Google Cloud Build V1 Client - Class Volume (0.8.0)

Reference documentation and code samples for the Google Cloud Build V1 Client class Volume.

Volume describes a Docker container volume which is mounted into build steps in order to persist files across build step execution.

Generated from protobuf message google.devtools.cloudbuild.v1.Volume

Namespace

Google \ Cloud \ Build \ V1

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ name string

Name of the volume to mount. Volume names must be unique per build step and must be valid names for Docker volumes. Each named volume must be used by at least two build steps.

↳ path string

Path at which to mount the volume. Paths must be absolute and cannot conflict with other volume paths on the same build step or with certain reserved volume paths.

getName

Name of the volume to mount.

Volume names must be unique per build step and must be valid names for Docker volumes. Each named volume must be used by at least two build steps.

Returns
TypeDescription
string

setName

Name of the volume to mount.

Volume names must be unique per build step and must be valid names for Docker volumes. Each named volume must be used by at least two build steps.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getPath

Path at which to mount the volume.

Paths must be absolute and cannot conflict with other volume paths on the same build step or with certain reserved volume paths.

Returns
TypeDescription
string

setPath

Path at which to mount the volume.

Paths must be absolute and cannot conflict with other volume paths on the same build step or with certain reserved volume paths.

Parameter
NameDescription
var string
Returns
TypeDescription
$this