Class Index (3.0.0)

Stay organized with collections Save and categorize content based on your preferences.
public sealed class Index : IMessage<Index>, IEquatable<Index>, IDeepCloneable<Index>, IBufferMessage, IMessage

Cloud Firestore indexes enable simple and complex queries against documents in a database.

Inheritance

Object > Index

Namespace

Google.Cloud.Firestore.Admin.V1

Assembly

Google.Cloud.Firestore.Admin.V1.dll

Constructors

Index()

public Index()

Index(Index)

public Index(Index other)
Parameter
NameDescription
otherIndex

Properties

Fields

public RepeatedField<Index.Types.IndexField> Fields { get; }

The fields supported by this index.

For composite indexes, this is always 2 or more fields. The last field entry is always for the field path __name__. If, on creation, __name__ was not specified as the last field, it will be added automatically with the same direction as that of the last field defined. If the final field in a composite index is not directional, the __name__ will be ordered ASCENDING (unless explicitly specified).

For single field indexes, this will always be exactly one entry with a field path equal to the field path of the associated field.

Property Value
TypeDescription
RepeatedField<Index.Types.IndexField>

IndexName

public IndexName IndexName { get; set; }

IndexName-typed view over the Name resource name property.

Property Value
TypeDescription
IndexName

Name

public string Name { get; set; }

Output only. A server defined name for this index. The form of this name for composite indexes will be: projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{composite_index_id} For single field indexes, this field will be empty.

Property Value
TypeDescription
String

QueryScope

public Index.Types.QueryScope QueryScope { get; set; }

Indexes with a collection query scope specified allow queries against a collection that is the child of a specific document, specified at query time, and that has the same collection id.

Indexes with a collection group query scope specified allow queries against all collections descended from a specific document, specified at query time, and that have the same collection id as this index.

Property Value
TypeDescription
Index.Types.QueryScope

State

public Index.Types.State State { get; set; }

Output only. The serving state of the index.

Property Value
TypeDescription
Index.Types.State