org.apache.camel.builder.component.dsl

Interface AzureCosmosdbComponentBuilderFactory.AzureCosmosdbComponentBuilder

All Superinterfaces:

ComponentBuilder<org.apache.camel.component.azure.cosmosdb.CosmosDbComponent>

All Known Implementing Classes:

AzureCosmosdbComponentBuilderFactory.AzureCosmosdbComponentBuilderImpl

Enclosing interface:

AzureCosmosdbComponentBuilderFactory

public static interface AzureCosmosdbComponentBuilderFactory.AzureCosmosdbComponentBuilder
extends ComponentBuilder<org.apache.camel.component.azure.cosmosdb.CosmosDbComponent>

Builder for the Azure CosmosDB component.

Method Summary

Modifier and Type	Method and Description
default AzureCosmosdbComponentBuilderFactory.AzureCosmosdbComponentBuilder	accountKey(String accountKey) Sets either a master or readonly key used to perform authentication for accessing resource.
default AzureCosmosdbComponentBuilderFactory.AzureCosmosdbComponentBuilder	autowiredEnabled(boolean autowiredEnabled) Whether autowiring is enabled.
default AzureCosmosdbComponentBuilderFactory.AzureCosmosdbComponentBuilder	bridgeErrorHandler(boolean bridgeErrorHandler) Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler.
default AzureCosmosdbComponentBuilderFactory.AzureCosmosdbComponentBuilder	changeFeedProcessorOptions(com.azure.cosmos.models.ChangeFeedProcessorOptions changeFeedProcessorOptions) Sets the ChangeFeedProcessorOptions to be used.
default AzureCosmosdbComponentBuilderFactory.AzureCosmosdbComponentBuilder	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 AzureCosmosdbComponentBuilderFactory.AzureCosmosdbComponentBuilder	configuration(org.apache.camel.component.azure.cosmosdb.CosmosDbConfiguration configuration) The component configurations.
default AzureCosmosdbComponentBuilderFactory.AzureCosmosdbComponentBuilder	connectionSharingAcrossClientsEnabled(boolean connectionSharingAcrossClientsEnabled) Enables connections sharing across multiple Cosmos Clients.
default AzureCosmosdbComponentBuilderFactory.AzureCosmosdbComponentBuilder	consistencyLevel(com.azure.cosmos.ConsistencyLevel consistencyLevel) Sets the consistency levels supported for Azure Cosmos DB client operations in the Azure Cosmos DB service.
default AzureCosmosdbComponentBuilderFactory.AzureCosmosdbComponentBuilder	containerPartitionKeyPath(String containerPartitionKeyPath) Sets the container partition key path.
default AzureCosmosdbComponentBuilderFactory.AzureCosmosdbComponentBuilder	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 AzureCosmosdbComponentBuilderFactory.AzureCosmosdbComponentBuilder	cosmosAsyncClient(com.azure.cosmos.CosmosAsyncClient cosmosAsyncClient) Inject an external CosmosAsyncClient into the component which provides a client-side logical representation of the Azure Cosmos DB service.
default AzureCosmosdbComponentBuilderFactory.AzureCosmosdbComponentBuilder	createContainerIfNotExists(boolean createContainerIfNotExists) Sets if the component should create Cosmos container automatically in case it doesn't exist in Cosmos database.
default AzureCosmosdbComponentBuilderFactory.AzureCosmosdbComponentBuilder	createDatabaseIfNotExists(boolean createDatabaseIfNotExists) Sets if the component should create Cosmos database automatically in case it doesn't exist in Cosmos account.
default AzureCosmosdbComponentBuilderFactory.AzureCosmosdbComponentBuilder	createLeaseContainerIfNotExists(boolean createLeaseContainerIfNotExists) Sets if the component should create Cosmos lease container for the consumer automatically in case it doesn't exist in Cosmos database.
default AzureCosmosdbComponentBuilderFactory.AzureCosmosdbComponentBuilder	createLeaseDatabaseIfNotExists(boolean createLeaseDatabaseIfNotExists) Sets if the component should create Cosmos lease database for the consumer automatically in case it doesn't exist in Cosmos account.
default AzureCosmosdbComponentBuilderFactory.AzureCosmosdbComponentBuilder	databaseEndpoint(String databaseEndpoint) Sets the Azure Cosmos database endpoint the component will connect to.
default AzureCosmosdbComponentBuilderFactory.AzureCosmosdbComponentBuilder	hostName(String hostName) Sets the hostname.
default AzureCosmosdbComponentBuilderFactory.AzureCosmosdbComponentBuilder	itemId(String itemId) Sets the itemId in case needed for operation on item like delete, replace.
default AzureCosmosdbComponentBuilderFactory.AzureCosmosdbComponentBuilder	itemPartitionKey(com.azure.cosmos.models.PartitionKey itemPartitionKey) Sets partition key.
default AzureCosmosdbComponentBuilderFactory.AzureCosmosdbComponentBuilder	lazyStartProducer(boolean lazyStartProducer) Whether the producer should be started lazy (on the first message).
default AzureCosmosdbComponentBuilderFactory.AzureCosmosdbComponentBuilder	leaseContainerName(String leaseContainerName) Sets the lease container which acts as a state storage and coordinates processing the change feed across multiple workers.
default AzureCosmosdbComponentBuilderFactory.AzureCosmosdbComponentBuilder	leaseDatabaseName(String leaseDatabaseName) Sets the lease database where the leaseContainerName will be stored.
default AzureCosmosdbComponentBuilderFactory.AzureCosmosdbComponentBuilder	multipleWriteRegionsEnabled(boolean multipleWriteRegionsEnabled) Sets the flag to enable writes on any regions for geo-replicated database accounts in the Azure Cosmos DB service.
default AzureCosmosdbComponentBuilderFactory.AzureCosmosdbComponentBuilder	operation(org.apache.camel.component.azure.cosmosdb.CosmosDbOperationsDefinition operation) The CosmosDB operation that can be used with this component on the producer.
default AzureCosmosdbComponentBuilderFactory.AzureCosmosdbComponentBuilder	preferredRegions(List<String> preferredRegions) Sets the preferred regions for geo-replicated database accounts.
default AzureCosmosdbComponentBuilderFactory.AzureCosmosdbComponentBuilder	query(String query) An SQL query to execute on a given resources.
default AzureCosmosdbComponentBuilderFactory.AzureCosmosdbComponentBuilder	queryRequestOptions(com.azure.cosmos.models.CosmosQueryRequestOptions queryRequestOptions) Set additional QueryRequestOptions that can be used with queryItems, queryContainers, queryDatabases, listDatabases, listItems, listContainers operations.
default AzureCosmosdbComponentBuilderFactory.AzureCosmosdbComponentBuilder	readRequestsFallbackEnabled(boolean readRequestsFallbackEnabled) Sets whether to allow for reads to go to multiple regions configured on an account of Azure Cosmos DB service.
default AzureCosmosdbComponentBuilderFactory.AzureCosmosdbComponentBuilder	throughputProperties(com.azure.cosmos.models.ThroughputProperties throughputProperties) Sets throughput of the resources in the Azure Cosmos DB service.

