Google Cloud Deploy V1 Client - Class PredeployJobRun (0.17.0)

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

PredeployJobRun contains information specific to a predeploy JobRun.

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

Namespace

Google \ Cloud \ Deploy \ V1

Methods

__construct

Constructor.

Parameters
NameDescription
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 execute the custom actions associated with the predeploy Job. Format is projects/{project}/locations/{location}/builds/{build}.

↳ failure_cause int

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

↳ failure_message string

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

getBuild

Output only. The resource name of the Cloud Build Build object that is used to execute the custom actions associated with the predeploy Job.

Format is projects/{project}/locations/{location}/builds/{build}.

Returns
TypeDescription
string

setBuild

Output only. The resource name of the Cloud Build Build object that is used to execute the custom actions associated with the predeploy Job.

Format is projects/{project}/locations/{location}/builds/{build}.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getFailureCause

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

Returns
TypeDescription
int

setFailureCause

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

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getFailureMessage

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

Returns
TypeDescription
string

setFailureMessage

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

Parameter
NameDescription
var string
Returns
TypeDescription
$this