Package | Description |
---|---|
com.azure.cosmos |
This package provides interfaces for interacting with Azure Cosmos DB.
|
Modifier and Type | Method and Description |
---|---|
CosmosClientBuilder |
CosmosClientBuilder.clientTelemetryEnabled(boolean clientTelemetryEnabled)
Sets the flag to enable client telemetry which will periodically collect
database operations aggregation statistics, system information like cpu/memory
and send it to cosmos monitoring service, which will be helpful during debugging.
|
CosmosClientBuilder |
CosmosClientBuilder.connectionSharingAcrossClientsEnabled(boolean connectionSharingAcrossClientsEnabled)
Enables connections sharing across multiple Cosmos Clients.
|
CosmosClientBuilder |
CosmosClientBuilder.consistencyLevel(ConsistencyLevel desiredConsistencyLevel)
Sets the
ConsistencyLevel to be used
By default, ConsistencyLevel.SESSION consistency will be used. |
CosmosClientBuilder |
CosmosClientBuilder.contentResponseOnWriteEnabled(boolean contentResponseOnWriteEnabled)
Sets the boolean to only return the headers and status code in Cosmos DB response
in case of Create, Update and Delete operations on CosmosItem.
|
CosmosClientBuilder |
CosmosClientBuilder.credential(com.azure.core.credential.AzureKeyCredential credential)
Sets the
AzureKeyCredential to be used |
CosmosClientBuilder |
CosmosClientBuilder.credential(com.azure.core.credential.TokenCredential credential)
Sets the
TokenCredential used to authorize requests sent to the service. |
CosmosClientBuilder |
CosmosClientBuilder.directMode()
Sets the default DIRECT connection configuration to be used.
|
CosmosClientBuilder |
CosmosClientBuilder.directMode(DirectConnectionConfig directConnectionConfig)
Sets the DIRECT connection configuration to be used.
|
CosmosClientBuilder |
CosmosClientBuilder.directMode(DirectConnectionConfig directConnectionConfig,
GatewayConnectionConfig gatewayConnectionConfig)
Sets the DIRECT connection configuration to be used.
|
CosmosClientBuilder |
CosmosClientBuilder.endpoint(String endpoint)
Sets the Azure Cosmos DB endpoint the SDK will connect to
|
CosmosClientBuilder |
CosmosClientBuilder.endpointDiscoveryEnabled(boolean endpointDiscoveryEnabled)
Sets the flag to enable endpoint discovery for geo-replicated database accounts.
|
CosmosClientBuilder |
CosmosClientBuilder.gatewayMode()
Sets the default GATEWAY connection configuration to be used.
|
CosmosClientBuilder |
CosmosClientBuilder.gatewayMode(GatewayConnectionConfig gatewayConnectionConfig)
Sets the GATEWAY connection configuration to be used.
|
CosmosClientBuilder |
CosmosClientBuilder.key(String key)
Sets either a master or readonly key used to perform authentication
for accessing resource.
|
CosmosClientBuilder |
CosmosClientBuilder.multipleWriteRegionsEnabled(boolean multipleWriteRegionsEnabled)
Sets the flag to enable writes on any regions for geo-replicated database accounts in the Azure
Cosmos DB service.
|
CosmosClientBuilder |
CosmosClientBuilder.permissions(List<CosmosPermissionProperties> permissions)
Sets the permission list, which contains the
resource tokens needed to access resources.
|
CosmosClientBuilder |
CosmosClientBuilder.preferredRegions(List<String> preferredRegions)
Sets the preferred regions for geo-replicated database accounts.
|
CosmosClientBuilder |
CosmosClientBuilder.readRequestsFallbackEnabled(boolean readRequestsFallbackEnabled)
Sets whether to allow for reads to go to multiple regions configured on an account of Azure Cosmos DB service.
|
CosmosClientBuilder |
CosmosClientBuilder.resourceToken(String resourceToken)
Sets a resource token used to perform authentication
for accessing resource.
|
CosmosClientBuilder |
CosmosClientBuilder.sessionCapturingOverrideEnabled(boolean sessionCapturingOverrideEnabled)
Session capturing is enabled by default for
ConsistencyLevel.SESSION . |
CosmosClientBuilder |
CosmosClientBuilder.throttlingRetryOptions(ThrottlingRetryOptions throttlingRetryOptions)
Sets the retry policy options associated with the DocumentClient instance.
|
CosmosClientBuilder |
CosmosClientBuilder.userAgentSuffix(String userAgentSuffix)
sets the value of the user-agent suffix.
|
Copyright © 2021 Microsoft Corporation. All rights reserved.