DeleteList DeleteList

yaml
type: "io.kestra.plugin.gcp.gcs.DeleteList"

Delete all file to a GCS bucket.

Examples

yaml
id: gcp_gcs_delete_list
namespace: company.team

tasks:
  - id: delete_list
    type: io.kestra.plugin.gcp.gcs.DeleteList
    from: "gs://my_bucket/dir/"

Properties

from

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

The directory to list

allVersions

  • Type: boolean
  • Dynamic: ✔️
  • Required:

If set to true, lists all versions of a blob. The default is false.

concurrent

  • Type: integer
  • Dynamic:
  • Required:
  • Minimum: >= 2

Number of concurrent parallel deletions

errorOnEmpty

  • Type: boolean
  • Dynamic: ✔️
  • Required:
  • Default: false

raise an error if the file is not found

listingType

  • Type: string
  • Dynamic:
  • Required:
  • Default: DIRECTORY
  • Possible Values:
    • RECURSIVE
    • DIRECTORY

The listing type you want (like directory or recursive)

if DIRECTORY, will only list objects in the specified directory if RECURSIVE, will list objects in the specified directory recursively Default value is DIRECTORY When using RECURSIVE value, be careful to move your files to a location not in the from scope

projectId

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

The GCP project ID.

regExp

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

A regexp to filter on full path

ex: regExp: .* to match all files regExp: .*2020-01-0.\\.csv to match files between 01 and 09 of january ending with .csv

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

Outputs

count

  • Type: integer
  • Required:
  • Default: 0

The count of blobs deleted

size

  • Type: integer
  • Required:
  • Default: 0

The size of all blobs deleted

Definitions

Was this page helpful?