Class GoogleFirestoreAdminV1Index

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

Inheritance
System.Object
GoogleFirestoreAdminV1Index
Implements
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
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
System.String

ETag

The ETag of the item.

Declaration
public virtual string ETag { get; set; }
Property Value
Type Description
System.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
System.Collections.Generic.IList<GoogleFirestoreAdminV1IndexField>

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
System.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
System.String

State

Output only. The serving state of the index.

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

Implements