Reference documentation and code samples for the Google Cloud Deploy V1 Client class JobRunNotificationEvent.
Payload proto for "clouddeploy.googleapis.com/jobrun_notification" Platform Log event that describes the failure to send JobRun resource update Pub/Sub notification.
Generated from protobuf message google.cloud.deploy.v1.JobRunNotificationEvent
Namespace
Google \ Cloud \ Deploy \ V1Methods
__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. |
↳ job_run |
string
The name of the |
↳ pipeline_uid |
string
Unique identifier of the |
↳ release_uid |
string
Unique identifier of the |
↳ release |
string
The name of the |
↳ rollout_uid |
string
Unique identifier of the |
↳ rollout |
string
The name of the |
↳ target_id |
string
ID of the |
↳ type |
int
Type of this notification, e.g. for a Pub/Sub failure. |
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 |
|
getJobRun
The name of the JobRun.
| Returns | |
|---|---|
| Type | Description |
string |
|
setJobRun
The name of the JobRun.
| 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 |
|
getRelease
The name of the Release.
| Returns | |
|---|---|
| Type | Description |
string |
|
setRelease
The name of the Release.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getRolloutUid
Unique identifier of the Rollout.
| Returns | |
|---|---|
| Type | Description |
string |
|
setRolloutUid
Unique identifier of the Rollout.
| 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 |
|
getTargetId
ID of the Target.
| Returns | |
|---|---|
| Type | Description |
string |
|
setTargetId
ID of the Target.
| 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 |
|