Class IndexState

Inheritance

System.Object

InputArgs

ResourceArgs

IndexState

Inherited Members

ResourceArgs.Empty

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: Pulumi.Gcp.Firestore

Assembly: Pulumi.Gcp.dll

Syntax

public sealed class IndexState : ResourceArgs

Constructors

IndexState()

Declaration

public IndexState()

Properties

Collection

The collection being indexed.

Declaration

public Input<string> Collection { get; set; }

Property Value

Type	Description
Input<System.String>

Database

The Firestore database id. Defaults to "(default)".

Declaration

public Input<string> Database { get; set; }

Property Value

Type	Description
Input<System.String>

Fields

The fields supported by this index. 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 otherwise). Structure is documented below.

Declaration

public InputList<IndexFieldGetArgs> Fields { get; set; }

Property Value

Type	Description
InputList<IndexFieldGetArgs>

Name

A server defined name for this index. Format: 'projects/{{project}}/databases/{{database}}/collectionGroups/{{collection}}/indexes/{{server_generated_id}}'

Declaration

public Input<string> Name { get; set; }

Property Value

Type	Description
Input<System.String>

Project

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

Declaration

public Input<string> Project { get; set; }

Property Value

Type	Description
Input<System.String>

QueryScope

The scope at which a query is run.

Declaration

public Input<string> QueryScope { get; set; }

Property Value

Type	Description
Input<System.String>