RequestOptions Class

Definition

Encapsulates options that can be specified for different requests issued to the Azure DocumentDB database service.

public sealed class RequestOptions
Inheritance
RequestOptions

Remarks

Some of these options are valid for specific operations only. For example,

PreTriggerInclude can be used only on create, replace and delete operations on a Document or Attachment.

ETag, while valid on Replace* and Delete* operations, would have no impact on a Read, CreateQuery or Create* operations.

Constructors

RequestOptions()

Properties

AccessCondition

Gets or sets the condition (ETag) associated with the request in the Azure DocumentDB database service.

ConsistencyLevel

Gets or sets the consistency level required for the request in the Azure DocumentDB database service.

DisableRUPerMinuteUsage

Gets or sets the DisableRUPerMinuteUsage for the current request in the Azure DocumentDB database service.

EnableScriptLogging

Gets or sets the EnableScriptLogging for the current request in the Azure DocumentDB database service.

IndexingDirective

Gets or sets the indexing directive (Include or Exclude) for the request in the Azure DocumentDB database service.

OfferEnableRUPerMinuteThroughput

Gets or sets the OfferEnableRUPerMinuteThroughput for a collection in the Azure DocumentDB database service

OfferThroughput

Gets or sets the offer throughput provisioned for a collection in measurement of Requests-per-Unit in the Azure DocumentDB database service.

OfferType

Gets or sets the offer type for the resource in the Azure DocumentDB database service.

PartitionKey

Gets or sets the PartitionKey for the current request in the Azure DocumentDB database service.

PopulateQuotaInfo

Gets or sets the PopulateQuotaInfo for document collection read requests in the Azure DocumentDB database service.

PostTriggerInclude

Gets or sets the trigger to be invoked after the operation in the Azure DocumentDB database service.

PreTriggerInclude

Gets or sets the trigger to be invoked before the operation in the Azure DocumentDB database service.

ResourceTokenExpirySeconds

Gets or sets the expiry time for resource token. Used when creating/updating/reading permissions in the Azure DocumentDB database service.

SessionToken

Gets or sets the token for use with session consistency in the Azure DocumentDB database service.

Extension Methods

IsDefined(Object)
IsNull(Object)
IsPrimitive(Object)