Skip to content

Commit

Permalink
feat: [batch] Clarify Batch API proto doc about pubsub notifications (#…
Browse files Browse the repository at this point in the history 
…9741)

* feat: Clarify Batch API proto doc about pubsub notifications

---
feat: add Batch Managed Container support for v1alpha
PiperOrigin-RevId: 554622486

Source-Link: googleapis/googleapis@0e42ad0

Source-Link: https://github.com/googleapis/googleapis-gen/commit/274d7b777e44d2e060ee0dca36204119275c2dca
Copy-Tag: eyJwIjoiamF2YS1iYXRjaC8uT3dsQm90LnlhbWwiLCJoIjoiMjc0ZDdiNzc3ZTQ0ZDJlMDYwZWUwZGNhMzYyMDQxMTkyNzVjMmRjYSJ9

* 🦉 Updates from OwlBot post-processor

See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md

---------

Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>
  • Loading branch information
@gcf-owl-bot
gcf-owl-bot[bot] and gcf-owl-bot[bot] authored Aug 8, 2023
1 parent bb4271e commit e580ede
Show file tree
Hide file tree
Showing 7 changed files with 124 additions and 108 deletions.
2 changes: 1 addition & 1 deletion java-batch/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ If you are using Maven with [BOM][libraries-bom], add this to your pom.xml file:
<dependency>
<groupId>com.google.cloud</groupId>
<artifactId>libraries-bom</artifactId>
<version>26.20.0</version>
<version>26.21.0</version>
<type>pom</type>
<scope>import</scope>
</dependency>
Expand Down
10 changes: 5 additions & 5 deletions ...proto-google-cloud-batch-v1/src/main/java/com/google/cloud/batch/v1/AllocationPolicy.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4427,7 +4427,7 @@ public interface AcceleratorOrBuilder
* <code>bool install_gpu_drivers = 3 [deprecated = true];</code>
*
* @deprecated google.cloud.batch.v1.AllocationPolicy.Accelerator.install_gpu_drivers is
* deprecated. See google/cloud/batch/v1/job.proto;l=327
* deprecated. See google/cloud/batch/v1/job.proto;l=331
* @return The installGpuDrivers.
*/
@java.lang.Deprecated
Expand Down Expand Up @@ -4598,7 +4598,7 @@ public long getCount() {
* <code>bool install_gpu_drivers = 3 [deprecated = true];</code>
*
* @deprecated google.cloud.batch.v1.AllocationPolicy.Accelerator.install_gpu_drivers is
* deprecated. See google/cloud/batch/v1/job.proto;l=327
* deprecated. See google/cloud/batch/v1/job.proto;l=331
* @return The installGpuDrivers.
*/
@java.lang.Override
Expand Down Expand Up @@ -5260,7 +5260,7 @@ public Builder clearCount() {
* <code>bool install_gpu_drivers = 3 [deprecated = true];</code>
*
* @deprecated google.cloud.batch.v1.AllocationPolicy.Accelerator.install_gpu_drivers is
* deprecated. See google/cloud/batch/v1/job.proto;l=327
* deprecated. See google/cloud/batch/v1/job.proto;l=331
* @return The installGpuDrivers.
*/
@java.lang.Override
Expand All @@ -5278,7 +5278,7 @@ public boolean getInstallGpuDrivers() {
* <code>bool install_gpu_drivers = 3 [deprecated = true];</code>
*
* @deprecated google.cloud.batch.v1.AllocationPolicy.Accelerator.install_gpu_drivers is
* deprecated. See google/cloud/batch/v1/job.proto;l=327
* deprecated. See google/cloud/batch/v1/job.proto;l=331
* @param value The installGpuDrivers to set.
* @return This builder for chaining.
*/
Expand All @@ -5300,7 +5300,7 @@ public Builder setInstallGpuDrivers(boolean value) {
* <code>bool install_gpu_drivers = 3 [deprecated = true];</code>
*
* @deprecated google.cloud.batch.v1.AllocationPolicy.Accelerator.install_gpu_drivers is
* deprecated. See google/cloud/batch/v1/job.proto;l=327
* deprecated. See google/cloud/batch/v1/job.proto;l=331
* @return This builder for chaining.
*/
@java.lang.Deprecated
Expand Down
44 changes: 26 additions & 18 deletions .../proto-google-cloud-batch-v1/src/main/java/com/google/cloud/batch/v1/JobNotification.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -304,8 +304,12 @@ public interface MessageOrBuilder
*
* <pre>
* 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.
* </pre>
*
* Protobuf type {@code google.cloud.batch.v1.JobNotification.Message}
Expand Down Expand Up @@ -637,8 +641,12 @@ protected Builder newBuilderForType(
*
* <pre>
* 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.
* </pre>
*
* Protobuf type {@code google.cloud.batch.v1.JobNotification.Message}
Expand Down Expand Up @@ -1189,8 +1197,8 @@ public com.google.cloud.batch.v1.JobNotification.Message getDefaultInstanceForTy
*
* <pre>
* 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}`.
* </pre>
Expand All @@ -1216,8 +1224,8 @@ public java.lang.String getPubsubTopic() {
*
* <pre>
* 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}`.
* </pre>
Expand Down Expand Up @@ -1670,8 +1678,8 @@ public Builder mergeFrom(
*
* <pre>
* 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}`.
* </pre>
Expand All @@ -1696,8 +1704,8 @@ public java.lang.String getPubsubTopic() {
*
* <pre>
* 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}`.
* </pre>
Expand All @@ -1722,8 +1730,8 @@ public com.google.protobuf.ByteString getPubsubTopicBytes() {
*
* <pre>
* 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}`.
* </pre>
Expand All @@ -1747,8 +1755,8 @@ public Builder setPubsubTopic(java.lang.String value) {
*
* <pre>
* 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}`.
* </pre>
Expand All @@ -1768,8 +1776,8 @@ public Builder clearPubsubTopic() {
*
* <pre>
* 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}`.
* </pre>
Expand Down
8 changes: 4 additions & 4 deletions ...ogle-cloud-batch-v1/src/main/java/com/google/cloud/batch/v1/JobNotificationOrBuilder.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,8 @@ public interface JobNotificationOrBuilder
*
* <pre>
* 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}`.
* </pre>
Expand All @@ -44,8 +44,8 @@ public interface JobNotificationOrBuilder
*
* <pre>
* 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}`.
* </pre>
Expand Down
Loading

0 comments on commit e580ede

Please sign in to comment.