468 строки
32 KiB
YAML
468 строки
32 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.azure.cosmos.models.CosmosRequestOptions"
|
|
fullName: "com.azure.cosmos.models.CosmosRequestOptions"
|
|
name: "CosmosRequestOptions"
|
|
nameWithType: "CosmosRequestOptions"
|
|
summary: "The common request options for operations."
|
|
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 **CosmosRequestOptions**"
|
|
constructors:
|
|
- uid: "com.azure.cosmos.models.CosmosRequestOptions.CosmosRequestOptions()"
|
|
fullName: "com.azure.cosmos.models.CosmosRequestOptions.CosmosRequestOptions()"
|
|
name: "CosmosRequestOptions()"
|
|
nameWithType: "CosmosRequestOptions.CosmosRequestOptions()"
|
|
syntax: "public CosmosRequestOptions()"
|
|
methods:
|
|
- uid: "com.azure.cosmos.models.CosmosRequestOptions.getConsistencyLevel()"
|
|
fullName: "com.azure.cosmos.models.CosmosRequestOptions.getConsistencyLevel()"
|
|
name: "getConsistencyLevel()"
|
|
nameWithType: "CosmosRequestOptions.getConsistencyLevel()"
|
|
summary: "Gets the consistency level."
|
|
syntax: "public ConsistencyLevel getConsistencyLevel()"
|
|
desc: "Gets the consistency level."
|
|
returns:
|
|
description: "the consistency level."
|
|
type: "<xref href=\"com.azure.cosmos.ConsistencyLevel?alt=com.azure.cosmos.ConsistencyLevel&text=ConsistencyLevel\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.cosmos.models.CosmosRequestOptions.getCosmosEndToEndLatencyPolicyConfig()"
|
|
fullName: "com.azure.cosmos.models.CosmosRequestOptions.getCosmosEndToEndLatencyPolicyConfig()"
|
|
name: "getCosmosEndToEndLatencyPolicyConfig()"
|
|
nameWithType: "CosmosRequestOptions.getCosmosEndToEndLatencyPolicyConfig()"
|
|
summary: "Gets the Cosmos<wbr>End<wbr>ToEnd<wbr>Latency<wbr>Policy<wbr>Config."
|
|
syntax: "public CosmosEndToEndOperationLatencyPolicyConfig getCosmosEndToEndLatencyPolicyConfig()"
|
|
desc: "Gets the CosmosEndToEndLatencyPolicyConfig."
|
|
returns:
|
|
description: "the CosmosEndToEndLatencyPolicyConfig."
|
|
type: "<xref href=\"com.azure.cosmos.CosmosEndToEndOperationLatencyPolicyConfig?alt=com.azure.cosmos.CosmosEndToEndOperationLatencyPolicyConfig&text=CosmosEndToEndOperationLatencyPolicyConfig\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.cosmos.models.CosmosRequestOptions.getDedicatedGatewayRequestOptions()"
|
|
fullName: "com.azure.cosmos.models.CosmosRequestOptions.getDedicatedGatewayRequestOptions()"
|
|
name: "getDedicatedGatewayRequestOptions()"
|
|
nameWithType: "CosmosRequestOptions.getDedicatedGatewayRequestOptions()"
|
|
summary: "Gets the dedicated gateway request options."
|
|
syntax: "public DedicatedGatewayRequestOptions getDedicatedGatewayRequestOptions()"
|
|
desc: "Gets the dedicated gateway request options."
|
|
returns:
|
|
description: "the dedicated gateway request options."
|
|
type: "<xref href=\"com.azure.cosmos.models.DedicatedGatewayRequestOptions?alt=com.azure.cosmos.models.DedicatedGatewayRequestOptions&text=DedicatedGatewayRequestOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.cosmos.models.CosmosRequestOptions.getDiagnosticsThresholds()"
|
|
fullName: "com.azure.cosmos.models.CosmosRequestOptions.getDiagnosticsThresholds()"
|
|
name: "getDiagnosticsThresholds()"
|
|
nameWithType: "CosmosRequestOptions.getDiagnosticsThresholds()"
|
|
summary: "Gets the diagnostics thresholds."
|
|
syntax: "public CosmosDiagnosticsThresholds getDiagnosticsThresholds()"
|
|
desc: "Gets the diagnostics thresholds."
|
|
returns:
|
|
description: "the diagnostics thresholds."
|
|
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.CosmosRequestOptions.getExcludedRegions()"
|
|
fullName: "com.azure.cosmos.models.CosmosRequestOptions.getExcludedRegions()"
|
|
name: "getExcludedRegions()"
|
|
nameWithType: "CosmosRequestOptions.getExcludedRegions()"
|
|
summary: "Gets the exclude regions."
|
|
syntax: "public List<String> getExcludedRegions()"
|
|
desc: "Gets the exclude regions."
|
|
returns:
|
|
description: "the exclude regions."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>>"
|
|
- uid: "com.azure.cosmos.models.CosmosRequestOptions.getKeywordIdentifiers()"
|
|
fullName: "com.azure.cosmos.models.CosmosRequestOptions.getKeywordIdentifiers()"
|
|
name: "getKeywordIdentifiers()"
|
|
nameWithType: "CosmosRequestOptions.getKeywordIdentifiers()"
|
|
summary: "Gets the keyword<wbr>Identifiers."
|
|
syntax: "public Set<String> getKeywordIdentifiers()"
|
|
desc: "Gets the keywordIdentifiers."
|
|
returns:
|
|
description: "the keywordIdentifiers."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/Set.html\">Set</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>>"
|
|
- uid: "com.azure.cosmos.models.CosmosRequestOptions.getMaxBufferedItemCount()"
|
|
fullName: "com.azure.cosmos.models.CosmosRequestOptions.getMaxBufferedItemCount()"
|
|
name: "getMaxBufferedItemCount()"
|
|
nameWithType: "CosmosRequestOptions.getMaxBufferedItemCount()"
|
|
summary: "Gets the max buffered item count."
|
|
syntax: "public Integer getMaxBufferedItemCount()"
|
|
desc: "Gets the max buffered item count."
|
|
returns:
|
|
description: "the max buffered item count."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
|
|
- uid: "com.azure.cosmos.models.CosmosRequestOptions.getMaxDegreeOfParallelism()"
|
|
fullName: "com.azure.cosmos.models.CosmosRequestOptions.getMaxDegreeOfParallelism()"
|
|
name: "getMaxDegreeOfParallelism()"
|
|
nameWithType: "CosmosRequestOptions.getMaxDegreeOfParallelism()"
|
|
summary: "Gets the max degree of parallelism."
|
|
syntax: "public Integer getMaxDegreeOfParallelism()"
|
|
desc: "Gets the max degree of parallelism."
|
|
returns:
|
|
description: "the max degree of parallelism."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
|
|
- uid: "com.azure.cosmos.models.CosmosRequestOptions.getMaxItemCount()"
|
|
fullName: "com.azure.cosmos.models.CosmosRequestOptions.getMaxItemCount()"
|
|
name: "getMaxItemCount()"
|
|
nameWithType: "CosmosRequestOptions.getMaxItemCount()"
|
|
summary: "Gets the max item count."
|
|
syntax: "public Integer getMaxItemCount()"
|
|
desc: "Gets the max item count."
|
|
returns:
|
|
description: "the max item count."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
|
|
- uid: "com.azure.cosmos.models.CosmosRequestOptions.getMaxPrefetchPageCount()"
|
|
fullName: "com.azure.cosmos.models.CosmosRequestOptions.getMaxPrefetchPageCount()"
|
|
name: "getMaxPrefetchPageCount()"
|
|
nameWithType: "CosmosRequestOptions.getMaxPrefetchPageCount()"
|
|
summary: "Gets the max prefetch page count."
|
|
syntax: "public Integer getMaxPrefetchPageCount()"
|
|
desc: "Gets the max prefetch page count."
|
|
returns:
|
|
description: "the max prefetch page count."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
|
|
- uid: "com.azure.cosmos.models.CosmosRequestOptions.getNonIdempotentWriteRetriesEnabled()"
|
|
fullName: "com.azure.cosmos.models.CosmosRequestOptions.getNonIdempotentWriteRetriesEnabled()"
|
|
name: "getNonIdempotentWriteRetriesEnabled()"
|
|
nameWithType: "CosmosRequestOptions.getNonIdempotentWriteRetriesEnabled()"
|
|
summary: "Gets the non idempotent write retries enabled."
|
|
syntax: "public Boolean getNonIdempotentWriteRetriesEnabled()"
|
|
desc: "Gets the non idempotent write retries enabled."
|
|
returns:
|
|
description: "the non idempotent write retries enabled."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
|
|
- uid: "com.azure.cosmos.models.CosmosRequestOptions.getQueryName()"
|
|
fullName: "com.azure.cosmos.models.CosmosRequestOptions.getQueryName()"
|
|
name: "getQueryName()"
|
|
nameWithType: "CosmosRequestOptions.getQueryName()"
|
|
summary: "Gets the query name."
|
|
syntax: "public String getQueryName()"
|
|
desc: "Gets the query name."
|
|
returns:
|
|
description: "the query name."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.azure.cosmos.models.CosmosRequestOptions.getResponseContinuationTokenLimitInKb()"
|
|
fullName: "com.azure.cosmos.models.CosmosRequestOptions.getResponseContinuationTokenLimitInKb()"
|
|
name: "getResponseContinuationTokenLimitInKb()"
|
|
nameWithType: "CosmosRequestOptions.getResponseContinuationTokenLimitInKb()"
|
|
summary: "Gets the response continuation token limit in KB."
|
|
syntax: "public Integer getResponseContinuationTokenLimitInKb()"
|
|
desc: "Gets the response continuation token limit in KB."
|
|
returns:
|
|
description: "the response continuation token limit in KB."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
|
|
- uid: "com.azure.cosmos.models.CosmosRequestOptions.getThroughputControlGroupName()"
|
|
fullName: "com.azure.cosmos.models.CosmosRequestOptions.getThroughputControlGroupName()"
|
|
name: "getThroughputControlGroupName()"
|
|
nameWithType: "CosmosRequestOptions.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.CosmosRequestOptions.isContentResponseOnWriteEnabled()"
|
|
fullName: "com.azure.cosmos.models.CosmosRequestOptions.isContentResponseOnWriteEnabled()"
|
|
name: "isContentResponseOnWriteEnabled()"
|
|
nameWithType: "CosmosRequestOptions.isContentResponseOnWriteEnabled()"
|
|
summary: "Gets the content response on write enabled."
|
|
syntax: "public Boolean isContentResponseOnWriteEnabled()"
|
|
desc: "Gets the content response on write enabled."
|
|
returns:
|
|
description: "the content response on write enabled."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
|
|
- uid: "com.azure.cosmos.models.CosmosRequestOptions.isIndexMetricsEnabled()"
|
|
fullName: "com.azure.cosmos.models.CosmosRequestOptions.isIndexMetricsEnabled()"
|
|
name: "isIndexMetricsEnabled()"
|
|
nameWithType: "CosmosRequestOptions.isIndexMetricsEnabled()"
|
|
summary: "Gets the index metrics enabled."
|
|
syntax: "public Boolean isIndexMetricsEnabled()"
|
|
desc: "Gets the index metrics enabled."
|
|
returns:
|
|
description: "the index metrics enabled."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
|
|
- uid: "com.azure.cosmos.models.CosmosRequestOptions.isQueryMetricsEnabled()"
|
|
fullName: "com.azure.cosmos.models.CosmosRequestOptions.isQueryMetricsEnabled()"
|
|
name: "isQueryMetricsEnabled()"
|
|
nameWithType: "CosmosRequestOptions.isQueryMetricsEnabled()"
|
|
summary: "Gets the query metrics enabled."
|
|
syntax: "public Boolean isQueryMetricsEnabled()"
|
|
desc: "Gets the query metrics enabled."
|
|
returns:
|
|
description: "the query metrics enabled."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
|
|
- uid: "com.azure.cosmos.models.CosmosRequestOptions.isScanInQueryEnabled()"
|
|
fullName: "com.azure.cosmos.models.CosmosRequestOptions.isScanInQueryEnabled()"
|
|
name: "isScanInQueryEnabled()"
|
|
nameWithType: "CosmosRequestOptions.isScanInQueryEnabled()"
|
|
summary: "Gets the scan in query enabled."
|
|
syntax: "public Boolean isScanInQueryEnabled()"
|
|
desc: "Gets the scan in query enabled."
|
|
returns:
|
|
description: "the scan in query enabled."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
|
|
- uid: "com.azure.cosmos.models.CosmosRequestOptions.setConsistencyLevel(com.azure.cosmos.ConsistencyLevel)"
|
|
fullName: "com.azure.cosmos.models.CosmosRequestOptions.setConsistencyLevel(ConsistencyLevel consistencyLevel)"
|
|
name: "setConsistencyLevel(ConsistencyLevel consistencyLevel)"
|
|
nameWithType: "CosmosRequestOptions.setConsistencyLevel(ConsistencyLevel consistencyLevel)"
|
|
summary: "Sets the consistency level."
|
|
parameters:
|
|
- description: "the consistency level."
|
|
name: "consistencyLevel"
|
|
type: "<xref href=\"com.azure.cosmos.ConsistencyLevel?alt=com.azure.cosmos.ConsistencyLevel&text=ConsistencyLevel\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public CosmosRequestOptions setConsistencyLevel(ConsistencyLevel consistencyLevel)"
|
|
desc: "Sets the consistency level."
|
|
returns:
|
|
description: "current CosmosRequestOptions."
|
|
type: "<xref href=\"com.azure.cosmos.models.CosmosRequestOptions?alt=com.azure.cosmos.models.CosmosRequestOptions&text=CosmosRequestOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.cosmos.models.CosmosRequestOptions.setContentResponseOnWriteEnabled(java.lang.Boolean)"
|
|
fullName: "com.azure.cosmos.models.CosmosRequestOptions.setContentResponseOnWriteEnabled(Boolean contentResponseOnWriteEnabled)"
|
|
name: "setContentResponseOnWriteEnabled(Boolean contentResponseOnWriteEnabled)"
|
|
nameWithType: "CosmosRequestOptions.setContentResponseOnWriteEnabled(Boolean contentResponseOnWriteEnabled)"
|
|
summary: "Sets the content response on write enabled."
|
|
parameters:
|
|
- description: "the content response on write enabled."
|
|
name: "contentResponseOnWriteEnabled"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
|
|
syntax: "public CosmosRequestOptions setContentResponseOnWriteEnabled(Boolean contentResponseOnWriteEnabled)"
|
|
desc: "Sets the content response on write enabled."
|
|
returns:
|
|
description: "current CosmosRequestOptions."
|
|
type: "<xref href=\"com.azure.cosmos.models.CosmosRequestOptions?alt=com.azure.cosmos.models.CosmosRequestOptions&text=CosmosRequestOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.cosmos.models.CosmosRequestOptions.setCosmosEndToEndLatencyPolicyConfig(com.azure.cosmos.CosmosEndToEndOperationLatencyPolicyConfig)"
|
|
fullName: "com.azure.cosmos.models.CosmosRequestOptions.setCosmosEndToEndLatencyPolicyConfig(CosmosEndToEndOperationLatencyPolicyConfig endToEndOperationLatencyPolicyConfig)"
|
|
name: "setCosmosEndToEndLatencyPolicyConfig(CosmosEndToEndOperationLatencyPolicyConfig endToEndOperationLatencyPolicyConfig)"
|
|
nameWithType: "CosmosRequestOptions.setCosmosEndToEndLatencyPolicyConfig(CosmosEndToEndOperationLatencyPolicyConfig endToEndOperationLatencyPolicyConfig)"
|
|
summary: "Sets the Cosmos<wbr>End<wbr>ToEnd<wbr>Latency<wbr>Policy<wbr>Config."
|
|
parameters:
|
|
- description: "the CosmosEndToEndLatencyPolicyConfig."
|
|
name: "endToEndOperationLatencyPolicyConfig"
|
|
type: "<xref href=\"com.azure.cosmos.CosmosEndToEndOperationLatencyPolicyConfig?alt=com.azure.cosmos.CosmosEndToEndOperationLatencyPolicyConfig&text=CosmosEndToEndOperationLatencyPolicyConfig\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public CosmosRequestOptions setCosmosEndToEndLatencyPolicyConfig(CosmosEndToEndOperationLatencyPolicyConfig endToEndOperationLatencyPolicyConfig)"
|
|
desc: "Sets the CosmosEndToEndLatencyPolicyConfig."
|
|
returns:
|
|
description: "current CosmosRequestOptions."
|
|
type: "<xref href=\"com.azure.cosmos.models.CosmosRequestOptions?alt=com.azure.cosmos.models.CosmosRequestOptions&text=CosmosRequestOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.cosmos.models.CosmosRequestOptions.setDedicatedGatewayRequestOptions(com.azure.cosmos.models.DedicatedGatewayRequestOptions)"
|
|
fullName: "com.azure.cosmos.models.CosmosRequestOptions.setDedicatedGatewayRequestOptions(DedicatedGatewayRequestOptions dedicatedGatewayRequestOptions)"
|
|
name: "setDedicatedGatewayRequestOptions(DedicatedGatewayRequestOptions dedicatedGatewayRequestOptions)"
|
|
nameWithType: "CosmosRequestOptions.setDedicatedGatewayRequestOptions(DedicatedGatewayRequestOptions dedicatedGatewayRequestOptions)"
|
|
summary: "Sets the Dedicated<wbr>Gateway<wbr>Request<wbr>Options."
|
|
parameters:
|
|
- description: "the DedicatedGatewayRequestOptions."
|
|
name: "dedicatedGatewayRequestOptions"
|
|
type: "<xref href=\"com.azure.cosmos.models.DedicatedGatewayRequestOptions?alt=com.azure.cosmos.models.DedicatedGatewayRequestOptions&text=DedicatedGatewayRequestOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public CosmosRequestOptions setDedicatedGatewayRequestOptions(DedicatedGatewayRequestOptions dedicatedGatewayRequestOptions)"
|
|
desc: "Sets the DedicatedGatewayRequestOptions."
|
|
returns:
|
|
description: "current CosmosRequestOptions."
|
|
type: "<xref href=\"com.azure.cosmos.models.CosmosRequestOptions?alt=com.azure.cosmos.models.CosmosRequestOptions&text=CosmosRequestOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.cosmos.models.CosmosRequestOptions.setDiagnosticsThresholds(com.azure.cosmos.CosmosDiagnosticsThresholds)"
|
|
fullName: "com.azure.cosmos.models.CosmosRequestOptions.setDiagnosticsThresholds(CosmosDiagnosticsThresholds thresholds)"
|
|
name: "setDiagnosticsThresholds(CosmosDiagnosticsThresholds thresholds)"
|
|
nameWithType: "CosmosRequestOptions.setDiagnosticsThresholds(CosmosDiagnosticsThresholds thresholds)"
|
|
summary: "Sets the Cosmos<wbr>Diagnostics<wbr>Thresholds."
|
|
parameters:
|
|
- description: "the CosmosDiagnosticsThresholds."
|
|
name: "thresholds"
|
|
type: "<xref href=\"com.azure.cosmos.CosmosDiagnosticsThresholds?alt=com.azure.cosmos.CosmosDiagnosticsThresholds&text=CosmosDiagnosticsThresholds\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public CosmosRequestOptions setDiagnosticsThresholds(CosmosDiagnosticsThresholds thresholds)"
|
|
desc: "Sets the CosmosDiagnosticsThresholds."
|
|
returns:
|
|
description: "current CosmosRequestOptions."
|
|
type: "<xref href=\"com.azure.cosmos.models.CosmosRequestOptions?alt=com.azure.cosmos.models.CosmosRequestOptions&text=CosmosRequestOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.cosmos.models.CosmosRequestOptions.setExcludeRegions(java.util.List<java.lang.String>)"
|
|
fullName: "com.azure.cosmos.models.CosmosRequestOptions.setExcludeRegions(List<String> excludeRegions)"
|
|
name: "setExcludeRegions(List<String> excludeRegions)"
|
|
nameWithType: "CosmosRequestOptions.setExcludeRegions(List<String> excludeRegions)"
|
|
summary: "Sets the exclude regions."
|
|
parameters:
|
|
- description: "the ExcludeRegions."
|
|
name: "excludeRegions"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>>"
|
|
syntax: "public CosmosRequestOptions setExcludeRegions(List<String> excludeRegions)"
|
|
desc: "Sets the exclude regions."
|
|
returns:
|
|
description: "current CosmosRequestOptions."
|
|
type: "<xref href=\"com.azure.cosmos.models.CosmosRequestOptions?alt=com.azure.cosmos.models.CosmosRequestOptions&text=CosmosRequestOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.cosmos.models.CosmosRequestOptions.setIndexMetricsEnabled(java.lang.Boolean)"
|
|
fullName: "com.azure.cosmos.models.CosmosRequestOptions.setIndexMetricsEnabled(Boolean indexMetricsEnabled)"
|
|
name: "setIndexMetricsEnabled(Boolean indexMetricsEnabled)"
|
|
nameWithType: "CosmosRequestOptions.setIndexMetricsEnabled(Boolean indexMetricsEnabled)"
|
|
summary: "Sets the Index<wbr>Metrics<wbr>Enabled."
|
|
parameters:
|
|
- description: "the IndexMetricsEnabled."
|
|
name: "indexMetricsEnabled"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
|
|
syntax: "public CosmosRequestOptions setIndexMetricsEnabled(Boolean indexMetricsEnabled)"
|
|
desc: "Sets the IndexMetricsEnabled."
|
|
returns:
|
|
description: "current CosmosRequestOptions."
|
|
type: "<xref href=\"com.azure.cosmos.models.CosmosRequestOptions?alt=com.azure.cosmos.models.CosmosRequestOptions&text=CosmosRequestOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.cosmos.models.CosmosRequestOptions.setKeywordIdentifiers(java.util.Set<java.lang.String>)"
|
|
fullName: "com.azure.cosmos.models.CosmosRequestOptions.setKeywordIdentifiers(Set<String> keywordIdentifiers)"
|
|
name: "setKeywordIdentifiers(Set<String> keywordIdentifiers)"
|
|
nameWithType: "CosmosRequestOptions.setKeywordIdentifiers(Set<String> keywordIdentifiers)"
|
|
summary: "Sets the keyword<wbr>Identifiers."
|
|
parameters:
|
|
- description: "the keywordIdentifiers."
|
|
name: "keywordIdentifiers"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/Set.html\">Set</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>>"
|
|
syntax: "public CosmosRequestOptions setKeywordIdentifiers(Set<String> keywordIdentifiers)"
|
|
desc: "Sets the keywordIdentifiers."
|
|
returns:
|
|
description: "current CosmosCommonRequestOptions."
|
|
type: "<xref href=\"com.azure.cosmos.models.CosmosRequestOptions?alt=com.azure.cosmos.models.CosmosRequestOptions&text=CosmosRequestOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.cosmos.models.CosmosRequestOptions.setMaxBufferedItemCount(java.lang.Integer)"
|
|
fullName: "com.azure.cosmos.models.CosmosRequestOptions.setMaxBufferedItemCount(Integer maxBufferedItemCount)"
|
|
name: "setMaxBufferedItemCount(Integer maxBufferedItemCount)"
|
|
nameWithType: "CosmosRequestOptions.setMaxBufferedItemCount(Integer maxBufferedItemCount)"
|
|
summary: "Sets the Max<wbr>Buffered<wbr>Item<wbr>Count."
|
|
parameters:
|
|
- description: "the MaxBufferedItemCount."
|
|
name: "maxBufferedItemCount"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
|
|
syntax: "public CosmosRequestOptions setMaxBufferedItemCount(Integer maxBufferedItemCount)"
|
|
desc: "Sets the MaxBufferedItemCount."
|
|
returns:
|
|
description: "current CosmosRequestOptions."
|
|
type: "<xref href=\"com.azure.cosmos.models.CosmosRequestOptions?alt=com.azure.cosmos.models.CosmosRequestOptions&text=CosmosRequestOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.cosmos.models.CosmosRequestOptions.setMaxDegreeOfParallelism(java.lang.Integer)"
|
|
fullName: "com.azure.cosmos.models.CosmosRequestOptions.setMaxDegreeOfParallelism(Integer maxDegreeOfParallelism)"
|
|
name: "setMaxDegreeOfParallelism(Integer maxDegreeOfParallelism)"
|
|
nameWithType: "CosmosRequestOptions.setMaxDegreeOfParallelism(Integer maxDegreeOfParallelism)"
|
|
summary: "Sets the Max<wbr>Degree<wbr>OfParallelism."
|
|
parameters:
|
|
- description: "the MaxDegreeOfParallelism."
|
|
name: "maxDegreeOfParallelism"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
|
|
syntax: "public CosmosRequestOptions setMaxDegreeOfParallelism(Integer maxDegreeOfParallelism)"
|
|
desc: "Sets the MaxDegreeOfParallelism."
|
|
returns:
|
|
description: "current CosmosRequestOptions."
|
|
type: "<xref href=\"com.azure.cosmos.models.CosmosRequestOptions?alt=com.azure.cosmos.models.CosmosRequestOptions&text=CosmosRequestOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.cosmos.models.CosmosRequestOptions.setMaxItemCount(java.lang.Integer)"
|
|
fullName: "com.azure.cosmos.models.CosmosRequestOptions.setMaxItemCount(Integer maxItemCount)"
|
|
name: "setMaxItemCount(Integer maxItemCount)"
|
|
nameWithType: "CosmosRequestOptions.setMaxItemCount(Integer maxItemCount)"
|
|
summary: "Sets the Max<wbr>Item<wbr>Count."
|
|
parameters:
|
|
- description: "the MaxItemCount."
|
|
name: "maxItemCount"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
|
|
syntax: "public CosmosRequestOptions setMaxItemCount(Integer maxItemCount)"
|
|
desc: "Sets the MaxItemCount."
|
|
returns:
|
|
description: "current CosmosRequestOptions."
|
|
type: "<xref href=\"com.azure.cosmos.models.CosmosRequestOptions?alt=com.azure.cosmos.models.CosmosRequestOptions&text=CosmosRequestOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.cosmos.models.CosmosRequestOptions.setMaxPrefetchPageCount(java.lang.Integer)"
|
|
fullName: "com.azure.cosmos.models.CosmosRequestOptions.setMaxPrefetchPageCount(Integer maxPrefetchPageCount)"
|
|
name: "setMaxPrefetchPageCount(Integer maxPrefetchPageCount)"
|
|
nameWithType: "CosmosRequestOptions.setMaxPrefetchPageCount(Integer maxPrefetchPageCount)"
|
|
summary: "Sets the Max<wbr>Prefetch<wbr>Page<wbr>Count."
|
|
parameters:
|
|
- description: "the MaxPrefetchPageCount."
|
|
name: "maxPrefetchPageCount"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
|
|
syntax: "public CosmosRequestOptions setMaxPrefetchPageCount(Integer maxPrefetchPageCount)"
|
|
desc: "Sets the MaxPrefetchPageCount."
|
|
returns:
|
|
description: "current CosmosRequestOptions."
|
|
type: "<xref href=\"com.azure.cosmos.models.CosmosRequestOptions?alt=com.azure.cosmos.models.CosmosRequestOptions&text=CosmosRequestOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.cosmos.models.CosmosRequestOptions.setNonIdempotentWriteRetriesEnabled(java.lang.Boolean)"
|
|
fullName: "com.azure.cosmos.models.CosmosRequestOptions.setNonIdempotentWriteRetriesEnabled(Boolean nonIdempotentWriteRetriesEnabled)"
|
|
name: "setNonIdempotentWriteRetriesEnabled(Boolean nonIdempotentWriteRetriesEnabled)"
|
|
nameWithType: "CosmosRequestOptions.setNonIdempotentWriteRetriesEnabled(Boolean nonIdempotentWriteRetriesEnabled)"
|
|
summary: "Sets the Non<wbr>Idempotent<wbr>Write<wbr>Retries<wbr>Enabled."
|
|
parameters:
|
|
- description: "the NonIdempotentWriteRetriesEnabled."
|
|
name: "nonIdempotentWriteRetriesEnabled"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
|
|
syntax: "public CosmosRequestOptions setNonIdempotentWriteRetriesEnabled(Boolean nonIdempotentWriteRetriesEnabled)"
|
|
desc: "Sets the NonIdempotentWriteRetriesEnabled."
|
|
returns:
|
|
description: "current CosmosRequestOptions."
|
|
type: "<xref href=\"com.azure.cosmos.models.CosmosRequestOptions?alt=com.azure.cosmos.models.CosmosRequestOptions&text=CosmosRequestOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.cosmos.models.CosmosRequestOptions.setQueryMetricsEnabled(java.lang.Boolean)"
|
|
fullName: "com.azure.cosmos.models.CosmosRequestOptions.setQueryMetricsEnabled(Boolean queryMetricsEnabled)"
|
|
name: "setQueryMetricsEnabled(Boolean queryMetricsEnabled)"
|
|
nameWithType: "CosmosRequestOptions.setQueryMetricsEnabled(Boolean queryMetricsEnabled)"
|
|
summary: "Sets the Query<wbr>Metrics<wbr>Enabled."
|
|
parameters:
|
|
- description: "the QueryMetricsEnabled."
|
|
name: "queryMetricsEnabled"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
|
|
syntax: "public CosmosRequestOptions setQueryMetricsEnabled(Boolean queryMetricsEnabled)"
|
|
desc: "Sets the QueryMetricsEnabled."
|
|
returns:
|
|
description: "current CosmosRequestOptions."
|
|
type: "<xref href=\"com.azure.cosmos.models.CosmosRequestOptions?alt=com.azure.cosmos.models.CosmosRequestOptions&text=CosmosRequestOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.cosmos.models.CosmosRequestOptions.setQueryName(java.lang.String)"
|
|
fullName: "com.azure.cosmos.models.CosmosRequestOptions.setQueryName(String queryName)"
|
|
name: "setQueryName(String queryName)"
|
|
nameWithType: "CosmosRequestOptions.setQueryName(String queryName)"
|
|
summary: "Sets the Query<wbr>Name."
|
|
parameters:
|
|
- description: "the QueryName."
|
|
name: "queryName"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public CosmosRequestOptions setQueryName(String queryName)"
|
|
desc: "Sets the QueryName."
|
|
returns:
|
|
description: "current CosmosRequestOptions."
|
|
type: "<xref href=\"com.azure.cosmos.models.CosmosRequestOptions?alt=com.azure.cosmos.models.CosmosRequestOptions&text=CosmosRequestOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.cosmos.models.CosmosRequestOptions.setResponseContinuationTokenLimitInKb(java.lang.Integer)"
|
|
fullName: "com.azure.cosmos.models.CosmosRequestOptions.setResponseContinuationTokenLimitInKb(Integer responseContinuationTokenLimitInKb)"
|
|
name: "setResponseContinuationTokenLimitInKb(Integer responseContinuationTokenLimitInKb)"
|
|
nameWithType: "CosmosRequestOptions.setResponseContinuationTokenLimitInKb(Integer responseContinuationTokenLimitInKb)"
|
|
summary: "Sets the Response<wbr>Continuation<wbr>Token<wbr>Limit<wbr>InKb."
|
|
parameters:
|
|
- description: "the ResponseContinuationTokenLimitInKb."
|
|
name: "responseContinuationTokenLimitInKb"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
|
|
syntax: "public CosmosRequestOptions setResponseContinuationTokenLimitInKb(Integer responseContinuationTokenLimitInKb)"
|
|
desc: "Sets the ResponseContinuationTokenLimitInKb."
|
|
returns:
|
|
description: "current CosmosRequestOptions."
|
|
type: "<xref href=\"com.azure.cosmos.models.CosmosRequestOptions?alt=com.azure.cosmos.models.CosmosRequestOptions&text=CosmosRequestOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.cosmos.models.CosmosRequestOptions.setScanInQueryEnabled(java.lang.Boolean)"
|
|
fullName: "com.azure.cosmos.models.CosmosRequestOptions.setScanInQueryEnabled(Boolean scanInQueryEnabled)"
|
|
name: "setScanInQueryEnabled(Boolean scanInQueryEnabled)"
|
|
nameWithType: "CosmosRequestOptions.setScanInQueryEnabled(Boolean scanInQueryEnabled)"
|
|
summary: "Sets the Scan<wbr>InQuery<wbr>Enabled."
|
|
parameters:
|
|
- description: "the ScanInQueryEnabled."
|
|
name: "scanInQueryEnabled"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
|
|
syntax: "public CosmosRequestOptions setScanInQueryEnabled(Boolean scanInQueryEnabled)"
|
|
desc: "Sets the ScanInQueryEnabled."
|
|
returns:
|
|
description: "current CosmosRequestOptions."
|
|
type: "<xref href=\"com.azure.cosmos.models.CosmosRequestOptions?alt=com.azure.cosmos.models.CosmosRequestOptions&text=CosmosRequestOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.cosmos.models.CosmosRequestOptions.setThroughputControlGroupName(java.lang.String)"
|
|
fullName: "com.azure.cosmos.models.CosmosRequestOptions.setThroughputControlGroupName(String throughputControlGroupName)"
|
|
name: "setThroughputControlGroupName(String throughputControlGroupName)"
|
|
nameWithType: "CosmosRequestOptions.setThroughputControlGroupName(String throughputControlGroupName)"
|
|
summary: "Sets the throughput control group name."
|
|
parameters:
|
|
- description: "the ThroughputControlGroupName."
|
|
name: "throughputControlGroupName"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public CosmosRequestOptions setThroughputControlGroupName(String throughputControlGroupName)"
|
|
desc: "Sets the throughput control group name."
|
|
returns:
|
|
description: "current CosmosRequestOptions."
|
|
type: "<xref href=\"com.azure.cosmos.models.CosmosRequestOptions?alt=com.azure.cosmos.models.CosmosRequestOptions&text=CosmosRequestOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
type: "class"
|
|
desc: "The common request options for operations. This class should be used with the addPolicy method in the <xref uid=\"com.azure.cosmos.CosmosClientBuilder\" data-throw-if-not-resolved=\"false\" data-raw-source=\"com.azure.cosmos.CosmosClientBuilder\"></xref> to change request options without restarting the application."
|
|
metadata: {}
|
|
package: "com.azure.cosmos.models"
|
|
artifact: com.azure:azure-cosmos:4.63.4
|