Uses of Class
com.azure.cosmos.util.Beta

Packages that use Beta

Package	Description
com.azure.cosmos	This package provides interfaces for interacting with Azure Cosmos DB.
com.azure.cosmos.models	This package provides rest contracts for interacting with Azure Cosmos DB SQL APIs.

Uses of Beta in com.azure.cosmos

Classes in com.azure.cosmos with annotations of type Beta

Modifier and Type	Class and Description
class	BulkExecutionOptions
class	BulkExecutionThresholds Encapsulates internal state used to dynamically determine max micro batch size for bulk operations.
class	BulkItemRequestOptions Encapsulates options that can be specified for an operation used in Bulk execution.
class	BulkOperations Utility for creating bulk operations which can be executed by calling CosmosAsyncContainer.processBulkOperations(Flux, BulkExecutionOptions) .
class	BulkPatchItemRequestOptions Encapsulates options that can be specified for an patch operation used in Bulk execution.
class	BulkProcessingOptions<TContext> Deprecated. forRemoval = true, since = "4.18" This class is not necessary anymore and 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 Encapsulates options for executing a bulk. This is immutable once CosmosAsyncContainer.processBulkOperations(Flux, BulkProcessingOptions) is called, changing it will have no affect.
class	BulkProcessingThresholds<TContext> Deprecated. forRemoval = true, since = "4.18" This class is not necessary anymore and 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 Encapsulates internal state used to dynamically determine max micro batch size for bulk operations. It allows passing this state for one `BulkProcessingOptions` to another in case bulk operations are expected to have similar characteristics and the context for determining the micro batch size should be preserved.
class	CosmosAsyncClientEncryptionKey The type Cosmos async clientEncryptionKey.
class	CosmosBulkItemResponse Response of a CosmosItemOperation request when processed using Bulk by calling CosmosAsyncContainer.processBulkOperations(Flux, BulkProcessingOptions).
class	CosmosBulkOperationResponse<TContext> Request, response and the exception(if any) for a CosmosItemOperation request when processed using Bulk by calling CosmosAsyncContainer.processBulkOperations(Flux, BulkProcessingOptions).
class	CosmosClientEncryptionKey The type Cosmos clientEncryptionKey.
interface	CosmosItemOperation
class	CosmosItemOperationType
class	CosmosPatchOperations Grammar is a super set of this RFC: https://tools.ietf.org/html/rfc6902#section-4.1 Contains a list of Patch operations to be applied on an item.
class	GlobalThroughputControlConfig This configuration is used for throughput global control mode.
class	GlobalThroughputControlConfigBuilder Throughput global control config builder.
class	ThroughputControlGroupConfig Throughput control group configuration.
class	ThroughputControlGroupConfigBuilder The throughput control group config builder.
class	TransactionalBatch Represents a batch of operations against items with the same PartitionKey in a container that will be performed in a transactional manner at the Azure Cosmos DB service.
class	TransactionalBatchItemRequestOptions Encapsulates options that can be specified for an operation within a TransactionalBatch.
class	TransactionalBatchOperationResult Represents a result for a specific operation that was part of a TransactionalBatch request.
class	TransactionalBatchPatchItemRequestOptions
class	TransactionalBatchRequestOptions Encapsulates options that can be specified for a TransactionalBatch.
class	TransactionalBatchResponse Response of a TransactionalBatch request.

Methods in com.azure.cosmos with annotations of type Beta

