TableState class

Input properties used for looking up and filtering Table resources.

Constructors

TableState({Input<TableBiglakeConfiguration?>? biglakeConfiguration, Input<List<String>?>? clusterings, Input<int?>? creationTime, Input<String?>? datasetId, Input<String?>? deletionPolicy, Input<bool?>? deletionProtection, Input<String?>? description, Input<Map<String, String>?>? effectiveLabels, Input<TableEncryptionConfiguration?>? encryptionConfiguration, Input<String?>? etag, Input<int?>? expirationTime, Input<TableExternalCatalogTableOptions?>? externalCatalogTableOptions, Input<TableExternalDataConfiguration?>? externalDataConfiguration, Input<String?>? friendlyName, Input<String?>? generatedSchemaColumns, Input<bool?>? ignoreAutoGeneratedSchema, Input<List<String>?>? ignoreSchemaChanges, Input<Map<String, String>?>? labels, Input<int?>? lastModifiedTime, Input<String?>? location, Input<TableMaterializedView?>? materializedView, Input<String?>? maxStaleness, Input<int?>? numBytes, Input<int?>? numLongTermBytes, Input<int?>? numRows, Input<String?>? project, Input<Map<String, String>?>? pulumiLabels, Input<TableRangePartitioning?>? rangePartitioning, Input<bool?>? requirePartitionFilter, Input<Map<String, String>?>? resourceTags, Input<String?>? schema, Input<TableSchemaForeignTypeInfo?>? schemaForeignTypeInfo, Input<String?>? selfLink, Input<TableTableConstraints?>? tableConstraints, Input<String?>? tableId, Input<String?>? tableMetadataView, Input<TableTableReplicationInfo?>? tableReplicationInfo, Input<TableTimePartitioning?>? timePartitioning, Input<String?>? type, Input<TableView?>? view})
Creates a new TableState. biglakeConfiguration Specifies the configuration of a BigLake managed table. Structure is documented below clusterings Specifies column names to use for data clustering. creationTime The time when this table was created, in milliseconds since the epoch. datasetId The dataset ID to create the table in. deletionPolicy (Optional) Whether Terraform will be prevented from destroying the resource. Defaults to "DELETE". deletionProtection Whether or not to allow the provider to destroy the instance. Unless this field is set to false description The field description. effectiveLabels All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services. encryptionConfiguration Specifies how the table should be encrypted. etag A hash of the resource. expirationTime The time when this table expires, in externalCatalogTableOptions Options defining open source externalDataConfiguration Describes the data format, friendlyName A descriptive name for the table. generatedSchemaColumns (Output-only) A list of autogenerated schema fields. ignoreAutoGeneratedSchema If true, Terraform will prevent columns added by the server(e.g. hive partitioned columns) in schema from showing diff. ignoreSchemaChanges A list of fields which would act non-authoritative for each column in schema. labels A mapping of labels to assign to the resource. lastModifiedTime The time when this table was last modified, in milliseconds since the epoch. location The geographic location where the table resides. This value is inherited from the dataset. materializedView If specified, configures this table as a materialized view. maxStaleness The maximum staleness of data that could be numBytes The size of this table in bytes, excluding any data in the streaming buffer. numLongTermBytes The number of bytes in the table that are considered "long-term storage". numRows The number of rows of data in this table, excluding any data in the streaming buffer. project The ID of the project in which the resource belongs. If it pulumiLabels The combination of labels configured directly on the resource and default labels configured on the provider. rangePartitioning If specified, configures range-based requirePartitionFilter If set to true, queries over this table resourceTags The tags attached to this table. Tag keys are schema A JSON schema for the table. schemaForeignTypeInfo Specifies metadata of the foreign data selfLink The URI of the created resource. tableConstraints Defines the primary key and foreign keys. tableId A unique ID for the resource. tableMetadataView View sets the optional parameter "view": Specifies the view that determines which table information is returned. By default, basic table information and storage statistics (STORAGE_STATS) are returned. Possible values: TABLE_METADATA_VIEW_UNSPECIFIED, BASIC, STORAGE_STATS, FULL tableReplicationInfo Replication info of a table created timePartitioning If specified, configures time-based type Describes the table type. view If specified, configures this table as a view.
const
TableState.fromMap(Map<String, dynamic> map)
factory

Properties

