Google Cloud Build V1 Client - Class BuildEvent (0.3.8)

Reference documentation and code samples for the Google Cloud Build V1 Client class BuildEvent.

An event representing some state change that occurred in the build. This message does not include field for uniquely identifying an event.

Generated from protobuf message google.devtools.build.v1.BuildEvent

Methods

__construct

Constructor.

Parameters

Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ event_time`	`Google\Protobuf\Timestamp` The timestamp of this event.
`↳ invocation_attempt_started`	`Google\Cloud\Build\V1\BuildEvent\InvocationAttemptStarted` An invocation attempt has started.
`↳ invocation_attempt_finished`	`Google\Cloud\Build\V1\BuildEvent\InvocationAttemptFinished` An invocation attempt has finished.
`↳ build_enqueued`	`Google\Cloud\Build\V1\BuildEvent\BuildEnqueued` The build is enqueued.
`↳ build_finished`	`Google\Cloud\Build\V1\BuildEvent\BuildFinished` The build has finished. Set when the build is terminated.
`↳ console_output`	`Google\Cloud\Build\V1\BuildEvent\ConsoleOutput` An event containing printed text.
`↳ component_stream_finished`	`Google\Cloud\Build\V1\BuildEvent\BuildComponentStreamFinished` Indicates the end of a build event stream (with the same StreamId) from a build component executing the requested build task. * This field does not indicate the WatchBuild RPC is finished. *
`↳ bazel_event`	`Google\Protobuf\Any` Structured build event generated by Bazel about its execution progress.
`↳ build_execution_event`	`Google\Protobuf\Any` An event that contains supplemental tool-specific information about build execution.
`↳ source_fetch_event`	`Google\Protobuf\Any` An event that contains supplemental tool-specific information about source fetching.

getEventTime

The timestamp of this event.

Returns

Type	Description
`Google\Protobuf\Timestamp\|null`

hasEventTime

clearEventTime

setEventTime

The timestamp of this event.

Parameter

Name	Description
`var`	`Google\Protobuf\Timestamp`

Returns

Type	Description
`$this`

getInvocationAttemptStarted

An invocation attempt has started.

Returns

Type	Description
`Google\Cloud\Build\V1\BuildEvent\InvocationAttemptStarted\|null`

hasInvocationAttemptStarted

setInvocationAttemptStarted

An invocation attempt has started.

Parameter

Name	Description
`var`	`Google\Cloud\Build\V1\BuildEvent\InvocationAttemptStarted`

Returns

Type	Description
`$this`

getInvocationAttemptFinished

An invocation attempt has finished.

Returns

Type	Description
`Google\Cloud\Build\V1\BuildEvent\InvocationAttemptFinished\|null`

hasInvocationAttemptFinished

setInvocationAttemptFinished

An invocation attempt has finished.

Parameter

Name	Description
`var`	`Google\Cloud\Build\V1\BuildEvent\InvocationAttemptFinished`

Returns

Type	Description
`$this`

getBuildEnqueued

The build is enqueued.

Returns

Type	Description
`Google\Cloud\Build\V1\BuildEvent\BuildEnqueued\|null`

hasBuildEnqueued

setBuildEnqueued

The build is enqueued.

Parameter

Name	Description
`var`	`Google\Cloud\Build\V1\BuildEvent\BuildEnqueued`

Returns

Type	Description
`$this`

getBuildFinished

The build has finished. Set when the build is terminated.

Returns

Type	Description
`Google\Cloud\Build\V1\BuildEvent\BuildFinished\|null`

hasBuildFinished

setBuildFinished

The build has finished. Set when the build is terminated.

Parameter

Name	Description
`var`	`Google\Cloud\Build\V1\BuildEvent\BuildFinished`

Returns

Type	Description
`$this`

getConsoleOutput

An event containing printed text.

Returns

Type	Description
`Google\Cloud\Build\V1\BuildEvent\ConsoleOutput\|null`

hasConsoleOutput

setConsoleOutput

An event containing printed text.

Parameter

Name	Description
`var`	`Google\Cloud\Build\V1\BuildEvent\ConsoleOutput`

Returns

Type	Description
`$this`

getComponentStreamFinished

Indicates the end of a build event stream (with the same StreamId) from a build component executing the requested build task.

*** This field does not indicate the WatchBuild RPC is finished. ***

Returns

Type	Description
`Google\Cloud\Build\V1\BuildEvent\BuildComponentStreamFinished\|null`

hasComponentStreamFinished

setComponentStreamFinished

Indicates the end of a build event stream (with the same StreamId) from a build component executing the requested build task.

*** This field does not indicate the WatchBuild RPC is finished. ***

Parameter

Name	Description
`var`	`Google\Cloud\Build\V1\BuildEvent\BuildComponentStreamFinished`

Returns

Type	Description
`$this`

getBazelEvent

Structured build event generated by Bazel about its execution progress.

Returns

Type	Description
`Google\Protobuf\Any\|null`

hasBazelEvent

setBazelEvent

Structured build event generated by Bazel about its execution progress.

Parameter

Name	Description
`var`	`Google\Protobuf\Any`

Returns

Type	Description
`$this`

getBuildExecutionEvent

An event that contains supplemental tool-specific information about build execution.

Returns

Type	Description
`Google\Protobuf\Any\|null`

hasBuildExecutionEvent

setBuildExecutionEvent

An event that contains supplemental tool-specific information about build execution.

Parameter

Name	Description
`var`	`Google\Protobuf\Any`

Returns

Type	Description
`$this`

getSourceFetchEvent

An event that contains supplemental tool-specific information about source fetching.

Returns

Type	Description
`Google\Protobuf\Any\|null`

hasSourceFetchEvent

setSourceFetchEvent

An event that contains supplemental tool-specific information about source fetching.

Parameter

Name	Description
`var`	`Google\Protobuf\Any`

Returns

Type	Description
`$this`

getEvent

Returns

Type	Description
`string`