yellowdog_client.namespaces – Namespace

All functionality is accessed via the yellowdog_client.namespaces.NamespaceClient.

class yellowdog_client.namespaces.NamespacesClient

The API interface exposed by the YellowDog Namespaces Service

abstractmethod create_namespace(request)

Creates a namespace.

Parameters:

request (CreateNamespaceRequest) – the request containing the data to create the namespace

Return type:

str

Returns:

the namespace ID

abstractmethod delete_namespace(namespace_id)

Deletes a namespace.

Parameters:

namespace_id (str) – the ID of the namespace to delete

Return type:

None

abstractmethod delete_namespace_policy(namespace)

Deletes the namespace policy for the specified namespace if it exists.

Parameters:

namespace (str) – the namespace

Return type:

None

abstractmethod get_namespace(namespace_id)

Gets the namespace with a matching ID.

Parameters:

namespace_id (str) – the namespace ID

Return type:

Namespace

Returns:

the namespace

abstractmethod get_namespace_policies(search)

Returns a search client for searching namespace policies.

Parameters:

search (NamespacePolicySearch) – the search criteria

Return type:

SearchClient[NamespacePolicy]

Returns:

a search client for searching namespace policies

abstractmethod get_namespace_policy(namespace)

Requests the namespace policy for the specified namespace.

Parameters:

namespace (str) – the namespace

Return type:

NamespacePolicy

Returns:

the namespace policy

abstractmethod get_namespaces(search)

Returns a search client for namespaces that match the NamespaceSearch parameter.

Parameters:

search (NamespaceSearch) – the search object to filter and sort results

Return type:

SearchClient[Namespace]

Returns:

a search client for matching namespaces

abstractmethod save_namespace_policy(namespace_policy)

Submits a namespace policy to either save or update.

Parameters:

namespace_policy (NamespacePolicy) – the namespace policy to submit

Return type:

None

class yellowdog_client.namespaces.NamespacesClientImpl(service_proxy)
Parameters:

service_proxy (NamespacesServiceProxy)

close()
Return type:

None

create_namespace(request)

Creates a namespace.

Parameters:

request (CreateNamespaceRequest) – the request containing the data to create the namespace

Return type:

str

Returns:

the namespace ID

delete_namespace(namespace_id)

Deletes a namespace.

Parameters:

namespace_id (str) – the ID of the namespace to delete

delete_namespace_policy(namespace)

Deletes the namespace policy for the specified namespace if it exists.

Parameters:

namespace (str) – the namespace

Return type:

None

get_namespace(namespace_id)

Gets the namespace with a matching ID.

Parameters:

namespace_id (str) – the namespace ID

Return type:

Namespace

Returns:

the namespace

get_namespace_policies(search)

Returns a search client for searching namespace policies.

Parameters:

search (NamespacePolicySearch) – the search criteria

Return type:

SearchClient[NamespacePolicy]

Returns:

a search client for searching namespace policies

get_namespace_policy(namespace)

Requests the namespace policy for the specified namespace.

Parameters:

namespace (str) – the namespace

Return type:

NamespacePolicy

Returns:

the namespace policy

get_namespaces(search)

Returns a search client for namespaces that match the NamespaceSearch parameter.

Parameters:

search (NamespaceSearch) – the search object to filter and sort results

Return type:

SearchClient[Namespace]

Returns:

a search client for matching namespaces

save_namespace_policy(namespace_policy)

Submits a namespace policy to either save or update.

Parameters:

namespace_policy (NamespacePolicy) – the namespace policy to submit

Return type:

None

class yellowdog_client.namespaces.NamespacesServiceProxy(proxy)
Parameters:

proxy (Proxy)

create_namespace(request)
Parameters:

request (CreateNamespaceRequest)

Return type:

str

delete_namespace(namespace_id)
Parameters:

namespace_id (str)

delete_namespace_policy(namespace)
Parameters:

namespace (str)

Return type:

None

get_namespace(namespace_id)
Parameters:

namespace_id (str)

Return type:

Namespace

get_namespace_policies(search, slice_reference)
Parameters:
Return type:

Slice[NamespacePolicy]

get_namespace_policy(namespace)
Parameters:

namespace (str)

Return type:

NamespacePolicy

save_namespace_policy(namespace_policy)
Parameters:

namespace_policy (NamespacePolicy)

Return type:

None

search_namespaces(search, slice_reference)
Parameters:
Return type:

Slice[Namespace]