google-native.bigquery/v2.getTable

func LookupTable(ctx *Context, args *LookupTableArgs, opts ...InvokeOption) (*LookupTableResult, error)
func LookupTableOutput(ctx *Context, args *LookupTableOutputArgs, opts ...InvokeOption) LookupTableResultOutput

> Note: This function is named LookupTable in the Go SDK.

DatasetId string

TableId string

Project string

SelectedFields string

View string

DatasetId string

TableId string

Project string

SelectedFields string

View string

datasetId String

tableId String

project String

selectedFields String

view String

datasetId string

tableId string

project string

selectedFields string

view string

dataset_id str

table_id str

project str

selected_fields str

view str

datasetId String

tableId String

project String

selectedFields String

view String

BiglakeConfiguration Pulumi.GoogleNative.BigQuery.V2.Outputs.BigLakeConfigurationResponse

[Optional] Specifies the configuration of a BigLake managed table.

CloneDefinition Pulumi.GoogleNative.BigQuery.V2.Outputs.CloneDefinitionResponse

Clone definition.

Clustering Pulumi.GoogleNative.BigQuery.V2.Outputs.ClusteringResponse

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

CreationTime string

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

DefaultCollation string

The default collation of the table.

DefaultRoundingMode string

The default rounding mode of the table.

Description string

[Optional] A user-friendly description of this table.

EncryptionConfiguration Pulumi.GoogleNative.BigQuery.V2.Outputs.EncryptionConfigurationResponse

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

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

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

ExternalDataConfiguration Pulumi.GoogleNative.BigQuery.V2.Outputs.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.

FriendlyName string

[Optional] A descriptive name for this table.

Kind string

The type of the resource.

Labels Dictionary<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.

LastModifiedTime string

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

Location string

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

MaterializedView Pulumi.GoogleNative.BigQuery.V2.Outputs.MaterializedViewDefinitionResponse

[Optional] Materialized view definition.

MaxStaleness string

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

Model Pulumi.GoogleNative.BigQuery.V2.Outputs.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.

NumActiveLogicalBytes string

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

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

NumBytes string

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

NumLongTermBytes string

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

NumLongTermLogicalBytes string

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

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

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

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

NumRows string

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

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

NumTotalLogicalBytes string

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

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

RangePartitioning Pulumi.GoogleNative.BigQuery.V2.Outputs.RangePartitioningResponse

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

RequirePartitionFilter bool

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

ResourceTags Dictionary<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".

Schema Pulumi.GoogleNative.BigQuery.V2.Outputs.TableSchemaResponse

[Optional] Describes the schema of this table.

SelfLink string

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

SnapshotDefinition Pulumi.GoogleNative.BigQuery.V2.Outputs.SnapshotDefinitionResponse

Snapshot definition.

StreamingBuffer Pulumi.GoogleNative.BigQuery.V2.Outputs.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.

TableConstraints Pulumi.GoogleNative.BigQuery.V2.Outputs.TableConstraintsResponse

[Optional] The table constraints on the table.

TableReference Pulumi.GoogleNative.BigQuery.V2.Outputs.TableReferenceResponse

[Required] Reference describing the ID of this table.

TimePartitioning Pulumi.GoogleNative.BigQuery.V2.Outputs.TimePartitioningResponse

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

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

View Pulumi.GoogleNative.BigQuery.V2.Outputs.ViewDefinitionResponse

[Optional] The view definition.

BiglakeConfiguration BigLakeConfigurationResponse

[Optional] Specifies the configuration of a BigLake managed table.

CloneDefinition CloneDefinitionResponse

Clone definition.

Clustering ClusteringResponse

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

CreationTime string

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

DefaultCollation string

The default collation of the table.

DefaultRoundingMode string

The default rounding mode of the table.

Description string

[Optional] A user-friendly description of this table.

EncryptionConfiguration EncryptionConfigurationResponse

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

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

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

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

FriendlyName string

[Optional] A descriptive name for this table.

Kind string

The type of the resource.

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

LastModifiedTime string

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

Location string

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

MaterializedView MaterializedViewDefinitionResponse

[Optional] Materialized view definition.

MaxStaleness string

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

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

NumActiveLogicalBytes string

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

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

NumBytes string

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

NumLongTermBytes string

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

NumLongTermLogicalBytes string

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

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

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

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

NumRows string

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

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

NumTotalLogicalBytes string

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

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

RangePartitioning RangePartitioningResponse

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

RequirePartitionFilter bool

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

ResourceTags 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".

Schema TableSchemaResponse

[Optional] Describes the schema of this table.

SelfLink string

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

SnapshotDefinition SnapshotDefinitionResponse

Snapshot definition.

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

TableConstraints TableConstraintsResponse

[Optional] The table constraints on the table.

TableReference TableReferenceResponse

[Required] Reference describing the ID of this table.

TimePartitioning TimePartitioningResponse

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

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

View ViewDefinitionResponse

[Optional] The view definition.

biglakeConfiguration BigLakeConfigurationResponse

[Optional] Specifies the configuration of a BigLake managed table.

cloneDefinition CloneDefinitionResponse

Clone definition.

clustering ClusteringResponse

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

creationTime String

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

defaultCollation String

The default collation of the table.

defaultRoundingMode String

The default rounding mode of the table.

description String

[Optional] A user-friendly description of this table.

encryptionConfiguration EncryptionConfigurationResponse

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

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

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

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

friendlyName String

[Optional] A descriptive name for this table.

kind String

The type of the resource.

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

lastModifiedTime String

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

location String

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

materializedView MaterializedViewDefinitionResponse

[Optional] Materialized view definition.

maxStaleness String

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

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

numActiveLogicalBytes String

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

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

numBytes String

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

numLongTermBytes String

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

numLongTermLogicalBytes String

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

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

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

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

numRows String

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

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

numTotalLogicalBytes String

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

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

rangePartitioning RangePartitioningResponse

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

requirePartitionFilter Boolean

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

resourceTags 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".

schema TableSchemaResponse

[Optional] Describes the schema of this table.

selfLink String

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

snapshotDefinition SnapshotDefinitionResponse

Snapshot definition.

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

tableConstraints TableConstraintsResponse

[Optional] The table constraints on the table.

tableReference TableReferenceResponse

[Required] Reference describing the ID of this table.

timePartitioning TimePartitioningResponse

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

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

view ViewDefinitionResponse

[Optional] The view definition.

biglakeConfiguration BigLakeConfigurationResponse

[Optional] Specifies the configuration of a BigLake managed table.

cloneDefinition CloneDefinitionResponse

Clone definition.

clustering ClusteringResponse

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

creationTime string

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

defaultCollation string

The default collation of the table.

defaultRoundingMode string

The default rounding mode of the table.

description string

[Optional] A user-friendly description of this table.

encryptionConfiguration EncryptionConfigurationResponse

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

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

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

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

friendlyName string

[Optional] A descriptive name for this table.

kind string

The type of the resource.

