Class NamespacesClientImpl

java.lang.Object

co.yellowdog.platform.clients.namespaces.NamespacesClientImpl

All Implemented Interfaces:

NamespacesClient

public class NamespacesClientImpl
extends Object
implements NamespacesClient

Constructor Summary

Constructors

Constructor	Description
NamespacesClientImpl(@NonNull co.yellowdog.platform.clients.namespaces.NamespacesClientProxy proxy)

Method Summary

Modifier and Type	Method	Description
static NamespacesClientImpl	create(@NonNull ServicesSchema servicesSchema, @NonNull RetryFactory retryFactory, @NonNull AuthenticationHeadersProvider authenticationHeadersProvider, @NonNull com.fasterxml.jackson.databind.ObjectMapper objectMapper, @NonNull UserAgent userAgent)
String	createNamespace(CreateNamespaceRequest request)	Creates a namespace.
void	deleteNamespace(String namespaceId)	Deletes a namespace.
void	deleteNamespacePolicy(@NonNull String namespace)	Deletes the namespace policy for the specified namespace if it exists.
Namespace	getNamespace(String namespaceId)	Gets the namespace with a matching ID.
SearchClient<NamespacePolicy>	getNamespacePolicies(@NonNull NamespacePolicySearch search)	Returns a search client for searching namespace policies.
NamespacePolicy	getNamespacePolicy(@NonNull String namespace)	Requests the namespace policy for the specified namespace.
SearchClient<Namespace>	getNamespaces(NamespaceSearch search)	Returns a search client for namespaces that match the NamespaceSearch parameter.
void	saveNamespacePolicy(@NonNull NamespacePolicy namespacePolicy)	Submits a namespace policy to either save or update.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

NamespacesClientImpl

public NamespacesClientImpl(@NonNull
 @NonNull co.yellowdog.platform.clients.namespaces.NamespacesClientProxy proxy)

Method Details

create

public static NamespacesClientImpl create(@NonNull
 @NonNull ServicesSchema servicesSchema,
 @NonNull
 @NonNull RetryFactory retryFactory,
 @NonNull
 @NonNull AuthenticationHeadersProvider authenticationHeadersProvider,
 @NonNull
 @NonNull com.fasterxml.jackson.databind.ObjectMapper objectMapper,
 @NonNull
 @NonNull UserAgent userAgent)

getNamespace

public Namespace getNamespace(String namespaceId)

Description copied from interface: NamespacesClient

Gets the namespace with a matching ID.

Specified by:

getNamespace in interface NamespacesClient

Parameters:

namespaceId - the namespace ID

Returns:

the namespace

getNamespaces

public SearchClient<Namespace> getNamespaces(NamespaceSearch search)

Description copied from interface: NamespacesClient

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

Specified by:

getNamespaces in interface NamespacesClient

Parameters:

search - the search object to filter and sort results

Returns:

a search client for matching namespaces

createNamespace

public String createNamespace(CreateNamespaceRequest request)

Description copied from interface: NamespacesClient

Creates a namespace.

Specified by:

createNamespace in interface NamespacesClient

Parameters:

request - the request containing the data to create the namespace

Returns:

the namespace ID

deleteNamespace

public void deleteNamespace(String namespaceId)

Description copied from interface: NamespacesClient

Deletes a namespace.

Specified by:

deleteNamespace in interface NamespacesClient

Parameters:

namespaceId - the ID of the namespace to delete

saveNamespacePolicy

public void saveNamespacePolicy(@NonNull
 @NonNull NamespacePolicy namespacePolicy)

Description copied from interface: NamespacesClient

Submits a namespace policy to either save or update.

Specified by:

saveNamespacePolicy in interface NamespacesClient

Parameters:

namespacePolicy - the namespace policy to submit

getNamespacePolicy

public NamespacePolicy getNamespacePolicy(@NonNull
 @NonNull String namespace)

Description copied from interface: NamespacesClient

Requests the namespace policy for the specified namespace.

Specified by:

getNamespacePolicy in interface NamespacesClient

Parameters:

namespace - the namespace

Returns:

the namespace policy

deleteNamespacePolicy

public void deleteNamespacePolicy(@NonNull
 @NonNull String namespace)

Description copied from interface: NamespacesClient

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

Specified by:

deleteNamespacePolicy in interface NamespacesClient

Parameters:

namespace - the namespace

getNamespacePolicies

public SearchClient<NamespacePolicy> getNamespacePolicies(@NonNull
 @NonNull NamespacePolicySearch search)

Description copied from interface: NamespacesClient

Returns a search client for searching namespace policies.

Specified by:

getNamespacePolicies in interface NamespacesClient

Parameters:

search - the search criteria

Returns:

a search client for searching namespace policies