RequestOptions.IndexingDirective Property

Definition

Namespace:
Microsoft.Azure.Documents.Client
Assemblies:
Microsoft.Azure.DocumentDB.Core.dll, Microsoft.Azure.Documents.Client.dll
Packages:
Microsoft.Azure.DocumentDB v2.13.1, Microsoft.Azure.DocumentDB.Core v2.13.1

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

public Microsoft.Azure.Documents.IndexingDirective? IndexingDirective { get; set; }
member this.IndexingDirective : Nullable<Microsoft.Azure.Documents.IndexingDirective> with get, set
Public Property IndexingDirective As Nullable(Of IndexingDirective)

Property Value

Nullable<IndexingDirective>

The indexing directive to use with a request.

Examples

The following example shows how to explicitly index a document in a collection with automatic indexing turned off.

client.CreateDocumentAsync(defaultCollection.SelfLink,
    new { id = "AndersenFamily", isRegistered = true },
    new RequestOptions { IndexingDirective = IndexingDirective.Include });

Applies to

See also