Google Cloud Deploy V1 Client - Class JobRunNotificationEvent (0.6.0)

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

Methods

__construct

Constructor.

Parameters
NameDescription
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 JobRun.

↳ pipeline_uid string

Unique identifier of the DeliveryPipeline.

↳ release_uid string

Unique identifier of the Release.

↳ rollout_uid string

Unique identifier of the Rollout.

↳ target_id string

ID of the Target.

↳ type int

Type of this notification, e.g. for a Pub/Sub failure.

getMessage

Debug message for when a notification fails to send.

Returns
TypeDescription
string

setMessage

Debug message for when a notification fails to send.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getJobRun

The name of the JobRun.

Returns
TypeDescription
string

setJobRun

The name of the JobRun.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getPipelineUid

Unique identifier of the DeliveryPipeline.

Returns
TypeDescription
string

setPipelineUid

Unique identifier of the DeliveryPipeline.

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

getRolloutUid

Unique identifier of the Rollout.

Returns
TypeDescription
string

setRolloutUid

Unique identifier of the Rollout.

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 Pub/Sub failure.

Returns
TypeDescription
int

setType

Type of this notification, e.g. for a Pub/Sub failure.

Parameter
NameDescription
var int
Returns
TypeDescription
$this