RequestOptions Class

Definition

Encapsulates options that can be specified for a request issued to the Azure Cosmos DB database service.

public class RequestOptions
Inheritance
java.lang.Object
RequestOptions

Methods

getAccessCondition()

Gets the conditions associated with the request.

getConsistencyLevel()

Gets the consistency level required for the request.

getDisableRUPerMinuteUsage()

Gets the disableRUPerMinuteUsage for the current request in the Azure Cosmos DB database service.

disableRUPerMinuteUsage is used to enable/disable Request Units(RUs)/minute capacity to serve the request if regular provisioned RUs/second is exhausted.

getIndexingDirective()

Gets the indexing directive (index, do not index etc).

getOfferEnableRUPerMinuteThroughput()

Gets offerEnableRUPerMinuteThroughput for a collection in the Azure Cosmos DB database service.

getOfferThroughput()

Gets the throughput in the form of Request Units per second when creating a document collection.

getOfferType()

Gets the offer type when creating a document collection.

getPartitionKey()

Gets the partition key used to identify the current request's target partition.

getPostTriggerInclude()

Gets the triggers to be invoked after the operation.

getPreTriggerInclude()

Gets the triggers to be invoked before the operation.

getResourceTokenExpirySeconds()

Gets the expiry time for resource token. Used when creating, updating, reading permission.

getSessionToken()

Gets the token for use with session consistency.

isPopulatePartitionKeyRangeStatistics()

Gets populatePartitionKeyRangeStatistics for a collection in the Azure Cosmos DB database service.

isPopulateQuotaInfo()

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.

isScriptLoggingEnabled()

Gets whether Javascript stored procedure logging is enabled for the current request in the Azure Cosmos DB database service or not.

setAccessCondition(AccessCondition accessCondition)

Sets the conditions associated with the request.

setConsistencyLevel(ConsistencyLevel consistencyLevel)

Sets the consistency level required for the request.

setCustomRequestOption(String key, String value)

Sets the custom request option value by key

setDisableRUPerMinuteUsage(boolean disableRUPerMinuteUsage)

Sets the disableRUPerMinuteUsage for the current request in the Azure Cosmos DB database service.

disableRUPerMinuteUsage is used to enable/disable Request Units(RUs)/minute capacity to serve the request if regular provisioned RUs/second is exhausted.

setIndexingDirective(IndexingDirective indexingDirective)

Sets the indexing directive (index, do not index etc).

setOfferEnableRUPerMinuteThroughput(boolean offerEnableRUPerMinuteThroughput)

Sets offerEnableRUPerMinuteThroughput for a collection in the Azure Cosmos DB database service.

setOfferThroughput(Integer offerThroughput)

Sets the throughput in the form of Request Units per second when creating a document collection.

setOfferType(String offerType)

Sets the offer type when creating a document collection.

setPartitionKey(PartitionKey partitionkey)

Sets the partition key used to identify the current request's target partition.

setPartitionKeyRengeId(String partitionKeyRangeId)

Internal usage only: Sets the partition key range id used to identify the current request's target partition.

setPopulatePartitionKeyRangeStatistics(boolean populatePartitionKeyRangeStatistics)

Sets populatePartitionKeyRangeStatistics for a collection in the Azure Cosmos DB database service.

setPopulateQuotaInfo(boolean populateQuotaInfo)

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.

setPostTriggerInclude(List<String> postTriggerInclude)

Sets the triggers to be invoked after the operation.

setPreTriggerInclude(List<String> preTriggerInclude)

Sets the triggers to be invoked before the operation.

setResourceTokenExpirySeconds(Integer resourceTokenExpirySeconds)

Sets the expiry time for resource token. Used when creating, updating, reading permission.

setScriptLoggingEnabled(boolean scriptLoggingEnabled)

Sets whether Javascript stored procedure logging is enabled for the current request in the Azure Cosmos DB database service or not.

setSessionToken(String sessionToken)

Sets the token for use with session consistency.

Applies to