docs: Clarify Batch API proto doc about pubsub notifications (#22749)

googleapis · Aug 8, 2023 · 67eb428 · 67eb428
1 parent f3e9643
commit 67eb428
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 5 deletions.
diff --git a/google-cloud-batch-v1/lib/google/cloud/batch/v1/task_pb.rb b/google-cloud-batch-v1/lib/google/cloud/batch/v1/task_pb.rb
diff --git a/google-cloud-batch-v1/proto_docs/google/cloud/batch/v1/job.rb b/google-cloud-batch-v1/proto_docs/google/cloud/batch/v1/job.rb
@@ -210,8 +210,8 @@ module State
  # @!attribute [rw] pubsub_topic
  # @return [::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.
+ # 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}`.
  # @!attribute [rw] message
@@ -223,8 +223,12 @@ class JobNotification
  extend ::Google::Protobuf::MessageExts::ClassMethods
 
  # Message details.
- # Describe the attribute that a message should have.
- # Without specified message attributes, no message will be sent by default.
+ # 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.