README.md

GCS

stoQ plugins that reads and writes data to Google Cloud Storage buckets.

Plugin Classes

• Archiver
• Connector

Configuration

All options below may be set by:

• plugin configuration file
• stoq command
• Stoq class

Options

• project_id [str]: Google Cloud project ID

Archiver

• archive_bucket [str]: GCS Bucket to read/save archived files from

• use_sha [True/False]: When archiving files, should archived files be saved in a directory structure based on the first five characters of the sha1 hash.

  For example, if the sha1 hash of the payload is da39a3ee5e6b4b0d3255bfef95601890afd80709, the payload will be archived to gs://$archive_bucket/d/a/3/9/a/da39a3ee5e6b4b0d3255bfef95601890afd80709.

Connector

• connector_bucket [str]: GCS Bucket where results will be saved to