biglakeConfiguration → Input<TableBiglakeConfiguration?>?
Specifies the configuration of a BigLake managed table. Structure is documented below
final
clusterings → Input<List<String>?>?
Specifies column names to use for data clustering. Up to four top-level columns are allowed, and should be specified in descending priority order.
final
creationTime → Input<int?>?
The time when this table was created, in milliseconds since the epoch.
final
datasetId → Input<String?>?
The dataset ID to create the table in. Changing this forces a new resource to be created.
final
deletionPolicy → Input<String?>?
(Optional) Whether Terraform will be prevented from destroying the resource. Defaults to "DELETE". When a 'terraform destroy' or 'pulumi up' would delete the resource, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", deleting the resource is allowed.
final
deletionProtection → Input<bool?>?
Whether or not to allow the provider to destroy the instance. Unless this field is set to false in state, a =destroy or =update that would delete the instance will fail.
final
description → Input<String?>?
The field description.
final
effectiveLabels → Input<Map<String, String>?>?
All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
final
encryptionConfiguration → Input<TableEncryptionConfiguration?>?
Specifies how the table should be encrypted. If left blank, the table will be encrypted with a Google-managed key; that process is transparent to the user. Structure is documented below.
final
etag → Input<String?>?
A hash of the resource.
final
expirationTime → Input<int?>?
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.
final
externalCatalogTableOptions → Input<TableExternalCatalogTableOptions?>?
Options defining open source compatible table. Structure is documented below.
final
externalDataConfiguration → Input<TableExternalDataConfiguration?>?
Describes the data format, location, and other properties of a table stored outside of BigQuery. By defining these properties, the data source can then be queried as if it were a standard BigQuery table. Structure is documented below.
final
friendlyName → Input<String?>?
A descriptive name for the table.
final
generatedSchemaColumns → Input<String?>?
(Output-only) A list of autogenerated schema fields.
final
hashCode → int
The hash code for this object.
no setterinherited
ignoreAutoGeneratedSchema → Input<bool?>?
If true, Terraform will prevent columns added by the server(e.g. hive partitioned columns) in schema from showing diff.
final
ignoreSchemaChanges → Input<List<String>?>?
A list of fields which would act non-authoritative for each column in schema. NOTE: Right now only dataPolicies field is supported(others might be supported in the future). It means that any dataPolicies updated outside terraform will be ignored if this option is used. If there is no policy in config for a column but there are in live state, the policy will persist. If the policy in config is updated, it will override the policy in the live state. Other fields like description for a column will keep behaving as they are(authoritatively).
final
labels → Input<Map<String, String>?>?
A mapping of labels to assign to the resource.
final
lastModifiedTime → Input<int?>?
The time when this table was last modified, in milliseconds since the epoch.
final
location → Input<String?>?
The geographic location where the table resides. This value is inherited from the dataset.
final
materializedView → Input<TableMaterializedView?>?
If specified, configures this table as a materialized view. Structure is documented below.
final
maxStaleness → Input<String?>?
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.
final
numBytes → Input<int?>?
The size of this table in bytes, excluding any data in the streaming buffer.
final
numLongTermBytes → Input<int?>?
The number of bytes in the table that are considered "long-term storage".
final
numRows → Input<int?>?
The number of rows of data in this table, excluding any data in the streaming buffer.
final
project → Input<String?>?
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
final
pulumiLabels → Input<Map<String, String>?>?
The combination of labels configured directly on the resource and default labels configured on the provider.
final
rangePartitioning → Input<TableRangePartitioning?>?
If specified, configures range-based partitioning for this table. Structure is documented below.
final
requirePartitionFilter → Input<bool?>?
If set to true, queries over this table require a partition filter that can be used for partition elimination to be specified.
final
resourceTags → Input<Map<String, String>?>?
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". See Tag definitions for more details.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
schema → Input<String?>?
A JSON schema for the table.
final
schemaForeignTypeInfo → Input<TableSchemaForeignTypeInfo?>?
Specifies metadata of the foreign data type definition in field schema. Structure is documented below.
final
The URI of the created resource.
final
tableConstraints → Input<TableTableConstraints?>?
Defines the primary key and foreign keys. Structure is documented below.
final
tableId → Input<String?>?
A unique ID for the resource. Changing this forces a new resource to be created.
final
tableMetadataView → Input<String?>?
View sets the optional parameter "view": Specifies the view that determines which table information is returned. By default, basic table information and storage statistics (STORAGE_STATS) are returned. Possible values: TABLE_METADATA_VIEW_UNSPECIFIED, BASIC, STORAGE_STATS, FULL
final
tableReplicationInfo → Input<TableTableReplicationInfo?>?
Replication info of a table created using "AS REPLICA" DDL like: CREATE MATERIALIZED VIEW mv1 AS REPLICA OF srcMv. Structure is documented below.
final
timePartitioning → Input<TableTimePartitioning?>?
If specified, configures time-based partitioning for this table. Structure is documented below.
final
type → Input<String?>?
Describes the table type.
final
view → Input<TableView?>?
If specified, configures this table as a view. Structure is documented below.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toMap() → Map<String, dynamic>
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited