Google Cloud Build V1 Client - Class PublishBuildToolEventStreamRequest (0.3.8)

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

Streaming request message for PublishBuildToolEventStream.

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

Methods

__construct

Constructor.

Parameters
Name
Description
data
array

Optional. Data for populating the Message object.

↳ ordered_build_event
Google\Cloud\Build\V1\OrderedBuildEvent

Required. The build event with position info. New publishing clients should use this field rather than the 3 above.

↳ notification_keywords
array

The keywords to be attached to the notification which notifies the start of a new build event stream. BES only reads this field when sequence_number or ordered_build_event.sequence_number is 1 in this message. If this field is empty, BES will not publish notification messages for this stream.

↳ project_id
string

Required. The project this build is associated with. This should match the project used for the initial call to PublishLifecycleEvent (containing a BuildEnqueued message).

↳ check_preceding_lifecycle_events_present
bool

Whether to require a previously received matching InvocationAttemptStarted event before continuing event processing for the event in the current request. BES only performs this check for events with sequence_number 1 i.e. the first event in the stream.

getOrderedBuildEvent

Required. The build event with position info.

New publishing clients should use this field rather than the 3 above.

Returns
Type
Description

hasOrderedBuildEvent

clearOrderedBuildEvent

setOrderedBuildEvent

Required. The build event with position info.

New publishing clients should use this field rather than the 3 above.

Parameter
Name
Description
Returns
Type
Description
$this

getNotificationKeywords

The keywords to be attached to the notification which notifies the start of a new build event stream. BES only reads this field when sequence_number or ordered_build_event.sequence_number is 1 in this message. If this field is empty, BES will not publish notification messages for this stream.

Returns
Type
Description

setNotificationKeywords

The keywords to be attached to the notification which notifies the start of a new build event stream. BES only reads this field when sequence_number or ordered_build_event.sequence_number is 1 in this message. If this field is empty, BES will not publish notification messages for this stream.

Parameter
Name
Description
var
string[]
Returns
Type
Description
$this

getProjectId

Required. The project this build is associated with.

This should match the project used for the initial call to PublishLifecycleEvent (containing a BuildEnqueued message).

Returns
Type
Description
string

setProjectId

Required. The project this build is associated with.

This should match the project used for the initial call to PublishLifecycleEvent (containing a BuildEnqueued message).

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getCheckPrecedingLifecycleEventsPresent

Whether to require a previously received matching InvocationAttemptStarted event before continuing event processing for the event in the current request. BES only performs this check for events with sequence_number 1 i.e. the first event in the stream.

Returns
Type
Description
bool

setCheckPrecedingLifecycleEventsPresent

Whether to require a previously received matching InvocationAttemptStarted event before continuing event processing for the event in the current request. BES only performs this check for events with sequence_number 1 i.e. the first event in the stream.

Parameter
Name
Description
var
bool
Returns
Type
Description
$this
Design a Mobile Site
View Site in Mobile | Classic
Share by: