Table class

Creates a new, empty table in the dataset. Auto-naming is currently not supported for this resource.

Constructors

Table(String name, {TableArgs? args, CustomResourceOptions? options})

Creates a new Table. name The Pulumi resource name. args Arguments used to configure this Table. The set of arguments for Table. options Resource options controlling this resource's behavior.

Properties

biglakeConfiguration ↔ Output<BigLakeConfigurationResponse>

Optional Specifies the configuration of a BigLake managed table.

late, final

childResources → Set<Resource>

final, inherited

cloneDefinition ↔ Output<CloneDefinitionResponse>

Clone definition.

late, final

clustering ↔ Output<ClusteringResponse>

Beta Clustering specification for the table. Must be specified with partitioning, data in the table will be first partitioned and subsequently clustered.

late, final

completionSources ↔ Map<String, IOutputCompletionSource>

late, final, inherited

creationTime ↔ Output<String>

The time when this table was created, in milliseconds since the epoch.

late, final

datasetId ↔ Output<String>

late, final

defaultCollation ↔ Output<String>

The default collation of the table.

late, final

defaultRoundingMode ↔ Output<String>

The default rounding mode of the table.

late, final

description ↔ Output<String>

Optional A user-friendly description of this table.

late, final

encryptionConfiguration ↔ Output<EncryptionConfigurationResponse>

Custom encryption configuration (e.g., Cloud KMS keys).

late, final

etag ↔ Output<String>

A hash of the table metadata. Used to ensure there were no concurrent modifications to the resource when attempting an update. Not guaranteed to change when the table contents or the fields numRows, numBytes, numLongTermBytes or lastModifiedTime change.

late, final

expirationTime ↔ Output<String>

Optional 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. The defaultTableExpirationMs property of the encapsulating dataset can be used to set a default expirationTime on newly created tables.

late, final

externalDataConfiguration ↔ Output<ExternalDataConfigurationResponse>

Optional 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.

late, final

friendlyName ↔ Output<String>

Optional A descriptive name for this table.

late, final

hashCode → int

The hash code for this object.

no setter, inherited

id ↔ Output<String>

getter/setter pair, inherited

isCustom → bool

Returns whether this resource is provider-managed.

no setter, inherited

isProtected → bool

Returns whether this resource is protected from deletion.

no setter, inherited

isRemote → bool

Whether this resource is registered as remote.

no setter, inherited

isResourceReference → bool

Whether this instance represents a resource value returned over RPC.

final, inherited

kind ↔ Output<String>

The type of the resource.

late, final

labels ↔ Output<Map<String, String>>

The labels associated with this table. You can use these to organize and group your tables. Label keys and values can be no longer than 63 characters, can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter and each label in the list must have a different key.

late, final

lastModifiedTime ↔ Output<String>

The time when this table was last modified, in milliseconds since the epoch.

late, final

location ↔ Output<String>

The geographic location where the table resides. This value is inherited from the dataset.

late, final

materializedView ↔ Output<MaterializedViewDefinitionResponse>

Optional Materialized view definition.

late, final

maxStaleness ↔ Output<String>

Optional Max staleness of data that could be returned when table or materialized view is queried (formatted as Google SQL Interval type).

late, final

model ↔ Output<ModelDefinitionResponse>

Output-only, Beta Present iff this table represents a ML model. Describes the training information for the model, and it is required to run 'PREDICT' queries.

late, final

numActiveLogicalBytes ↔ Output<String>

Number of logical bytes that are less than 90 days old.

late, final

numActivePhysicalBytes ↔ Output<String>

Number of physical bytes less than 90 days old. This data is not kept in real time, and might be delayed by a few seconds to a few minutes.

late, final

numBytes ↔ Output<String>

The size of this table in bytes, excluding any data in the streaming buffer.

late, final

numLongTermBytes ↔ Output<String>

The number of bytes in the table that are considered "long-term storage".

late, final

numLongTermLogicalBytes ↔ Output<String>

Number of logical bytes that are more than 90 days old.

late, final

numLongTermPhysicalBytes ↔ Output<String>

Number of physical bytes more than 90 days old. This data is not kept in real time, and might be delayed by a few seconds to a few minutes.

late, final

numPartitions ↔ Output<String>

