Package com.hashicorp.cdktf.providers.google.firestore_index

Class FirestoreIndex.Builder

    • Method Detail

      • create

        @Stability(Stable)
public static FirestoreIndex.Builder create​(software.constructs.Construct scope,
                                            String id)
        Parameters:
        scope - The scope in which to define this construct. This parameter is required.
        id - The scoped construct ID. This parameter is required.
        Returns:
        a new instance of FirestoreIndex.Builder.

      • connection

        @Stability(Experimental)
public FirestoreIndex.Builder connection​(com.hashicorp.cdktf.SSHProvisionerConnection connection)
        Parameters:
        connection - This parameter is required.
        Returns:
        this

      • connection

        @Stability(Experimental)
public FirestoreIndex.Builder connection​(com.hashicorp.cdktf.WinrmProvisionerConnection connection)
        Parameters:
        connection - This parameter is required.
        Returns:
        this

      • count

        @Stability(Experimental)
public FirestoreIndex.Builder count​(Number count)
        Parameters:
        count - This parameter is required.
        Returns:
        this

      • count

        @Stability(Experimental)
public FirestoreIndex.Builder count​(com.hashicorp.cdktf.TerraformCount count)
        Parameters:
        count - This parameter is required.
        Returns:
        this

      • dependsOn

        @Stability(Experimental)
public FirestoreIndex.Builder dependsOn​(List<? extends com.hashicorp.cdktf.ITerraformDependable> dependsOn)
        Parameters:
        dependsOn - This parameter is required.
        Returns:
        this

      • forEach

        @Stability(Experimental)
public FirestoreIndex.Builder forEach​(com.hashicorp.cdktf.ITerraformIterator forEach)
        Parameters:
        forEach - This parameter is required.
        Returns:
        this

      • lifecycle

        @Stability(Experimental)
public FirestoreIndex.Builder lifecycle​(com.hashicorp.cdktf.TerraformResourceLifecycle lifecycle)
        Parameters:
        lifecycle - This parameter is required.
        Returns:
        this

      • provider

        @Stability(Experimental)
public FirestoreIndex.Builder provider​(com.hashicorp.cdktf.TerraformProvider provider)
        Parameters:
        provider - This parameter is required.
        Returns:
        this

      • provisioners

        @Stability(Experimental)
public FirestoreIndex.Builder provisioners​(List<? extends Object> provisioners)
        Parameters:
        provisioners - This parameter is required.
        Returns:
        this

      • collection

        @Stability(Stable)
public FirestoreIndex.Builder collection​(String collection)
        The collection being indexed.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/firestore_index#collection FirestoreIndex#collection}

        Parameters:
        collection - The collection being indexed. This parameter is required.
        Returns:
        this

      • fields

        @Stability(Stable)
public FirestoreIndex.Builder fields​(com.hashicorp.cdktf.IResolvable fields)
        fields block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/firestore_index#fields FirestoreIndex#fields}

        Parameters:
        fields - fields block. This parameter is required.
        Returns:
        this

      • fields

        @Stability(Stable)
public FirestoreIndex.Builder fields​(List<? extends FirestoreIndexFields> fields)
        fields block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/firestore_index#fields FirestoreIndex#fields}

        Parameters:
        fields - fields block. This parameter is required.
        Returns:
        this

      • apiScope

        @Stability(Stable)
public FirestoreIndex.Builder apiScope​(String apiScope)
        The API scope at which a query is run. Default value: "ANY_API" Possible values: ["ANY_API", "DATASTORE_MODE_API"].

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/firestore_index#api_scope FirestoreIndex#api_scope}

        Parameters:
        apiScope - The API scope at which a query is run. Default value: "ANY_API" Possible values: ["ANY_API", "DATASTORE_MODE_API"]. This parameter is required.
        Returns:
        this

      • database

        @Stability(Stable)
public FirestoreIndex.Builder database​(String database)
        The Firestore database id. Defaults to '"(default)"'.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/firestore_index#database FirestoreIndex#database}

        Parameters:
        database - The Firestore database id. Defaults to '"(default)"'. This parameter is required.
        Returns:
        this

      • id

        @Stability(Stable)
public FirestoreIndex.Builder id​(String id)
        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/firestore_index#id FirestoreIndex#id}.

        Please be aware that the id field is automatically added to all resources in Terraform providers using a Terraform provider SDK version below 2. If you experience problems setting this value it might not be settable. Please take a look at the provider documentation to ensure it should be settable.

        Parameters:
        id - Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/firestore_index#id FirestoreIndex#id}. This parameter is required.
        Returns:
        this

      • project

        @Stability(Stable)
public FirestoreIndex.Builder project​(String project)
        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/firestore_index#project FirestoreIndex#project}.

        Parameters:
        project - Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/firestore_index#project FirestoreIndex#project}. This parameter is required.
        Returns:
        this

      • queryScope

        @Stability(Stable)
public FirestoreIndex.Builder queryScope​(String queryScope)
        The scope at which a query is run. Default value: "COLLECTION" Possible values: ["COLLECTION", "COLLECTION_GROUP", "COLLECTION_RECURSIVE"].

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/firestore_index#query_scope FirestoreIndex#query_scope}

        Parameters:
        queryScope - The scope at which a query is run. Default value: "COLLECTION" Possible values: ["COLLECTION", "COLLECTION_GROUP", "COLLECTION_RECURSIVE"]. This parameter is required.
        Returns:
        this

      • timeouts

        @Stability(Stable)
public FirestoreIndex.Builder timeouts​(FirestoreIndexTimeouts timeouts)
        timeouts block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/firestore_index#timeouts FirestoreIndex#timeouts}

        Parameters:
        timeouts - timeouts block. This parameter is required.
        Returns:
        this