Class BigtableGcPolicyConfig.Builder
- java.lang.Object
-
- com.hashicorp.cdktf.providers.google.bigtable_gc_policy.BigtableGcPolicyConfig.Builder
-
- All Implemented Interfaces:
software.amazon.jsii.Builder<BigtableGcPolicyConfig>
- Enclosing interface:
- BigtableGcPolicyConfig
@Stability(Stable) public static final class BigtableGcPolicyConfig.Builder extends Object implements software.amazon.jsii.Builder<BigtableGcPolicyConfig>
A builder forBigtableGcPolicyConfig
-
-
Constructor Summary
Constructors Constructor Description Builder()
-
Method Summary
-
-
-
Method Detail
-
columnFamily
@Stability(Stable) public BigtableGcPolicyConfig.Builder columnFamily(String columnFamily)
Sets the value ofBigtableGcPolicyConfig.getColumnFamily()- Parameters:
columnFamily- The name of the column family. This parameter is required. 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}- Returns:
this
-
instanceName
@Stability(Stable) public BigtableGcPolicyConfig.Builder instanceName(String instanceName)
Sets the value ofBigtableGcPolicyConfig.getInstanceName()- Parameters:
instanceName- The name of the Bigtable instance. This parameter is required. 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}- Returns:
this
-
table
@Stability(Stable) public BigtableGcPolicyConfig.Builder table(String table)
Sets the value ofBigtableGcPolicyConfig.getTable()- Parameters:
table- The name of the table. This parameter is required. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/bigtable_gc_policy#table BigtableGcPolicy#table}- Returns:
this
-
deletionPolicy
@Stability(Stable) public BigtableGcPolicyConfig.Builder deletionPolicy(String deletionPolicy)
Sets the value ofBigtableGcPolicyConfig.getDeletionPolicy()- Parameters:
deletionPolicy- 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}- Returns:
this
-
gcRules
@Stability(Stable) public BigtableGcPolicyConfig.Builder gcRules(String gcRules)
Sets the value ofBigtableGcPolicyConfig.getGcRules()- Parameters:
gcRules- 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}- Returns:
this
-
id
@Stability(Stable) public BigtableGcPolicyConfig.Builder id(String id)
Sets the value ofBigtableGcPolicyConfig.getId()- Parameters:
id- 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.- Returns:
this
-
ignoreWarnings
@Stability(Stable) public BigtableGcPolicyConfig.Builder ignoreWarnings(Boolean ignoreWarnings)
Sets the value ofBigtableGcPolicyConfig.getIgnoreWarnings()- Parameters:
ignoreWarnings- 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}- Returns:
this
-
ignoreWarnings
@Stability(Stable) public BigtableGcPolicyConfig.Builder ignoreWarnings(com.hashicorp.cdktf.IResolvable ignoreWarnings)
Sets the value ofBigtableGcPolicyConfig.getIgnoreWarnings()- Parameters:
ignoreWarnings- 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}- Returns:
this
-
maxAge
@Stability(Stable) public BigtableGcPolicyConfig.Builder maxAge(BigtableGcPolicyMaxAge maxAge)
Sets the value ofBigtableGcPolicyConfig.getMaxAge()- Parameters:
maxAge- 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}- Returns:
this
-
maxVersion
@Stability(Stable) public BigtableGcPolicyConfig.Builder maxVersion(com.hashicorp.cdktf.IResolvable maxVersion)
Sets the value ofBigtableGcPolicyConfig.getMaxVersion()- Parameters:
maxVersion- 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}- Returns:
this
-
maxVersion
@Stability(Stable) public BigtableGcPolicyConfig.Builder maxVersion(List<? extends BigtableGcPolicyMaxVersion> maxVersion)
Sets the value ofBigtableGcPolicyConfig.getMaxVersion()- Parameters:
maxVersion- 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}- Returns:
this
-
mode
@Stability(Stable) public BigtableGcPolicyConfig.Builder mode(String mode)
Sets the value ofBigtableGcPolicyConfig.getMode()- Parameters:
mode- 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}- Returns:
this
-
project
@Stability(Stable) public BigtableGcPolicyConfig.Builder project(String project)
Sets the value ofBigtableGcPolicyConfig.getProject()- Parameters:
project- 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}- Returns:
this
-
timeouts
@Stability(Stable) public BigtableGcPolicyConfig.Builder timeouts(BigtableGcPolicyTimeouts timeouts)
Sets the value ofBigtableGcPolicyConfig.getTimeouts()- Parameters:
timeouts- 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}- Returns:
this
-
connection
@Stability(Experimental) public BigtableGcPolicyConfig.Builder connection(com.hashicorp.cdktf.SSHProvisionerConnection connection)
Sets the value ofTerraformMetaArguments.getConnection()- Parameters:
connection- the value to be set.- Returns:
this
-
connection
@Stability(Experimental) public BigtableGcPolicyConfig.Builder connection(com.hashicorp.cdktf.WinrmProvisionerConnection connection)
Sets the value ofTerraformMetaArguments.getConnection()- Parameters:
connection- the value to be set.- Returns:
this
-
count
@Stability(Experimental) public BigtableGcPolicyConfig.Builder count(Number count)
Sets the value ofTerraformMetaArguments.getCount()- Parameters:
count- the value to be set.- Returns:
this
-
count
@Stability(Experimental) public BigtableGcPolicyConfig.Builder count(com.hashicorp.cdktf.TerraformCount count)
Sets the value ofTerraformMetaArguments.getCount()- Parameters:
count- the value to be set.- Returns:
this
-
dependsOn
@Stability(Experimental) public BigtableGcPolicyConfig.Builder dependsOn(List<? extends com.hashicorp.cdktf.ITerraformDependable> dependsOn)
Sets the value ofTerraformMetaArguments.getDependsOn()- Parameters:
dependsOn- the value to be set.- Returns:
this
-
forEach
@Stability(Experimental) public BigtableGcPolicyConfig.Builder forEach(com.hashicorp.cdktf.ITerraformIterator forEach)
Sets the value ofTerraformMetaArguments.getForEach()- Parameters:
forEach- the value to be set.- Returns:
this
-
lifecycle
@Stability(Experimental) public BigtableGcPolicyConfig.Builder lifecycle(com.hashicorp.cdktf.TerraformResourceLifecycle lifecycle)
Sets the value ofTerraformMetaArguments.getLifecycle()- Parameters:
lifecycle- the value to be set.- Returns:
this
-
provider
@Stability(Experimental) public BigtableGcPolicyConfig.Builder provider(com.hashicorp.cdktf.TerraformProvider provider)
Sets the value ofTerraformMetaArguments.getProvider()- Parameters:
provider- the value to be set.- Returns:
this
-
provisioners
@Stability(Experimental) public BigtableGcPolicyConfig.Builder provisioners(List<? extends Object> provisioners)
Sets the value ofTerraformMetaArguments.getProvisioners()- Parameters:
provisioners- the value to be set.- Returns:
this
-
build
@Stability(Stable) public BigtableGcPolicyConfig build()
Builds the configured instance.- Specified by:
buildin interfacesoftware.amazon.jsii.Builder<BigtableGcPolicyConfig>- Returns:
- a new instance of
BigtableGcPolicyConfig - Throws:
NullPointerException- if any required attribute was not provided
-
-