Reference documentation and code samples for the Google Cloud Batch V1 Client class JobNotification.
Notification configurations.
Generated from protobuf message google.cloud.batch.v1.JobNotification
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ pubsub_topic |
string
The Pub/Sub topic where notifications like the job state changes will be published. This topic exist in the same project as the job and billings will be charged to this project. If not specified, no Pub/Sub messages will be sent. Topic format: |
↳ message |
Google\Cloud\Batch\V1\JobNotification\Message
The attribute requirements of messages to be sent to this Pub/Sub topic. Without this field, no message will be sent. |
getPubsubTopic
The Pub/Sub topic where notifications like the job state changes will be published. This topic exist in the same project as the job and billings will be charged to this project.
If not specified, no Pub/Sub messages will be sent.
Topic format: projects/{project}/topics/{topic}.
| Returns | |
|---|---|
| Type | Description |
string | |
setPubsubTopic
The Pub/Sub topic where notifications like the job state changes will be published. This topic exist in the same project as the job and billings will be charged to this project.
If not specified, no Pub/Sub messages will be sent.
Topic format: projects/{project}/topics/{topic}.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getMessage
The attribute requirements of messages to be sent to this Pub/Sub topic.
Without this field, no message will be sent.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Batch\V1\JobNotification\Message|null | |
hasMessage
clearMessage
setMessage
The attribute requirements of messages to be sent to this Pub/Sub topic.
Without this field, no message will be sent.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Batch\V1\JobNotification\Message
|
| Returns | |
|---|---|
| Type | Description |
$this | |