com.azure.cosmos

Class BulkProcessingOptions<TContext>

java.lang.Object

com.azure.cosmos.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.

@Beta(value=V4_9_0,
      warningText="Preview API - subject to change in non-backwards compatible way")
 @Deprecated
public final class BulkProcessingOptions<TContext>
extends Object

Constructor Summary

Constructors

Constructor and Description
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

Method Summary

Modifier and Type	Method and Description
TContext	getBatchContext() Deprecated. Returns batch context
int	getMaxMicroBatchConcurrency() Deprecated. Returns max micro batch concurrency
Duration	getMaxMicroBatchInterval() Deprecated. Returns max micro batch interval
int	getMaxMicroBatchSize() Deprecated. Returns micro batch size
double	getMaxTargetedMicroBatchRetryRate() Deprecated. Returns max targeted micro batch retry rate
double	getMinTargetedMicroBatchRetryRate() Deprecated. Returns min targeted micro batch retry rate
BulkProcessingThresholds<TContext>	getThresholds() Deprecated. Returns thresholds
BulkProcessingOptions<TContext>	setMaxMicroBatchConcurrency(int maxMicroBatchConcurrency) Deprecated. The maximum concurrency for executing requests for a partition key range.
BulkProcessingOptions<TContext>	setMaxMicroBatchInterval(Duration maxMicroBatchInterval) Deprecated. The flush interval for bulk operations.
BulkProcessingOptions<TContext>	setMaxMicroBatchSize(int maxMicroBatchSize) Deprecated. The maximum batching size for bulk operations.
BulkProcessingOptions<TContext>	setTargetedMicroBatchRetryRate(double minRetryRate, double maxRetryRate) Deprecated. The acceptable retry rate bandwidth.

Methods inherited from class java.lang.Object

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

Constructor Detail

BulkProcessingOptions

@Beta(value=V4_17_0,
      warningText="Preview API - subject to change in non-backwards compatible way")
 @Deprecated
public 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

Parameters:

batchContext - batch context

thresholds - thresholds

BulkProcessingOptions

@Beta(value=V4_9_0,
      warningText="Preview API - subject to change in non-backwards compatible way")
 @Deprecated
public 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

Parameters:

batchContext - batch context

BulkProcessingOptions

@Beta(value=V4_9_0,
      warningText="Preview API - subject to change in non-backwards compatible way")
 @Deprecated
public 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

Method Detail

getMaxMicroBatchSize

@Beta(value=V4_9_0,
      warningText="Preview API - subject to change in non-backwards compatible way")
public int getMaxMicroBatchSize()

Deprecated.

Returns micro batch size

Returns:

micro batch size

setMaxMicroBatchSize

@Beta(value=V4_9_0,
      warningText="Preview API - subject to change in non-backwards compatible way")
public BulkProcessingOptions<TContext> setMaxMicroBatchSize(int maxMicroBatchSize)

Deprecated.

The maximum batching size for bulk operations. This value determines number of operations executed in one request. There is an upper limit on both number of operations and sum of size of operations. Any overflow is internally retried. Another instance is: Currently we support a max limit of 200KB, and user select batch size to be 100 and individual documents are of size 20KB, approximately 90 operations will always be retried. So it's better to choose a batch size of 10 here if user is aware of there workload. If sizes are totally unknown and user cannot put a number on it then retries are handled, so no issues as such. If the retry rate exceeds `getMaxMicroBatchInterval` the micro batch size gets dynamically reduced at runtime

Parameters:

maxMicroBatchSize - batching size.

Returns:

the bulk processing options.

getMaxMicroBatchConcurrency

@Beta(value=V4_9_0,
      warningText="Preview API - subject to change in non-backwards compatible way")
public int getMaxMicroBatchConcurrency()

Deprecated.

Returns max micro batch concurrency

Returns:

max micro batch concurrency

setMaxMicroBatchConcurrency

@Beta(value=V4_9_0,
      warningText="Preview API - subject to change in non-backwards compatible way")
public BulkProcessingOptions<TContext> setMaxMicroBatchConcurrency(int maxMicroBatchConcurrency)

Deprecated.

The maximum concurrency for executing requests for a partition key range.

Parameters:

maxMicroBatchConcurrency - maximum concurrency.

Returns:

the bulk processing options.

getMaxMicroBatchInterval

@Beta(value=V4_9_0,
      warningText="Preview API - subject to change in non-backwards compatible way")
public Duration getMaxMicroBatchInterval()

Deprecated.

Returns max micro batch interval

Returns:

max micro batch interval

setMaxMicroBatchInterval

@Beta(value=V4_9_0,
      warningText="Preview API - subject to change in non-backwards compatible way")
public BulkProcessingOptions<TContext> setMaxMicroBatchInterval(Duration maxMicroBatchInterval)

Deprecated.

The flush interval for bulk operations.

Parameters:

maxMicroBatchInterval - duration after which operations will be flushed to form a new batch to be executed.

Returns:

the bulk processing options.

getMaxTargetedMicroBatchRetryRate

@Beta(value=V4_17_0,
      warningText="Preview API - subject to change in non-backwards compatible way")
public double getMaxTargetedMicroBatchRetryRate()

Deprecated.

Returns max targeted micro batch retry rate

Returns:

max targeted micro batch retry rate

setTargetedMicroBatchRetryRate

@Beta(value=V4_17_0,
      warningText="Preview API - subject to change in non-backwards compatible way")
public BulkProcessingOptions<TContext> setTargetedMicroBatchRetryRate(double minRetryRate,
                                                                                                                                                                                double maxRetryRate)

Deprecated.

The acceptable retry rate bandwidth. This value determines how aggressively the actual micro batch size gets reduced or increased if the number of retries (for example due to 429 - Throttling or because the total request size exceeds the payload limit) is higher or lower that the targeted range.

Parameters:

minRetryRate - minimum targeted retry rate of batch requests. If the retry rate is lower than this threshold the micro batch size will be dynamically increased over time

maxRetryRate - maximum retry rate of batch requests that is treated as acceptable. If the retry rate is higher than this threshold the micro batch size will be dynamically reduced over time

Returns:

the bulk processing options.

getMinTargetedMicroBatchRetryRate

@Beta(value=V4_17_0,
      warningText="Preview API - subject to change in non-backwards compatible way")
public double getMinTargetedMicroBatchRetryRate()

Deprecated.

Returns min targeted micro batch retry rate

Returns:

min targeted micro batch retry rate

getBatchContext

@Beta(value=V4_9_0,
      warningText="Preview API - subject to change in non-backwards compatible way")
public TContext getBatchContext()

Deprecated.

Returns batch context

Returns:

batch context

getThresholds

@Beta(value=V4_17_0,
      warningText="Preview API - subject to change in non-backwards compatible way")
public BulkProcessingThresholds<TContext> getThresholds()

Deprecated.

Returns thresholds

Returns:

thresholds