875 строки
37 KiB
YAML
875 строки
37 KiB
YAML
### YamlMime:ManagedReference
|
|
items:
|
|
- uid: com.microsoft.azure.cosmosdb._request_options
|
|
id: _request_options
|
|
parent: com.microsoft.azure.cosmosdb
|
|
children:
|
|
- com.microsoft.azure.cosmosdb._request_options.getAccessCondition()
|
|
- com.microsoft.azure.cosmosdb._request_options.getConsistencyLevel()
|
|
- com.microsoft.azure.cosmosdb._request_options.getIndexingDirective()
|
|
- com.microsoft.azure.cosmosdb._request_options.getOfferThroughput()
|
|
- com.microsoft.azure.cosmosdb._request_options.getOfferType()
|
|
- com.microsoft.azure.cosmosdb._request_options.getPartitionKey()
|
|
- com.microsoft.azure.cosmosdb._request_options.getPostTriggerInclude()
|
|
- com.microsoft.azure.cosmosdb._request_options.getPreTriggerInclude()
|
|
- com.microsoft.azure.cosmosdb._request_options.getResourceTokenExpirySeconds()
|
|
- com.microsoft.azure.cosmosdb._request_options.getSessionToken()
|
|
- com.microsoft.azure.cosmosdb._request_options.isPopulateQuotaInfo()
|
|
- com.microsoft.azure.cosmosdb._request_options.isScriptLoggingEnabled()
|
|
- com.microsoft.azure.cosmosdb._request_options.setAccessCondition(AccessCondition)
|
|
- com.microsoft.azure.cosmosdb._request_options.setConsistencyLevel(ConsistencyLevel)
|
|
- com.microsoft.azure.cosmosdb._request_options.setIndexingDirective(IndexingDirective)
|
|
- com.microsoft.azure.cosmosdb._request_options.setOfferThroughput(Integer)
|
|
- com.microsoft.azure.cosmosdb._request_options.setOfferType(String)
|
|
- com.microsoft.azure.cosmosdb._request_options.setPartitionKey(PartitionKey)
|
|
- com.microsoft.azure.cosmosdb._request_options.setPartitionKeyRengeId(String)
|
|
- com.microsoft.azure.cosmosdb._request_options.setPopulateQuotaInfo(boolean)
|
|
- com.microsoft.azure.cosmosdb._request_options.setPostTriggerInclude(List<String>)
|
|
- com.microsoft.azure.cosmosdb._request_options.setPreTriggerInclude(List<String>)
|
|
- com.microsoft.azure.cosmosdb._request_options.setResourceTokenExpirySeconds(Integer)
|
|
- com.microsoft.azure.cosmosdb._request_options.setScriptLoggingEnabled(boolean)
|
|
- com.microsoft.azure.cosmosdb._request_options.setSessionToken(String)
|
|
href: com.microsoft.azure.cosmosdb._request_options.yml
|
|
langs:
|
|
- java
|
|
name: RequestOptions
|
|
nameWithType: RequestOptions
|
|
fullName: com.microsoft.azure.cosmosdb.RequestOptions
|
|
type: Class
|
|
source:
|
|
remote: &o0
|
|
path: sdk/src/main/java/com/microsoft/azure/cosmosdb/RequestOptions.java
|
|
branch: master
|
|
repo: https://github.com/Azure/azure-cosmosdb-java
|
|
path: sdk/src/main/java/com/microsoft/azure/cosmosdb/RequestOptions.java
|
|
startLine: 30
|
|
package: com.microsoft.azure.cosmosdb
|
|
summary: <p>Encapsulates options that can be specified for a request issued to the Azure Cosmos DB database service. </p>
|
|
syntax:
|
|
content: public class RequestOptions
|
|
inheritance:
|
|
- java.lang.Object
|
|
- uid: com.microsoft.azure.cosmosdb._request_options.getAccessCondition()
|
|
id: getAccessCondition()
|
|
parent: com.microsoft.azure.cosmosdb._request_options
|
|
href: com.microsoft.azure.cosmosdb._request_options.yml
|
|
langs:
|
|
- java
|
|
name: getAccessCondition()
|
|
nameWithType: RequestOptions.getAccessCondition()
|
|
fullName: com.microsoft.azure.cosmosdb.RequestOptions.getAccessCondition()
|
|
overload: com.microsoft.azure.cosmosdb._request_options.getAccessCondition*
|
|
type: Method
|
|
source:
|
|
remote: *o0
|
|
path: sdk/src/main/java/com/microsoft/azure/cosmosdb/RequestOptions.java
|
|
startLine: 86
|
|
package: com.microsoft.azure.cosmosdb
|
|
summary: >-
|
|
<p>Gets the conditions associated with the request.</p>
|
|
|
|
<p></p>
|
|
syntax:
|
|
content: public AccessCondition getAccessCondition()
|
|
return:
|
|
type: com.microsoft.azure.cosmosdb._access_condition
|
|
description: <p>the access condition. </p>
|
|
- uid: com.microsoft.azure.cosmosdb._request_options.getConsistencyLevel()
|
|
id: getConsistencyLevel()
|
|
parent: com.microsoft.azure.cosmosdb._request_options
|
|
href: com.microsoft.azure.cosmosdb._request_options.yml
|
|
langs:
|
|
- java
|
|
name: getConsistencyLevel()
|
|
nameWithType: RequestOptions.getConsistencyLevel()
|
|
fullName: com.microsoft.azure.cosmosdb.RequestOptions.getConsistencyLevel()
|
|
overload: com.microsoft.azure.cosmosdb._request_options.getConsistencyLevel*
|
|
type: Method
|
|
source:
|
|
remote: *o0
|
|
path: sdk/src/main/java/com/microsoft/azure/cosmosdb/RequestOptions.java
|
|
startLine: 122
|
|
package: com.microsoft.azure.cosmosdb
|
|
summary: >-
|
|
<p>Gets the consistency level required for the request.</p>
|
|
|
|
<p></p>
|
|
syntax:
|
|
content: public ConsistencyLevel getConsistencyLevel()
|
|
return:
|
|
type: com.microsoft.azure.cosmosdb._consistency_level
|
|
description: <p>the consistency level. </p>
|
|
- uid: com.microsoft.azure.cosmosdb._request_options.getIndexingDirective()
|
|
id: getIndexingDirective()
|
|
parent: com.microsoft.azure.cosmosdb._request_options
|
|
href: com.microsoft.azure.cosmosdb._request_options.yml
|
|
langs:
|
|
- java
|
|
name: getIndexingDirective()
|
|
nameWithType: RequestOptions.getIndexingDirective()
|
|
fullName: com.microsoft.azure.cosmosdb.RequestOptions.getIndexingDirective()
|
|
overload: com.microsoft.azure.cosmosdb._request_options.getIndexingDirective*
|
|
type: Method
|
|
source:
|
|
remote: *o0
|
|
path: sdk/src/main/java/com/microsoft/azure/cosmosdb/RequestOptions.java
|
|
startLine: 104
|
|
package: com.microsoft.azure.cosmosdb
|
|
summary: >-
|
|
<p>Gets the indexing directive (index, do not index etc).</p>
|
|
|
|
<p></p>
|
|
syntax:
|
|
content: public IndexingDirective getIndexingDirective()
|
|
return:
|
|
type: com.microsoft.azure.cosmosdb._indexing_directive
|
|
description: <p>the indexing directive. </p>
|
|
- uid: com.microsoft.azure.cosmosdb._request_options.getOfferThroughput()
|
|
id: getOfferThroughput()
|
|
parent: com.microsoft.azure.cosmosdb._request_options
|
|
href: com.microsoft.azure.cosmosdb._request_options.yml
|
|
langs:
|
|
- java
|
|
name: getOfferThroughput()
|
|
nameWithType: RequestOptions.getOfferThroughput()
|
|
fullName: com.microsoft.azure.cosmosdb.RequestOptions.getOfferThroughput()
|
|
overload: com.microsoft.azure.cosmosdb._request_options.getOfferThroughput*
|
|
type: Method
|
|
source:
|
|
remote: *o0
|
|
path: sdk/src/main/java/com/microsoft/azure/cosmosdb/RequestOptions.java
|
|
startLine: 194
|
|
package: com.microsoft.azure.cosmosdb
|
|
summary: >-
|
|
<p>Gets the throughput in the form of Request Units per second when creating a document collection.</p>
|
|
|
|
<p></p>
|
|
syntax:
|
|
content: public Integer getOfferThroughput()
|
|
return:
|
|
type: 08effaa0
|
|
description: <p>the throughput value. </p>
|
|
- uid: com.microsoft.azure.cosmosdb._request_options.getOfferType()
|
|
id: getOfferType()
|
|
parent: com.microsoft.azure.cosmosdb._request_options
|
|
href: com.microsoft.azure.cosmosdb._request_options.yml
|
|
langs:
|
|
- java
|
|
name: getOfferType()
|
|
nameWithType: RequestOptions.getOfferType()
|
|
fullName: com.microsoft.azure.cosmosdb.RequestOptions.getOfferType()
|
|
overload: com.microsoft.azure.cosmosdb._request_options.getOfferType*
|
|
type: Method
|
|
source:
|
|
remote: *o0
|
|
path: sdk/src/main/java/com/microsoft/azure/cosmosdb/RequestOptions.java
|
|
startLine: 176
|
|
package: com.microsoft.azure.cosmosdb
|
|
summary: >-
|
|
<p>Gets the offer type when creating a document collection.</p>
|
|
|
|
<p></p>
|
|
syntax:
|
|
content: public String getOfferType()
|
|
return:
|
|
type: "26831127"
|
|
description: <p>the offer type. </p>
|
|
- uid: com.microsoft.azure.cosmosdb._request_options.getPartitionKey()
|
|
id: getPartitionKey()
|
|
parent: com.microsoft.azure.cosmosdb._request_options
|
|
href: com.microsoft.azure.cosmosdb._request_options.yml
|
|
langs:
|
|
- java
|
|
name: getPartitionKey()
|
|
nameWithType: RequestOptions.getPartitionKey()
|
|
fullName: com.microsoft.azure.cosmosdb.RequestOptions.getPartitionKey()
|
|
overload: com.microsoft.azure.cosmosdb._request_options.getPartitionKey*
|
|
type: Method
|
|
source:
|
|
remote: *o0
|
|
path: sdk/src/main/java/com/microsoft/azure/cosmosdb/RequestOptions.java
|
|
startLine: 212
|
|
package: com.microsoft.azure.cosmosdb
|
|
summary: >-
|
|
<p>Gets the partition key used to identify the current request's target partition.</p>
|
|
|
|
<p></p>
|
|
syntax:
|
|
content: public PartitionKey getPartitionKey()
|
|
return:
|
|
type: com.microsoft.azure.cosmosdb._partition_key
|
|
description: <p>the partition key value. </p>
|
|
- uid: com.microsoft.azure.cosmosdb._request_options.getPostTriggerInclude()
|
|
id: getPostTriggerInclude()
|
|
parent: com.microsoft.azure.cosmosdb._request_options
|
|
href: com.microsoft.azure.cosmosdb._request_options.yml
|
|
langs:
|
|
- java
|
|
name: getPostTriggerInclude()
|
|
nameWithType: RequestOptions.getPostTriggerInclude()
|
|
fullName: com.microsoft.azure.cosmosdb.RequestOptions.getPostTriggerInclude()
|
|
overload: com.microsoft.azure.cosmosdb._request_options.getPostTriggerInclude*
|
|
type: Method
|
|
source:
|
|
remote: *o0
|
|
path: sdk/src/main/java/com/microsoft/azure/cosmosdb/RequestOptions.java
|
|
startLine: 68
|
|
package: com.microsoft.azure.cosmosdb
|
|
summary: >-
|
|
<p>Gets the triggers to be invoked after the operation.</p>
|
|
|
|
<p></p>
|
|
syntax:
|
|
content: public List<String> getPostTriggerInclude()
|
|
return:
|
|
type: 7d60c20e
|
|
description: <p>the triggers to be invoked after the operation. </p>
|
|
- uid: com.microsoft.azure.cosmosdb._request_options.getPreTriggerInclude()
|
|
id: getPreTriggerInclude()
|
|
parent: com.microsoft.azure.cosmosdb._request_options
|
|
href: com.microsoft.azure.cosmosdb._request_options.yml
|
|
langs:
|
|
- java
|
|
name: getPreTriggerInclude()
|
|
nameWithType: RequestOptions.getPreTriggerInclude()
|
|
fullName: com.microsoft.azure.cosmosdb.RequestOptions.getPreTriggerInclude()
|
|
overload: com.microsoft.azure.cosmosdb._request_options.getPreTriggerInclude*
|
|
type: Method
|
|
source:
|
|
remote: *o0
|
|
path: sdk/src/main/java/com/microsoft/azure/cosmosdb/RequestOptions.java
|
|
startLine: 50
|
|
package: com.microsoft.azure.cosmosdb
|
|
summary: >-
|
|
<p>Gets the triggers to be invoked before the operation.</p>
|
|
|
|
<p></p>
|
|
syntax:
|
|
content: public List<String> getPreTriggerInclude()
|
|
return:
|
|
type: 7d60c20e
|
|
description: <p>the triggers to be invoked before the operation. </p>
|
|
- uid: com.microsoft.azure.cosmosdb._request_options.getResourceTokenExpirySeconds()
|
|
id: getResourceTokenExpirySeconds()
|
|
parent: com.microsoft.azure.cosmosdb._request_options
|
|
href: com.microsoft.azure.cosmosdb._request_options.yml
|
|
langs:
|
|
- java
|
|
name: getResourceTokenExpirySeconds()
|
|
nameWithType: RequestOptions.getResourceTokenExpirySeconds()
|
|
fullName: com.microsoft.azure.cosmosdb.RequestOptions.getResourceTokenExpirySeconds()
|
|
overload: com.microsoft.azure.cosmosdb._request_options.getResourceTokenExpirySeconds*
|
|
type: Method
|
|
source:
|
|
remote: *o0
|
|
path: sdk/src/main/java/com/microsoft/azure/cosmosdb/RequestOptions.java
|
|
startLine: 158
|
|
package: com.microsoft.azure.cosmosdb
|
|
summary: >-
|
|
<p>Gets the expiry time for resource token. Used when creating, updating, reading permission.</p>
|
|
|
|
<p></p>
|
|
syntax:
|
|
content: public Integer getResourceTokenExpirySeconds()
|
|
return:
|
|
type: 08effaa0
|
|
description: <p>the resource token expiry seconds. </p>
|
|
- uid: com.microsoft.azure.cosmosdb._request_options.getSessionToken()
|
|
id: getSessionToken()
|
|
parent: com.microsoft.azure.cosmosdb._request_options
|
|
href: com.microsoft.azure.cosmosdb._request_options.yml
|
|
langs:
|
|
- java
|
|
name: getSessionToken()
|
|
nameWithType: RequestOptions.getSessionToken()
|
|
fullName: com.microsoft.azure.cosmosdb.RequestOptions.getSessionToken()
|
|
overload: com.microsoft.azure.cosmosdb._request_options.getSessionToken*
|
|
type: Method
|
|
source:
|
|
remote: *o0
|
|
path: sdk/src/main/java/com/microsoft/azure/cosmosdb/RequestOptions.java
|
|
startLine: 140
|
|
package: com.microsoft.azure.cosmosdb
|
|
summary: >-
|
|
<p>Gets the token for use with session consistency.</p>
|
|
|
|
<p></p>
|
|
syntax:
|
|
content: public String getSessionToken()
|
|
return:
|
|
type: "26831127"
|
|
description: <p>the session token. </p>
|
|
- uid: com.microsoft.azure.cosmosdb._request_options.isPopulateQuotaInfo()
|
|
id: isPopulateQuotaInfo()
|
|
parent: com.microsoft.azure.cosmosdb._request_options
|
|
href: com.microsoft.azure.cosmosdb._request_options.yml
|
|
langs:
|
|
- java
|
|
name: isPopulateQuotaInfo()
|
|
nameWithType: RequestOptions.isPopulateQuotaInfo()
|
|
fullName: com.microsoft.azure.cosmosdb.RequestOptions.isPopulateQuotaInfo()
|
|
overload: com.microsoft.azure.cosmosdb._request_options.isPopulateQuotaInfo*
|
|
type: Method
|
|
source:
|
|
remote: *o0
|
|
path: sdk/src/main/java/com/microsoft/azure/cosmosdb/RequestOptions.java
|
|
startLine: 270
|
|
package: com.microsoft.azure.cosmosdb
|
|
summary: >-
|
|
<p>Gets the PopulateQuotaInfo setting for document collection read requests in the Azure Cosmos DB database service. PopulateQuotaInfo is used to enable/disable getting document collection quota related stats for document collection read requests.</p>
|
|
|
|
<p></p>
|
|
syntax:
|
|
content: public boolean isPopulateQuotaInfo()
|
|
return:
|
|
type: 4fc6e284
|
|
description: <p>true if PopulateQuotaInfo is enabled </p>
|
|
- uid: com.microsoft.azure.cosmosdb._request_options.isScriptLoggingEnabled()
|
|
id: isScriptLoggingEnabled()
|
|
parent: com.microsoft.azure.cosmosdb._request_options
|
|
href: com.microsoft.azure.cosmosdb._request_options.yml
|
|
langs:
|
|
- java
|
|
name: isScriptLoggingEnabled()
|
|
nameWithType: RequestOptions.isScriptLoggingEnabled()
|
|
fullName: com.microsoft.azure.cosmosdb.RequestOptions.isScriptLoggingEnabled()
|
|
overload: com.microsoft.azure.cosmosdb._request_options.isScriptLoggingEnabled*
|
|
type: Method
|
|
source:
|
|
remote: *o0
|
|
path: sdk/src/main/java/com/microsoft/azure/cosmosdb/RequestOptions.java
|
|
startLine: 249
|
|
package: com.microsoft.azure.cosmosdb
|
|
summary: >-
|
|
<p>Gets whether Javascript stored procedure logging is enabled for the current request in the Azure Cosmos DB database service or not.</p>
|
|
|
|
<p></p>
|
|
syntax:
|
|
content: public boolean isScriptLoggingEnabled()
|
|
return:
|
|
type: 4fc6e284
|
|
description: <p>true if Javascript stored procedure logging is enabled </p>
|
|
- uid: com.microsoft.azure.cosmosdb._request_options.setAccessCondition(AccessCondition)
|
|
id: setAccessCondition(AccessCondition)
|
|
parent: com.microsoft.azure.cosmosdb._request_options
|
|
href: com.microsoft.azure.cosmosdb._request_options.yml
|
|
langs:
|
|
- java
|
|
name: setAccessCondition(AccessCondition accessCondition)
|
|
nameWithType: RequestOptions.setAccessCondition(AccessCondition accessCondition)
|
|
fullName: com.microsoft.azure.cosmosdb.RequestOptions.setAccessCondition(AccessCondition accessCondition)
|
|
overload: com.microsoft.azure.cosmosdb._request_options.setAccessCondition*
|
|
type: Method
|
|
source:
|
|
remote: *o0
|
|
path: sdk/src/main/java/com/microsoft/azure/cosmosdb/RequestOptions.java
|
|
startLine: 95
|
|
package: com.microsoft.azure.cosmosdb
|
|
summary: >-
|
|
<p>Sets the conditions associated with the request.</p>
|
|
|
|
<p></p>
|
|
syntax:
|
|
content: public void setAccessCondition(AccessCondition accessCondition)
|
|
parameters:
|
|
- id: accessCondition
|
|
type: com.microsoft.azure.cosmosdb._access_condition
|
|
description: <p>the access condition. </p>
|
|
- uid: com.microsoft.azure.cosmosdb._request_options.setConsistencyLevel(ConsistencyLevel)
|
|
id: setConsistencyLevel(ConsistencyLevel)
|
|
parent: com.microsoft.azure.cosmosdb._request_options
|
|
href: com.microsoft.azure.cosmosdb._request_options.yml
|
|
langs:
|
|
- java
|
|
name: setConsistencyLevel(ConsistencyLevel consistencyLevel)
|
|
nameWithType: RequestOptions.setConsistencyLevel(ConsistencyLevel consistencyLevel)
|
|
fullName: com.microsoft.azure.cosmosdb.RequestOptions.setConsistencyLevel(ConsistencyLevel consistencyLevel)
|
|
overload: com.microsoft.azure.cosmosdb._request_options.setConsistencyLevel*
|
|
type: Method
|
|
source:
|
|
remote: *o0
|
|
path: sdk/src/main/java/com/microsoft/azure/cosmosdb/RequestOptions.java
|
|
startLine: 131
|
|
package: com.microsoft.azure.cosmosdb
|
|
summary: >-
|
|
<p>Sets the consistency level required for the request.</p>
|
|
|
|
<p></p>
|
|
syntax:
|
|
content: public void setConsistencyLevel(ConsistencyLevel consistencyLevel)
|
|
parameters:
|
|
- id: consistencyLevel
|
|
type: com.microsoft.azure.cosmosdb._consistency_level
|
|
description: <p>the consistency level. </p>
|
|
- uid: com.microsoft.azure.cosmosdb._request_options.setIndexingDirective(IndexingDirective)
|
|
id: setIndexingDirective(IndexingDirective)
|
|
parent: com.microsoft.azure.cosmosdb._request_options
|
|
href: com.microsoft.azure.cosmosdb._request_options.yml
|
|
langs:
|
|
- java
|
|
name: setIndexingDirective(IndexingDirective indexingDirective)
|
|
nameWithType: RequestOptions.setIndexingDirective(IndexingDirective indexingDirective)
|
|
fullName: com.microsoft.azure.cosmosdb.RequestOptions.setIndexingDirective(IndexingDirective indexingDirective)
|
|
overload: com.microsoft.azure.cosmosdb._request_options.setIndexingDirective*
|
|
type: Method
|
|
source:
|
|
remote: *o0
|
|
path: sdk/src/main/java/com/microsoft/azure/cosmosdb/RequestOptions.java
|
|
startLine: 113
|
|
package: com.microsoft.azure.cosmosdb
|
|
summary: >-
|
|
<p>Sets the indexing directive (index, do not index etc).</p>
|
|
|
|
<p></p>
|
|
syntax:
|
|
content: public void setIndexingDirective(IndexingDirective indexingDirective)
|
|
parameters:
|
|
- id: indexingDirective
|
|
type: com.microsoft.azure.cosmosdb._indexing_directive
|
|
description: <p>the indexing directive. </p>
|
|
- uid: com.microsoft.azure.cosmosdb._request_options.setOfferThroughput(Integer)
|
|
id: setOfferThroughput(Integer)
|
|
parent: com.microsoft.azure.cosmosdb._request_options
|
|
href: com.microsoft.azure.cosmosdb._request_options.yml
|
|
langs:
|
|
- java
|
|
name: setOfferThroughput(Integer offerThroughput)
|
|
nameWithType: RequestOptions.setOfferThroughput(Integer offerThroughput)
|
|
fullName: com.microsoft.azure.cosmosdb.RequestOptions.setOfferThroughput(Integer offerThroughput)
|
|
overload: com.microsoft.azure.cosmosdb._request_options.setOfferThroughput*
|
|
type: Method
|
|
source:
|
|
remote: *o0
|
|
path: sdk/src/main/java/com/microsoft/azure/cosmosdb/RequestOptions.java
|
|
startLine: 203
|
|
package: com.microsoft.azure.cosmosdb
|
|
summary: >-
|
|
<p>Sets the throughput in the form of Request Units per second when creating a document collection.</p>
|
|
|
|
<p></p>
|
|
syntax:
|
|
content: public void setOfferThroughput(Integer offerThroughput)
|
|
parameters:
|
|
- id: offerThroughput
|
|
type: 08effaa0
|
|
description: <p>the throughput value. </p>
|
|
- uid: com.microsoft.azure.cosmosdb._request_options.setOfferType(String)
|
|
id: setOfferType(String)
|
|
parent: com.microsoft.azure.cosmosdb._request_options
|
|
href: com.microsoft.azure.cosmosdb._request_options.yml
|
|
langs:
|
|
- java
|
|
name: setOfferType(String offerType)
|
|
nameWithType: RequestOptions.setOfferType(String offerType)
|
|
fullName: com.microsoft.azure.cosmosdb.RequestOptions.setOfferType(String offerType)
|
|
overload: com.microsoft.azure.cosmosdb._request_options.setOfferType*
|
|
type: Method
|
|
source:
|
|
remote: *o0
|
|
path: sdk/src/main/java/com/microsoft/azure/cosmosdb/RequestOptions.java
|
|
startLine: 185
|
|
package: com.microsoft.azure.cosmosdb
|
|
summary: >-
|
|
<p>Sets the offer type when creating a document collection.</p>
|
|
|
|
<p></p>
|
|
syntax:
|
|
content: public void setOfferType(String offerType)
|
|
parameters:
|
|
- id: offerType
|
|
type: "26831127"
|
|
description: <p>the offer type. </p>
|
|
- uid: com.microsoft.azure.cosmosdb._request_options.setPartitionKey(PartitionKey)
|
|
id: setPartitionKey(PartitionKey)
|
|
parent: com.microsoft.azure.cosmosdb._request_options
|
|
href: com.microsoft.azure.cosmosdb._request_options.yml
|
|
langs:
|
|
- java
|
|
name: setPartitionKey(PartitionKey partitionkey)
|
|
nameWithType: RequestOptions.setPartitionKey(PartitionKey partitionkey)
|
|
fullName: com.microsoft.azure.cosmosdb.RequestOptions.setPartitionKey(PartitionKey partitionkey)
|
|
overload: com.microsoft.azure.cosmosdb._request_options.setPartitionKey*
|
|
type: Method
|
|
source:
|
|
remote: *o0
|
|
path: sdk/src/main/java/com/microsoft/azure/cosmosdb/RequestOptions.java
|
|
startLine: 221
|
|
package: com.microsoft.azure.cosmosdb
|
|
summary: >-
|
|
<p>Sets the partition key used to identify the current request's target partition.</p>
|
|
|
|
<p></p>
|
|
syntax:
|
|
content: public void setPartitionKey(PartitionKey partitionkey)
|
|
parameters:
|
|
- id: partitionkey
|
|
type: com.microsoft.azure.cosmosdb._partition_key
|
|
description: <p>the partition key value. </p>
|
|
- uid: com.microsoft.azure.cosmosdb._request_options.setPartitionKeyRengeId(String)
|
|
id: setPartitionKeyRengeId(String)
|
|
parent: com.microsoft.azure.cosmosdb._request_options
|
|
href: com.microsoft.azure.cosmosdb._request_options.yml
|
|
langs:
|
|
- java
|
|
name: setPartitionKeyRengeId(String partitionKeyRangeId)
|
|
nameWithType: RequestOptions.setPartitionKeyRengeId(String partitionKeyRangeId)
|
|
fullName: com.microsoft.azure.cosmosdb.RequestOptions.setPartitionKeyRengeId(String partitionKeyRangeId)
|
|
overload: com.microsoft.azure.cosmosdb._request_options.setPartitionKeyRengeId*
|
|
type: Method
|
|
source:
|
|
remote: *o0
|
|
path: sdk/src/main/java/com/microsoft/azure/cosmosdb/RequestOptions.java
|
|
startLine: 239
|
|
package: com.microsoft.azure.cosmosdb
|
|
summary: >-
|
|
<p>Internal usage only: Sets the partition key range id used to identify the current request's target partition.</p>
|
|
|
|
<p></p>
|
|
syntax:
|
|
content: protected void setPartitionKeyRengeId(String partitionKeyRangeId)
|
|
parameters:
|
|
- id: partitionKeyRangeId
|
|
type: "26831127"
|
|
description: <p>the partition key range id value. </p>
|
|
- uid: com.microsoft.azure.cosmosdb._request_options.setPopulateQuotaInfo(boolean)
|
|
id: setPopulateQuotaInfo(boolean)
|
|
parent: com.microsoft.azure.cosmosdb._request_options
|
|
href: com.microsoft.azure.cosmosdb._request_options.yml
|
|
langs:
|
|
- java
|
|
name: setPopulateQuotaInfo(boolean populateQuotaInfo)
|
|
nameWithType: RequestOptions.setPopulateQuotaInfo(boolean populateQuotaInfo)
|
|
fullName: com.microsoft.azure.cosmosdb.RequestOptions.setPopulateQuotaInfo(boolean populateQuotaInfo)
|
|
overload: com.microsoft.azure.cosmosdb._request_options.setPopulateQuotaInfo*
|
|
type: Method
|
|
source:
|
|
remote: *o0
|
|
path: sdk/src/main/java/com/microsoft/azure/cosmosdb/RequestOptions.java
|
|
startLine: 281
|
|
package: com.microsoft.azure.cosmosdb
|
|
summary: >-
|
|
<p>Sets the PopulateQuotaInfo setting for document collection read requests in the Azure Cosmos DB database service. PopulateQuotaInfo is used to enable/disable getting document collection quota related stats for document collection read requests.</p>
|
|
|
|
<p></p>
|
|
syntax:
|
|
content: public void setPopulateQuotaInfo(boolean populateQuotaInfo)
|
|
parameters:
|
|
- id: populateQuotaInfo
|
|
type: 4fc6e284
|
|
description: <p>a boolean value indicating whether PopulateQuotaInfo is enabled or not </p>
|
|
- uid: com.microsoft.azure.cosmosdb._request_options.setPostTriggerInclude(List<String>)
|
|
id: setPostTriggerInclude(List<String>)
|
|
parent: com.microsoft.azure.cosmosdb._request_options
|
|
href: com.microsoft.azure.cosmosdb._request_options.yml
|
|
langs:
|
|
- java
|
|
name: setPostTriggerInclude(List<String> postTriggerInclude)
|
|
nameWithType: RequestOptions.setPostTriggerInclude(List<String> postTriggerInclude)
|
|
fullName: com.microsoft.azure.cosmosdb.RequestOptions.setPostTriggerInclude(List<String> postTriggerInclude)
|
|
overload: com.microsoft.azure.cosmosdb._request_options.setPostTriggerInclude*
|
|
type: Method
|
|
source:
|
|
remote: *o0
|
|
path: sdk/src/main/java/com/microsoft/azure/cosmosdb/RequestOptions.java
|
|
startLine: 77
|
|
package: com.microsoft.azure.cosmosdb
|
|
summary: >-
|
|
<p>Sets the triggers to be invoked after the operation.</p>
|
|
|
|
<p></p>
|
|
syntax:
|
|
content: public void setPostTriggerInclude(List<String> postTriggerInclude)
|
|
parameters:
|
|
- id: postTriggerInclude
|
|
type: 7d60c20e
|
|
description: <p>the triggers to be invoked after the operation. </p>
|
|
- uid: com.microsoft.azure.cosmosdb._request_options.setPreTriggerInclude(List<String>)
|
|
id: setPreTriggerInclude(List<String>)
|
|
parent: com.microsoft.azure.cosmosdb._request_options
|
|
href: com.microsoft.azure.cosmosdb._request_options.yml
|
|
langs:
|
|
- java
|
|
name: setPreTriggerInclude(List<String> preTriggerInclude)
|
|
nameWithType: RequestOptions.setPreTriggerInclude(List<String> preTriggerInclude)
|
|
fullName: com.microsoft.azure.cosmosdb.RequestOptions.setPreTriggerInclude(List<String> preTriggerInclude)
|
|
overload: com.microsoft.azure.cosmosdb._request_options.setPreTriggerInclude*
|
|
type: Method
|
|
source:
|
|
remote: *o0
|
|
path: sdk/src/main/java/com/microsoft/azure/cosmosdb/RequestOptions.java
|
|
startLine: 59
|
|
package: com.microsoft.azure.cosmosdb
|
|
summary: >-
|
|
<p>Sets the triggers to be invoked before the operation.</p>
|
|
|
|
<p></p>
|
|
syntax:
|
|
content: public void setPreTriggerInclude(List<String> preTriggerInclude)
|
|
parameters:
|
|
- id: preTriggerInclude
|
|
type: 7d60c20e
|
|
description: <p>the triggers to be invoked before the operation. </p>
|
|
- uid: com.microsoft.azure.cosmosdb._request_options.setResourceTokenExpirySeconds(Integer)
|
|
id: setResourceTokenExpirySeconds(Integer)
|
|
parent: com.microsoft.azure.cosmosdb._request_options
|
|
href: com.microsoft.azure.cosmosdb._request_options.yml
|
|
langs:
|
|
- java
|
|
name: setResourceTokenExpirySeconds(Integer resourceTokenExpirySeconds)
|
|
nameWithType: RequestOptions.setResourceTokenExpirySeconds(Integer resourceTokenExpirySeconds)
|
|
fullName: com.microsoft.azure.cosmosdb.RequestOptions.setResourceTokenExpirySeconds(Integer resourceTokenExpirySeconds)
|
|
overload: com.microsoft.azure.cosmosdb._request_options.setResourceTokenExpirySeconds*
|
|
type: Method
|
|
source:
|
|
remote: *o0
|
|
path: sdk/src/main/java/com/microsoft/azure/cosmosdb/RequestOptions.java
|
|
startLine: 167
|
|
package: com.microsoft.azure.cosmosdb
|
|
summary: >-
|
|
<p>Sets the expiry time for resource token. Used when creating, updating, reading permission.</p>
|
|
|
|
<p></p>
|
|
syntax:
|
|
content: public void setResourceTokenExpirySeconds(Integer resourceTokenExpirySeconds)
|
|
parameters:
|
|
- id: resourceTokenExpirySeconds
|
|
type: 08effaa0
|
|
description: <p>the resource token expiry seconds. </p>
|
|
- uid: com.microsoft.azure.cosmosdb._request_options.setScriptLoggingEnabled(boolean)
|
|
id: setScriptLoggingEnabled(boolean)
|
|
parent: com.microsoft.azure.cosmosdb._request_options
|
|
href: com.microsoft.azure.cosmosdb._request_options.yml
|
|
langs:
|
|
- java
|
|
name: setScriptLoggingEnabled(boolean scriptLoggingEnabled)
|
|
nameWithType: RequestOptions.setScriptLoggingEnabled(boolean scriptLoggingEnabled)
|
|
fullName: com.microsoft.azure.cosmosdb.RequestOptions.setScriptLoggingEnabled(boolean scriptLoggingEnabled)
|
|
overload: com.microsoft.azure.cosmosdb._request_options.setScriptLoggingEnabled*
|
|
type: Method
|
|
source:
|
|
remote: *o0
|
|
path: sdk/src/main/java/com/microsoft/azure/cosmosdb/RequestOptions.java
|
|
startLine: 259
|
|
package: com.microsoft.azure.cosmosdb
|
|
summary: >-
|
|
<p>Sets whether Javascript stored procedure logging is enabled for the current request in the Azure Cosmos DB database service or not.</p>
|
|
|
|
<p></p>
|
|
syntax:
|
|
content: public void setScriptLoggingEnabled(boolean scriptLoggingEnabled)
|
|
parameters:
|
|
- id: scriptLoggingEnabled
|
|
type: 4fc6e284
|
|
description: <p>true if stored procedure Javascript logging is enabled </p>
|
|
- uid: com.microsoft.azure.cosmosdb._request_options.setSessionToken(String)
|
|
id: setSessionToken(String)
|
|
parent: com.microsoft.azure.cosmosdb._request_options
|
|
href: com.microsoft.azure.cosmosdb._request_options.yml
|
|
langs:
|
|
- java
|
|
name: setSessionToken(String sessionToken)
|
|
nameWithType: RequestOptions.setSessionToken(String sessionToken)
|
|
fullName: com.microsoft.azure.cosmosdb.RequestOptions.setSessionToken(String sessionToken)
|
|
overload: com.microsoft.azure.cosmosdb._request_options.setSessionToken*
|
|
type: Method
|
|
source:
|
|
remote: *o0
|
|
path: sdk/src/main/java/com/microsoft/azure/cosmosdb/RequestOptions.java
|
|
startLine: 149
|
|
package: com.microsoft.azure.cosmosdb
|
|
summary: >-
|
|
<p>Sets the token for use with session consistency.</p>
|
|
|
|
<p></p>
|
|
syntax:
|
|
content: public void setSessionToken(String sessionToken)
|
|
parameters:
|
|
- id: sessionToken
|
|
type: "26831127"
|
|
description: <p>the session token. </p>
|
|
references:
|
|
- uid: 7d60c20e
|
|
spec.java:
|
|
- name: List<String>
|
|
fullName: List<String>
|
|
- uid: com.microsoft.azure.cosmosdb._request_options.getPreTriggerInclude*
|
|
name: getPreTriggerInclude
|
|
nameWithType: RequestOptions.getPreTriggerInclude
|
|
fullName: com.microsoft.azure.cosmosdb.RequestOptions.getPreTriggerInclude
|
|
package: com.microsoft.azure.cosmosdb
|
|
- uid: com.microsoft.azure.cosmosdb._request_options.setPreTriggerInclude*
|
|
name: setPreTriggerInclude
|
|
nameWithType: RequestOptions.setPreTriggerInclude
|
|
fullName: com.microsoft.azure.cosmosdb.RequestOptions.setPreTriggerInclude
|
|
package: com.microsoft.azure.cosmosdb
|
|
- uid: com.microsoft.azure.cosmosdb._request_options.getPostTriggerInclude*
|
|
name: getPostTriggerInclude
|
|
nameWithType: RequestOptions.getPostTriggerInclude
|
|
fullName: com.microsoft.azure.cosmosdb.RequestOptions.getPostTriggerInclude
|
|
package: com.microsoft.azure.cosmosdb
|
|
- uid: com.microsoft.azure.cosmosdb._request_options.setPostTriggerInclude*
|
|
name: setPostTriggerInclude
|
|
nameWithType: RequestOptions.setPostTriggerInclude
|
|
fullName: com.microsoft.azure.cosmosdb.RequestOptions.setPostTriggerInclude
|
|
package: com.microsoft.azure.cosmosdb
|
|
- uid: com.microsoft.azure.cosmosdb._request_options.getAccessCondition*
|
|
name: getAccessCondition
|
|
nameWithType: RequestOptions.getAccessCondition
|
|
fullName: com.microsoft.azure.cosmosdb.RequestOptions.getAccessCondition
|
|
package: com.microsoft.azure.cosmosdb
|
|
- uid: com.microsoft.azure.cosmosdb._request_options.setAccessCondition*
|
|
name: setAccessCondition
|
|
nameWithType: RequestOptions.setAccessCondition
|
|
fullName: com.microsoft.azure.cosmosdb.RequestOptions.setAccessCondition
|
|
package: com.microsoft.azure.cosmosdb
|
|
- uid: com.microsoft.azure.cosmosdb._request_options.getIndexingDirective*
|
|
name: getIndexingDirective
|
|
nameWithType: RequestOptions.getIndexingDirective
|
|
fullName: com.microsoft.azure.cosmosdb.RequestOptions.getIndexingDirective
|
|
package: com.microsoft.azure.cosmosdb
|
|
- uid: com.microsoft.azure.cosmosdb._request_options.setIndexingDirective*
|
|
name: setIndexingDirective
|
|
nameWithType: RequestOptions.setIndexingDirective
|
|
fullName: com.microsoft.azure.cosmosdb.RequestOptions.setIndexingDirective
|
|
package: com.microsoft.azure.cosmosdb
|
|
- uid: com.microsoft.azure.cosmosdb._request_options.getConsistencyLevel*
|
|
name: getConsistencyLevel
|
|
nameWithType: RequestOptions.getConsistencyLevel
|
|
fullName: com.microsoft.azure.cosmosdb.RequestOptions.getConsistencyLevel
|
|
package: com.microsoft.azure.cosmosdb
|
|
- uid: com.microsoft.azure.cosmosdb._request_options.setConsistencyLevel*
|
|
name: setConsistencyLevel
|
|
nameWithType: RequestOptions.setConsistencyLevel
|
|
fullName: com.microsoft.azure.cosmosdb.RequestOptions.setConsistencyLevel
|
|
package: com.microsoft.azure.cosmosdb
|
|
- uid: "26831127"
|
|
spec.java:
|
|
- name: String
|
|
fullName: String
|
|
- uid: com.microsoft.azure.cosmosdb._request_options.getSessionToken*
|
|
name: getSessionToken
|
|
nameWithType: RequestOptions.getSessionToken
|
|
fullName: com.microsoft.azure.cosmosdb.RequestOptions.getSessionToken
|
|
package: com.microsoft.azure.cosmosdb
|
|
- uid: com.microsoft.azure.cosmosdb._request_options.setSessionToken*
|
|
name: setSessionToken
|
|
nameWithType: RequestOptions.setSessionToken
|
|
fullName: com.microsoft.azure.cosmosdb.RequestOptions.setSessionToken
|
|
package: com.microsoft.azure.cosmosdb
|
|
- uid: 08effaa0
|
|
spec.java:
|
|
- name: Integer
|
|
fullName: Integer
|
|
- uid: com.microsoft.azure.cosmosdb._request_options.getResourceTokenExpirySeconds*
|
|
name: getResourceTokenExpirySeconds
|
|
nameWithType: RequestOptions.getResourceTokenExpirySeconds
|
|
fullName: com.microsoft.azure.cosmosdb.RequestOptions.getResourceTokenExpirySeconds
|
|
package: com.microsoft.azure.cosmosdb
|
|
- uid: com.microsoft.azure.cosmosdb._request_options.setResourceTokenExpirySeconds*
|
|
name: setResourceTokenExpirySeconds
|
|
nameWithType: RequestOptions.setResourceTokenExpirySeconds
|
|
fullName: com.microsoft.azure.cosmosdb.RequestOptions.setResourceTokenExpirySeconds
|
|
package: com.microsoft.azure.cosmosdb
|
|
- uid: com.microsoft.azure.cosmosdb._request_options.getOfferType*
|
|
name: getOfferType
|
|
nameWithType: RequestOptions.getOfferType
|
|
fullName: com.microsoft.azure.cosmosdb.RequestOptions.getOfferType
|
|
package: com.microsoft.azure.cosmosdb
|
|
- uid: com.microsoft.azure.cosmosdb._request_options.setOfferType*
|
|
name: setOfferType
|
|
nameWithType: RequestOptions.setOfferType
|
|
fullName: com.microsoft.azure.cosmosdb.RequestOptions.setOfferType
|
|
package: com.microsoft.azure.cosmosdb
|
|
- uid: com.microsoft.azure.cosmosdb._request_options.getOfferThroughput*
|
|
name: getOfferThroughput
|
|
nameWithType: RequestOptions.getOfferThroughput
|
|
fullName: com.microsoft.azure.cosmosdb.RequestOptions.getOfferThroughput
|
|
package: com.microsoft.azure.cosmosdb
|
|
- uid: com.microsoft.azure.cosmosdb._request_options.setOfferThroughput*
|
|
name: setOfferThroughput
|
|
nameWithType: RequestOptions.setOfferThroughput
|
|
fullName: com.microsoft.azure.cosmosdb.RequestOptions.setOfferThroughput
|
|
package: com.microsoft.azure.cosmosdb
|
|
- uid: com.microsoft.azure.cosmosdb._request_options.getPartitionKey*
|
|
name: getPartitionKey
|
|
nameWithType: RequestOptions.getPartitionKey
|
|
fullName: com.microsoft.azure.cosmosdb.RequestOptions.getPartitionKey
|
|
package: com.microsoft.azure.cosmosdb
|
|
- uid: com.microsoft.azure.cosmosdb._request_options.setPartitionKey*
|
|
name: setPartitionKey
|
|
nameWithType: RequestOptions.setPartitionKey
|
|
fullName: com.microsoft.azure.cosmosdb.RequestOptions.setPartitionKey
|
|
package: com.microsoft.azure.cosmosdb
|
|
- uid: 4fc6e284
|
|
spec.java:
|
|
- name: boolean
|
|
fullName: boolean
|
|
- uid: com.microsoft.azure.cosmosdb._request_options.isScriptLoggingEnabled*
|
|
name: isScriptLoggingEnabled
|
|
nameWithType: RequestOptions.isScriptLoggingEnabled
|
|
fullName: com.microsoft.azure.cosmosdb.RequestOptions.isScriptLoggingEnabled
|
|
package: com.microsoft.azure.cosmosdb
|
|
- uid: com.microsoft.azure.cosmosdb._request_options.setScriptLoggingEnabled*
|
|
name: setScriptLoggingEnabled
|
|
nameWithType: RequestOptions.setScriptLoggingEnabled
|
|
fullName: com.microsoft.azure.cosmosdb.RequestOptions.setScriptLoggingEnabled
|
|
package: com.microsoft.azure.cosmosdb
|
|
- uid: com.microsoft.azure.cosmosdb._request_options.isPopulateQuotaInfo*
|
|
name: isPopulateQuotaInfo
|
|
nameWithType: RequestOptions.isPopulateQuotaInfo
|
|
fullName: com.microsoft.azure.cosmosdb.RequestOptions.isPopulateQuotaInfo
|
|
package: com.microsoft.azure.cosmosdb
|
|
- uid: com.microsoft.azure.cosmosdb._request_options.setPopulateQuotaInfo*
|
|
name: setPopulateQuotaInfo
|
|
nameWithType: RequestOptions.setPopulateQuotaInfo
|
|
fullName: com.microsoft.azure.cosmosdb.RequestOptions.setPopulateQuotaInfo
|
|
package: com.microsoft.azure.cosmosdb
|
|
- uid: com.microsoft.azure.cosmosdb._request_options.setPartitionKeyRengeId*
|
|
name: setPartitionKeyRengeId
|
|
nameWithType: RequestOptions.setPartitionKeyRengeId
|
|
fullName: com.microsoft.azure.cosmosdb.RequestOptions.setPartitionKeyRengeId
|
|
package: com.microsoft.azure.cosmosdb
|
|
- uid: com.microsoft.azure.cosmosdb._access_condition
|
|
parent: com.microsoft.azure.cosmosdb
|
|
href: com.microsoft.azure.cosmosdb._access_condition.yml
|
|
name: AccessCondition
|
|
nameWithType: AccessCondition
|
|
fullName: com.microsoft.azure.cosmosdb.AccessCondition
|
|
type: Class
|
|
summary: <p>Represents a set of access conditions to be used for operations against the Azure Cosmos DB database service. </p>
|
|
syntax:
|
|
content: public class AccessCondition
|
|
- uid: com.microsoft.azure.cosmosdb._indexing_directive
|
|
parent: com.microsoft.azure.cosmosdb
|
|
href: com.microsoft.azure.cosmosdb._indexing_directive.yml
|
|
name: IndexingDirective
|
|
nameWithType: IndexingDirective
|
|
fullName: com.microsoft.azure.cosmosdb.IndexingDirective
|
|
type: Enum
|
|
summary: <p>Specifies whether or not the resource is to be indexed in the Azure Cosmos DB database service. </p>
|
|
syntax:
|
|
content: public enum IndexingDirective
|
|
- uid: com.microsoft.azure.cosmosdb._consistency_level
|
|
parent: com.microsoft.azure.cosmosdb
|
|
href: com.microsoft.azure.cosmosdb._consistency_level.yml
|
|
name: ConsistencyLevel
|
|
nameWithType: ConsistencyLevel
|
|
fullName: com.microsoft.azure.cosmosdb.ConsistencyLevel
|
|
type: Enum
|
|
summary: >-
|
|
<p>Represents the consistency levels supported for Cosmos DB client operations in the Azure Cosmos DB database service. </p>
|
|
|
|
<p>The requested ConsistencyLevel must match or be weaker than that provisioned for the database account. Consistency levels by order of strength are Strong, BoundedStaleness, Session and Eventual. </p>
|
|
syntax:
|
|
content: public enum ConsistencyLevel
|
|
- uid: com.microsoft.azure.cosmosdb._partition_key
|
|
parent: com.microsoft.azure.cosmosdb
|
|
href: com.microsoft.azure.cosmosdb._partition_key.yml
|
|
name: PartitionKey
|
|
nameWithType: PartitionKey
|
|
fullName: com.microsoft.azure.cosmosdb.PartitionKey
|
|
type: Class
|
|
summary: <p>Represents a partition key value in the Azure Cosmos DB database service. A partition key identifies the partition where the document is stored in. </p>
|
|
syntax:
|
|
content: public class PartitionKey
|