com.microsoft.azure.cosmosdb.rx

Class AsyncDocumentClient.Builder

java.lang.Object

com.microsoft.azure.cosmosdb.rx.AsyncDocumentClient.Builder

Enclosing interface:

AsyncDocumentClient

public static class AsyncDocumentClient.Builder
extends Object

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

 
 ConnectionPolicy connectionPolicy = new ConnectionPolicy();
 connectionPolicy.setConnectionMode(ConnectionMode.Direct);
 AsyncDocumentClient client = new AsyncDocumentClient.Builder()
         .withServiceEndpoint(serviceEndpoint)
         .withMasterKeyOrResourceToken(masterKey)
         .withConnectionPolicy(connectionPolicy)
         .withConsistencyLevel(ConsistencyLevel.Session)
         .build();
 
 

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
AsyncDocumentClient	build()
com.microsoft.azure.cosmosdb.rx.internal.Configs	getConfigs()
ConnectionPolicy	getConnectionPolicy()
ConsistencyLevel	getDesiredConsistencyLevel()
String	getMasterKeyOrResourceToken()
List<Permission>	getPermissionFeed()
URI	getServiceEndpoint()
TokenResolver	getTokenResolver()
void	setConfigs(com.microsoft.azure.cosmosdb.rx.internal.Configs configs)
void	setConnectionPolicy(ConnectionPolicy connectionPolicy)
void	setDesiredConsistencyLevel(ConsistencyLevel desiredConsistencyLevel)
void	setMasterKeyOrResourceToken(String masterKeyOrResourceToken)
void	setPermissionFeed(List<Permission> permissionFeed)
void	setServiceEndpoint(URI serviceEndpoint)
void	setTokenResolver(TokenResolver tokenResolver)
AsyncDocumentClient.Builder	withConfigs(com.microsoft.azure.cosmosdb.rx.internal.Configs configs)
AsyncDocumentClient.Builder	withConnectionPolicy(ConnectionPolicy connectionPolicy)
AsyncDocumentClient.Builder	withConsistencyLevel(ConsistencyLevel desiredConsistencyLevel)
AsyncDocumentClient.Builder	withMasterKey(String masterKeyOrResourceToken) Deprecated. use withMasterKeyOrResourceToken(String) instead.
AsyncDocumentClient.Builder	withMasterKeyOrResourceToken(String masterKeyOrResourceToken) This method will accept the master key , additionally it can also consume resource token too for authentication.
AsyncDocumentClient.Builder	withPermissionFeed(List<Permission> permissionFeed) This method will accept the permission list , which contains the resource tokens needed to access resources.
AsyncDocumentClient.Builder	withServiceEndpoint(String serviceEndpoint)
AsyncDocumentClient.Builder	withTokenResolver(TokenResolver tokenResolver) This method will accept functional interface TokenResolver which helps in generation authorization token per request.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

withServiceEndpoint

public AsyncDocumentClient.Builder withServiceEndpoint(String serviceEndpoint)

withMasterKey

@Deprecated
public AsyncDocumentClient.Builder withMasterKey(String masterKeyOrResourceToken)

Deprecated. use withMasterKeyOrResourceToken(String) instead.

New method withMasterKeyOrResourceToken will take either master key or resource token and perform authentication for accessing resource.

Parameters:

masterKeyOrResourceToken - MasterKey or resourceToken for authentication.

Returns:

current Builder.

withMasterKeyOrResourceToken

public AsyncDocumentClient.Builder withMasterKeyOrResourceToken(String masterKeyOrResourceToken)

This method will accept the master key , additionally it can also consume resource token too for authentication.

Parameters:

masterKeyOrResourceToken - MasterKey or resourceToken for authentication.

Returns:

current Builder.

withPermissionFeed

public AsyncDocumentClient.Builder withPermissionFeed(List<Permission> permissionFeed)

This method will accept the permission list , which contains the resource tokens needed to access resources.

Parameters:

permissionFeed - Permission list for authentication.

Returns:

current Builder.

withConsistencyLevel

public AsyncDocumentClient.Builder withConsistencyLevel(ConsistencyLevel desiredConsistencyLevel)

withConfigs

public AsyncDocumentClient.Builder withConfigs(com.microsoft.azure.cosmosdb.rx.internal.Configs configs)

withConnectionPolicy

public AsyncDocumentClient.Builder withConnectionPolicy(ConnectionPolicy connectionPolicy)

withTokenResolver

public AsyncDocumentClient.Builder withTokenResolver(TokenResolver tokenResolver)

This method will accept functional interface TokenResolver which helps in generation authorization token per request. AsyncDocumentClient can be successfully initialized with this API without passing any MasterKey, ResourceToken or PermissionFeed.

Parameters:

tokenResolver - The tokenResolver

Returns:

current Builder.

build

public AsyncDocumentClient build()

getConfigs

public com.microsoft.azure.cosmosdb.rx.internal.Configs getConfigs()

setConfigs

public void setConfigs(com.microsoft.azure.cosmosdb.rx.internal.Configs configs)

getConnectionPolicy

public ConnectionPolicy getConnectionPolicy()

setConnectionPolicy

public void setConnectionPolicy(ConnectionPolicy connectionPolicy)

getDesiredConsistencyLevel

public ConsistencyLevel getDesiredConsistencyLevel()

setDesiredConsistencyLevel

public void setDesiredConsistencyLevel(ConsistencyLevel desiredConsistencyLevel)

getPermissionFeed

public List<Permission> getPermissionFeed()

setPermissionFeed

public void setPermissionFeed(List<Permission> permissionFeed)

getMasterKeyOrResourceToken

public String getMasterKeyOrResourceToken()

setMasterKeyOrResourceToken

public void setMasterKeyOrResourceToken(String masterKeyOrResourceToken)

getServiceEndpoint

public URI getServiceEndpoint()

setServiceEndpoint

public void setServiceEndpoint(URI serviceEndpoint)

getTokenResolver

public TokenResolver getTokenResolver()

setTokenResolver

public void setTokenResolver(TokenResolver tokenResolver)