The number of partitions present in the table or materialized view. This data is not kept in real time, and might be delayed by a few seconds to a few minutes.

late, final

numPhysicalBytes ↔ Output<String>

TrustedTester The physical size of this table in bytes, excluding any data in the streaming buffer. This includes compression and storage used for time travel.

late, final

numRows ↔ Output<String>

The number of rows of data in this table, excluding any data in the streaming buffer.

late, final

numTimeTravelPhysicalBytes ↔ Output<String>

Number of physical bytes used by time travel storage (deleted or changed data). This data is not kept in real time, and might be delayed by a few seconds to a few minutes.

late, final

numTotalLogicalBytes ↔ Output<String>

Total number of logical bytes in the table or materialized view.

late, final

numTotalPhysicalBytes ↔ Output<String>

The physical size of this table in bytes. This also includes storage used for time travel. This data is not kept in real time, and might be delayed by a few seconds to a few minutes.

late, final

project ↔ Output<String>

late, final

rangePartitioning ↔ Output<RangePartitioningResponse>

TrustedTester Range partitioning specification for this table. Only one of timePartitioning and rangePartitioning should be specified.

late, final

requirePartitionFilter ↔ Output<bool>

Optional If set to true, queries over this table require a partition filter that can be used for partition elimination to be specified.

late, final

resourceTags ↔ Output<Map<String, String>>

Optional The tags associated with this table. Tag keys are globally unique. See additional information on tags. An object containing a list of "key": value pairs. The key is the namespaced friendly name of the tag key, e.g. "12345/environment" where 12345 is parent id. The value is the friendly short name of the tag value, e.g. "production".

late, final

resourceTransforms → List<ResourceTransform>

Inherited/explicit async transforms.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

schema ↔ Output<TableSchemaResponse>

Optional Describes the schema of this table.

late, final

selfLink ↔ Output<String>

A URL that can be used to access this resource again.

late, final

snapshotDefinition ↔ Output<SnapshotDefinitionResponse>

Snapshot definition.

late, final

streamingBuffer ↔ Output<StreamingbufferResponse>

Contains information regarding this table's streaming buffer, if one is present. This field will be absent if the table is not being streamed to or if there is no data in the streaming buffer.

late, final

tableConstraints ↔ Output<TableConstraintsResponse>

Optional The table constraints on the table.

late, final

tableReference ↔ Output<TableReferenceResponse>

Required Reference describing the ID of this table.

late, final

timePartitioning ↔ Output<TimePartitioningResponse>

Time-based partitioning specification for this table. Only one of timePartitioning and rangePartitioning should be specified.

late, final

transformations → List<ResourceTransformation>

Inherited/explicit legacy transformations.

no setter, inherited

type ↔ Output<String>

Describes the table type. The following values are supported: TABLE: A normal BigQuery table. VIEW: A virtual table defined by a SQL query. SNAPSHOT: An immutable, read-only table that is a copy of another table. TrustedTester MATERIALIZED_VIEW: SQL query whose result is persisted. EXTERNAL: A table that references data stored in an external storage system, such as Google Cloud Storage. The default value is TABLE.

late, final

urn ↔ Output<String>

late, final, inherited

view ↔ Output<ViewDefinitionResponse>

Optional The view definition.

late, final

Methods

failId(Object error) → void

Completes this resource ID with an error when registration fails.

inherited

failOutputs(Object error) → void

Completes all output properties with error.

inherited

failUrn(Object error) → void

Completes this resource URN with an error when registration fails.

inherited

getProvider(String moduleMember) → ProviderResource?

Returns provider for moduleMember's package, if configured.

inherited

getResourceName() → String

Returns this resource's logical name.

inherited

getResourceType() → String

Returns this resource's Pulumi type token.

inherited

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>

Registers a dynamic output property for this resource.

inherited

resolveId(String? value, {required bool isKnown}) → void

Resolves the provider-assigned ID for this resource.

inherited

resolveOutputs(Struct outputs) → void

Resolves all output properties from a monitor response payload.

inherited

resolveUrn(String value) → void

Resolves this resource's URN once assigned by the engine.

inherited

serializeProperties(Map<String, dynamic> properties) → Future<Struct>

Serializes resource properties for RPC transmission.

inherited

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited