Interface and Description |
---|
com.azure.cosmos.CosmosItemOperation
forRemoval = true, since = "4.19"
This class is not necessary anymore and will be removed. Please use
CosmosItemOperation |
Class and Description |
---|
com.azure.cosmos.BulkExecutionOptions
forRemoval = true, since = "4.19"
This class is not necessary anymore and will be removed.
Please use
CosmosBulkExecutionOptions |
com.azure.cosmos.BulkExecutionThresholds
forRemoval = true, since = "4.19"
This class is not necessary anymore and will be removed. Please use
CosmosBulkExecutionThresholdsState
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. |
com.azure.cosmos.BulkItemRequestOptions
forRemoval = true, since = "4.19"
This class is not necessary anymore and will be removed. Please use
CosmosBulkItemRequestOptions
Encapsulates options that can be specified for an operation used in Bulk execution. It can be passed while
creating bulk request using BulkOperations . |
com.azure.cosmos.BulkOperations
forRemoval = true, since = "4.19"
This class is not necessary anymore and will be removed. Please use
CosmosBulkOperations
Utility for creating bulk operations which can be executed by calling
CosmosAsyncContainer.processBulkOperations(Flux, BulkExecutionOptions) .
Also while creating these operation, if some options which are only for individual operation can be provided by passing
a BulkItemRequestOptions while creating the bulk operation.
See also BulkExecutionOptions . |
com.azure.cosmos.BulkPatchItemRequestOptions
forRemoval = true, since = "4.19"
This class is not necessary anymore and will be removed. Please use
CosmosBulkPatchItemRequestOptions
Encapsulates options that can be specified for an patch operation used in Bulk execution. It can be passed while
creating bulk patch request using BulkOperations . |
com.azure.cosmos.BulkProcessingOptions
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. |
com.azure.cosmos.BulkProcessingThresholds
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. |
com.azure.cosmos.CosmosBulkItemResponse
forRemoval = true, since = "4.19"
This class is not necessary anymore and will be removed. Please use
CosmosBulkItemResponse
Response of a CosmosItemOperation request when processed using Bulk by calling
CosmosAsyncContainer.processBulkOperations(Flux, BulkProcessingOptions) . |
com.azure.cosmos.CosmosBulkOperationResponse
forRemoval = true, since = "4.19"
This class is not necessary anymore and will be removed. Please use
CosmosBulkOperationResponse
Request, response and the exception(if any) for a CosmosItemOperation request when processed using Bulk by calling
CosmosAsyncContainer.processBulkOperations(Flux, BulkProcessingOptions) . |
com.azure.cosmos.CosmosPatchOperations
forRemoval = true, since = "4.19"
This class is not necessary anymore and will be removed. Please use
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. It is applied in an atomic manner and we support all
the operation in above RFC and more.
This can be executed in 3 ways:
1. Passing this to container in container.patchItem() which requires the id of the item to be patched, partition
key, the CosmosPatchOperations instance, any CosmosItemRequestOptions and the class type for which response will be parsed.
2. Add CosmosPatchOperations instance in TransactionalBatch using batch.patchItemOperation() which requires the id of the item
to be patched, cosmos patch instance and TransactionalBatchItemRequestOptions(if-any) and follow remaining
steps for batch for it's execution.
3. Create a bulk item using BulkOperations.getPatchItemOperation which requires the id of the item to be patched,
cosmos patch instance, partition key and BulkItemRequestOptions(if-any) and follow remaining steps to
execute bulk operations.
Let's assume this is the JSON for which we want to run patch operation.
{
a : "xyz"
b : {
c : "efg:
d : 4
e : [0, 1, 2 , 3]
}
}
|
com.azure.cosmos.TransactionalBatch
forRemoval = true, since = "4.19"
This class is not necessary anymore and will be removed. Please use
CosmosBatch
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.
Use
Example
This example atomically reads a set of items as a batch.
|
com.azure.cosmos.TransactionalBatchItemRequestOptions
forRemoval = true, since = "4.19"
This class is not necessary anymore and will be removed. Please use
CosmosBatchItemRequestOptions
Encapsulates options that can be specified for an operation within a TransactionalBatch . |
com.azure.cosmos.TransactionalBatchOperationResult
forRemoval = true, since = "4.19"
This class is not necessary anymore and will be removed. Please use
CosmosBatchOperationResult
Represents a result for a specific operation that was part of a TransactionalBatch request. |
com.azure.cosmos.TransactionalBatchPatchItemRequestOptions
forRemoval = true, since = "4.19"
This class is not necessary anymore and will be removed. Please use
CosmosBatchPatchItemRequestOptions
Encapsulates options that can be specified for an operation within a TransactionalBatch . |
com.azure.cosmos.TransactionalBatchRequestOptions
forRemoval = true, since = "4.19"
This class is not necessary anymore and will be removed. Please use
CosmosBatchRequestOptions
Encapsulates options that can be specified for a TransactionalBatch . |
com.azure.cosmos.TransactionalBatchResponse
forRemoval = true, since = "4.19"
This class is not necessary anymore and will be removed. Please use
CosmosBatchResponse
Response of a TransactionalBatch request. |
Enum and Description |
---|
com.azure.cosmos.CosmosItemOperationType
forRemoval = true, since = "4.19"
This class is not necessary anymore and will be removed. Please use
CosmosItemOperationType |
Copyright © 2021 Microsoft Corporation. All rights reserved.