firestore

Documentation

Index

• type Index
  • func GetIndex(ctx *pulumi.Context, name string, id pulumi.ID, state *IndexState, ...) (*Index, error)
  • func NewIndex(ctx *pulumi.Context, name string, args *IndexArgs, opts ...pulumi.ResourceOpt) (*Index, error)
  • func (r *Index) Collection() pulumi.StringOutput
  • func (r *Index) Database() pulumi.StringOutput
  • func (r *Index) Fields() pulumi.ArrayOutput
  • func (r *Index) ID() pulumi.IDOutput
  • func (r *Index) Name() pulumi.StringOutput
  • func (r *Index) Project() pulumi.StringOutput
  • func (r *Index) QueryScope() pulumi.StringOutput
  • func (r *Index) URN() pulumi.URNOutput
• type IndexArgs
• type IndexState

Types

type Index

type Index struct {
	// contains filtered or unexported fields
}

> This content is derived from https://github.com/terraform-providers/terraform-provider-google/blob/master/website/docs/r/firestore_index.html.markdown.

func GetIndex

func GetIndex(ctx *pulumi.Context,
	name string, id pulumi.ID, state *IndexState, opts ...pulumi.ResourceOpt) (*Index, error)

GetIndex gets an existing Index resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewIndex

func NewIndex(ctx *pulumi.Context,
	name string, args *IndexArgs, opts ...pulumi.ResourceOpt) (*Index, error)

NewIndex registers a new resource with the given unique name, arguments, and options.

func (*Index) Collection

func (r *Index) Collection() pulumi.StringOutput

The collection being indexed.

func (*Index) Database

func (r *Index) Database() pulumi.StringOutput

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

func (*Index) Fields

func (r *Index) Fields() pulumi.ArrayOutput

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).

func (*Index) ID

func (r *Index) ID() pulumi.IDOutput

ID is this resource's unique identifier assigned by its provider.

func (*Index) Name

func (r *Index) Name() pulumi.StringOutput

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

func (*Index) Project

func (r *Index) Project() pulumi.StringOutput

func (*Index) QueryScope

func (r *Index) QueryScope() pulumi.StringOutput

The scope at which a query is run. One of '"COLLECTION"' or '"COLLECTION_GROUP"'. Defaults to '"COLLECTION"'.

func (*Index) URN

func (r *Index) URN() pulumi.URNOutput

URN is this resource's unique name assigned by Pulumi.

type IndexArgs

type IndexArgs struct {
	// The collection being indexed.
	Collection interface{}
	// The Firestore database id. Defaults to '"(default)"'.
	Database interface{}
	// 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).
	Fields  interface{}
	Project interface{}
	// The scope at which a query is run. One of '"COLLECTION"' or '"COLLECTION_GROUP"'. Defaults to '"COLLECTION"'.
	QueryScope interface{}
}

The set of arguments for constructing a Index resource.

type IndexState

type IndexState struct {
	// The collection being indexed.
	Collection interface{}
	// The Firestore database id. Defaults to '"(default)"'.
	Database interface{}
	// 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).
	Fields interface{}
	// A server defined name for this index. Format:
	// 'projects/{{project}}/databases/{{database}}/collectionGroups/{{collection}}/indexes/{{server_generated_id}}'
	Name    interface{}
	Project interface{}
	// The scope at which a query is run. One of '"COLLECTION"' or '"COLLECTION_GROUP"'. Defaults to '"COLLECTION"'.
	QueryScope interface{}
}

Input properties used for looking up and filtering Index resources.