Google Cloud UpdateDataset

Google Cloud UpdateDataset

Certified

Update BigQuery dataset metadata

Updates dataset properties such as friendly name, description, ACLs, labels, location, defaults, and encryption configuration.

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

Dataset ID

Required dataset identifier

Access controls

List of dataset ACL entries (see AccessControl)

Definitions
entity*

The GCP entity

type*string
Possible Values
DOMAINGROUPUSERIAM_MEMBER

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

value*string

The value for the entity

For example, user email if the type is USER.

role*string
Possible Values
READERWRITEROWNER

The role to assign to the entity

Assets this task consumes as inputs or produces as outputs, for lineage tracking and the asset graph (Enterprise Edition). A flow declaring this property on a task is rejected in the open-source edition.

Definitions
assetFailureBehaviorstring
Possible Values
IGNOREFAILWARN

Asset failure behavior

Behavior applied to the task state when a declared asset fails to render, emit, or be persisted (e.g. a lock conflict): FAIL escalates it to FAILED, WARN (default) warns it if it would otherwise succeed, IGNORE leaves the state untouched.

enableAutobooleanstring

Whether to auto-register assets referenced dynamically at runtime that are not statically declared in inputs or outputs.

inputsarray

The assets consumed as inputs.

id*string
Min length1
typestring
outputs

The assets produced as outputs.

id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*string
Min length1

Custom asset type

descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150

Default table encryption key

CMEK applied to newly created tables unless overridden

Definitions
kmsKeyNamestring

Default partition expiration (ms)

Applied to new partitioned tables only; overrides defaultTableLifetime for partitions

Default table expiration (ms)

Minimum 3,600,000 ms (1h). Applies to new tables only; existing tables keep their own expiration. Experimental.

Dataset description

User-friendly description; supports templating

Dataset display name

The GCP service account to impersonate

Dataset labels

Dataset location

Optional BigQuery location; experimental and may change. See BigQuery dataset location docs.

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*string
Formatduration
type*object
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*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

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

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

Dataset ID

Dataset description

Dataset display name

Dataset location

Optional BigQuery location; experimental and may change

GCP project ID