IncludedPath Class

Reference

Definition

Namespace:: Microsoft.Azure.Documents

Assemblies:: Microsoft.Azure.DocumentDB.Core.dll, Microsoft.Azure.Documents.Client.dll

Packages:: Microsoft.Azure.DocumentDB v2.18.0, Microsoft.Azure.DocumentDB.Core v2.18.0

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Specifies a path within a JSON document to be included in the Azure Cosmos DB service.

public sealed class IncludedPath : Microsoft.Azure.Documents.JsonSerializable

type IncludedPath = class
    inherit JsonSerializable

Public NotInheritable Class IncludedPath
Inherits JsonSerializable

Inheritance: Object

JsonSerializable
IncludedPath

Implements: ICloneable

Constructors

IncludedPath()

Initializes a new instance of the IncludedPath class for the Azure Cosmos DB service.

Properties

Indexes	Gets or sets the collection of Index objects to be applied for this included path in the Azure Cosmos DB service.
Path	Gets or sets the path to be indexed in the Azure Cosmos DB service.

Methods

Clone()	Creates a copy of the included path in the Azure Cosmos DB service.
LoadFrom(JsonReader)	Loads the object from the specified JSON reader in the Azure Cosmos DB service. (Inherited from JsonSerializable)
LoadFrom(JsonReader, JsonSerializerSettings)	Loads the object from the specified JSON reader in the Azure Cosmos DB service. (Inherited from JsonSerializable)
SaveTo(Stream, SerializationFormattingPolicy)	Saves the object to the specified stream in the Azure Cosmos DB service. (Inherited from JsonSerializable)
SaveTo(Stream, SerializationFormattingPolicy, JsonSerializerSettings)	Saves the object to the specified stream in the Azure Cosmos DB service. (Inherited from JsonSerializable)
ToString()	Returns the string representation of the object in the Azure Cosmos DB service. (Inherited from JsonSerializable)

Applies to