81 строка
5.4 KiB
YAML
81 строка
5.4 KiB
YAML
### 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\" />"
|
|
inheritedMembers:
|
|
- "java.lang.Object.clone()"
|
|
- "java.lang.Object.equals(java.lang.Object)"
|
|
- "java.lang.Object.finalize()"
|
|
- "java.lang.Object.getClass()"
|
|
- "java.lang.Object.hashCode()"
|
|
- "java.lang.Object.notify()"
|
|
- "java.lang.Object.notifyAll()"
|
|
- "java.lang.Object.toString()"
|
|
- "java.lang.Object.wait()"
|
|
- "java.lang.Object.wait(long)"
|
|
- "java.lang.Object.wait(long,int)"
|
|
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.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.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.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\" />"
|
|
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.36.0
|