Batch V1 API - Class Google::Cloud::Batch::V1::JobNotification (v0.18.0)

Version latest

• 0.18.0 (latest)
• 0.17.4
• 0.16.2
• 0.15.1
• 0.14.0
• 0.13.1
• 0.12.0
• 0.11.1
• 0.10.5
• 0.9.0
• 0.8.0
• 0.7.0
• 0.6.0
• 0.5.0
• 0.4.3
• 0.3.0
• 0.2.0
• 0.1.0

Reference documentation and code samples for the Batch V1 API class Google::Cloud::Batch::V1::JobNotification.

Notification configurations.

Inherits

• Object

Extended By

• Google::Protobuf::MessageExts::ClassMethods

Includes

• Google::Protobuf::MessageExts

Methods

#message

def message() -> ::Google::Cloud::Batch::V1::JobNotification::Message

Returns

• (::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.

#message=

def message=(value) -> ::Google::Cloud::Batch::V1::JobNotification::Message

Parameter

• value (::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.

Returns

• (::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.

#pubsub_topic

def pubsub_topic() -> ::String

Returns

• (::String) — The Pub/Sub topic where notifications for the job, like state changes, will be published. If undefined, no Pub/Sub notifications are sent for this job.

  Specify the topic using the following format: projects/{project}/topics/{topic}. Notably, if you want to specify a Pub/Sub topic that is in a different project than the job, your administrator must grant your project's Batch service agent permission to publish to that topic.

  For more information about configuring Pub/Sub notifications for a job, see https://cloud.google.com/batch/docs/enable-notifications.

#pubsub_topic=

def pubsub_topic=(value) -> ::String

Parameter

• value (::String) — The Pub/Sub topic where notifications for the job, like state changes, will be published. If undefined, no Pub/Sub notifications are sent for this job.

  Specify the topic using the following format: projects/{project}/topics/{topic}. Notably, if you want to specify a Pub/Sub topic that is in a different project than the job, your administrator must grant your project's Batch service agent permission to publish to that topic.

  For more information about configuring Pub/Sub notifications for a job, see https://cloud.google.com/batch/docs/enable-notifications.

Returns

• (::String) — The Pub/Sub topic where notifications for the job, like state changes, will be published. If undefined, no Pub/Sub notifications are sent for this job.

  Specify the topic using the following format: projects/{project}/topics/{topic}. Notably, if you want to specify a Pub/Sub topic that is in a different project than the job, your administrator must grant your project's Batch service agent permission to publish to that topic.

  For more information about configuring Pub/Sub notifications for a job, see https://cloud.google.com/batch/docs/enable-notifications.