com.azure.cosmos

Class CosmosContainer

java.lang.Object

com.azure.cosmos.CosmosContainer

public class CosmosContainer
extends Object

Provides synchronous methods for reading, deleting, and replacing existing Containers Provides methods for interacting with child resources (Items, Scripts, Conflicts)

Method Summary

Modifier and Type	Method and Description
<T> CosmosItemResponse<T>	createItem(T item) Creates a new item synchronously and returns its respective Cosmos item response.
<T> CosmosItemResponse<T>	createItem(T item, CosmosItemRequestOptions options) Creates a new item synchronously and returns its respective Cosmos item response while specifying additional options.
<T> CosmosItemResponse<T>	createItem(T item, PartitionKey partitionKey, CosmosItemRequestOptions options) Creates a new item synchronously and returns its respective Cosmos item response while specifying additional options.
CosmosContainerResponse	delete() Deletes the current cosmos container.
CosmosContainerResponse	delete(CosmosContainerRequestOptions options) Deletes the current Cosmos container while specifying additional options such as If-Match.
CosmosItemResponse<Object>	deleteItem(String itemId, PartitionKey partitionKey, CosmosItemRequestOptions options) Deletes an item in the current container.
<T> CosmosItemResponse<Object>	deleteItem(T item, CosmosItemRequestOptions options) Deletes an item in the current container.
void	enableGlobalThroughputControlGroup(ThroughputControlGroupConfig groupConfig, GlobalThroughputControlConfig globalControlConfig) Enable the throughput control group with global control mode.
void	enableLocalThroughputControlGroup(ThroughputControlGroupConfig groupConfig) Enable the throughput control group with local control mode.
TransactionalBatchResponse	executeTransactionalBatch(TransactionalBatch transactionalBatch) Executes the transactional batch.
TransactionalBatchResponse	executeTransactionalBatch(TransactionalBatch transactionalBatch, TransactionalBatchRequestOptions requestOptions) Executes the transactional batch.
List<FeedRange>	getFeedRanges() Obtains a list of FeedRange that can be used to parallelize Feed operations.
String	getId() Gets the current container id.
CosmosScripts	getScripts() Gets the Cosmos scripts using the current container as context.
void	openConnectionsAndInitCaches() Initializes the container by warming up the caches and connections for the current read region.
<T> CosmosItemResponse<T>	patchItem(String itemId, PartitionKey partitionKey, CosmosPatchOperations cosmosPatchOperations, Class<T> itemType) Run patch operations on an Item.
<T> CosmosItemResponse<T>	patchItem(String itemId, PartitionKey partitionKey, CosmosPatchOperations cosmosPatchOperations, CosmosPatchItemRequestOptions options, Class<T> itemType) Run patch operations on an Item.
<TContext> List<CosmosBulkOperationResponse<TContext>>	processBulkOperations(Iterable<CosmosItemOperation> operations) Executes list of operations in Bulk.
<TContext> List<CosmosBulkOperationResponse<TContext>>	processBulkOperations(Iterable<CosmosItemOperation> operations, BulkExecutionOptions bulkOptions) Executes list of operations in Bulk.
<TContext> List<CosmosBulkOperationResponse<TContext>>	processBulkOperations(Iterable<CosmosItemOperation> operations, BulkProcessingOptions<TContext> bulkOptions) Deprecated. forRemoval = true, since = "4.18" This overload will be removed. Please use one of the following overloads instead - CosmosAsyncContainer.processBulkOperations(Flux) - CosmosAsyncContainer.processBulkOperations(Flux, BulkExecutionOptions) - CosmosContainer.processBulkOperations(Iterable) - CosmosContainer.processBulkOperations(Iterable, BulkExecutionOptions) and to pass in a custom context use one of the BulkOperations factory methods allowing to provide an operation specific context
<T> CosmosPagedIterable<T>	queryChangeFeed(CosmosChangeFeedRequestOptions options, Class<T> classType) Query for items in the change feed of the current container using the CosmosChangeFeedRequestOptions.
<T> CosmosPagedIterable<T>	queryItems(SqlQuerySpec querySpec, CosmosQueryRequestOptions options, Class<T> classType) Query items in the current container returning the results as CosmosPagedIterable.
<T> CosmosPagedIterable<T>	queryItems(String query, CosmosQueryRequestOptions options, Class<T> classType) Query items in the current container returning the results as CosmosPagedIterable.
CosmosContainerResponse	read() Reads the current container.
CosmosContainerResponse	read(CosmosContainerRequestOptions options) Reads the current container while specifying additional options such as If-Match.
<T> CosmosPagedIterable<T>	readAllItems(PartitionKey partitionKey, Class<T> classType) Reads all the items of a logical partition returning the results as CosmosPagedIterable.
<T> CosmosPagedIterable<T>	readAllItems(PartitionKey partitionKey, CosmosQueryRequestOptions options, Class<T> classType) Reads all the items of a logical partition returning the results as CosmosPagedIterable.
<T> CosmosItemResponse<T>	readItem(String itemId, PartitionKey partitionKey, Class<T> itemType) Reads an item in the current container.
<T> CosmosItemResponse<T>	readItem(String itemId, PartitionKey partitionKey, CosmosItemRequestOptions options, Class<T> itemType) Reads an item in the current container while specifying additional options.
<T> FeedResponse<T>	readMany(List<CosmosItemIdentity> itemIdentityList, Class<T> classType) Reads many documents.
<T> FeedResponse<T>	readMany(List<CosmosItemIdentity> itemIdentityList, String sessionToken, Class<T> classType) Reads many documents.
ThroughputResponse	readThroughput() Gets the throughput for the current container.
CosmosContainerResponse	replace(CosmosContainerProperties containerProperties) Replaces the current container properties.
CosmosContainerResponse	replace(CosmosContainerProperties containerProperties, CosmosContainerRequestOptions options) Replaces the current container properties while specifying additional options such as If-Match.
<T> CosmosItemResponse<T>	replaceItem(T item, String itemId, PartitionKey partitionKey, CosmosItemRequestOptions options) Replaces an item in the current container.
ThroughputResponse	replaceThroughput(ThroughputProperties throughputProperties) Sets the throughput for the current container.
<T> CosmosItemResponse<T>	upsertItem(T item) Upserts an Cosmos item in the current container.
<T> CosmosItemResponse<T>	upsertItem(T item, CosmosItemRequestOptions options) Upserts a item Cosmos sync item while specifying additional options.
<T> CosmosItemResponse<T>	upsertItem(T item, PartitionKey partitionKey, CosmosItemRequestOptions options) Upserts a item Cosmos sync item while specifying additional options.

