Skip to content

Commit e580ede

Browse files
feat: [batch] Clarify Batch API proto doc about pubsub notifications (#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>
1 parent bb4271e commit e580ede

File tree

7 files changed

+124
-108
lines changed

7 files changed

+124
-108
lines changed

java-batch/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ If you are using Maven with [BOM][libraries-bom], add this to your pom.xml file:
2323
<dependency>
2424
<groupId>com.google.cloud</groupId>
2525
<artifactId>libraries-bom</artifactId>
26-
<version>26.20.0</version>
26+
<version>26.21.0</version>
2727
<type>pom</type>
2828
<scope>import</scope>
2929
</dependency>

java-batch/proto-google-cloud-batch-v1/src/main/java/com/google/cloud/batch/v1/AllocationPolicy.java

+5-5
Original file line numberDiff line numberDiff line change
@@ -4427,7 +4427,7 @@ public interface AcceleratorOrBuilder
44274427
* <code>bool install_gpu_drivers = 3 [deprecated = true];</code>
44284428
*
44294429
* @deprecated google.cloud.batch.v1.AllocationPolicy.Accelerator.install_gpu_drivers is
4430-
* deprecated. See google/cloud/batch/v1/job.proto;l=327
4430+
* deprecated. See google/cloud/batch/v1/job.proto;l=331
44314431
* @return The installGpuDrivers.
44324432
*/
44334433
@java.lang.Deprecated
@@ -4598,7 +4598,7 @@ public long getCount() {
45984598
* <code>bool install_gpu_drivers = 3 [deprecated = true];</code>
45994599
*
46004600
* @deprecated google.cloud.batch.v1.AllocationPolicy.Accelerator.install_gpu_drivers is
4601-
* deprecated. See google/cloud/batch/v1/job.proto;l=327
4601+
* deprecated. See google/cloud/batch/v1/job.proto;l=331
46024602
* @return The installGpuDrivers.
46034603
*/
46044604
@java.lang.Override
@@ -5260,7 +5260,7 @@ public Builder clearCount() {
52605260
* <code>bool install_gpu_drivers = 3 [deprecated = true];</code>
52615261
*
52625262
* @deprecated google.cloud.batch.v1.AllocationPolicy.Accelerator.install_gpu_drivers is
5263-
* deprecated. See google/cloud/batch/v1/job.proto;l=327
5263+
* deprecated. See google/cloud/batch/v1/job.proto;l=331
52645264
* @return The installGpuDrivers.
52655265
*/
52665266
@java.lang.Override
@@ -5278,7 +5278,7 @@ public boolean getInstallGpuDrivers() {
52785278
* <code>bool install_gpu_drivers = 3 [deprecated = true];</code>
52795279
*
52805280
* @deprecated google.cloud.batch.v1.AllocationPolicy.Accelerator.install_gpu_drivers is
5281-
* deprecated. See google/cloud/batch/v1/job.proto;l=327
5281+
* deprecated. See google/cloud/batch/v1/job.proto;l=331
52825282
* @param value The installGpuDrivers to set.
52835283
* @return This builder for chaining.
52845284
*/
@@ -5300,7 +5300,7 @@ public Builder setInstallGpuDrivers(boolean value) {
53005300
* <code>bool install_gpu_drivers = 3 [deprecated = true];</code>
53015301
*
53025302
* @deprecated google.cloud.batch.v1.AllocationPolicy.Accelerator.install_gpu_drivers is
5303-
* deprecated. See google/cloud/batch/v1/job.proto;l=327
5303+
* deprecated. See google/cloud/batch/v1/job.proto;l=331
53045304
* @return This builder for chaining.
53055305
*/
53065306
@java.lang.Deprecated

java-batch/proto-google-cloud-batch-v1/src/main/java/com/google/cloud/batch/v1/JobNotification.java

+26-18
Original file line numberDiff line numberDiff line change
@@ -304,8 +304,12 @@ public interface MessageOrBuilder
304304
*
305305
* <pre>
306306
* Message details.
307-
* Describe the attribute that a message should have.
308-
* Without specified message attributes, no message will be sent by default.
307+
* Describe the conditions under which messages will be sent.
308+
* If no attribute is defined, no message will be sent by default.
309+
* One message should specify either the job or the task level attributes,
310+
* but not both. For example,
311+
* job level: JOB_STATE_CHANGED and/or a specified new_job_state;
312+
* task level: TASK_STATE_CHANGED and/or a specified new_task_state.
309313
* </pre>
310314
*
311315
* Protobuf type {@code google.cloud.batch.v1.JobNotification.Message}
@@ -637,8 +641,12 @@ protected Builder newBuilderForType(
637641
*
638642
* <pre>
639643
* Message details.
640-
* Describe the attribute that a message should have.
641-
* Without specified message attributes, no message will be sent by default.
644+
* Describe the conditions under which messages will be sent.
645+
* If no attribute is defined, no message will be sent by default.
646+
* One message should specify either the job or the task level attributes,
647+
* but not both. For example,
648+
* job level: JOB_STATE_CHANGED and/or a specified new_job_state;
649+
* task level: TASK_STATE_CHANGED and/or a specified new_task_state.
642650
* </pre>
643651
*
644652
* Protobuf type {@code google.cloud.batch.v1.JobNotification.Message}
@@ -1189,8 +1197,8 @@ public com.google.cloud.batch.v1.JobNotification.Message getDefaultInstanceForTy
11891197
*
11901198
* <pre>
11911199
* The Pub/Sub topic where notifications like the job state changes
1192-
* will be published. This topic exist in the same project as the job
1193-
* and billings will be charged to this project.
1200+
* will be published. The topic must exist in the same project as
1201+
* the job and billings will be charged to this project.
11941202
* If not specified, no Pub/Sub messages will be sent.
11951203
* Topic format: `projects/{project}/topics/{topic}`.
11961204
* </pre>
@@ -1216,8 +1224,8 @@ public java.lang.String getPubsubTopic() {
12161224
*
12171225
* <pre>
12181226
* The Pub/Sub topic where notifications like the job state changes
1219-
* will be published. This topic exist in the same project as the job
1220-
* and billings will be charged to this project.
1227+
* will be published. The topic must exist in the same project as
1228+
* the job and billings will be charged to this project.
12211229
* If not specified, no Pub/Sub messages will be sent.
12221230
* Topic format: `projects/{project}/topics/{topic}`.
12231231
* </pre>
@@ -1670,8 +1678,8 @@ public Builder mergeFrom(
16701678
*
16711679
* <pre>
16721680
* The Pub/Sub topic where notifications like the job state changes
1673-
* will be published. This topic exist in the same project as the job
1674-
* and billings will be charged to this project.
1681+
* will be published. The topic must exist in the same project as
1682+
* the job and billings will be charged to this project.
16751683
* If not specified, no Pub/Sub messages will be sent.
16761684
* Topic format: `projects/{project}/topics/{topic}`.
16771685
* </pre>
@@ -1696,8 +1704,8 @@ public java.lang.String getPubsubTopic() {
16961704
*
16971705
* <pre>
16981706
* The Pub/Sub topic where notifications like the job state changes
1699-
* will be published. This topic exist in the same project as the job
1700-
* and billings will be charged to this project.
1707+
* will be published. The topic must exist in the same project as
1708+
* the job and billings will be charged to this project.
17011709
* If not specified, no Pub/Sub messages will be sent.
17021710
* Topic format: `projects/{project}/topics/{topic}`.
17031711
* </pre>
@@ -1722,8 +1730,8 @@ public com.google.protobuf.ByteString getPubsubTopicBytes() {
17221730
*
17231731
* <pre>
17241732
* The Pub/Sub topic where notifications like the job state changes
1725-
* will be published. This topic exist in the same project as the job
1726-
* and billings will be charged to this project.
1733+
* will be published. The topic must exist in the same project as
1734+
* the job and billings will be charged to this project.
17271735
* If not specified, no Pub/Sub messages will be sent.
17281736
* Topic format: `projects/{project}/topics/{topic}`.
17291737
* </pre>
@@ -1747,8 +1755,8 @@ public Builder setPubsubTopic(java.lang.String value) {
17471755
*
17481756
* <pre>
17491757
* The Pub/Sub topic where notifications like the job state changes
1750-
* will be published. This topic exist in the same project as the job
1751-
* and billings will be charged to this project.
1758+
* will be published. The topic must exist in the same project as
1759+
* the job and billings will be charged to this project.
17521760
* If not specified, no Pub/Sub messages will be sent.
17531761
* Topic format: `projects/{project}/topics/{topic}`.
17541762
* </pre>
@@ -1768,8 +1776,8 @@ public Builder clearPubsubTopic() {
17681776
*
17691777
* <pre>
17701778
* The Pub/Sub topic where notifications like the job state changes
1771-
* will be published. This topic exist in the same project as the job
1772-
* and billings will be charged to this project.
1779+
* will be published. The topic must exist in the same project as
1780+
* the job and billings will be charged to this project.
17731781
* If not specified, no Pub/Sub messages will be sent.
17741782
* Topic format: `projects/{project}/topics/{topic}`.
17751783
* </pre>

java-batch/proto-google-cloud-batch-v1/src/main/java/com/google/cloud/batch/v1/JobNotificationOrBuilder.java

+4-4
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,8 @@ public interface JobNotificationOrBuilder
2828
*
2929
* <pre>
3030
* The Pub/Sub topic where notifications like the job state changes
31-
* will be published. This topic exist in the same project as the job
32-
* and billings will be charged to this project.
31+
* will be published. The topic must exist in the same project as
32+
* the job and billings will be charged to this project.
3333
* If not specified, no Pub/Sub messages will be sent.
3434
* Topic format: `projects/{project}/topics/{topic}`.
3535
* </pre>
@@ -44,8 +44,8 @@ public interface JobNotificationOrBuilder
4444
*
4545
* <pre>
4646
* The Pub/Sub topic where notifications like the job state changes
47-
* will be published. This topic exist in the same project as the job
48-
* and billings will be charged to this project.
47+
* will be published. The topic must exist in the same project as
48+
* the job and billings will be charged to this project.
4949
* If not specified, no Pub/Sub messages will be sent.
5050
* Topic format: `projects/{project}/topics/{topic}`.
5151
* </pre>

0 commit comments

Comments
 (0)