Reference documentation and code samples for the Google Cloud Build V1 Client class OrderedBuildEvent.
Build event with contextual information about the stream it belongs to and its position in that stream.
Generated from protobuf message google.devtools.build.v1.OrderedBuildEvent
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ stream_id |
Google\Cloud\Build\V1\StreamId
Which build event stream this event belongs to. |
↳ sequence_number |
int|string
The position of this event in the stream. The sequence numbers for a build event stream should be a sequence of consecutive natural numbers starting from one. (1, 2, 3, ...) |
↳ event |
Google\Cloud\Build\V1\BuildEvent
The actual event. |
getStreamId
Which build event stream this event belongs to.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Build\V1\StreamId|null | |
hasStreamId
clearStreamId
setStreamId
Which build event stream this event belongs to.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Build\V1\StreamId
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getSequenceNumber
The position of this event in the stream. The sequence numbers for a build event stream should be a sequence of consecutive natural numbers starting from one. (1, 2, 3, ...)
| Returns | |
|---|---|
| Type | Description |
int|string | |
setSequenceNumber
The position of this event in the stream. The sequence numbers for a build event stream should be a sequence of consecutive natural numbers starting from one. (1, 2, 3, ...)
| Parameter | |
|---|---|
| Name | Description |
var |
int|string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getEvent
The actual event.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Build\V1\BuildEvent|null | |
hasEvent
clearEvent
setEvent
The actual event.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Build\V1\BuildEvent
|
| Returns | |
|---|---|
| Type | Description |
$this | |