org.finra.herd.sdk.api

Class NamespaceApi

java.lang.Object

org.finra.herd.sdk.api.NamespaceApi

@Generated(value="class io.swagger.codegen.languages.JavaClientCodegen",
           date="2017-02-24T15:10:39.441-05:00")
public class NamespaceApi
extends Object

Constructor Summary

Constructors

Constructor and Description
NamespaceApi()
NamespaceApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
ApiClient	getApiClient()
Namespace	namespaceCreateNamespace(NamespaceCreateRequest namespaceCreateRequest) createNamespace Creates a new namespace.
Namespace	namespaceDeleteNamespace(String namespaceCode) deleteNamespace Deletes an existing namespace by namespace code.
Namespace	namespaceGetNamespace(String namespaceCode) getNamespace Gets an existing namespace by namespace code.
NamespaceKeys	namespaceGetNamespaces() getNamespaces Gets a list of namespace keys for all namespaces defined in the system.
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

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

Constructor Detail

NamespaceApi

public NamespaceApi()

NamespaceApi

public NamespaceApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

namespaceGetNamespaces

public NamespaceKeys namespaceGetNamespaces()
                                     throws ApiException

getNamespaces Gets a list of namespace keys for all namespaces defined in the system.

Returns:

NamespaceKeys

Throws:

ApiException

namespaceCreateNamespace

public Namespace namespaceCreateNamespace(NamespaceCreateRequest namespaceCreateRequest)
                                   throws ApiException

createNamespace Creates a new namespace.

Parameters:

namespaceCreateRequest - the information needed to create the namespace

Returns:

Namespace

Throws:

ApiException

namespaceGetNamespace

public Namespace namespaceGetNamespace(String namespaceCode)
                                throws ApiException

getNamespace Gets an existing namespace by namespace code.

Parameters:

namespaceCode - the namespace code

Returns:

Namespace

Throws:

ApiException

namespaceDeleteNamespace

public Namespace namespaceDeleteNamespace(String namespaceCode)
                                   throws ApiException

deleteNamespace Deletes an existing namespace by namespace code.

Parameters:

namespaceCode - the namespace code

Returns:

Namespace

Throws:

ApiException