com.azure.cosmos.models.CosmosBulkExecutionOptions.yml

### YamlMime:JavaType
uid: "com.azure.cosmos.models.CosmosBulkExecutionOptions"
fullName: "com.azure.cosmos.models.CosmosBulkExecutionOptions"
name: "CosmosBulkExecutionOptions"
nameWithType: "CosmosBulkExecutionOptions"
summary: "Encapsulates options that can be specified for operations used in Bulk execution."
inheritances:
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
inheritedClassMethods:
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
  methodsRef:
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
syntax: "public final class **CosmosBulkExecutionOptions**"
constructors:
- uid: "com.azure.cosmos.models.CosmosBulkExecutionOptions.CosmosBulkExecutionOptions()"
  fullName: "com.azure.cosmos.models.CosmosBulkExecutionOptions.CosmosBulkExecutionOptions()"
  name: "CosmosBulkExecutionOptions()"
  nameWithType: "CosmosBulkExecutionOptions.CosmosBulkExecutionOptions()"
  summary: "Constructor"
  syntax: "public CosmosBulkExecutionOptions()"
  desc: "Constructor"
- uid: "com.azure.cosmos.models.CosmosBulkExecutionOptions.CosmosBulkExecutionOptions(com.azure.cosmos.models.CosmosBulkExecutionThresholdsState)"
  fullName: "com.azure.cosmos.models.CosmosBulkExecutionOptions.CosmosBulkExecutionOptions(CosmosBulkExecutionThresholdsState thresholdsState)"
  name: "CosmosBulkExecutionOptions(CosmosBulkExecutionThresholdsState thresholdsState)"
  nameWithType: "CosmosBulkExecutionOptions.CosmosBulkExecutionOptions(CosmosBulkExecutionThresholdsState thresholdsState)"
  summary: "Constructor"
  parameters:
  - description: "thresholds"
    name: "thresholdsState"
    type: "<xref href=\"com.azure.cosmos.models.CosmosBulkExecutionThresholdsState?alt=com.azure.cosmos.models.CosmosBulkExecutionThresholdsState&text=CosmosBulkExecutionThresholdsState\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public CosmosBulkExecutionOptions(CosmosBulkExecutionThresholdsState thresholdsState)"
  desc: "Constructor"
methods:
- uid: "com.azure.cosmos.models.CosmosBulkExecutionOptions.getCustomItemSerializer()"
  fullName: "com.azure.cosmos.models.CosmosBulkExecutionOptions.getCustomItemSerializer()"
  name: "getCustomItemSerializer()"
  nameWithType: "CosmosBulkExecutionOptions.getCustomItemSerializer()"
  summary: "Gets the custom item serializer defined for this instance of request options"
  syntax: "public CosmosItemSerializer getCustomItemSerializer()"
  desc: "Gets the custom item serializer defined for this instance of request options"
  returns:
    description: "the custom item serializer"
    type: "<xref href=\"com.azure.cosmos.CosmosItemSerializer?alt=com.azure.cosmos.CosmosItemSerializer&text=CosmosItemSerializer\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.cosmos.models.CosmosBulkExecutionOptions.getExcludedRegions()"
  fullName: "com.azure.cosmos.models.CosmosBulkExecutionOptions.getExcludedRegions()"
  name: "getExcludedRegions()"
  nameWithType: "CosmosBulkExecutionOptions.getExcludedRegions()"
  summary: "Gets the list of regions to be excluded for the request/retries."
  syntax: "public List<String> getExcludedRegions()"
  desc: "Gets the list of regions to be excluded for the request/retries. These regions are excluded from the preferred region list."
  returns:
    description: "a list of excluded regions"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a>&lt;<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>&gt;"
