Class IndexingPolicy

Namespace

Microsoft.Azure.Management.CosmosDB.Fluent.Models

Assembly

Microsoft.Azure.Management.CosmosDB.Fluent.dll

Cosmos DB indexing policy

public class IndexingPolicy

Inheritance

object

IndexingPolicy

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

IndexingPolicy()

Initializes a new instance of the IndexingPolicy class.

public IndexingPolicy()

IndexingPolicy(bool?, IndexingMode, IList<IncludedPath>, IList<ExcludedPath>, IList<IList<CompositePath>>, IList<SpatialSpec>)

Initializes a new instance of the IndexingPolicy class.

public IndexingPolicy(bool? automatic = null, IndexingMode indexingMode = null, IList<IncludedPath> includedPaths = null, IList<ExcludedPath> excludedPaths = null, IList<IList<CompositePath>> compositeIndexes = null, IList<SpatialSpec> spatialIndexes = null)

Parameters

automatic bool?

Indicates if the indexing policy is automatic

indexingMode IndexingMode

Indicates the indexing mode. Possible values include: 'Consistent', 'Lazy', 'None'

includedPaths IList<IncludedPath>

List of paths to include in the indexing

excludedPaths IList<ExcludedPath>

List of paths to exclude from indexing

compositeIndexes IList<IList<CompositePath>>

List of composite path list

spatialIndexes IList<SpatialSpec>

List of spatial specifics

Properties

Automatic

Gets or sets indicates if the indexing policy is automatic

public bool? Automatic { get; set; }

Property Value

bool?

CompositeIndexes

Gets or sets list of composite path list

public IList<IList<CompositePath>> CompositeIndexes { get; set; }

Property Value

IList<IList<CompositePath>>

ExcludedPaths

Gets or sets list of paths to exclude from indexing

public IList<ExcludedPath> ExcludedPaths { get; set; }

Property Value

IList<ExcludedPath>

IncludedPaths

Gets or sets list of paths to include in the indexing

public IList<IncludedPath> IncludedPaths { get; set; }

Property Value

IList<IncludedPath>

IndexingMode

Gets or sets indicates the indexing mode. Possible values include: 'Consistent', 'Lazy', 'None'

public IndexingMode IndexingMode { get; set; }

Property Value

IndexingMode

SpatialIndexes

Gets or sets list of spatial specifics

public IList<SpatialSpec> SpatialIndexes { get; set; }

Property Value

IList<SpatialSpec>