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
}

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

This resource manages composite indexes and not single

field indexes.

To get more information about Index, see:

* [API documentation](https://cloud.google.com/firestore/docs/reference/rest/v1/projects.databases.collectionGroups.indexes) * How-to Guides

• [Official Documentation](https://cloud.google.com/firestore/docs/query-data/indexing)

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

func (*Index) Database

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

func (*Index) Fields

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

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

func (*Index) Project

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

func (*Index) QueryScope

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

func (*Index) URN

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

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

type IndexArgs

type IndexArgs struct {
	Collection interface{}
	Database   interface{}
	Fields     interface{}
	Project    interface{}
	QueryScope interface{}
}

The set of arguments for constructing a Index resource.

type IndexState

type IndexState struct {
	Collection interface{}
	Database   interface{}
	Fields     interface{}
	Name       interface{}
	Project    interface{}
	QueryScope interface{}
}

Input properties used for looking up and filtering Index resources.