PluginsPlugin GcpBigquery

TableMetadata​Table​Metadata

Get a BigQuery table’s metadata.

yaml
type: "io.kestra.plugin.gcp.bigquery.TableMetadata"
yaml
id: gcp_bq_table_metadata
namespace: company.team

tasks:
  - id: table_metadata
    type: io.kestra.plugin.gcp.bigquery.TableMetadata
    projectId: my-project
    dataset: my-dataset
    table: my-table
Properties

The dataset's user-defined ID.

The table's user-defined ID.

Default ERROR
Possible Values
ERRORSKIP

Policy to apply if a table don't exists.

If the policy is SKIP, the output will contain only null value, otherwise an error is raised.

The GCP service account to impersonate.

The geographic location where the dataset should reside.

This property is experimental and might be subject to change or removed.

See Dataset Location

The GCP project ID.

Automatic retry for retryable BigQuery exceptions.

Some exceptions (especially rate limit) are not retried by default by BigQuery client, we use by default a transparent retry (not the kestra one) to handle this case. The default values are exponential of 5 seconds for a maximum of 15 minutes and ten attempts

SubType string
Default ["due to concurrent update","Retrying the job may solve the problem","Retrying may solve the problem"]

The messages which would trigger an automatic retry.

Message is tested as a substring of the full message, and is case insensitive.

SubType string
Default ["rateLimitExceeded","jobBackendError","backendError","internalError","jobInternalError"]

The reasons which would trigger an automatic retry.

SubType string
Default ["https://www.googleapis.com/auth/cloud-platform"]

The GCP scopes to be used.

The GCP service account.

Format date-time

The time when this table was created.

The dataset's ID.

The table definition.

The user-friendly description for the table.

The encryption configuration.

The hash of the table resource.

Format date-time

Returns the time when this table expires.

If not present, the table will persist indefinitely. Expired tables will be deleted and their storage reclaimed.

The user-friendly name for the table.

The service-generated id for the table.

SubType string

Return a map for labels applied to the table.

Format date-time

The time when this table was last modified.

The size of this table in bytes.

The number of bytes considered "long-term storage" for reduced billing purposes.

The number of rows of data in this table.

The project's ID.

Return true if a partition filter (that can be used for partition elimination) is required for queries over this table.

The table name.

Format duration
Default RETRY_FAILED_TASK
Possible Values
RETRY_FAILED_TASKCREATE_NEW_EXECUTION
Minimum >= 1
Format duration
Default false
Format duration
Format duration
Default RETRY_FAILED_TASK
Possible Values
RETRY_FAILED_TASKCREATE_NEW_EXECUTION
Minimum >= 1
Format duration
Default false
Possible Values
NULLABLEREQUIREDREPEATED
SubType
Possible Values
BOOLINT64FLOAT64NUMERICBIGNUMERICSTRINGBYTESSTRUCTARRAYTIMESTAMPDATETIMEDATETIMEGEOGRAPHYJSONINTERVALRANGE
SubType
Format duration
Possible Values
DAYHOURMONTHYEAR
Possible Values
INLINEFROM_URI
Format duration
Format duration
Default RETRY_FAILED_TASK
Possible Values
RETRY_FAILED_TASKCREATE_NEW_EXECUTION
Minimum >= 1
Format duration
Default false
Possible Values
TABLEVIEWMATERIALIZED_VIEWEXTERNALMODEL
Possible Values
CSVJSONBIGTABLEDATASTORE_BACKUPAVROGOOGLE_SHEETSPARQUETORC
SubType string
Format date-time
Format duration
SubType string
SubType string