Documentation CLI 0.1.1 · development llms.txt

coldctl destination add gcs

Configure a Google Cloud Storage archive destination.

ImplementedLocal destination configuration

Syntax

USAGE

coldctl destination add gcs [OPTIONS] --name <NAME> --bucket <BUCKET>

Arguments & options

Option	Description / default
`--data-dir <PATH>`	Override the OS application data directory
`--name <NAME>`	Unique destination name.
`--output <OUTPUT>`	[default: table] [possible values: table, json]
`--bucket <BUCKET>`	Existing customer-owned GCS bucket.
`--prefix <PREFIX>`	[default: coldctl]
`--credentials-env <CREDENTIALS_ENV>`	Variable containing an absolute ADC JSON file path. Defaults to Google's ADC chain
`--endpoint <ENDPOINT>`	Anonymous loopback GCS emulator only; never a production endpoint override
`--allow-http`	Allow anonymous HTTP only with an explicit loopback emulator endpoint.
`--staging-path <STAGING_PATH>`	Durable local staging directory for pending batches
`-h, --help`	Print help

Examples

Replace configuration names, paths and JOB_ID with values from your installation. Examples are not executed by this page.

CLI

coldctl destination add gcs --name gcs-archive --bucket YOUR_BUCKET --prefix coldctl

CLI

coldctl destination add gcs --name gcs-archive --bucket YOUR_BUCKET --credentials-env COLDCTL_GCS_CREDENTIALS

Operational notes

Provision the bucket separately and run destination test. Credential variables contain absolute ADC JSON file paths, not JSON contents. Service-account and authorized-user files are supported; external_account federation is unsupported. Match agent and connector builds. Custom endpoints are anonymous loopback emulators only.

Output, placeholders & global flags

View exact CLI help

HELP OUTPUT

Configure Google Cloud Storage using ADC or an anonymous loopback emulator

Usage: coldctl destination add gcs [OPTIONS] --name <NAME> --bucket <BUCKET>

Options:
      --data-dir <PATH>
          Override the OS application data directory
      --name <NAME>
          
      --output <OUTPUT>
          [default: table] [possible values: table, json]
      --bucket <BUCKET>
          
      --prefix <PREFIX>
          [default: coldctl]
      --credentials-env <CREDENTIALS_ENV>
          Variable containing an absolute ADC JSON file path. Defaults to Google's ADC chain
      --endpoint <ENDPOINT>
          Anonymous loopback GCS emulator only; never a production endpoint override
      --allow-http
          
      --staging-path <STAGING_PATH>
          Durable local staging directory for pending batches
  -h, --help
          Print help