Class: Google::Cloud::Batch::V1::JobNotification

Inherits:

Object

Object
Google::Cloud::Batch::V1::JobNotification

show all

Extended by:: Protobuf::MessageExts::ClassMethods

Includes:: Protobuf::MessageExts

Defined in:: proto_docs/google/cloud/batch/v1/job.rb

Overview

Notification configurations.

Defined Under Namespace

Modules: Type Classes: Message

Instance Attribute Summary collapse

#message ⇒ ::Google::Cloud::Batch::V1::JobNotification::Message
The attribute requirements of messages to be sent to this Pub/Sub topic.
#pubsub_topic ⇒ ::String
The Pub/Sub topic where notifications like the job state changes will be published.

Instance Attribute Details

#message ⇒ `::Google::Cloud::Batch::V1::JobNotification::Message`

Returns 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.

# File 'proto_docs/google/cloud/batch/v1/job.rb', line 221

class JobNotification
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Message details.
  # Describe the conditions under which messages will be sent.
  # If no attribute is defined, no message will be sent by default.
  # One message should specify either the job or the task level attributes,
  # but not both. For example,
  # job level: JOB_STATE_CHANGED and/or a specified new_job_state;
  # task level: TASK_STATE_CHANGED and/or a specified new_task_state.
  # @!attribute [rw] type
  #   @return [::Google::Cloud::Batch::V1::JobNotification::Type]
  #     The message type.
  # @!attribute [rw] new_job_state
  #   @return [::Google::Cloud::Batch::V1::JobStatus::State]
  #     The new job state.
  # @!attribute [rw] new_task_state
  #   @return [::Google::Cloud::Batch::V1::TaskStatus::State]
  #     The new task state.
  class Message
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The message type.
  module Type
    # Unspecified.
    TYPE_UNSPECIFIED = 0

    # Notify users that the job state has changed.
    JOB_STATE_CHANGED = 1

    # Notify users that the task state has changed.
    TASK_STATE_CHANGED = 2
  end
end

#pubsub_topic ⇒ `::String`

Returns 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}.