GCS Object

GCS is an object store, and GCS object artifacts are references to objects stored in GCS buckets. These artifacts are generally consumed by stages that read configuration from text files, such as a Deploy Manifest or App Engine Deploy stage.

GCS object artifact in the UI

The pipeline UI exposes the following fields for the GCS object artifact:

Field Explanation
Account A GCS artifact account.
Object path The path to the artifact file, beginning with gs://.

In a trigger

When configuring certain triggers (such as a Pub/Sub trigger with Pub/Sub System Type “Google”), you can use a GCS object as an expected artifact.

Configuring GCS object fields in a pipeline trigger’s expected artifact settings.

In a pipeline stage

When configuring a “Deploy (Manifest)” or “Deploy” stage, you can use a GCS object as a manifest or application artifact. You can either use a previously-defined artifact (for example, an artifact defined in a trigger) or define an artifact inline.

Configuring a Deploy (Manifest) stage to use a GCS object as a manifest source.

GCS object artifact in a pipeline definition

The following are the fields that make up a GCS object artifact:

Field Explanation
type Always gcs/object.
reference The reference to the artifact file, beginning with gs:// and optionally ending with the object’s version. Example: gs://bucket/file.yml#1360383693620000
name The same as reference, but never with a version.
version The object’s version, if applicable.
location N/A

The following is an example JSON representation of a GCS object artifact, as it would appear in a pipeline definition:

{
  "type": "gcs/object",
  "reference": "gs://bucket/file.yml#1360383693620000",
  "name": "gs://bucket/file.yml",
  "version": "1360383693620000"
}