Google Cloud Deploy V1 Client - Class PredeployJobRun (2.0.0)

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

PredeployJobRun contains information specific to a predeployJobRun.

Generated from protobuf messagegoogle.cloud.deploy.v1.PredeployJobRun

Namespace

Google \ Cloud \ Deploy \ V1

Methods

__construct

Constructor.

Parameters
NameDescription
dataarray

Optional. Data for populating the Message object.

↳ buildstring

Output only. The resource name of the Cloud BuildBuild object that is used to execute the custom actions associated with the predeploy Job. Format isprojects/{project}/locations/{location}/builds/{build}.

↳ failure_causeint

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

↳ failure_messagestring

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

getBuild

Output only. The resource name of the Cloud BuildBuild object that isused to execute the custom actions associated with the predeploy Job.

Format isprojects/{project}/locations/{location}/builds/{build}.

Returns
TypeDescription
string

setBuild

Output only. The resource name of the Cloud BuildBuild object that isused to execute the custom actions associated with the predeploy Job.

Format isprojects/{project}/locations/{location}/builds/{build}.

Parameter
NameDescription
varstring
Returns
TypeDescription
$this

getFailureCause

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

Returns
TypeDescription
int

setFailureCause

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

Parameter
NameDescription
varint
Returns
TypeDescription
$this

getFailureMessage

Output only. Additional information about the predeploy failure, ifavailable.

Returns
TypeDescription
string

setFailureMessage

Output only. Additional information about the predeploy failure, ifavailable.

Parameter
NameDescription
varstring
Returns
TypeDescription
$this

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2026-01-10 UTC.