docs: Refine usage scope for fields task_execution and task_state in StatusEvent

Google APIs · copybara-github · commit 00ed8aad1ec2 · 2024-08-05T14:36:46.000-07:00
PiperOrigin-RevId: 659685089
diff --git a/google/cloud/batch/v1/batch_v1_grpc_service_config.json b/google/cloud/batch/v1/batch_v1_grpc_service_config.json
@@ -4,9 +4,11 @@
       { "service": "google.cloud.batch.v1.BatchService", "method": "ListJobs" },
       { "service": "google.cloud.batch.v1.BatchService", "method": "ListTasks" },
       { "service": "google.cloud.batch.v1.BatchService", "method": "ListResourceAllowances" },
+      { "service": "google.cloud.batch.v1.BatchService", "method": "ListNodePools" },
       { "service": "google.cloud.batch.v1.BatchService", "method": "GetJob" },
       { "service": "google.cloud.batch.v1.BatchService", "method": "GetTask" },
-      { "service": "google.cloud.batch.v1.BatchService", "method": "GetResourceAllowance" }
+      { "service": "google.cloud.batch.v1.BatchService", "method": "GetResourceAllowance" },
+      { "service": "google.cloud.batch.v1.BatchService", "method": "GetNodePool" }
     ],
     "timeout": "60s",
     "retryPolicy": {
@@ -26,7 +28,9 @@
       { "service": "google.cloud.batch.v1.BatchService", "method": "CreateResourceAllowance" },
       { "service": "google.cloud.batch.v1.BatchService", "method": "DeleteResourceAllowance" },
       { "service": "google.cloud.batch.v1.BatchService", "method": "UpdateResourceAllowance"},
-      { "service": "google.cloud.batch.v1.BatchService", "method": "CancelTasks"}
+      { "service": "google.cloud.batch.v1.BatchService", "method": "CancelTasks"},
+      { "service": "google.cloud.batch.v1.BatchService", "method": "CreateNodePool" },
+      { "service": "google.cloud.batch.v1.BatchService", "method": "DeleteNodePool" }
     ],
     "timeout": "60s"
   }]
diff --git a/google/cloud/batch/v1/task.proto b/google/cloud/batch/v1/task.proto
@@ -81,7 +81,7 @@ message ComputeResource {
   int64 boot_disk_mib = 4;
 }
 
-// Status event
+// Status event.
 message StatusEvent {
   // Type of the event.
   string type = 3;
@@ -92,10 +92,13 @@ message StatusEvent {
   // The time this event occurred.
   google.protobuf.Timestamp event_time = 2;
 
-  // Task Execution
+  // Task Execution.
+  // This field is only defined for task-level status events where the task
+  // fails.
   TaskExecution task_execution = 4;
 
-  // Task State
+  // Task State.
+  // This field is only defined for task-level status events.
   TaskStatus.State task_state = 5;
 }
 
@@ -116,7 +119,7 @@ message TaskExecution {
   int32 exit_code = 1;
 }
 
-// Status of a task
+// Status of a task.
 message TaskStatus {
   // Task states.
   enum State {
@@ -142,7 +145,7 @@ message TaskStatus {
     UNEXECUTED = 6;
   }
 
-  // Task state
+  // Task state.
   State state = 1;
 
   // Detailed info about why the state is reached.
