340 строки
30 KiB
YAML
340 строки
30 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.azure.cosmos.models.CosmosReadManyRequestOptions"
|
|
fullName: "com.azure.cosmos.models.CosmosReadManyRequestOptions"
|
|
name: "CosmosReadManyRequestOptions"
|
|
nameWithType: "CosmosReadManyRequestOptions"
|
|
summary: "Specifies the options associated with read many operation in the Azure Cosmos DB database service."
|
|
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 **CosmosReadManyRequestOptions**"
|
|
constructors:
|
|
- uid: "com.azure.cosmos.models.CosmosReadManyRequestOptions.CosmosReadManyRequestOptions()"
|
|
fullName: "com.azure.cosmos.models.CosmosReadManyRequestOptions.CosmosReadManyRequestOptions()"
|
|
name: "CosmosReadManyRequestOptions()"
|
|
nameWithType: "CosmosReadManyRequestOptions.CosmosReadManyRequestOptions()"
|
|
summary: "Instantiates a new read many request options."
|
|
syntax: "public CosmosReadManyRequestOptions()"
|
|
desc: "Instantiates a new read many request options."
|
|
methods:
|
|
- uid: "com.azure.cosmos.models.CosmosReadManyRequestOptions.getConsistencyLevel()"
|
|
fullName: "com.azure.cosmos.models.CosmosReadManyRequestOptions.getConsistencyLevel()"
|
|
name: "getConsistencyLevel()"
|
|
nameWithType: "CosmosReadManyRequestOptions.getConsistencyLevel()"
|
|
summary: "Gets the consistency level required for the request."
|
|
syntax: "public ConsistencyLevel getConsistencyLevel()"
|
|
desc: "Gets the consistency level required for the request."
|
|
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.CosmosReadManyRequestOptions.getCustomItemSerializer()"
|
|
fullName: "com.azure.cosmos.models.CosmosReadManyRequestOptions.getCustomItemSerializer()"
|
|
name: "getCustomItemSerializer()"
|
|
nameWithType: "CosmosReadManyRequestOptions.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.CosmosReadManyRequestOptions.getDedicatedGatewayRequestOptions()"
|
|
fullName: "com.azure.cosmos.models.CosmosReadManyRequestOptions.getDedicatedGatewayRequestOptions()"
|
|
name: "getDedicatedGatewayRequestOptions()"
|
|
nameWithType: "CosmosReadManyRequestOptions.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.CosmosReadManyRequestOptions.getDiagnosticsThresholds()"
|
|
fullName: "com.azure.cosmos.models.CosmosReadManyRequestOptions.getDiagnosticsThresholds()"
|
|
name: "getDiagnosticsThresholds()"
|
|
nameWithType: "CosmosReadManyRequestOptions.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.CosmosReadManyRequestOptions.getExcludedRegions()"
|
|
fullName: "com.azure.cosmos.models.CosmosReadManyRequestOptions.getExcludedRegions()"
|
|
name: "getExcludedRegions()"
|
|
nameWithType: "CosmosReadManyRequestOptions.getExcludedRegions()"
|
|
summary: "Gets the list of regions to exclude for the request/retries."
|
|
syntax: "public List<String> getExcludedRegions()"
|
|
desc: "Gets the list of regions to exclude 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><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>>"
|
|
- uid: "com.azure.cosmos.models.CosmosReadManyRequestOptions.getKeywordIdentifiers()"
|
|
fullName: "com.azure.cosmos.models.CosmosReadManyRequestOptions.getKeywordIdentifiers()"
|
|
name: "getKeywordIdentifiers()"
|
|
nameWithType: "CosmosReadManyRequestOptions.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><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>>"
|
|
- uid: "com.azure.cosmos.models.CosmosReadManyRequestOptions.getResponseContinuationTokenLimitInKb()"
|
|
fullName: "com.azure.cosmos.models.CosmosReadManyRequestOptions.getResponseContinuationTokenLimitInKb()"
|
|
name: "getResponseContinuationTokenLimitInKb()"
|
|
nameWithType: "CosmosReadManyRequestOptions.getResponseContinuationTokenLimitInKb()"
|
|
summary: "Gets the Response<wbr>Continuation<wbr>Token<wbr>Limit<wbr>InKb request option for item query requests in the Azure Cosmos DB service."
|
|
syntax: "public int getResponseContinuationTokenLimitInKb()"
|
|
desc: "Gets the ResponseContinuationTokenLimitInKb request option for item query requests in the Azure Cosmos DB service. If not already set returns 0.\n\nResponseContinuationTokenLimitInKb is used to limit the length of continuation token in the query response. Valid values are >= 1."
|
|
returns:
|
|
description: "return set ResponseContinuationTokenLimitInKb, or 0 if not set"
|
|
type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.cosmos.models.CosmosReadManyRequestOptions.getSessionToken()"
|
|
fullName: "com.azure.cosmos.models.CosmosReadManyRequestOptions.getSessionToken()"
|
|
name: "getSessionToken()"
|
|
nameWithType: "CosmosReadManyRequestOptions.getSessionToken()"
|
|
summary: "Gets the session token for use with session consistency."
|
|
syntax: "public String getSessionToken()"
|
|
desc: "Gets the session 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.CosmosReadManyRequestOptions.getThresholdForDiagnosticsOnTracer()"
|
|
fullName: "com.azure.cosmos.models.CosmosReadManyRequestOptions.getThresholdForDiagnosticsOnTracer()"
|
|
name: "getThresholdForDiagnosticsOnTracer()"
|
|
nameWithType: "CosmosReadManyRequestOptions.getThresholdForDiagnosticsOnTracer()"
|
|
summary: "Gets the threshold<wbr>For<wbr>Diagnostics<wbr>OnTracer, if latency on query operation is greater than this diagnostics will be send to open telemetry exporter as events in tracer span of end to end CRUD api."
|
|
syntax: "public Duration getThresholdForDiagnosticsOnTracer()"
|
|
desc: "Gets the thresholdForDiagnosticsOnTracer, if latency on query operation is greater than this diagnostics will be send to open telemetry exporter as events in tracer span of end to end CRUD api. Default is 500 ms."
|
|
returns:
|
|
description: "thresholdForDiagnosticsOnTracer the latency threshold for diagnostics on tracer."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html\">Duration</a>"
|
|
- uid: "com.azure.cosmos.models.CosmosReadManyRequestOptions.getThroughputControlGroupName()"
|
|
fullName: "com.azure.cosmos.models.CosmosReadManyRequestOptions.getThroughputControlGroupName()"
|
|
name: "getThroughputControlGroupName()"
|
|
nameWithType: "CosmosReadManyRequestOptions.getThroughputControlGroupName()"
|
|
summary: "Get throughput control group name."
|
|
syntax: "public String getThroughputControlGroupName()"
|
|
desc: "Get 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.CosmosReadManyRequestOptions.isIndexMetricsEnabled()"
|
|
fullName: "com.azure.cosmos.models.CosmosReadManyRequestOptions.isIndexMetricsEnabled()"
|
|
name: "isIndexMetricsEnabled()"
|
|
nameWithType: "CosmosReadManyRequestOptions.isIndexMetricsEnabled()"
|
|
summary: "Gets index<wbr>Metrics<wbr>Enabled, which is used to obtain the index metrics to understand how the query engine used existing indexes and could use potential new indexes."
|
|
syntax: "public boolean isIndexMetricsEnabled()"
|
|
desc: "Gets indexMetricsEnabled, which is used to obtain the index metrics to understand how the query engine used existing indexes and could use potential new indexes. The results will be displayed in QueryMetrics. Please note that this options will incurs overhead, so it should be enabled when debuging slow queries."
|
|
returns:
|
|
description: "indexMetricsEnabled (default: false)"
|
|
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.cosmos.models.CosmosReadManyRequestOptions.isQueryMetricsEnabled()"
|
|
fullName: "com.azure.cosmos.models.CosmosReadManyRequestOptions.isQueryMetricsEnabled()"
|
|
name: "isQueryMetricsEnabled()"
|
|
nameWithType: "CosmosReadManyRequestOptions.isQueryMetricsEnabled()"
|
|
summary: "Gets the option to enable populate query metrics."
|
|
syntax: "public boolean isQueryMetricsEnabled()"
|
|
desc: "Gets the option to enable populate query metrics. By default query metrics are enabled."
|
|
returns:
|
|
description: "whether to enable populate query metrics (default: true)"
|
|
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.cosmos.models.CosmosReadManyRequestOptions.setConsistencyLevel(com.azure.cosmos.ConsistencyLevel)"
|
|
fullName: "com.azure.cosmos.models.CosmosReadManyRequestOptions.setConsistencyLevel(ConsistencyLevel consistencyLevel)"
|
|
name: "setConsistencyLevel(ConsistencyLevel consistencyLevel)"
|
|
nameWithType: "CosmosReadManyRequestOptions.setConsistencyLevel(ConsistencyLevel consistencyLevel)"
|
|
summary: "Sets the consistency level required for the request."
|
|
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 CosmosReadManyRequestOptions setConsistencyLevel(ConsistencyLevel consistencyLevel)"
|
|
desc: "Sets the consistency level required for the request. The effective consistency level can only be reduce for read/query requests. So when the Account's default consistency level is for example Session you can specify on a request-by-request level for individual requests that Eventual consistency is sufficient - which could reduce the latency and RU charges for this request but will not guarantee session consistency (read-your-own-write) anymore"
|
|
returns:
|
|
description: "the CosmosReadManyRequestOptions."
|
|
type: "<xref href=\"com.azure.cosmos.models.CosmosReadManyRequestOptions?alt=com.azure.cosmos.models.CosmosReadManyRequestOptions&text=CosmosReadManyRequestOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.cosmos.models.CosmosReadManyRequestOptions.setCosmosEndToEndOperationLatencyPolicyConfig(com.azure.cosmos.CosmosEndToEndOperationLatencyPolicyConfig)"
|
|
fullName: "com.azure.cosmos.models.CosmosReadManyRequestOptions.setCosmosEndToEndOperationLatencyPolicyConfig(CosmosEndToEndOperationLatencyPolicyConfig cosmosEndToEndOperationLatencyPolicyConfig)"
|
|
name: "setCosmosEndToEndOperationLatencyPolicyConfig(CosmosEndToEndOperationLatencyPolicyConfig cosmosEndToEndOperationLatencyPolicyConfig)"
|
|
nameWithType: "CosmosReadManyRequestOptions.setCosmosEndToEndOperationLatencyPolicyConfig(CosmosEndToEndOperationLatencyPolicyConfig cosmosEndToEndOperationLatencyPolicyConfig)"
|
|
summary: "Sets the <xref uid=\"com.azure.cosmos.CosmosEndToEndOperationLatencyPolicyConfig\" data-throw-if-not-resolved=\"false\" data-raw-source=\"CosmosEndToEndOperationLatencyPolicyConfig\"></xref> to be used for the request."
|
|
parameters:
|
|
- description: "the <xref uid=\"com.azure.cosmos.CosmosEndToEndOperationLatencyPolicyConfig\" data-throw-if-not-resolved=\"false\" data-raw-source=\"CosmosEndToEndOperationLatencyPolicyConfig\"></xref>"
|
|
name: "cosmosEndToEndOperationLatencyPolicyConfig"
|
|
type: "<xref href=\"com.azure.cosmos.CosmosEndToEndOperationLatencyPolicyConfig?alt=com.azure.cosmos.CosmosEndToEndOperationLatencyPolicyConfig&text=CosmosEndToEndOperationLatencyPolicyConfig\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public CosmosReadManyRequestOptions setCosmosEndToEndOperationLatencyPolicyConfig(CosmosEndToEndOperationLatencyPolicyConfig cosmosEndToEndOperationLatencyPolicyConfig)"
|
|
desc: "Sets the <xref uid=\"com.azure.cosmos.CosmosEndToEndOperationLatencyPolicyConfig\" data-throw-if-not-resolved=\"false\" data-raw-source=\"CosmosEndToEndOperationLatencyPolicyConfig\"></xref> to be used for the request. If the config is already set \\* on the client, then this will override the client level config for this request"
|
|
returns:
|
|
description: "the CosmosReadManyRequestOptions"
|
|
type: "<xref href=\"com.azure.cosmos.models.CosmosReadManyRequestOptions?alt=com.azure.cosmos.models.CosmosReadManyRequestOptions&text=CosmosReadManyRequestOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.cosmos.models.CosmosReadManyRequestOptions.setCustomItemSerializer(com.azure.cosmos.CosmosItemSerializer)"
|
|
fullName: "com.azure.cosmos.models.CosmosReadManyRequestOptions.setCustomItemSerializer(CosmosItemSerializer customItemSerializer)"
|
|
name: "setCustomItemSerializer(CosmosItemSerializer customItemSerializer)"
|
|
nameWithType: "CosmosReadManyRequestOptions.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 CosmosReadManyRequestOptions 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.CosmosReadManyRequestOptions?alt=com.azure.cosmos.models.CosmosReadManyRequestOptions&text=CosmosReadManyRequestOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.cosmos.models.CosmosReadManyRequestOptions.setDedicatedGatewayRequestOptions(com.azure.cosmos.models.DedicatedGatewayRequestOptions)"
|
|
fullName: "com.azure.cosmos.models.CosmosReadManyRequestOptions.setDedicatedGatewayRequestOptions(DedicatedGatewayRequestOptions dedicatedGatewayRequestOptions)"
|
|
name: "setDedicatedGatewayRequestOptions(DedicatedGatewayRequestOptions dedicatedGatewayRequestOptions)"
|
|
nameWithType: "CosmosReadManyRequestOptions.setDedicatedGatewayRequestOptions(DedicatedGatewayRequestOptions dedicatedGatewayRequestOptions)"
|
|
summary: "Sets the Dedicated Gateway Request Options"
|
|
parameters:
|
|
- description: "Dedicated Gateway Request Options"
|
|
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 CosmosReadManyRequestOptions setDedicatedGatewayRequestOptions(DedicatedGatewayRequestOptions dedicatedGatewayRequestOptions)"
|
|
desc: "Sets the Dedicated Gateway Request Options"
|
|
returns:
|
|
description: "the CosmosReadManyRequestOptions"
|
|
type: "<xref href=\"com.azure.cosmos.models.CosmosReadManyRequestOptions?alt=com.azure.cosmos.models.CosmosReadManyRequestOptions&text=CosmosReadManyRequestOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.cosmos.models.CosmosReadManyRequestOptions.setDiagnosticsThresholds(com.azure.cosmos.CosmosDiagnosticsThresholds)"
|
|
fullName: "com.azure.cosmos.models.CosmosReadManyRequestOptions.setDiagnosticsThresholds(CosmosDiagnosticsThresholds operationSpecificThresholds)"
|
|
name: "setDiagnosticsThresholds(CosmosDiagnosticsThresholds operationSpecificThresholds)"
|
|
nameWithType: "CosmosReadManyRequestOptions.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 CosmosReadManyRequestOptions setDiagnosticsThresholds(CosmosDiagnosticsThresholds operationSpecificThresholds)"
|
|
desc: "Allows overriding the diagnostic thresholds for a specific operation."
|
|
returns:
|
|
description: "the CosmosReadManyRequestOptions."
|
|
type: "<xref href=\"com.azure.cosmos.models.CosmosReadManyRequestOptions?alt=com.azure.cosmos.models.CosmosReadManyRequestOptions&text=CosmosReadManyRequestOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.cosmos.models.CosmosReadManyRequestOptions.setExcludedRegions(java.util.List<java.lang.String>)"
|
|
fullName: "com.azure.cosmos.models.CosmosReadManyRequestOptions.setExcludedRegions(List<String> excludeRegions)"
|
|
name: "setExcludedRegions(List<String> excludeRegions)"
|
|
nameWithType: "CosmosReadManyRequestOptions.setExcludedRegions(List<String> excludeRegions)"
|
|
summary: "List of regions to be excluded for the request/retries."
|
|
parameters:
|
|
- description: "the regions to exclude"
|
|
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 CosmosReadManyRequestOptions setExcludedRegions(List<String> excludeRegions)"
|
|
desc: "List of regions to be excluded 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.CosmosReadManyRequestOptions\" data-throw-if-not-resolved=\"false\" data-raw-source=\"CosmosReadManyRequestOptions\"></xref>"
|
|
type: "<xref href=\"com.azure.cosmos.models.CosmosReadManyRequestOptions?alt=com.azure.cosmos.models.CosmosReadManyRequestOptions&text=CosmosReadManyRequestOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.cosmos.models.CosmosReadManyRequestOptions.setIndexMetricsEnabled(boolean)"
|
|
fullName: "com.azure.cosmos.models.CosmosReadManyRequestOptions.setIndexMetricsEnabled(boolean indexMetricsEnabled)"
|
|
name: "setIndexMetricsEnabled(boolean indexMetricsEnabled)"
|
|
nameWithType: "CosmosReadManyRequestOptions.setIndexMetricsEnabled(boolean indexMetricsEnabled)"
|
|
summary: "Sets index<wbr>Metrics<wbr>Enabled, which is used to obtain the index metrics to understand how the query engine used existing indexes and could use potential new indexes."
|
|
parameters:
|
|
- description: "a boolean used to obtain the index metrics"
|
|
name: "indexMetricsEnabled"
|
|
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public CosmosReadManyRequestOptions setIndexMetricsEnabled(boolean indexMetricsEnabled)"
|
|
desc: "Sets indexMetricsEnabled, which is used to obtain the index metrics to understand how the query engine used existing indexes and could use potential new indexes. The results will be displayed in QueryMetrics. Please note that this options will incurs overhead, so it should be enabled when debugging slow queries. By default the indexMetrics are disabled."
|
|
returns:
|
|
description: "indexMetricsEnabled"
|
|
type: "<xref href=\"com.azure.cosmos.models.CosmosReadManyRequestOptions?alt=com.azure.cosmos.models.CosmosReadManyRequestOptions&text=CosmosReadManyRequestOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.cosmos.models.CosmosReadManyRequestOptions.setKeywordIdentifiers(java.util.Set<java.lang.String>)"
|
|
fullName: "com.azure.cosmos.models.CosmosReadManyRequestOptions.setKeywordIdentifiers(Set<String> keywordIdentifiers)"
|
|
name: "setKeywordIdentifiers(Set<String> keywordIdentifiers)"
|
|
nameWithType: "CosmosReadManyRequestOptions.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><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>>"
|
|
syntax: "public CosmosReadManyRequestOptions setKeywordIdentifiers(Set<String> keywordIdentifiers)"
|
|
desc: "Sets the custom ids."
|
|
returns:
|
|
description: "the current request options."
|
|
type: "<xref href=\"com.azure.cosmos.models.CosmosReadManyRequestOptions?alt=com.azure.cosmos.models.CosmosReadManyRequestOptions&text=CosmosReadManyRequestOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.cosmos.models.CosmosReadManyRequestOptions.setQueryMetricsEnabled(boolean)"
|
|
fullName: "com.azure.cosmos.models.CosmosReadManyRequestOptions.setQueryMetricsEnabled(boolean queryMetricsEnabled)"
|
|
name: "setQueryMetricsEnabled(boolean queryMetricsEnabled)"
|
|
nameWithType: "CosmosReadManyRequestOptions.setQueryMetricsEnabled(boolean queryMetricsEnabled)"
|
|
summary: "Sets the option to enable/disable getting metrics relating to query execution on item query requests."
|
|
parameters:
|
|
- description: "whether to enable or disable query metrics"
|
|
name: "queryMetricsEnabled"
|
|
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public CosmosReadManyRequestOptions setQueryMetricsEnabled(boolean queryMetricsEnabled)"
|
|
desc: "Sets the option to enable/disable getting metrics relating to query execution on item query requests. By default query metrics are enabled."
|
|
returns:
|
|
description: "the CosmosReadManyRequestOptions."
|
|
type: "<xref href=\"com.azure.cosmos.models.CosmosReadManyRequestOptions?alt=com.azure.cosmos.models.CosmosReadManyRequestOptions&text=CosmosReadManyRequestOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.cosmos.models.CosmosReadManyRequestOptions.setResponseContinuationTokenLimitInKb(int)"
|
|
fullName: "com.azure.cosmos.models.CosmosReadManyRequestOptions.setResponseContinuationTokenLimitInKb(int limitInKb)"
|
|
name: "setResponseContinuationTokenLimitInKb(int limitInKb)"
|
|
nameWithType: "CosmosReadManyRequestOptions.setResponseContinuationTokenLimitInKb(int limitInKb)"
|
|
summary: "Sets the Response<wbr>Continuation<wbr>Token<wbr>Limit<wbr>InKb request option for item query requests in the Azure Cosmos DB service."
|
|
parameters:
|
|
- description: "continuation token size limit."
|
|
name: "limitInKb"
|
|
type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public CosmosReadManyRequestOptions setResponseContinuationTokenLimitInKb(int limitInKb)"
|
|
desc: "Sets the ResponseContinuationTokenLimitInKb request option for item query requests in the Azure Cosmos DB service.\n\nResponseContinuationTokenLimitInKb is used to limit the length of continuation token in the query response. Valid values are >= 1.\n\nThe continuation token contains both required and optional fields. The required fields are necessary for resuming the execution from where it was stooped. The optional fields may contain serialized index lookup work that was done but not yet utilized. This avoids redoing the work again in subsequent continuations and hence improve the query performance. Setting the maximum continuation size to 1KB, the Azure Cosmos DB service will only serialize required fields. Starting from 2KB, the Azure Cosmos DB service would serialize as much as it could fit till it reaches the maximum specified size."
|
|
returns:
|
|
description: "the CosmosReadManyRequestOptions."
|
|
type: "<xref href=\"com.azure.cosmos.models.CosmosReadManyRequestOptions?alt=com.azure.cosmos.models.CosmosReadManyRequestOptions&text=CosmosReadManyRequestOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.cosmos.models.CosmosReadManyRequestOptions.setSessionToken(java.lang.String)"
|
|
fullName: "com.azure.cosmos.models.CosmosReadManyRequestOptions.setSessionToken(String sessionToken)"
|
|
name: "setSessionToken(String sessionToken)"
|
|
nameWithType: "CosmosReadManyRequestOptions.setSessionToken(String sessionToken)"
|
|
summary: "Sets the session 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 CosmosReadManyRequestOptions setSessionToken(String sessionToken)"
|
|
desc: "Sets the session token for use with session consistency."
|
|
returns:
|
|
description: "the CosmosReadManyRequestOptions."
|
|
type: "<xref href=\"com.azure.cosmos.models.CosmosReadManyRequestOptions?alt=com.azure.cosmos.models.CosmosReadManyRequestOptions&text=CosmosReadManyRequestOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.cosmos.models.CosmosReadManyRequestOptions.setThresholdForDiagnosticsOnTracer(java.time.Duration)"
|
|
fullName: "com.azure.cosmos.models.CosmosReadManyRequestOptions.setThresholdForDiagnosticsOnTracer(Duration thresholdForDiagnosticsOnTracer)"
|
|
name: "setThresholdForDiagnosticsOnTracer(Duration thresholdForDiagnosticsOnTracer)"
|
|
nameWithType: "CosmosReadManyRequestOptions.setThresholdForDiagnosticsOnTracer(Duration thresholdForDiagnosticsOnTracer)"
|
|
summary: "Sets the threshold<wbr>For<wbr>Diagnostics<wbr>OnTracer, if latency on query operation is greater than this diagnostics will be send to open telemetry exporter as events in tracer span of end to end CRUD api."
|
|
parameters:
|
|
- description: "the latency threshold for diagnostics on tracer."
|
|
name: "thresholdForDiagnosticsOnTracer"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html\">Duration</a>"
|
|
syntax: "public CosmosReadManyRequestOptions setThresholdForDiagnosticsOnTracer(Duration thresholdForDiagnosticsOnTracer)"
|
|
desc: "Sets the thresholdForDiagnosticsOnTracer, if latency on query operation is greater than this diagnostics will be send to open telemetry exporter as events in tracer span of end to end CRUD api. Default is 500 ms"
|
|
returns:
|
|
description: "the CosmosReadManyRequestOptions"
|
|
type: "<xref href=\"com.azure.cosmos.models.CosmosReadManyRequestOptions?alt=com.azure.cosmos.models.CosmosReadManyRequestOptions&text=CosmosReadManyRequestOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.cosmos.models.CosmosReadManyRequestOptions.setThroughputControlGroupName(java.lang.String)"
|
|
fullName: "com.azure.cosmos.models.CosmosReadManyRequestOptions.setThroughputControlGroupName(String throughputControlGroupName)"
|
|
name: "setThroughputControlGroupName(String throughputControlGroupName)"
|
|
nameWithType: "CosmosReadManyRequestOptions.setThroughputControlGroupName(String throughputControlGroupName)"
|
|
summary: "Set 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 CosmosReadManyRequestOptions setThroughputControlGroupName(String throughputControlGroupName)"
|
|
desc: "Set the throughput control group name."
|
|
returns:
|
|
description: "A <xref uid=\"com.azure.cosmos.models.CosmosReadManyRequestOptions\" data-throw-if-not-resolved=\"false\" data-raw-source=\"CosmosReadManyRequestOptions\"></xref>."
|
|
type: "<xref href=\"com.azure.cosmos.models.CosmosReadManyRequestOptions?alt=com.azure.cosmos.models.CosmosReadManyRequestOptions&text=CosmosReadManyRequestOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
type: "class"
|
|
desc: "Specifies the options associated with read many operation in the Azure Cosmos DB database service."
|
|
metadata: {}
|
|
package: "com.azure.cosmos.models"
|
|
artifact: com.azure:azure-cosmos:4.63.4
|