Package com.hashicorp.cdktf.providers.google.firestore_field

Class FirestoreField.Builder

    • Method Detail

      • create

        @Stability(Stable)
public static FirestoreField.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 FirestoreField.Builder.

      • connection

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

      • connection

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

      • count

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

      • count

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

      • dependsOn

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

      • forEach

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

      • lifecycle

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

      • provider

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

      • provisioners

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

      • collection

        @Stability(Stable)
public FirestoreField.Builder collection​(String collection)
        The id of the collection group to configure.

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

        Parameters:
        collection - The id of the collection group to configure. This parameter is required.
        Returns:
        this

      • field

        @Stability(Stable)
public FirestoreField.Builder field​(String field)
        The id of the field to configure.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/firestore_field#field FirestoreField#field}

        Parameters:
        field - The id of the field to configure. This parameter is required.
        Returns:
        this

      • database

        @Stability(Stable)
public FirestoreField.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_field#database FirestoreField#database}

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

      • id

        @Stability(Stable)
public FirestoreField.Builder id​(String id)
        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/firestore_field#id FirestoreField#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_field#id FirestoreField#id}. This parameter is required.
        Returns:
        this

      • indexConfig

        @Stability(Stable)
public FirestoreField.Builder indexConfig​(FirestoreFieldIndexConfig indexConfig)
        index_config block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/firestore_field#index_config FirestoreField#index_config}

        Parameters:
        indexConfig - index_config block. This parameter is required.
        Returns:
        this

      • project

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

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

      • timeouts

        @Stability(Stable)
public FirestoreField.Builder timeouts​(FirestoreFieldTimeouts timeouts)
        timeouts block.

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

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

      • ttlConfig

        @Stability(Stable)
public FirestoreField.Builder ttlConfig​(FirestoreFieldTtlConfig ttlConfig)
        ttl_config block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/firestore_field#ttl_config FirestoreField#ttl_config}

        Parameters:
        ttlConfig - ttl_config block. This parameter is required.
        Returns:
        this