Google Cloud Deploy V1 Client - Class RolloutUpdateEvent (0.17.0)

Reference documentation and code samples for the Google Cloud Deploy V1 Client class RolloutUpdateEvent.

Payload proto for "clouddeploy.googleapis.com/rollout_update" Platform Log event that describes the rollout update event.

Generated from protobuf message google.cloud.deploy.v1.RolloutUpdateEvent

Namespace

Google \ Cloud \ Deploy \ V1

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ message string

Debug message for when a rollout update event occurs.

↳ pipeline_uid string

Unique identifier of the pipeline.

↳ release_uid string

Unique identifier of the release.

↳ release string

The name of the Release.

↳ rollout string

The name of the rollout. rollout_uid is not in this log message because we write some of these log messages at rollout creation time, before we've generated the uid.

↳ target_id string

ID of the target.

↳ type int

Type of this notification, e.g. for a rollout update event.

↳ rollout_update_type int

The type of the rollout update.

getMessage

Debug message for when a rollout update event occurs.

Returns
TypeDescription
string

setMessage

Debug message for when a rollout update event occurs.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getPipelineUid

Unique identifier of the pipeline.

Returns
TypeDescription
string

setPipelineUid

Unique identifier of the pipeline.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getReleaseUid

Unique identifier of the release.

Returns
TypeDescription
string

setReleaseUid

Unique identifier of the release.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getRelease

The name of the Release.

Returns
TypeDescription
string

setRelease

The name of the Release.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getRollout

The name of the rollout.

rollout_uid is not in this log message because we write some of these log messages at rollout creation time, before we've generated the uid.

Returns
TypeDescription
string

setRollout

The name of the rollout.

rollout_uid is not in this log message because we write some of these log messages at rollout creation time, before we've generated the uid.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getTargetId

ID of the target.

Returns
TypeDescription
string

setTargetId

ID of the target.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getType

Type of this notification, e.g. for a rollout update event.

Returns
TypeDescription
int

setType

Type of this notification, e.g. for a rollout update event.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getRolloutUpdateType

The type of the rollout update.

Returns
TypeDescription
int

setRolloutUpdateType

The type of the rollout update.

Parameter
NameDescription
var int
Returns
TypeDescription
$this