Class GoogleFirestoreAdminV1Index

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

Inheritance
object
GoogleFirestoreAdminV1Index
Implements
Inherited Members
Namespace: Google.Apis.Firestore.v1.Data
Assembly: Google.Apis.Firestore.v1.dll
Syntax
public class GoogleFirestoreAdminV1Index : IDirectResponseSchema

Properties

ApiScope

The API scope supported by this index.

Declaration
[JsonProperty("apiScope")]
public virtual string ApiScope { get; set; }
Property Value
Type Description
string

Density

Immutable. The density configuration of the index.

Declaration
[JsonProperty("density")]
public virtual string Density { get; set; }
Property Value
Type Description
string

ETag

The ETag of the item.

Declaration
public virtual string ETag { get; set; }
Property Value
Type Description
string

Fields

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.

Declaration
[JsonProperty("fields")]
public virtual IList<GoogleFirestoreAdminV1IndexField> Fields { get; set; }
Property Value
Type Description
IList<GoogleFirestoreAdminV1IndexField>

Multikey

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.

Declaration
[JsonProperty("multikey")]
public virtual bool? Multikey { get; set; }
Property Value
Type Description
bool?

Name

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.

Declaration
[JsonProperty("name")]
public virtual string Name { get; set; }
Property Value
Type Description
string

QueryScope

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.

Declaration
[JsonProperty("queryScope")]
public virtual string QueryScope { get; set; }
Property Value
Type Description
string

ShardCount

Optional. The number of shards for the index.

Declaration
[JsonProperty("shardCount")]
public virtual int? ShardCount { get; set; }
Property Value
Type Description
int?

State

Output only. The serving state of the index.

Declaration
[JsonProperty("state")]
public virtual string State { get; set; }
Property Value
Type Description
string

Implements