Google Cloud TableMetadata

Google Cloud TableMetadata

Certified

Get BigQuery table metadata

Retrieves metadata for a table or partition. Can return empty output instead of failing when the table is missing.

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

Dataset ID

Target dataset name

Table ID

Target table name

DefaultERROR
Possible Values
ERRORSKIP

Missing table policy

ERROR by default. Use SKIP to return an empty output when the table does not exist.

The GCP service account to impersonate

Dataset location

Optional BigQuery location for created or targeted resources. Experimental and may change; see BigQuery dataset location documentation.

Reference (ref) of the pluginDefaults to apply to this task.

The GCP project ID

Automatic BigQuery retry policy

Optional custom retry policy for retryable BigQuery errors. If unset, uses an exponential backoff starting at 5s (per-attempt interval capped at 60m), with a total duration of up to 15m and a maximum of 10 attempts.

Definitions

Retry with a fixed delay between attempts.

interval*Requiredstring
Formatduration
type*Requiredobject
behaviorstring
DefaultRETRY_FAILED_TASK
Possible Values
RETRY_FAILED_TASKCREATE_NEW_EXECUTION
maxAttemptsinteger
Minimum>= 1
maxDurationstring
Formatduration
warningOnRetryboolean
Defaultfalse

Retry with exponentially increasing delays between attempts.

interval*Requiredstring
Formatduration
maxInterval*Requiredstring
Formatduration
type*Requiredobject
behaviorstring
DefaultRETRY_FAILED_TASK
Possible Values
RETRY_FAILED_TASKCREATE_NEW_EXECUTION
delayFactornumber
maxAttemptsinteger
Minimum>= 1
maxDurationstring
Formatduration
warningOnRetryboolean
Defaultfalse

Retry with a random delay within a configurable range between attempts.

maxInterval*Requiredstring
Formatduration
minInterval*Requiredstring
Formatduration
type*Requiredobject
behaviorstring
DefaultRETRY_FAILED_TASK
Possible Values
RETRY_FAILED_TASKCREATE_NEW_EXECUTION
maxAttemptsinteger
Minimum>= 1
maxDurationstring
Formatduration
warningOnRetryboolean
Defaultfalse
SubTypestring
Default["due to concurrent update","Retrying the job may solve the problem","Retrying may solve the problem"]

Retry message substrings

Case-insensitive substrings that, if found in the error message, trigger an automatic retry

SubTypestring
Default["rateLimitExceeded","jobBackendError","backendError","internalError","jobInternalError"]

Retry reasons

BigQuery error reasons that trigger an automatic retry; evaluated against error reason strings

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

The GCP scopes to be used

The GCP service account

Formatdate-time

Creation time

Dataset ID

Table definition

Definitions
externalTableDefinition
autodetectboolean
compressionstring
formatTypestring
Possible Values
CSVJSONBIGTABLEDATASTORE_BACKUPAVROGOOGLE_SHEETSPARQUETORC
ignoreUnknownValuesboolean
maxBadRecordsinteger
sourceUrisarray
SubTypestring
materializedViewDefinition
enableRefreshboolean
lastRefreshDatestring
Formatdate-time
querystring
refreshIntervalstring
Formatduration
schema
fieldsarray
descriptionstring
modestring
Possible Values
NULLABLEREQUIREDREPEATED
namestring
policyTags
subFieldsarray
typestring
Possible Values
BOOLINT64FLOAT64NUMERICBIGNUMERICSTRINGBYTESSTRUCTARRAYTIMESTAMPDATETIMEDATETIMEGEOGRAPHYJSONINTERVALRANGE
standardTableDefinition
clusteringarray
SubTypestring
rangePartitioning
fieldstring
range
streamingBuffer
estimatedBytesinteger
estimatedRowsinteger
oldestEntryTimeinteger
timePartitioning
expirationstring
Formatduration
fieldstring
requirePartitionFilterboolean
typestring
Possible Values
DAYHOURMONTHYEAR
typestring
Possible Values
TABLEVIEWMATERIALIZED_VIEWEXTERNALMODEL
viewDefinition
querystring
viewUserDefinedFunctionsarray
contentstring
typestring
Possible Values
INLINEFROM_URI

Description

Encryption configuration

Definitions
kmsKeyNamestring

Table etag

Formatdate-time

Expiration time

If absent, the table persists indefinitely; expired tables are deleted

Friendly name

Service-generated table id

SubTypestring

Labels

Formatdate-time

Last modified time

Size in bytes

Long-term storage bytes

Bytes billed at long-term storage rates

Row count

Project ID

Require partition filter

True when queries must specify a partition filter for partition elimination

Table name