labels {[key: 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.

lastModifiedTime string

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

location string

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

materializedView MaterializedViewDefinitionResponse

[Optional] Materialized view definition.

maxStaleness string

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

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

numActiveLogicalBytes string

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

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

numBytes string

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

numLongTermBytes string

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

numLongTermLogicalBytes string

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

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

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

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

numRows string

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

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

numTotalLogicalBytes string

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

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

rangePartitioning RangePartitioningResponse

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

requirePartitionFilter boolean

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

resourceTags {[key: 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".

schema TableSchemaResponse

[Optional] Describes the schema of this table.

selfLink string

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

snapshotDefinition SnapshotDefinitionResponse

Snapshot definition.

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

tableConstraints TableConstraintsResponse

[Optional] The table constraints on the table.

tableReference TableReferenceResponse

[Required] Reference describing the ID of this table.

timePartitioning TimePartitioningResponse

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

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

view ViewDefinitionResponse

[Optional] The view definition.

biglake_configuration BigLakeConfigurationResponse

[Optional] Specifies the configuration of a BigLake managed table.

clone_definition CloneDefinitionResponse

Clone definition.

clustering ClusteringResponse

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

creation_time str

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

default_collation str

The default collation of the table.

default_rounding_mode str

The default rounding mode of the table.

description str

[Optional] A user-friendly description of this table.

encryption_configuration EncryptionConfigurationResponse

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

etag str

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.

expiration_time str

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

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

friendly_name str

[Optional] A descriptive name for this table.

kind str

The type of the resource.

labels Mapping[str, str]

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.

last_modified_time str

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

location str

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

materialized_view MaterializedViewDefinitionResponse

[Optional] Materialized view definition.

max_staleness str

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

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

num_active_logical_bytes str

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

num_active_physical_bytes str

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.

num_bytes str

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

num_long_term_bytes str

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

num_long_term_logical_bytes str

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

num_long_term_physical_bytes str

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.

num_partitions str

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.

num_physical_bytes str

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

num_rows str

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

num_time_travel_physical_bytes str

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.

num_total_logical_bytes str

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

num_total_physical_bytes str

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.

range_partitioning RangePartitioningResponse

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

require_partition_filter bool

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

resource_tags Mapping[str, str]

[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".

schema TableSchemaResponse

[Optional] Describes the schema of this table.

self_link str

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

snapshot_definition SnapshotDefinitionResponse

Snapshot definition.

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

table_constraints TableConstraintsResponse

[Optional] The table constraints on the table.

table_reference TableReferenceResponse

[Required] Reference describing the ID of this table.

time_partitioning TimePartitioningResponse

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

type str

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.

view ViewDefinitionResponse

[Optional] The view definition.

biglakeConfiguration Property Map

[Optional] Specifies the configuration of a BigLake managed table.

cloneDefinition Property Map

Clone definition.

clustering Property Map

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

creationTime String

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

defaultCollation String

The default collation of the table.

defaultRoundingMode String

The default rounding mode of the table.

description String

[Optional] A user-friendly description of this table.

encryptionConfiguration Property Map

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

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

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

externalDataConfiguration Property Map

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

friendlyName String

[Optional] A descriptive name for this table.

kind String

The type of the resource.

labels Map<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.

lastModifiedTime String

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

location String

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

materializedView Property Map

[Optional] Materialized view definition.

maxStaleness String

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

model Property Map

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

numActiveLogicalBytes String

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

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

numBytes String

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

numLongTermBytes String

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

numLongTermLogicalBytes String

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

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

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

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

numRows String

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

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

numTotalLogicalBytes String

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

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

rangePartitioning Property Map

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

requirePartitionFilter Boolean

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

resourceTags Map<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".

schema Property Map

[Optional] Describes the schema of this table.

selfLink String

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

snapshotDefinition Property Map

Snapshot definition.

streamingBuffer Property Map

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.

tableConstraints Property Map

[Optional] The table constraints on the table.

tableReference Property Map

[Required] Reference describing the ID of this table.

timePartitioning Property Map

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

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

view Property Map

[Optional] The view definition.

UseAvroLogicalTypes bool

[Optional] If sourceFormat is set to "AVRO", indicates whether to interpret logical types as the corresponding BigQuery data type (for example, TIMESTAMP), instead of using the raw type (for example, INTEGER).

UseAvroLogicalTypes bool

[Optional] If sourceFormat is set to "AVRO", indicates whether to interpret logical types as the corresponding BigQuery data type (for example, TIMESTAMP), instead of using the raw type (for example, INTEGER).

useAvroLogicalTypes Boolean

[Optional] If sourceFormat is set to "AVRO", indicates whether to interpret logical types as the corresponding BigQuery data type (for example, TIMESTAMP), instead of using the raw type (for example, INTEGER).

useAvroLogicalTypes boolean

[Optional] If sourceFormat is set to "AVRO", indicates whether to interpret logical types as the corresponding BigQuery data type (for example, TIMESTAMP), instead of using the raw type (for example, INTEGER).

use_avro_logical_types bool

[Optional] If sourceFormat is set to "AVRO", indicates whether to interpret logical types as the corresponding BigQuery data type (for example, TIMESTAMP), instead of using the raw type (for example, INTEGER).

useAvroLogicalTypes Boolean

[Optional] If sourceFormat is set to "AVRO", indicates whether to interpret logical types as the corresponding BigQuery data type (for example, TIMESTAMP), instead of using the raw type (for example, INTEGER).

ConnectionId string

[Required] Required and immutable. Credential reference for accessing external storage system. Normalized as project_id.location_id.connection_id.

FileFormat string

[Required] Required and immutable. Open source file format that the table data is stored in. Currently only PARQUET is supported.

StorageUri string

[Required] Required and immutable. Fully qualified location prefix of the external folder where data is stored. Normalized to standard format: "gs:////". Starts with "gs://" rather than "/bigstore/". Ends with "/". Does not contain "*". See also BigLakeStorageMetadata on how it is used.

TableFormat string

[Required] Required and immutable. Open source file format that the table data is stored in. Currently only PARQUET is supported.

ConnectionId string

[Required] Required and immutable. Credential reference for accessing external storage system. Normalized as project_id.location_id.connection_id.

FileFormat string

[Required] Required and immutable. Open source file format that the table data is stored in. Currently only PARQUET is supported.

StorageUri string

[Required] Required and immutable. Fully qualified location prefix of the external folder where data is stored. Normalized to standard format: "gs:////". Starts with "gs://" rather than "/bigstore/". Ends with "/". Does not contain "*". See also BigLakeStorageMetadata on how it is used.

TableFormat string

[Required] Required and immutable. Open source file format that the table data is stored in. Currently only PARQUET is supported.

connectionId String

[Required] Required and immutable. Credential reference for accessing external storage system. Normalized as project_id.location_id.connection_id.

fileFormat String

[Required] Required and immutable. Open source file format that the table data is stored in. Currently only PARQUET is supported.

storageUri String

[Required] Required and immutable. Fully qualified location prefix of the external folder where data is stored. Normalized to standard format: "gs:////". Starts with "gs://" rather than "/bigstore/". Ends with "/". Does not contain "*". See also BigLakeStorageMetadata on how it is used.

tableFormat String

[Required] Required and immutable. Open source file format that the table data is stored in. Currently only PARQUET is supported.

connectionId string

[Required] Required and immutable. Credential reference for accessing external storage system. Normalized as project_id.location_id.connection_id.

fileFormat string

[Required] Required and immutable. Open source file format that the table data is stored in. Currently only PARQUET is supported.

storageUri string

[Required] Required and immutable. Fully qualified location prefix of the external folder where data is stored. Normalized to standard format: "gs:////". Starts with "gs://" rather than "/bigstore/". Ends with "/". Does not contain "*". See also BigLakeStorageMetadata on how it is used.

tableFormat string

[Required] Required and immutable. Open source file format that the table data is stored in. Currently only PARQUET is supported.

connection_id str

[Required] Required and immutable. Credential reference for accessing external storage system. Normalized as project_id.location_id.connection_id.

file_format str

[Required] Required and immutable. Open source file format that the table data is stored in. Currently only PARQUET is supported.

storage_uri str

[Required] Required and immutable. Fully qualified location prefix of the external folder where data is stored. Normalized to standard format: "gs:////". Starts with "gs://" rather than "/bigstore/". Ends with "/". Does not contain "*". See also BigLakeStorageMetadata on how it is used.

table_format str

[Required] Required and immutable. Open source file format that the table data is stored in. Currently only PARQUET is supported.

connectionId String

[Required] Required and immutable. Credential reference for accessing external storage system. Normalized as project_id.location_id.connection_id.

fileFormat String

[Required] Required and immutable. Open source file format that the table data is stored in. Currently only PARQUET is supported.

storageUri String

[Required] Required and immutable. Fully qualified location prefix of the external folder where data is stored. Normalized to standard format: "gs:////". Starts with "gs://" rather than "/bigstore/". Ends with "/". Does not contain "*". See also BigLakeStorageMetadata on how it is used.

tableFormat String

[Required] Required and immutable. Open source file format that the table data is stored in. Currently only PARQUET is supported.

Columns List<Pulumi.GoogleNative.BigQuery.V2.Inputs.BigtableColumnResponse>

[Optional] Lists of columns that should be exposed as individual fields as opposed to a list of (column name, value) pairs. All columns whose qualifier matches a qualifier in this list can be accessed as .. Other columns can be accessed as a list through .Column field.

Encoding string

[Optional] The encoding of the values when the type is not STRING. Acceptable encoding values are: TEXT - indicates values are alphanumeric text strings. BINARY - indicates values are encoded using HBase Bytes.toBytes family of functions. This can be overridden for a specific column by listing that column in 'columns' and specifying an encoding for it.

FamilyId string

Identifier of the column family.

OnlyReadLatest bool

[Optional] If this is set only the latest version of value are exposed for all columns in this column family. This can be overridden for a specific column by listing that column in 'columns' and specifying a different setting for that column.

Type string

[Optional] The type to convert the value in cells of this column family. The values are expected to be encoded using HBase Bytes.toBytes function when using the BINARY encoding value. Following BigQuery types are allowed (case-sensitive) - BYTES STRING INTEGER FLOAT BOOLEAN Default type is BYTES. This can be overridden for a specific column by listing that column in 'columns' and specifying a type for it.

Columns []BigtableColumnResponse

[Optional] Lists of columns that should be exposed as individual fields as opposed to a list of (column name, value) pairs. All columns whose qualifier matches a qualifier in this list can be accessed as .. Other columns can be accessed as a list through .Column field.

Encoding string

[Optional] The encoding of the values when the type is not STRING. Acceptable encoding values are: TEXT - indicates values are alphanumeric text strings. BINARY - indicates values are encoded using HBase Bytes.toBytes family of functions. This can be overridden for a specific column by listing that column in 'columns' and specifying an encoding for it.

FamilyId string

Identifier of the column family.

OnlyReadLatest bool

[Optional] If this is set only the latest version of value are exposed for all columns in this column family. This can be overridden for a specific column by listing that column in 'columns' and specifying a different setting for that column.

Type string

[Optional] The type to convert the value in cells of this column family. The values are expected to be encoded using HBase Bytes.toBytes function when using the BINARY encoding value. Following BigQuery types are allowed (case-sensitive) - BYTES STRING INTEGER FLOAT BOOLEAN Default type is BYTES. This can be overridden for a specific column by listing that column in 'columns' and specifying a type for it.

columns List<BigtableColumnResponse>

[Optional] Lists of columns that should be exposed as individual fields as opposed to a list of (column name, value) pairs. All columns whose qualifier matches a qualifier in this list can be accessed as .. Other columns can be accessed as a list through .Column field.

encoding String

[Optional] The encoding of the values when the type is not STRING. Acceptable encoding values are: TEXT - indicates values are alphanumeric text strings. BINARY - indicates values are encoded using HBase Bytes.toBytes family of functions. This can be overridden for a specific column by listing that column in 'columns' and specifying an encoding for it.

familyId String

Identifier of the column family.

onlyReadLatest Boolean

[Optional] If this is set only the latest version of value are exposed for all columns in this column family. This can be overridden for a specific column by listing that column in 'columns' and specifying a different setting for that column.

type String

[Optional] The type to convert the value in cells of this column family. The values are expected to be encoded using HBase Bytes.toBytes function when using the BINARY encoding value. Following BigQuery types are allowed (case-sensitive) - BYTES STRING INTEGER FLOAT BOOLEAN Default type is BYTES. This can be overridden for a specific column by listing that column in 'columns' and specifying a type for it.

columns BigtableColumnResponse[]

[Optional] Lists of columns that should be exposed as individual fields as opposed to a list of (column name, value) pairs. All columns whose qualifier matches a qualifier in this list can be accessed as .. Other columns can be accessed as a list through .Column field.

encoding string

[Optional] The encoding of the values when the type is not STRING. Acceptable encoding values are: TEXT - indicates values are alphanumeric text strings. BINARY - indicates values are encoded using HBase Bytes.toBytes family of functions. This can be overridden for a specific column by listing that column in 'columns' and specifying an encoding for it.

familyId string

Identifier of the column family.

onlyReadLatest boolean

[Optional] If this is set only the latest version of value are exposed for all columns in this column family. This can be overridden for a specific column by listing that column in 'columns' and specifying a different setting for that column.

type string

[Optional] The type to convert the value in cells of this column family. The values are expected to be encoded using HBase Bytes.toBytes function when using the BINARY encoding value. Following BigQuery types are allowed (case-sensitive) - BYTES STRING INTEGER FLOAT BOOLEAN Default type is BYTES. This can be overridden for a specific column by listing that column in 'columns' and specifying a type for it.

columns Sequence[BigtableColumnResponse]

[Optional] Lists of columns that should be exposed as individual fields as opposed to a list of (column name, value) pairs. All columns whose qualifier matches a qualifier in this list can be accessed as .. Other columns can be accessed as a list through .Column field.

encoding str

[Optional] The encoding of the values when the type is not STRING. Acceptable encoding values are: TEXT - indicates values are alphanumeric text strings. BINARY - indicates values are encoded using HBase Bytes.toBytes family of functions. This can be overridden for a specific column by listing that column in 'columns' and specifying an encoding for it.

family_id str

Identifier of the column family.

only_read_latest bool

[Optional] If this is set only the latest version of value are exposed for all columns in this column family. This can be overridden for a specific column by listing that column in 'columns' and specifying a different setting for that column.

type str

[Optional] The type to convert the value in cells of this column family. The values are expected to be encoded using HBase Bytes.toBytes function when using the BINARY encoding value. Following BigQuery types are allowed (case-sensitive) - BYTES STRING INTEGER FLOAT BOOLEAN Default type is BYTES. This can be overridden for a specific column by listing that column in 'columns' and specifying a type for it.

columns List<Property Map>

[Optional] Lists of columns that should be exposed as individual fields as opposed to a list of (column name, value) pairs. All columns whose qualifier matches a qualifier in this list can be accessed as .. Other columns can be accessed as a list through .Column field.

encoding String

[Optional] The encoding of the values when the type is not STRING. Acceptable encoding values are: TEXT - indicates values are alphanumeric text strings. BINARY - indicates values are encoded using HBase Bytes.toBytes family of functions. This can be overridden for a specific column by listing that column in 'columns' and specifying an encoding for it.

familyId String

Identifier of the column family.

onlyReadLatest Boolean

[Optional] If this is set only the latest version of value are exposed for all columns in this column family. This can be overridden for a specific column by listing that column in 'columns' and specifying a different setting for that column.

type String

[Optional] The type to convert the value in cells of this column family. The values are expected to be encoded using HBase Bytes.toBytes function when using the BINARY encoding value. Following BigQuery types are allowed (case-sensitive) - BYTES STRING INTEGER FLOAT BOOLEAN Default type is BYTES. This can be overridden for a specific column by listing that column in 'columns' and specifying a type for it.

Encoding string

[Optional] The encoding of the values when the type is not STRING. Acceptable encoding values are: TEXT - indicates values are alphanumeric text strings. BINARY - indicates values are encoded using HBase Bytes.toBytes family of functions. 'encoding' can also be set at the column family level. However, the setting at this level takes precedence if 'encoding' is set at both levels.

FieldName string

[Optional] If the qualifier is not a valid BigQuery field identifier i.e. does not match [a-zA-Z][a-zA-Z0-9_]*, a valid identifier must be provided as the column field name and is used as field name in queries.

OnlyReadLatest bool

[Optional] If this is set, only the latest version of value in this column are exposed. 'onlyReadLatest' can also be set at the column family level. However, the setting at this level takes precedence if 'onlyReadLatest' is set at both levels.

QualifierEncoded string

[Required] Qualifier of the column. Columns in the parent column family that has this exact qualifier are exposed as . field. If the qualifier is valid UTF-8 string, it can be specified in the qualifier_string field. Otherwise, a base-64 encoded value must be set to qualifier_encoded. The column field name is the same as the column qualifier. However, if the qualifier is not a valid BigQuery field identifier i.e. does not match [a-zA-Z][a-zA-Z0-9_]*, a valid identifier must be provided as field_name.

QualifierString string

Type string

[Optional] The type to convert the value in cells of this column. The values are expected to be encoded using HBase Bytes.toBytes function when using the BINARY encoding value. Following BigQuery types are allowed (case-sensitive) - BYTES STRING INTEGER FLOAT BOOLEAN Default type is BYTES. 'type' can also be set at the column family level. However, the setting at this level takes precedence if 'type' is set at both levels.

Encoding string

[Optional] The encoding of the values when the type is not STRING. Acceptable encoding values are: TEXT - indicates values are alphanumeric text strings. BINARY - indicates values are encoded using HBase Bytes.toBytes family of functions. 'encoding' can also be set at the column family level. However, the setting at this level takes precedence if 'encoding' is set at both levels.

FieldName string

[Optional] If the qualifier is not a valid BigQuery field identifier i.e. does not match [a-zA-Z][a-zA-Z0-9_]*, a valid identifier must be provided as the column field name and is used as field name in queries.

OnlyReadLatest bool

[Optional] If this is set, only the latest version of value in this column are exposed. 'onlyReadLatest' can also be set at the column family level. However, the setting at this level takes precedence if 'onlyReadLatest' is set at both levels.

QualifierEncoded string

[Required] Qualifier of the column. Columns in the parent column family that has this exact qualifier are exposed as . field. If the qualifier is valid UTF-8 string, it can be specified in the qualifier_string field. Otherwise, a base-64 encoded value must be set to qualifier_encoded. The column field name is the same as the column qualifier. However, if the qualifier is not a valid BigQuery field identifier i.e. does not match [a-zA-Z][a-zA-Z0-9_]*, a valid identifier must be provided as field_name.

QualifierString string

Type string

[Optional] The type to convert the value in cells of this column. The values are expected to be encoded using HBase Bytes.toBytes function when using the BINARY encoding value. Following BigQuery types are allowed (case-sensitive) - BYTES STRING INTEGER FLOAT BOOLEAN Default type is BYTES. 'type' can also be set at the column family level. However, the setting at this level takes precedence if 'type' is set at both levels.

encoding String

[Optional] The encoding of the values when the type is not STRING. Acceptable encoding values are: TEXT - indicates values are alphanumeric text strings. BINARY - indicates values are encoded using HBase Bytes.toBytes family of functions. 'encoding' can also be set at the column family level. However, the setting at this level takes precedence if 'encoding' is set at both levels.

fieldName String

[Optional] If the qualifier is not a valid BigQuery field identifier i.e. does not match [a-zA-Z][a-zA-Z0-9_]*, a valid identifier must be provided as the column field name and is used as field name in queries.

onlyReadLatest Boolean

[Optional] If this is set, only the latest version of value in this column are exposed. 'onlyReadLatest' can also be set at the column family level. However, the setting at this level takes precedence if 'onlyReadLatest' is set at both levels.

qualifierEncoded String

[Required] Qualifier of the column. Columns in the parent column family that has this exact qualifier are exposed as . field. If the qualifier is valid UTF-8 string, it can be specified in the qualifier_string field. Otherwise, a base-64 encoded value must be set to qualifier_encoded. The column field name is the same as the column qualifier. However, if the qualifier is not a valid BigQuery field identifier i.e. does not match [a-zA-Z][a-zA-Z0-9_]*, a valid identifier must be provided as field_name.

qualifierString String

type String

[Optional] The type to convert the value in cells of this column. The values are expected to be encoded using HBase Bytes.toBytes function when using the BINARY encoding value. Following BigQuery types are allowed (case-sensitive) - BYTES STRING INTEGER FLOAT BOOLEAN Default type is BYTES. 'type' can also be set at the column family level. However, the setting at this level takes precedence if 'type' is set at both levels.

encoding string

[Optional] The encoding of the values when the type is not STRING. Acceptable encoding values are: TEXT - indicates values are alphanumeric text strings. BINARY - indicates values are encoded using HBase Bytes.toBytes family of functions. 'encoding' can also be set at the column family level. However, the setting at this level takes precedence if 'encoding' is set at both levels.

fieldName string

[Optional] If the qualifier is not a valid BigQuery field identifier i.e. does not match [a-zA-Z][a-zA-Z0-9_]*, a valid identifier must be provided as the column field name and is used as field name in queries.

onlyReadLatest boolean

[Optional] If this is set, only the latest version of value in this column are exposed. 'onlyReadLatest' can also be set at the column family level. However, the setting at this level takes precedence if 'onlyReadLatest' is set at both levels.

qualifierEncoded string

[Required] Qualifier of the column. Columns in the parent column family that has this exact qualifier are exposed as . field. If the qualifier is valid UTF-8 string, it can be specified in the qualifier_string field. Otherwise, a base-64 encoded value must be set to qualifier_encoded. The column field name is the same as the column qualifier. However, if the qualifier is not a valid BigQuery field identifier i.e. does not match [a-zA-Z][a-zA-Z0-9_]*, a valid identifier must be provided as field_name.

qualifierString string

type string

[Optional] The type to convert the value in cells of this column. The values are expected to be encoded using HBase Bytes.toBytes function when using the BINARY encoding value. Following BigQuery types are allowed (case-sensitive) - BYTES STRING INTEGER FLOAT BOOLEAN Default type is BYTES. 'type' can also be set at the column family level. However, the setting at this level takes precedence if 'type' is set at both levels.

encoding str

[Optional] The encoding of the values when the type is not STRING. Acceptable encoding values are: TEXT - indicates values are alphanumeric text strings. BINARY - indicates values are encoded using HBase Bytes.toBytes family of functions. 'encoding' can also be set at the column family level. However, the setting at this level takes precedence if 'encoding' is set at both levels.

field_name str

[Optional] If the qualifier is not a valid BigQuery field identifier i.e. does not match [a-zA-Z][a-zA-Z0-9_]*, a valid identifier must be provided as the column field name and is used as field name in queries.

only_read_latest bool

[Optional] If this is set, only the latest version of value in this column are exposed. 'onlyReadLatest' can also be set at the column family level. However, the setting at this level takes precedence if 'onlyReadLatest' is set at both levels.

qualifier_encoded str

[Required] Qualifier of the column. Columns in the parent column family that has this exact qualifier are exposed as . field. If the qualifier is valid UTF-8 string, it can be specified in the qualifier_string field. Otherwise, a base-64 encoded value must be set to qualifier_encoded. The column field name is the same as the column qualifier. However, if the qualifier is not a valid BigQuery field identifier i.e. does not match [a-zA-Z][a-zA-Z0-9_]*, a valid identifier must be provided as field_name.

qualifier_string str

type str

[Optional] The type to convert the value in cells of this column. The values are expected to be encoded using HBase Bytes.toBytes function when using the BINARY encoding value. Following BigQuery types are allowed (case-sensitive) - BYTES STRING INTEGER FLOAT BOOLEAN Default type is BYTES. 'type' can also be set at the column family level. However, the setting at this level takes precedence if 'type' is set at both levels.

encoding String

[Optional] The encoding of the values when the type is not STRING. Acceptable encoding values are: TEXT - indicates values are alphanumeric text strings. BINARY - indicates values are encoded using HBase Bytes.toBytes family of functions. 'encoding' can also be set at the column family level. However, the setting at this level takes precedence if 'encoding' is set at both levels.

fieldName String

[Optional] If the qualifier is not a valid BigQuery field identifier i.e. does not match [a-zA-Z][a-zA-Z0-9_]*, a valid identifier must be provided as the column field name and is used as field name in queries.

onlyReadLatest Boolean

[Optional] If this is set, only the latest version of value in this column are exposed. 'onlyReadLatest' can also be set at the column family level. However, the setting at this level takes precedence if 'onlyReadLatest' is set at both levels.

qualifierEncoded String

[Required] Qualifier of the column. Columns in the parent column family that has this exact qualifier are exposed as . field. If the qualifier is valid UTF-8 string, it can be specified in the qualifier_string field. Otherwise, a base-64 encoded value must be set to qualifier_encoded. The column field name is the same as the column qualifier. However, if the qualifier is not a valid BigQuery field identifier i.e. does not match [a-zA-Z][a-zA-Z0-9_]*, a valid identifier must be provided as field_name.

qualifierString String

type String

[Optional] The type to convert the value in cells of this column. The values are expected to be encoded using HBase Bytes.toBytes function when using the BINARY encoding value. Following BigQuery types are allowed (case-sensitive) - BYTES STRING INTEGER FLOAT BOOLEAN Default type is BYTES. 'type' can also be set at the column family level. However, the setting at this level takes precedence if 'type' is set at both levels.

ColumnFamilies List<Pulumi.GoogleNative.BigQuery.V2.Inputs.BigtableColumnFamilyResponse>

[Optional] List of column families to expose in the table schema along with their types. This list restricts the column families that can be referenced in queries and specifies their value types. You can use this list to do type conversions - see the 'type' field for more details. If you leave this list empty, all column families are present in the table schema and their values are read as BYTES. During a query only the column families referenced in that query are read from Bigtable.

IgnoreUnspecifiedColumnFamilies bool

[Optional] If field is true, then the column families that are not specified in columnFamilies list are not exposed in the table schema. Otherwise, they are read with BYTES type values. The default value is false.

ReadRowkeyAsString bool

[Optional] If field is true, then the rowkey column families will be read and converted to string. Otherwise they are read with BYTES type values and users need to manually cast them with CAST if necessary. The default value is false.

ColumnFamilies []BigtableColumnFamilyResponse

[Optional] List of column families to expose in the table schema along with their types. This list restricts the column families that can be referenced in queries and specifies their value types. You can use this list to do type conversions - see the 'type' field for more details. If you leave this list empty, all column families are present in the table schema and their values are read as BYTES. During a query only the column families referenced in that query are read from Bigtable.

IgnoreUnspecifiedColumnFamilies bool

[Optional] If field is true, then the column families that are not specified in columnFamilies list are not exposed in the table schema. Otherwise, they are read with BYTES type values. The default value is false.

ReadRowkeyAsString bool

[Optional] If field is true, then the rowkey column families will be read and converted to string. Otherwise they are read with BYTES type values and users need to manually cast them with CAST if necessary. The default value is false.

columnFamilies List<BigtableColumnFamilyResponse>

[Optional] List of column families to expose in the table schema along with their types. This list restricts the column families that can be referenced in queries and specifies their value types. You can use this list to do type conversions - see the 'type' field for more details. If you leave this list empty, all column families are present in the table schema and their values are read as BYTES. During a query only the column families referenced in that query are read from Bigtable.

ignoreUnspecifiedColumnFamilies Boolean

[Optional] If field is true, then the column families that are not specified in columnFamilies list are not exposed in the table schema. Otherwise, they are read with BYTES type values. The default value is false.

readRowkeyAsString Boolean

[Optional] If field is true, then the rowkey column families will be read and converted to string. Otherwise they are read with BYTES type values and users need to manually cast them with CAST if necessary. The default value is false.

columnFamilies BigtableColumnFamilyResponse[]

[Optional] List of column families to expose in the table schema along with their types. This list restricts the column families that can be referenced in queries and specifies their value types. You can use this list to do type conversions - see the 'type' field for more details. If you leave this list empty, all column families are present in the table schema and their values are read as BYTES. During a query only the column families referenced in that query are read from Bigtable.

ignoreUnspecifiedColumnFamilies boolean

[Optional] If field is true, then the column families that are not specified in columnFamilies list are not exposed in the table schema. Otherwise, they are read with BYTES type values. The default value is false.

readRowkeyAsString boolean

[Optional] If field is true, then the rowkey column families will be read and converted to string. Otherwise they are read with BYTES type values and users need to manually cast them with CAST if necessary. The default value is false.

column_families Sequence[BigtableColumnFamilyResponse]

[Optional] List of column families to expose in the table schema along with their types. This list restricts the column families that can be referenced in queries and specifies their value types. You can use this list to do type conversions - see the 'type' field for more details. If you leave this list empty, all column families are present in the table schema and their values are read as BYTES. During a query only the column families referenced in that query are read from Bigtable.

ignore_unspecified_column_families bool

[Optional] If field is true, then the column families that are not specified in columnFamilies list are not exposed in the table schema. Otherwise, they are read with BYTES type values. The default value is false.

read_rowkey_as_string bool

[Optional] If field is true, then the rowkey column families will be read and converted to string. Otherwise they are read with BYTES type values and users need to manually cast them with CAST if necessary. The default value is false.

columnFamilies List<Property Map>

[Optional] List of column families to expose in the table schema along with their types. This list restricts the column families that can be referenced in queries and specifies their value types. You can use this list to do type conversions - see the 'type' field for more details. If you leave this list empty, all column families are present in the table schema and their values are read as BYTES. During a query only the column families referenced in that query are read from Bigtable.

ignoreUnspecifiedColumnFamilies Boolean

[Optional] If field is true, then the column families that are not specified in columnFamilies list are not exposed in the table schema. Otherwise, they are read with BYTES type values. The default value is false.

readRowkeyAsString Boolean

[Optional] If field is true, then the rowkey column families will be read and converted to string. Otherwise they are read with BYTES type values and users need to manually cast them with CAST if necessary. The default value is false.

DurationMs string

[Output-only, Beta] Time taken to run the training iteration in milliseconds.

EvalLoss double

[Output-only, Beta] Eval loss computed on the eval data at the end of the iteration. The eval loss is used for early stopping to avoid overfitting. No eval loss if eval_split_method option is specified as no_split or auto_split with input data size less than 500 rows.

Index int

[Output-only, Beta] Index of the ML training iteration, starting from zero for each training run.

LearnRate double

[Output-only, Beta] Learning rate used for this iteration, it varies for different training iterations if learn_rate_strategy option is not constant.

TrainingLoss double

[Output-only, Beta] Training loss computed on the training data at the end of the iteration. The training loss function is defined by model type.

DurationMs string

[Output-only, Beta] Time taken to run the training iteration in milliseconds.

EvalLoss float64

[Output-only, Beta] Eval loss computed on the eval data at the end of the iteration. The eval loss is used for early stopping to avoid overfitting. No eval loss if eval_split_method option is specified as no_split or auto_split with input data size less than 500 rows.

Index int

[Output-only, Beta] Index of the ML training iteration, starting from zero for each training run.

LearnRate float64

[Output-only, Beta] Learning rate used for this iteration, it varies for different training iterations if learn_rate_strategy option is not constant.

TrainingLoss float64

[Output-only, Beta] Training loss computed on the training data at the end of the iteration. The training loss function is defined by model type.

durationMs String

[Output-only, Beta] Time taken to run the training iteration in milliseconds.

evalLoss Double

[Output-only, Beta] Eval loss computed on the eval data at the end of the iteration. The eval loss is used for early stopping to avoid overfitting. No eval loss if eval_split_method option is specified as no_split or auto_split with input data size less than 500 rows.

index Integer

[Output-only, Beta] Index of the ML training iteration, starting from zero for each training run.

learnRate Double

[Output-only, Beta] Learning rate used for this iteration, it varies for different training iterations if learn_rate_strategy option is not constant.

trainingLoss Double

[Output-only, Beta] Training loss computed on the training data at the end of the iteration. The training loss function is defined by model type.

durationMs string

[Output-only, Beta] Time taken to run the training iteration in milliseconds.

evalLoss number

[Output-only, Beta] Eval loss computed on the eval data at the end of the iteration. The eval loss is used for early stopping to avoid overfitting. No eval loss if eval_split_method option is specified as no_split or auto_split with input data size less than 500 rows.

index number

[Output-only, Beta] Index of the ML training iteration, starting from zero for each training run.

learnRate number

[Output-only, Beta] Learning rate used for this iteration, it varies for different training iterations if learn_rate_strategy option is not constant.

trainingLoss number

[Output-only, Beta] Training loss computed on the training data at the end of the iteration. The training loss function is defined by model type.

duration_ms str

[Output-only, Beta] Time taken to run the training iteration in milliseconds.

eval_loss float

[Output-only, Beta] Eval loss computed on the eval data at the end of the iteration. The eval loss is used for early stopping to avoid overfitting. No eval loss if eval_split_method option is specified as no_split or auto_split with input data size less than 500 rows.

index int

[Output-only, Beta] Index of the ML training iteration, starting from zero for each training run.

learn_rate float

[Output-only, Beta] Learning rate used for this iteration, it varies for different training iterations if learn_rate_strategy option is not constant.

training_loss float

[Output-only, Beta] Training loss computed on the training data at the end of the iteration. The training loss function is defined by model type.

durationMs String

[Output-only, Beta] Time taken to run the training iteration in milliseconds.

evalLoss Number

[Output-only, Beta] Eval loss computed on the eval data at the end of the iteration. The eval loss is used for early stopping to avoid overfitting. No eval loss if eval_split_method option is specified as no_split or auto_split with input data size less than 500 rows.

index Number

[Output-only, Beta] Index of the ML training iteration, starting from zero for each training run.

learnRate Number

[Output-only, Beta] Learning rate used for this iteration, it varies for different training iterations if learn_rate_strategy option is not constant.

trainingLoss Number

[Output-only, Beta] Training loss computed on the training data at the end of the iteration. The training loss function is defined by model type.

IterationResults List<Pulumi.GoogleNative.BigQuery.V2.Inputs.BqmlIterationResultResponse>

[Output-only, Beta] List of each iteration results.

StartTime string

[Output-only, Beta] Training run start time in milliseconds since the epoch.

State string

[Output-only, Beta] Different state applicable for a training run. IN PROGRESS: Training run is in progress. FAILED: Training run ended due to a non-retryable failure. SUCCEEDED: Training run successfully completed. CANCELLED: Training run cancelled by the user.

TrainingOptions Pulumi.GoogleNative.BigQuery.V2.Inputs.BqmlTrainingRunTrainingOptionsResponse

[Output-only, Beta] Training options used by this training run. These options are mutable for subsequent training runs. Default values are explicitly stored for options not specified in the input query of the first training run. For subsequent training runs, any option not explicitly specified in the input query will be copied from the previous training run.

IterationResults []BqmlIterationResultResponse

[Output-only, Beta] List of each iteration results.

StartTime string

[Output-only, Beta] Training run start time in milliseconds since the epoch.

State string

[Output-only, Beta] Different state applicable for a training run. IN PROGRESS: Training run is in progress. FAILED: Training run ended due to a non-retryable failure. SUCCEEDED: Training run successfully completed. CANCELLED: Training run cancelled by the user.

TrainingOptions BqmlTrainingRunTrainingOptionsResponse

[Output-only, Beta] Training options used by this training run. These options are mutable for subsequent training runs. Default values are explicitly stored for options not specified in the input query of the first training run. For subsequent training runs, any option not explicitly specified in the input query will be copied from the previous training run.

iterationResults List<BqmlIterationResultResponse>

[Output-only, Beta] List of each iteration results.

startTime String

[Output-only, Beta] Training run start time in milliseconds since the epoch.

state String

[Output-only, Beta] Different state applicable for a training run. IN PROGRESS: Training run is in progress. FAILED: Training run ended due to a non-retryable failure. SUCCEEDED: Training run successfully completed. CANCELLED: Training run cancelled by the user.

trainingOptions BqmlTrainingRunTrainingOptionsResponse

[Output-only, Beta] Training options used by this training run. These options are mutable for subsequent training runs. Default values are explicitly stored for options not specified in the input query of the first training run. For subsequent training runs, any option not explicitly specified in the input query will be copied from the previous training run.

iterationResults BqmlIterationResultResponse[]

[Output-only, Beta] List of each iteration results.

startTime string

[Output-only, Beta] Training run start time in milliseconds since the epoch.

state string

[Output-only, Beta] Different state applicable for a training run. IN PROGRESS: Training run is in progress. FAILED: Training run ended due to a non-retryable failure. SUCCEEDED: Training run successfully completed. CANCELLED: Training run cancelled by the user.

trainingOptions BqmlTrainingRunTrainingOptionsResponse

[Output-only, Beta] Training options used by this training run. These options are mutable for subsequent training runs. Default values are explicitly stored for options not specified in the input query of the first training run. For subsequent training runs, any option not explicitly specified in the input query will be copied from the previous training run.

iteration_results Sequence[BqmlIterationResultResponse]

[Output-only, Beta] List of each iteration results.

start_time str

[Output-only, Beta] Training run start time in milliseconds since the epoch.

state str

[Output-only, Beta] Different state applicable for a training run. IN PROGRESS: Training run is in progress. FAILED: Training run ended due to a non-retryable failure. SUCCEEDED: Training run successfully completed. CANCELLED: Training run cancelled by the user.

training_options BqmlTrainingRunTrainingOptionsResponse

[Output-only, Beta] Training options used by this training run. These options are mutable for subsequent training runs. Default values are explicitly stored for options not specified in the input query of the first training run. For subsequent training runs, any option not explicitly specified in the input query will be copied from the previous training run.

iterationResults List<Property Map>

[Output-only, Beta] List of each iteration results.

startTime String

[Output-only, Beta] Training run start time in milliseconds since the epoch.

state String

[Output-only, Beta] Different state applicable for a training run. IN PROGRESS: Training run is in progress. FAILED: Training run ended due to a non-retryable failure. SUCCEEDED: Training run successfully completed. CANCELLED: Training run cancelled by the user.

trainingOptions Property Map

[Output-only, Beta] Training options used by this training run. These options are mutable for subsequent training runs. Default values are explicitly stored for options not specified in the input query of the first training run. For subsequent training runs, any option not explicitly specified in the input query will be copied from the previous training run.

EarlyStop bool

L1Reg double

L2Reg double

LearnRate double

LearnRateStrategy string

LineSearchInitLearnRate double

MaxIteration string

MinRelProgress double

WarmStart bool

EarlyStop bool

L1Reg float64

L2Reg float64

LearnRate float64

LearnRateStrategy string

LineSearchInitLearnRate float64

MaxIteration string

MinRelProgress float64

WarmStart bool

earlyStop Boolean

l1Reg Double

l2Reg Double

learnRate Double

learnRateStrategy String

lineSearchInitLearnRate Double

maxIteration String

minRelProgress Double

warmStart Boolean

earlyStop boolean

l1Reg number

l2Reg number

learnRate number

learnRateStrategy string

lineSearchInitLearnRate number

maxIteration string

minRelProgress number

warmStart boolean

early_stop bool

l1_reg float

l2_reg float

learn_rate float

learn_rate_strategy str

line_search_init_learn_rate float

max_iteration str

min_rel_progress float

warm_start bool

earlyStop Boolean

l1Reg Number

l2Reg Number

learnRate Number

learnRateStrategy String

lineSearchInitLearnRate Number

maxIteration String

minRelProgress Number

warmStart Boolean

BaseTableReference Pulumi.GoogleNative.BigQuery.V2.Inputs.TableReferenceResponse

[Required] Reference describing the ID of the table that was cloned.

CloneTime string

[Required] The time at which the base table was cloned. This value is reported in the JSON response using RFC3339 format.

BaseTableReference TableReferenceResponse

[Required] Reference describing the ID of the table that was cloned.

CloneTime string

[Required] The time at which the base table was cloned. This value is reported in the JSON response using RFC3339 format.

baseTableReference TableReferenceResponse

[Required] Reference describing the ID of the table that was cloned.

cloneTime String

[Required] The time at which the base table was cloned. This value is reported in the JSON response using RFC3339 format.

baseTableReference TableReferenceResponse

[Required] Reference describing the ID of the table that was cloned.

cloneTime string

[Required] The time at which the base table was cloned. This value is reported in the JSON response using RFC3339 format.

base_table_reference TableReferenceResponse

[Required] Reference describing the ID of the table that was cloned.

clone_time str

[Required] The time at which the base table was cloned. This value is reported in the JSON response using RFC3339 format.

baseTableReference Property Map

[Required] Reference describing the ID of the table that was cloned.

cloneTime String

[Required] The time at which the base table was cloned. This value is reported in the JSON response using RFC3339 format.

Fields List<string>

[Repeated] One or more fields on which data should be clustered. Only top-level, non-repeated, simple-type fields are supported. When you cluster a table using multiple columns, the order of columns you specify is important. The order of the specified columns determines the sort order of the data.

Fields []string

[Repeated] One or more fields on which data should be clustered. Only top-level, non-repeated, simple-type fields are supported. When you cluster a table using multiple columns, the order of columns you specify is important. The order of the specified columns determines the sort order of the data.

fields List<String>

[Repeated] One or more fields on which data should be clustered. Only top-level, non-repeated, simple-type fields are supported. When you cluster a table using multiple columns, the order of columns you specify is important. The order of the specified columns determines the sort order of the data.

fields string[]

[Repeated] One or more fields on which data should be clustered. Only top-level, non-repeated, simple-type fields are supported. When you cluster a table using multiple columns, the order of columns you specify is important. The order of the specified columns determines the sort order of the data.

fields Sequence[str]

[Repeated] One or more fields on which data should be clustered. Only top-level, non-repeated, simple-type fields are supported. When you cluster a table using multiple columns, the order of columns you specify is important. The order of the specified columns determines the sort order of the data.

fields List<String>

[Repeated] One or more fields on which data should be clustered. Only top-level, non-repeated, simple-type fields are supported. When you cluster a table using multiple columns, the order of columns you specify is important. The order of the specified columns determines the sort order of the data.

AllowJaggedRows bool

[Optional] Indicates if BigQuery should accept rows that are missing trailing optional columns. If true, BigQuery treats missing trailing columns as null values. If false, records with missing trailing columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false.

AllowQuotedNewlines bool

[Optional] Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false.

Encoding string

[Optional] The character encoding of the data. The supported values are UTF-8 or ISO-8859-1. The default value is UTF-8. BigQuery decodes the data after the raw, binary data has been split using the values of the quote and fieldDelimiter properties.

FieldDelimiter string

[Optional] The separator for fields in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. BigQuery also supports the escape sequence "\t" to specify a tab separator. The default value is a comma (',').

NullMarker string

[Optional] An custom string that will represent a NULL value in CSV import data.

PreserveAsciiControlCharacters bool

[Optional] Preserves the embedded ASCII control characters (the first 32 characters in the ASCII-table, from '\x00' to '\x1F') when loading from CSV. Only applicable to CSV, ignored for other formats.

Quote string

[Optional] The value that is used to quote data sections in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. The default value is a double-quote ('"'). If your data does not contain quoted sections, set the property value to an empty string. If your data contains quoted newline characters, you must also set the allowQuotedNewlines property to true.

SkipLeadingRows string

[Optional] The number of rows at the top of a CSV file that BigQuery will skip when reading the data. The default value is 0. This property is useful if you have header rows in the file that should be skipped. When autodetect is on, the behavior is the following: * skipLeadingRows unspecified - Autodetect tries to detect headers in the first row. If they are not detected, the row is read as data. Otherwise data is read starting from the second row. * skipLeadingRows is 0 - Instructs autodetect that there are no headers and data should be read starting from the first row. * skipLeadingRows = N > 0 - Autodetect skips N-1 rows and tries to detect headers in row N. If headers are not detected, row N is just skipped. Otherwise row N is used to extract column names for the detected schema.

AllowJaggedRows bool

[Optional] Indicates if BigQuery should accept rows that are missing trailing optional columns. If true, BigQuery treats missing trailing columns as null values. If false, records with missing trailing columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false.

AllowQuotedNewlines bool

[Optional] Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false.

Encoding string

[Optional] The character encoding of the data. The supported values are UTF-8 or ISO-8859-1. The default value is UTF-8. BigQuery decodes the data after the raw, binary data has been split using the values of the quote and fieldDelimiter properties.

FieldDelimiter string

[Optional] The separator for fields in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. BigQuery also supports the escape sequence "\t" to specify a tab separator. The default value is a comma (',').

NullMarker string

[Optional] An custom string that will represent a NULL value in CSV import data.

PreserveAsciiControlCharacters bool

[Optional] Preserves the embedded ASCII control characters (the first 32 characters in the ASCII-table, from '\x00' to '\x1F') when loading from CSV. Only applicable to CSV, ignored for other formats.

Quote string

[Optional] The value that is used to quote data sections in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. The default value is a double-quote ('"'). If your data does not contain quoted sections, set the property value to an empty string. If your data contains quoted newline characters, you must also set the allowQuotedNewlines property to true.

SkipLeadingRows string

[Optional] The number of rows at the top of a CSV file that BigQuery will skip when reading the data. The default value is 0. This property is useful if you have header rows in the file that should be skipped. When autodetect is on, the behavior is the following: * skipLeadingRows unspecified - Autodetect tries to detect headers in the first row. If they are not detected, the row is read as data. Otherwise data is read starting from the second row. * skipLeadingRows is 0 - Instructs autodetect that there are no headers and data should be read starting from the first row. * skipLeadingRows = N > 0 - Autodetect skips N-1 rows and tries to detect headers in row N. If headers are not detected, row N is just skipped. Otherwise row N is used to extract column names for the detected schema.

allowJaggedRows Boolean

[Optional] Indicates if BigQuery should accept rows that are missing trailing optional columns. If true, BigQuery treats missing trailing columns as null values. If false, records with missing trailing columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false.

allowQuotedNewlines Boolean

[Optional] Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false.

encoding String

[Optional] The character encoding of the data. The supported values are UTF-8 or ISO-8859-1. The default value is UTF-8. BigQuery decodes the data after the raw, binary data has been split using the values of the quote and fieldDelimiter properties.

fieldDelimiter String

[Optional] The separator for fields in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. BigQuery also supports the escape sequence "\t" to specify a tab separator. The default value is a comma (',').

nullMarker String

[Optional] An custom string that will represent a NULL value in CSV import data.

preserveAsciiControlCharacters Boolean

[Optional] Preserves the embedded ASCII control characters (the first 32 characters in the ASCII-table, from '\x00' to '\x1F') when loading from CSV. Only applicable to CSV, ignored for other formats.

quote String

[Optional] The value that is used to quote data sections in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. The default value is a double-quote ('"'). If your data does not contain quoted sections, set the property value to an empty string. If your data contains quoted newline characters, you must also set the allowQuotedNewlines property to true.

skipLeadingRows String

[Optional] The number of rows at the top of a CSV file that BigQuery will skip when reading the data. The default value is 0. This property is useful if you have header rows in the file that should be skipped. When autodetect is on, the behavior is the following: * skipLeadingRows unspecified - Autodetect tries to detect headers in the first row. If they are not detected, the row is read as data. Otherwise data is read starting from the second row. * skipLeadingRows is 0 - Instructs autodetect that there are no headers and data should be read starting from the first row. * skipLeadingRows = N > 0 - Autodetect skips N-1 rows and tries to detect headers in row N. If headers are not detected, row N is just skipped. Otherwise row N is used to extract column names for the detected schema.

allowJaggedRows boolean

[Optional] Indicates if BigQuery should accept rows that are missing trailing optional columns. If true, BigQuery treats missing trailing columns as null values. If false, records with missing trailing columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false.

allowQuotedNewlines boolean

[Optional] Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false.

encoding string

[Optional] The character encoding of the data. The supported values are UTF-8 or ISO-8859-1. The default value is UTF-8. BigQuery decodes the data after the raw, binary data has been split using the values of the quote and fieldDelimiter properties.

fieldDelimiter string

[Optional] The separator for fields in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. BigQuery also supports the escape sequence "\t" to specify a tab separator. The default value is a comma (',').

nullMarker string

[Optional] An custom string that will represent a NULL value in CSV import data.

preserveAsciiControlCharacters boolean

[Optional] Preserves the embedded ASCII control characters (the first 32 characters in the ASCII-table, from '\x00' to '\x1F') when loading from CSV. Only applicable to CSV, ignored for other formats.

quote string

[Optional] The value that is used to quote data sections in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. The default value is a double-quote ('"'). If your data does not contain quoted sections, set the property value to an empty string. If your data contains quoted newline characters, you must also set the allowQuotedNewlines property to true.

skipLeadingRows string

[Optional] The number of rows at the top of a CSV file that BigQuery will skip when reading the data. The default value is 0. This property is useful if you have header rows in the file that should be skipped. When autodetect is on, the behavior is the following: * skipLeadingRows unspecified - Autodetect tries to detect headers in the first row. If they are not detected, the row is read as data. Otherwise data is read starting from the second row. * skipLeadingRows is 0 - Instructs autodetect that there are no headers and data should be read starting from the first row. * skipLeadingRows = N > 0 - Autodetect skips N-1 rows and tries to detect headers in row N. If headers are not detected, row N is just skipped. Otherwise row N is used to extract column names for the detected schema.

allow_jagged_rows bool

[Optional] Indicates if BigQuery should accept rows that are missing trailing optional columns. If true, BigQuery treats missing trailing columns as null values. If false, records with missing trailing columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false.

allow_quoted_newlines bool

[Optional] Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false.

encoding str

[Optional] The character encoding of the data. The supported values are UTF-8 or ISO-8859-1. The default value is UTF-8. BigQuery decodes the data after the raw, binary data has been split using the values of the quote and fieldDelimiter properties.

field_delimiter str

[Optional] The separator for fields in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. BigQuery also supports the escape sequence "\t" to specify a tab separator. The default value is a comma (',').

null_marker str

[Optional] An custom string that will represent a NULL value in CSV import data.

preserve_ascii_control_characters bool

[Optional] Preserves the embedded ASCII control characters (the first 32 characters in the ASCII-table, from '\x00' to '\x1F') when loading from CSV. Only applicable to CSV, ignored for other formats.

quote str

[Optional] The value that is used to quote data sections in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. The default value is a double-quote ('"'). If your data does not contain quoted sections, set the property value to an empty string. If your data contains quoted newline characters, you must also set the allowQuotedNewlines property to true.

skip_leading_rows str

[Optional] The number of rows at the top of a CSV file that BigQuery will skip when reading the data. The default value is 0. This property is useful if you have header rows in the file that should be skipped. When autodetect is on, the behavior is the following: * skipLeadingRows unspecified - Autodetect tries to detect headers in the first row. If they are not detected, the row is read as data. Otherwise data is read starting from the second row. * skipLeadingRows is 0 - Instructs autodetect that there are no headers and data should be read starting from the first row. * skipLeadingRows = N > 0 - Autodetect skips N-1 rows and tries to detect headers in row N. If headers are not detected, row N is just skipped. Otherwise row N is used to extract column names for the detected schema.

allowJaggedRows Boolean

[Optional] Indicates if BigQuery should accept rows that are missing trailing optional columns. If true, BigQuery treats missing trailing columns as null values. If false, records with missing trailing columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false.

allowQuotedNewlines Boolean

[Optional] Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false.

encoding String

[Optional] The character encoding of the data. The supported values are UTF-8 or ISO-8859-1. The default value is UTF-8. BigQuery decodes the data after the raw, binary data has been split using the values of the quote and fieldDelimiter properties.

fieldDelimiter String

[Optional] The separator for fields in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. BigQuery also supports the escape sequence "\t" to specify a tab separator. The default value is a comma (',').

nullMarker String

[Optional] An custom string that will represent a NULL value in CSV import data.

preserveAsciiControlCharacters Boolean

[Optional] Preserves the embedded ASCII control characters (the first 32 characters in the ASCII-table, from '\x00' to '\x1F') when loading from CSV. Only applicable to CSV, ignored for other formats.

quote String

[Optional] The value that is used to quote data sections in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. The default value is a double-quote ('"'). If your data does not contain quoted sections, set the property value to an empty string. If your data contains quoted newline characters, you must also set the allowQuotedNewlines property to true.

skipLeadingRows String

[Optional] The number of rows at the top of a CSV file that BigQuery will skip when reading the data. The default value is 0. This property is useful if you have header rows in the file that should be skipped. When autodetect is on, the behavior is the following: * skipLeadingRows unspecified - Autodetect tries to detect headers in the first row. If they are not detected, the row is read as data. Otherwise data is read starting from the second row. * skipLeadingRows is 0 - Instructs autodetect that there are no headers and data should be read starting from the first row. * skipLeadingRows = N > 0 - Autodetect skips N-1 rows and tries to detect headers in row N. If headers are not detected, row N is just skipped. Otherwise row N is used to extract column names for the detected schema.

KmsKeyName string

Optional. Describes the Cloud KMS encryption key that will be used to protect destination BigQuery table. The BigQuery Service Account associated with your project requires access to this encryption key.

KmsKeyName string

Optional. Describes the Cloud KMS encryption key that will be used to protect destination BigQuery table. The BigQuery Service Account associated with your project requires access to this encryption key.

kmsKeyName String

Optional. Describes the Cloud KMS encryption key that will be used to protect destination BigQuery table. The BigQuery Service Account associated with your project requires access to this encryption key.

kmsKeyName string

Optional. Describes the Cloud KMS encryption key that will be used to protect destination BigQuery table. The BigQuery Service Account associated with your project requires access to this encryption key.

kms_key_name str

Optional. Describes the Cloud KMS encryption key that will be used to protect destination BigQuery table. The BigQuery Service Account associated with your project requires access to this encryption key.

kmsKeyName String

Optional. Describes the Cloud KMS encryption key that will be used to protect destination BigQuery table. The BigQuery Service Account associated with your project requires access to this encryption key.

Autodetect bool

Try to detect schema and format options automatically. Any option specified explicitly will be honored.

AvroOptions Pulumi.GoogleNative.BigQuery.V2.Inputs.AvroOptionsResponse

Additional properties to set if sourceFormat is set to Avro.

BigtableOptions Pulumi.GoogleNative.BigQuery.V2.Inputs.BigtableOptionsResponse

[Optional] Additional options if sourceFormat is set to BIGTABLE.

Compression string

[Optional] The compression type of the data source. Possible values include GZIP and NONE. The default value is NONE. This setting is ignored for Google Cloud Bigtable, Google Cloud Datastore backups and Avro formats.

ConnectionId string

[Optional, Trusted Tester] Connection for external data source.

CsvOptions Pulumi.GoogleNative.BigQuery.V2.Inputs.CsvOptionsResponse

Additional properties to set if sourceFormat is set to CSV.

DecimalTargetTypes List<string>

[Optional] Defines the list of possible SQL data types to which the source decimal values are converted. This list and the precision and the scale parameters of the decimal field determine the target type. In the order of NUMERIC, BIGNUMERIC, and STRING, a type is picked if it is in the specified list and if it supports the precision and the scale. STRING supports all precision and scale values. If none of the listed types supports the precision and the scale, the type supporting the widest range in the specified list is picked, and if a value exceeds the supported range when reading the data, an error will be thrown. Example: Suppose the value of this field is ["NUMERIC", "BIGNUMERIC"]. If (precision,scale) is: (38,9) -> NUMERIC; (39,9) -> BIGNUMERIC (NUMERIC cannot hold 30 integer digits); (38,10) -> BIGNUMERIC (NUMERIC cannot hold 10 fractional digits); (76,38) -> BIGNUMERIC; (77,38) -> BIGNUMERIC (error if value exeeds supported range). This field cannot contain duplicate types. The order of the types in this field is ignored. For example, ["BIGNUMERIC", "NUMERIC"] is the same as ["NUMERIC", "BIGNUMERIC"] and NUMERIC always takes precedence over BIGNUMERIC. Defaults to ["NUMERIC", "STRING"] for ORC and ["NUMERIC"] for the other file formats.

FileSetSpecType string

[Optional] Specifies how source URIs are interpreted for constructing the file set to load. By default source URIs are expanded against the underlying storage. Other options include specifying manifest files. Only applicable to object storage systems.

GoogleSheetsOptions Pulumi.GoogleNative.BigQuery.V2.Inputs.GoogleSheetsOptionsResponse

[Optional] Additional options if sourceFormat is set to GOOGLE_SHEETS.

HivePartitioningOptions Pulumi.GoogleNative.BigQuery.V2.Inputs.HivePartitioningOptionsResponse

[Optional] Options to configure hive partitioning support.

IgnoreUnknownValues bool

[Optional] Indicates if BigQuery should allow extra values that are not represented in the table schema. If true, the extra values are ignored. If false, records with extra columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. The sourceFormat property determines what BigQuery treats as an extra value: CSV: Trailing columns JSON: Named values that don't match any column names Google Cloud Bigtable: This setting is ignored. Google Cloud Datastore backups: This setting is ignored. Avro: This setting is ignored.

JsonOptions Pulumi.GoogleNative.BigQuery.V2.Inputs.JsonOptionsResponse

Additional properties to set if sourceFormat is set to NEWLINE_DELIMITED_JSON.

MaxBadRecords int

[Optional] The maximum number of bad records that BigQuery can ignore when reading data. If the number of bad records exceeds this value, an invalid error is returned in the job result. This is only valid for CSV, JSON, and Google Sheets. The default value is 0, which requires that all records are valid. This setting is ignored for Google Cloud Bigtable, Google Cloud Datastore backups and Avro formats.

MetadataCacheMode string

[Optional] Metadata Cache Mode for the table. Set this to enable caching of metadata from external data source.

ObjectMetadata string

ObjectMetadata is used to create Object Tables. Object Tables contain a listing of objects (with their metadata) found at the source_uris. If ObjectMetadata is set, source_format should be omitted. Currently SIMPLE is the only supported Object Metadata type.

ParquetOptions Pulumi.GoogleNative.BigQuery.V2.Inputs.ParquetOptionsResponse

Additional properties to set if sourceFormat is set to Parquet.

ReferenceFileSchemaUri string

[Optional] Provide a referencing file with the expected table schema. Enabled for the format: AVRO, PARQUET, ORC.

Schema Pulumi.GoogleNative.BigQuery.V2.Inputs.TableSchemaResponse

[Optional] The schema for the data. Schema is required for CSV and JSON formats. Schema is disallowed for Google Cloud Bigtable, Cloud Datastore backups, and Avro formats.

SourceFormat string

[Required] The data format. For CSV files, specify "CSV". For Google sheets, specify "GOOGLE_SHEETS". For newline-delimited JSON, specify "NEWLINE_DELIMITED_JSON". For Avro files, specify "AVRO". For Google Cloud Datastore backups, specify "DATASTORE_BACKUP". [Beta] For Google Cloud Bigtable, specify "BIGTABLE".

SourceUris List<string>

[Required] The fully-qualified URIs that point to your data in Google Cloud. For Google Cloud Storage URIs: Each URI can contain one '' wildcard character and it must come after the 'bucket' name. Size limits related to load jobs apply to external data sources. For Google Cloud Bigtable URIs: Exactly one URI can be specified and it has be a fully specified and valid HTTPS URL for a Google Cloud Bigtable table. For Google Cloud Datastore backups, exactly one URI can be specified. Also, the '' wildcard character is not allowed.

Autodetect bool

Try to detect schema and format options automatically. Any option specified explicitly will be honored.

AvroOptions AvroOptionsResponse

Additional properties to set if sourceFormat is set to Avro.

BigtableOptions BigtableOptionsResponse

[Optional] Additional options if sourceFormat is set to BIGTABLE.

Compression string

[Optional] The compression type of the data source. Possible values include GZIP and NONE. The default value is NONE. This setting is ignored for Google Cloud Bigtable, Google Cloud Datastore backups and Avro formats.

ConnectionId string

[Optional, Trusted Tester] Connection for external data source.

CsvOptions CsvOptionsResponse

Additional properties to set if sourceFormat is set to CSV.

DecimalTargetTypes []string

[Optional] Defines the list of possible SQL data types to which the source decimal values are converted. This list and the precision and the scale parameters of the decimal field determine the target type. In the order of NUMERIC, BIGNUMERIC, and STRING, a type is picked if it is in the specified list and if it supports the precision and the scale. STRING supports all precision and scale values. If none of the listed types supports the precision and the scale, the type supporting the widest range in the specified list is picked, and if a value exceeds the supported range when reading the data, an error will be thrown. Example: Suppose the value of this field is ["NUMERIC", "BIGNUMERIC"]. If (precision,scale) is: (38,9) -> NUMERIC; (39,9) -> BIGNUMERIC (NUMERIC cannot hold 30 integer digits); (38,10) -> BIGNUMERIC (NUMERIC cannot hold 10 fractional digits); (76,38) -> BIGNUMERIC; (77,38) -> BIGNUMERIC (error if value exeeds supported range). This field cannot contain duplicate types. The order of the types in this field is ignored. For example, ["BIGNUMERIC", "NUMERIC"] is the same as ["NUMERIC", "BIGNUMERIC"] and NUMERIC always takes precedence over BIGNUMERIC. Defaults to ["NUMERIC", "STRING"] for ORC and ["NUMERIC"] for the other file formats.

FileSetSpecType string

[Optional] Specifies how source URIs are interpreted for constructing the file set to load. By default source URIs are expanded against the underlying storage. Other options include specifying manifest files. Only applicable to object storage systems.

GoogleSheetsOptions GoogleSheetsOptionsResponse

[Optional] Additional options if sourceFormat is set to GOOGLE_SHEETS.

HivePartitioningOptions HivePartitioningOptionsResponse

[Optional] Options to configure hive partitioning support.

IgnoreUnknownValues bool

[Optional] Indicates if BigQuery should allow extra values that are not represented in the table schema. If true, the extra values are ignored. If false, records with extra columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. The sourceFormat property determines what BigQuery treats as an extra value: CSV: Trailing columns JSON: Named values that don't match any column names Google Cloud Bigtable: This setting is ignored. Google Cloud Datastore backups: This setting is ignored. Avro: This setting is ignored.

JsonOptions JsonOptionsResponse

Additional properties to set if sourceFormat is set to NEWLINE_DELIMITED_JSON.

MaxBadRecords int

[Optional] The maximum number of bad records that BigQuery can ignore when reading data. If the number of bad records exceeds this value, an invalid error is returned in the job result. This is only valid for CSV, JSON, and Google Sheets. The default value is 0, which requires that all records are valid. This setting is ignored for Google Cloud Bigtable, Google Cloud Datastore backups and Avro formats.

MetadataCacheMode string

[Optional] Metadata Cache Mode for the table. Set this to enable caching of metadata from external data source.

ObjectMetadata string

ObjectMetadata is used to create Object Tables. Object Tables contain a listing of objects (with their metadata) found at the source_uris. If ObjectMetadata is set, source_format should be omitted. Currently SIMPLE is the only supported Object Metadata type.

ParquetOptions ParquetOptionsResponse

Additional properties to set if sourceFormat is set to Parquet.

ReferenceFileSchemaUri string

[Optional] Provide a referencing file with the expected table schema. Enabled for the format: AVRO, PARQUET, ORC.

Schema TableSchemaResponse

[Optional] The schema for the data. Schema is required for CSV and JSON formats. Schema is disallowed for Google Cloud Bigtable, Cloud Datastore backups, and Avro formats.

SourceFormat string

[Required] The data format. For CSV files, specify "CSV". For Google sheets, specify "GOOGLE_SHEETS". For newline-delimited JSON, specify "NEWLINE_DELIMITED_JSON". For Avro files, specify "AVRO". For Google Cloud Datastore backups, specify "DATASTORE_BACKUP". [Beta] For Google Cloud Bigtable, specify "BIGTABLE".

SourceUris []string

[Required] The fully-qualified URIs that point to your data in Google Cloud. For Google Cloud Storage URIs: Each URI can contain one '' wildcard character and it must come after the 'bucket' name. Size limits related to load jobs apply to external data sources. For Google Cloud Bigtable URIs: Exactly one URI can be specified and it has be a fully specified and valid HTTPS URL for a Google Cloud Bigtable table. For Google Cloud Datastore backups, exactly one URI can be specified. Also, the '' wildcard character is not allowed.

autodetect Boolean

Try to detect schema and format options automatically. Any option specified explicitly will be honored.

avroOptions AvroOptionsResponse

Additional properties to set if sourceFormat is set to Avro.

bigtableOptions BigtableOptionsResponse

[Optional] Additional options if sourceFormat is set to BIGTABLE.

compression String

[Optional] The compression type of the data source. Possible values include GZIP and NONE. The default value is NONE. This setting is ignored for Google Cloud Bigtable, Google Cloud Datastore backups and Avro formats.

connectionId String

[Optional, Trusted Tester] Connection for external data source.

csvOptions CsvOptionsResponse

Additional properties to set if sourceFormat is set to CSV.

decimalTargetTypes List<String>

[Optional] Defines the list of possible SQL data types to which the source decimal values are converted. This list and the precision and the scale parameters of the decimal field determine the target type. In the order of NUMERIC, BIGNUMERIC, and STRING, a type is picked if it is in the specified list and if it supports the precision and the scale. STRING supports all precision and scale values. If none of the listed types supports the precision and the scale, the type supporting the widest range in the specified list is picked, and if a value exceeds the supported range when reading the data, an error will be thrown. Example: Suppose the value of this field is ["NUMERIC", "BIGNUMERIC"]. If (precision,scale) is: (38,9) -> NUMERIC; (39,9) -> BIGNUMERIC (NUMERIC cannot hold 30 integer digits); (38,10) -> BIGNUMERIC (NUMERIC cannot hold 10 fractional digits); (76,38) -> BIGNUMERIC; (77,38) -> BIGNUMERIC (error if value exeeds supported range). This field cannot contain duplicate types. The order of the types in this field is ignored. For example, ["BIGNUMERIC", "NUMERIC"] is the same as ["NUMERIC", "BIGNUMERIC"] and NUMERIC always takes precedence over BIGNUMERIC. Defaults to ["NUMERIC", "STRING"] for ORC and ["NUMERIC"] for the other file formats.

fileSetSpecType String

[Optional] Specifies how source URIs are interpreted for constructing the file set to load. By default source URIs are expanded against the underlying storage. Other options include specifying manifest files. Only applicable to object storage systems.

googleSheetsOptions GoogleSheetsOptionsResponse

[Optional] Additional options if sourceFormat is set to GOOGLE_SHEETS.

hivePartitioningOptions HivePartitioningOptionsResponse

[Optional] Options to configure hive partitioning support.

ignoreUnknownValues Boolean

[Optional] Indicates if BigQuery should allow extra values that are not represented in the table schema. If true, the extra values are ignored. If false, records with extra columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. The sourceFormat property determines what BigQuery treats as an extra value: CSV: Trailing columns JSON: Named values that don't match any column names Google Cloud Bigtable: This setting is ignored. Google Cloud Datastore backups: This setting is ignored. Avro: This setting is ignored.

jsonOptions JsonOptionsResponse

Additional properties to set if sourceFormat is set to NEWLINE_DELIMITED_JSON.

maxBadRecords Integer

[Optional] The maximum number of bad records that BigQuery can ignore when reading data. If the number of bad records exceeds this value, an invalid error is returned in the job result. This is only valid for CSV, JSON, and Google Sheets. The default value is 0, which requires that all records are valid. This setting is ignored for Google Cloud Bigtable, Google Cloud Datastore backups and Avro formats.

metadataCacheMode String

[Optional] Metadata Cache Mode for the table. Set this to enable caching of metadata from external data source.

objectMetadata String

ObjectMetadata is used to create Object Tables. Object Tables contain a listing of objects (with their metadata) found at the source_uris. If ObjectMetadata is set, source_format should be omitted. Currently SIMPLE is the only supported Object Metadata type.

parquetOptions ParquetOptionsResponse

Additional properties to set if sourceFormat is set to Parquet.

referenceFileSchemaUri String

[Optional] Provide a referencing file with the expected table schema. Enabled for the format: AVRO, PARQUET, ORC.

schema TableSchemaResponse

[Optional] The schema for the data. Schema is required for CSV and JSON formats. Schema is disallowed for Google Cloud Bigtable, Cloud Datastore backups, and Avro formats.

sourceFormat String

[Required] The data format. For CSV files, specify "CSV". For Google sheets, specify "GOOGLE_SHEETS". For newline-delimited JSON, specify "NEWLINE_DELIMITED_JSON". For Avro files, specify "AVRO". For Google Cloud Datastore backups, specify "DATASTORE_BACKUP". [Beta] For Google Cloud Bigtable, specify "BIGTABLE".

sourceUris List<String>

[Required] The fully-qualified URIs that point to your data in Google Cloud. For Google Cloud Storage URIs: Each URI can contain one '' wildcard character and it must come after the 'bucket' name. Size limits related to load jobs apply to external data sources. For Google Cloud Bigtable URIs: Exactly one URI can be specified and it has be a fully specified and valid HTTPS URL for a Google Cloud Bigtable table. For Google Cloud Datastore backups, exactly one URI can be specified. Also, the '' wildcard character is not allowed.

autodetect boolean

Try to detect schema and format options automatically. Any option specified explicitly will be honored.

avroOptions AvroOptionsResponse

Additional properties to set if sourceFormat is set to Avro.

bigtableOptions BigtableOptionsResponse

[Optional] Additional options if sourceFormat is set to BIGTABLE.

compression string

[Optional] The compression type of the data source. Possible values include GZIP and NONE. The default value is NONE. This setting is ignored for Google Cloud Bigtable, Google Cloud Datastore backups and Avro formats.

connectionId string

[Optional, Trusted Tester] Connection for external data source.

csvOptions CsvOptionsResponse

Additional properties to set if sourceFormat is set to CSV.

decimalTargetTypes string[]

[Optional] Defines the list of possible SQL data types to which the source decimal values are converted. This list and the precision and the scale parameters of the decimal field determine the target type. In the order of NUMERIC, BIGNUMERIC, and STRING, a type is picked if it is in the specified list and if it supports the precision and the scale. STRING supports all precision and scale values. If none of the listed types supports the precision and the scale, the type supporting the widest range in the specified list is picked, and if a value exceeds the supported range when reading the data, an error will be thrown. Example: Suppose the value of this field is ["NUMERIC", "BIGNUMERIC"]. If (precision,scale) is: (38,9) -> NUMERIC; (39,9) -> BIGNUMERIC (NUMERIC cannot hold 30 integer digits); (38,10) -> BIGNUMERIC (NUMERIC cannot hold 10 fractional digits); (76,38) -> BIGNUMERIC; (77,38) -> BIGNUMERIC (error if value exeeds supported range). This field cannot contain duplicate types. The order of the types in this field is ignored. For example, ["BIGNUMERIC", "NUMERIC"] is the same as ["NUMERIC", "BIGNUMERIC"] and NUMERIC always takes precedence over BIGNUMERIC. Defaults to ["NUMERIC", "STRING"] for ORC and ["NUMERIC"] for the other file formats.

fileSetSpecType string

[Optional] Specifies how source URIs are interpreted for constructing the file set to load. By default source URIs are expanded against the underlying storage. Other options include specifying manifest files. Only applicable to object storage systems.

googleSheetsOptions GoogleSheetsOptionsResponse

[Optional] Additional options if sourceFormat is set to GOOGLE_SHEETS.

hivePartitioningOptions HivePartitioningOptionsResponse

[Optional] Options to configure hive partitioning support.

ignoreUnknownValues boolean

[Optional] Indicates if BigQuery should allow extra values that are not represented in the table schema. If true, the extra values are ignored. If false, records with extra columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. The sourceFormat property determines what BigQuery treats as an extra value: CSV: Trailing columns JSON: Named values that don't match any column names Google Cloud Bigtable: This setting is ignored. Google Cloud Datastore backups: This setting is ignored. Avro: This setting is ignored.

jsonOptions JsonOptionsResponse

Additional properties to set if sourceFormat is set to NEWLINE_DELIMITED_JSON.

maxBadRecords number

[Optional] The maximum number of bad records that BigQuery can ignore when reading data. If the number of bad records exceeds this value, an invalid error is returned in the job result. This is only valid for CSV, JSON, and Google Sheets. The default value is 0, which requires that all records are valid. This setting is ignored for Google Cloud Bigtable, Google Cloud Datastore backups and Avro formats.

metadataCacheMode string

[Optional] Metadata Cache Mode for the table. Set this to enable caching of metadata from external data source.

objectMetadata string

ObjectMetadata is used to create Object Tables. Object Tables contain a listing of objects (with their metadata) found at the source_uris. If ObjectMetadata is set, source_format should be omitted. Currently SIMPLE is the only supported Object Metadata type.

parquetOptions ParquetOptionsResponse

Additional properties to set if sourceFormat is set to Parquet.

referenceFileSchemaUri string

[Optional] Provide a referencing file with the expected table schema. Enabled for the format: AVRO, PARQUET, ORC.

schema TableSchemaResponse

[Optional] The schema for the data. Schema is required for CSV and JSON formats. Schema is disallowed for Google Cloud Bigtable, Cloud Datastore backups, and Avro formats.

sourceFormat string

[Required] The data format. For CSV files, specify "CSV". For Google sheets, specify "GOOGLE_SHEETS". For newline-delimited JSON, specify "NEWLINE_DELIMITED_JSON". For Avro files, specify "AVRO". For Google Cloud Datastore backups, specify "DATASTORE_BACKUP". [Beta] For Google Cloud Bigtable, specify "BIGTABLE".

sourceUris string[]

[Required] The fully-qualified URIs that point to your data in Google Cloud. For Google Cloud Storage URIs: Each URI can contain one '' wildcard character and it must come after the 'bucket' name. Size limits related to load jobs apply to external data sources. For Google Cloud Bigtable URIs: Exactly one URI can be specified and it has be a fully specified and valid HTTPS URL for a Google Cloud Bigtable table. For Google Cloud Datastore backups, exactly one URI can be specified. Also, the '' wildcard character is not allowed.

autodetect bool

Try to detect schema and format options automatically. Any option specified explicitly will be honored.

avro_options AvroOptionsResponse

Additional properties to set if sourceFormat is set to Avro.

bigtable_options BigtableOptionsResponse

[Optional] Additional options if sourceFormat is set to BIGTABLE.

compression str

[Optional] The compression type of the data source. Possible values include GZIP and NONE. The default value is NONE. This setting is ignored for Google Cloud Bigtable, Google Cloud Datastore backups and Avro formats.

connection_id str

[Optional, Trusted Tester] Connection for external data source.

csv_options CsvOptionsResponse

Additional properties to set if sourceFormat is set to CSV.

decimal_target_types Sequence[str]

[Optional] Defines the list of possible SQL data types to which the source decimal values are converted. This list and the precision and the scale parameters of the decimal field determine the target type. In the order of NUMERIC, BIGNUMERIC, and STRING, a type is picked if it is in the specified list and if it supports the precision and the scale. STRING supports all precision and scale values. If none of the listed types supports the precision and the scale, the type supporting the widest range in the specified list is picked, and if a value exceeds the supported range when reading the data, an error will be thrown. Example: Suppose the value of this field is ["NUMERIC", "BIGNUMERIC"]. If (precision,scale) is: (38,9) -> NUMERIC; (39,9) -> BIGNUMERIC (NUMERIC cannot hold 30 integer digits); (38,10) -> BIGNUMERIC (NUMERIC cannot hold 10 fractional digits); (76,38) -> BIGNUMERIC; (77,38) -> BIGNUMERIC (error if value exeeds supported range). This field cannot contain duplicate types. The order of the types in this field is ignored. For example, ["BIGNUMERIC", "NUMERIC"] is the same as ["NUMERIC", "BIGNUMERIC"] and NUMERIC always takes precedence over BIGNUMERIC. Defaults to ["NUMERIC", "STRING"] for ORC and ["NUMERIC"] for the other file formats.

file_set_spec_type str

[Optional] Specifies how source URIs are interpreted for constructing the file set to load. By default source URIs are expanded against the underlying storage. Other options include specifying manifest files. Only applicable to object storage systems.

google_sheets_options GoogleSheetsOptionsResponse

[Optional] Additional options if sourceFormat is set to GOOGLE_SHEETS.

hive_partitioning_options HivePartitioningOptionsResponse

[Optional] Options to configure hive partitioning support.

ignore_unknown_values bool

[Optional] Indicates if BigQuery should allow extra values that are not represented in the table schema. If true, the extra values are ignored. If false, records with extra columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. The sourceFormat property determines what BigQuery treats as an extra value: CSV: Trailing columns JSON: Named values that don't match any column names Google Cloud Bigtable: This setting is ignored. Google Cloud Datastore backups: This setting is ignored. Avro: This setting is ignored.

json_options JsonOptionsResponse

Additional properties to set if sourceFormat is set to NEWLINE_DELIMITED_JSON.

max_bad_records int

[Optional] The maximum number of bad records that BigQuery can ignore when reading data. If the number of bad records exceeds this value, an invalid error is returned in the job result. This is only valid for CSV, JSON, and Google Sheets. The default value is 0, which requires that all records are valid. This setting is ignored for Google Cloud Bigtable, Google Cloud Datastore backups and Avro formats.

metadata_cache_mode str

[Optional] Metadata Cache Mode for the table. Set this to enable caching of metadata from external data source.

object_metadata str

ObjectMetadata is used to create Object Tables. Object Tables contain a listing of objects (with their metadata) found at the source_uris. If ObjectMetadata is set, source_format should be omitted. Currently SIMPLE is the only supported Object Metadata type.

parquet_options ParquetOptionsResponse

Additional properties to set if sourceFormat is set to Parquet.

reference_file_schema_uri str

[Optional] Provide a referencing file with the expected table schema. Enabled for the format: AVRO, PARQUET, ORC.

schema TableSchemaResponse

[Optional] The schema for the data. Schema is required for CSV and JSON formats. Schema is disallowed for Google Cloud Bigtable, Cloud Datastore backups, and Avro formats.

source_format str

[Required] The data format. For CSV files, specify "CSV". For Google sheets, specify "GOOGLE_SHEETS". For newline-delimited JSON, specify "NEWLINE_DELIMITED_JSON". For Avro files, specify "AVRO". For Google Cloud Datastore backups, specify "DATASTORE_BACKUP". [Beta] For Google Cloud Bigtable, specify "BIGTABLE".

source_uris Sequence[str]

[Required] The fully-qualified URIs that point to your data in Google Cloud. For Google Cloud Storage URIs: Each URI can contain one '' wildcard character and it must come after the 'bucket' name. Size limits related to load jobs apply to external data sources. For Google Cloud Bigtable URIs: Exactly one URI can be specified and it has be a fully specified and valid HTTPS URL for a Google Cloud Bigtable table. For Google Cloud Datastore backups, exactly one URI can be specified. Also, the '' wildcard character is not allowed.

autodetect Boolean

Try to detect schema and format options automatically. Any option specified explicitly will be honored.

avroOptions Property Map

Additional properties to set if sourceFormat is set to Avro.

bigtableOptions Property Map

[Optional] Additional options if sourceFormat is set to BIGTABLE.

compression String

[Optional] The compression type of the data source. Possible values include GZIP and NONE. The default value is NONE. This setting is ignored for Google Cloud Bigtable, Google Cloud Datastore backups and Avro formats.

connectionId String

[Optional, Trusted Tester] Connection for external data source.

csvOptions Property Map

Additional properties to set if sourceFormat is set to CSV.

decimalTargetTypes List<String>

[Optional] Defines the list of possible SQL data types to which the source decimal values are converted. This list and the precision and the scale parameters of the decimal field determine the target type. In the order of NUMERIC, BIGNUMERIC, and STRING, a type is picked if it is in the specified list and if it supports the precision and the scale. STRING supports all precision and scale values. If none of the listed types supports the precision and the scale, the type supporting the widest range in the specified list is picked, and if a value exceeds the supported range when reading the data, an error will be thrown. Example: Suppose the value of this field is ["NUMERIC", "BIGNUMERIC"]. If (precision,scale) is: (38,9) -> NUMERIC; (39,9) -> BIGNUMERIC (NUMERIC cannot hold 30 integer digits); (38,10) -> BIGNUMERIC (NUMERIC cannot hold 10 fractional digits); (76,38) -> BIGNUMERIC; (77,38) -> BIGNUMERIC (error if value exeeds supported range). This field cannot contain duplicate types. The order of the types in this field is ignored. For example, ["BIGNUMERIC", "NUMERIC"] is the same as ["NUMERIC", "BIGNUMERIC"] and NUMERIC always takes precedence over BIGNUMERIC. Defaults to ["NUMERIC", "STRING"] for ORC and ["NUMERIC"] for the other file formats.

fileSetSpecType String

[Optional] Specifies how source URIs are interpreted for constructing the file set to load. By default source URIs are expanded against the underlying storage. Other options include specifying manifest files. Only applicable to object storage systems.

googleSheetsOptions Property Map

[Optional] Additional options if sourceFormat is set to GOOGLE_SHEETS.

hivePartitioningOptions Property Map

[Optional] Options to configure hive partitioning support.

ignoreUnknownValues Boolean

[Optional] Indicates if BigQuery should allow extra values that are not represented in the table schema. If true, the extra values are ignored. If false, records with extra columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. The sourceFormat property determines what BigQuery treats as an extra value: CSV: Trailing columns JSON: Named values that don't match any column names Google Cloud Bigtable: This setting is ignored. Google Cloud Datastore backups: This setting is ignored. Avro: This setting is ignored.

jsonOptions Property Map

Additional properties to set if sourceFormat is set to NEWLINE_DELIMITED_JSON.

maxBadRecords Number

[Optional] The maximum number of bad records that BigQuery can ignore when reading data. If the number of bad records exceeds this value, an invalid error is returned in the job result. This is only valid for CSV, JSON, and Google Sheets. The default value is 0, which requires that all records are valid. This setting is ignored for Google Cloud Bigtable, Google Cloud Datastore backups and Avro formats.

metadataCacheMode String

[Optional] Metadata Cache Mode for the table. Set this to enable caching of metadata from external data source.

objectMetadata String

ObjectMetadata is used to create Object Tables. Object Tables contain a listing of objects (with their metadata) found at the source_uris. If ObjectMetadata is set, source_format should be omitted. Currently SIMPLE is the only supported Object Metadata type.

parquetOptions Property Map

Additional properties to set if sourceFormat is set to Parquet.

referenceFileSchemaUri String

[Optional] Provide a referencing file with the expected table schema. Enabled for the format: AVRO, PARQUET, ORC.

schema Property Map

[Optional] The schema for the data. Schema is required for CSV and JSON formats. Schema is disallowed for Google Cloud Bigtable, Cloud Datastore backups, and Avro formats.

sourceFormat String

[Required] The data format. For CSV files, specify "CSV". For Google sheets, specify "GOOGLE_SHEETS". For newline-delimited JSON, specify "NEWLINE_DELIMITED_JSON". For Avro files, specify "AVRO". For Google Cloud Datastore backups, specify "DATASTORE_BACKUP". [Beta] For Google Cloud Bigtable, specify "BIGTABLE".

sourceUris List<String>

[Required] The fully-qualified URIs that point to your data in Google Cloud. For Google Cloud Storage URIs: Each URI can contain one '' wildcard character and it must come after the 'bucket' name. Size limits related to load jobs apply to external data sources. For Google Cloud Bigtable URIs: Exactly one URI can be specified and it has be a fully specified and valid HTTPS URL for a Google Cloud Bigtable table. For Google Cloud Datastore backups, exactly one URI can be specified. Also, the '' wildcard character is not allowed.

Range string

[Optional] Range of a sheet to query from. Only used when non-empty. Typical format: sheet_name!top_left_cell_id:bottom_right_cell_id For example: sheet1!A1:B20

SkipLeadingRows string

[Optional] The number of rows at the top of a sheet that BigQuery will skip when reading the data. The default value is 0. This property is useful if you have header rows that should be skipped. When autodetect is on, behavior is the following: * skipLeadingRows unspecified - Autodetect tries to detect headers in the first row. If they are not detected, the row is read as data. Otherwise data is read starting from the second row. * skipLeadingRows is 0 - Instructs autodetect that there are no headers and data should be read starting from the first row. * skipLeadingRows = N > 0 - Autodetect skips N-1 rows and tries to detect headers in row N. If headers are not detected, row N is just skipped. Otherwise row N is used to extract column names for the detected schema.

Range string

[Optional] Range of a sheet to query from. Only used when non-empty. Typical format: sheet_name!top_left_cell_id:bottom_right_cell_id For example: sheet1!A1:B20

SkipLeadingRows string

[Optional] The number of rows at the top of a sheet that BigQuery will skip when reading the data. The default value is 0. This property is useful if you have header rows that should be skipped. When autodetect is on, behavior is the following: * skipLeadingRows unspecified - Autodetect tries to detect headers in the first row. If they are not detected, the row is read as data. Otherwise data is read starting from the second row. * skipLeadingRows is 0 - Instructs autodetect that there are no headers and data should be read starting from the first row. * skipLeadingRows = N > 0 - Autodetect skips N-1 rows and tries to detect headers in row N. If headers are not detected, row N is just skipped. Otherwise row N is used to extract column names for the detected schema.

range String

[Optional] Range of a sheet to query from. Only used when non-empty. Typical format: sheet_name!top_left_cell_id:bottom_right_cell_id For example: sheet1!A1:B20

skipLeadingRows String

[Optional] The number of rows at the top of a sheet that BigQuery will skip when reading the data. The default value is 0. This property is useful if you have header rows that should be skipped. When autodetect is on, behavior is the following: * skipLeadingRows unspecified - Autodetect tries to detect headers in the first row. If they are not detected, the row is read as data. Otherwise data is read starting from the second row. * skipLeadingRows is 0 - Instructs autodetect that there are no headers and data should be read starting from the first row. * skipLeadingRows = N > 0 - Autodetect skips N-1 rows and tries to detect headers in row N. If headers are not detected, row N is just skipped. Otherwise row N is used to extract column names for the detected schema.

range string

[Optional] Range of a sheet to query from. Only used when non-empty. Typical format: sheet_name!top_left_cell_id:bottom_right_cell_id For example: sheet1!A1:B20

skipLeadingRows string

[Optional] The number of rows at the top of a sheet that BigQuery will skip when reading the data. The default value is 0. This property is useful if you have header rows that should be skipped. When autodetect is on, behavior is the following: * skipLeadingRows unspecified - Autodetect tries to detect headers in the first row. If they are not detected, the row is read as data. Otherwise data is read starting from the second row. * skipLeadingRows is 0 - Instructs autodetect that there are no headers and data should be read starting from the first row. * skipLeadingRows = N > 0 - Autodetect skips N-1 rows and tries to detect headers in row N. If headers are not detected, row N is just skipped. Otherwise row N is used to extract column names for the detected schema.

range str

[Optional] Range of a sheet to query from. Only used when non-empty. Typical format: sheet_name!top_left_cell_id:bottom_right_cell_id For example: sheet1!A1:B20

skip_leading_rows str

[Optional] The number of rows at the top of a sheet that BigQuery will skip when reading the data. The default value is 0. This property is useful if you have header rows that should be skipped. When autodetect is on, behavior is the following: * skipLeadingRows unspecified - Autodetect tries to detect headers in the first row. If they are not detected, the row is read as data. Otherwise data is read starting from the second row. * skipLeadingRows is 0 - Instructs autodetect that there are no headers and data should be read starting from the first row. * skipLeadingRows = N > 0 - Autodetect skips N-1 rows and tries to detect headers in row N. If headers are not detected, row N is just skipped. Otherwise row N is used to extract column names for the detected schema.

range String

[Optional] Range of a sheet to query from. Only used when non-empty. Typical format: sheet_name!top_left_cell_id:bottom_right_cell_id For example: sheet1!A1:B20

skipLeadingRows String

[Optional] The number of rows at the top of a sheet that BigQuery will skip when reading the data. The default value is 0. This property is useful if you have header rows that should be skipped. When autodetect is on, behavior is the following: * skipLeadingRows unspecified - Autodetect tries to detect headers in the first row. If they are not detected, the row is read as data. Otherwise data is read starting from the second row. * skipLeadingRows is 0 - Instructs autodetect that there are no headers and data should be read starting from the first row. * skipLeadingRows = N > 0 - Autodetect skips N-1 rows and tries to detect headers in row N. If headers are not detected, row N is just skipped. Otherwise row N is used to extract column names for the detected schema.

Fields List<string>

For permanent external tables, this field is populated with the hive partition keys in the order they were inferred. The types of the partition keys can be deduced by checking the table schema (which will include the partition keys). Not every API will populate this field in the output. For example, Tables.Get will populate it, but Tables.List will not contain this field.

Mode string

[Optional] When set, what mode of hive partitioning to use when reading data. The following modes are supported. (1) AUTO: automatically infer partition key name(s) and type(s). (2) STRINGS: automatically infer partition key name(s). All types are interpreted as strings. (3) CUSTOM: partition key schema is encoded in the source URI prefix. Not all storage formats support hive partitioning. Requesting hive partitioning on an unsupported format will lead to an error. Currently supported types include: AVRO, CSV, JSON, ORC and Parquet.

RequirePartitionFilter bool

[Optional] If set to true, queries over this table require a partition filter that can be used for partition elimination to be specified. Note that this field should only be true when creating a permanent external table or querying a temporary external table. Hive-partitioned loads with requirePartitionFilter explicitly set to true will fail.

SourceUriPrefix string

[Optional] When hive partition detection is requested, a common prefix for all source uris should be supplied. The prefix must end immediately before the partition key encoding begins. For example, consider files following this data layout. gs://bucket/path_to_table/dt=2019-01-01/country=BR/id=7/file.avro gs://bucket/path_to_table/dt=2018-12-31/country=CA/id=3/file.avro When hive partitioning is requested with either AUTO or STRINGS detection, the common prefix can be either of gs://bucket/path_to_table or gs://bucket/path_to_table/ (trailing slash does not matter).

Fields []string

For permanent external tables, this field is populated with the hive partition keys in the order they were inferred. The types of the partition keys can be deduced by checking the table schema (which will include the partition keys). Not every API will populate this field in the output. For example, Tables.Get will populate it, but Tables.List will not contain this field.

Mode string

[Optional] When set, what mode of hive partitioning to use when reading data. The following modes are supported. (1) AUTO: automatically infer partition key name(s) and type(s). (2) STRINGS: automatically infer partition key name(s). All types are interpreted as strings. (3) CUSTOM: partition key schema is encoded in the source URI prefix. Not all storage formats support hive partitioning. Requesting hive partitioning on an unsupported format will lead to an error. Currently supported types include: AVRO, CSV, JSON, ORC and Parquet.

RequirePartitionFilter bool

[Optional] If set to true, queries over this table require a partition filter that can be used for partition elimination to be specified. Note that this field should only be true when creating a permanent external table or querying a temporary external table. Hive-partitioned loads with requirePartitionFilter explicitly set to true will fail.

SourceUriPrefix string

[Optional] When hive partition detection is requested, a common prefix for all source uris should be supplied. The prefix must end immediately before the partition key encoding begins. For example, consider files following this data layout. gs://bucket/path_to_table/dt=2019-01-01/country=BR/id=7/file.avro gs://bucket/path_to_table/dt=2018-12-31/country=CA/id=3/file.avro When hive partitioning is requested with either AUTO or STRINGS detection, the common prefix can be either of gs://bucket/path_to_table or gs://bucket/path_to_table/ (trailing slash does not matter).

fields List<String>

For permanent external tables, this field is populated with the hive partition keys in the order they were inferred. The types of the partition keys can be deduced by checking the table schema (which will include the partition keys). Not every API will populate this field in the output. For example, Tables.Get will populate it, but Tables.List will not contain this field.

mode String

[Optional] When set, what mode of hive partitioning to use when reading data. The following modes are supported. (1) AUTO: automatically infer partition key name(s) and type(s). (2) STRINGS: automatically infer partition key name(s). All types are interpreted as strings. (3) CUSTOM: partition key schema is encoded in the source URI prefix. Not all storage formats support hive partitioning. Requesting hive partitioning on an unsupported format will lead to an error. Currently supported types include: AVRO, CSV, JSON, ORC and Parquet.

requirePartitionFilter Boolean

[Optional] If set to true, queries over this table require a partition filter that can be used for partition elimination to be specified. Note that this field should only be true when creating a permanent external table or querying a temporary external table. Hive-partitioned loads with requirePartitionFilter explicitly set to true will fail.

sourceUriPrefix String

[Optional] When hive partition detection is requested, a common prefix for all source uris should be supplied. The prefix must end immediately before the partition key encoding begins. For example, consider files following this data layout. gs://bucket/path_to_table/dt=2019-01-01/country=BR/id=7/file.avro gs://bucket/path_to_table/dt=2018-12-31/country=CA/id=3/file.avro When hive partitioning is requested with either AUTO or STRINGS detection, the common prefix can be either of gs://bucket/path_to_table or gs://bucket/path_to_table/ (trailing slash does not matter).

fields string[]

For permanent external tables, this field is populated with the hive partition keys in the order they were inferred. The types of the partition keys can be deduced by checking the table schema (which will include the partition keys). Not every API will populate this field in the output. For example, Tables.Get will populate it, but Tables.List will not contain this field.

mode string

[Optional] When set, what mode of hive partitioning to use when reading data. The following modes are supported. (1) AUTO: automatically infer partition key name(s) and type(s). (2) STRINGS: automatically infer partition key name(s). All types are interpreted as strings. (3) CUSTOM: partition key schema is encoded in the source URI prefix. Not all storage formats support hive partitioning. Requesting hive partitioning on an unsupported format will lead to an error. Currently supported types include: AVRO, CSV, JSON, ORC and Parquet.

requirePartitionFilter boolean

[Optional] If set to true, queries over this table require a partition filter that can be used for partition elimination to be specified. Note that this field should only be true when creating a permanent external table or querying a temporary external table. Hive-partitioned loads with requirePartitionFilter explicitly set to true will fail.

sourceUriPrefix string

[Optional] When hive partition detection is requested, a common prefix for all source uris should be supplied. The prefix must end immediately before the partition key encoding begins. For example, consider files following this data layout. gs://bucket/path_to_table/dt=2019-01-01/country=BR/id=7/file.avro gs://bucket/path_to_table/dt=2018-12-31/country=CA/id=3/file.avro When hive partitioning is requested with either AUTO or STRINGS detection, the common prefix can be either of gs://bucket/path_to_table or gs://bucket/path_to_table/ (trailing slash does not matter).

fields Sequence[str]

For permanent external tables, this field is populated with the hive partition keys in the order they were inferred. The types of the partition keys can be deduced by checking the table schema (which will include the partition keys). Not every API will populate this field in the output. For example, Tables.Get will populate it, but Tables.List will not contain this field.

mode str

[Optional] When set, what mode of hive partitioning to use when reading data. The following modes are supported. (1) AUTO: automatically infer partition key name(s) and type(s). (2) STRINGS: automatically infer partition key name(s). All types are interpreted as strings. (3) CUSTOM: partition key schema is encoded in the source URI prefix. Not all storage formats support hive partitioning. Requesting hive partitioning on an unsupported format will lead to an error. Currently supported types include: AVRO, CSV, JSON, ORC and Parquet.

require_partition_filter bool

[Optional] If set to true, queries over this table require a partition filter that can be used for partition elimination to be specified. Note that this field should only be true when creating a permanent external table or querying a temporary external table. Hive-partitioned loads with requirePartitionFilter explicitly set to true will fail.

source_uri_prefix str

[Optional] When hive partition detection is requested, a common prefix for all source uris should be supplied. The prefix must end immediately before the partition key encoding begins. For example, consider files following this data layout. gs://bucket/path_to_table/dt=2019-01-01/country=BR/id=7/file.avro gs://bucket/path_to_table/dt=2018-12-31/country=CA/id=3/file.avro When hive partitioning is requested with either AUTO or STRINGS detection, the common prefix can be either of gs://bucket/path_to_table or gs://bucket/path_to_table/ (trailing slash does not matter).

fields List<String>

For permanent external tables, this field is populated with the hive partition keys in the order they were inferred. The types of the partition keys can be deduced by checking the table schema (which will include the partition keys). Not every API will populate this field in the output. For example, Tables.Get will populate it, but Tables.List will not contain this field.

mode String

[Optional] When set, what mode of hive partitioning to use when reading data. The following modes are supported. (1) AUTO: automatically infer partition key name(s) and type(s). (2) STRINGS: automatically infer partition key name(s). All types are interpreted as strings. (3) CUSTOM: partition key schema is encoded in the source URI prefix. Not all storage formats support hive partitioning. Requesting hive partitioning on an unsupported format will lead to an error. Currently supported types include: AVRO, CSV, JSON, ORC and Parquet.

requirePartitionFilter Boolean

[Optional] If set to true, queries over this table require a partition filter that can be used for partition elimination to be specified. Note that this field should only be true when creating a permanent external table or querying a temporary external table. Hive-partitioned loads with requirePartitionFilter explicitly set to true will fail.

sourceUriPrefix String

[Optional] When hive partition detection is requested, a common prefix for all source uris should be supplied. The prefix must end immediately before the partition key encoding begins. For example, consider files following this data layout. gs://bucket/path_to_table/dt=2019-01-01/country=BR/id=7/file.avro gs://bucket/path_to_table/dt=2018-12-31/country=CA/id=3/file.avro When hive partitioning is requested with either AUTO or STRINGS detection, the common prefix can be either of gs://bucket/path_to_table or gs://bucket/path_to_table/ (trailing slash does not matter).

Encoding string

[Optional] The character encoding of the data. The supported values are UTF-8, UTF-16BE, UTF-16LE, UTF-32BE, and UTF-32LE. The default value is UTF-8.

Encoding string

[Optional] The character encoding of the data. The supported values are UTF-8, UTF-16BE, UTF-16LE, UTF-32BE, and UTF-32LE. The default value is UTF-8.

encoding String

[Optional] The character encoding of the data. The supported values are UTF-8, UTF-16BE, UTF-16LE, UTF-32BE, and UTF-32LE. The default value is UTF-8.

encoding string

[Optional] The character encoding of the data. The supported values are UTF-8, UTF-16BE, UTF-16LE, UTF-32BE, and UTF-32LE. The default value is UTF-8.

encoding str

[Optional] The character encoding of the data. The supported values are UTF-8, UTF-16BE, UTF-16LE, UTF-32BE, and UTF-32LE. The default value is UTF-8.

encoding String

[Optional] The character encoding of the data. The supported values are UTF-8, UTF-16BE, UTF-16LE, UTF-32BE, and UTF-32LE. The default value is UTF-8.

AllowNonIncrementalDefinition bool

[Optional] Allow non incremental materialized view definition. The default value is "false".

EnableRefresh bool

[Optional] [TrustedTester] Enable automatic refresh of the materialized view when the base table is updated. The default value is "true".

LastRefreshTime string

[TrustedTester] The time when this materialized view was last modified, in milliseconds since the epoch.

MaxStaleness string

[Optional] Max staleness of data that could be returned when materizlized view is queried (formatted as Google SQL Interval type).

Query string

[Required] A query whose result is persisted.

RefreshIntervalMs string

[Optional] [TrustedTester] The maximum frequency at which this materialized view will be refreshed. The default value is "1800000" (30 minutes).

AllowNonIncrementalDefinition bool

[Optional] Allow non incremental materialized view definition. The default value is "false".

EnableRefresh bool

[Optional] [TrustedTester] Enable automatic refresh of the materialized view when the base table is updated. The default value is "true".

LastRefreshTime string

[TrustedTester] The time when this materialized view was last modified, in milliseconds since the epoch.

MaxStaleness string

[Optional] Max staleness of data that could be returned when materizlized view is queried (formatted as Google SQL Interval type).

Query string

[Required] A query whose result is persisted.

RefreshIntervalMs string

[Optional] [TrustedTester] The maximum frequency at which this materialized view will be refreshed. The default value is "1800000" (30 minutes).

allowNonIncrementalDefinition Boolean

[Optional] Allow non incremental materialized view definition. The default value is "false".

enableRefresh Boolean

[Optional] [TrustedTester] Enable automatic refresh of the materialized view when the base table is updated. The default value is "true".

lastRefreshTime String

[TrustedTester] The time when this materialized view was last modified, in milliseconds since the epoch.

maxStaleness String

[Optional] Max staleness of data that could be returned when materizlized view is queried (formatted as Google SQL Interval type).

query String

[Required] A query whose result is persisted.

refreshIntervalMs String

[Optional] [TrustedTester] The maximum frequency at which this materialized view will be refreshed. The default value is "1800000" (30 minutes).

allowNonIncrementalDefinition boolean

[Optional] Allow non incremental materialized view definition. The default value is "false".

enableRefresh boolean

[Optional] [TrustedTester] Enable automatic refresh of the materialized view when the base table is updated. The default value is "true".

lastRefreshTime string

[TrustedTester] The time when this materialized view was last modified, in milliseconds since the epoch.

maxStaleness string

[Optional] Max staleness of data that could be returned when materizlized view is queried (formatted as Google SQL Interval type).

query string

[Required] A query whose result is persisted.

refreshIntervalMs string

[Optional] [TrustedTester] The maximum frequency at which this materialized view will be refreshed. The default value is "1800000" (30 minutes).

allow_non_incremental_definition bool

[Optional] Allow non incremental materialized view definition. The default value is "false".

enable_refresh bool

[Optional] [TrustedTester] Enable automatic refresh of the materialized view when the base table is updated. The default value is "true".

last_refresh_time str

[TrustedTester] The time when this materialized view was last modified, in milliseconds since the epoch.

max_staleness str

[Optional] Max staleness of data that could be returned when materizlized view is queried (formatted as Google SQL Interval type).

query str

[Required] A query whose result is persisted.

refresh_interval_ms str

[Optional] [TrustedTester] The maximum frequency at which this materialized view will be refreshed. The default value is "1800000" (30 minutes).

allowNonIncrementalDefinition Boolean

[Optional] Allow non incremental materialized view definition. The default value is "false".

enableRefresh Boolean

[Optional] [TrustedTester] Enable automatic refresh of the materialized view when the base table is updated. The default value is "true".

lastRefreshTime String

[TrustedTester] The time when this materialized view was last modified, in milliseconds since the epoch.

maxStaleness String

[Optional] Max staleness of data that could be returned when materizlized view is queried (formatted as Google SQL Interval type).

query String

[Required] A query whose result is persisted.

refreshIntervalMs String

[Optional] [TrustedTester] The maximum frequency at which this materialized view will be refreshed. The default value is "1800000" (30 minutes).

Labels List<string>

LossType string

ModelType string

Labels []string

LossType string

ModelType string

labels List<String>

lossType String

modelType String

labels string[]

lossType string

modelType string

labels Sequence[str]

loss_type str

model_type str

labels List<String>

lossType String

modelType String

ModelOptions Pulumi.GoogleNative.BigQuery.V2.Inputs.ModelDefinitionModelOptionsResponse

[Output-only, Beta] Model options used for the first training run. These options are immutable for subsequent training runs. Default values are used for any options not specified in the input query.

TrainingRuns List<Pulumi.GoogleNative.BigQuery.V2.Inputs.BqmlTrainingRunResponse>

[Output-only, Beta] Information about ml training runs, each training run comprises of multiple iterations and there may be multiple training runs for the model if warm start is used or if a user decides to continue a previously cancelled query.

ModelOptions ModelDefinitionModelOptionsResponse

[Output-only, Beta] Model options used for the first training run. These options are immutable for subsequent training runs. Default values are used for any options not specified in the input query.

TrainingRuns []BqmlTrainingRunResponse

[Output-only, Beta] Information about ml training runs, each training run comprises of multiple iterations and there may be multiple training runs for the model if warm start is used or if a user decides to continue a previously cancelled query.

modelOptions ModelDefinitionModelOptionsResponse

[Output-only, Beta] Model options used for the first training run. These options are immutable for subsequent training runs. Default values are used for any options not specified in the input query.

trainingRuns List<BqmlTrainingRunResponse>

[Output-only, Beta] Information about ml training runs, each training run comprises of multiple iterations and there may be multiple training runs for the model if warm start is used or if a user decides to continue a previously cancelled query.

modelOptions ModelDefinitionModelOptionsResponse

[Output-only, Beta] Model options used for the first training run. These options are immutable for subsequent training runs. Default values are used for any options not specified in the input query.

trainingRuns BqmlTrainingRunResponse[]

[Output-only, Beta] Information about ml training runs, each training run comprises of multiple iterations and there may be multiple training runs for the model if warm start is used or if a user decides to continue a previously cancelled query.

model_options ModelDefinitionModelOptionsResponse

[Output-only, Beta] Model options used for the first training run. These options are immutable for subsequent training runs. Default values are used for any options not specified in the input query.

training_runs Sequence[BqmlTrainingRunResponse]

[Output-only, Beta] Information about ml training runs, each training run comprises of multiple iterations and there may be multiple training runs for the model if warm start is used or if a user decides to continue a previously cancelled query.

modelOptions Property Map

[Output-only, Beta] Model options used for the first training run. These options are immutable for subsequent training runs. Default values are used for any options not specified in the input query.

trainingRuns List<Property Map>

[Output-only, Beta] Information about ml training runs, each training run comprises of multiple iterations and there may be multiple training runs for the model if warm start is used or if a user decides to continue a previously cancelled query.

EnableListInference bool

[Optional] Indicates whether to use schema inference specifically for Parquet LIST logical type.

EnumAsString bool

[Optional] Indicates whether to infer Parquet ENUM logical type as STRING instead of BYTES by default.

EnableListInference bool

[Optional] Indicates whether to use schema inference specifically for Parquet LIST logical type.

EnumAsString bool

[Optional] Indicates whether to infer Parquet ENUM logical type as STRING instead of BYTES by default.

enableListInference Boolean

[Optional] Indicates whether to use schema inference specifically for Parquet LIST logical type.

enumAsString Boolean

[Optional] Indicates whether to infer Parquet ENUM logical type as STRING instead of BYTES by default.

enableListInference boolean

[Optional] Indicates whether to use schema inference specifically for Parquet LIST logical type.

enumAsString boolean

[Optional] Indicates whether to infer Parquet ENUM logical type as STRING instead of BYTES by default.

enable_list_inference bool

[Optional] Indicates whether to use schema inference specifically for Parquet LIST logical type.

enum_as_string bool

[Optional] Indicates whether to infer Parquet ENUM logical type as STRING instead of BYTES by default.

enableListInference Boolean

[Optional] Indicates whether to use schema inference specifically for Parquet LIST logical type.

enumAsString Boolean

[Optional] Indicates whether to infer Parquet ENUM logical type as STRING instead of BYTES by default.

End string

[TrustedTester] [Required] The end of range partitioning, exclusive.

Interval string

[TrustedTester] [Required] The width of each interval.

Start string

[TrustedTester] [Required] The start of range partitioning, inclusive.

End string

[TrustedTester] [Required] The end of range partitioning, exclusive.

Interval string

[TrustedTester] [Required] The width of each interval.

Start string

[TrustedTester] [Required] The start of range partitioning, inclusive.

end String

[TrustedTester] [Required] The end of range partitioning, exclusive.

interval String

[TrustedTester] [Required] The width of each interval.

start String

[TrustedTester] [Required] The start of range partitioning, inclusive.

end string

[TrustedTester] [Required] The end of range partitioning, exclusive.

interval string

[TrustedTester] [Required] The width of each interval.

start string

[TrustedTester] [Required] The start of range partitioning, inclusive.

end str

[TrustedTester] [Required] The end of range partitioning, exclusive.

interval str

[TrustedTester] [Required] The width of each interval.

start str

[TrustedTester] [Required] The start of range partitioning, inclusive.

end String

[TrustedTester] [Required] The end of range partitioning, exclusive.

interval String

[TrustedTester] [Required] The width of each interval.

start String

[TrustedTester] [Required] The start of range partitioning, inclusive.

Field string

[TrustedTester] [Required] The table is partitioned by this field. The field must be a top-level NULLABLE/REQUIRED field. The only supported type is INTEGER/INT64.

Range Pulumi.GoogleNative.BigQuery.V2.Inputs.RangePartitioningRangeResponse

[TrustedTester] [Required] Defines the ranges for range partitioning.

Field string

[TrustedTester] [Required] The table is partitioned by this field. The field must be a top-level NULLABLE/REQUIRED field. The only supported type is INTEGER/INT64.

Range RangePartitioningRangeResponse

[TrustedTester] [Required] Defines the ranges for range partitioning.

field String

[TrustedTester] [Required] The table is partitioned by this field. The field must be a top-level NULLABLE/REQUIRED field. The only supported type is INTEGER/INT64.

range RangePartitioningRangeResponse

[TrustedTester] [Required] Defines the ranges for range partitioning.

field string

[TrustedTester] [Required] The table is partitioned by this field. The field must be a top-level NULLABLE/REQUIRED field. The only supported type is INTEGER/INT64.

range RangePartitioningRangeResponse

[TrustedTester] [Required] Defines the ranges for range partitioning.

field str

[TrustedTester] [Required] The table is partitioned by this field. The field must be a top-level NULLABLE/REQUIRED field. The only supported type is INTEGER/INT64.

range RangePartitioningRangeResponse

[TrustedTester] [Required] Defines the ranges for range partitioning.

field String

[TrustedTester] [Required] The table is partitioned by this field. The field must be a top-level NULLABLE/REQUIRED field. The only supported type is INTEGER/INT64.

range Property Map

[TrustedTester] [Required] Defines the ranges for range partitioning.

BaseTableReference Pulumi.GoogleNative.BigQuery.V2.Inputs.TableReferenceResponse

[Required] Reference describing the ID of the table that was snapshot.

SnapshotTime string

[Required] The time at which the base table was snapshot. This value is reported in the JSON response using RFC3339 format.

BaseTableReference TableReferenceResponse

[Required] Reference describing the ID of the table that was snapshot.

SnapshotTime string

[Required] The time at which the base table was snapshot. This value is reported in the JSON response using RFC3339 format.

baseTableReference TableReferenceResponse

[Required] Reference describing the ID of the table that was snapshot.

snapshotTime String

[Required] The time at which the base table was snapshot. This value is reported in the JSON response using RFC3339 format.

baseTableReference TableReferenceResponse

[Required] Reference describing the ID of the table that was snapshot.

snapshotTime string

[Required] The time at which the base table was snapshot. This value is reported in the JSON response using RFC3339 format.

base_table_reference TableReferenceResponse

[Required] Reference describing the ID of the table that was snapshot.

snapshot_time str

[Required] The time at which the base table was snapshot. This value is reported in the JSON response using RFC3339 format.

baseTableReference Property Map

[Required] Reference describing the ID of the table that was snapshot.

snapshotTime String

[Required] The time at which the base table was snapshot. This value is reported in the JSON response using RFC3339 format.

EstimatedBytes string

A lower-bound estimate of the number of bytes currently in the streaming buffer.

EstimatedRows string

A lower-bound estimate of the number of rows currently in the streaming buffer.

OldestEntryTime string

Contains the timestamp of the oldest entry in the streaming buffer, in milliseconds since the epoch, if the streaming buffer is available.

EstimatedBytes string

A lower-bound estimate of the number of bytes currently in the streaming buffer.

EstimatedRows string

A lower-bound estimate of the number of rows currently in the streaming buffer.

OldestEntryTime string

Contains the timestamp of the oldest entry in the streaming buffer, in milliseconds since the epoch, if the streaming buffer is available.

estimatedBytes String

A lower-bound estimate of the number of bytes currently in the streaming buffer.

estimatedRows String

A lower-bound estimate of the number of rows currently in the streaming buffer.

oldestEntryTime String

Contains the timestamp of the oldest entry in the streaming buffer, in milliseconds since the epoch, if the streaming buffer is available.

estimatedBytes string

A lower-bound estimate of the number of bytes currently in the streaming buffer.

estimatedRows string

A lower-bound estimate of the number of rows currently in the streaming buffer.

oldestEntryTime string

Contains the timestamp of the oldest entry in the streaming buffer, in milliseconds since the epoch, if the streaming buffer is available.

estimated_bytes str

A lower-bound estimate of the number of bytes currently in the streaming buffer.

estimated_rows str

A lower-bound estimate of the number of rows currently in the streaming buffer.

oldest_entry_time str

Contains the timestamp of the oldest entry in the streaming buffer, in milliseconds since the epoch, if the streaming buffer is available.

estimatedBytes String

A lower-bound estimate of the number of bytes currently in the streaming buffer.

estimatedRows String

A lower-bound estimate of the number of rows currently in the streaming buffer.

oldestEntryTime String

Contains the timestamp of the oldest entry in the streaming buffer, in milliseconds since the epoch, if the streaming buffer is available.