Reference documentation and code samples for the Google Cloud Deploy V1 Client class RolloutNotificationEvent.
Payload proto for "clouddeploy.googleapis.com/rollout_notification" Platform Log event that describes the failure to send rollout status change Pub/Sub notification.
Generated from protobuf message google.cloud.deploy.v1.RolloutNotificationEvent
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ message |
string
Debug message for when a notification fails to send. |
↳ pipeline_uid |
string
Unique identifier of the |
↳ release_uid |
string
Unique identifier of the |
↳ rollout |
string
The name of the |
↳ type |
int
Type of this notification, e.g. for a Pub/Sub failure. |
↳ target_id |
string
ID of the |
getMessage
Debug message for when a notification fails to send.
| Returns | |
|---|---|
| Type | Description |
string | |
setMessage
Debug message for when a notification fails to send.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getPipelineUid
Unique identifier of the DeliveryPipeline.
| Returns | |
|---|---|
| Type | Description |
string | |
setPipelineUid
Unique identifier of the DeliveryPipeline.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getReleaseUid
Unique identifier of the Release.
| Returns | |
|---|---|
| Type | Description |
string | |
setReleaseUid
Unique identifier of the Release.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getRollout
The name of the Rollout.
| Returns | |
|---|---|
| Type | Description |
string | |
setRollout
The name of the Rollout.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getType
Type of this notification, e.g. for a Pub/Sub failure.
| Returns | |
|---|---|
| Type | Description |
int | |
setType
Type of this notification, e.g. for a Pub/Sub failure.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getTargetId
ID of the Target that the rollout is deployed to.
| Returns | |
|---|---|
| Type | Description |
string | |
setTargetId
ID of the Target that the rollout is deployed to.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |