Package io.stargate.sdk.doc

Class StargateDocumentApiClient

java.lang.Object

io.stargate.sdk.doc.StargateDocumentApiClient

public class StargateDocumentApiClient
extends Object

Client for the Astra/Stargate document (collections) API.

Author:

Cedrick LUNVEN (@clunven)

Field Summary

Fields

Modifier and Type	Field	Description
Function<ServiceHttp,String>	namespacesResource	Mapping from root URL to rest endpoint listing keyspaces definitions.
Function<ServiceHttp,String>	namespacesSchemaResource	Mapping from root URL to rest endpoint listing keyspaces definitions.
static final String	PATH_SCHEMA	Schema sub level.
static final String	PATH_SCHEMA_NAMESPACES	Schema sub level.
static final String	PATH_V2	Schema sub level.
protected final LoadBalancedHttpClient	stargateHttpClient	Get Topology of the nodes.

Constructor Summary

Constructors

Constructor	Description
StargateDocumentApiClient()	Default Constructor
StargateDocumentApiClient(ServiceDeployment<ServiceHttp> serviceDeployment)	Initialized document API with a URL and a token.
StargateDocumentApiClient(String endpoint)	Single instance of Stargate, could be used for tests.

Method Summary

Modifier and Type	Method	Description
LoadBalancedHttpClient	getStargateHttpClient()	Gets stargateHttpClient
NamespaceClient	namespace(String namespace)	Move the document API (namespace client)
Stream<String>	namespaceNames()	Return list of Namespace (keyspaces) names available.
Stream<Namespace>	namespaces()	Return list of Namespace(keyspaces) available.

Methods inherited from class java.lang.Object

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

Field Details

PATH_SCHEMA_NAMESPACES

public static final String PATH_SCHEMA_NAMESPACES

Schema sub level.

See Also:

• Constant Field Values

PATH_SCHEMA

public static final String PATH_SCHEMA

Schema sub level.

See Also:

• Constant Field Values

PATH_V2

public static final String PATH_V2

Schema sub level.

See Also:

• Constant Field Values

stargateHttpClient

protected final LoadBalancedHttpClient stargateHttpClient

Get Topology of the nodes.

namespacesSchemaResource

public Function<ServiceHttp,String> namespacesSchemaResource

Mapping from root URL to rest endpoint listing keyspaces definitions.

namespacesResource

public Function<ServiceHttp,String> namespacesResource

Mapping from root URL to rest endpoint listing keyspaces definitions.

Constructor Details

StargateDocumentApiClient

public StargateDocumentApiClient()

Default Constructor

StargateDocumentApiClient

public StargateDocumentApiClient(String endpoint)

Single instance of Stargate, could be used for tests.

Parameters:

endpoint - service endpoint

StargateDocumentApiClient

public StargateDocumentApiClient(ServiceDeployment<ServiceHttp> serviceDeployment)

Initialized document API with a URL and a token.

Parameters:

serviceDeployment - http client topology aware

Method Details

namespaces

public Stream<Namespace> namespaces()

Return list of Namespace(keyspaces) available.

Returns:

Stream

See Also:

• Reference Documentation

namespaceNames

public Stream<String> namespaceNames()

Return list of Namespace (keyspaces) names available.

Returns:

stream of the namespaces

namespace

public NamespaceClient namespace(String namespace)

Move the document API (namespace client)

Parameters:

namespace - String

Returns:

NamespaceClient

getStargateHttpClient

public LoadBalancedHttpClient getStargateHttpClient()

Gets stargateHttpClient

Returns:

value of stargateHttpClient