Package com.hashicorp.cdktf.providers.google.bigquery_table

Class BigqueryTable.Builder

    • Method Detail

      • create

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

      • connection

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

      • connection

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

      • count

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

      • count

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

      • dependsOn

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

      • forEach

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

      • lifecycle

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

      • provider

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

      • provisioners

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

      • datasetId

        @Stability(Stable)
public BigqueryTable.Builder datasetId​(String datasetId)
        The dataset ID to create the table in. Changing this forces a new resource to be created.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/bigquery_table#dataset_id BigqueryTable#dataset_id}

        Parameters:
        datasetId - The dataset ID to create the table in. Changing this forces a new resource to be created. This parameter is required.
        Returns:
        this

      • tableId

        @Stability(Stable)
public BigqueryTable.Builder tableId​(String tableId)
        A unique ID for the resource. Changing this forces a new resource to be created.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/bigquery_table#table_id BigqueryTable#table_id}

        Parameters:
        tableId - A unique ID for the resource. Changing this forces a new resource to be created. This parameter is required.
        Returns:
        this

      • allowResourceTagsOnDeletion

        @Stability(Stable)
public BigqueryTable.Builder allowResourceTagsOnDeletion​(Boolean allowResourceTagsOnDeletion)
        Deprecated Whether or not to allow table deletion when there are still resource tags attached.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/bigquery_table#allow_resource_tags_on_deletion BigqueryTable#allow_resource_tags_on_deletion}

        Parameters:
        allowResourceTagsOnDeletion - Deprecated Whether or not to allow table deletion when there are still resource tags attached. This parameter is required.
        Returns:
        this

      • allowResourceTagsOnDeletion

        @Stability(Stable)
public BigqueryTable.Builder allowResourceTagsOnDeletion​(com.hashicorp.cdktf.IResolvable allowResourceTagsOnDeletion)
        Deprecated Whether or not to allow table deletion when there are still resource tags attached.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/bigquery_table#allow_resource_tags_on_deletion BigqueryTable#allow_resource_tags_on_deletion}

        Parameters:
        allowResourceTagsOnDeletion - Deprecated Whether or not to allow table deletion when there are still resource tags attached. This parameter is required.
        Returns:
        this

      • clustering

        @Stability(Stable)
public BigqueryTable.Builder clustering​(List<String> clustering)
        Specifies column names to use for data clustering.

        Up to four top-level columns are allowed, and should be specified in descending priority order. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/bigquery_table#clustering BigqueryTable#clustering}

        Parameters:
        clustering - Specifies column names to use for data clustering. This parameter is required.
        Returns:
        this

      • deletionProtection

        @Stability(Stable)
public BigqueryTable.Builder deletionProtection​(Boolean deletionProtection)
        Whether Terraform will be prevented from destroying the instance.

        When the field is set to true or unset in Terraform state, a terraform apply or terraform destroy that would delete the table will fail. When the field is set to false, deleting the table is allowed. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/bigquery_table#deletion_protection BigqueryTable#deletion_protection}

        Parameters:
        deletionProtection - Whether Terraform will be prevented from destroying the instance. This parameter is required.
        Returns:
        this

      • deletionProtection

        @Stability(Stable)
public BigqueryTable.Builder deletionProtection​(com.hashicorp.cdktf.IResolvable deletionProtection)
        Whether Terraform will be prevented from destroying the instance.

        When the field is set to true or unset in Terraform state, a terraform apply or terraform destroy that would delete the table will fail. When the field is set to false, deleting the table is allowed. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/bigquery_table#deletion_protection BigqueryTable#deletion_protection}

        Parameters:
        deletionProtection - Whether Terraform will be prevented from destroying the instance. This parameter is required.
        Returns:
        this

      • description

        @Stability(Stable)
public BigqueryTable.Builder description​(String description)
        The field description.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/bigquery_table#description BigqueryTable#description}

        Parameters:
        description - The field description. This parameter is required.
        Returns:
        this

      • encryptionConfiguration

        @Stability(Stable)
public BigqueryTable.Builder encryptionConfiguration​(BigqueryTableEncryptionConfiguration encryptionConfiguration)
        encryption_configuration block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/bigquery_table#encryption_configuration BigqueryTable#encryption_configuration}

        Parameters:
        encryptionConfiguration - encryption_configuration block. This parameter is required.
        Returns:
        this

      • expirationTime

        @Stability(Stable)
public BigqueryTable.Builder expirationTime​(Number expirationTime)
        The time when this table expires, in milliseconds since the epoch.

        If not present, the table will persist indefinitely. Expired tables will be deleted and their storage reclaimed. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/bigquery_table#expiration_time BigqueryTable#expiration_time}

        Parameters:
        expirationTime - The time when this table expires, in milliseconds since the epoch. This parameter is required.
        Returns:
        this

      • externalDataConfiguration

        @Stability(Stable)
public BigqueryTable.Builder externalDataConfiguration​(BigqueryTableExternalDataConfiguration externalDataConfiguration)
        external_data_configuration block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/bigquery_table#external_data_configuration BigqueryTable#external_data_configuration}

        Parameters:
        externalDataConfiguration - external_data_configuration block. This parameter is required.
        Returns:
        this

      • friendlyName

        @Stability(Stable)
