Google Cloud Batch V1 Client - Class JobNotification (0.12.1)

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

Namespace

Google \ Cloud \ Batch \ V1

Methods

__construct

Constructor.

Parameters
NameDescription
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. The topic must 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}.

↳ 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. The topic must 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
TypeDescription
string

setPubsubTopic

The Pub/Sub topic where notifications like the job state changes will be published. The topic must 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
NameDescription
var string
Returns
TypeDescription
$this

getMessage

The attribute requirements of messages to be sent to this Pub/Sub topic.

Without this field, no message will be sent.

Returns
TypeDescription
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
NameDescription
var Google\Cloud\Batch\V1\JobNotification\Message
Returns
TypeDescription
$this