Methods inherited from class java.lang.Object

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

Method Detail

getId

public String getId()

Gets the current container id.

Returns:

the container id.

read

public CosmosContainerResponse read()

Reads the current container.

Returns:

the Cosmos container response with the read container.

read

public CosmosContainerResponse read(CosmosContainerRequestOptions options)

Reads the current container while specifying additional options such as If-Match.

Parameters:

options - the options.

Returns:

the Cosmos container response.

delete

public CosmosContainerResponse delete(CosmosContainerRequestOptions options)

Deletes the current Cosmos container while specifying additional options such as If-Match.

Parameters:

options - the options.

Returns:

the cosmos container response.

delete

public CosmosContainerResponse delete()

Deletes the current cosmos container.

Returns:

the cosmos container response.

replace

public CosmosContainerResponse replace(CosmosContainerProperties containerProperties)

Replaces the current container properties.

Parameters:

containerProperties - the container properties.

Returns:

the cosmos container response.

replace

public CosmosContainerResponse replace(CosmosContainerProperties containerProperties,
                                       CosmosContainerRequestOptions options)

Replaces the current container properties while specifying additional options such as If-Match.

Parameters:

containerProperties - the container properties.

options - the options.

Returns:

the cosmos container response.

replaceThroughput

public ThroughputResponse replaceThroughput(ThroughputProperties throughputProperties)

Sets the throughput for the current container.

Parameters:

throughputProperties - the throughput properties.

Returns:

the throughput response.

readThroughput

public ThroughputResponse readThroughput()

Gets the throughput for the current container.

Returns:

the throughput response.

createItem

public <T> CosmosItemResponse<T> createItem(T item)

Creates a new item synchronously and returns its respective Cosmos item response.

Type Parameters:

T - the type parameter

Parameters:

item - the item

Returns:

the Cosmos item response

createItem

public <T> CosmosItemResponse<T> createItem(T item,
                                            PartitionKey partitionKey,
                                            CosmosItemRequestOptions options)

Creates a new item synchronously and returns its respective Cosmos item response while specifying additional options.

Type Parameters:

T - the type parameter.

Parameters:

item - the item.

partitionKey - the partition key.

options - the options.

Returns:

the Cosmos item response.

createItem

