Skip to content

Commit 83585eb

Browse files
Google APIscopybara-github
Google APIs
authored and
copybara-github
committed
feat: add stderr_snippet to indicate the real stderr output by runnables to the execution field of status event
docs: update comments PiperOrigin-RevId: 559249641
1 parent f49882a commit 83585eb

2 files changed

Lines changed: 23 additions & 26 deletions

File tree

‎google/cloud/batch/v1alpha/job.proto‎

Lines changed: 13 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -317,17 +317,14 @@ message AllocationPolicy {
317317
message Disk {
318318
// A data source from which a PD will be created.
319319
oneof data_source {
320-
// Name of an image used as the data source.
320+
// URL for a VM image to use as the data source for this disk.
321321
// For example, the following are all valid URLs:
322322
//
323323
// * Specify the image by its family name:
324-
// <pre><code>projects/<var
325-
// class="apiparam">project</var>/global/images/family/<var
326-
// class="apiparam">image_family</var></code></pre>
324+
// projects/{project}/global/images/family/{image_family}
327325
// * Specify the image version:
328-
// <pre>projects/<var
329-
// class="apiparam">project</var>/global/images/<var
330-
// class="apiparam">image_version</var></code></pre>
326+
// projects/{project}/global/images/{image_version}
327+
//
331328
// You can also use Batch customized image in short names.
332329
// The following image values are supported for a boot disk:
333330
//
@@ -432,7 +429,7 @@ message AllocationPolicy {
432429

433430
// Non-boot disks to be attached for each VM created by this InstancePolicy.
434431
// New disks will be deleted when the VM is deleted.
435-
// A non bootable disk is a disk that can be of a device with a
432+
// A non-boot disk is a disk that can be of a device with a
436433
// file system or a raw storage drive that is not ready for data
437434
// storage and accessing.
438435
repeated AttachedDisk disks = 6;
@@ -476,30 +473,20 @@ message AllocationPolicy {
476473
// You can specify the network as a full or partial URL.
477474
//
478475
// For example, the following are all valid URLs:
479-
// <pre><code>https://www.googleapis.com/compute/v1/projects/<var
480-
// class="apiparam">project</var>/global/networks/<var
481-
// class="apiparam">network</var></code></pre>
482-
// <pre><code>projects/<var
483-
// class="apiparam">project</var>/global/networks/<var
484-
// class="apiparam">network</var></code></pre>
485-
// <pre><code>global/networks/<var
486-
// class="apiparam">network</var></code></pre>
476+
//
477+
// * https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}
478+
// * projects/{project}/global/networks/{network}
479+
// * global/networks/{network}
487480
string network = 1;
488481

489482
// The URL of an existing subnetwork resource in the network.
490483
// You can specify the subnetwork as a full or partial URL.
491484
//
492485
// For example, the following are all valid URLs:
493-
// <pre><code>https://www.googleapis.com/compute/v1/projects/<var
494-
// class="apiparam">project</var>/regions/<var
495-
// class="apiparam">region</var>/subnetworks/<var
496-
// class="apiparam">subnetwork</var></code></pre>
497-
// <pre><code>projects/<var class="apiparam">project</var>/regions/<var
498-
// class="apiparam">region</var>/subnetworks/<var
499-
// class="apiparam">subnetwork</var></code></pre>
500-
// <pre><code>regions/<var
501-
// class="apiparam">region</var>/subnetworks/<var
502-
// class="apiparam">subnetwork</var></code></pre>
486+
//
487+
// * https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/subnetworks/{subnetwork}
488+
// * projects/{project}/regions/{region}/subnetworks/{subnetwork}
489+
// * regions/{region}/subnetworks/{subnetwork}
503490
string subnetwork = 2;
504491

505492
// Default is false (with an external IP address). Required if

‎google/cloud/batch/v1alpha/task.proto‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -110,6 +110,10 @@ message TaskExecution {
110110
// When task is completed as the status of FAILED or SUCCEEDED,
111111
// exit code is for one task execution result, default is 0 as success.
112112
int32 exit_code = 1;
113+
114+
// Optional. The tail end of any content written to standard error by the task
115+
// execution. This field will be populated only when the execution failed.
116+
string stderr_snippet = 2 [(google.api.field_behavior) = OPTIONAL];
113117
}
114118

115119
// Status of a task
@@ -248,6 +252,12 @@ message Runnable {
248252
Barrier barrier = 6;
249253
}
250254

255+
// Optional. DisplayName is an optional field that can be provided by the
256+
// caller. If provided, it will be used in logs and other outputs to identify
257+
// the script, making it easier for users to understand the logs. If not
258+
// provided the index of the runnable will be used for outputs.
259+
string display_name = 10 [(google.api.field_behavior) = OPTIONAL];
260+
251261
// Normally, a non-zero exit status causes the Task to fail. This flag allows
252262
// execution of other Runnables to continue instead.
253263
bool ignore_exit_status = 3;

0 commit comments

Comments
 (0)