Reference documentation and code samples for the Google Cloud Build V1 Client class BuildStatus.
Status used for both invocation attempt and overall build completion.
Generated from protobuf message google.devtools.build.v1.BuildStatus
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ result |
int
The end result. |
↳ final_invocation_id |
string
Final invocation ID of the build, if there was one. This field is only set on a status in BuildFinished event. |
↳ build_tool_exit_code |
Google\Protobuf\Int32Value
Build tool exit code. Integer value returned by the executed build tool. Might not be available in some cases, e.g., a build timeout. |
↳ details |
Google\Protobuf\Any
Fine-grained diagnostic information to complement the status. |
getResult
The end result.
| Returns | |
|---|---|
| Type | Description |
int | |
setResult
The end result.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getFinalInvocationId
Final invocation ID of the build, if there was one.
This field is only set on a status in BuildFinished event.
| Returns | |
|---|---|
| Type | Description |
string | |
setFinalInvocationId
Final invocation ID of the build, if there was one.
This field is only set on a status in BuildFinished event.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getBuildToolExitCode
Build tool exit code. Integer value returned by the executed build tool.
Might not be available in some cases, e.g., a build timeout.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Int32Value|null | |
hasBuildToolExitCode
clearBuildToolExitCode
getBuildToolExitCodeValue
Returns the unboxed value from getBuildToolExitCode()
Build tool exit code. Integer value returned by the executed build tool. Might not be available in some cases, e.g., a build timeout.
| Returns | |
|---|---|
| Type | Description |
int|null | |
setBuildToolExitCode
Build tool exit code. Integer value returned by the executed build tool.
Might not be available in some cases, e.g., a build timeout.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Int32Value
|
| Returns | |
|---|---|
| Type | Description |
$this | |
setBuildToolExitCodeValue
Sets the field by wrapping a primitive type in a Google\Protobuf\Int32Value object.
Build tool exit code. Integer value returned by the executed build tool. Might not be available in some cases, e.g., a build timeout.
| Parameter | |
|---|---|
| Name | Description |
var |
int|null
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getDetails
Fine-grained diagnostic information to complement the status.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Any|null | |
hasDetails
clearDetails
setDetails
Fine-grained diagnostic information to complement the status.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Any
|
| Returns | |
|---|---|
| Type | Description |
$this | |