com.azure.cosmos

Class BulkProcessingOptions<TContext>

java.lang.Object

com.azure.cosmos.BulkProcessingOptions<TContext>

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

Encapsulates options for executing a bulk. This is immutable once CosmosAsyncContainer.processBulkOperations(Flux, BulkProcessingOptions) is called, changing it will have no affect.

Constructor Summary

Constructors

Constructor and Description
BulkProcessingOptions()
BulkProcessingOptions(TContext batchContext)

Method Summary

Modifier and Type	Method and Description
TContext	getBatchContext()
int	getMaxMicroBatchConcurrency()
Duration	getMaxMicroBatchInterval()
int	getMaxMicroBatchSize()
BulkProcessingOptions<TContext>	setMaxMicroBatchConcurrency(int maxMicroBatchConcurrency) The maximum concurrency for executing requests for a partition key range.
BulkProcessingOptions<TContext>	setMaxMicroBatchInterval(Duration maxMicroBatchInterval) The flush interval for bulk operations.
BulkProcessingOptions<TContext>	setMaxMicroBatchSize(int maxMicroBatchSize) The batching size for bulk operations.

Methods inherited from class java.lang.Object

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

Constructor Detail

BulkProcessingOptions

public BulkProcessingOptions(TContext batchContext)

BulkProcessingOptions

public BulkProcessingOptions()

Method Detail

getMaxMicroBatchSize

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

setMaxMicroBatchSize

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

The 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(without keeping any count). Always good to select a value such that there is less un-necessary retry as much as possible. For eg. If max operation count supported is 100, and user passes the value to be 120, 20 operations will be retried all the time(without any execution i.e. in the client logic). So it's better to choose a value of 100 in this case. 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.

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()

setMaxMicroBatchConcurrency

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

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()

setMaxMicroBatchInterval

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

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.

getBatchContext

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