pluginsplugin-gcpbigquery

UpdateDataset​Update​Dataset

Update a BigQuery dataset.

yaml
type: "io.kestra.plugin.gcp.bigquery.UpdateDataset"
yaml
id: gcp_bq_update_dataset
namespace: company.team

tasks:
  - id: update_dataset
    type: io.kestra.plugin.gcp.bigquery.UpdateDataset
    name: "my_dataset"
    location: "EU"
    friendlyName: "new Friendly Name"
Properties

The dataset's user-defined ID.

SubType

The dataset's access control configuration.

The default encryption key for all tables in the dataset.

Once this property is set, all newly-created partitioned tables in the dataset will have encryption key set to this value, unless table creation request (or query) overrides the key.

Optional The default partition expiration time for all partitioned tables in the dataset, in milliseconds.

Once this property is set, all newly-created partitioned tables in the dataset will has an expirationMs property in the timePartitioning settings set to this value. Changing the value only affect new tables, not existing ones. The storage in a partition will have an expiration time of its partition time plus this value. Setting this property overrides the use of defaultTableExpirationMs for partitioned tables: only one of defaultTableExpirationMs and defaultPartitionExpirationMs will be used for any new partitioned table. If you provide an explicit timePartitioning.expirationMs when creating or updating a partitioned table, that value takes precedence over the default partition expiration time indicated by this property. The value may be null.

The default lifetime of all tables in the dataset, in milliseconds.

The minimum value is 3600000 milliseconds (one hour). Once this property is set, all newly-created tables in the dataset will have an expirationTime property set to the creation time plus the value in this property, and changing the value will only affect new tables, not existing ones. When the expirationTime for a given table is reached, that table will be deleted automatically. If a table's expirationTime is modified or removed before the table expires, or if you provide an explicit expirationTime when creating a table, that value takes precedence over the default expiration time indicated by this property. This property is experimental and might be subject to change or removed.

The dataset description.

A user-friendly description for the dataset.

A user-friendly name for the dataset.

The GCP service account to impersonate.

SubType string

The dataset's labels.

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.

The dataset's user-defined ID.

A user-friendly description for the dataset.

A user-friendly name for the dataset.

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.

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
DOMAINGROUPUSERIAM_MEMBER

The type of the entity (USER, GROUP, DOMAIN or IAM_MEMBER).

The value for the entity.

For example, user email if the type is USER.

Format duration
Format duration
Default RETRY_FAILED_TASK
Possible Values
RETRY_FAILED_TASKCREATE_NEW_EXECUTION
Minimum >= 1
Format duration
Default false

The GCP entity.

Possible Values
READERWRITEROWNER

The role to assign to the entity.