Firestore Admin v1 API - Class Field.Types.IndexConfig (3.6.0)

public sealed class Field.Types.IndexConfig : IMessage<Field.Types.IndexConfig>, IEquatable<Field.Types.IndexConfig>, IDeepCloneable<Field.Types.IndexConfig>, IBufferMessage, IMessage

Reference documentation and code samples for the Firestore Admin v1 API class Field.Types.IndexConfig.

The index configuration for this field.

Inheritance

object > Field.Types.IndexConfig

Implements

IMessage Field Types IndexConfig, IEquatable Field Types IndexConfig, IDeepCloneable Field Types IndexConfig, IBufferMessage, IMessage

Inherited Members

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.Firestore.Admin.V1

Assembly

Google.Cloud.Firestore.Admin.V1.dll

Constructors

IndexConfig()

public IndexConfig()

IndexConfig(IndexConfig)

public IndexConfig(Field.Types.IndexConfig other)

Parameter
Name	Description
`other`	`FieldTypesIndexConfig`

Properties

AncestorField

public string AncestorField { get; set; }

Output only. Specifies the resource name of the Field from which this field's index configuration is set (when uses_ancestor_config is true), or from which it would be set if this field had no index configuration (when uses_ancestor_config is false).

Property Value
Type	Description
`string`

Indexes

public RepeatedField<Index> Indexes { get; }

The indexes supported for this field.

Property Value
Type	Description
`RepeatedFieldIndex`

Reverting

public bool Reverting { get; set; }

Output only When true, the Field's index configuration is in the process of being reverted. Once complete, the index config will transition to the same state as the field specified by ancestor_field, at which point uses_ancestor_config will be true and reverting will be false.

Property Value
Type	Description
`bool`

UsesAncestorConfig

public bool UsesAncestorConfig { get; set; }

Output only. When true, the Field's index configuration is set from the configuration specified by the ancestor_field. When false, the Field's index configuration is defined explicitly.

Property Value
Type	Description
`bool`