Google Cloud Deploy V1 Client - Class DeployJobRun (1.2.0)

Reference documentation and code samples for the Google Cloud Deploy V1 Client class DeployJobRun.

DeployJobRun contains information specific to a deploy JobRun.

Generated from protobuf message google.cloud.deploy.v1.DeployJobRun

Namespace

Google \ Cloud \ Deploy \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ build string

Output only. The resource name of the Cloud Build Build object that is used to deploy. Format is projects/{project}/locations/{location}/builds/{build}.

↳ failure_cause int

Output only. The reason the deploy failed. This will always be unspecified while the deploy is in progress or if it succeeded.

↳ failure_message string

Output only. Additional information about the deploy failure, if available.

↳ metadata Google\Cloud\Deploy\V1\DeployJobRunMetadata

Output only. Metadata containing information about the deploy job run.

↳ artifact Google\Cloud\Deploy\V1\DeployArtifact

Output only. The artifact of a deploy job run, if available.

getBuild

Output only. The resource name of the Cloud Build Build object that is used to deploy. Format is projects/{project}/locations/{location}/builds/{build}.

Returns
Type Description
string

setBuild

Output only. The resource name of the Cloud Build Build object that is used to deploy. Format is projects/{project}/locations/{location}/builds/{build}.

Parameter
Name Description
var string
Returns
Type Description
$this

getFailureCause

Output only. The reason the deploy failed. This will always be unspecified while the deploy is in progress or if it succeeded.

Returns
Type Description
int

setFailureCause

Output only. The reason the deploy failed. This will always be unspecified while the deploy is in progress or if it succeeded.

Parameter
Name Description
var int
Returns
Type Description
$this

getFailureMessage

Output only. Additional information about the deploy failure, if available.

Returns
Type Description
string

setFailureMessage

Output only. Additional information about the deploy failure, if available.

Parameter
Name Description
var string
Returns
Type Description
$this

getMetadata

Output only. Metadata containing information about the deploy job run.

Returns
Type Description
Google\Cloud\Deploy\V1\DeployJobRunMetadata|null

hasMetadata

clearMetadata

setMetadata

Output only. Metadata containing information about the deploy job run.

Parameter
Name Description
var Google\Cloud\Deploy\V1\DeployJobRunMetadata
Returns
Type Description
$this

getArtifact

Output only. The artifact of a deploy job run, if available.

Returns
Type Description
Google\Cloud\Deploy\V1\DeployArtifact|null

hasArtifact

clearArtifact

setArtifact

Output only. The artifact of a deploy job run, if available.

Parameter
Name Description
var Google\Cloud\Deploy\V1\DeployArtifact
Returns
Type Description
$this