public BigqueryTable.Builder friendlyName​(String friendlyName)
        A descriptive name for the table.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/bigquery_table#friendly_name BigqueryTable#friendly_name}

        Parameters:
        friendlyName - A descriptive name for the table. This parameter is required.
        Returns:
        this

      • id

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

      • labels

        @Stability(Stable)
public BigqueryTable.Builder labels​(Map<String,​String> labels)
        A mapping of labels to assign to the resource.

        **Note**: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field 'effective_labels' for all of the labels present on the resource. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/bigquery_table#labels BigqueryTable#labels}

        Parameters:
        labels - A mapping of labels to assign to the resource. This parameter is required.
        Returns:
        this

      • materializedView

        @Stability(Stable)
public BigqueryTable.Builder materializedView​(BigqueryTableMaterializedView materializedView)
        materialized_view block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/bigquery_table#materialized_view BigqueryTable#materialized_view}

        Parameters:
        materializedView - materialized_view block. This parameter is required.
        Returns:
        this

      • maxStaleness

        @Stability(Stable)
public BigqueryTable.Builder maxStaleness​(String maxStaleness)
        The maximum staleness of data that could be returned when the table (or stale MV) is queried.

        Staleness encoded as a string encoding of [SQL IntervalValue type](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-types#interval_type). Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/bigquery_table#max_staleness BigqueryTable#max_staleness}

        Parameters:
        maxStaleness - The maximum staleness of data that could be returned when the table (or stale MV) is queried. This parameter is required.
        Returns:
        this

      • project

        @Stability(Stable)
public BigqueryTable.Builder project​(String project)
        The ID of the project in which the resource belongs.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/bigquery_table#project BigqueryTable#project}

        Parameters:
        project - The ID of the project in which the resource belongs. This parameter is required.
        Returns:
        this

      • rangePartitioning

        @Stability(Stable)
public BigqueryTable.Builder rangePartitioning​(BigqueryTableRangePartitioning rangePartitioning)
        range_partitioning block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/bigquery_table#range_partitioning BigqueryTable#range_partitioning}

        Parameters:
        rangePartitioning - range_partitioning block. This parameter is required.
        Returns:
        this

      • requirePartitionFilter

        @Stability(Stable)
public BigqueryTable.Builder requirePartitionFilter​(Boolean requirePartitionFilter)
        If set to true, queries over this table require a partition filter that can be used for partition elimination to be specified.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/bigquery_table#require_partition_filter BigqueryTable#require_partition_filter}

        Parameters:
        requirePartitionFilter - If set to true, queries over this table require a partition filter that can be used for partition elimination to be specified. This parameter is required.
        Returns:
        this

      • requirePartitionFilter

        @Stability(Stable)
public BigqueryTable.Builder requirePartitionFilter​(com.hashicorp.cdktf.IResolvable requirePartitionFilter)
        If set to true, queries over this table require a partition filter that can be used for partition elimination to be specified.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/bigquery_table#require_partition_filter BigqueryTable#require_partition_filter}

        Parameters:
        requirePartitionFilter - If set to true, queries over this table require a partition filter that can be used for partition elimination to be specified. This parameter is required.
        Returns:
        this

      • resourceTags

        @Stability(Stable)
public BigqueryTable.Builder resourceTags​(Map<String,​String> resourceTags)
        The tags attached to this table.

        Tag keys are globally unique. Tag key is expected to be in the namespaced format, for example "123456789012/environment" where 123456789012 is the ID of the parent organization or project resource for this tag key. Tag value is expected to be the short name, for example "Production". Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/bigquery_table#resource_tags BigqueryTable#resource_tags}

        Parameters:
        resourceTags - The tags attached to this table. This parameter is required.
        Returns:
        this

      • schema

        @Stability(Stable)
public BigqueryTable.Builder schema​(String schema)
        A JSON schema for the table.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/bigquery_table#schema BigqueryTable#schema}

        Parameters:
        schema - A JSON schema for the table. This parameter is required.
        Returns:
        this

      • tableConstraints

        @Stability(Stable)
public BigqueryTable.Builder tableConstraints​(BigqueryTableTableConstraints tableConstraints)
        table_constraints block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/bigquery_table#table_constraints BigqueryTable#table_constraints}

        Parameters:
        tableConstraints - table_constraints block. This parameter is required.
        Returns:
        this

      • tableReplicationInfo

        @Stability(Stable)
public BigqueryTable.Builder tableReplicationInfo​(BigqueryTableTableReplicationInfo tableReplicationInfo)
        table_replication_info block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/bigquery_table#table_replication_info BigqueryTable#table_replication_info}

        Parameters:
        tableReplicationInfo - table_replication_info block. This parameter is required.
        Returns:
        this

      • timePartitioning

        @Stability(Stable)
public BigqueryTable.Builder timePartitioning​(BigqueryTableTimePartitioning timePartitioning)
        time_partitioning block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/bigquery_table#time_partitioning BigqueryTable#time_partitioning}

        Parameters:
        timePartitioning - time_partitioning block. This parameter is required.
        Returns:
        this

      • view

        @Stability(Stable)
public BigqueryTable.Builder view​(BigqueryTableView view)
        view block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/bigquery_table#view BigqueryTable#view}

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