Modifier and Type	Method and Description
<T> CosmosPatchOperations	CosmosPatchOperations.add(String path, T value) This performs one of the following functions, depending upon what the target location references: 1.
GlobalThroughputControlConfig	GlobalThroughputControlConfigBuilder.build() Validate the throughput global control configuration and create a new throughput global control config item.
ThroughputControlGroupConfig	ThroughputControlGroupConfigBuilder.build() Validate the throughput configuration and create a new throughput control group config item.
static CosmosPatchOperations	CosmosPatchOperations.create() Initializes a new instance of CosmosPatchOperations that will contain operations to be performed on a item atomically.
Mono<CosmosClientEncryptionKeyResponse>	CosmosAsyncDatabase.createClientEncryptionKey(CosmosClientEncryptionKeyProperties keyProperties) Creates a client encryption key after subscription the operation will be performed.
GlobalThroughputControlConfigBuilder	CosmosAsyncClient.createGlobalThroughputControlConfigBuilder(String databaseId, String containerId) Create global throughput control config builder which will be used to build GlobalThroughputControlConfig.
GlobalThroughputControlConfigBuilder	CosmosClient.createGlobalThroughputControlConfigBuilder(String databaseId, String containerId) Create global throughput control config builder which will be used to build GlobalThroughputControlConfig.
<T> CosmosItemOperation	TransactionalBatch.createItemOperation(T item) Adds an operation to create an item into the batch.
<T> CosmosItemOperation	TransactionalBatch.createItemOperation(T item, TransactionalBatchItemRequestOptions requestOptions) Adds an operation to create an item into the batch.
static TransactionalBatch	TransactionalBatch.createTransactionalBatch(PartitionKey partitionKey) Initializes a new instance of TransactionalBatch that will contain operations to be performed across multiple items in the container with the provided partition key in a transactional manner
CosmosItemOperation	TransactionalBatch.deleteItemOperation(String id) Adds an operation to delete an item into the batch.
CosmosItemOperation	TransactionalBatch.deleteItemOperation(String id, TransactionalBatchItemRequestOptions requestOptions) Adds an operation to delete an item into the batch.
void	CosmosContainer.enableGlobalThroughputControlGroup(ThroughputControlGroupConfig groupConfig, GlobalThroughputControlConfig globalControlConfig) Enable the throughput control group with global control mode.
void	CosmosAsyncContainer.enableGlobalThroughputControlGroup(ThroughputControlGroupConfig groupConfig, GlobalThroughputControlConfig globalControlConfig) Enable the throughput control group with global control mode.
void	CosmosContainer.enableLocalThroughputControlGroup(ThroughputControlGroupConfig groupConfig) Enable the throughput control group with local control mode.
void	CosmosAsyncContainer.enableLocalThroughputControlGroup(ThroughputControlGroupConfig groupConfig) Enable the throughput control group with local control mode.
TransactionalBatchResponse	CosmosContainer.executeTransactionalBatch(TransactionalBatch transactionalBatch) Executes the transactional batch.
Mono<TransactionalBatchResponse>	CosmosAsyncContainer.executeTransactionalBatch(TransactionalBatch transactionalBatch) Executes the transactional batch.
TransactionalBatchResponse	CosmosContainer.executeTransactionalBatch(TransactionalBatch transactionalBatch, TransactionalBatchRequestOptions requestOptions) Executes the transactional batch.
Mono<TransactionalBatchResponse>	CosmosAsyncContainer.executeTransactionalBatch(TransactionalBatch transactionalBatch, TransactionalBatchRequestOptions requestOptions) Executes the transactional batch.
String	TransactionalBatchResponse.getActivityId() Gets the activity ID that identifies the server request made to execute the batch.
String	CosmosBulkItemResponse.getActivityId() Gets the activity ID that identifies the server request made to execute this operation.
TContext	BulkProcessingOptions.getBatchContext() Deprecated. Returns batch context
TContext	CosmosBulkOperationResponse.getBatchContext()
CosmosAsyncClientEncryptionKey	CosmosAsyncDatabase.getClientEncryptionKey(String id) Gets a CosmosAsyncClientEncryptionKey object without making a service call
CosmosClientEncryptionKey	CosmosDatabase.getClientEncryptionKey(String id) Gets a CosmosClientEncryptionKey object without making a service call
Duration	GlobalThroughputControlConfig.getControlItemExpireInterval() Get the control item expire interval.
Duration	GlobalThroughputControlConfig.getControlItemRenewInterval() Get the control item renew interval.
CosmosDiagnostics	CosmosBulkItemResponse.getCosmosDiagnostics() Gets the cosmos diagnostic for this operation.
static <T> CosmosItemOperation	BulkOperations.getCreateItemOperation(T item, PartitionKey partitionKey) Instantiate an operation for Creating item in Bulk execution.
static <T> CosmosItemOperation	BulkOperations.getCreateItemOperation(T item, PartitionKey partitionKey, BulkItemRequestOptions requestOptions) Instantiate an operation for Creating item in Bulk execution.
static <T,TContext> CosmosItemOperation	BulkOperations.getCreateItemOperation(T item, PartitionKey partitionKey, BulkItemRequestOptions requestOptions, TContext context) Instantiate an operation for Creating item in Bulk execution.
static <T,TContext> CosmosItemOperation	BulkOperations.getCreateItemOperation(T item, PartitionKey partitionKey, TContext context) Instantiate an operation for Creating item in Bulk execution.
Mono<List<ChangeFeedProcessorState>>	ChangeFeedProcessor.getCurrentState() Returns a read only list of states each representing one scoped worker item.
static CosmosItemOperation	BulkOperations.getDeleteItemOperation(String id, PartitionKey partitionKey) Instantiate an operation for deleting item in Bulk execution.
static CosmosItemOperation	BulkOperations.getDeleteItemOperation(String id, PartitionKey partitionKey, BulkItemRequestOptions requestOptions) Instantiate an operation for deleting item in Bulk execution.
static <TContext> CosmosItemOperation	BulkOperations.getDeleteItemOperation(String id, PartitionKey partitionKey, BulkItemRequestOptions requestOptions, TContext context) Instantiate an operation for deleting item in Bulk execution.
static <TContext> CosmosItemOperation	BulkOperations.getDeleteItemOperation(String id, PartitionKey partitionKey, TContext context) Instantiate an operation for deleting item in Bulk execution.
CosmosDiagnostics	TransactionalBatchResponse.getDiagnostics() Gets the diagnostics information for the current request to Azure Cosmos DB service.
Duration	TransactionalBatchResponse.getDuration() Gets the end-to-end request latency for the current request to Azure Cosmos DB service.
Duration	CosmosBulkItemResponse.getDuration() Gets the end-to-end request latency for the current request to Azure Cosmos DB service.
String	TransactionalBatchResponse.getErrorMessage() Gets the reason for the failure of the batch request, if any, or null.
String	TransactionalBatchOperationResult.getETag() Gets the entity tag associated with the current item.
String	CosmosBulkItemResponse.getETag() Gets the entity tag associated with the current item.
Exception	CosmosBulkOperationResponse.getException()
List<FeedRange>	CosmosContainer.getFeedRanges() Obtains a list of FeedRange that can be used to parallelize Feed operations.
Mono<List<FeedRange>>	CosmosAsyncContainer.getFeedRanges() Obtains a list of FeedRange that can be used to parallelize Feed operations.
String	BulkPatchItemRequestOptions.getFilterPredicate() Gets the FilterPredicate associated with the request in the Azure Cosmos DB service.
String	TransactionalBatchPatchItemRequestOptions.getFilterPredicate() Gets the FilterPredicate associated with the request in the Azure Cosmos DB service.
String	ThroughputControlGroupConfig.getGroupName() Get the throughput control group name.
String	CosmosClientEncryptionKey.getId() Get the id of the CosmosClientEncryptionKey
String	CosmosAsyncClientEncryptionKey.getId() Get the id of the CosmosAsyncClientEncryptionKey
<T> T	TransactionalBatchOperationResult.getItem(Class<T> type) Gets the item associated with the current result.
<T> T	CosmosBulkItemResponse.getItem(Class<T> type) Gets the item associated with the current result.
int	BulkExecutionOptions.getMaxMicroBatchConcurrency() The maximum concurrency for executing requests for a partition key range.
int	BulkProcessingOptions.getMaxMicroBatchConcurrency() Deprecated. Returns max micro batch concurrency
Duration	BulkExecutionOptions.getMaxMicroBatchInterval() The flush interval for bulk operations.
Duration	BulkProcessingOptions.getMaxMicroBatchInterval() Deprecated. Returns max micro batch interval
int	BulkExecutionOptions.getMaxMicroBatchSize() The maximum batching size for bulk operations.
int	BulkProcessingOptions.getMaxMicroBatchSize() Deprecated. Returns micro batch size
double	BulkExecutionOptions.getMaxTargetedMicroBatchRetryRate() The maximum acceptable retry rate bandwidth.
double	BulkProcessingOptions.getMaxTargetedMicroBatchRetryRate() Deprecated. Returns max targeted micro batch retry rate
double	BulkExecutionOptions.getMinTargetedMicroBatchRetryRate() The minimum acceptable retry rate bandwidth.
double	BulkProcessingOptions.getMinTargetedMicroBatchRetryRate() Deprecated. Returns min targeted micro batch retry rate
CosmosItemOperation	TransactionalBatchOperationResult.getOperation() Gets the original operation for this result.
CosmosItemOperation	CosmosBulkOperationResponse.getOperation()
List<CosmosItemOperation>	TransactionalBatch.getOperations() Return the list of operation in an unmodifiable instance so no one can change it in the down path.
PartitionKey	TransactionalBatch.getPartitionKeyValue() Return the partition key for this batch.
static CosmosItemOperation	BulkOperations.getPatchItemOperation(String id, PartitionKey partitionKey, CosmosPatchOperations cosmosPatchOperations) Instantiate an operation for a patch in Bulk execution.
static CosmosItemOperation	BulkOperations.getPatchItemOperation(String id, PartitionKey partitionKey, CosmosPatchOperations cosmosPatchOperations, BulkPatchItemRequestOptions requestOptions) Instantiate an operation for a patch in Bulk execution.
static <TContext> CosmosItemOperation	BulkOperations.getPatchItemOperation(String id, PartitionKey partitionKey, CosmosPatchOperations cosmosPatchOperations, BulkPatchItemRequestOptions requestOptions, TContext context) Instantiate an operation for a patch in Bulk execution.
static <TContext> CosmosItemOperation	BulkOperations.getPatchItemOperation(String id, PartitionKey partitionKey, CosmosPatchOperations cosmosPatchOperations, TContext context) Instantiate an operation for a patch in Bulk execution.
static CosmosItemOperation	BulkOperations.getReadItemOperation(String id, PartitionKey partitionKey) Instantiate an operation for read item in Bulk execution.
static CosmosItemOperation	BulkOperations.getReadItemOperation(String id, PartitionKey partitionKey, BulkItemRequestOptions requestOptions) Instantiate an operation for read item in Bulk execution.
static <TContext> CosmosItemOperation	BulkOperations.getReadItemOperation(String id, PartitionKey partitionKey, BulkItemRequestOptions requestOptions, TContext context) Instantiate an operation for read item in Bulk execution.
static <TContext> CosmosItemOperation	BulkOperations.getReadItemOperation(String id, PartitionKey partitionKey, TContext context) Instantiate an operation for read item in Bulk execution.
Set<URI>	CosmosDiagnostics.getRegionsContacted() Regions contacted for this request
static <T> CosmosItemOperation	BulkOperations.getReplaceItemOperation(String id, T item, PartitionKey partitionKey) Instantiate an operation for replace item in Bulk execution.
static <T> CosmosItemOperation	BulkOperations.getReplaceItemOperation(String id, T item, PartitionKey partitionKey, BulkItemRequestOptions requestOptions) Instantiate an operation for replace item in Bulk execution.
static <T,TContext> CosmosItemOperation	BulkOperations.getReplaceItemOperation(String id, T item, PartitionKey partitionKey, BulkItemRequestOptions requestOptions, TContext context) Instantiate an operation for replace item in Bulk execution.
static <T,TContext> CosmosItemOperation	BulkOperations.getReplaceItemOperation(String id, T item, PartitionKey partitionKey, TContext context) Instantiate an operation for replace item in Bulk execution.
double	TransactionalBatchResponse.getRequestCharge() Gets the request charge as request units (RU) consumed by the batch operation.
double	TransactionalBatchOperationResult.getRequestCharge() Gets the request charge as request units (RU) consumed by the current operation.
double	CosmosBulkItemResponse.getRequestCharge() Gets the request charge as request units (RU) consumed by the current operation.
CosmosBulkItemResponse	CosmosBulkOperationResponse.getResponse()
Map<String,String>	TransactionalBatchResponse.getResponseHeaders() Gets the headers associated with the response.
Map<String,String>	CosmosBulkItemResponse.getResponseHeaders() Gets the headers associated with the response.
int	TransactionalBatchResponse.getResponseLength() Get the length of the response of a batch operation change it in the down path.
List<TransactionalBatchOperationResult>	TransactionalBatchResponse.getResults() Get all the results of the operations in a batch in an unmodifiable instance so no one can change it in the down path.
Duration	TransactionalBatchResponse.getRetryAfterDuration() Gets the amount of time to wait before retrying this or any other request due to throttling.
Duration	TransactionalBatchOperationResult.getRetryAfterDuration() Gets retry after.
Duration	CosmosBulkItemResponse.getRetryAfterDuration() Gets retry after.
String	TransactionalBatchResponse.getSessionToken() Gets the token used for managing client's consistency requirements.
String	CosmosBulkItemResponse.getSessionToken() Gets the token used for managing client's consistency requirements.
String	TransactionalBatchRequestOptions.getSessionToken() Gets the token for use with session consistency.
int	TransactionalBatchResponse.getStatusCode() Gets the HTTP status code associated with the response.
int	TransactionalBatchOperationResult.getStatusCode() Gets the HTTP status code associated with the current result.
int	CosmosBulkItemResponse.getStatusCode() Gets the HTTP status code associated with the current result.
int	TransactionalBatchResponse.getSubStatusCode() Gets the HTTP sub status code associated with the response.
int	TransactionalBatchOperationResult.getSubStatusCode() Gets sub status code associated with the current result.
int	CosmosBulkItemResponse.getSubStatusCode() Gets sub status code associated with the current result.
Integer	ThroughputControlGroupConfig.getTargetThroughput() Get throughput control group target throughput.
Double	ThroughputControlGroupConfig.getTargetThroughputThreshold() Get the throughput control group target throughput threshold.
BulkExecutionThresholds	BulkExecutionOptions.getThresholds() Returns thresholds
BulkProcessingThresholds<TContext>	BulkProcessingOptions.getThresholds() Deprecated. Returns thresholds
static <T> CosmosItemOperation	BulkOperations.getUpsertItemOperation(T item, PartitionKey partitionKey) Instantiate an operation for upsert item in Bulk execution.
static <T> CosmosItemOperation	BulkOperations.getUpsertItemOperation(T item, PartitionKey partitionKey, BulkItemRequestOptions requestOptions) Instantiate an operation for upsert item in Bulk execution.
static <T,TContext> CosmosItemOperation	BulkOperations.getUpsertItemOperation(T item, PartitionKey partitionKey, BulkItemRequestOptions requestOptions, TContext context) Instantiate an operation for upsert item in Bulk execution.
static <T,TContext> CosmosItemOperation	BulkOperations.getUpsertItemOperation(T item, PartitionKey partitionKey, TContext context) Instantiate an operation for upsert item in Bulk execution.
CosmosPatchOperations	CosmosPatchOperations.increment(String path, double value) This increment the value at the target location.
CosmosPatchOperations	CosmosPatchOperations.increment(String path, long value) This increment the value at the target location.
boolean	ThroughputControlGroupConfig.isDefault() Get whether this throughput control group will be used by default.
boolean	TransactionalBatchResponse.isSuccessStatusCode() Returns a value indicating whether the batch was successfully processed.
boolean	TransactionalBatchOperationResult.isSuccessStatusCode() Gets a value indicating whether the current operation completed successfully.
boolean	CosmosBulkItemResponse.isSuccessStatusCode() Gets a value indicating whether the current operation completed successfully.
void	CosmosContainer.openConnectionsAndInitCaches() Initializes the container by warming up the caches and connections for the current read region.
Mono<Void>	CosmosAsyncContainer.openConnectionsAndInitCaches() Initializes the container by warming up the caches and connections for the current read region.
<T> CosmosItemResponse<T>	CosmosContainer.patchItem(String itemId, PartitionKey partitionKey, CosmosPatchOperations cosmosPatchOperations, Class<T> itemType) Run patch operations on an Item.
<T> Mono<CosmosItemResponse<T>>	CosmosAsyncContainer.patchItem(String itemId, PartitionKey partitionKey, CosmosPatchOperations cosmosPatchOperations, Class<T> itemType) Run patch operations on an Item.
<T> CosmosItemResponse<T>	CosmosContainer.patchItem(String itemId, PartitionKey partitionKey, CosmosPatchOperations cosmosPatchOperations, CosmosPatchItemRequestOptions options, Class<T> itemType) Run patch operations on an Item.
<T> Mono<CosmosItemResponse<T>>	CosmosAsyncContainer.patchItem(String itemId, PartitionKey partitionKey, CosmosPatchOperations cosmosPatchOperations, CosmosPatchItemRequestOptions options, Class<T> itemType) Run patch operations on an Item.
CosmosItemOperation	TransactionalBatch.patchItemOperation(String id, CosmosPatchOperations cosmosPatchOperations) Adds a patch operations for an item into the batch.
CosmosItemOperation	TransactionalBatch.patchItemOperation(String id, CosmosPatchOperations cosmosPatchOperations, TransactionalBatchPatchItemRequestOptions requestOptions) Adds a patch operations for an item into the batch.
<TContext> Flux<CosmosBulkOperationResponse<TContext>>	CosmosAsyncContainer.processBulkOperations(Flux<CosmosItemOperation> operations) Executes flux of operations in Bulk.
<TContext> Flux<CosmosBulkOperationResponse<TContext>>	CosmosAsyncContainer.processBulkOperations(Flux<CosmosItemOperation> operations, BulkExecutionOptions bulkOptions) Executes flux of operations in Bulk.
<TContext> Flux<CosmosBulkOperationResponse<TContext>>	CosmosAsyncContainer.processBulkOperations(Flux<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
<TContext> List<CosmosBulkOperationResponse<TContext>>	CosmosContainer.processBulkOperations(Iterable<CosmosItemOperation> operations) Executes list of operations in Bulk.
<TContext> List<CosmosBulkOperationResponse<TContext>>	CosmosContainer.processBulkOperations(Iterable<CosmosItemOperation> operations, BulkExecutionOptions bulkOptions) Executes list of operations in Bulk.
<TContext> List<CosmosBulkOperationResponse<TContext>>	CosmosContainer.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>	CosmosContainer.queryChangeFeed(CosmosChangeFeedRequestOptions options, Class<T> classType) Query for items in the change feed of the current container using the CosmosChangeFeedRequestOptions.
<T> CosmosPagedFlux<T>	CosmosAsyncContainer.queryChangeFeed(CosmosChangeFeedRequestOptions options, Class<T> classType) Query for items in the change feed of the current container using the CosmosChangeFeedRequestOptions.
CosmosPagedFlux<CosmosClientEncryptionKeyProperties>	CosmosAsyncDatabase.queryClientEncryptionKeys(SqlQuerySpec querySpec) Query for cosmos client encryption keys in a database.
CosmosPagedFlux<CosmosClientEncryptionKeyProperties>	CosmosAsyncDatabase.queryClientEncryptionKeys(SqlQuerySpec querySpec, CosmosQueryRequestOptions options) Query for cosmos client encryption keys in a database.
CosmosPagedFlux<CosmosClientEncryptionKeyProperties>	CosmosAsyncDatabase.queryClientEncryptionKeys(String query) Query for cosmos client encryption keys in a database.
CosmosPagedFlux<CosmosClientEncryptionKeyProperties>	CosmosAsyncDatabase.queryClientEncryptionKeys(String query, CosmosQueryRequestOptions options) Query for cosmos client encryption keys in a database.
CosmosClientEncryptionKeyResponse	CosmosClientEncryptionKey.read() Reads a cosmos client encryption key
Mono<CosmosClientEncryptionKeyResponse>	CosmosAsyncClientEncryptionKey.read() Reads a cosmos client encryption key
CosmosPagedFlux<CosmosClientEncryptionKeyProperties>	CosmosAsyncDatabase.readAllClientEncryptionKeys() Reads all cosmos client encryption keys in a database.
CosmosPagedIterable<CosmosClientEncryptionKeyProperties>	CosmosDatabase.readAllClientEncryptionKeys() Reads all cosmos client encryption keys in a database.
CosmosPagedFlux<CosmosClientEncryptionKeyProperties>	CosmosAsyncDatabase.readAllClientEncryptionKeys(CosmosQueryRequestOptions options) Reads all cosmos client encryption keys in a database.
CosmosItemOperation	TransactionalBatch.readItemOperation(String id) Adds an operation to read an item into the batch.
CosmosItemOperation	TransactionalBatch.readItemOperation(String id, TransactionalBatchItemRequestOptions requestOptions) Adds an operation to read an item into the batch.
CosmosPatchOperations	CosmosPatchOperations.remove(String path) This removes the value at the target location.
Mono<CosmosClientEncryptionKeyResponse>	CosmosAsyncClientEncryptionKey.replace(CosmosClientEncryptionKeyProperties keyProperties) Replace a cosmos client encryption key.
<T> CosmosPatchOperations	CosmosPatchOperations.replace(String path, T value) This replaces the value at the target location with a new value.
<T> CosmosItemOperation	TransactionalBatch.replaceItemOperation(String id, T item) Adds an operation to replace an item into the batch.
<T> CosmosItemOperation	TransactionalBatch.replaceItemOperation(String id, T item, TransactionalBatchItemRequestOptions requestOptions) Adds an operation to replace an item into the batch.
<T> CosmosPatchOperations	CosmosPatchOperations.set(String path, T value) This sets the value at the target location with a new value.
BulkItemRequestOptions	BulkItemRequestOptions.setContentResponseOnWriteEnabled(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 in CosmosItemOperation.
BulkPatchItemRequestOptions	BulkPatchItemRequestOptions.setContentResponseOnWriteEnabled(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 in CosmosItemOperation.
GlobalThroughputControlConfigBuilder	GlobalThroughputControlConfigBuilder.setControlItemExpireInterval(Duration controlItemExpireInterval) Set the control item expire interval.
GlobalThroughputControlConfigBuilder	GlobalThroughputControlConfigBuilder.setControlItemRenewInterval(Duration controlItemRenewInterval) Set the control item renew interval.
ThroughputControlGroupConfigBuilder	ThroughputControlGroupConfigBuilder.setDefault(boolean aDefault) Set whether this throughput control group will be used by default.
BulkPatchItemRequestOptions	BulkPatchItemRequestOptions.setFilterPredicate(String filterPredicate) Sets the FilterPredicate associated with the request in the Azure Cosmos DB service.
TransactionalBatchPatchItemRequestOptions	TransactionalBatchPatchItemRequestOptions.setFilterPredicate(String filterPredicate) Sets the FilterPredicate associated with the request in the Azure Cosmos DB service.
ThroughputControlGroupConfigBuilder	ThroughputControlGroupConfigBuilder.setGroupName(String groupName) Set the throughput control group name.
BulkItemRequestOptions	BulkItemRequestOptions.setIfMatchETag(String ifMatchETag) Sets the If-Match (ETag) associated with the operation in CosmosItemOperation.
TransactionalBatchItemRequestOptions	TransactionalBatchItemRequestOptions.setIfMatchETag(String ifMatchETag) Sets the If-Match (ETag) associated with the operation in TransactionalBatch.
BulkPatchItemRequestOptions	BulkPatchItemRequestOptions.setIfMatchETag(String ifMatchETag) Sets the If-Match (ETag) associated with the operation in CosmosItemOperation.
TransactionalBatchPatchItemRequestOptions	TransactionalBatchPatchItemRequestOptions.setIfMatchETag(String ifMatchETag) Sets the If-Match (ETag) associated with the operation in TransactionalBatch.
BulkItemRequestOptions	BulkItemRequestOptions.setIfNoneMatchETag(String ifNoneMatchEtag) Sets the If-None-Match (ETag) associated with the request in operation in CosmosItemOperation.
TransactionalBatchItemRequestOptions	TransactionalBatchItemRequestOptions.setIfNoneMatchETag(String ifNoneMatchEtag) Sets the If-None-Match (ETag) associated with the request in operation in TransactionalBatch.
BulkPatchItemRequestOptions	BulkPatchItemRequestOptions.setIfNoneMatchETag(String ifNoneMatchEtag) Sets the If-None-Match (ETag) associated with the request in operation in CosmosItemOperation.
TransactionalBatchPatchItemRequestOptions	TransactionalBatchPatchItemRequestOptions.setIfNoneMatchETag(String ifNoneMatchEtag) Sets the If-None-Match (ETag) associated with the request in operation in TransactionalBatch.
BulkExecutionOptions	BulkExecutionOptions.setMaxMicroBatchConcurrency(int maxMicroBatchConcurrency) The maximum concurrency for executing requests for a partition key range.
BulkProcessingOptions<TContext>	BulkProcessingOptions.setMaxMicroBatchConcurrency(int maxMicroBatchConcurrency) Deprecated. The maximum concurrency for executing requests for a partition key range.
BulkExecutionOptions	BulkExecutionOptions.setMaxMicroBatchInterval(Duration maxMicroBatchInterval) The flush interval for bulk operations.
BulkProcessingOptions<TContext>	BulkProcessingOptions.setMaxMicroBatchInterval(Duration maxMicroBatchInterval) Deprecated. The flush interval for bulk operations.
BulkExecutionOptions	BulkExecutionOptions.setMaxMicroBatchSize(int maxMicroBatchSize) The maximum batching size for bulk operations.
BulkProcessingOptions<TContext>	BulkProcessingOptions.setMaxMicroBatchSize(int maxMicroBatchSize) Deprecated. The maximum batching size for bulk operations.
TransactionalBatchRequestOptions	TransactionalBatchRequestOptions.setSessionToken(String sessionToken) Sets the token for use with session consistency.
BulkExecutionOptions	BulkExecutionOptions.setTargetedMicroBatchRetryRate(double minRetryRate, double maxRetryRate) The acceptable retry rate bandwidth.
BulkProcessingOptions<TContext>	BulkProcessingOptions.setTargetedMicroBatchRetryRate(double minRetryRate, double maxRetryRate) Deprecated. The acceptable retry rate bandwidth.
ThroughputControlGroupConfigBuilder	ThroughputControlGroupConfigBuilder.setTargetThroughput(int targetThroughput) Set the throughput control group target throughput.
ThroughputControlGroupConfigBuilder	ThroughputControlGroupConfigBuilder.setTargetThroughputThreshold(double targetThroughputThreshold) Set the throughput control group target throughput threshold.
int	TransactionalBatchResponse.size() Gets the number of operation results.
<T> CosmosItemOperation	TransactionalBatch.upsertItemOperation(T item) Adds an operation to upsert an item into the batch.
<T> CosmosItemOperation	TransactionalBatch.upsertItemOperation(T item, TransactionalBatchItemRequestOptions requestOptions) Adds an operation to upsert an item into the batch.

Constructors in com.azure.cosmos with annotations of type Beta

Constructor and Description
BulkExecutionOptions() Constructor
BulkExecutionOptions(BulkExecutionThresholds thresholds) Constructor
BulkExecutionThresholds() Constructor
BulkProcessingOptions() Deprecated. forRemoval = true, since = "4.18" This class is not necessary anymore and 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 Constructor
BulkProcessingOptions(TContext batchContext) Deprecated. forRemoval = true, since = "4.18" This class is not necessary anymore and 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 Constructor
BulkProcessingOptions(TContext batchContext, BulkProcessingThresholds<TContext> thresholds) Deprecated. forRemoval = true, since = "4.18" This class is not necessary anymore and 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 Constructor
BulkProcessingThresholds() Deprecated. forRemoval = true, since = "4.18" This class is not necessary anymore and 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 Constructor

Uses of Beta in com.azure.cosmos.models

Classes in com.azure.cosmos.models with annotations of type Beta

Modifier and Type	Class and Description
class	ChangeFeedPolicy Represents the change feed policy configuration for the container in the Azure Cosmos DB service.
class	ChangeFeedProcessorState Specifies the ChangeFeedProcessor state for a particular lease/worker.
class	ClientEncryptionIncludedPath Path that needs encryption and the associated settings within ClientEncryptionPolicy.
class	ClientEncryptionPolicy Client encryption policy.
class	CosmosChangeFeedRequestOptions
class	CosmosClientEncryptionKeyProperties Details of an encryption key for use with the Azure Cosmos DB service.
class	CosmosClientEncryptionKeyResponse The type Cosmos client encryption key response.
class	CosmosPatchItemRequestOptions
class	DedicatedGatewayRequestOptions Dedicated Gateway Request Options
class	EncryptionKeyWrapMetadata Metadata that a key wrapping provider can use to wrap/unwrap data encryption keys.
interface	FeedRange
class	PartitionKeyBuilder

Methods in com.azure.cosmos.models with annotations of type Beta

Modifier and Type	Method and Description
PartitionKeyBuilder	PartitionKeyBuilder.add(boolean value) Adds partition value of type boolean
PartitionKeyBuilder	PartitionKeyBuilder.add(double value) Adds partition value of type double
PartitionKeyBuilder	PartitionKeyBuilder.add(String value) Adds partition value of type string
PartitionKeyBuilder	PartitionKeyBuilder.addNoneValue() Adds a None Partition Key
PartitionKeyBuilder	PartitionKeyBuilder.addNullValue() Adds a null partition key value
PartitionKey	PartitionKeyBuilder.build() Builds a new instance of the type PartitionKey with the specified Partition Key values.
static CosmosChangeFeedRequestOptions	CosmosChangeFeedRequestOptions.createForProcessingFromBeginning(FeedRange feedRange) Creates a new CosmosChangeFeedRequestOptions instance to start processing change feed items from the beginning of the change feed
static CosmosChangeFeedRequestOptions	CosmosChangeFeedRequestOptions.createForProcessingFromContinuation(String continuation) Creates a new CosmosChangeFeedRequestOptions instance to start processing change feed items from a previous continuation
static CosmosChangeFeedRequestOptions	CosmosChangeFeedRequestOptions.createForProcessingFromNow(FeedRange feedRange) Creates a new CosmosChangeFeedRequestOptions instance to start processing change feed items from the current time - so only events for all future changes will be retrieved
static CosmosChangeFeedRequestOptions	CosmosChangeFeedRequestOptions.createForProcessingFromPointInTime(Instant pointInTime, FeedRange feedRange) Creates a new CosmosChangeFeedRequestOptions instance to start processing change feed items from a certain point in time
static ChangeFeedPolicy	ChangeFeedPolicy.createFullFidelityPolicy(Duration retentionDuration) Creates a ChangeFeedPolicy with retention duration for full fidelity processing
static ChangeFeedPolicy	ChangeFeedPolicy.createIncrementalPolicy() Creates a default ChangeFeedPolicy without retention duration specified.
static FeedRange	FeedRange.forFullRange() Creates a range for an entire container
static FeedRange	FeedRange.forLogicalPartition(PartitionKey partitionKey) Creates a range for a certain logical partition
static FeedRange	FeedRange.fromString(String json) Creates a range from a previously obtained string representation.
CosmosChangeFeedRequestOptions	CosmosChangeFeedRequestOptions.fullFidelity() Changes the change feed mode so that the change feed will contain events for creations, deletes as well as all intermediary snapshots for updates.
ChangeFeedPolicy	CosmosContainerProperties.getChangeFeedPolicy() Gets the changeFeedPolicy for this container in the Azure Cosmos DB service.
String	ClientEncryptionIncludedPath.getClientEncryptionKeyId() Gets the identifier of the Data Encryption Key to be used to encrypt the path.
ClientEncryptionPolicy	CosmosContainerProperties.getClientEncryptionPolicy() Gets the ClientEncryptionPolicy that is used for encrypting item fields
DedicatedGatewayRequestOptions	CosmosItemRequestOptions.getDedicatedGatewayRequestOptions() Gets the Dedicated Gateway Request Options
DedicatedGatewayRequestOptions	CosmosQueryRequestOptions.getDedicatedGatewayRequestOptions() Gets the Dedicated Gateway Request Options
String	ClientEncryptionIncludedPath.getEncryptionAlgorithm() Gets the type of encryption algorithm to be performed.
String	CosmosClientEncryptionKeyProperties.getEncryptionAlgorithm() Gets the encryption algorithm that will be used along with this client encryption key to encrypt/decrypt data.
EncryptionKeyWrapMetadata	CosmosClientEncryptionKeyProperties.getEncryptionKeyWrapMetadata() Gets the metadata for the wrapping provider that can be used to unwrap the wrapped client encryption key.
String	ClientEncryptionIncludedPath.getEncryptionType() Gets the type of encryption to be performed.
String	CosmosClientEncryptionKeyProperties.getETag() Get the entity tag associated with the resource.
FeedRange	CosmosQueryRequestOptions.getFeedRange() Gets the FeedRange
FeedRange	CosmosChangeFeedRequestOptions.getFeedRange()
String	CosmosPatchItemRequestOptions.getFilterPredicate() Gets the FilterPredicate associated with the request in the Azure Cosmos DB service.
Duration	ChangeFeedPolicy.getFullFidelityRetentionDuration() Gets the retention duration in which it will be possible to process change feed events with full fidelity mode (meaning intermediary changes and deletes will be exposed in change feed).
String	CosmosClientEncryptionKeyProperties.getId() Gets the name of the resource.
List<ClientEncryptionIncludedPath>	ClientEncryptionPolicy.getIncludedPaths() Gets the list of path of the item that need encryption along with path-specific settings.
Duration	DedicatedGatewayRequestOptions.getMaxIntegratedCacheStaleness() Gets the staleness value associated with the request in the Azure CosmosDB service.
int	CosmosChangeFeedRequestOptions.getMaxItemCount() Gets the maximum number of items to be returned in the enumeration operation.
int	CosmosChangeFeedRequestOptions.getMaxPrefetchPageCount() Gets the maximum number of pages that will be prefetched from the backend asynchronously in the background.
String	EncryptionKeyWrapMetadata.getName() Serialized form of metadata.
String	ClientEncryptionIncludedPath.getPath() Gets the path to be encrypted.
int	ClientEncryptionPolicy.getPolicyFormatVersion() Version of the client encryption policy definition.
CosmosClientEncryptionKeyProperties	CosmosClientEncryptionKeyResponse.getProperties() Gets the cosmos client encryption key properties
String	CosmosItemRequestOptions.getThroughputControlGroupName()
String	CosmosQueryRequestOptions.getThroughputControlGroupName() Get throughput control group name.
String	CosmosChangeFeedRequestOptions.getThroughputControlGroupName() Get the throughput control group name.
Instant	CosmosClientEncryptionKeyProperties.getTimestamp() Get the last modified timestamp associated with the resource.
String	EncryptionKeyWrapMetadata.getType() Serialized form of metadata.
String	EncryptionKeyWrapMetadata.getValue() Serialized form of metadata.
byte[]	CosmosClientEncryptionKeyProperties.getWrappedDataEncryptionKey() Gets the wrapped form of the client encryption key.
boolean	CosmosChangeFeedRequestOptions.isQuotaInfoEnabled() Gets the quotaInfoEnabled setting for change feed request in the Azure Cosmos DB database service.
CosmosContainerProperties	CosmosContainerProperties.setChangeFeedPolicy(ChangeFeedPolicy value) Sets the changeFeedPolicy for this container in the Azure Cosmos DB service.
ClientEncryptionIncludedPath	ClientEncryptionIncludedPath.setClientEncryptionKeyId(String clientEncryptionKeyId) Sets the identifier of the Data Encryption Key to be used to encrypt the path.
CosmosContainerProperties	CosmosContainerProperties.setClientEncryptionPolicy(ClientEncryptionPolicy value) Sets the ClientEncryptionPolicy that is used for encrypting item fields
CosmosItemRequestOptions	CosmosItemRequestOptions.setDedicatedGatewayRequestOptions(DedicatedGatewayRequestOptions dedicatedGatewayRequestOptions) Sets the Dedicated Gateway Request Options
CosmosQueryRequestOptions	CosmosQueryRequestOptions.setDedicatedGatewayRequestOptions(DedicatedGatewayRequestOptions dedicatedGatewayRequestOptions) Sets the Dedicated Gateway Request Options
ClientEncryptionIncludedPath	ClientEncryptionIncludedPath.setEncryptionAlgorithm(String encryptionAlgorithm) Sets the type of encryption algorithm to be performed.
CosmosClientEncryptionKeyProperties	CosmosClientEncryptionKeyProperties.setEncryptionAlgorithm(String encryptionAlgorithm) Sets the encryption algorithm that will be used along with this client encryption key to encrypt/decrypt data.
CosmosClientEncryptionKeyProperties	CosmosClientEncryptionKeyProperties.setEncryptionKeyWrapMetadata(EncryptionKeyWrapMetadata encryptionKeyWrapMetadata) Sets the metadata for the wrapping provider that can be used to unwrap the wrapped client encryption key.
ClientEncryptionIncludedPath	ClientEncryptionIncludedPath.setEncryptionType(String encryptionType) Sets the type of encryption to be performed.
CosmosQueryRequestOptions	CosmosQueryRequestOptions.setFeedRange(FeedRange feedRange) Sets the FeedRange that we want to query
CosmosPatchItemRequestOptions	CosmosPatchItemRequestOptions.setFilterPredicate(String filterPredicate) Sets the FilterPredicate associated with the request in the Azure Cosmos DB service.
CosmosClientEncryptionKeyProperties	CosmosClientEncryptionKeyProperties.setId(String id) Sets the name of the resource.
DedicatedGatewayRequestOptions	DedicatedGatewayRequestOptions.setMaxIntegratedCacheStaleness(Duration maxIntegratedCacheStaleness) Sets the staleness value associated with the request in the Azure CosmosDB service.
CosmosChangeFeedRequestOptions	CosmosChangeFeedRequestOptions.setMaxItemCount(int maxItemCount) Sets the maximum number of items to be returned in the enumeration operation.
CosmosChangeFeedRequestOptions	CosmosChangeFeedRequestOptions.setMaxPrefetchPageCount(int maxPrefetchPageCount) Sets the maximum number of pages that will be prefetched from the backend asynchronously in the background.
ClientEncryptionIncludedPath	ClientEncryptionIncludedPath.setPath(String path) Sets the path to be encrypted.
void	CosmosChangeFeedRequestOptions.setQuotaInfoEnabled(boolean quotaInfoEnabled) Gets the quotaInfoEnabled setting for change feed request in the Azure Cosmos DB database service.
void	CosmosItemRequestOptions.setThroughputControlGroupName(String throughputControlGroupName)
CosmosQueryRequestOptions	CosmosQueryRequestOptions.setThroughputControlGroupName(String throughputControlGroupName) Set the throughput control group name.
CosmosChangeFeedRequestOptions	CosmosChangeFeedRequestOptions.setThroughputControlGroupName(String throughputControlGroupName) Set the throughput control group name.
CosmosClientEncryptionKeyProperties	CosmosClientEncryptionKeyProperties.setWrappedDataEncryptionKey(byte[] wrappedDataEncryptionKey) Sets the wrapped form of the client encryption key.
String	FeedRange.toString() Gets a json representation of the feed range - the returned json string can be used to create a new feed range instance from it - (use factory method fromJsonString to do so)

Constructors in com.azure.cosmos.models with annotations of type Beta

Constructor and Description
ClientEncryptionPolicy(List<ClientEncryptionIncludedPath> paths) Constructor.
CosmosClientEncryptionKeyProperties(String id, String encryptionAlgorithm, byte[] wrappedDataEncryptionKey, EncryptionKeyWrapMetadata encryptionKeyWrapMetadata) Constructor.
CosmosPatchItemRequestOptions() Constructor
DedicatedGatewayRequestOptions() Constructor
EncryptionKeyWrapMetadata() For JSON deserialize
EncryptionKeyWrapMetadata(EncryptionKeyWrapMetadata source) Creates a new instance of key wrap metadata based on an existing instance.
EncryptionKeyWrapMetadata(String type, String name, String value) Creates a new instance of key wrap metadata based on an existing instance.
PartitionKeyBuilder() Constructor.