Firestore Admin v1 API - Class Index.Types.IndexField (3.15.0) 

public sealed class Index.Types.IndexField : IMessage<Index.Types.IndexField>, IEquatable<Index.Types.IndexField>, IDeepCloneable<Index.Types.IndexField>, IBufferMessage, IMessage

Reference documentation and code samples for the Firestore Admin v1 API class Index.Types.IndexField.

A field in an index. The field_path describes which field is indexed, the value_mode describes how the field value is indexed.

Inheritance

object > Index.Types.IndexField

Namespace

Google.Cloud.Firestore.Admin.V1

Assembly

Google.Cloud.Firestore.Admin.V1.dll

Constructors

IndexField()

public IndexField()

IndexField(IndexField)

public IndexField(Index.Types.IndexField other)
Parameter
Name Description
other IndexTypesIndexField

Properties

ArrayConfig

public Index.Types.IndexField.Types.ArrayConfig ArrayConfig { get; set; }

Indicates that this field supports operations on array_values.

Property Value
Type Description
IndexTypesIndexFieldTypesArrayConfig

FieldPath

public string FieldPath { get; set; }

Can be name. For single field indexes, this must match the name of the field or may be omitted.

Property Value
Type Description
string

HasArrayConfig

public bool HasArrayConfig { get; }

Gets whether the "array_config" field is set

Property Value
Type Description
bool

HasOrder

public bool HasOrder { get; }

Gets whether the "order" field is set

Property Value
Type Description
bool

Order

public Index.Types.IndexField.Types.Order Order { get; set; }

Indicates that this field supports ordering by the specified order or comparing using =, !=, <, <=, >, >=.

Property Value
Type Description
IndexTypesIndexFieldTypesOrder

ValueModeCase

public Index.Types.IndexField.ValueModeOneofCase ValueModeCase { get; }
Property Value
Type Description
IndexTypesIndexFieldValueModeOneofCase

VectorConfig

public Index.Types.IndexField.Types.VectorConfig VectorConfig { get; set; }

Indicates that this field supports nearest neighbor and distance operations on vector.

Property Value
Type Description
IndexTypesIndexFieldTypesVectorConfig