Firestore Admin v1 API - Class Index (3.13.0)

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

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

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
Name Description
other Index

Properties

ApiScope

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

The API scope supported by this index.

Property Value
Type Description
IndexTypesApiScope

Density

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

Immutable. The density configuration of the index.

Property Value
Type Description
IndexTypesDensity

Fields

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

The fields supported by this index.

For composite indexes, this requires a minimum of 2 and a maximum of 100 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
Type Description
RepeatedFieldIndexTypesIndexField

IndexName

public IndexName IndexName { get; set; }

IndexName-typed view over the Name resource name property.

Property Value
Type Description
IndexName

Multikey

public bool Multikey { get; set; }

Optional. Whether the index is multikey. By default, the index is not multikey. For non-multikey indexes, none of the paths in the index definition reach or traverse an array, except via an explicit array index. For multikey indexes, at most one of the paths in the index definition reach or traverse an array, except via an explicit array index. Violations will result in errors.

Note this field only applies to index with MONGODB_COMPATIBLE_API ApiScope.

Property Value
Type Description
bool

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
Type Description
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
Type Description
IndexTypesQueryScope

ShardCount

public int ShardCount { get; set; }

Optional. The number of shards for the index.

Property Value
Type Description
int

State

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

Output only. The serving state of the index.

Property Value
Type Description
IndexTypesState