public <T> CosmosItemResponse<T> createItem(T item,
                                            CosmosItemRequestOptions options)

Creates a new item synchronously and returns its respective Cosmos item response while specifying additional options.

The partition key value will be automatically extracted from the item's content.

Type Parameters:

T - the type parameter.

Parameters:

item - the item.

options - the options.

Returns:

the cosmos item response.

upsertItem

public <T> CosmosItemResponse<T> upsertItem(T item)

Upserts an Cosmos item in the current container.

Type Parameters:

T - the type parameter.

Parameters:

item - the item.

Returns:

the Cosmos item response.

upsertItem

public <T> CosmosItemResponse<T> upsertItem(T item,
                                            CosmosItemRequestOptions options)

Upserts a item Cosmos sync item while specifying additional options.

Type Parameters:

T - the type parameter.

Parameters:

item - the item.

options - the options.

Returns:

the Cosmos item response.

upsertItem

public <T> CosmosItemResponse<T> upsertItem(T item,
                                            PartitionKey partitionKey,
                                            CosmosItemRequestOptions options)

Upserts a item Cosmos sync item while specifying additional options.

Type Parameters:

T - the type parameter.

Parameters:

item - the item.

partitionKey - the partitionKey.

options - the options.

Returns:

the Cosmos item response.

queryItems

public <T> CosmosPagedIterable<T> queryItems(String query,
                                             CosmosQueryRequestOptions options,
                                             Class<T> classType)

Query items in the current container returning the results as CosmosPagedIterable.

Type Parameters:

T - the type parameter.

Parameters:

query - the query.

options - the options.

classType - the class type.

Returns:

the CosmosPagedIterable.

queryItems

public <T> CosmosPagedIterable<T> queryItems(SqlQuerySpec querySpec,
                                             CosmosQueryRequestOptions options,
                                             Class<T> classType)

Query items in the current container returning the results as CosmosPagedIterable.

Type Parameters:

T - the type parameter.

Parameters:

querySpec - the query spec.

options - the options.

classType - the class type.

Returns:

the CosmosPagedIterable.

queryChangeFeed

@Beta(value=V4_12_0,
      warningText="Preview API - subject to change in non-backwards compatible way")
public <T> CosmosPagedIterable<T> queryChangeFeed(CosmosChangeFeedRequestOptions options,
                                                                                                                                                            Class<T> classType)

Query for items in the change feed of the current container using the CosmosChangeFeedRequestOptions.

The next page can be retrieved by calling queryChangeFeed again with a new instance of CosmosChangeFeedRequestOptions created from the continuation token of the previously returned FeedResponse instance.

Type Parameters:

T - the type parameter.

Parameters:

options - the change feed request options.

classType - the class type.

Returns:

a CosmosPagedFlux containing one feed response page

readMany

public <T> FeedResponse<T> readMany(List<CosmosItemIdentity> itemIdentityList,
                                    Class<T> classType)

Reads many documents.

Type Parameters:

T - the type parameter

Parameters:

itemIdentityList - CosmosItem id and partition key tuple of items that that needs to be read

classType - class type

Returns:

a Mono with feed response of cosmos items

readMany

public <T> FeedResponse<T> readMany(List<CosmosItemIdentity> itemIdentityList,
                                    String sessionToken,
                                    Class<T> classType)

Reads many documents.

Type Parameters:

T - the type parameter

Parameters:

itemIdentityList - CosmosItem id and partition key tuple of items that that needs to be read

sessionToken - the optional Session token - null if the read can be made without specific session token

classType - class type

Returns:

a Mono with feed response of cosmos items

readAllItems

public <T> CosmosPagedIterable<T> readAllItems(PartitionKey partitionKey,
                                               Class<T> classType)

Reads all the items of a logical partition returning the results as CosmosPagedIterable.

Type Parameters:

T - the type parameter.

Parameters:

partitionKey - the partition key value of the documents that need to be read

classType - the class type.

Returns:

the CosmosPagedIterable.

readAllItems

public <T> CosmosPagedIterable<T> readAllItems(PartitionKey partitionKey,
                                               CosmosQueryRequestOptions options,
                                               Class<T> classType)

Reads all the items of a logical partition returning the results as CosmosPagedIterable.

Type Parameters:

T - the type parameter.

Parameters:

partitionKey - the partition key value of the documents that need to be read

options - the feed options.

classType - the class type.

Returns:

the CosmosPagedIterable.

readItem

