Show / Hide Table of Contents

Class IndexArgs

Inheritance
System.Object
InputArgs
ResourceArgs
IndexArgs
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 IndexArgs : ResourceArgs

Constructors

View Source

IndexArgs()

Declaration
public IndexArgs()

Properties

View Source

Collection

The collection being indexed.

Declaration
public Input<string> Collection { get; set; }
Property Value
Type Description
Input<System.String>
View Source

Database

The Firestore database id. Defaults to &quot;(default)&quot;.

Declaration
public Input<string> Database { get; set; }
Property Value
Type Description
Input<System.String>
View Source

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 &quot;ASCENDING&quot; (unless explicitly specified otherwise). Structure is documented below.

Declaration
public InputList<IndexFieldArgs> Fields { get; set; }
Property Value
Type Description
InputList<IndexFieldArgs>
View Source

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>
View Source

QueryScope

The scope at which a query is run.

Declaration
public Input<string> QueryScope { get; set; }
Property Value
Type Description
Input<System.String>
  • View Source
Back to top Copyright 2016-2020, Pulumi Corporation.