TableMetadata
Get a BigQuery table’s metadata.
type: "io.kestra.plugin.gcp.bigquery.TableMetadata"
Examples
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 *Requiredstring
The dataset's user-defined ID.
table *Requiredstring
The table's user-defined ID.
ifNotExists string
ERROR
ERROR
SKIP
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.
impersonatedServiceAccount string
The GCP service account to impersonate.
location string
The geographic location where the dataset should reside.
This property is experimental and might be subject to change or removed.
See Dataset Location
projectId string
The GCP project ID.
retryAuto Non-dynamicConstantExponentialRandom
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
retryMessages array
["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.
retryReasons array
["rateLimitExceeded","jobBackendError","backendError","internalError","jobInternalError"]
The reasons which would trigger an automatic retry.
scopes array
["https://www.googleapis.com/auth/cloud-platform"]
The GCP scopes to be used.
serviceAccount string
The GCP service account.
Outputs
creationTime string
date-time
The time when this table was created.
datasetId string
The dataset's ID.
definition TableDefinition-Output
The table definition.
description string
The user-friendly description for the table.
encryptionConfiguration EncryptionConfiguration-Output
The encryption configuration.
etag string
The hash of the table resource.
expirationTime string
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.
friendlyName string
The user-friendly name for the table.
generatedId string
The service-generated id for the table.
labels object
Return a map for labels applied to the table.
lastModifiedTime string
date-time
The time when this table was last modified.
numBytes integer
The size of this table in bytes.
numLongTermBytes integer
The number of bytes considered "long-term storage" for reduced billing purposes.
numRows integer
The number of rows of data in this table.
projectId string
The project's ID.
requirePartitionFilter boolean
Return true if a partition filter (that can be used for partition elimination) is required for queries over this table.
selfLink string
The URL that can be used to access the resource again. The returned URL can be used for get or update requests.
table string
The table name.
Definitions
io.kestra.core.models.tasks.retrys.Constant
interval *Requiredstring
duration
type *Requiredobject
behavior string
RETRY_FAILED_TASK
RETRY_FAILED_TASK
CREATE_NEW_EXECUTION
maxAttempts integer
>= 1
maxDuration string
duration
warningOnRetry boolean
false
io.kestra.plugin.gcp.bigquery.models.EncryptionConfiguration-Output
kmsKeyName string
io.kestra.core.models.tasks.retrys.Exponential
interval *Requiredstring
duration
maxInterval *Requiredstring
duration
type *Requiredobject
behavior string
RETRY_FAILED_TASK
RETRY_FAILED_TASK
CREATE_NEW_EXECUTION
delayFactor number
maxAttempts integer
>= 1
maxDuration string
duration
warningOnRetry boolean
false
io.kestra.plugin.gcp.bigquery.models.RangePartitioning-Range-Output
end integer
interval integer
start integer
com.google.cloud.bigquery.StandardTableDefinition-StreamingBuffer
estimatedBytes integer
estimatedRows integer
oldestEntryTime integer
io.kestra.plugin.gcp.bigquery.models.Field-Output
description string
mode string
NULLABLE
REQUIRED
REPEATED
name string
policyTags PolicyTags-Output
type string
BOOL
INT64
FLOAT64
NUMERIC
BIGNUMERIC
STRING
BYTES
STRUCT
ARRAY
TIMESTAMP
DATE
TIME
DATETIME
GEOGRAPHY
JSON
INTERVAL
RANGE
io.kestra.plugin.gcp.bigquery.models.ViewDefinition-Output
io.kestra.plugin.gcp.bigquery.models.TimePartitioning-Output
expiration string
duration
field string
requirePartitionFilter boolean
type string
DAY
HOUR
MONTH
YEAR
io.kestra.plugin.gcp.bigquery.models.UserDefinedFunction-Output
content string
type string
INLINE
FROM_URI
io.kestra.core.models.tasks.retrys.Random
maxInterval *Requiredstring
duration
minInterval *Requiredstring
duration
type *Requiredobject
behavior string
RETRY_FAILED_TASK
RETRY_FAILED_TASK
CREATE_NEW_EXECUTION
maxAttempts integer
>= 1
maxDuration string
duration
warningOnRetry boolean
false
io.kestra.plugin.gcp.bigquery.models.TableDefinition-Output
externalTableDefinition ExternalTableDefinition-Output
materializedViewDefinition MaterializedViewDefinition-Output
schema Schema-Output
standardTableDefinition StandardTableDefinition-Output
type string
TABLE
VIEW
MATERIALIZED_VIEW
EXTERNAL
MODEL
viewDefinition ViewDefinition-Output
io.kestra.plugin.gcp.bigquery.models.ExternalTableDefinition-Output
autodetect boolean
compression string
formatType string
CSV
JSON
BIGTABLE
DATASTORE_BACKUP
AVRO
GOOGLE_SHEETS
PARQUET
ORC
ignoreUnknownValues boolean
maxBadRecords integer
sourceUris array
io.kestra.plugin.gcp.bigquery.models.MaterializedViewDefinition-Output
enableRefresh boolean
lastRefreshDate string
date-time
query string
refreshInterval string
duration