Google Cloud Storage

Google Cloud Storage (gcs)

Write events to a Google Cloud bucket.

Block Store Cloud Enterprise edition binary json raw

Minimal example

output:
  gcs:
    bucket-name: ~
    credentials:
      storage-url: ~
    object-name:
      name: ~

JSON

{
  "output": {
    "gcs": {
      "bucket-name": null,
      "credentials": {
        "storage-url": null
      },
      "object-name": {
        "name": null
      }
    }
  }
}

Contents

• Minimal example

• Authentication

• Behavior

• Location

• Object Properties

• Processing

• Reliability

• Schema

A ✓ marks a field that accepts a context variable such as {{ VARIABLE }}.

Authentication

Authentication

Field	Type	Required	Description
credentials	Credentials	✅	Credentials for GCP. Supports service account JSON, application-default credentials, or context-provided material via PossibleContextString. Allowed values: storage-url, service-account, application-credentials

Behavior

Behavior

Field	Type	Required	Description
mode	Mode		Put or delete the object? Put uploads content (default), while Delete removes the named object. Allowed values: put, delete

Location

Location

Field	Type	Required	Description
bucket-name	string	✅	Bucket Name.
object-name	Object Name	✅	Remote object name or field reference (via ObjectDestination). Supports folder-style paths using / separators. Allowed values: name, field

Object Properties

Object Properties

Field	Type	Required	Description
disable-object-name-guid ✓	boolean (bool)		Disable the autogenerated GUID prefix so the provided object name is used verbatim. This is forced off for delete operations. Default: false
guid-prefix	string		Optional GUID prefix appended ahead of the generated identifier. Defaults to /.
guid-suffix	string		Optional GUID suffix appended after the generated identifier.

Processing

Processing

Field	Type	Required	Description
batch	Batch		Configure batching before uploads; batching is recommended when writing many small events to reduce API calls.
input-field	field (string)		Use the specified field as the object payload. When omitted the entire event body is serialized according to the selected preprocessors. Examples: data_field
preprocessors	Preprocessors[]		Preprocessors (process data before making it available for upload) these processors will be run in the order they are specified. Allowed values: gzip, parquet, base64

Reliability

Reliability

Field	Type	Required	Description
retry	Retry		How to retry operation if it fails.
track-schema ✓	boolean (bool)		Validate JSON payloads against the stored schema and maintain __SCHEMA_NUMBER metadata. Only available when the payload serializes to JSON. Default: false

Schema

• Credentials - Service Account Options
• Credentials - Application Credentials Options
• Credentials Options
• Object Name Options
• Batch Fields
• Retry - Backoff Fields
• Retry Fields
• Mode Options
• Batch - Mode Options
• Preprocessors Options
• Retry - Backoff - Strategy Options

Credentials - Service Account Options

Option	Name	Type	Description
path	Path	string	Service Account File location. Examples: /path/to/file, c:\users\joe\data\file.txt
key	Key	string

Credentials - Application Credentials Options

Option	Name	Type	Description
path	Path	string	Application Credential File Location. Examples: /path/to/file, c:\users\joe\data\file.txt
key	Key	string	Application Credential in JSON format.

Credentials Options

Option	Name	Type	Description
storage-url	Storage Url	string	URL in the form gs:///path.
service-account	Service Account	one_of	Service Account credentials. Allowed values: path, key
application-credentials	Application Credentials	one_of	Application credentials. Allowed values: path, key

Object Name Options

Option	Name	Type	Description
name	Name	string	Object Name.
field	Field	string	Field containing the Object Name.

Batch Fields

Field	Type	Required	Description
fixed-size ✓	number (integer)		maximum number of events in an output batch. Examples: 42, 1.2e-10
max-bytes ✓	number (integer)		Close the batch before adding an event that would make the serialized request payload exceed this many bytes. Examples: 42, 1.2e-10
mode	Mode	✅	If ‘document’ send on end of document generated by input. If ‘fixed’, use fixed_size. Allowed values: fixed, document
timeout	time-interval (string)	✅	interval after which the batch is sent, to keep throughput going (default 100ms). Default: 100ms Examples: 500ms, 2h
header	multiline-text (string)		put a header line before the batch.
footer	multiline-text (string)		put a header line after the last line of the batch.
use-document-marker ✓	boolean (bool)		Enrich the job metadata with a document marker (for document handling in batch mode). Default: false
wrap-as-json ✓	boolean (bool)		Format the output batch as a JSON array. Default: false

Retry - Backoff Fields

Field	Type	Required	Description
strategy	Strategy		Backoff strategy to use (default exponential). Allowed values: exponential, linear, fixed
base	string		Base delay before retrying (e.g. “200ms”).
max	string		Maximum delay between retries.
jitter ✓	boolean (bool)		Whether to add jitter to retry delays. Default: false

Retry Fields

Field	Type	Required	Description
max-attempts	number (integer)		Maximum attempts before giving up. Examples: 42, 1.2e-10
forever ✓	boolean (bool)		Retry indefinitely until cancelled. Default: false
backoff	Backoff		Backoff strategy configuration.

Mode Options

Value	Aliases	Name	Description
put		put	Put Objects
delete		delete	Delete Objects

Batch - Mode Options

Value	Aliases	Name	Description
fixed		fixed
document		document

Preprocessors Options

Value	Aliases	Name	Description
gzip		gzip	Gzip the output data
parquet		parquet	Extract the received data as JSON rows from a parquet file
base64		base64	Decode base64 as binary

Retry - Backoff - Strategy Options

Value	Aliases	Name	Description
exponential		exponential
linear		linear
fixed		fixed