Package org.apache.camel.component.azure.cosmosdb

Class CosmosDbConfiguration

java.lang.Object
org.apache.camel.component.azure.cosmosdb.CosmosDbConfiguration
All Implemented Interfaces:
Cloneable
@UriParams public class CosmosDbConfiguration extends Object implements Cloneable

  • Constructor Details

    • CosmosDbConfiguration

      public CosmosDbConfiguration()

  • Method Details

    • getDatabaseName

      public String getDatabaseName()
      The name of the Cosmos database that component should connect to. In case you are producing data and have createDatabaseIfNotExists=true, the component will automatically auto create a Cosmos database.

    • setDatabaseName

      public void setDatabaseName(String databaseName)

    • getContainerName

      public String getContainerName()
      The name of the Cosmos container that component should connect to. In case you are producing data and have createContainerIfNotExists=true, the component will automatically auto create a Cosmos container.

    • setContainerName

      public void setContainerName(String containerName)

    • getAccountKey

      public String getAccountKey()
      Sets either a master or readonly key used to perform authentication for accessing resource.

    • setAccountKey

      public void setAccountKey(String accountKey)

    • isUseDefaultIdentity

      public boolean isUseDefaultIdentity()
      Indicates whether to use the default identity mechanism instead of the access key.

    • setUseDefaultIdentity

      public void setUseDefaultIdentity(boolean useDefaultIdentity)

    • getDatabaseEndpoint

      public String getDatabaseEndpoint()
      Sets the Azure Cosmos database endpoint the component will connect to.

    • setDatabaseEndpoint

      public void setDatabaseEndpoint(String databaseEndpoint)

    • getContainerPartitionKeyPath

      public String getContainerPartitionKeyPath()
      Sets the container partition key path.

    • setContainerPartitionKeyPath

      public void setContainerPartitionKeyPath(String containerPartitionKeyPath)

    • getItemPartitionKey

      public String getItemPartitionKey()
      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.

    • setItemPartitionKey

      public void setItemPartitionKey(String itemPartitionKey)

    • getItemId

      public String getItemId()
      Sets the itemId in case needed for operation on item like delete, replace

    • setItemId

      public void setItemId(String itemId)

    • isCreateDatabaseIfNotExists

      public boolean isCreateDatabaseIfNotExists()
      Sets if the component should create Cosmos database automatically in case it doesn't exist in Cosmos account

    • setCreateDatabaseIfNotExists

      public void setCreateDatabaseIfNotExists(boolean createDatabaseIfNotExists)

    • isCreateContainerIfNotExists

      public boolean isCreateContainerIfNotExists()
      Sets if the component should create Cosmos container automatically in case it doesn't exist in Cosmos database

    • setCreateContainerIfNotExists

      public void setCreateContainerIfNotExists(boolean createContainerIfNotExists)

    • isCreateLeaseDatabaseIfNotExists

      public boolean isCreateLeaseDatabaseIfNotExists()
      Sets if the component should create Cosmos lease database for the consumer automatically in case it doesn't exist in Cosmos account

    • setCreateLeaseDatabaseIfNotExists

      public void setCreateLeaseDatabaseIfNotExists(boolean createLeaseDatabaseIfNotExists)

    • isCreateLeaseContainerIfNotExists

      public boolean isCreateLeaseContainerIfNotExists()
      Sets if the component should create Cosmos lease container for the consumer automatically in case it doesn't exist in Cosmos database

    • setCreateLeaseContainerIfNotExists

      public void setCreateLeaseContainerIfNotExists(boolean createLeaseContainerIfNotExists)

    • getCosmosAsyncClient

      public com.azure.cosmos.CosmosAsyncClient getCosmosAsyncClient()
      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.

    • setCosmosAsyncClient

      public void setCosmosAsyncClient(com.azure.cosmos.CosmosAsyncClient cosmosAsyncClient)

    • getQueryRequestOptions

      public com.azure.cosmos.models.CosmosQueryRequestOptions getQueryRequestOptions()
      Set additional QueryRequestOptions that can be used with queryItems, queryContainers, queryDatabases, listDatabases, listItems, listContainers operations

    • setQueryRequestOptions

      public void setQueryRequestOptions(com.azure.cosmos.models.CosmosQueryRequestOptions queryRequestOptions)

    • getConsistencyLevel

      public com.azure.cosmos.ConsistencyLevel getConsistencyLevel()
      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

    • setConsistencyLevel

      public void setConsistencyLevel(com.azure.cosmos.ConsistencyLevel consistencyLevel)

    • getPreferredRegions

      public String getPreferredRegions()
      Sets the comma separated 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.

    • setPreferredRegions

      public void setPreferredRegions(String preferredRegions)

    • isClientTelemetryEnabled

      public boolean isClientTelemetryEnabled()
      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.

    • setClientTelemetryEnabled

      public void setClientTelemetryEnabled(boolean clientTelemetryEnabled)

    • isConnectionSharingAcrossClientsEnabled

      public boolean isConnectionSharingAcrossClientsEnabled()
      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.

    • setConnectionSharingAcrossClientsEnabled

      public void setConnectionSharingAcrossClientsEnabled(boolean connectionSharingAcrossClientsEnabled)

    • isMultipleWriteRegionsEnabled

      public boolean isMultipleWriteRegionsEnabled()
      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.

    • setMultipleWriteRegionsEnabled

      public void setMultipleWriteRegionsEnabled(boolean multipleWriteRegionsEnabled)

    • isReadRequestsFallbackEnabled

      public boolean isReadRequestsFallbackEnabled()
      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.

      invalid reference 
      #endpointDiscoveryEnabled
      is true 2. the Azure Cosmos DB account has more than one region

    • setReadRequestsFallbackEnabled

      public void setReadRequestsFallbackEnabled(boolean readRequestsFallbackEnabled)

    • getQuery

      public String getQuery()
      An SQL query to execute on a given resources. To learn more about Cosmos SQL API, check this link
      invalid @link 
      {@link https://docs.microsoft.com/en-us/azure/cosmos-db/sql-query-getting-started
      }

    • setQuery

      public void setQuery(String query)

    • getThroughputProperties

      public com.azure.cosmos.models.ThroughputProperties getThroughputProperties()
      Sets throughput of the resources in the Azure Cosmos DB service.

    • setThroughputProperties

      public void setThroughputProperties(com.azure.cosmos.models.ThroughputProperties throughputProperties)

    • isContentResponseOnWriteEnabled

      public boolean isContentResponseOnWriteEnabled()
      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

    • setContentResponseOnWriteEnabled

      public void setContentResponseOnWriteEnabled(boolean contentResponseOnWriteEnabled)

    • getLeaseContainerName

      public String getLeaseContainerName()
      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.

    • setLeaseContainerName

      public void setLeaseContainerName(String leaseContainerName)

    • getLeaseDatabaseName

      public String getLeaseDatabaseName()
      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.

    • setLeaseDatabaseName

      public void setLeaseDatabaseName(String leaseDatabaseName)

    • getHostName

      public String getHostName()
      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.

    • setHostName

      public void setHostName(String hostName)

    • getChangeFeedProcessorOptions

      public com.azure.cosmos.models.ChangeFeedProcessorOptions getChangeFeedProcessorOptions()
      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

    • setChangeFeedProcessorOptions

      public void setChangeFeedProcessorOptions(com.azure.cosmos.models.ChangeFeedProcessorOptions changeFeedProcessorOptions)

    • getOperation

      public CosmosDbOperationsDefinition getOperation()
      The CosmosDB operation that can be used with this component on the producer.

    • setOperation

      public void setOperation(CosmosDbOperationsDefinition operation)

    • getIndexingPolicy

      public com.azure.cosmos.models.IndexingPolicy getIndexingPolicy()
      The CosmosDB Indexing Policy that will be set in case of container creation, this option is related to createLeaseContainerIfNotExists and it will be taken into account when the latter is true.

    • setIndexingPolicy

      public void setIndexingPolicy(com.azure.cosmos.models.IndexingPolicy indexingPolicy)

    • copy

      public CosmosDbConfiguration copy()