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

Interface FirestoreFieldConfig

  • All Superinterfaces:
    software.amazon.jsii.JsiiSerializable, com.hashicorp.cdktf.TerraformMetaArguments
    All Known Implementing Classes:
    FirestoreFieldConfig.Jsii$Proxy
    @Generated(value="jsii-pacmak/1.102.0 (build e354887)",
           date="2024-08-31T03:59:21.236Z")
@Stability(Stable)
public interface FirestoreFieldConfig
extends software.amazon.jsii.JsiiSerializable, com.hashicorp.cdktf.TerraformMetaArguments

    • Method Detail

      • getCollection

        @Stability(Stable)
@NotNull
String getCollection()
        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}

      • getField

        @Stability(Stable)
@NotNull
String getField()
        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}

      • getDatabase

        @Stability(Stable)
@Nullable
default String getDatabase()
        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}

      • getId

        @Stability(Stable)
@Nullable
default String getId()
        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.

      • getIndexConfig

        @Stability(Stable)
@Nullable
default FirestoreFieldIndexConfig getIndexConfig()
        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}

      • getProject

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

      • getTimeouts

        @Stability(Stable)
@Nullable
default FirestoreFieldTimeouts getTimeouts()
        timeouts block.

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

      • getTtlConfig

        @Stability(Stable)
@Nullable
default FirestoreFieldTtlConfig getTtlConfig()
        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}