public <T> CosmosItemResponse<T> readItem(String itemId,
                                          PartitionKey partitionKey,
                                          Class<T> itemType)

Reads an item in the current container.

Type Parameters:

T - the type parameter.

Parameters:

itemId - the item id.

partitionKey - the partition key.

itemType - the class type of item.

Returns:

the Cosmos item response.

readItem

public <T> CosmosItemResponse<T> readItem(String itemId,
                                          PartitionKey partitionKey,
                                          CosmosItemRequestOptions options,
                                          Class<T> itemType)

Reads an item in the current container while specifying additional options.

Type Parameters:

T - the type parameter.

Parameters:

itemId - the item id.

partitionKey - the partition key.

options - the options.

itemType - the class type of item.

Returns:

the Cosmos item response.

replaceItem

public <T> CosmosItemResponse<T> replaceItem(T item,
                                             String itemId,
                                             PartitionKey partitionKey,
                                             CosmosItemRequestOptions options)

Replaces an item in the current container.

Type Parameters:

T - the type parameter.

Parameters:

item - the item.

itemId - the item id.

partitionKey - the partition key.

options - the options.

Returns:

the Cosmos item response.

patchItem

@Beta(value=V4_11_0,
      warningText="Preview API - subject to change in non-backwards compatible way")
public <T> CosmosItemResponse<T> patchItem(String itemId,
                                                                                                                                                     PartitionKey partitionKey,
                                                                                                                                                     CosmosPatchOperations cosmosPatchOperations,
                                                                                                                                                     Class<T> itemType)

Run patch operations on an Item.

Type Parameters:

T - the type parameter.

Parameters:

itemId - the item id.

partitionKey - the partition key.

cosmosPatchOperations - Represents a container having list of operations to be sequentially applied to the referred Cosmos item.

itemType - the item type.

Returns:

the Cosmos item resource response with the patched item or an exception.

patchItem

@Beta(value=V4_11_0,
      warningText="Preview API - subject to change in non-backwards compatible way")
public <T> CosmosItemResponse<T> patchItem(String itemId,
                                                                                                                                                     PartitionKey partitionKey,
                                                                                                                                                     CosmosPatchOperations cosmosPatchOperations,
                                                                                                                                                     CosmosPatchItemRequestOptions options,
                                                                                                                                                     Class<T> itemType)

Run patch operations on an Item.

Type Parameters:

T - the type parameter.

Parameters:

itemId - the item id.

partitionKey - the partition key.

cosmosPatchOperations - Represents a container having list of operations to be sequentially applied to the referred Cosmos item.

options - the request options.

itemType - the item type.

Returns:

the Cosmos item resource response with the patched item or an exception.

deleteItem

public CosmosItemResponse<Object> deleteItem(String itemId,
                                             PartitionKey partitionKey,
                                             CosmosItemRequestOptions options)

Deletes an item in the current container.

Parameters:

itemId - the item id.

partitionKey - the partition key.

options - the options.

Returns:

the Cosmos item response.

deleteItem

public <T> CosmosItemResponse<Object> deleteItem(T item,
                                                 CosmosItemRequestOptions options)

Deletes an item in the current container.

Type Parameters:

T - the type parameter.

Parameters:

item - the item to be deleted.

options - the options.

Returns:

the Cosmos item response.

executeTransactionalBatch

@Beta(value=V4_7_0,
      warningText="Preview API - subject to change in non-backwards compatible way")
public TransactionalBatchResponse executeTransactionalBatch(TransactionalBatch transactionalBatch)

Executes the transactional batch.

Parameters:

transactionalBatch - Batch having list of operation and partition key which will be executed by this container.

Returns:

A TransactionalBatchResponse which contains details of execution of the transactional batch.

If the transactional batch executes successfully, the value returned by TransactionalBatchResponse.getStatusCode() on the response returned will be set to 200}.

If an operation within the transactional batch fails during execution, no changes from the batch will be committed and the status of the failing operation is made available by TransactionalBatchResponse.getStatusCode() or by the exception. To obtain information about the operations that failed in case of some user error like conflict, not found etc, the response can be enumerated. This returns TransactionalBatchOperationResult instances corresponding to each operation in the transactional batch in the order they were added to the transactional batch. For a result corresponding to an operation within the transactional batch, use TransactionalBatchOperationResult.getStatusCode() to access the status of the operation. If the operation was not executed or it was aborted due to the failure of another operation within the transactional batch, the value of this field will be 424; for the operation that caused the batch to abort, the value of this field will indicate the cause of failure.

