com.azure.cosmos

Class CosmosClientBuilder

java.lang.Object

com.azure.cosmos.CosmosClientBuilder

public class CosmosClientBuilder
extends Object

Helper class to buildAsyncClient CosmosAsyncClient instances as logical representation of the Azure Cosmos database service.

 
 ConnectionPolicy getConnectionPolicy = new ConnectionPolicy();
 getConnectionPolicy.getConnectionMode(ConnectionMode.DIRECT);
 CosmonsClient client = new CosmosAsyncClient.cosmosClientBuilder()
         .getEndpoint(serviceEndpoint)
         .getKey(getKey)
         .getConnectionPolicy(getConnectionPolicy)
         .getConsistencyLevel(ConsistencyLevel.SESSION)
         .buildAsyncClient();
 
 

Constructor Summary

Constructors

Constructor and Description
CosmosClientBuilder()

Method Summary

Modifier and Type	Method and Description
CosmosAsyncClient	buildAsyncClient() Builds a cosmos configuration object with the provided properties
CosmosClient	buildClient() Builds a cosmos sync client object with the provided properties
void	enableSessionCapturing(boolean sessionCapturingOverride) Session capturing is enabled by default for ConsistencyLevel.SESSION.
ConnectionPolicy	getConnectionPolicy() Gets the (@link ConnectionPolicy) to be used
ConsistencyLevel	getConsistencyLevel() Gets the ConsistencyLevel to be used
CosmosKeyCredential	getCosmosKeyCredential() Gets the CosmosKeyCredential to be used
String	getEndpoint() Gets the Azure Cosmos DB endpoint the SDK will connect to
String	getKey() Gets either a master or readonly key used to perform authentication for accessing resource.
List<com.azure.cosmos.implementation.Permission>	getPermissions() Gets the permission list, which contains the resource tokens needed to access resources.
String	getResourceToken() Sets a resource token used to perform authentication for accessing resource.
TokenResolver	getTokenResolver() Gets the token resolver
boolean	isSessionCapturingOverride() Indicates if Session capturing is enabled for non Session modes.
CosmosClientBuilder	setConnectionPolicy(ConnectionPolicy connectionPolicy) Sets the ConnectionPolicy to be used
CosmosClientBuilder	setConsistencyLevel(ConsistencyLevel desiredConsistencyLevel) Sets the ConsistencyLevel to be used
CosmosClientBuilder	setCosmosKeyCredential(CosmosKeyCredential cosmosKeyCredential) Sets the CosmosKeyCredential to be used
CosmosClientBuilder	setEndpoint(String endpoint) Sets the Azure Cosmos DB endpoint the SDK will connect to
CosmosClientBuilder	setKey(String key) Sets either a master or readonly key used to perform authentication for accessing resource.
CosmosClientBuilder	setPermissions(List<com.azure.cosmos.implementation.Permission> permissions) Sets the permission list, which contains the resource tokens needed to access resources.
CosmosClientBuilder	setResourceToken(String resourceToken) Sets a resource token used to perform authentication for accessing resource.
CosmosClientBuilder	setTokenResolver(TokenResolver tokenResolver) Sets the token resolver

Methods inherited from class java.lang.Object

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

Constructor Detail

CosmosClientBuilder

public CosmosClientBuilder()

Method Detail

enableSessionCapturing

public void enableSessionCapturing(boolean sessionCapturingOverride)

Session capturing is enabled by default for ConsistencyLevel.SESSION. For other consistency levels, it is not needed, unless if you need occasionally send requests with Session Consistency while the client is not configured in session. enabling Session capturing for Session mode has no effect.

Parameters:

sessionCapturingOverride - the session capturing override

isSessionCapturingOverride

public boolean isSessionCapturingOverride()

Indicates if Session capturing is enabled for non Session modes. The default is false.

Returns:

the session capturing override

getTokenResolver

public TokenResolver getTokenResolver()

Gets the token resolver

Returns:

the token resolver

setTokenResolver

public CosmosClientBuilder setTokenResolver(TokenResolver tokenResolver)

Sets the token resolver

Parameters:

tokenResolver - the token resolver

Returns:

current cosmosClientBuilder

getEndpoint

public String getEndpoint()

Gets the Azure Cosmos DB endpoint the SDK will connect to

Returns:

the endpoint

setEndpoint

public CosmosClientBuilder setEndpoint(String endpoint)

Sets the Azure Cosmos DB endpoint the SDK will connect to

Parameters:

endpoint - the service endpoint

Returns:

current Builder

getKey

public String getKey()

Gets either a master or readonly key used to perform authentication for accessing resource.

Returns:

the key

setKey

public CosmosClientBuilder setKey(String key)

Sets either a master or readonly key used to perform authentication for accessing resource.

Parameters:

key - master or readonly key

Returns:

current Builder.

getResourceToken

public String getResourceToken()

Sets a resource token used to perform authentication for accessing resource.

Returns:

the resourceToken

setResourceToken

public CosmosClientBuilder setResourceToken(String resourceToken)

Sets a resource token used to perform authentication for accessing resource.

Parameters:

resourceToken - resourceToken for authentication

Returns:

current Builder.

getPermissions

public List<com.azure.cosmos.implementation.Permission> getPermissions()

Gets the permission list, which contains the resource tokens needed to access resources.

Returns:

the permission list

setPermissions

public CosmosClientBuilder setPermissions(List<com.azure.cosmos.implementation.Permission> permissions)

Sets the permission list, which contains the resource tokens needed to access resources.

Parameters:

permissions - Permission list for authentication.

Returns:

current Builder.

getConsistencyLevel

public ConsistencyLevel getConsistencyLevel()

Gets the ConsistencyLevel to be used

Returns:

the consistency level

setConsistencyLevel

public CosmosClientBuilder setConsistencyLevel(ConsistencyLevel desiredConsistencyLevel)

Sets the ConsistencyLevel to be used

Parameters:

desiredConsistencyLevel - ConsistencyLevel

Returns:

current Builder

getConnectionPolicy

public ConnectionPolicy getConnectionPolicy()

Gets the (@link ConnectionPolicy) to be used

Returns:

the connection policy

setConnectionPolicy

public CosmosClientBuilder setConnectionPolicy(ConnectionPolicy connectionPolicy)

Sets the ConnectionPolicy to be used

Parameters:

connectionPolicy - ConnectionPolicy

Returns:

current Builder

getCosmosKeyCredential

public CosmosKeyCredential getCosmosKeyCredential()

Gets the CosmosKeyCredential to be used

Returns:

cosmosKeyCredential

setCosmosKeyCredential

public CosmosClientBuilder setCosmosKeyCredential(CosmosKeyCredential cosmosKeyCredential)

Sets the CosmosKeyCredential to be used

Parameters:

cosmosKeyCredential - CosmosKeyCredential

Returns:

current cosmosClientBuilder

buildAsyncClient

public CosmosAsyncClient buildAsyncClient()

Builds a cosmos configuration object with the provided properties

Returns:

CosmosAsyncClient

buildClient

public CosmosClient buildClient()

Builds a cosmos sync client object with the provided properties

Returns:

CosmosClient