com.azure.data.cosmos

Class CosmosClientBuilder

java.lang.Object

com.azure.data.cosmos.CosmosClientBuilder

public class CosmosClientBuilder
extends Object

Helper class to build CosmosClient instances as logical representation of the Azure Cosmos database service.

 
 ConnectionPolicy connectionPolicy = new ConnectionPolicy();
 connectionPolicy.connectionMode(ConnectionMode.DIRECT);
 CosmonsClient client = new CosmosClient.builder()
         .endpoint(serviceEndpoint)
         .key(key)
         .connectionPolicy(connectionPolicy)
         .consistencyLevel(ConsistencyLevel.SESSION)
         .build();
 
 

Method Summary

Modifier and Type	Method and Description
CosmosClient	build() Builds a cosmos configuration object with the provided properties
ConnectionPolicy	connectionPolicy() Gets the (@link ConnectionPolicy) to be used
CosmosClientBuilder	connectionPolicy(ConnectionPolicy connectionPolicy) Sets the (@link ConnectionPolicy) to be used
ConsistencyLevel	consistencyLevel() Gets the (@link ConsistencyLevel) to be used
CosmosClientBuilder	consistencyLevel(ConsistencyLevel desiredConsistencyLevel) Sets the (@link ConsistencyLevel) to be used
String	endpoint() Gets the Azure Cosmos DB endpoint the SDK will connect to
CosmosClientBuilder	endpoint(String endpoint) Sets the Azure Cosmos DB endpoint the SDK will connect to
String	key() Gets either a master or readonly key used to perform authentication for accessing resource.
CosmosClientBuilder	key(String key) Sets either a master or readonly key used to perform authentication for accessing resource.
List<com.azure.data.cosmos.internal.Permission>	permissions() Gets the permission list, which contains the resource tokens needed to access resources.
CosmosClientBuilder	permissions(List<com.azure.data.cosmos.internal.Permission> permissions) Sets the permission list, which contains the resource tokens needed to access resources.
String	resourceToken() Sets a resource token used to perform authentication for accessing resource.
CosmosClientBuilder	resourceToken(String resourceToken) Sets a resource token used to perform authentication for accessing resource.
TokenResolver	tokenResolver() Gets the token resolver
CosmosClientBuilder	tokenResolver(TokenResolver tokenResolver) Sets the token resolver

Methods inherited from class java.lang.Object

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

Method Detail

tokenResolver

public TokenResolver tokenResolver()

Gets the token resolver

Returns:

the token resolver

tokenResolver

public CosmosClientBuilder tokenResolver(TokenResolver tokenResolver)

Sets the token resolver

Parameters:

tokenResolver -

Returns:

current builder

endpoint

public String endpoint()

Gets the Azure Cosmos DB endpoint the SDK will connect to

Returns:

the endpoint

endpoint

public CosmosClientBuilder endpoint(String endpoint)

Sets the Azure Cosmos DB endpoint the SDK will connect to

Parameters:

endpoint - the service endpoint

Returns:

current Builder

key

public String key()

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

Returns:

the key

key

public CosmosClientBuilder key(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.

resourceToken

public String resourceToken()

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

Returns:

the resourceToken

resourceToken

public CosmosClientBuilder resourceToken(String resourceToken)

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

Parameters:

resourceToken - resourceToken for authentication

Returns:

current Builder.

permissions

public List<com.azure.data.cosmos.internal.Permission> permissions()

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

Returns:

the permission list

permissions

public CosmosClientBuilder permissions(List<com.azure.data.cosmos.internal.Permission> permissions)

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

Parameters:

permissions - Permission list for authentication.

Returns:

current Builder.

consistencyLevel

public ConsistencyLevel consistencyLevel()

Gets the (@link ConsistencyLevel) to be used

Returns:

the consistency level

consistencyLevel

public CosmosClientBuilder consistencyLevel(ConsistencyLevel desiredConsistencyLevel)

Sets the (@link ConsistencyLevel) to be used

Parameters:

desiredConsistencyLevel - ConsistencyLevel

Returns:

current Builder

connectionPolicy

public ConnectionPolicy connectionPolicy()

Gets the (@link ConnectionPolicy) to be used

Returns:

the connection policy

connectionPolicy

public CosmosClientBuilder connectionPolicy(ConnectionPolicy connectionPolicy)

Sets the (@link ConnectionPolicy) to be used

Parameters:

connectionPolicy - ConnectionPolicy

Returns:

current Builder

build

public CosmosClient build()

Builds a cosmos configuration object with the provided properties

Returns:

CosmosClient