Get a BigQuery table’s metadata.

yaml
type: "io.kestra.plugin.gcp.bigquery.tablemetadata"

Examples

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*string

The dataset's user-defined ID.

table*string

The table's user-defined ID.

ifNotExistsstring

DefaultERROR

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.

impersonatedServiceAccountstring

The GCP service account to impersonate.

locationstring

The geographic location where the dataset should reside.

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

See Dataset Location

projectIdstring

The GCP project ID.

retryAuto

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

Definitions

io.kestra.core.models.tasks.retrys.Constant

interval*string

Formatduration

type*object

behaviorstring

DefaultRETRY_FAILED_TASK

Possible Values

RETRY_FAILED_TASKCREATE_NEW_EXECUTION

maxAttemptsinteger

Minimum>= 1

maxDurationstring

Formatduration

warningOnRetryboolean

Defaultfalse

io.kestra.core.models.tasks.retrys.Exponential

interval*string

Formatduration

maxInterval*string

Formatduration

type*object

behaviorstring

DefaultRETRY_FAILED_TASK

Possible Values

RETRY_FAILED_TASKCREATE_NEW_EXECUTION

delayFactornumber

maxAttemptsinteger

Minimum>= 1

maxDurationstring

Formatduration

warningOnRetryboolean

Defaultfalse

io.kestra.core.models.tasks.retrys.Random

maxInterval*string

Formatduration

minInterval*string

Formatduration

type*object

behaviorstring

DefaultRETRY_FAILED_TASK

Possible Values

RETRY_FAILED_TASKCREATE_NEW_EXECUTION

maxAttemptsinteger

Minimum>= 1

maxDurationstring

Formatduration

warningOnRetryboolean

Defaultfalse

retryMessagesarray

SubTypestring

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.

retryReasonsarray

SubTypestring

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

The reasons which would trigger an automatic retry.

scopesarray

SubTypestring

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

The GCP scopes to be used.

serviceAccountstring

The GCP service account.

Outputs

creationTimestring

Formatdate-time

The time when this table was created.

datasetIdstring

The dataset's ID.

definition

The table definition.

Definitions

io.kestra.plugin.gcp.bigquery.models.TableDefinition-Output

externalTableDefinition

io.kestra.plugin.gcp.bigquery.models.ExternalTableDefinition-Output

autodetectboolean

compressionstring

formatTypestring

Possible Values

CSVJSONBIGTABLEDATASTORE_BACKUPAVROGOOGLE_SHEETSPARQUETORC

ignoreUnknownValuesboolean

maxBadRecordsinteger

sourceUrisarray

SubTypestring

materializedViewDefinition

io.kestra.plugin.gcp.bigquery.models.MaterializedViewDefinition-Output

enableRefreshboolean

lastRefreshDatestring

Formatdate-time

querystring

refreshIntervalstring

Formatduration

schema

io.kestra.plugin.gcp.bigquery.models.Schema-Output

fieldsarray

io.kestra.plugin.gcp.bigquery.models.Field-Output

descriptionstring

modestring

Possible Values

NULLABLEREQUIREDREPEATED

namestring

policyTags

subFieldsarray

typestring

Possible Values

BOOLINT64FLOAT64NUMERICBIGNUMERICSTRINGBYTESSTRUCTARRAYTIMESTAMPDATETIMEDATETIMEGEOGRAPHYJSONINTERVALRANGE

standardTableDefinition

io.kestra.plugin.gcp.bigquery.models.StandardTableDefinition-Output

clusteringarray

SubTypestring

rangePartitioning

io.kestra.plugin.gcp.bigquery.models.RangePartitioning-Output

fieldstring

range

streamingBuffer

com.google.cloud.bigquery.StandardTableDefinition-StreamingBuffer

estimatedBytesinteger

estimatedRowsinteger

oldestEntryTimeinteger

timePartitioning

io.kestra.plugin.gcp.bigquery.models.TimePartitioning-Output

expirationstring

Formatduration

fieldstring

requirePartitionFilterboolean

typestring

Possible Values

DAYHOURMONTHYEAR

typestring

Possible Values

TABLEVIEWMATERIALIZED_VIEWEXTERNALMODEL

viewDefinition

io.kestra.plugin.gcp.bigquery.models.ViewDefinition-Output

querystring

viewUserDefinedFunctionsarray

io.kestra.plugin.gcp.bigquery.models.UserDefinedFunction-Output

contentstring

typestring

Possible Values

INLINEFROM_URI

descriptionstring

The user-friendly description for the table.

encryptionConfiguration

The encryption configuration.

Definitions

io.kestra.plugin.gcp.bigquery.models.EncryptionConfiguration-Output

kmsKeyNamestring

etagstring

The hash of the table resource.

expirationTimestring

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

friendlyNamestring

The user-friendly name for the table.

generatedIdstring

The service-generated id for the table.

labelsobject

SubTypestring

Return a map for labels applied to the table.

lastModifiedTimestring

Formatdate-time

The time when this table was last modified.

numBytesinteger

The size of this table in bytes.

numLongTermBytesinteger

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

numRowsinteger

The number of rows of data in this table.

projectIdstring

The project's ID.

requirePartitionFilterboolean

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

selfLinkstring

The URL that can be used to access the resource again. The returned URL can be used for get or update requests.

tablestring

The table name.

Core

CoreStorageScript

Resend

Plugin Resend for Kestra

Messaging

MQTT

This sub-group of plugins contains tasks for using a MQTT message broker.

Messaging

More Plugins in this Category

Core

Resend

MQTT

1.2.0