Class IndexingPolicyDefinition<T>

Namespace

Microsoft.Azure.Cosmos.Fluent

Assembly

Microsoft.Azure.Cosmos.Client.dll

Indexing Policy fluent definition.

public class IndexingPolicyDefinition<T>

Type Parameters

T

Inheritance

object

IndexingPolicyDefinition<T>

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Extension Methods

CosmosLinqExtensions.DocumentId(object)

CosmosLinqExtensions.IsArray(object)

CosmosLinqExtensions.IsBool(object)

CosmosLinqExtensions.IsDefined(object)

CosmosLinqExtensions.IsNull(object)

CosmosLinqExtensions.IsNumber(object)

CosmosLinqExtensions.IsObject(object)

CosmosLinqExtensions.IsPrimitive(object)

CosmosLinqExtensions.IsString(object)

CosmosLinqExtensions.RegexMatch(object, string, string)

CosmosLinqExtensions.RegexMatch(object, string)

Constructors

IndexingPolicyDefinition()

Creates an instance for unit-testing

public IndexingPolicyDefinition()

See Also

IndexingPolicy

Methods

Attach()

Applies the current definition to the parent.

public T Attach()

Returns

T

An instance of the parent.

See Also

IndexingPolicy

WithAutomaticIndexing(bool)

Defines the Container's automatic indexing.

public IndexingPolicyDefinition<T> WithAutomaticIndexing(bool enabled)

Parameters

enabled bool

Defines whether Automatic Indexing is enabled or not.

Returns

IndexingPolicyDefinition<T>

An instance of IndexingPolicyDefinition<T>.

See Also

IndexingPolicy

WithCompositeIndex()

Defines a Composite Index in the current Container's definition.

public CompositeIndexDefinition<IndexingPolicyDefinition<T>> WithCompositeIndex()

Returns

CompositeIndexDefinition<IndexingPolicyDefinition<T>>

An instance of CompositeIndexDefinition<T>.

See Also

IndexingPolicy

WithExcludedPaths()

Defines the Container's ExcludedPaths.

public PathsDefinition<IndexingPolicyDefinition<T>> WithExcludedPaths()

Returns

PathsDefinition<IndexingPolicyDefinition<T>>

An instance of PathsDefinition<T>.

See Also

IndexingPolicy

WithIncludedPaths()

Defines the Container's IncludedPaths.

public PathsDefinition<IndexingPolicyDefinition<T>> WithIncludedPaths()

Returns

PathsDefinition<IndexingPolicyDefinition<T>>

An instance of PathsDefinition<T>.

See Also

IndexingPolicy

WithIndexingMode(IndexingMode)

Defines the Container's IndexingMode.

public IndexingPolicyDefinition<T> WithIndexingMode(IndexingMode indexingMode)

Parameters

indexingMode IndexingMode

An IndexingMode

Returns

IndexingPolicyDefinition<T>

An instance of IndexingPolicyDefinition<T>.

Remarks

If multiple calls are made to this method within the same IndexingPolicyDefinition<T>, the last one will apply.

See Also

IndexingPolicy

WithSpatialIndex()

Defines a SpatialIndex in the current Container's definition.

public SpatialIndexDefinition<IndexingPolicyDefinition<T>> WithSpatialIndex()

Returns

SpatialIndexDefinition<IndexingPolicyDefinition<T>>

An instance of SpatialIndexDefinition<T>.

See Also

IndexingPolicy

See Also

IndexingPolicy