RequestOptions Class

Updated: June 30, 2017

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

Namespace: Microsoft.Azure.Documents.Client
Assembly: Microsoft.Azure.Documents.Client (in Microsoft.Azure.Documents.Client.dll)

Inheritance Hierarchy

SystemObject
Microsoft.Azure.Documents.ClientRequestOptions

No code example is currently available or this language may not be supported.

	Name	Description
	RequestOptions

	Name	Description
		Gets or sets the condition (ETag) associated with the request in the Azure DocumentDB database service.
		Gets or sets the consistency level required for the request in the Azure DocumentDB database service.
		Gets or sets the for the current request in the Azure DocumentDB database service.
		Gets or sets the for the current request in the Azure DocumentDB database service.
		Gets or sets the indexing directive (Include or Exclude) for the request in the Azure DocumentDB database service.
		Gets or sets the for a collection in the Azure DocumentDB database service
		Gets or sets the offer throughput provisioned for a collection in measurement of Requests-per-Unit in the Azure DocumentDB database service.
		Gets or sets the offer type for the resource in the Azure DocumentDB database service.
		Gets or sets the for the current request in the Azure DocumentDB database service.
		Gets or sets the for document collection read requests in the Azure DocumentDB database service.
		Gets or sets the trigger to be invoked after the operation in the Azure DocumentDB database service.
		Gets or sets the trigger to be invoked before the operation in the Azure DocumentDB database service.
		Gets or sets the expiry time for resource token. Used when creating/updating/reading permissions in the Azure DocumentDB database service.
		Gets or sets the token for use with session consistency in the Azure DocumentDB database service.

	Name	Description
	IsDefined	Determines if a certain property is defined or not. (Defined by TypeCheckFunctionsExtensions.)
	IsNull	Determines if a certain property is null or not. (Defined by TypeCheckFunctionsExtensions.)
	IsPrimitive	Determines if a certain property is of premitive JSON type. (Defined by TypeCheckFunctionsExtensions.)

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.

Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.