Package com.hashicorp.cdktf.providers.google.bigtable_gc_policy

Interface BigtableGcPolicyConfig

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

    • Method Detail

      • getColumnFamily

        @Stability(Stable)
@NotNull
String getColumnFamily()
        The name of the column family.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/bigtable_gc_policy#column_family BigtableGcPolicy#column_family}

      • getInstanceName

        @Stability(Stable)
@NotNull
String getInstanceName()
        The name of the Bigtable instance.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/bigtable_gc_policy#instance_name BigtableGcPolicy#instance_name}

      • getTable

        @Stability(Stable)
@NotNull
String getTable()
        The name of the table.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/bigtable_gc_policy#table BigtableGcPolicy#table}

      • getDeletionPolicy

        @Stability(Stable)
@Nullable
default String getDeletionPolicy()
        The deletion policy for the GC policy.

        Setting ABANDON allows the resource to be abandoned rather than deleted. This is useful for GC policy as it cannot be deleted in a replicated instance. Possible values are: "ABANDON". Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/bigtable_gc_policy#deletion_policy BigtableGcPolicy#deletion_policy}

      • getGcRules

        @Stability(Stable)
@Nullable
default String getGcRules()
        Serialized JSON string for garbage collection policy. Conflicts with "mode", "max_age" and "max_version".

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/bigtable_gc_policy#gc_rules BigtableGcPolicy#gc_rules}

      • getId

        @Stability(Stable)
@Nullable
default String getId()
        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/bigtable_gc_policy#id BigtableGcPolicy#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.

      • getIgnoreWarnings

        @Stability(Stable)
@Nullable
default Object getIgnoreWarnings()
        Allows ignoring warnings when updating the GC policy.

        This can be used to increase the gc policy on replicated clusters. Doing this may make clusters be inconsistent for a longer period of time, before using this make sure you understand the risks listed at https://cloud.google.com/bigtable/docs/garbage-collection#increasing Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/bigtable_gc_policy#ignore_warnings BigtableGcPolicy#ignore_warnings}

      • getMaxAge

        @Stability(Stable)
@Nullable
default BigtableGcPolicyMaxAge getMaxAge()
        max_age block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/bigtable_gc_policy#max_age BigtableGcPolicy#max_age}

      • getMaxVersion

        @Stability(Stable)
@Nullable
default Object getMaxVersion()
        max_version block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/bigtable_gc_policy#max_version BigtableGcPolicy#max_version}

      • getMode

        @Stability(Stable)
@Nullable
default String getMode()
        NOTE: 'gc_rules' is more flexible, and should be preferred over this field for new resources.

        This field may be deprecated in the future. If multiple policies are set, you should choose between UNION OR INTERSECTION. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/bigtable_gc_policy#mode BigtableGcPolicy#mode}

      • getProject

        @Stability(Stable)
@Nullable
default String getProject()
        The ID of the project in which the resource belongs.

        If it is not provided, the provider project is used. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/bigtable_gc_policy#project BigtableGcPolicy#project}

      • getTimeouts

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

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