If there are issues such as request timeouts, Gone, session not available, network failure or if the service somehow returns 5xx then this will throw an exception instead of returning a TransactionalBatchResponse.

Use TransactionalBatchResponse.isSuccessStatusCode() on the response returned to ensure that the transactional batch succeeded.

executeTransactionalBatch

@Beta(value=V4_7_0,
      warningText="Preview API - subject to change in non-backwards compatible way")
public TransactionalBatchResponse executeTransactionalBatch(TransactionalBatch transactionalBatch,
                                                                                                                                                                     TransactionalBatchRequestOptions requestOptions)

Executes the transactional batch.

Parameters:

transactionalBatch - Batch having list of operation and partition key which will be executed by this container.

requestOptions - Options that apply specifically to batch request.

Returns:

A TransactionalBatchResponse which contains details of execution of the transactional batch.

If the transactional batch executes successfully, the value returned by TransactionalBatchResponse.getStatusCode() on the response returned will be set to 200}.

If an operation within the transactional batch fails during execution, no changes from the batch will be committed and the status of the failing operation is made available by TransactionalBatchResponse.getStatusCode() or by the exception. To obtain information about the operations that failed in case of some user error like conflict, not found etc, the response can be enumerated. This returns TransactionalBatchOperationResult instances corresponding to each operation in the transactional batch in the order they were added to the transactional batch. For a result corresponding to an operation within the transactional batch, use TransactionalBatchOperationResult.getStatusCode() to access the status of the operation. If the operation was not executed or it was aborted due to the failure of another operation within the transactional batch, the value of this field will be 424; for the operation that caused the batch to abort, the value of this field will indicate the cause of failure.

If there are issues such as request timeouts, Gone, session not available, network failure or if the service somehow returns 5xx then this will throw an exception instead of returning a TransactionalBatchResponse.

Use TransactionalBatchResponse.isSuccessStatusCode() on the response returned to ensure that the transactional batch succeeded.

processBulkOperations

@Beta(value=V4_9_0,
      warningText="Preview API - subject to change in non-backwards compatible way")
public <TContext> List<CosmosBulkOperationResponse<TContext>> processBulkOperations(Iterable<CosmosItemOperation> operations)

Executes list of operations in Bulk.

Type Parameters:

TContext - The context for the bulk processing.

Parameters:

operations - list of operation which will be executed by this container.

Returns:

A list of CosmosBulkOperationResponse which contains operation and it's response or exception.

To create a operation which can be executed here, use BulkOperations. For eg. for a upsert operation use BulkOperations.getUpsertItemOperation(Object, PartitionKey)

We can get the corresponding operation using CosmosBulkOperationResponse.getOperation() and it's response using CosmosBulkOperationResponse.getResponse(). If the operation was executed successfully, the value returned by CosmosBulkItemResponse.isSuccessStatusCode() will be true. To get actual status use CosmosBulkItemResponse.getStatusCode().

To check if the operation had any exception, use CosmosBulkOperationResponse.getException() to get the exception.

processBulkOperations

@Beta(value=V4_9_0,
      warningText="Preview API - subject to change in non-backwards compatible way")
 @Deprecated
public <TContext> List<CosmosBulkOperationResponse<TContext>> processBulkOperations(Iterable<CosmosItemOperation> operations,
                                                                                                                                                                                                          BulkProcessingOptions<TContext> bulkOptions)

Deprecated. forRemoval = true, since = "4.18" This overload will be removed. Please use one of the following overloads instead - CosmosAsyncContainer.processBulkOperations(Flux) - CosmosAsyncContainer.processBulkOperations(Flux, BulkExecutionOptions) - CosmosContainer.processBulkOperations(Iterable) - CosmosContainer.processBulkOperations(Iterable, BulkExecutionOptions) and to pass in a custom context use one of the BulkOperations factory methods allowing to provide an operation specific context

Executes list of operations in Bulk.

Type Parameters:

TContext - The context for the bulk processing.

Parameters:

operations - list of operation which will be executed by this container.

bulkOptions - Options that apply for this Bulk request which specifies options regarding execution like concurrency, batching size, interval and context.

Returns:

A list of CosmosBulkOperationResponse which contains operation and it's response or exception.

To create a operation which can be executed here, use BulkOperations. For eg. for a upsert operation use BulkOperations.getUpsertItemOperation(Object, PartitionKey)

