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
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 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
Type
Description
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
Name
Description
var
string
Returns
Type
Description
$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
Type
Description
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
Name
Description
var
int
Returns
Type
Description
$this
getFailureMessage
Output only. Additional information about the predeploy failure, if
available.
Returns
Type
Description
string
setFailureMessage
Output only. Additional information about the predeploy failure, if
available.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-28 UTC."],[],[],null,["# Google Cloud Deploy V1 Client - Class PredeployJobRun (2.0.0)\n\nVersion latestkeyboard_arrow_down\n\n- [2.0.0 (latest)](/php/docs/reference/cloud-deploy/latest/V1.PredeployJobRun)\n- [1.5.7](/php/docs/reference/cloud-deploy/1.5.7/V1.PredeployJobRun)\n- [1.4.0](/php/docs/reference/cloud-deploy/1.4.0/V1.PredeployJobRun)\n- [1.3.0](/php/docs/reference/cloud-deploy/1.3.0/V1.PredeployJobRun)\n- [1.2.0](/php/docs/reference/cloud-deploy/1.2.0/V1.PredeployJobRun)\n- [1.1.1](/php/docs/reference/cloud-deploy/1.1.1/V1.PredeployJobRun)\n- [1.0.0](/php/docs/reference/cloud-deploy/1.0.0/V1.PredeployJobRun)\n- [0.19.1](/php/docs/reference/cloud-deploy/0.19.1/V1.PredeployJobRun)\n- [0.18.1](/php/docs/reference/cloud-deploy/0.18.1/V1.PredeployJobRun)\n- [0.17.0](/php/docs/reference/cloud-deploy/0.17.0/V1.PredeployJobRun)\n- [0.16.0](/php/docs/reference/cloud-deploy/0.16.0/V1.PredeployJobRun)\n- [0.15.0](/php/docs/reference/cloud-deploy/0.15.0/V1.PredeployJobRun)\n- [0.14.0](/php/docs/reference/cloud-deploy/0.14.0/V1.PredeployJobRun)\n- [0.13.1](/php/docs/reference/cloud-deploy/0.13.1/V1.PredeployJobRun)\n- [0.12.1](/php/docs/reference/cloud-deploy/0.12.1/V1.PredeployJobRun)\n- [0.11.1](/php/docs/reference/cloud-deploy/0.11.1/V1.PredeployJobRun)\n- [0.10.0](/php/docs/reference/cloud-deploy/0.10.0/V1.PredeployJobRun)\n- [0.9.0](/php/docs/reference/cloud-deploy/0.9.0/V1.PredeployJobRun)\n- [0.8.0](/php/docs/reference/cloud-deploy/0.8.0/V1.PredeployJobRun)\n- [0.7.0](/php/docs/reference/cloud-deploy/0.7.0/V1.PredeployJobRun)\n- [0.6.0](/php/docs/reference/cloud-deploy/0.6.0/V1.PredeployJobRun)\n- [0.5.0](/php/docs/reference/cloud-deploy/0.5.0/V1.PredeployJobRun)\n- [0.4.1](/php/docs/reference/cloud-deploy/0.4.1/V1.PredeployJobRun)\n- [0.3.4](/php/docs/reference/cloud-deploy/0.3.4/V1.PredeployJobRun) \nReference documentation and code samples for the Google Cloud Deploy V1 Client class PredeployJobRun.\n\nPredeployJobRun contains information specific to a predeploy `JobRun`.\n\nGenerated from protobuf message `google.cloud.deploy.v1.PredeployJobRun`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Deploy \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getBuild\n\nOutput only. The resource name of the Cloud Build `Build` object that is\nused to execute the custom actions associated with the predeploy Job.\n\nFormat is `projects/{project}/locations/{location}/builds/{build}`.\n\n### setBuild\n\nOutput only. The resource name of the Cloud Build `Build` object that is\nused to execute the custom actions associated with the predeploy Job.\n\nFormat is `projects/{project}/locations/{location}/builds/{build}`.\n\n### getFailureCause\n\nOutput only. The reason the predeploy failed. This will always be\nunspecified while the predeploy is in progress or if it succeeded.\n\n### setFailureCause\n\nOutput only. The reason the predeploy failed. This will always be\nunspecified while the predeploy is in progress or if it succeeded.\n\n### getFailureMessage\n\nOutput only. Additional information about the predeploy failure, if\navailable.\n\n### setFailureMessage\n\nOutput only. Additional information about the predeploy failure, if\navailable."]]
