265 строки
14 KiB
YAML
265 строки
14 KiB
YAML
### YamlMime:JavaType
|
|
constructors:
|
|
- fullName: com.microsoft.azure.cosmosdb.FeedOptions.FeedOptions()
|
|
name: FeedOptions()
|
|
nameWithType: FeedOptions.FeedOptions()
|
|
syntax: public FeedOptions()
|
|
uid: com.microsoft.azure.cosmosdb.FeedOptions.FeedOptions()
|
|
- fullName: com.microsoft.azure.cosmosdb.FeedOptions.FeedOptions(FeedOptions options)
|
|
name: FeedOptions(FeedOptions options)
|
|
nameWithType: FeedOptions.FeedOptions(FeedOptions options)
|
|
parameters:
|
|
- name: options
|
|
type: <xref href="com.microsoft.azure.cosmosdb.FeedOptions?alt=com.microsoft.azure.cosmosdb.FeedOptions&text=FeedOptions" data-throw-if-not-resolved="False"/>
|
|
syntax: public FeedOptions(FeedOptions options)
|
|
uid: com.microsoft.azure.cosmosdb.FeedOptions.FeedOptions(FeedOptions)
|
|
inheritances:
|
|
- <xref href="java.lang.Object" data-throw-if-not-resolved="False"/>
|
|
- <xref href="com.microsoft.azure.cosmosdb.FeedOptionsBase?alt=com.microsoft.azure.cosmosdb.FeedOptionsBase&text=FeedOptionsBase" data-throw-if-not-resolved="False"/>
|
|
inheritedMembers:
|
|
- com.microsoft.azure.cosmosdb.FeedOptionsBase.FeedOptionsBase()
|
|
- com.microsoft.azure.cosmosdb.FeedOptionsBase.getMaxItemCount()
|
|
- com.microsoft.azure.cosmosdb.FeedOptionsBase.getPartitionKey()
|
|
- com.microsoft.azure.cosmosdb.FeedOptionsBase.getPopulateQueryMetrics()
|
|
- com.microsoft.azure.cosmosdb.FeedOptionsBase.getProperties()
|
|
- com.microsoft.azure.cosmosdb.FeedOptionsBase.getRequestContinuation()
|
|
- com.microsoft.azure.cosmosdb.FeedOptionsBase.setMaxItemCount(Integer)
|
|
- com.microsoft.azure.cosmosdb.FeedOptionsBase.setPartitionKey(PartitionKey)
|
|
- com.microsoft.azure.cosmosdb.FeedOptionsBase.setPopulateQueryMetrics(boolean)
|
|
- com.microsoft.azure.cosmosdb.FeedOptionsBase.setProperties(Map<String, Object>)
|
|
- com.microsoft.azure.cosmosdb.FeedOptionsBase.setRequestContinuation(String)
|
|
methods:
|
|
- fullName: com.microsoft.azure.cosmosdb.FeedOptions.getAllowEmptyPages()
|
|
name: getAllowEmptyPages()
|
|
nameWithType: FeedOptions.getAllowEmptyPages()
|
|
returns:
|
|
type: <xref href="boolean?alt=boolean&text=boolean" data-throw-if-not-resolved="False"/>
|
|
summary: <p>Gets the option to allow empty result pages in feed response. </p>
|
|
syntax: public boolean getAllowEmptyPages()
|
|
uid: com.microsoft.azure.cosmosdb.FeedOptions.getAllowEmptyPages()
|
|
- fullName: com.microsoft.azure.cosmosdb.FeedOptions.getEmitVerboseTracesInQuery()
|
|
name: getEmitVerboseTracesInQuery()
|
|
nameWithType: FeedOptions.getEmitVerboseTracesInQuery()
|
|
returns:
|
|
description: <p>the emit verbose traces in query. </p>
|
|
type: <xref href="Boolean?alt=Boolean&text=Boolean" data-throw-if-not-resolved="False"/>
|
|
summary: >-
|
|
<p>Gets the option to allow queries to emit out verbose traces for investigation.</p>
|
|
|
|
<p></p>
|
|
syntax: public Boolean getEmitVerboseTracesInQuery()
|
|
uid: com.microsoft.azure.cosmosdb.FeedOptions.getEmitVerboseTracesInQuery()
|
|
- fullName: com.microsoft.azure.cosmosdb.FeedOptions.getEnableCrossPartitionQuery()
|
|
name: getEnableCrossPartitionQuery()
|
|
nameWithType: FeedOptions.getEnableCrossPartitionQuery()
|
|
returns:
|
|
description: <p>whether to allow queries to run across all partitions of the collection. </p>
|
|
type: <xref href="Boolean?alt=Boolean&text=Boolean" data-throw-if-not-resolved="False"/>
|
|
summary: >-
|
|
<p>Gets the option to allow queries to run across all partitions of the collection.</p>
|
|
|
|
<p></p>
|
|
syntax: public Boolean getEnableCrossPartitionQuery()
|
|
uid: com.microsoft.azure.cosmosdb.FeedOptions.getEnableCrossPartitionQuery()
|
|
- fullName: com.microsoft.azure.cosmosdb.FeedOptions.getEnableScanInQuery()
|
|
name: getEnableScanInQuery()
|
|
nameWithType: FeedOptions.getEnableScanInQuery()
|
|
returns:
|
|
description: <p>the option of enable scan in query. </p>
|
|
type: <xref href="Boolean?alt=Boolean&text=Boolean" data-throw-if-not-resolved="False"/>
|
|
summary: >-
|
|
<p>Gets the option to allow scan on the queries which couldn't be served as indexing was opted out on the requested paths.</p>
|
|
|
|
<p></p>
|
|
syntax: public Boolean getEnableScanInQuery()
|
|
uid: com.microsoft.azure.cosmosdb.FeedOptions.getEnableScanInQuery()
|
|
- fullName: com.microsoft.azure.cosmosdb.FeedOptions.getMaxBufferedItemCount()
|
|
name: getMaxBufferedItemCount()
|
|
nameWithType: FeedOptions.getMaxBufferedItemCount()
|
|
returns:
|
|
description: <p>maximum number of items that can be buffered client side during parallel query execution. </p>
|
|
type: <xref href="int?alt=int&text=int" data-throw-if-not-resolved="False"/>
|
|
summary: >-
|
|
<p>Gets the maximum number of items that can be buffered client side during parallel query execution.</p>
|
|
|
|
<p></p>
|
|
syntax: public int getMaxBufferedItemCount()
|
|
uid: com.microsoft.azure.cosmosdb.FeedOptions.getMaxBufferedItemCount()
|
|
- fullName: com.microsoft.azure.cosmosdb.FeedOptions.getMaxDegreeOfParallelism()
|
|
name: getMaxDegreeOfParallelism()
|
|
nameWithType: FeedOptions.getMaxDegreeOfParallelism()
|
|
returns:
|
|
description: <p>number of concurrent operations run client side during parallel query execution. </p>
|
|
type: <xref href="int?alt=int&text=int" data-throw-if-not-resolved="False"/>
|
|
summary: >-
|
|
<p>Gets the number of concurrent operations run client side during parallel query execution.</p>
|
|
|
|
<p></p>
|
|
syntax: public int getMaxDegreeOfParallelism()
|
|
uid: com.microsoft.azure.cosmosdb.FeedOptions.getMaxDegreeOfParallelism()
|
|
- fullName: com.microsoft.azure.cosmosdb.FeedOptions.getPartitionKeyRangeIdInternal()
|
|
name: getPartitionKeyRangeIdInternal()
|
|
nameWithType: FeedOptions.getPartitionKeyRangeIdInternal()
|
|
returns:
|
|
description: <p>the partitionKeyRangeId. </p>
|
|
type: <xref href="String?alt=String&text=String" data-throw-if-not-resolved="False"/>
|
|
summary: >-
|
|
<p>Gets the partitionKeyRangeId.</p>
|
|
|
|
<p></p>
|
|
syntax: public String getPartitionKeyRangeIdInternal()
|
|
uid: com.microsoft.azure.cosmosdb.FeedOptions.getPartitionKeyRangeIdInternal()
|
|
- fullName: com.microsoft.azure.cosmosdb.FeedOptions.getResponseContinuationTokenLimitInKb()
|
|
name: getResponseContinuationTokenLimitInKb()
|
|
nameWithType: FeedOptions.getResponseContinuationTokenLimitInKb()
|
|
returns:
|
|
description: <p>return set ResponseContinuationTokenLimitInKb, or 0 if not set </p>
|
|
type: <xref href="int?alt=int&text=int" data-throw-if-not-resolved="False"/>
|
|
summary: >-
|
|
<p>Gets the ResponseContinuationTokenLimitInKb request option for document query requests in the Azure Cosmos DB service. If not already set returns 0.</p>
|
|
|
|
<p>ResponseContinuationTokenLimitInKb is used to limit the length of continuation token in the query response. Valid values are>= 1.</p>
|
|
|
|
<p></p>
|
|
syntax: public int getResponseContinuationTokenLimitInKb()
|
|
uid: com.microsoft.azure.cosmosdb.FeedOptions.getResponseContinuationTokenLimitInKb()
|
|
- fullName: com.microsoft.azure.cosmosdb.FeedOptions.getSessionToken()
|
|
name: getSessionToken()
|
|
nameWithType: FeedOptions.getSessionToken()
|
|
returns:
|
|
description: <p>the session token. </p>
|
|
type: <xref href="String?alt=String&text=String" data-throw-if-not-resolved="False"/>
|
|
summary: >-
|
|
<p>Gets the session token for use with session consistency.</p>
|
|
|
|
<p></p>
|
|
syntax: public String getSessionToken()
|
|
uid: com.microsoft.azure.cosmosdb.FeedOptions.getSessionToken()
|
|
- fullName: com.microsoft.azure.cosmosdb.FeedOptions.setAllowEmptyPages(boolean allowEmptyPages)
|
|
name: setAllowEmptyPages(boolean allowEmptyPages)
|
|
nameWithType: FeedOptions.setAllowEmptyPages(boolean allowEmptyPages)
|
|
parameters:
|
|
- description: <p>whether to allow empty pages in feed response </p>
|
|
name: allowEmptyPages
|
|
type: <xref href="boolean?alt=boolean&text=boolean" data-throw-if-not-resolved="False"/>
|
|
summary: <p>Sets the option to allow empty result pages in feed response. Defaults to false </p>
|
|
syntax: public void setAllowEmptyPages(boolean allowEmptyPages)
|
|
uid: com.microsoft.azure.cosmosdb.FeedOptions.setAllowEmptyPages(boolean)
|
|
- fullName: com.microsoft.azure.cosmosdb.FeedOptions.setEmitVerboseTracesInQuery(Boolean emitVerboseTracesInQuery)
|
|
name: setEmitVerboseTracesInQuery(Boolean emitVerboseTracesInQuery)
|
|
nameWithType: FeedOptions.setEmitVerboseTracesInQuery(Boolean emitVerboseTracesInQuery)
|
|
parameters:
|
|
- description: <p>the emit verbose traces in query. </p>
|
|
name: emitVerboseTracesInQuery
|
|
type: <xref href="Boolean?alt=Boolean&text=Boolean" data-throw-if-not-resolved="False"/>
|
|
summary: >-
|
|
<p>Sets the option to allow queries to emit out verbose traces for investigation.</p>
|
|
|
|
<p></p>
|
|
syntax: public void setEmitVerboseTracesInQuery(Boolean emitVerboseTracesInQuery)
|
|
uid: com.microsoft.azure.cosmosdb.FeedOptions.setEmitVerboseTracesInQuery(Boolean)
|
|
- fullName: com.microsoft.azure.cosmosdb.FeedOptions.setEnableCrossPartitionQuery(Boolean enableCrossPartitionQuery)
|
|
name: setEnableCrossPartitionQuery(Boolean enableCrossPartitionQuery)
|
|
nameWithType: FeedOptions.setEnableCrossPartitionQuery(Boolean enableCrossPartitionQuery)
|
|
parameters:
|
|
- description: <p>whether to allow queries to run across all partitions of the collection. </p>
|
|
name: enableCrossPartitionQuery
|
|
type: <xref href="Boolean?alt=Boolean&text=Boolean" data-throw-if-not-resolved="False"/>
|
|
summary: >-
|
|
<p>Sets the option to allow queries to run across all partitions of the collection.</p>
|
|
|
|
<p></p>
|
|
syntax: public void setEnableCrossPartitionQuery(Boolean enableCrossPartitionQuery)
|
|
uid: com.microsoft.azure.cosmosdb.FeedOptions.setEnableCrossPartitionQuery(Boolean)
|
|
- fullName: com.microsoft.azure.cosmosdb.FeedOptions.setEnableScanInQuery(Boolean enableScanInQuery)
|
|
name: setEnableScanInQuery(Boolean enableScanInQuery)
|
|
nameWithType: FeedOptions.setEnableScanInQuery(Boolean enableScanInQuery)
|
|
parameters:
|
|
- description: <p>the option of enable scan in query. </p>
|
|
name: enableScanInQuery
|
|
type: <xref href="Boolean?alt=Boolean&text=Boolean" data-throw-if-not-resolved="False"/>
|
|
summary: >-
|
|
<p>Sets the option to allow scan on the queries which couldn't be served as indexing was opted out on the requested paths.</p>
|
|
|
|
<p></p>
|
|
syntax: public void setEnableScanInQuery(Boolean enableScanInQuery)
|
|
uid: com.microsoft.azure.cosmosdb.FeedOptions.setEnableScanInQuery(Boolean)
|
|
- fullName: com.microsoft.azure.cosmosdb.FeedOptions.setMaxBufferedItemCount(int maxBufferedItemCount)
|
|
name: setMaxBufferedItemCount(int maxBufferedItemCount)
|
|
nameWithType: FeedOptions.setMaxBufferedItemCount(int maxBufferedItemCount)
|
|
parameters:
|
|
- description: <p>maximum number of items. </p>
|
|
name: maxBufferedItemCount
|
|
type: <xref href="int?alt=int&text=int" data-throw-if-not-resolved="False"/>
|
|
summary: >-
|
|
<p>Sets the maximum number of items that can be buffered client side during parallel query execution.</p>
|
|
|
|
<p></p>
|
|
syntax: public void setMaxBufferedItemCount(int maxBufferedItemCount)
|
|
uid: com.microsoft.azure.cosmosdb.FeedOptions.setMaxBufferedItemCount(int)
|
|
- fullName: com.microsoft.azure.cosmosdb.FeedOptions.setMaxDegreeOfParallelism(int maxDegreeOfParallelism)
|
|
name: setMaxDegreeOfParallelism(int maxDegreeOfParallelism)
|
|
nameWithType: FeedOptions.setMaxDegreeOfParallelism(int maxDegreeOfParallelism)
|
|
parameters:
|
|
- description: <p>number of concurrent operations. </p>
|
|
name: maxDegreeOfParallelism
|
|
type: <xref href="int?alt=int&text=int" data-throw-if-not-resolved="False"/>
|
|
summary: >-
|
|
<p>Sets the number of concurrent operations run client side during parallel query execution.</p>
|
|
|
|
<p></p>
|
|
syntax: public void setMaxDegreeOfParallelism(int maxDegreeOfParallelism)
|
|
uid: com.microsoft.azure.cosmosdb.FeedOptions.setMaxDegreeOfParallelism(int)
|
|
- fullName: com.microsoft.azure.cosmosdb.FeedOptions.setPartitionKeyRangeIdInternal(String partitionKeyRangeId)
|
|
name: setPartitionKeyRangeIdInternal(String partitionKeyRangeId)
|
|
nameWithType: FeedOptions.setPartitionKeyRangeIdInternal(String partitionKeyRangeId)
|
|
parameters:
|
|
- description: <p>the partitionKeyRangeId. </p>
|
|
name: partitionKeyRangeId
|
|
type: <xref href="String?alt=String&text=String" data-throw-if-not-resolved="False"/>
|
|
summary: >-
|
|
<p>Sets the partitionKeyRangeId.</p>
|
|
|
|
<p></p>
|
|
syntax: public void setPartitionKeyRangeIdInternal(String partitionKeyRangeId)
|
|
uid: com.microsoft.azure.cosmosdb.FeedOptions.setPartitionKeyRangeIdInternal(String)
|
|
- fullName: com.microsoft.azure.cosmosdb.FeedOptions.setResponseContinuationTokenLimitInKb(int limitInKb)
|
|
name: setResponseContinuationTokenLimitInKb(int limitInKb)
|
|
nameWithType: FeedOptions.setResponseContinuationTokenLimitInKb(int limitInKb)
|
|
parameters:
|
|
- description: <p>continuation token size limit. </p>
|
|
name: limitInKb
|
|
type: <xref href="int?alt=int&text=int" data-throw-if-not-resolved="False"/>
|
|
summary: >-
|
|
<p>Sets the ResponseContinuationTokenLimitInKb request option for document query requests in the Azure Cosmos DB service.</p>
|
|
|
|
<p>ResponseContinuationTokenLimitInKb is used to limit the length of continuation token in the query response. Valid values are>= 1.</p>
|
|
|
|
<p>The 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.</p>
|
|
|
|
<p></p>
|
|
syntax: public void setResponseContinuationTokenLimitInKb(int limitInKb)
|
|
uid: com.microsoft.azure.cosmosdb.FeedOptions.setResponseContinuationTokenLimitInKb(int)
|
|
- fullName: com.microsoft.azure.cosmosdb.FeedOptions.setSessionToken(String sessionToken)
|
|
name: setSessionToken(String sessionToken)
|
|
nameWithType: FeedOptions.setSessionToken(String sessionToken)
|
|
parameters:
|
|
- description: <p>the session token. </p>
|
|
name: sessionToken
|
|
type: <xref href="String?alt=String&text=String" data-throw-if-not-resolved="False"/>
|
|
summary: >-
|
|
<p>Sets the session token for use with session consistency.</p>
|
|
|
|
<p></p>
|
|
syntax: public void setSessionToken(String sessionToken)
|
|
uid: com.microsoft.azure.cosmosdb.FeedOptions.setSessionToken(String)
|
|
nameWithType: FeedOptions
|
|
syntax: public class FeedOptions extends FeedOptionsBase
|
|
type: class
|
|
uid: com.microsoft.azure.cosmosdb.FeedOptions
|
|
fullName: com.microsoft.azure.cosmosdb.FeedOptions
|
|
name: FeedOptions
|
|
package: com.microsoft.azure.cosmosdb
|
|
summary: <p>Specifies the options associated with feed methods (enumeration operations) in the Azure Cosmos DB database service. </p>
|
|
metadata: {}
|