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

Interface BigqueryTableConfig

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

    • Method Detail

      • getDatasetId

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

      • getTableId

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

      • getAllowResourceTagsOnDeletion

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

      • getClustering

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

      • getDeletionProtection

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

      • getDescription

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

      • getEncryptionConfiguration

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

      • getExpirationTime

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

      • getExternalDataConfiguration

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

      • getFriendlyName

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

      • getId

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

      • getLabels

        @Stability(Stable)
@Nullable
default Map<String,​String> getLabels()
        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}

      • getMaterializedView

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

      • getMaxStaleness

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

      • getProject

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

      • getRangePartitioning

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

      • getRequirePartitionFilter

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

      • getResourceTags

        @Stability(Stable)
@Nullable
default Map<String,​String> getResourceTags()
        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}

      • getSchema

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

      • getTableConstraints

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

      • getTableReplicationInfo

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

      • getTimePartitioning

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

      • getView

        @Stability(Stable)
@Nullable
default BigqueryTableView getView()
        view block.

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