We can get the corresponding operation using CosmosBulkOperationResponse.getOperation() and it's response using CosmosBulkOperationResponse.getResponse(). If the operation was executed successfully, the value returned by CosmosBulkItemResponse.isSuccessStatusCode() will be true. To get actual status use CosmosBulkItemResponse.getStatusCode().

To check if the operation had any exception, use CosmosBulkOperationResponse.getException() to get the exception.

processBulkOperations

@Beta(value=V4_18_0,
      warningText="Preview API - subject to change in non-backwards compatible way")
public <TContext> List<CosmosBulkOperationResponse<TContext>> processBulkOperations(Iterable<CosmosItemOperation> operations,
                                                                                                                                                                                              BulkExecutionOptions bulkOptions)

Executes list of operations in Bulk.

Type Parameters:

TContext - The context for the bulk processing.

Parameters:

operations - list of operation which will be executed by this container.

bulkOptions - Options that apply for this Bulk request which specifies options regarding execution like concurrency, batching size, interval and context.

Returns:

A list of CosmosBulkOperationResponse which contains operation and it's response or exception.

To create a operation which can be executed here, use BulkOperations. For eg. for a upsert operation use BulkOperations.getUpsertItemOperation(Object, PartitionKey)

We can get the corresponding operation using CosmosBulkOperationResponse.getOperation() and it's response using CosmosBulkOperationResponse.getResponse(). If the operation was executed successfully, the value returned by CosmosBulkItemResponse.isSuccessStatusCode() will be true. To get actual status use CosmosBulkItemResponse.getStatusCode().

To check if the operation had any exception, use CosmosBulkOperationResponse.getException() to get the exception.

getScripts

public CosmosScripts getScripts()

Gets the Cosmos scripts using the current container as context.

Returns:

the Cosmos sync scripts.

getFeedRanges

@Beta(value=V4_9_0,
      warningText="Preview API - subject to change in non-backwards compatible way")
public List<FeedRange> getFeedRanges()

Obtains a list of FeedRange that can be used to parallelize Feed operations.

Returns:

An unmodifiable list of FeedRange

enableLocalThroughputControlGroup

@Beta(value=V4_13_0,
      warningText="Preview API - subject to change in non-backwards compatible way")
public void enableLocalThroughputControlGroup(ThroughputControlGroupConfig groupConfig)

Enable the throughput control group with local control mode.

 ThroughputControlGroupConfig groupConfig =
     new ThroughputControlGroupConfigBuilder()
         .setGroupName("localControlGroup")
         .setTargetThroughputThreshold(0.1)
         .build();
 
 container.enableLocalThroughputControlGroup(groupConfig);
 

Parameters:

groupConfig - A GlobalThroughputControlConfig.

enableGlobalThroughputControlGroup

@Beta(value=V4_13_0,
      warningText="Preview API - subject to change in non-backwards compatible way")
public void enableGlobalThroughputControlGroup(ThroughputControlGroupConfig groupConfig,
                                                                                                                                                         GlobalThroughputControlConfig globalControlConfig)

Enable the throughput control group with global control mode. The defined throughput limit will be shared across different clients.

 ThroughputControlGroupConfig groupConfig =
     new ThroughputControlGroupConfigBuilder()
         .setGroupName("localControlGroup")
         .setTargetThroughputThreshold(0.1)
         .build();
 
 GlobalThroughputControlConfig globalControlConfig =
     this.client.createGlobalThroughputControlConfigBuilder(database.getId(), container.getId())
         .setControlItemRenewInterval(Duration.ofSeconds(5))
         .setControlItemExpireInterval(Duration.ofSeconds(10))
         .build();
 
 container.enableGlobalThroughputControlGroup(groupConfig, globalControlConfig);
 

Parameters:

groupConfig - The throughput control group configuration, see GlobalThroughputControlGroup.

globalControlConfig - The global throughput control configuration, see GlobalThroughputControlConfig.

openConnectionsAndInitCaches

@Beta(value=V4_14_0,
      warningText="Preview API - subject to change in non-backwards compatible way")
public void openConnectionsAndInitCaches()

Initializes the container by warming up the caches and connections for the current read region.

The execution of this method is expected to result in some RU charges to your account. The number of RU consumed by this request varies, depending on data consistency, size of the overall data in the container, item indexing, number of projections. For more information regarding RU considerations please visit https://docs.microsoft.com/en-us/azure/cosmos-db/request-units#request-unit-considerations.

NOTE: This API ideally should be called only once during application initialization before any workload.
In case of any transient error, caller should consume the error and continue the regular workload.