Variable Name Type Required Default Description
project string Yes - Project identifier for GCS
keyfile string No - Path of GCS service account credentials JSON file
credentials_json *secret.Secret No - GCS service account credentials in JSON format
Secret
client_retries int No - Number of times to retry requests on server error
client_timeout int No - Default timeout to use in requests
bucket string Yes - Name of a GCS bucket
object_key_format string No %{path}%{time_slice}_%{index}.%{file_extension} Format of GCS object keys
path string No - Path prefix of the files on GCS
store_as string No gzip Archive format on GCS: gzip json text
transcoding bool No - Enable the decompressive form of transcoding
auto_create_bucket bool No true Create GCS bucket if it does not exists
hex_random_length int No 4 Max length of %{hex_random} placeholder(4-16)
overwrite bool No false Overwrite already existing path
acl string No - Permission for the object in GCS: auth_read owner_full owner_read private project_private public_read
storage_class string No - Storage class of the file: dra nearline coldline multi_regional regional standard
encryption_key string No - Customer-supplied, AES-256 encryption key
object_metadata []ObjectMetadata No - User provided web-safe keys and arbitrary string values that will returned with requests for the file as “x-goog-meta-” response headers.
Object Metadata
format *Format No - Format
buffer *Buffer No - Buffer

ObjectMetadata 🔗︎

Variable Name Type Required Default Description
key string Yes - Key
value string Yes - Value