### YamlMime:JavaType
uid: "com.azure.cosmos.models.CosmosBatchRequestOptions"
fullName: "com.azure.cosmos.models.CosmosBatchRequestOptions"
name: "CosmosBatchRequestOptions"
nameWithType: "CosmosBatchRequestOptions"
summary: "Encapsulates options that can be specified for a <xref uid=\"com.azure.cosmos.models.CosmosBatch\" data-throw-if-not-resolved=\"false\" data-raw-source=\"CosmosBatch\"></xref>."
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 **CosmosBatchRequestOptions**"
constructors:
- uid: "com.azure.cosmos.models.CosmosBatchRequestOptions.CosmosBatchRequestOptions()"
  fullName: "com.azure.cosmos.models.CosmosBatchRequestOptions.CosmosBatchRequestOptions()"
  name: "CosmosBatchRequestOptions()"
  nameWithType: "CosmosBatchRequestOptions.CosmosBatchRequestOptions()"
  summary: "Creates an instance of the Cosmos<wbr>Batch<wbr>Request<wbr>Options class"
  syntax: "public CosmosBatchRequestOptions()"
  desc: "Creates an instance of the CosmosBatchRequestOptions class"
methods:
- uid: "com.azure.cosmos.models.CosmosBatchRequestOptions.getCustomItemSerializer()"
  fullName: "com.azure.cosmos.models.CosmosBatchRequestOptions.getCustomItemSerializer()"
  name: "getCustomItemSerializer()"
  nameWithType: "CosmosBatchRequestOptions.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.CosmosBatchRequestOptions.getDiagnosticsThresholds()"
  fullName: "com.azure.cosmos.models.CosmosBatchRequestOptions.getDiagnosticsThresholds()"
  name: "getDiagnosticsThresholds()"
  nameWithType: "CosmosBatchRequestOptions.getDiagnosticsThresholds()"
  summary: "Gets the diagnostic thresholds used as an override for a specific operation."
  syntax: "public CosmosDiagnosticsThresholds getDiagnosticsThresholds()"
  desc: "Gets the diagnostic thresholds used as an override for a specific operation. If no operation specific diagnostic threshold has been specified, this method will return null, although at runtime the default thresholds specified at the client-level will be used."
  returns:
    description: "the diagnostic thresholds used as an override for a specific operation."
    type: "<xref href=\"com.azure.cosmos.CosmosDiagnosticsThresholds?alt=com.azure.cosmos.CosmosDiagnosticsThresholds&text=CosmosDiagnosticsThresholds\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.cosmos.models.CosmosBatchRequestOptions.getExcludedRegions()"
  fullName: "com.azure.cosmos.models.CosmosBatchRequestOptions.getExcludedRegions()"
  name: "getExcludedRegions()"
  nameWithType: "CosmosBatchRequestOptions.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.CosmosBatchRequestOptions.getKeywordIdentifiers()"
  fullName: "com.azure.cosmos.models.CosmosBatchRequestOptions.getKeywordIdentifiers()"
  name: "getKeywordIdentifiers()"
  nameWithType: "CosmosBatchRequestOptions.getKeywordIdentifiers()"
  summary: "Gets the custom ids."
  syntax: "public Set<String> getKeywordIdentifiers()"
  desc: "Gets the custom ids."
  returns:
    description: "the custom ids."
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/Set.html\">Set</a>&lt;<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>&gt;"
- uid: "com.azure.cosmos.models.CosmosBatchRequestOptions.getSessionToken()"
  fullName: "com.azure.cosmos.models.CosmosBatchRequestOptions.getSessionToken()"
  name: "getSessionToken()"
  nameWithType: "CosmosBatchRequestOptions.getSessionToken()"
  summary: "Gets the token for use with session consistency."
  syntax: "public String getSessionToken()"
  desc: "Gets the token for use with session consistency."
  returns:
    description: "the session token."
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.cosmos.models.CosmosBatchRequestOptions.setCustomItemSerializer(com.azure.cosmos.CosmosItemSerializer)"
  fullName: "com.azure.cosmos.models.CosmosBatchRequestOptions.setCustomItemSerializer(CosmosItemSerializer customItemSerializer)"
  name: "setCustomItemSerializer(CosmosItemSerializer customItemSerializer)"
  nameWithType: "CosmosBatchRequestOptions.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 CosmosBatchRequestOptions 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.CosmosBatchRequestOptions?alt=com.azure.cosmos.models.CosmosBatchRequestOptions&text=CosmosBatchRequestOptions\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.cosmos.models.CosmosBatchRequestOptions.setDiagnosticsThresholds(com.azure.cosmos.CosmosDiagnosticsThresholds)"
  fullName: "com.azure.cosmos.models.CosmosBatchRequestOptions.setDiagnosticsThresholds(CosmosDiagnosticsThresholds operationSpecificThresholds)"
  name: "setDiagnosticsThresholds(CosmosDiagnosticsThresholds operationSpecificThresholds)"
  nameWithType: "CosmosBatchRequestOptions.setDiagnosticsThresholds(CosmosDiagnosticsThresholds operationSpecificThresholds)"
  summary: "Allows overriding the diagnostic thresholds for a specific operation."
  parameters:
  - description: "the diagnostic threshold override for this operation"
    name: "operationSpecificThresholds"
    type: "<xref href=\"com.azure.cosmos.CosmosDiagnosticsThresholds?alt=com.azure.cosmos.CosmosDiagnosticsThresholds&text=CosmosDiagnosticsThresholds\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public CosmosBatchRequestOptions setDiagnosticsThresholds(CosmosDiagnosticsThresholds operationSpecificThresholds)"
  desc: "Allows overriding the diagnostic thresholds for a specific operation."
  returns:
    description: "the TransactionalBatchRequestOptions."
    type: "<xref href=\"com.azure.cosmos.models.CosmosBatchRequestOptions?alt=com.azure.cosmos.models.CosmosBatchRequestOptions&text=CosmosBatchRequestOptions\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.cosmos.models.CosmosBatchRequestOptions.setExcludedRegions(java.util.List<java.lang.String>)"
  fullName: "com.azure.cosmos.models.CosmosBatchRequestOptions.setExcludedRegions(List<String> excludeRegions)"
  name: "setExcludedRegions(List<String> excludeRegions)"
  nameWithType: "CosmosBatchRequestOptions.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 CosmosBatchRequestOptions 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.CosmosBatchRequestOptions\" data-throw-if-not-resolved=\"false\" data-raw-source=\"CosmosBatchRequestOptions\"></xref>"
    type: "<xref href=\"com.azure.cosmos.models.CosmosBatchRequestOptions?alt=com.azure.cosmos.models.CosmosBatchRequestOptions&text=CosmosBatchRequestOptions\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.cosmos.models.CosmosBatchRequestOptions.setKeywordIdentifiers(java.util.Set<java.lang.String>)"
  fullName: "com.azure.cosmos.models.CosmosBatchRequestOptions.setKeywordIdentifiers(Set<String> keywordIdentifiers)"
  name: "setKeywordIdentifiers(Set<String> keywordIdentifiers)"
  nameWithType: "CosmosBatchRequestOptions.setKeywordIdentifiers(Set<String> keywordIdentifiers)"
  summary: "Sets the custom ids."
  parameters:
  - description: "the custom ids."
    name: "keywordIdentifiers"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/Set.html\">Set</a>&lt;<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>&gt;"
  syntax: "public CosmosBatchRequestOptions setKeywordIdentifiers(Set<String> keywordIdentifiers)"
  desc: "Sets the custom ids."
  returns:
    description: "the current request options."
    type: "<xref href=\"com.azure.cosmos.models.CosmosBatchRequestOptions?alt=com.azure.cosmos.models.CosmosBatchRequestOptions&text=CosmosBatchRequestOptions\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.cosmos.models.CosmosBatchRequestOptions.setSessionToken(java.lang.String)"
  fullName: "com.azure.cosmos.models.CosmosBatchRequestOptions.setSessionToken(String sessionToken)"
  name: "setSessionToken(String sessionToken)"
  nameWithType: "CosmosBatchRequestOptions.setSessionToken(String sessionToken)"
  summary: "Sets the token for use with session consistency."
  parameters:
  - description: "the session token."
    name: "sessionToken"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
  syntax: "public CosmosBatchRequestOptions setSessionToken(String sessionToken)"
  desc: "Sets the token for use with session consistency."
  returns:
    description: "the TransactionalBatchRequestOptions."
    type: "<xref href=\"com.azure.cosmos.models.CosmosBatchRequestOptions?alt=com.azure.cosmos.models.CosmosBatchRequestOptions&text=CosmosBatchRequestOptions\" data-throw-if-not-resolved=\"False\" />"
type: "class"
desc: "Encapsulates options that can be specified for a <xref uid=\"com.azure.cosmos.models.CosmosBatch\" data-throw-if-not-resolved=\"false\" data-raw-source=\"CosmosBatch\"></xref>."
metadata: {}
package: "com.azure.cosmos.models"
artifact: com.azure:azure-cosmos:4.63.3