Interface NamespacesClient

All Known Implementing Classes:
NamespacesClientImpl
public interface NamespacesClient
The API interface exposed by the YellowDog Namespaces Service

  • Method Details

    • getNamespace

      Namespace getNamespace(String namespaceId)
      Gets the namespace with a matching ID.
      Parameters:
      namespaceId - the namespace ID
      Returns:
      the namespace

    • getNamespaces

      SearchClient<Namespace> getNamespaces(NamespaceSearch search)
      Returns a search client for namespaces that match the NamespaceSearch parameter.
      Parameters:
      search - the search object to filter and sort results
      Returns:
      a search client for matching namespaces

    • createNamespace

      String createNamespace(CreateNamespaceRequest request)
      Creates a namespace.
      Parameters:
      request - the request containing the data to create the namespace
      Returns:
      the namespace ID

    • deleteNamespace

      void deleteNamespace(String namespaceId)
      Deletes a namespace.
      Parameters:
      namespaceId - the ID of the namespace to delete

    • saveNamespacePolicy

      void saveNamespacePolicy(NamespacePolicy namespacePolicy)
      Submits a namespace policy to either save or update.
      Parameters:
      namespacePolicy - the namespace policy to submit

    • getNamespacePolicy

      NamespacePolicy getNamespacePolicy(String namespace)
      Requests the namespace policy for the specified namespace.
      Parameters:
      namespace - the namespace
      Returns:
      the namespace policy

    • deleteNamespacePolicy

      void deleteNamespacePolicy(String namespace)
      Deletes the namespace policy for the specified namespace if it exists.
      Parameters:
      namespace - the namespace

    • getNamespacePolicies

      SearchClient<NamespacePolicy> getNamespacePolicies(NamespacePolicySearch search)
      Returns a search client for searching namespace policies.
      Parameters:
      search - the search criteria
      Returns:
      a search client for searching namespace policies