Package io.stargate.sdk.doc

Class NamespaceClient

java.lang.Object

io.stargate.sdk.doc.NamespaceClient

public class NamespaceClient
extends Object

Client for Document API 'Namespace' resource /v2/namespaces

Author:

Cedrick LUNVEN (@clunven)

Field Summary

Fields

Modifier and Type	Field	Description
Function<ServiceHttp,String>	collectionsResource	/v2/namespaces/{namespace}/collections
Function<ServiceHttp,String>	functionsResource	/v2/namespaces/{namespace}/functions
Function<ServiceHttp,String>	namespaceResource	/v2/namespaces/{namespace}
Function<ServiceHttp,String>	namespaceSchemaResource	/v2/schemas/namespaces/{namespace}
static final String	PATH_COLLECTIONS	Constants.
static final String	PATH_FUNCTIONS	Constants.
protected final LoadBalancedHttpClient	stargateHttpClient	Get Topology of the nodes.

Constructor Summary

Constructors

Constructor	Description
NamespaceClient(LoadBalancedHttpClient stargateHttpClient, StargateDocumentApiClient docClient, String namespace)	Full constructor.

Method Summary

Modifier and Type	Method	Description
CollectionClient	collection(String collectionName)	Move to the collection client
Stream<String>	collectionNames()	List collections in namespace.
Stream<CollectionDefinition>	collections()	List collections in namespace.
void	create(DataCenter... datacenters)	Create a namespace.
void	createSimple(int replicas)	Create a namespace.
void	delete()	Delete a namespace.
boolean	exist()	Check if namespace exists.
Optional<Namespace>	find()	Find a namespace and its metadata based on its id
String	getNamespace()	Getter accessor for attribute 'namespace'.

Methods inherited from class java.lang.Object

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

Field Details

PATH_COLLECTIONS

public static final String PATH_COLLECTIONS

Constants.

See Also:

• Constant Field Values

PATH_FUNCTIONS

public static final String PATH_FUNCTIONS

Constants.

See Also:

• Constant Field Values

stargateHttpClient

protected final LoadBalancedHttpClient stargateHttpClient

Get Topology of the nodes.

namespaceSchemaResource

public Function<ServiceHttp,String> namespaceSchemaResource

/v2/schemas/namespaces/{namespace}

namespaceResource

public Function<ServiceHttp,String> namespaceResource

/v2/namespaces/{namespace}

collectionsResource

public Function<ServiceHttp,String> collectionsResource

/v2/namespaces/{namespace}/collections

functionsResource

public Function<ServiceHttp,String> functionsResource

/v2/namespaces/{namespace}/functions

Constructor Details

NamespaceClient

public NamespaceClient(LoadBalancedHttpClient stargateHttpClient,
 StargateDocumentApiClient docClient,
 String namespace)

Full constructor.

Parameters:

stargateHttpClient - stargateHttpClient

docClient - ApiDocumentClient

namespace - String

Method Details

find

public Optional<Namespace> find()

Find a namespace and its metadata based on its id

Returns:

Namespace

exist

public boolean exist()

Check if namespace exists.

Returns:

boolean

create

public void create(DataCenter... datacenters)

Create a namespace.

Parameters:

datacenters - DataCenter

createSimple

public void createSimple(int replicas)

Create a namespace.

Parameters:

replicas - int

delete

public void delete()

Delete a namespace.

collections

public Stream<CollectionDefinition> collections()

List collections in namespace. GET /v2/namespaces/{namespace-id}/collections

Returns:

CollectionDefinition

collectionNames

public Stream<String> collectionNames()

List collections in namespace. GET /v2/namespaces/{namespace-id}/collections

Returns:

String

collection

public CollectionClient collection(String collectionName)

Move to the collection client

Parameters:

collectionName - String

Returns:

CollectionClient

getNamespace

public String getNamespace()

Getter accessor for attribute 'namespace'.

Returns:

current value of 'namespace'