Package org.apache.camel.builder.endpoint.dsl

Interface CosmosDbEndpointBuilderFactory.CosmosDbEndpointBuilder

All Superinterfaces:

CosmosDbEndpointBuilderFactory.CosmosDbEndpointConsumerBuilder, CosmosDbEndpointBuilderFactory.CosmosDbEndpointProducerBuilder, org.apache.camel.builder.EndpointConsumerBuilder, org.apache.camel.EndpointConsumerResolver, org.apache.camel.builder.EndpointProducerBuilder, org.apache.camel.EndpointProducerResolver

Enclosing interface:

CosmosDbEndpointBuilderFactory

public static interface CosmosDbEndpointBuilderFactory.CosmosDbEndpointBuilder
extends CosmosDbEndpointBuilderFactory.CosmosDbEndpointConsumerBuilder, CosmosDbEndpointBuilderFactory.CosmosDbEndpointProducerBuilder

Builder for endpoint for the Azure CosmosDB component.

Method Summary

Modifier and Type	Method	Description
default CosmosDbEndpointBuilderFactory.CosmosDbEndpointBuilder	accountKey(String accountKey)	Sets either a master or readonly key used to perform authentication for accessing resource.
default CosmosDbEndpointBuilderFactory.AdvancedCosmosDbEndpointBuilder	advanced()
default CosmosDbEndpointBuilderFactory.CosmosDbEndpointBuilder	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.
default CosmosDbEndpointBuilderFactory.CosmosDbEndpointBuilder	clientTelemetryEnabled(String 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.
default CosmosDbEndpointBuilderFactory.CosmosDbEndpointBuilder	connectionSharingAcrossClientsEnabled(boolean connectionSharingAcrossClientsEnabled)	Enables connections sharing across multiple Cosmos Clients.
default CosmosDbEndpointBuilderFactory.CosmosDbEndpointBuilder	connectionSharingAcrossClientsEnabled(String connectionSharingAcrossClientsEnabled)	Enables connections sharing across multiple Cosmos Clients.
default CosmosDbEndpointBuilderFactory.CosmosDbEndpointBuilder	consistencyLevel(String consistencyLevel)	Sets the consistency levels supported for Azure Cosmos DB client operations in the Azure Cosmos DB service.
default CosmosDbEndpointBuilderFactory.CosmosDbEndpointBuilder	consistencyLevel(CosmosDbEndpointBuilderFactory.ConsistencyLevel consistencyLevel)	Sets the consistency levels supported for Azure Cosmos DB client operations in the Azure Cosmos DB service.
default CosmosDbEndpointBuilderFactory.CosmosDbEndpointBuilder	containerPartitionKeyPath(String containerPartitionKeyPath)	Sets the container partition key path.
default CosmosDbEndpointBuilderFactory.CosmosDbEndpointBuilder	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.
default CosmosDbEndpointBuilderFactory.CosmosDbEndpointBuilder	contentResponseOnWriteEnabled(String 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.
default CosmosDbEndpointBuilderFactory.CosmosDbEndpointBuilder	cosmosAsyncClient(Object cosmosAsyncClient)	Inject an external CosmosAsyncClient into the component which provides a client-side logical representation of the Azure Cosmos DB service.
default CosmosDbEndpointBuilderFactory.CosmosDbEndpointBuilder	cosmosAsyncClient(String cosmosAsyncClient)	Inject an external CosmosAsyncClient into the component which provides a client-side logical representation of the Azure Cosmos DB service.
default CosmosDbEndpointBuilderFactory.CosmosDbEndpointBuilder	createContainerIfNotExists(boolean createContainerIfNotExists)	Sets if the component should create Cosmos container automatically in case it doesn't exist in Cosmos database.
default CosmosDbEndpointBuilderFactory.CosmosDbEndpointBuilder	createContainerIfNotExists(String createContainerIfNotExists)	Sets if the component should create Cosmos container automatically in case it doesn't exist in Cosmos database.
default CosmosDbEndpointBuilderFactory.CosmosDbEndpointBuilder	createDatabaseIfNotExists(boolean createDatabaseIfNotExists)	Sets if the component should create Cosmos database automatically in case it doesn't exist in Cosmos account.
default CosmosDbEndpointBuilderFactory.CosmosDbEndpointBuilder	createDatabaseIfNotExists(String createDatabaseIfNotExists)	Sets if the component should create Cosmos database automatically in case it doesn't exist in Cosmos account.
default CosmosDbEndpointBuilderFactory.CosmosDbEndpointBuilder	databaseEndpoint(String databaseEndpoint)	Sets the Azure Cosmos database endpoint the component will connect to.
default CosmosDbEndpointBuilderFactory.CosmosDbEndpointBuilder	multipleWriteRegionsEnabled(boolean multipleWriteRegionsEnabled)	Sets the flag to enable writes on any regions for geo-replicated database accounts in the Azure Cosmos DB service.
default CosmosDbEndpointBuilderFactory.CosmosDbEndpointBuilder	multipleWriteRegionsEnabled(String multipleWriteRegionsEnabled)	Sets the flag to enable writes on any regions for geo-replicated database accounts in the Azure Cosmos DB service.
default CosmosDbEndpointBuilderFactory.CosmosDbEndpointBuilder	preferredRegions(String preferredRegions)	Sets the preferred regions for geo-replicated database accounts.
default CosmosDbEndpointBuilderFactory.CosmosDbEndpointBuilder	preferredRegions(List<String> preferredRegions)	Sets the preferred regions for geo-replicated database accounts.
default CosmosDbEndpointBuilderFactory.CosmosDbEndpointBuilder	readRequestsFallbackEnabled(boolean readRequestsFallbackEnabled)	Sets whether to allow for reads to go to multiple regions configured on an account of Azure Cosmos DB service.
default CosmosDbEndpointBuilderFactory.CosmosDbEndpointBuilder	readRequestsFallbackEnabled(String readRequestsFallbackEnabled)	Sets whether to allow for reads to go to multiple regions configured on an account of Azure Cosmos DB service.
default CosmosDbEndpointBuilderFactory.CosmosDbEndpointBuilder	throughputProperties(Object throughputProperties)	Sets throughput of the resources in the Azure Cosmos DB service.
default CosmosDbEndpointBuilderFactory.CosmosDbEndpointBuilder	throughputProperties(String throughputProperties)	Sets throughput of the resources in the Azure Cosmos DB service.

Methods inherited from interface org.apache.camel.builder.endpoint.dsl.CosmosDbEndpointBuilderFactory.CosmosDbEndpointConsumerBuilder

bridgeErrorHandler, bridgeErrorHandler, changeFeedProcessorOptions, changeFeedProcessorOptions, createLeaseContainerIfNotExists, createLeaseContainerIfNotExists, createLeaseDatabaseIfNotExists, createLeaseDatabaseIfNotExists, hostName, leaseContainerName, leaseDatabaseName

Methods inherited from interface org.apache.camel.builder.endpoint.dsl.CosmosDbEndpointBuilderFactory.CosmosDbEndpointProducerBuilder

itemId, itemPartitionKey, itemPartitionKey, lazyStartProducer, lazyStartProducer, operation, operation, query, queryRequestOptions, queryRequestOptions

Methods inherited from interface org.apache.camel.builder.EndpointConsumerBuilder

doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, expr, getUri

Methods inherited from interface org.apache.camel.EndpointConsumerResolver

resolve, resolve

Methods inherited from interface org.apache.camel.builder.EndpointProducerBuilder

doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, expr, getUri

Methods inherited from interface org.apache.camel.EndpointProducerResolver

resolve, resolve

Method Detail

advanced

default CosmosDbEndpointBuilderFactory.AdvancedCosmosDbEndpointBuilder advanced()

Specified by:

advanced in interface CosmosDbEndpointBuilderFactory.CosmosDbEndpointConsumerBuilder

Specified by:

advanced in interface CosmosDbEndpointBuilderFactory.CosmosDbEndpointProducerBuilder

clientTelemetryEnabled

default CosmosDbEndpointBuilderFactory.CosmosDbEndpointBuilder 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. DEFAULT value is false indicating this is opt in feature, by default no telemetry collection. The option is a: <code>boolean</code> type. Default: false Group: common

Specified by:

clientTelemetryEnabled in interface CosmosDbEndpointBuilderFactory.CosmosDbEndpointConsumerBuilder

Specified by:

clientTelemetryEnabled in interface CosmosDbEndpointBuilderFactory.CosmosDbEndpointProducerBuilder

Parameters:

clientTelemetryEnabled - the value to set

Returns:

the dsl builder

clientTelemetryEnabled

default CosmosDbEndpointBuilderFactory.CosmosDbEndpointBuilder clientTelemetryEnabled(String 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. DEFAULT value is false indicating this is opt in feature, by default no telemetry collection. The option will be converted to a <code>boolean</code> type. Default: false Group: common

Specified by:

clientTelemetryEnabled in interface CosmosDbEndpointBuilderFactory.CosmosDbEndpointConsumerBuilder

Specified by:

clientTelemetryEnabled in interface CosmosDbEndpointBuilderFactory.CosmosDbEndpointProducerBuilder

Parameters:

clientTelemetryEnabled - the value to set

Returns:

the dsl builder

connectionSharingAcrossClientsEnabled

default CosmosDbEndpointBuilderFactory.CosmosDbEndpointBuilder connectionSharingAcrossClientsEnabled(boolean connectionSharingAcrossClientsEnabled)

Enables connections sharing across multiple Cosmos Clients. The default is false. When you have multiple instances of Cosmos Client in the same JVM interacting to multiple Cosmos accounts, enabling this allows connection sharing in Direct mode if possible between instances of Cosmos Client. Please note, when setting this option, the connection configuration (e.g., socket timeout config, idle timeout config) of the first instantiated client will be used for all other client instances. The option is a: <code>boolean</code> type. Default: false Group: common

Specified by:

connectionSharingAcrossClientsEnabled in interface CosmosDbEndpointBuilderFactory.CosmosDbEndpointConsumerBuilder

Specified by:

connectionSharingAcrossClientsEnabled in interface CosmosDbEndpointBuilderFactory.CosmosDbEndpointProducerBuilder

Parameters:

connectionSharingAcrossClientsEnabled - the value to set

Returns:

the dsl builder

connectionSharingAcrossClientsEnabled

default CosmosDbEndpointBuilderFactory.CosmosDbEndpointBuilder connectionSharingAcrossClientsEnabled(String connectionSharingAcrossClientsEnabled)

Enables connections sharing across multiple Cosmos Clients. The default is false. When you have multiple instances of Cosmos Client in the same JVM interacting to multiple Cosmos accounts, enabling this allows connection sharing in Direct mode if possible between instances of Cosmos Client. Please note, when setting this option, the connection configuration (e.g., socket timeout config, idle timeout config) of the first instantiated client will be used for all other client instances. The option will be converted to a <code>boolean</code> type. Default: false Group: common

Specified by:

connectionSharingAcrossClientsEnabled in interface CosmosDbEndpointBuilderFactory.CosmosDbEndpointConsumerBuilder

Specified by:

connectionSharingAcrossClientsEnabled in interface CosmosDbEndpointBuilderFactory.CosmosDbEndpointProducerBuilder

Parameters:

connectionSharingAcrossClientsEnabled - the value to set

Returns:

the dsl builder

consistencyLevel

default CosmosDbEndpointBuilderFactory.CosmosDbEndpointBuilder consistencyLevel(CosmosDbEndpointBuilderFactory.ConsistencyLevel consistencyLevel)

Sets the consistency levels supported for Azure Cosmos DB client operations in the Azure Cosmos DB service. The requested ConsistencyLevel must match or be weaker than that provisioned for the database account. Consistency levels by order of strength are STRONG, BOUNDED_STALENESS, SESSION and EVENTUAL. Refer to consistency level documentation for additional details: https://docs.microsoft.com/en-us/azure/cosmos-db/consistency-levels. The option is a: <code>com.azure.cosmos.ConsistencyLevel</code> type. Default: SESSION Group: common

Specified by:

consistencyLevel in interface CosmosDbEndpointBuilderFactory.CosmosDbEndpointConsumerBuilder

Specified by:

consistencyLevel in interface CosmosDbEndpointBuilderFactory.CosmosDbEndpointProducerBuilder

Parameters:

consistencyLevel - the value to set

Returns:

the dsl builder

consistencyLevel

default CosmosDbEndpointBuilderFactory.CosmosDbEndpointBuilder consistencyLevel(String consistencyLevel)

Sets the consistency levels supported for Azure Cosmos DB client operations in the Azure Cosmos DB service. The requested ConsistencyLevel must match or be weaker than that provisioned for the database account. Consistency levels by order of strength are STRONG, BOUNDED_STALENESS, SESSION and EVENTUAL. Refer to consistency level documentation for additional details: https://docs.microsoft.com/en-us/azure/cosmos-db/consistency-levels. The option will be converted to a <code>com.azure.cosmos.ConsistencyLevel</code> type. Default: SESSION Group: common

Specified by:

consistencyLevel in interface CosmosDbEndpointBuilderFactory.CosmosDbEndpointConsumerBuilder

Specified by:

consistencyLevel in interface CosmosDbEndpointBuilderFactory.CosmosDbEndpointProducerBuilder

Parameters:

consistencyLevel - the value to set

Returns:

the dsl builder

containerPartitionKeyPath

default CosmosDbEndpointBuilderFactory.CosmosDbEndpointBuilder containerPartitionKeyPath(String containerPartitionKeyPath)

Sets the container partition key path. The option is a: <code>java.lang.String</code> type. Group: common

Specified by:

containerPartitionKeyPath in interface CosmosDbEndpointBuilderFactory.CosmosDbEndpointConsumerBuilder

Specified by:

containerPartitionKeyPath in interface CosmosDbEndpointBuilderFactory.CosmosDbEndpointProducerBuilder

Parameters:

containerPartitionKeyPath - the value to set

Returns:

the dsl builder

contentResponseOnWriteEnabled

default CosmosDbEndpointBuilderFactory.CosmosDbEndpointBuilder 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. In Consumer, it is enabled by default because of the ChangeFeed in the consumer that needs this flag to be enabled and thus is shouldn't be overridden. In Producer, it advised to disable it since it reduces the network overhead. The option is a: <code>boolean</code> type. Default: true Group: common

Specified by:

contentResponseOnWriteEnabled in interface CosmosDbEndpointBuilderFactory.CosmosDbEndpointConsumerBuilder

Specified by:

contentResponseOnWriteEnabled in interface CosmosDbEndpointBuilderFactory.CosmosDbEndpointProducerBuilder

Parameters:

contentResponseOnWriteEnabled - the value to set

Returns:

the dsl builder

contentResponseOnWriteEnabled

default CosmosDbEndpointBuilderFactory.CosmosDbEndpointBuilder contentResponseOnWriteEnabled(String 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. In Consumer, it is enabled by default because of the ChangeFeed in the consumer that needs this flag to be enabled and thus is shouldn't be overridden. In Producer, it advised to disable it since it reduces the network overhead. The option will be converted to a <code>boolean</code> type. Default: true Group: common

Specified by:

contentResponseOnWriteEnabled in interface CosmosDbEndpointBuilderFactory.CosmosDbEndpointConsumerBuilder

Specified by:

contentResponseOnWriteEnabled in interface CosmosDbEndpointBuilderFactory.CosmosDbEndpointProducerBuilder

Parameters:

contentResponseOnWriteEnabled - the value to set

Returns:

the dsl builder

cosmosAsyncClient

default CosmosDbEndpointBuilderFactory.CosmosDbEndpointBuilder cosmosAsyncClient(Object cosmosAsyncClient)

Inject an external CosmosAsyncClient into the component which provides a client-side logical representation of the Azure Cosmos DB service. This asynchronous client is used to configure and execute requests against the service. The option is a: <code>com.azure.cosmos.CosmosAsyncClient</code> type. Group: common

Specified by:

cosmosAsyncClient in interface CosmosDbEndpointBuilderFactory.CosmosDbEndpointConsumerBuilder

Specified by:

cosmosAsyncClient in interface CosmosDbEndpointBuilderFactory.CosmosDbEndpointProducerBuilder

Parameters:

cosmosAsyncClient - the value to set

Returns:

the dsl builder

cosmosAsyncClient

default CosmosDbEndpointBuilderFactory.CosmosDbEndpointBuilder cosmosAsyncClient(String cosmosAsyncClient)

Inject an external CosmosAsyncClient into the component which provides a client-side logical representation of the Azure Cosmos DB service. This asynchronous client is used to configure and execute requests against the service. The option will be converted to a <code>com.azure.cosmos.CosmosAsyncClient</code> type. Group: common

Specified by:

cosmosAsyncClient in interface CosmosDbEndpointBuilderFactory.CosmosDbEndpointConsumerBuilder

Specified by:

cosmosAsyncClient in interface CosmosDbEndpointBuilderFactory.CosmosDbEndpointProducerBuilder

Parameters:

cosmosAsyncClient - the value to set

Returns:

the dsl builder

createContainerIfNotExists

default CosmosDbEndpointBuilderFactory.CosmosDbEndpointBuilder createContainerIfNotExists(boolean createContainerIfNotExists)

Sets if the component should create Cosmos container automatically in case it doesn't exist in Cosmos database. The option is a: <code>boolean</code> type. Default: false Group: common

Specified by:

createContainerIfNotExists in interface CosmosDbEndpointBuilderFactory.CosmosDbEndpointConsumerBuilder

Specified by:

createContainerIfNotExists in interface CosmosDbEndpointBuilderFactory.CosmosDbEndpointProducerBuilder

Parameters:

createContainerIfNotExists - the value to set

Returns:

the dsl builder

createContainerIfNotExists

default CosmosDbEndpointBuilderFactory.CosmosDbEndpointBuilder createContainerIfNotExists(String createContainerIfNotExists)

Sets if the component should create Cosmos container automatically in case it doesn't exist in Cosmos database. The option will be converted to a <code>boolean</code> type. Default: false Group: common

Specified by:

createContainerIfNotExists in interface CosmosDbEndpointBuilderFactory.CosmosDbEndpointConsumerBuilder

Specified by:

createContainerIfNotExists in interface CosmosDbEndpointBuilderFactory.CosmosDbEndpointProducerBuilder

Parameters:

createContainerIfNotExists - the value to set

Returns:

the dsl builder

createDatabaseIfNotExists

default CosmosDbEndpointBuilderFactory.CosmosDbEndpointBuilder createDatabaseIfNotExists(boolean createDatabaseIfNotExists)

Sets if the component should create Cosmos database automatically in case it doesn't exist in Cosmos account. The option is a: <code>boolean</code> type. Default: false Group: common

Specified by:

createDatabaseIfNotExists in interface CosmosDbEndpointBuilderFactory.CosmosDbEndpointConsumerBuilder

Specified by:

createDatabaseIfNotExists in interface CosmosDbEndpointBuilderFactory.CosmosDbEndpointProducerBuilder

Parameters:

createDatabaseIfNotExists - the value to set

Returns:

the dsl builder

createDatabaseIfNotExists

default CosmosDbEndpointBuilderFactory.CosmosDbEndpointBuilder createDatabaseIfNotExists(String createDatabaseIfNotExists)

Sets if the component should create Cosmos database automatically in case it doesn't exist in Cosmos account. The option will be converted to a <code>boolean</code> type. Default: false Group: common

Specified by:

createDatabaseIfNotExists in interface CosmosDbEndpointBuilderFactory.CosmosDbEndpointConsumerBuilder

Specified by:

createDatabaseIfNotExists in interface CosmosDbEndpointBuilderFactory.CosmosDbEndpointProducerBuilder

Parameters:

createDatabaseIfNotExists - the value to set

Returns:

the dsl builder

databaseEndpoint

default CosmosDbEndpointBuilderFactory.CosmosDbEndpointBuilder databaseEndpoint(String databaseEndpoint)

Sets the Azure Cosmos database endpoint the component will connect to. The option is a: <code>java.lang.String</code> type. Required: true Group: common

Specified by:

databaseEndpoint in interface CosmosDbEndpointBuilderFactory.CosmosDbEndpointConsumerBuilder

Specified by:

databaseEndpoint in interface CosmosDbEndpointBuilderFactory.CosmosDbEndpointProducerBuilder

Parameters:

databaseEndpoint - the value to set

Returns:

the dsl builder

multipleWriteRegionsEnabled

default CosmosDbEndpointBuilderFactory.CosmosDbEndpointBuilder multipleWriteRegionsEnabled(boolean multipleWriteRegionsEnabled)

Sets the flag to enable writes on any regions for geo-replicated database accounts in the Azure Cosmos DB service. When the value of this property is true, the SDK will direct write operations to available writable regions of geo-replicated database account. Writable regions are ordered by PreferredRegions property. Setting the property value to true has no effect until EnableMultipleWriteRegions in DatabaseAccount is also set to true. DEFAULT value is true indicating that writes are directed to available writable regions of geo-replicated database account. The option is a: <code>boolean</code> type. Default: true Group: common

Specified by:

multipleWriteRegionsEnabled in interface CosmosDbEndpointBuilderFactory.CosmosDbEndpointConsumerBuilder

Specified by:

multipleWriteRegionsEnabled in interface CosmosDbEndpointBuilderFactory.CosmosDbEndpointProducerBuilder

Parameters:

multipleWriteRegionsEnabled - the value to set

Returns:

the dsl builder

multipleWriteRegionsEnabled

default CosmosDbEndpointBuilderFactory.CosmosDbEndpointBuilder multipleWriteRegionsEnabled(String multipleWriteRegionsEnabled)

Sets the flag to enable writes on any regions for geo-replicated database accounts in the Azure Cosmos DB service. When the value of this property is true, the SDK will direct write operations to available writable regions of geo-replicated database account. Writable regions are ordered by PreferredRegions property. Setting the property value to true has no effect until EnableMultipleWriteRegions in DatabaseAccount is also set to true. DEFAULT value is true indicating that writes are directed to available writable regions of geo-replicated database account. The option will be converted to a <code>boolean</code> type. Default: true Group: common

Specified by:

multipleWriteRegionsEnabled in interface CosmosDbEndpointBuilderFactory.CosmosDbEndpointConsumerBuilder

Specified by:

multipleWriteRegionsEnabled in interface CosmosDbEndpointBuilderFactory.CosmosDbEndpointProducerBuilder

Parameters:

multipleWriteRegionsEnabled - the value to set

Returns:

the dsl builder

preferredRegions

default CosmosDbEndpointBuilderFactory.CosmosDbEndpointBuilder preferredRegions(List<String> preferredRegions)

Sets the preferred regions for geo-replicated database accounts. For example, East US as the preferred region. When EnableEndpointDiscovery is true and PreferredRegions is non-empty, the SDK will prefer to use the regions in the container in the order they are specified to perform operations. The option is a: <code>java.util.List&lt;java.lang.String&gt;</code> type. Group: common

Specified by:

preferredRegions in interface CosmosDbEndpointBuilderFactory.CosmosDbEndpointConsumerBuilder

Specified by:

preferredRegions in interface CosmosDbEndpointBuilderFactory.CosmosDbEndpointProducerBuilder

Parameters:

preferredRegions - the value to set

Returns:

the dsl builder

preferredRegions

default CosmosDbEndpointBuilderFactory.CosmosDbEndpointBuilder preferredRegions(String preferredRegions)

Sets the preferred regions for geo-replicated database accounts. For example, East US as the preferred region. When EnableEndpointDiscovery is true and PreferredRegions is non-empty, the SDK will prefer to use the regions in the container in the order they are specified to perform operations. The option will be converted to a <code>java.util.List&lt;java.lang.String&gt;</code> type. Group: common

Specified by:

preferredRegions in interface CosmosDbEndpointBuilderFactory.CosmosDbEndpointConsumerBuilder

Specified by:

preferredRegions in interface CosmosDbEndpointBuilderFactory.CosmosDbEndpointProducerBuilder

Parameters:

preferredRegions - the value to set

Returns:

the dsl builder

readRequestsFallbackEnabled

default CosmosDbEndpointBuilderFactory.CosmosDbEndpointBuilder readRequestsFallbackEnabled(boolean readRequestsFallbackEnabled)

Sets whether to allow for reads to go to multiple regions configured on an account of Azure Cosmos DB service. DEFAULT value is true. If this property is not set, the default is true for all Consistency Levels other than Bounded Staleness, The default is false for Bounded Staleness. 1. endpointDiscoveryEnabled is true 2. the Azure Cosmos DB account has more than one region. The option is a: <code>boolean</code> type. Default: true Group: common

Specified by:

readRequestsFallbackEnabled in interface CosmosDbEndpointBuilderFactory.CosmosDbEndpointConsumerBuilder

Specified by:

readRequestsFallbackEnabled in interface CosmosDbEndpointBuilderFactory.CosmosDbEndpointProducerBuilder

Parameters:

readRequestsFallbackEnabled - the value to set

Returns:

the dsl builder

readRequestsFallbackEnabled

default CosmosDbEndpointBuilderFactory.CosmosDbEndpointBuilder readRequestsFallbackEnabled(String readRequestsFallbackEnabled)

Sets whether to allow for reads to go to multiple regions configured on an account of Azure Cosmos DB service. DEFAULT value is true. If this property is not set, the default is true for all Consistency Levels other than Bounded Staleness, The default is false for Bounded Staleness. 1. endpointDiscoveryEnabled is true 2. the Azure Cosmos DB account has more than one region. The option will be converted to a <code>boolean</code> type. Default: true Group: common

Specified by:

readRequestsFallbackEnabled in interface CosmosDbEndpointBuilderFactory.CosmosDbEndpointConsumerBuilder

Specified by:

readRequestsFallbackEnabled in interface CosmosDbEndpointBuilderFactory.CosmosDbEndpointProducerBuilder

Parameters:

readRequestsFallbackEnabled - the value to set

Returns:

the dsl builder

throughputProperties

default CosmosDbEndpointBuilderFactory.CosmosDbEndpointBuilder throughputProperties(Object throughputProperties)

Sets throughput of the resources in the Azure Cosmos DB service. The option is a: <code>com.azure.cosmos.models.ThroughputProperties</code> type. Group: common

Specified by:

throughputProperties in interface CosmosDbEndpointBuilderFactory.CosmosDbEndpointConsumerBuilder

Specified by:

throughputProperties in interface CosmosDbEndpointBuilderFactory.CosmosDbEndpointProducerBuilder

Parameters:

throughputProperties - the value to set

Returns:

the dsl builder

throughputProperties

default CosmosDbEndpointBuilderFactory.CosmosDbEndpointBuilder throughputProperties(String throughputProperties)

Sets throughput of the resources in the Azure Cosmos DB service. The option will be converted to a <code>com.azure.cosmos.models.ThroughputProperties</code> type. Group: common

Specified by:

throughputProperties in interface CosmosDbEndpointBuilderFactory.CosmosDbEndpointConsumerBuilder

Specified by:

throughputProperties in interface CosmosDbEndpointBuilderFactory.CosmosDbEndpointProducerBuilder

Parameters:

throughputProperties - the value to set

Returns:

the dsl builder

accountKey

default CosmosDbEndpointBuilderFactory.CosmosDbEndpointBuilder accountKey(String accountKey)

Sets either a master or readonly key used to perform authentication for accessing resource. The option is a: <code>java.lang.String</code> type. Required: true Group: security

Specified by:

accountKey in interface CosmosDbEndpointBuilderFactory.CosmosDbEndpointConsumerBuilder

Specified by:

accountKey in interface CosmosDbEndpointBuilderFactory.CosmosDbEndpointProducerBuilder

Parameters:

accountKey - the value to set

Returns:

the dsl builder