Module firestore

This provider is a derived work of the Terraform Provider distributed under MPL 2.0. If you encounter a bug or missing feature, first check the pulumi/pulumi-gcp repo; however, if that doesn’t turn up anything, please consult the source terraform-providers/terraform-provider-google repo.

Resources

Others

Resources

Resource Index

class Index extends CustomResource

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:

Example Usage - Firestore Index Basic

import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";

const myIndex = new gcp.firestore.Index("my-index", {
    collection: "chatrooms",
    fields: [
        {
            fieldPath: "name",
            order: "ASCENDING",
        },
        {
            fieldPath: "description",
            order: "DESCENDING",
        },
        {
            fieldPath: "__name__",
            order: "DESCENDING",
        },
    ],
    project: "my-project-name",
});

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

constructor

new Index(name: string, args: IndexArgs, opts?: pulumi.CustomResourceOptions)

Create a Index resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: IndexState, opts?: pulumi.CustomResourceOptions): Index

Get an existing Index resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): boolean

Returns true if the given object is an instance of Index. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property collection

public collection: pulumi.Output<string>;

property database

public database: pulumi.Output<string | undefined>;

property fields

public fields: pulumi.Output<outputs.firestore.IndexField[]>;

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property name

public name: pulumi.Output<string>;

property project

public project: pulumi.Output<string>;

property queryScope

public queryScope: pulumi.Output<string | undefined>;

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Others

interface IndexArgs

interface IndexArgs

The set of arguments for constructing a Index resource.

property collection

collection: pulumi.Input<string>;

property database

database?: pulumi.Input<string>;

property fields

fields: pulumi.Input<pulumi.Input<inputs.firestore.IndexField>[]>;

property project

project?: pulumi.Input<string>;

property queryScope

queryScope?: pulumi.Input<string>;

interface IndexState

interface IndexState

Input properties used for looking up and filtering Index resources.

property collection

collection?: pulumi.Input<string>;

property database

database?: pulumi.Input<string>;

property fields

fields?: pulumi.Input<pulumi.Input<inputs.firestore.IndexField>[]>;

property name

name?: pulumi.Input<string>;

property project

project?: pulumi.Input<string>;

property queryScope

queryScope?: pulumi.Input<string>;