PluginsGoogle CloudTasksBigquery

DeleteDataset​Delete​Dataset

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

Delete a dataset.

Examples

Delete a dataset.

yaml
id: gcp_bq_delete_dataset
namespace: company.team

tasks:
  - id: delete_dataset
    type: io.kestra.plugin.gcp.bigquery.DeleteDataset
    name: "my-dataset"
    deleteContents: true

Properties

name

  • Type: string
  • Dynamic: ✔️
  • Required: ✔️

The dataset's user-defined id.

deleteContents

  • Type: boolean
  • Dynamic: ❌
  • Required: ❌

Whether to delete a dataset even if non-empty.

If not provided, attempting to delete a non-empty dataset will result in a exception being thrown.

impersonatedServiceAccount

  • Type: string
  • Dynamic: ✔️
  • Required: ❌

The GCP service account to impersonate.

location

  • Type: string
  • Dynamic: ✔️
  • Required: ❌

The geographic location where the dataset should reside.

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

See Dataset Location

projectId

  • Type: string
  • Dynamic: ✔️
  • Required: ❌

The GCP project ID.

retryAuto

  • Type:
  • Dynamic: ❌
  • Required: ❌

retryMessages

  • Type: array
  • SubType: string
  • Dynamic: ✔️
  • Required: ❌
  • Default: [ "due to concurrent update", "Retrying the job 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

  • Type: array
  • SubType: string
  • Dynamic: ✔️
  • Required: ❌
  • Default: [ "rateLimitExceeded", "jobBackendError", "internalError", "jobInternalError" ]

The reasons which would trigger an automatic retry.

scopes

  • Type: array
  • SubType: string
  • Dynamic: ✔️
  • Required: ❌
  • Default: [ "https://www.googleapis.com/auth/cloud-platform" ]

The GCP scopes to be used.

serviceAccount

  • Type: string
  • Dynamic: ✔️
  • Required: ❌

The GCP service account.

Outputs

dataset

  • Type: string
  • Required: ✔️

Definitions

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

  • interval
    • Type: string
    • Dynamic: ❌
    • Required: ✔️
    • Format: duration
  • type
    • Type: string
    • Dynamic: ❌
    • Required: ✔️
    • Default: constant
  • behavior
    • Type: string
    • Dynamic: ❌
    • Required: ❌
    • Default: RETRY_FAILED_TASK
    • Possible Values:
      • RETRY_FAILED_TASK
      • CREATE_NEW_EXECUTION
  • maxAttempt
    • Type: integer
    • Dynamic: ❌
    • Required: ❌
    • Minimum: ›= 1
  • maxDuration
    • Type: string
    • Dynamic: ❌
    • Required: ❌
    • Format: duration
  • warningOnRetry
    • Type: boolean
    • Dynamic: ❌
    • Required: ❌
    • Default: false

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

  • maxInterval
    • Type: string
    • Dynamic: ❌
    • Required: ✔️
    • Format: duration
  • minInterval
    • Type: string
    • Dynamic: ❌
    • Required: ✔️
    • Format: duration
  • type
    • Type: string
    • Dynamic: ❌
    • Required: ✔️
    • Default: random
  • behavior
    • Type: string
    • Dynamic: ❌
    • Required: ❌
    • Default: RETRY_FAILED_TASK
    • Possible Values:
      • RETRY_FAILED_TASK
      • CREATE_NEW_EXECUTION
  • maxAttempt
    • Type: integer
    • Dynamic: ❌
    • Required: ❌
    • Minimum: ›= 1
  • maxDuration
    • Type: string
    • Dynamic: ❌
    • Required: ❌
    • Format: duration
  • warningOnRetry
    • Type: boolean
    • Dynamic: ❌
    • Required: ❌
    • Default: false

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

  • interval
    • Type: string
    • Dynamic: ❌
    • Required: ✔️
    • Format: duration
  • maxInterval
    • Type: string
    • Dynamic: ❌
    • Required: ✔️
    • Format: duration
  • type
    • Type: string
    • Dynamic: ❌
    • Required: ✔️
    • Default: exponential
  • behavior
    • Type: string
    • Dynamic: ❌
    • Required: ❌
    • Default: RETRY_FAILED_TASK
    • Possible Values:
      • RETRY_FAILED_TASK
      • CREATE_NEW_EXECUTION
  • delayFactor
    • Type: number
    • Dynamic: ❌
    • Required: ❌
  • maxAttempt
    • Type: integer
    • Dynamic: ❌
    • Required: ❌
    • Minimum: ›= 1
  • maxDuration
    • Type: string
    • Dynamic: ❌
    • Required: ❌
    • Format: duration
  • warningOnRetry
    • Type: boolean
    • Dynamic: ❌
    • Required: ❌
    • Default: false