PluginsGoogle CloudTasksGcsList

List​List

List List

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

List file on a GCS bucket.

Examples

List files in a bucket

yaml
id: gcp_gcs_list
namespace: company.team

tasks:
  - id: list
    type: io.kestra.plugin.gcp.gcs.List
    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.

filter

  • Type: string
  • Dynamic: ❌
  • Required: ❌
  • Default: BOTH
  • Possible Values:
    • FILES
    • DIRECTORY
    • BOTH

The filter files or directory

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

blobs

  • Type: array
  • SubType: Blob
  • Required: ❌

The list of blobs

Definitions

io.kestra.plugin.gcp.gcs.models.Blob

Properties

bucket
  • Type: string
  • Dynamic: ❓
  • Required: ❓
cacheControl
  • Type: string
  • Dynamic: ❓
  • Required: ❓
componentCount
  • Type: integer
  • Dynamic: ❓
  • Required: ❓
contentDisposition
  • Type: string
  • Dynamic: ❓
  • Required: ❓
contentEncoding
  • Type: string
  • Dynamic: ❓
  • Required: ❓
contentLanguage
  • Type: string
  • Dynamic: ❓
  • Required: ❓
contentType
  • Type: string
  • Dynamic: ❓
  • Required: ❓
crc32c
  • Type: string
  • Dynamic: ❓
  • Required: ❓
createTime
  • Type: string
  • Dynamic: ❓
  • Required: ❓
  • Format: date-time
customTime
  • Type: string
  • Dynamic: ❓
  • Required: ❓
  • Format: date-time
deleteTime
  • Type: string
  • Dynamic: ❓
  • Required: ❓
  • Format: date-time
etag
  • Type: string
  • Dynamic: ❓
  • Required: ❓
eventBasedHold
  • Type: boolean
  • Dynamic: ❓
  • Required: ❓
generatedId
  • Type: string
  • Dynamic: ❓
  • Required: ❓
isDirectory
  • Type: boolean
  • Dynamic: ❓
  • Required: ❓
kmsKeyName
  • Type: string
  • Dynamic: ❓
  • Required: ❓
md5
  • Type: string
  • Dynamic: ❓
  • Required: ❓
  • Type: string
  • Dynamic: ❓
  • Required: ❓
metaGeneration
  • Type: integer
  • Dynamic: ❓
  • Required: ❓
metadata
  • Type: object
  • SubType: string
  • Dynamic: ❓
  • Required: ❓
name
  • Type: string
  • Dynamic: ❓
  • Required: ❓
retentionExpirationTime
  • Type: integer
  • Dynamic: ❓
  • Required: ❓
  • Type: string
  • Dynamic: ❓
  • Required: ❓
size
  • Type: integer
  • Dynamic: ❓
  • Required: ❓
temporaryHold
  • Type: boolean
  • Dynamic: ❓
  • Required: ❓
timeStorageClassUpdated
  • Type: string
  • Dynamic: ❓
  • Required: ❓
  • Format: date-time
updateTime
  • Type: string
  • Dynamic: ❓
  • Required: ❓
  • Format: date-time
uri
  • Type: string
  • Dynamic: ❓
  • Required: ❓
  • Format: uri

Was this page helpful?