Skip to main content

List Bucket Objects

Lists all objects (files) in a Google Cloud Storage bucket.

Common Properties​

  • Name - The custom name of the node.
  • Color - The custom color of the node.
  • Delay Before (sec) - Waits in seconds before executing the node.
  • Delay After (sec) - Waits in seconds after executing node.
  • Continue On Error - Automation will continue regardless of any error. The default value is false.
info

If the ContinueOnError property is true, no error is caught when the project is executed, even if a Catch node is used.

Inputs​

  • GCS Client Id - The client identifier obtained from the Connect node.
  • Bucket Name - The name of the bucket to list objects from.

Output​

  • List - An array of objects containing file information:
    • Name - The name of the object (file)
    • Size - The size of the object in bytes

How It Works​

The List Bucket Objects node retrieves a list of all objects (files) in a Google Cloud Storage bucket. When executed, the node:

  1. Validates the provided inputs (GCS Client Id, Bucket Name)
  2. Uses the existing storage client connection
  3. Queries Google Cloud Storage for all objects in the specified bucket
  4. Returns an array of objects with file names and sizes

Requirements​

  • A valid GCS Client Id from a successful Connect node execution
  • Valid bucket name that exists in Google Cloud Storage
  • Proper permissions to list objects in the specified bucket

Error Handling​

The node will return specific errors in the following cases:

  • Empty or invalid GCS Client Id
  • Empty or invalid Bucket Name
  • Bucket does not exist
  • Insufficient permissions to list objects
  • Google Cloud Storage service errors

Usage Notes​

  • The output includes both file names and sizes for each object
  • Objects in subdirectories will be listed with their full paths (e.g., "folder/file.txt")
  • This node is useful for inventory, validation, or processing all files in a bucket
  • Large buckets may take longer to list all objects
  • The list includes all objects regardless of their storage class or metadata
  • Make sure the authenticated account has the necessary permissions to list objects
  • The returned list can be used with other nodes for batch operations
  • Empty buckets will return an empty array
  • This operation is read-only and does not modify any objects