Methods inherited from interface org.apache.camel.builder.component.ComponentBuilder

build, build, doSetProperty, register

Method Detail

clientTelemetryEnabled

default AzureCosmosdbComponentBuilderFactory.AzureCosmosdbComponentBuilder 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

Parameters:

clientTelemetryEnabled - the value to set

Returns:

the dsl builder

configuration

default AzureCosmosdbComponentBuilderFactory.AzureCosmosdbComponentBuilder configuration(org.apache.camel.component.azure.cosmosdb.CosmosDbConfiguration configuration)

The component configurations. The option is a: <code>org.apache.camel.component.azure.cosmosdb.CosmosDbConfiguration</code> type. Group: common

Parameters:

configuration - the value to set

Returns:

the dsl builder

connectionSharingAcrossClientsEnabled

default AzureCosmosdbComponentBuilderFactory.AzureCosmosdbComponentBuilder 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

Parameters:

connectionSharingAcrossClientsEnabled - the value to set

Returns:

the dsl builder

consistencyLevel

default AzureCosmosdbComponentBuilderFactory.AzureCosmosdbComponentBuilder consistencyLevel(com.azure.cosmos.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

Parameters:

consistencyLevel - the value to set

Returns:

the dsl builder

containerPartitionKeyPath

default AzureCosmosdbComponentBuilderFactory.AzureCosmosdbComponentBuilder containerPartitionKeyPath(String containerPartitionKeyPath)

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

Parameters:

containerPartitionKeyPath - the value to set

Returns:

the dsl builder

contentResponseOnWriteEnabled

default AzureCosmosdbComponentBuilderFactory.AzureCosmosdbComponentBuilder 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

Parameters:

contentResponseOnWriteEnabled - the value to set

Returns:

the dsl builder

cosmosAsyncClient

default AzureCosmosdbComponentBuilderFactory.AzureCosmosdbComponentBuilder cosmosAsyncClient(com.azure.cosmos.CosmosAsyncClient 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

Parameters:

cosmosAsyncClient - the value to set

Returns:

the dsl builder

createContainerIfNotExists

default AzureCosmosdbComponentBuilderFactory.AzureCosmosdbComponentBuilder 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

Parameters:

createContainerIfNotExists - the value to set

Returns:

the dsl builder

createDatabaseIfNotExists

default AzureCosmosdbComponentBuilderFactory.AzureCosmosdbComponentBuilder 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

Parameters:

createDatabaseIfNotExists - the value to set

Returns:

the dsl builder

databaseEndpoint

default AzureCosmosdbComponentBuilderFactory.AzureCosmosdbComponentBuilder databaseEndpoint(String databaseEndpoint)

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

Parameters:

databaseEndpoint - the value to set

Returns:

the dsl builder

multipleWriteRegionsEnabled

default AzureCosmosdbComponentBuilderFactory.AzureCosmosdbComponentBuilder 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

Parameters:

multipleWriteRegionsEnabled - the value to set

Returns:

the dsl builder

preferredRegions

default AzureCosmosdbComponentBuilderFactory.AzureCosmosdbComponentBuilder 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

Parameters:

preferredRegions - the value to set

Returns:

the dsl builder

readRequestsFallbackEnabled

default AzureCosmosdbComponentBuilderFactory.AzureCosmosdbComponentBuilder 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

Parameters:

readRequestsFallbackEnabled - the value to set

Returns:

the dsl builder

throughputProperties

default AzureCosmosdbComponentBuilderFactory.AzureCosmosdbComponentBuilder throughputProperties(com.azure.cosmos.models.ThroughputProperties 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

Parameters:

throughputProperties - the value to set

Returns:

the dsl builder

bridgeErrorHandler

default AzureCosmosdbComponentBuilderFactory.AzureCosmosdbComponentBuilder bridgeErrorHandler(boolean bridgeErrorHandler)

Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN or ERROR level and ignored. The option is a: <code>boolean</code> type. Default: false Group: consumer

Parameters:

bridgeErrorHandler - the value to set

Returns:

the dsl builder

changeFeedProcessorOptions

default AzureCosmosdbComponentBuilderFactory.AzureCosmosdbComponentBuilder changeFeedProcessorOptions(com.azure.cosmos.models.ChangeFeedProcessorOptions changeFeedProcessorOptions)

Sets the ChangeFeedProcessorOptions to be used. Unless specifically set the default values that will be used are: maximum items per page or FeedResponse: 100 lease renew interval: 17 seconds lease acquire interval: 13 seconds lease expiration interval: 60 seconds feed poll delay: 5 seconds maximum scale count: unlimited. The option is a: <code>com.azure.cosmos.models.ChangeFeedProcessorOptions</code> type. Group: consumer

Parameters:

changeFeedProcessorOptions - the value to set

Returns:

the dsl builder

createLeaseContainerIfNotExists

default AzureCosmosdbComponentBuilderFactory.AzureCosmosdbComponentBuilder createLeaseContainerIfNotExists(boolean createLeaseContainerIfNotExists)

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

Parameters:

createLeaseContainerIfNotExists - the value to set

Returns:

the dsl builder

createLeaseDatabaseIfNotExists

default AzureCosmosdbComponentBuilderFactory.AzureCosmosdbComponentBuilder createLeaseDatabaseIfNotExists(boolean createLeaseDatabaseIfNotExists)

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

Parameters:

createLeaseDatabaseIfNotExists - the value to set

Returns:

the dsl builder

hostName

default AzureCosmosdbComponentBuilderFactory.AzureCosmosdbComponentBuilder hostName(String hostName)

Sets the hostname. The host: a host is an application instance that uses the change feed processor to listen for changes. Multiple instances with the same lease configuration can run in parallel, but each instance should have a different instance name. If not specified, this will be a generated random hostname. The option is a: <code>java.lang.String</code> type. Group: consumer

Parameters:

hostName - the value to set

Returns:

the dsl builder

leaseContainerName

default AzureCosmosdbComponentBuilderFactory.AzureCosmosdbComponentBuilder leaseContainerName(String leaseContainerName)

Sets the lease container which acts as a state storage and coordinates processing the change feed across multiple workers. The lease container can be stored in the same account as the monitored container or in a separate account. It will be auto created if createLeaseContainerIfNotExists is set to true. The option is a: <code>java.lang.String</code> type. Default: camel-lease Group: consumer

Parameters:

leaseContainerName - the value to set

Returns:

the dsl builder

leaseDatabaseName

default AzureCosmosdbComponentBuilderFactory.AzureCosmosdbComponentBuilder leaseDatabaseName(String leaseDatabaseName)

Sets the lease database where the leaseContainerName will be stored. If it is not specified, this component will store the lease container in the same database that is specified in databaseName. It will be auto created if createLeaseDatabaseIfNotExists is set to true. The option is a: <code>java.lang.String</code> type. Group: consumer

Parameters:

leaseDatabaseName - the value to set

Returns:

the dsl builder

itemId

default AzureCosmosdbComponentBuilderFactory.AzureCosmosdbComponentBuilder itemId(String itemId)

Sets the itemId in case needed for operation on item like delete, replace. The option is a: <code>java.lang.String</code> type. Group: producer

Parameters:

itemId - the value to set

Returns:

the dsl builder

itemPartitionKey

default AzureCosmosdbComponentBuilderFactory.AzureCosmosdbComponentBuilder itemPartitionKey(com.azure.cosmos.models.PartitionKey itemPartitionKey)

Sets partition key. Represents a partition key value in the Azure Cosmos DB database service. A partition key identifies the partition where the item is stored in. The option is a: <code>com.azure.cosmos.models.PartitionKey</code> type. Group: producer

Parameters:

itemPartitionKey - the value to set

Returns:

the dsl builder

lazyStartProducer

default AzureCosmosdbComponentBuilderFactory.AzureCosmosdbComponentBuilder lazyStartProducer(boolean lazyStartProducer)

Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing. The option is a: <code>boolean</code> type. Default: false Group: producer

Parameters:

lazyStartProducer - the value to set

Returns:

the dsl builder

operation

default AzureCosmosdbComponentBuilderFactory.AzureCosmosdbComponentBuilder operation(org.apache.camel.component.azure.cosmosdb.CosmosDbOperationsDefinition operation)

The CosmosDB operation that can be used with this component on the producer. The option is a: <code>org.apache.camel.component.azure.cosmosdb.CosmosDbOperationsDefinition</code> type. Default: listDatabases Group: producer

Parameters:

operation - the value to set

Returns:

the dsl builder

query

default AzureCosmosdbComponentBuilderFactory.AzureCosmosdbComponentBuilder query(String query)

An SQL query to execute on a given resources. To learn more about Cosmos SQL API, check this link {link https://docs.microsoft.com/en-us/azure/cosmos-db/sql-query-getting-started}. The option is a: <code>java.lang.String</code> type. Group: producer

Parameters:

query - the value to set

Returns:

the dsl builder

queryRequestOptions

default AzureCosmosdbComponentBuilderFactory.AzureCosmosdbComponentBuilder queryRequestOptions(com.azure.cosmos.models.CosmosQueryRequestOptions queryRequestOptions)

Set additional QueryRequestOptions that can be used with queryItems, queryContainers, queryDatabases, listDatabases, listItems, listContainers operations. The option is a: <code>com.azure.cosmos.models.CosmosQueryRequestOptions</code> type. Group: producer

Parameters:

queryRequestOptions - the value to set

Returns:

the dsl builder

autowiredEnabled

default AzureCosmosdbComponentBuilderFactory.AzureCosmosdbComponentBuilder autowiredEnabled(boolean autowiredEnabled)

Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc. The option is a: <code>boolean</code> type. Default: true Group: advanced

Parameters:

autowiredEnabled - the value to set

Returns:

the dsl builder

accountKey

default AzureCosmosdbComponentBuilderFactory.AzureCosmosdbComponentBuilder 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. Group: security

Parameters:

accountKey - the value to set

Returns:

the dsl builder