- uid: "com.azure.cosmos.models.CosmosBulkExecutionOptions.getInitialMicroBatchSize()"
  fullName: "com.azure.cosmos.models.CosmosBulkExecutionOptions.getInitialMicroBatchSize()"
  name: "getInitialMicroBatchSize()"
  nameWithType: "CosmosBulkExecutionOptions.getInitialMicroBatchSize()"
  summary: "Gets the initial size of micro batches that will be sent to the backend."
  syntax: "public int getInitialMicroBatchSize()"
  desc: "Gets the initial size of micro batches that will be sent to the backend. The size of micro batches will be dynamically adjusted based on the throttling rate. The default value is 100 - so, it starts with relatively large micro batches and when the throttling rate is too high, it will reduce the batch size. When the short spikes of throttling before dynamically reducing the initial batch size results in side effects for other workloads the initial micro batch size can be reduced - for example set to 1 - at which point it would start with small micro batches and then increase the batch size over time."
  returns:
    description: "the initial micro batch size"
    type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.cosmos.models.CosmosBulkExecutionOptions.getMaxMicroBatchConcurrency()"
  fullName: "com.azure.cosmos.models.CosmosBulkExecutionOptions.getMaxMicroBatchConcurrency()"
  name: "getMaxMicroBatchConcurrency()"
  nameWithType: "CosmosBulkExecutionOptions.getMaxMicroBatchConcurrency()"
  summary: "The maximum concurrency for executing requests for a partition key range."
  syntax: "public int getMaxMicroBatchConcurrency()"
  desc: "The maximum concurrency for executing requests for a partition key range. By default, the maxMicroBatchConcurrency is 1."
  returns:
    description: "max micro batch concurrency"
    type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.cosmos.models.CosmosBulkExecutionOptions.getMaxMicroBatchSize()"
  fullName: "com.azure.cosmos.models.CosmosBulkExecutionOptions.getMaxMicroBatchSize()"
  name: "getMaxMicroBatchSize()"
  nameWithType: "CosmosBulkExecutionOptions.getMaxMicroBatchSize()"
  summary: "The maximum batch size for bulk operations."
  syntax: "public int getMaxMicroBatchSize()"
  desc: "The maximum batch size for bulk operations. Once queued docs exceed this value, the micro batch will be flushed to the wire."
  returns:
    description: "the max micro batch size."
    type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.cosmos.models.CosmosBulkExecutionOptions.getThresholdsState()"
  fullName: "com.azure.cosmos.models.CosmosBulkExecutionOptions.getThresholdsState()"
  name: "getThresholdsState()"
  nameWithType: "CosmosBulkExecutionOptions.getThresholdsState()"
  summary: "Returns threshold state that can be passed to other Cosmos<wbr>Bulk<wbr>Execution<wbr>Options in the future"
  syntax: "public CosmosBulkExecutionThresholdsState getThresholdsState()"
  desc: "Returns threshold state that can be passed to other CosmosBulkExecutionOptions in the future"
  returns:
    description: "thresholds"
    type: "<xref href=\"com.azure.cosmos.models.CosmosBulkExecutionThresholdsState?alt=com.azure.cosmos.models.CosmosBulkExecutionThresholdsState&text=CosmosBulkExecutionThresholdsState\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.cosmos.models.CosmosBulkExecutionOptions.getThroughputControlGroupName()"
  fullName: "com.azure.cosmos.models.CosmosBulkExecutionOptions.getThroughputControlGroupName()"
  name: "getThroughputControlGroupName()"
  nameWithType: "CosmosBulkExecutionOptions.getThroughputControlGroupName()"
  summary: "Gets the throughput control group name."
  syntax: "public String getThroughputControlGroupName()"
  desc: "Gets the throughput control group name."
  returns:
    description: "the throughput control group name."
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.cosmos.models.CosmosBulkExecutionOptions.setCustomItemSerializer(com.azure.cosmos.CosmosItemSerializer)"
  fullName: "com.azure.cosmos.models.CosmosBulkExecutionOptions.setCustomItemSerializer(CosmosItemSerializer customItemSerializer)"
  name: "setCustomItemSerializer(CosmosItemSerializer customItemSerializer)"
  nameWithType: "CosmosBulkExecutionOptions.setCustomItemSerializer(CosmosItemSerializer customItemSerializer)"
  summary: "Allows specifying a custom item serializer to be used for this operation."
  parameters:
  - description: "the custom item serializer for this operation"
    name: "customItemSerializer"
    type: "<xref href=\"com.azure.cosmos.CosmosItemSerializer?alt=com.azure.cosmos.CosmosItemSerializer&text=CosmosItemSerializer\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public CosmosBulkExecutionOptions setCustomItemSerializer(CosmosItemSerializer customItemSerializer)"
  desc: "Allows specifying a custom item serializer to be used for this operation. If the serializer on the request options is null, the serializer on CosmosClientBuilder is used. If both serializers are null (the default), an internal Jackson ObjectMapper is ued for serialization/deserialization."
  returns:
    description: "the CosmosItemRequestOptions."
    type: "<xref href=\"com.azure.cosmos.models.CosmosBulkExecutionOptions?alt=com.azure.cosmos.models.CosmosBulkExecutionOptions&text=CosmosBulkExecutionOptions\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.cosmos.models.CosmosBulkExecutionOptions.setExcludedRegions(java.util.List<java.lang.String>)"
  fullName: "com.azure.cosmos.models.CosmosBulkExecutionOptions.setExcludedRegions(List<String> excludeRegions)"
  name: "setExcludedRegions(List<String> excludeRegions)"
  nameWithType: "CosmosBulkExecutionOptions.setExcludedRegions(List<String> excludeRegions)"
  summary: "List of regions to exclude for the request/retries."
  parameters:
  - description: "list of regions"
    name: "excludeRegions"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a>&lt;<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>&gt;"
  syntax: "public CosmosBulkExecutionOptions setExcludedRegions(List<String> excludeRegions)"
  desc: "List of regions to exclude for the request/retries. Example \"East US\" or \"East US, West US\" These regions will be excluded from the preferred regions list"
  returns:
    description: "the <xref uid=\"com.azure.cosmos.models.CosmosBulkExecutionOptions\" data-throw-if-not-resolved=\"false\" data-raw-source=\"CosmosBulkExecutionOptions\"></xref>"
    type: "<xref href=\"com.azure.cosmos.models.CosmosBulkExecutionOptions?alt=com.azure.cosmos.models.CosmosBulkExecutionOptions&text=CosmosBulkExecutionOptions\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.cosmos.models.CosmosBulkExecutionOptions.setInitialMicroBatchSize(int)"
  fullName: "com.azure.cosmos.models.CosmosBulkExecutionOptions.setInitialMicroBatchSize(int initialMicroBatchSize)"
  name: "setInitialMicroBatchSize(int initialMicroBatchSize)"
  nameWithType: "CosmosBulkExecutionOptions.setInitialMicroBatchSize(int initialMicroBatchSize)"
  summary: "Sets the initial size of micro batches that will be sent to the backend."
  parameters:
  - description: "the initial micro batch size to be used. Must be a positive integer."
    name: "initialMicroBatchSize"
    type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public CosmosBulkExecutionOptions setInitialMicroBatchSize(int initialMicroBatchSize)"
  desc: "Sets the initial size of micro batches that will be sent to the backend. The size of micro batches will be dynamically adjusted based on the throttling rate. The default value is 100 - so, it starts with relatively large micro batches and when the throttling rate is too high, it will reduce the batch size. When the short spikes of throttling before dynamically reducing the initial batch size results in side effects for other workloads the initial micro batch size can be reduced - for example set to 1 - at which point it would start with small micro batches and then increase the batch size over time."
  returns:
    description: "the bulk execution options."
    type: "<xref href=\"com.azure.cosmos.models.CosmosBulkExecutionOptions?alt=com.azure.cosmos.models.CosmosBulkExecutionOptions&text=CosmosBulkExecutionOptions\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.cosmos.models.CosmosBulkExecutionOptions.setMaxMicroBatchConcurrency(int)"
  fullName: "com.azure.cosmos.models.CosmosBulkExecutionOptions.setMaxMicroBatchConcurrency(int maxMicroBatchConcurrency)"
  name: "setMaxMicroBatchConcurrency(int maxMicroBatchConcurrency)"
  nameWithType: "CosmosBulkExecutionOptions.setMaxMicroBatchConcurrency(int maxMicroBatchConcurrency)"
  summary: "Set the maximum concurrency for executing requests for a partition key range."
  parameters:
  - description: "the micro batch concurrency."
    name: "maxMicroBatchConcurrency"
    type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public CosmosBulkExecutionOptions setMaxMicroBatchConcurrency(int maxMicroBatchConcurrency)"
  desc: "Set the maximum concurrency for executing requests for a partition key range. By default, the maxMicroBatchConcurrency is 1. It only allows values ?1 and ?5. Attention! Please adjust this value with caution. By increasing this value, more concurrent requests will be allowed to be sent to the server, in which case may cause 429 or request timed out due to saturate local resources, which could degrade the performance."
  returns:
    description: "the bulk processing options."
    type: "<xref href=\"com.azure.cosmos.models.CosmosBulkExecutionOptions?alt=com.azure.cosmos.models.CosmosBulkExecutionOptions&text=CosmosBulkExecutionOptions\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.cosmos.models.CosmosBulkExecutionOptions.setMaxMicroBatchSize(int)"
  fullName: "com.azure.cosmos.models.CosmosBulkExecutionOptions.setMaxMicroBatchSize(int maxMicroBatchSize)"
  name: "setMaxMicroBatchSize(int maxMicroBatchSize)"
  nameWithType: "CosmosBulkExecutionOptions.setMaxMicroBatchSize(int maxMicroBatchSize)"
  summary: "The maximum batch size for bulk operations."
  parameters:
  - description: "maximum batching size."
    name: "maxMicroBatchSize"
    type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public CosmosBulkExecutionOptions setMaxMicroBatchSize(int maxMicroBatchSize)"
  desc: "The maximum batch size for bulk operations. Once queued docs exceed this value, the micro batch will be flushed to the wire."
  returns:
    description: "the bulk processing options."
    type: "<xref href=\"com.azure.cosmos.models.CosmosBulkExecutionOptions?alt=com.azure.cosmos.models.CosmosBulkExecutionOptions&text=CosmosBulkExecutionOptions\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.cosmos.models.CosmosBulkExecutionOptions.setThroughputControlGroupName(java.lang.String)"
  fullName: "com.azure.cosmos.models.CosmosBulkExecutionOptions.setThroughputControlGroupName(String throughputControlGroupName)"
  name: "setThroughputControlGroupName(String throughputControlGroupName)"
  nameWithType: "CosmosBulkExecutionOptions.setThroughputControlGroupName(String throughputControlGroupName)"
  summary: "Sets the throughput control group name."
  parameters:
  - description: "the throughput control group name."
    name: "throughputControlGroupName"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
  syntax: "public CosmosBulkExecutionOptions setThroughputControlGroupName(String throughputControlGroupName)"
  desc: "Sets the throughput control group name."
  returns:
    description: "the CosmosBulkExecutionOptions."
    type: "<xref href=\"com.azure.cosmos.models.CosmosBulkExecutionOptions?alt=com.azure.cosmos.models.CosmosBulkExecutionOptions&text=CosmosBulkExecutionOptions\" data-throw-if-not-resolved=\"False\" />"
type: "class"
desc: "Encapsulates options that can be specified for operations used in Bulk execution. It can be passed while processing bulk operations."
metadata: {}
package: "com.azure.cosmos.models"
artifact: com.azure:azure-cosmos:4.62.0