-
Notifications
You must be signed in to change notification settings - Fork 2.4k
/
batch_v1.projects.locations.jobs.html
1190 lines (1136 loc) 路 142 KB
/
batch_v1.projects.locations.jobs.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="batch_v1.html">Batch API</a> . <a href="batch_v1.projects.html">projects</a> . <a href="batch_v1.projects.locations.html">locations</a> . <a href="batch_v1.projects.locations.jobs.html">jobs</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="batch_v1.projects.locations.jobs.taskGroups.html">taskGroups()</a></code>
</p>
<p class="firstline">Returns the taskGroups Resource.</p>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#create">create(parent, body=None, jobId=None, requestId=None, x__xgafv=None)</a></code></p>
<p class="firstline">Create a Job.</p>
<p class="toc_element">
<code><a href="#delete">delete(name, reason=None, requestId=None, x__xgafv=None)</a></code></p>
<p class="firstline">Delete a Job.</p>
<p class="toc_element">
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Get a Job specified by its resource name.</p>
<p class="toc_element">
<code><a href="#getIamPolicy">getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None)</a></code></p>
<p class="firstline">Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.</p>
<p class="toc_element">
<code><a href="#list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">List all Jobs for a project within a region.</p>
<p class="toc_element">
<code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#setIamPolicy">setIamPolicy(resource, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.</p>
<p class="toc_element">
<code><a href="#testIamPermissions">testIamPermissions(resource, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="create">create(parent, body=None, jobId=None, requestId=None, x__xgafv=None)</code>
<pre>Create a Job.
Args:
parent: string, Required. The parent resource name where the Job will be created. Pattern: "projects/{project}/locations/{location}" (required)
body: object, The request body.
The object takes the form of:
{ # The Cloud Batch Job description.
"allocationPolicy": { # A Job's resource allocation policy describes when, where, and how compute resources should be allocated for the Job. # Compute resource allocation for all TaskGroups in the Job.
"instances": [ # Describe instances that can be created by this AllocationPolicy. Only instances[0] is supported now.
{ # Either an InstancePolicy or an instance template.
"installGpuDrivers": True or False, # Set this field true if users want Batch to help fetch drivers from a third party location and install them for GPUs specified in policy.accelerators or instance_template on their behalf. Default is false.
"instanceTemplate": "A String", # Name of an instance template used to create VMs. Named the field as 'instance_template' instead of 'template' to avoid c++ keyword conflict.
"policy": { # InstancePolicy describes an instance type and resources attached to each VM created by this InstancePolicy. # InstancePolicy.
"accelerators": [ # The accelerators attached to each VM instance.
{ # Accelerator describes Compute Engine accelerators to be attached to the VM.
"count": "A String", # The number of accelerators of this type.
"installGpuDrivers": True or False, # Deprecated: please use instances[0].install_gpu_drivers instead.
"type": "A String", # The accelerator type. For example, "nvidia-tesla-t4". See `gcloud compute accelerator-types list`.
},
],
"disks": [ # Non-boot disks to be attached for each VM created by this InstancePolicy. New disks will be deleted when the VM is deleted.
{ # A new or an existing persistent disk (PD) or a local ssd attached to a VM instance.
"deviceName": "A String", # Device name that the guest operating system will see. It is used by Runnable.volumes field to mount disks. So please specify the device_name if you want Batch to help mount the disk, and it should match the device_name field in volumes.
"existingDisk": "A String", # Name of an existing PD.
"newDisk": { # A new persistent disk or a local ssd. A VM can only have one local SSD setting but multiple local SSD partitions. https://cloud.google.com/compute/docs/disks#pdspecs. https://cloud.google.com/compute/docs/disks#localssds.
"diskInterface": "A String", # Local SSDs are available through both "SCSI" and "NVMe" interfaces. If not indicated, "NVMe" will be the default one for local ssds. We only support "SCSI" for persistent disks now.
"image": "A String", # Name of a public or custom image used as the data source.
"sizeGb": "A String", # Disk size in GB. This field is ignored if `data_source` is `disk` or `image`. If `type` is `local-ssd`, size_gb should be a multiple of 375GB, otherwise, the final size will be the next greater multiple of 375 GB.
"snapshot": "A String", # Name of a snapshot used as the data source.
"type": "A String", # Disk type as shown in `gcloud compute disk-types list` For example, "pd-ssd", "pd-standard", "pd-balanced", "local-ssd".
},
},
],
"machineType": "A String", # The Compute Engine machine type.
"minCpuPlatform": "A String", # The minimum CPU platform. See `https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform`. Not yet implemented.
"provisioningModel": "A String", # The provisioning model.
},
},
],
"labels": { # Labels applied to all VM instances and other resources created by AllocationPolicy. Labels could be user provided or system generated. You can assign up to 64 labels. [Google Compute Engine label restrictions](https://cloud.google.com/compute/docs/labeling-resources#restrictions) apply. Label names that start with "goog-" or "google-" are reserved.
"a_key": "A String",
},
"location": { # Location where compute resources should be allocated for the Job.
"allowedLocations": [ # A list of allowed location names represented by internal URLs. Each location can be a region or a zone. Only one region or multiple zones in one region is supported now. For example, ["regions/us-central1"] allow VMs in any zones in region us-central1. ["zones/us-central1-a", "zones/us-central1-c"] only allow VMs in zones us-central1-a and us-central1-c. All locations end up in different regions would cause errors. For example, ["regions/us-central1", "zones/us-central1-a", "zones/us-central1-b", "zones/us-west1-a"] contains 2 regions "us-central1" and "us-west1". An error is expected in this case.
"A String",
],
},
"network": { # NetworkPolicy describes VM instance network configurations. # The network policy.
"networkInterfaces": [ # Network configurations.
{ # A network interface.
"network": "A String", # The URL of an existing network resource. You can specify the network as a full or partial URL. For example, the following are all valid URLs: https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} projects/{project}/global/networks/{network} global/networks/{network}
"noExternalIpAddress": True or False, # Default is false (with an external IP address). Required if no external public IP address is attached to the VM. If no external public IP address, additional configuration is required to allow the VM to access Google Services. See https://cloud.google.com/vpc/docs/configure-private-google-access and https://cloud.google.com/nat/docs/gce-example#create-nat for more information.
"subnetwork": "A String", # The URL of an existing subnetwork resource in the network. You can specify the subnetwork as a full or partial URL. For example, the following are all valid URLs: https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/subnetworks/{subnetwork} projects/{project}/regions/{region}/subnetworks/{subnetwork} regions/{region}/subnetworks/{subnetwork}
},
],
},
"serviceAccount": { # Carries information about a Google Cloud service account. # Service account that VMs will run as.
"email": "A String", # Email address of the service account. If not specified, the default Compute Engine service account for the project will be used. If instance template is being used, the service account has to be specified in the instance template and it has to match the email field here.
},
},
"createTime": "A String", # Output only. When the Job was created.
"labels": { # Labels for the Job. Labels could be user provided or system generated. For example, "labels": { "department": "finance", "environment": "test" } You can assign up to 64 labels. [Google Compute Engine label restrictions](https://cloud.google.com/compute/docs/labeling-resources#restrictions) apply. Label names that start with "goog-" or "google-" are reserved.
"a_key": "A String",
},
"logsPolicy": { # LogsPolicy describes how outputs from a Job's Tasks (stdout/stderr) will be preserved. # Log preservation policy for the Job.
"destination": "A String", # Where logs should be saved.
"logsPath": "A String", # The path to which logs are saved when the destination = PATH. This can be a local file path on the VM, or under the mount point of a Persistent Disk or Filestore, or a Cloud Storage path.
},
"name": "A String", # Output only. Job name. For example: "projects/123456/locations/us-central1/jobs/job01".
"notifications": [ # Notification configurations.
{ # Notification configurations.
"message": { # Message details. Describe the attribute that a message should have. Without specified message attributes, no message will be sent by default. # The attribute requirements of messages to be sent to this Pub/Sub topic. Without this field, no message will be sent.
"newJobState": "A String", # The new job state.
"newTaskState": "A String", # The new task state.
"type": "A String", # The message type.
},
"pubsubTopic": "A 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. If not specified, no Pub/Sub messages will be sent. Topic format: `projects/{project}/topics/{topic}`.
},
],
"priority": "A String", # Priority of the Job. The valid value range is [0, 100). A job with higher priority value is more likely to run earlier if all other requirements are satisfied.
"status": { # Job status. # Output only. Job status. It is read only for users.
"runDuration": "A String", # The duration of time that the Job spent in status RUNNING.
"state": "A String", # Job state
"statusEvents": [ # Job status events
{ # Status event
"description": "A String", # Description of the event.
"eventTime": "A String", # The time this event occurred.
"taskExecution": { # This Task Execution field includes detail information for task execution procedures, based on StatusEvent types. # Task Execution
"exitCode": 42, # When task is completed as the status of FAILED or SUCCEEDED, exit code is for one task execution result, default is 0 as success.
},
"type": "A String", # Type of the event.
},
],
"taskGroups": { # Aggregated task status for each TaskGroup in the Job. The map key is TaskGroup ID.
"a_key": { # Aggregated task status for a TaskGroup.
"counts": { # Count of task in each state in the TaskGroup. The map key is task state name.
"a_key": "A String",
},
"instances": [ # Status of instances allocated for the TaskGroup.
{ # VM instance status.
"machineType": "A String", # The Compute Engine machine type.
"provisioningModel": "A String", # The VM instance provisioning model.
"taskPack": "A String", # The max number of tasks can be assigned to this instance type.
},
],
},
},
},
"taskGroups": [ # Required. TaskGroups in the Job. Only one TaskGroup is supported now.
{ # A TaskGroup contains one or multiple Tasks that share the same Runnable but with different runtime parameters.
"name": "A String", # Output only. TaskGroup name. The system generates this field based on parent Job name. For example: "projects/123456/locations/us-west1/jobs/job01/taskGroups/group01".
"parallelism": "A String", # Max number of tasks that can run in parallel. Default to min(task_count, 1000).
"permissiveSsh": True or False, # When true, Batch will configure SSH to allow passwordless login between VMs running the Batch tasks in the same TaskGroup.
"requireHostsFile": True or False, # When true, Batch will populate a file with a list of all VMs assigned to the TaskGroup and set the BATCH_HOSTS_FILE environment variable to the path of that file. Defaults to false.
"taskCount": "A String", # Number of Tasks in the TaskGroup. default is 1
"taskCountPerNode": "A String", # Max number of tasks that can be run on a VM at the same time. If not specified, the system will decide a value based on available compute resources on a VM and task requirements.
"taskEnvironments": [ # An array of environment variable mappings, which are passed to Tasks with matching indices. If task_environments is used then task_count should not be specified in the request (and will be ignored). Task count will be the length of task_environments. Tasks get a BATCH_TASK_INDEX and BATCH_TASK_COUNT environment variable, in addition to any environment variables set in task_environments, specifying the number of Tasks in the Task's parent TaskGroup, and the specific Task's index in the TaskGroup (0 through BATCH_TASK_COUNT - 1). task_environments supports up to 200 entries.
{ # An Environment describes a collection of environment variables to set when executing Tasks.
"variables": { # A map of environment variable names to values.
"a_key": "A String",
},
},
],
"taskSpec": { # Spec of a task # Required. Tasks in the group share the same task spec.
"computeResource": { # Compute resource requirements # ComputeResource requirements.
"bootDiskMib": "A String", # Extra boot disk size in MiB for each task.
"cpuMilli": "A String", # The milliCPU count.
"memoryMib": "A String", # Memory in MiB.
},
"environment": { # An Environment describes a collection of environment variables to set when executing Tasks. # Environment variables to set before running the Task.
"variables": { # A map of environment variable names to values.
"a_key": "A String",
},
},
"environments": { # Deprecated: please use environment(non-plural) instead.
"a_key": "A String",
},
"lifecyclePolicies": [ # Lifecycle management schema when any task in a task group is failed. The valid size of lifecycle policies are [0, 10]. For each lifecycle policy, when the condition is met, the action in that policy will execute. If there are multiple policies that the task execution result matches, we use the action from the first matched policy. If task execution result does not meet with any of the defined lifecycle policy, we consider it as the default policy. Default policy means if the exit code is 0, exit task. If task ends with non-zero exit code, retry the task with max_retry_count.
{ # LifecyclePolicy describes how to deal with task failures based on different conditions.
"action": "A String", # Action to execute when ActionCondition is true.
"actionCondition": { # Conditions for actions to deal with task failures. # Conditions that decide why a task failure is dealt with a specific action.
"exitCodes": [ # Exit codes of a task execution. If there are more than 1 exit codes, when task executes with any of the exit code in the list, the condition is met and the action will be executed.
42,
],
},
},
],
"maxRetryCount": 42, # Maximum number of retries on failures. The default, 0, which means never retry. The valid value range is [0, 10].
"maxRunDuration": "A String", # Maximum duration the task should run. The task will be killed and marked as FAILED if over this limit.
"runnables": [ # The sequence of scripts or containers to run for this Task. Each Task using this TaskSpec executes its list of runnables in order. The Task succeeds if all of its runnables either exit with a zero status or any that exit with a non-zero status have the ignore_exit_status flag. Background runnables are killed automatically (if they have not already exited) a short time after all foreground runnables have completed. Even though this is likely to result in a non-zero exit status for the background runnable, these automatic kills are not treated as Task failures.
{ # Runnable describes instructions for executing a specific script or container as part of a Task.
"alwaysRun": True or False, # By default, after a Runnable fails, no further Runnable are executed. This flag indicates that this Runnable must be run even if the Task has already failed. This is useful for Runnables that copy output files off of the VM or for debugging. The always_run flag does not override the Task's overall max_run_duration. If the max_run_duration has expired then no further Runnables will execute, not even always_run Runnables.
"background": True or False, # This flag allows a Runnable to continue running in the background while the Task executes subsequent Runnables. This is useful to provide services to other Runnables (or to provide debugging support tools like SSH servers).
"barrier": { # Barrier runnable blocks until all tasks in a taskgroup reach it. # Barrier runnable.
"name": "A String", # Barriers are identified by their index in runnable list. Names are not required, but if present should be an identifier.
},
"container": { # Container runnable. # Container runnable.
"blockExternalNetwork": True or False, # If set to true, external network access to and from container will be blocked. The container will use the default internal network 'goog-internal'.
"commands": [ # Overrides the `CMD` specified in the container. If there is an ENTRYPOINT (either in the container image or with the entrypoint field below) then commands are appended as arguments to the ENTRYPOINT.
"A String",
],
"entrypoint": "A String", # Overrides the `ENTRYPOINT` specified in the container.
"imageUri": "A String", # The URI to pull the container image from.
"options": "A String", # Arbitrary additional options to include in the "docker run" command when running this container, e.g. "--network host".
"password": "A String", # Optional password for logging in to a docker registry. If password matches `projects/*/secrets/*/versions/*` then Batch will read the password from the Secret Manager;
"username": "A String", # Optional username for logging in to a docker registry. If username matches `projects/*/secrets/*/versions/*` then Batch will read the username from the Secret Manager.
"volumes": [ # Volumes to mount (bind mount) from the host machine files or directories into the container, formatted to match docker run's --volume option, e.g. /foo:/bar, or /foo:/bar:ro
"A String",
],
},
"environment": { # An Environment describes a collection of environment variables to set when executing Tasks. # Environment variables for this Runnable (overrides variables set for the whole Task or TaskGroup).
"variables": { # A map of environment variable names to values.
"a_key": "A String",
},
},
"ignoreExitStatus": True or False, # Normally, a non-zero exit status causes the Task to fail. This flag allows execution of other Runnables to continue instead.
"script": { # Script runnable. # Script runnable.
"path": "A String", # Script file path on the host VM.
"text": "A String", # Shell script text.
},
"timeout": "A String", # Timeout for this Runnable.
},
],
"volumes": [ # Volumes to mount before running Tasks using this TaskSpec.
{ # Volume describes a volume and parameters for it to be mounted to a VM.
"deviceName": "A String", # Device name of an attached disk volume, which should align with a device_name specified by job.allocation_policy.instances[0].policy.disks[i].device_name or defined by the given instance template in job.allocation_policy.instances[0].instance_template.
"gcs": { # Represents a Google Cloud Storage volume. # A Google Cloud Storage (GCS) volume.
"remotePath": "A String", # Remote path, either a bucket name or a subdirectory of a bucket, e.g.: bucket_name, bucket_name/subdirectory/
},
"mountOptions": [ # For Google Cloud Storage (GCS), mount options are the options supported by the gcsfuse tool (https://github.com/GoogleCloudPlatform/gcsfuse). For existing persistent disks, mount options provided by the mount command (https://man7.org/linux/man-pages/man8/mount.8.html) except writing are supported. This is due to restrictions of multi-writer mode (https://cloud.google.com/compute/docs/disks/sharing-disks-between-vms). For other attached disks and Network File System (NFS), mount options are these supported by the mount command (https://man7.org/linux/man-pages/man8/mount.8.html).
"A String",
],
"mountPath": "A String", # The mount path for the volume, e.g. /mnt/disks/share.
"nfs": { # Represents an NFS volume. # A Network File System (NFS) volume. For example, a Filestore file share.
"remotePath": "A String", # Remote source path exported from the NFS, e.g., "/share".
"server": "A String", # The IP address of the NFS.
},
},
],
},
},
],
"uid": "A String", # Output only. A system generated unique ID (in UUID4 format) for the Job.
"updateTime": "A String", # Output only. The last time the Job was updated.
}
jobId: string, ID used to uniquely identify the Job within its parent scope. This field should contain at most 63 characters and must start with lowercase characters. Only lowercase characters, numbers and '-' are accepted. The '-' character cannot be the first or the last one. A system generated ID will be used if the field is not set. The job.name field in the request will be ignored and the created resource name of the Job will be "{parent}/jobs/{job_id}".
requestId: string, Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and t he request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # The Cloud Batch Job description.
"allocationPolicy": { # A Job's resource allocation policy describes when, where, and how compute resources should be allocated for the Job. # Compute resource allocation for all TaskGroups in the Job.
"instances": [ # Describe instances that can be created by this AllocationPolicy. Only instances[0] is supported now.
{ # Either an InstancePolicy or an instance template.
"installGpuDrivers": True or False, # Set this field true if users want Batch to help fetch drivers from a third party location and install them for GPUs specified in policy.accelerators or instance_template on their behalf. Default is false.
"instanceTemplate": "A String", # Name of an instance template used to create VMs. Named the field as 'instance_template' instead of 'template' to avoid c++ keyword conflict.
"policy": { # InstancePolicy describes an instance type and resources attached to each VM created by this InstancePolicy. # InstancePolicy.
"accelerators": [ # The accelerators attached to each VM instance.
{ # Accelerator describes Compute Engine accelerators to be attached to the VM.
"count": "A String", # The number of accelerators of this type.
"installGpuDrivers": True or False, # Deprecated: please use instances[0].install_gpu_drivers instead.
"type": "A String", # The accelerator type. For example, "nvidia-tesla-t4". See `gcloud compute accelerator-types list`.
},
],
"disks": [ # Non-boot disks to be attached for each VM created by this InstancePolicy. New disks will be deleted when the VM is deleted.
{ # A new or an existing persistent disk (PD) or a local ssd attached to a VM instance.
"deviceName": "A String", # Device name that the guest operating system will see. It is used by Runnable.volumes field to mount disks. So please specify the device_name if you want Batch to help mount the disk, and it should match the device_name field in volumes.
"existingDisk": "A String", # Name of an existing PD.
"newDisk": { # A new persistent disk or a local ssd. A VM can only have one local SSD setting but multiple local SSD partitions. https://cloud.google.com/compute/docs/disks#pdspecs. https://cloud.google.com/compute/docs/disks#localssds.
"diskInterface": "A String", # Local SSDs are available through both "SCSI" and "NVMe" interfaces. If not indicated, "NVMe" will be the default one for local ssds. We only support "SCSI" for persistent disks now.
"image": "A String", # Name of a public or custom image used as the data source.
"sizeGb": "A String", # Disk size in GB. This field is ignored if `data_source` is `disk` or `image`. If `type` is `local-ssd`, size_gb should be a multiple of 375GB, otherwise, the final size will be the next greater multiple of 375 GB.
"snapshot": "A String", # Name of a snapshot used as the data source.
"type": "A String", # Disk type as shown in `gcloud compute disk-types list` For example, "pd-ssd", "pd-standard", "pd-balanced", "local-ssd".
},
},
],
"machineType": "A String", # The Compute Engine machine type.
"minCpuPlatform": "A String", # The minimum CPU platform. See `https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform`. Not yet implemented.
"provisioningModel": "A String", # The provisioning model.
},
},
],
"labels": { # Labels applied to all VM instances and other resources created by AllocationPolicy. Labels could be user provided or system generated. You can assign up to 64 labels. [Google Compute Engine label restrictions](https://cloud.google.com/compute/docs/labeling-resources#restrictions) apply. Label names that start with "goog-" or "google-" are reserved.
"a_key": "A String",
},
"location": { # Location where compute resources should be allocated for the Job.
"allowedLocations": [ # A list of allowed location names represented by internal URLs. Each location can be a region or a zone. Only one region or multiple zones in one region is supported now. For example, ["regions/us-central1"] allow VMs in any zones in region us-central1. ["zones/us-central1-a", "zones/us-central1-c"] only allow VMs in zones us-central1-a and us-central1-c. All locations end up in different regions would cause errors. For example, ["regions/us-central1", "zones/us-central1-a", "zones/us-central1-b", "zones/us-west1-a"] contains 2 regions "us-central1" and "us-west1". An error is expected in this case.
"A String",
],
},
"network": { # NetworkPolicy describes VM instance network configurations. # The network policy.
"networkInterfaces": [ # Network configurations.
{ # A network interface.
"network": "A String", # The URL of an existing network resource. You can specify the network as a full or partial URL. For example, the following are all valid URLs: https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} projects/{project}/global/networks/{network} global/networks/{network}
"noExternalIpAddress": True or False, # Default is false (with an external IP address). Required if no external public IP address is attached to the VM. If no external public IP address, additional configuration is required to allow the VM to access Google Services. See https://cloud.google.com/vpc/docs/configure-private-google-access and https://cloud.google.com/nat/docs/gce-example#create-nat for more information.
"subnetwork": "A String", # The URL of an existing subnetwork resource in the network. You can specify the subnetwork as a full or partial URL. For example, the following are all valid URLs: https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/subnetworks/{subnetwork} projects/{project}/regions/{region}/subnetworks/{subnetwork} regions/{region}/subnetworks/{subnetwork}
},
],
},
"serviceAccount": { # Carries information about a Google Cloud service account. # Service account that VMs will run as.
"email": "A String", # Email address of the service account. If not specified, the default Compute Engine service account for the project will be used. If instance template is being used, the service account has to be specified in the instance template and it has to match the email field here.
},
},
"createTime": "A String", # Output only. When the Job was created.
"labels": { # Labels for the Job. Labels could be user provided or system generated. For example, "labels": { "department": "finance", "environment": "test" } You can assign up to 64 labels. [Google Compute Engine label restrictions](https://cloud.google.com/compute/docs/labeling-resources#restrictions) apply. Label names that start with "goog-" or "google-" are reserved.
"a_key": "A String",
},
"logsPolicy": { # LogsPolicy describes how outputs from a Job's Tasks (stdout/stderr) will be preserved. # Log preservation policy for the Job.
"destination": "A String", # Where logs should be saved.
"logsPath": "A String", # The path to which logs are saved when the destination = PATH. This can be a local file path on the VM, or under the mount point of a Persistent Disk or Filestore, or a Cloud Storage path.
},
"name": "A String", # Output only. Job name. For example: "projects/123456/locations/us-central1/jobs/job01".
"notifications": [ # Notification configurations.
{ # Notification configurations.
"message": { # Message details. Describe the attribute that a message should have. Without specified message attributes, no message will be sent by default. # The attribute requirements of messages to be sent to this Pub/Sub topic. Without this field, no message will be sent.
"newJobState": "A String", # The new job state.
"newTaskState": "A String", # The new task state.
"type": "A String", # The message type.
},
"pubsubTopic": "A 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. If not specified, no Pub/Sub messages will be sent. Topic format: `projects/{project}/topics/{topic}`.
},
],
"priority": "A String", # Priority of the Job. The valid value range is [0, 100). A job with higher priority value is more likely to run earlier if all other requirements are satisfied.
"status": { # Job status. # Output only. Job status. It is read only for users.
"runDuration": "A String", # The duration of time that the Job spent in status RUNNING.
"state": "A String", # Job state
"statusEvents": [ # Job status events
{ # Status event
"description": "A String", # Description of the event.
"eventTime": "A String", # The time this event occurred.
"taskExecution": { # This Task Execution field includes detail information for task execution procedures, based on StatusEvent types. # Task Execution
"exitCode": 42, # When task is completed as the status of FAILED or SUCCEEDED, exit code is for one task execution result, default is 0 as success.
},
"type": "A String", # Type of the event.
},
],
"taskGroups": { # Aggregated task status for each TaskGroup in the Job. The map key is TaskGroup ID.
"a_key": { # Aggregated task status for a TaskGroup.
"counts": { # Count of task in each state in the TaskGroup. The map key is task state name.
"a_key": "A String",
},
"instances": [ # Status of instances allocated for the TaskGroup.
{ # VM instance status.
"machineType": "A String", # The Compute Engine machine type.
"provisioningModel": "A String", # The VM instance provisioning model.
"taskPack": "A String", # The max number of tasks can be assigned to this instance type.
},
],
},
},
},
"taskGroups": [ # Required. TaskGroups in the Job. Only one TaskGroup is supported now.
{ # A TaskGroup contains one or multiple Tasks that share the same Runnable but with different runtime parameters.
"name": "A String", # Output only. TaskGroup name. The system generates this field based on parent Job name. For example: "projects/123456/locations/us-west1/jobs/job01/taskGroups/group01".
"parallelism": "A String", # Max number of tasks that can run in parallel. Default to min(task_count, 1000).
"permissiveSsh": True or False, # When true, Batch will configure SSH to allow passwordless login between VMs running the Batch tasks in the same TaskGroup.
"requireHostsFile": True or False, # When true, Batch will populate a file with a list of all VMs assigned to the TaskGroup and set the BATCH_HOSTS_FILE environment variable to the path of that file. Defaults to false.
"taskCount": "A String", # Number of Tasks in the TaskGroup. default is 1
"taskCountPerNode": "A String", # Max number of tasks that can be run on a VM at the same time. If not specified, the system will decide a value based on available compute resources on a VM and task requirements.
"taskEnvironments": [ # An array of environment variable mappings, which are passed to Tasks with matching indices. If task_environments is used then task_count should not be specified in the request (and will be ignored). Task count will be the length of task_environments. Tasks get a BATCH_TASK_INDEX and BATCH_TASK_COUNT environment variable, in addition to any environment variables set in task_environments, specifying the number of Tasks in the Task's parent TaskGroup, and the specific Task's index in the TaskGroup (0 through BATCH_TASK_COUNT - 1). task_environments supports up to 200 entries.
{ # An Environment describes a collection of environment variables to set when executing Tasks.
"variables": { # A map of environment variable names to values.
"a_key": "A String",
},
},
],
"taskSpec": { # Spec of a task # Required. Tasks in the group share the same task spec.
"computeResource": { # Compute resource requirements # ComputeResource requirements.
"bootDiskMib": "A String", # Extra boot disk size in MiB for each task.
"cpuMilli": "A String", # The milliCPU count.
"memoryMib": "A String", # Memory in MiB.
},
"environment": { # An Environment describes a collection of environment variables to set when executing Tasks. # Environment variables to set before running the Task.
"variables": { # A map of environment variable names to values.
"a_key": "A String",
},
},
"environments": { # Deprecated: please use environment(non-plural) instead.
"a_key": "A String",
},
"lifecyclePolicies": [ # Lifecycle management schema when any task in a task group is failed. The valid size of lifecycle policies are [0, 10]. For each lifecycle policy, when the condition is met, the action in that policy will execute. If there are multiple policies that the task execution result matches, we use the action from the first matched policy. If task execution result does not meet with any of the defined lifecycle policy, we consider it as the default policy. Default policy means if the exit code is 0, exit task. If task ends with non-zero exit code, retry the task with max_retry_count.
{ # LifecyclePolicy describes how to deal with task failures based on different conditions.
"action": "A String", # Action to execute when ActionCondition is true.
"actionCondition": { # Conditions for actions to deal with task failures. # Conditions that decide why a task failure is dealt with a specific action.
"exitCodes": [ # Exit codes of a task execution. If there are more than 1 exit codes, when task executes with any of the exit code in the list, the condition is met and the action will be executed.
42,
],
},
},
],
"maxRetryCount": 42, # Maximum number of retries on failures. The default, 0, which means never retry. The valid value range is [0, 10].
"maxRunDuration": "A String", # Maximum duration the task should run. The task will be killed and marked as FAILED if over this limit.
"runnables": [ # The sequence of scripts or containers to run for this Task. Each Task using this TaskSpec executes its list of runnables in order. The Task succeeds if all of its runnables either exit with a zero status or any that exit with a non-zero status have the ignore_exit_status flag. Background runnables are killed automatically (if they have not already exited) a short time after all foreground runnables have completed. Even though this is likely to result in a non-zero exit status for the background runnable, these automatic kills are not treated as Task failures.
{ # Runnable describes instructions for executing a specific script or container as part of a Task.
"alwaysRun": True or False, # By default, after a Runnable fails, no further Runnable are executed. This flag indicates that this Runnable must be run even if the Task has already failed. This is useful for Runnables that copy output files off of the VM or for debugging. The always_run flag does not override the Task's overall max_run_duration. If the max_run_duration has expired then no further Runnables will execute, not even always_run Runnables.
"background": True or False, # This flag allows a Runnable to continue running in the background while the Task executes subsequent Runnables. This is useful to provide services to other Runnables (or to provide debugging support tools like SSH servers).
"barrier": { # Barrier runnable blocks until all tasks in a taskgroup reach it. # Barrier runnable.
"name": "A String", # Barriers are identified by their index in runnable list. Names are not required, but if present should be an identifier.
},
"container": { # Container runnable. # Container runnable.
"blockExternalNetwork": True or False, # If set to true, external network access to and from container will be blocked. The container will use the default internal network 'goog-internal'.
"commands": [ # Overrides the `CMD` specified in the container. If there is an ENTRYPOINT (either in the container image or with the entrypoint field below) then commands are appended as arguments to the ENTRYPOINT.
"A String",
],
"entrypoint": "A String", # Overrides the `ENTRYPOINT` specified in the container.
"imageUri": "A String", # The URI to pull the container image from.
"options": "A String", # Arbitrary additional options to include in the "docker run" command when running this container, e.g. "--network host".
"password": "A String", # Optional password for logging in to a docker registry. If password matches `projects/*/secrets/*/versions/*` then Batch will read the password from the Secret Manager;
"username": "A String", # Optional username for logging in to a docker registry. If username matches `projects/*/secrets/*/versions/*` then Batch will read the username from the Secret Manager.
"volumes": [ # Volumes to mount (bind mount) from the host machine files or directories into the container, formatted to match docker run's --volume option, e.g. /foo:/bar, or /foo:/bar:ro
"A String",
],
},
"environment": { # An Environment describes a collection of environment variables to set when executing Tasks. # Environment variables for this Runnable (overrides variables set for the whole Task or TaskGroup).
"variables": { # A map of environment variable names to values.
"a_key": "A String",
},
},
"ignoreExitStatus": True or False, # Normally, a non-zero exit status causes the Task to fail. This flag allows execution of other Runnables to continue instead.
"script": { # Script runnable. # Script runnable.
"path": "A String", # Script file path on the host VM.
"text": "A String", # Shell script text.
},
"timeout": "A String", # Timeout for this Runnable.
},
],
"volumes": [ # Volumes to mount before running Tasks using this TaskSpec.
{ # Volume describes a volume and parameters for it to be mounted to a VM.
"deviceName": "A String", # Device name of an attached disk volume, which should align with a device_name specified by job.allocation_policy.instances[0].policy.disks[i].device_name or defined by the given instance template in job.allocation_policy.instances[0].instance_template.
"gcs": { # Represents a Google Cloud Storage volume. # A Google Cloud Storage (GCS) volume.
"remotePath": "A String", # Remote path, either a bucket name or a subdirectory of a bucket, e.g.: bucket_name, bucket_name/subdirectory/
},
"mountOptions": [ # For Google Cloud Storage (GCS), mount options are the options supported by the gcsfuse tool (https://github.com/GoogleCloudPlatform/gcsfuse). For existing persistent disks, mount options provided by the mount command (https://man7.org/linux/man-pages/man8/mount.8.html) except writing are supported. This is due to restrictions of multi-writer mode (https://cloud.google.com/compute/docs/disks/sharing-disks-between-vms). For other attached disks and Network File System (NFS), mount options are these supported by the mount command (https://man7.org/linux/man-pages/man8/mount.8.html).
"A String",
],
"mountPath": "A String", # The mount path for the volume, e.g. /mnt/disks/share.
"nfs": { # Represents an NFS volume. # A Network File System (NFS) volume. For example, a Filestore file share.
"remotePath": "A String", # Remote source path exported from the NFS, e.g., "/share".
"server": "A String", # The IP address of the NFS.
},
},
],
},
},
],
"uid": "A String", # Output only. A system generated unique ID (in UUID4 format) for the Job.
"updateTime": "A String", # Output only. The last time the Job was updated.
}</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(name, reason=None, requestId=None, x__xgafv=None)</code>
<pre>Delete a Job.
Args:
name: string, Job name. (required)
reason: string, Optional. Reason for this deletion.
requestId: string, Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and t he request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}</pre>
</div>
<div class="method">
<code class="details" id="get">get(name, x__xgafv=None)</code>
<pre>Get a Job specified by its resource name.
Args:
name: string, Required. Job name. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # The Cloud Batch Job description.
"allocationPolicy": { # A Job's resource allocation policy describes when, where, and how compute resources should be allocated for the Job. # Compute resource allocation for all TaskGroups in the Job.
"instances": [ # Describe instances that can be created by this AllocationPolicy. Only instances[0] is supported now.
{ # Either an InstancePolicy or an instance template.
"installGpuDrivers": True or False, # Set this field true if users want Batch to help fetch drivers from a third party location and install them for GPUs specified in policy.accelerators or instance_template on their behalf. Default is false.
"instanceTemplate": "A String", # Name of an instance template used to create VMs. Named the field as 'instance_template' instead of 'template' to avoid c++ keyword conflict.
"policy": { # InstancePolicy describes an instance type and resources attached to each VM created by this InstancePolicy. # InstancePolicy.
"accelerators": [ # The accelerators attached to each VM instance.
{ # Accelerator describes Compute Engine accelerators to be attached to the VM.
"count": "A String", # The number of accelerators of this type.
"installGpuDrivers": True or False, # Deprecated: please use instances[0].install_gpu_drivers instead.
"type": "A String", # The accelerator type. For example, "nvidia-tesla-t4". See `gcloud compute accelerator-types list`.
},
],
"disks": [ # Non-boot disks to be attached for each VM created by this InstancePolicy. New disks will be deleted when the VM is deleted.
{ # A new or an existing persistent disk (PD) or a local ssd attached to a VM instance.
"deviceName": "A String", # Device name that the guest operating system will see. It is used by Runnable.volumes field to mount disks. So please specify the device_name if you want Batch to help mount the disk, and it should match the device_name field in volumes.
"existingDisk": "A String", # Name of an existing PD.
"newDisk": { # A new persistent disk or a local ssd. A VM can only have one local SSD setting but multiple local SSD partitions. https://cloud.google.com/compute/docs/disks#pdspecs. https://cloud.google.com/compute/docs/disks#localssds.
"diskInterface": "A String", # Local SSDs are available through both "SCSI" and "NVMe" interfaces. If not indicated, "NVMe" will be the default one for local ssds. We only support "SCSI" for persistent disks now.
"image": "A String", # Name of a public or custom image used as the data source.
"sizeGb": "A String", # Disk size in GB. This field is ignored if `data_source` is `disk` or `image`. If `type` is `local-ssd`, size_gb should be a multiple of 375GB, otherwise, the final size will be the next greater multiple of 375 GB.
"snapshot": "A String", # Name of a snapshot used as the data source.
"type": "A String", # Disk type as shown in `gcloud compute disk-types list` For example, "pd-ssd", "pd-standard", "pd-balanced", "local-ssd".
},
},
],
"machineType": "A String", # The Compute Engine machine type.
"minCpuPlatform": "A String", # The minimum CPU platform. See `https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform`. Not yet implemented.
"provisioningModel": "A String", # The provisioning model.
},
},
],
"labels": { # Labels applied to all VM instances and other resources created by AllocationPolicy. Labels could be user provided or system generated. You can assign up to 64 labels. [Google Compute Engine label restrictions](https://cloud.google.com/compute/docs/labeling-resources#restrictions) apply. Label names that start with "goog-" or "google-" are reserved.
"a_key": "A String",
},
"location": { # Location where compute resources should be allocated for the Job.
"allowedLocations": [ # A list of allowed location names represented by internal URLs. Each location can be a region or a zone. Only one region or multiple zones in one region is supported now. For example, ["regions/us-central1"] allow VMs in any zones in region us-central1. ["zones/us-central1-a", "zones/us-central1-c"] only allow VMs in zones us-central1-a and us-central1-c. All locations end up in different regions would cause errors. For example, ["regions/us-central1", "zones/us-central1-a", "zones/us-central1-b", "zones/us-west1-a"] contains 2 regions "us-central1" and "us-west1". An error is expected in this case.
"A String",
],
},
"network": { # NetworkPolicy describes VM instance network configurations. # The network policy.
"networkInterfaces": [ # Network configurations.
{ # A network interface.
"network": "A String", # The URL of an existing network resource. You can specify the network as a full or partial URL. For example, the following are all valid URLs: https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} projects/{project}/global/networks/{network} global/networks/{network}
"noExternalIpAddress": True or False, # Default is false (with an external IP address). Required if no external public IP address is attached to the VM. If no external public IP address, additional configuration is required to allow the VM to access Google Services. See https://cloud.google.com/vpc/docs/configure-private-google-access and https://cloud.google.com/nat/docs/gce-example#create-nat for more information.
"subnetwork": "A String", # The URL of an existing subnetwork resource in the network. You can specify the subnetwork as a full or partial URL. For example, the following are all valid URLs: https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/subnetworks/{subnetwork} projects/{project}/regions/{region}/subnetworks/{subnetwork} regions/{region}/subnetworks/{subnetwork}
},
],
},
"serviceAccount": { # Carries information about a Google Cloud service account. # Service account that VMs will run as.
"email": "A String", # Email address of the service account. If not specified, the default Compute Engine service account for the project will be used. If instance template is being used, the service account has to be specified in the instance template and it has to match the email field here.
},
},
"createTime": "A String", # Output only. When the Job was created.
"labels": { # Labels for the Job. Labels could be user provided or system generated. For example, "labels": { "department": "finance", "environment": "test" } You can assign up to 64 labels. [Google Compute Engine label restrictions](https://cloud.google.com/compute/docs/labeling-resources#restrictions) apply. Label names that start with "goog-" or "google-" are reserved.
"a_key": "A String",
},
"logsPolicy": { # LogsPolicy describes how outputs from a Job's Tasks (stdout/stderr) will be preserved. # Log preservation policy for the Job.
"destination": "A String", # Where logs should be saved.
"logsPath": "A String", # The path to which logs are saved when the destination = PATH. This can be a local file path on the VM, or under the mount point of a Persistent Disk or Filestore, or a Cloud Storage path.
},
"name": "A String", # Output only. Job name. For example: "projects/123456/locations/us-central1/jobs/job01".
"notifications": [ # Notification configurations.
{ # Notification configurations.
"message": { # Message details. Describe the attribute that a message should have. Without specified message attributes, no message will be sent by default. # The attribute requirements of messages to be sent to this Pub/Sub topic. Without this field, no message will be sent.
"newJobState": "A String", # The new job state.
"newTaskState": "A String", # The new task state.
"type": "A String", # The message type.
},
"pubsubTopic": "A 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. If not specified, no Pub/Sub messages will be sent. Topic format: `projects/{project}/topics/{topic}`.
},
],
"priority": "A String", # Priority of the Job. The valid value range is [0, 100). A job with higher priority value is more likely to run earlier if all other requirements are satisfied.
"status": { # Job status. # Output only. Job status. It is read only for users.
"runDuration": "A String", # The duration of time that the Job spent in status RUNNING.
"state": "A String", # Job state
"statusEvents": [ # Job status events
{ # Status event
"description": "A String", # Description of the event.
"eventTime": "A String", # The time this event occurred.
"taskExecution": { # This Task Execution field includes detail information for task execution procedures, based on StatusEvent types. # Task Execution
"exitCode": 42, # When task is completed as the status of FAILED or SUCCEEDED, exit code is for one task execution result, default is 0 as success.
},
"type": "A String", # Type of the event.
},
],
"taskGroups": { # Aggregated task status for each TaskGroup in the Job. The map key is TaskGroup ID.
"a_key": { # Aggregated task status for a TaskGroup.
"counts": { # Count of task in each state in the TaskGroup. The map key is task state name.
"a_key": "A String",
},
"instances": [ # Status of instances allocated for the TaskGroup.
{ # VM instance status.
"machineType": "A String", # The Compute Engine machine type.
"provisioningModel": "A String", # The VM instance provisioning model.
"taskPack": "A String", # The max number of tasks can be assigned to this instance type.
},
],
},
},
},
"taskGroups": [ # Required. TaskGroups in the Job. Only one TaskGroup is supported now.
{ # A TaskGroup contains one or multiple Tasks that share the same Runnable but with different runtime parameters.
"name": "A String", # Output only. TaskGroup name. The system generates this field based on parent Job name. For example: "projects/123456/locations/us-west1/jobs/job01/taskGroups/group01".
"parallelism": "A String", # Max number of tasks that can run in parallel. Default to min(task_count, 1000).
"permissiveSsh": True or False, # When true, Batch will configure SSH to allow passwordless login between VMs running the Batch tasks in the same TaskGroup.
"requireHostsFile": True or False, # When true, Batch will populate a file with a list of all VMs assigned to the TaskGroup and set the BATCH_HOSTS_FILE environment variable to the path of that file. Defaults to false.
"taskCount": "A String", # Number of Tasks in the TaskGroup. default is 1
"taskCountPerNode": "A String", # Max number of tasks that can be run on a VM at the same time. If not specified, the system will decide a value based on available compute resources on a VM and task requirements.
"taskEnvironments": [ # An array of environment variable mappings, which are passed to Tasks with matching indices. If task_environments is used then task_count should not be specified in the request (and will be ignored). Task count will be the length of task_environments. Tasks get a BATCH_TASK_INDEX and BATCH_TASK_COUNT environment variable, in addition to any environment variables set in task_environments, specifying the number of Tasks in the Task's parent TaskGroup, and the specific Task's index in the TaskGroup (0 through BATCH_TASK_COUNT - 1). task_environments supports up to 200 entries.
{ # An Environment describes a collection of environment variables to set when executing Tasks.
"variables": { # A map of environment variable names to values.
"a_key": "A String",
},
},
],
"taskSpec": { # Spec of a task # Required. Tasks in the group share the same task spec.
"computeResource": { # Compute resource requirements # ComputeResource requirements.
"bootDiskMib": "A String", # Extra boot disk size in MiB for each task.
"cpuMilli": "A String", # The milliCPU count.
"memoryMib": "A String", # Memory in MiB.
},
"environment": { # An Environment describes a collection of environment variables to set when executing Tasks. # Environment variables to set before running the Task.
"variables": { # A map of environment variable names to values.
"a_key": "A String",
},
},
"environments": { # Deprecated: please use environment(non-plural) instead.
"a_key": "A String",
},
"lifecyclePolicies": [ # Lifecycle management schema when any task in a task group is failed. The valid size of lifecycle policies are [0, 10]. For each lifecycle policy, when the condition is met, the action in that policy will execute. If there are multiple policies that the task execution result matches, we use the action from the first matched policy. If task execution result does not meet with any of the defined lifecycle policy, we consider it as the default policy. Default policy means if the exit code is 0, exit task. If task ends with non-zero exit code, retry the task with max_retry_count.
{ # LifecyclePolicy describes how to deal with task failures based on different conditions.
"action": "A String", # Action to execute when ActionCondition is true.
"actionCondition": { # Conditions for actions to deal with task failures. # Conditions that decide why a task failure is dealt with a specific action.
"exitCodes": [ # Exit codes of a task execution. If there are more than 1 exit codes, when task executes with any of the exit code in the list, the condition is met and the action will be executed.
42,
],
},
},
],
"maxRetryCount": 42, # Maximum number of retries on failures. The default, 0, which means never retry. The valid value range is [0, 10].
"maxRunDuration": "A String", # Maximum duration the task should run. The task will be killed and marked as FAILED if over this limit.
"runnables": [ # The sequence of scripts or containers to run for this Task. Each Task using this TaskSpec executes its list of runnables in order. The Task succeeds if all of its runnables either exit with a zero status or any that exit with a non-zero status have the ignore_exit_status flag. Background runnables are killed automatically (if they have not already exited) a short time after all foreground runnables have completed. Even though this is likely to result in a non-zero exit status for the background runnable, these automatic kills are not treated as Task failures.
{ # Runnable describes instructions for executing a specific script or container as part of a Task.
"alwaysRun": True or False, # By default, after a Runnable fails, no further Runnable are executed. This flag indicates that this Runnable must be run even if the Task has already failed. This is useful for Runnables that copy output files off of the VM or for debugging. The always_run flag does not override the Task's overall max_run_duration. If the max_run_duration has expired then no further Runnables will execute, not even always_run Runnables.
"background": True or False, # This flag allows a Runnable to continue running in the background while the Task executes subsequent Runnables. This is useful to provide services to other Runnables (or to provide debugging support tools like SSH servers).
"barrier": { # Barrier runnable blocks until all tasks in a taskgroup reach it. # Barrier runnable.
"name": "A String", # Barriers are identified by their index in runnable list. Names are not required, but if present should be an identifier.
},
"container": { # Container runnable. # Container runnable.
"blockExternalNetwork": True or False, # If set to true, external network access to and from container will be blocked. The container will use the default internal network 'goog-internal'.
"commands": [ # Overrides the `CMD` specified in the container. If there is an ENTRYPOINT (either in the container image or with the entrypoint field below) then commands are appended as arguments to the ENTRYPOINT.
"A String",
],
"entrypoint": "A String", # Overrides the `ENTRYPOINT` specified in the container.
"imageUri": "A String", # The URI to pull the container image from.
"options": "A String", # Arbitrary additional options to include in the "docker run" command when running this container, e.g. "--network host".
"password": "A String", # Optional password for logging in to a docker registry. If password matches `projects/*/secrets/*/versions/*` then Batch will read the password from the Secret Manager;
"username": "A String", # Optional username for logging in to a docker registry. If username matches `projects/*/secrets/*/versions/*` then Batch will read the username from the Secret Manager.
"volumes": [ # Volumes to mount (bind mount) from the host machine files or directories into the container, formatted to match docker run's --volume option, e.g. /foo:/bar, or /foo:/bar:ro
"A String",
],
},
"environment": { # An Environment describes a collection of environment variables to set when executing Tasks. # Environment variables for this Runnable (overrides variables set for the whole Task or TaskGroup).
"variables": { # A map of environment variable names to values.
"a_key": "A String",
},
},
"ignoreExitStatus": True or False, # Normally, a non-zero exit status causes the Task to fail. This flag allows execution of other Runnables to continue instead.
"script": { # Script runnable. # Script runnable.
"path": "A String", # Script file path on the host VM.
"text": "A String", # Shell script text.
},
"timeout": "A String", # Timeout for this Runnable.
},
],
"volumes": [ # Volumes to mount before running Tasks using this TaskSpec.
{ # Volume describes a volume and parameters for it to be mounted to a VM.
"deviceName": "A String", # Device name of an attached disk volume, which should align with a device_name specified by job.allocation_policy.instances[0].policy.disks[i].device_name or defined by the given instance template in job.allocation_policy.instances[0].instance_template.
"gcs": { # Represents a Google Cloud Storage volume. # A Google Cloud Storage (GCS) volume.
"remotePath": "A String", # Remote path, either a bucket name or a subdirectory of a bucket, e.g.: bucket_name, bucket_name/subdirectory/
},
"mountOptions": [ # For Google Cloud Storage (GCS), mount options are the options supported by the gcsfuse tool (https://github.com/GoogleCloudPlatform/gcsfuse). For existing persistent disks, mount options provided by the mount command (https://man7.org/linux/man-pages/man8/mount.8.html) except writing are supported. This is due to restrictions of multi-writer mode (https://cloud.google.com/compute/docs/disks/sharing-disks-between-vms). For other attached disks and Network File System (NFS), mount options are these supported by the mount command (https://man7.org/linux/man-pages/man8/mount.8.html).
"A String",
],
"mountPath": "A String", # The mount path for the volume, e.g. /mnt/disks/share.
"nfs": { # Represents an NFS volume. # A Network File System (NFS) volume. For example, a Filestore file share.
"remotePath": "A String", # Remote source path exported from the NFS, e.g., "/share".
"server": "A String", # The IP address of the NFS.
},
},
],
},
},
],
"uid": "A String", # Output only. A system generated unique ID (in UUID4 format) for the Job.
"updateTime": "A String", # Output only. The last time the Job was updated.
}</pre>
</div>
<div class="method">
<code class="details" id="getIamPolicy">getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None)</code>
<pre>Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
Args:
resource: string, REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. (required)
options_requestedPolicyVersion: integer, Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).
"auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
{ # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging.
"auditLogConfigs": [ # The configuration for logging of each type of permission.
{ # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.
"exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.
"A String",
],
"logType": "A String", # The log type that this config enables.
},
],
"service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.
},
],
"bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.
{ # Associates `members`, or principals, with a `role`.
"condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
"description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
"expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
"location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
"title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
},
"members": [ # Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`.
"A String",
],
"role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
},
],
"etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
"version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>List all Jobs for a project within a region.
Args:
parent: string, Parent path. (required)
filter: string, List filter.
pageSize: integer, Page size.
pageToken: string, Page token.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # ListJob Response.
"jobs": [ # Jobs.
{ # The Cloud Batch Job description.
"allocationPolicy": { # A Job's resource allocation policy describes when, where, and how compute resources should be allocated for the Job. # Compute resource allocation for all TaskGroups in the Job.
"instances": [ # Describe instances that can be created by this AllocationPolicy. Only instances[0] is supported now.
{ # Either an InstancePolicy or an instance template.
"installGpuDrivers": True or False, # Set this field true if users want Batch to help fetch drivers from a third party location and install them for GPUs specified in policy.accelerators or instance_template on their behalf. Default is false.
"instanceTemplate": "A String", # Name of an instance template used to create VMs. Named the field as 'instance_template' instead of 'template' to avoid c++ keyword conflict.
"policy": { # InstancePolicy describes an instance type and resources attached to each VM created by this InstancePolicy. # InstancePolicy.
"accelerators": [ # The accelerators attached to each VM instance.
{ # Accelerator describes Compute Engine accelerators to be attached to the VM.
"count": "A String", # The number of accelerators of this type.
"installGpuDrivers": True or False, # Deprecated: please use instances[0].install_gpu_drivers instead.
"type": "A String", # The accelerator type. For example, "nvidia-tesla-t4". See `gcloud compute accelerator-types list`.
},
],
"disks": [ # Non-boot disks to be attached for each VM created by this InstancePolicy. New disks will be deleted when the VM is deleted.
{ # A new or an existing persistent disk (PD) or a local ssd attached to a VM instance.
"deviceName": "A String", # Device name that the guest operating system will see. It is used by Runnable.volumes field to mount disks. So please specify the device_name if you want Batch to help mount the disk, and it should match the device_name field in volumes.
"existingDisk": "A String", # Name of an existing PD.
"newDisk": { # A new persistent disk or a local ssd. A VM can only have one local SSD setting but multiple local SSD partitions. https://cloud.google.com/compute/docs/disks#pdspecs. https://cloud.google.com/compute/docs/disks#localssds.
"diskInterface": "A String", # Local SSDs are available through both "SCSI" and "NVMe" interfaces. If not indicated, "NVMe" will be the default one for local ssds. We only support "SCSI" for persistent disks now.
"image": "A String", # Name of a public or custom image used as the data source.
"sizeGb": "A String", # Disk size in GB. This field is ignored if `data_source` is `disk` or `image`. If `type` is `local-ssd`, size_gb should be a multiple of 375GB, otherwise, the final size will be the next greater multiple of 375 GB.
"snapshot": "A String", # Name of a snapshot used as the data source.
"type": "A String", # Disk type as shown in `gcloud compute disk-types list` For example, "pd-ssd", "pd-standard", "pd-balanced", "local-ssd".
},
},
],
"machineType": "A String", # The Compute Engine machine type.
"minCpuPlatform": "A String", # The minimum CPU platform. See `https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform`. Not yet implemented.
"provisioningModel": "A String", # The provisioning model.
},
},
],
"labels": { # Labels applied to all VM instances and other resources created by AllocationPolicy. Labels could be user provided or system generated. You can assign up to 64 labels. [Google Compute Engine label restrictions](https://cloud.google.com/compute/docs/labeling-resources#restrictions) apply. Label names that start with "goog-" or "google-" are reserved.
"a_key": "A String",
},
"location": { # Location where compute resources should be allocated for the Job.
"allowedLocations": [ # A list of allowed location names represented by internal URLs. Each location can be a region or a zone. Only one region or multiple zones in one region is supported now. For example, ["regions/us-central1"] allow VMs in any zones in region us-central1. ["zones/us-central1-a", "zones/us-central1-c"] only allow VMs in zones us-central1-a and us-central1-c. All locations end up in different regions would cause errors. For example, ["regions/us-central1", "zones/us-central1-a", "zones/us-central1-b", "zones/us-west1-a"] contains 2 regions "us-central1" and "us-west1". An error is expected in this case.
"A String",
],
},
"network": { # NetworkPolicy describes VM instance network configurations. # The network policy.
"networkInterfaces": [ # Network configurations.
{ # A network interface.
"network": "A String", # The URL of an existing network resource. You can specify the network as a full or partial URL. For example, the following are all valid URLs: https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} projects/{project}/global/networks/{network} global/networks/{network}
"noExternalIpAddress": True or False, # Default is false (with an external IP address). Required if no external public IP address is attached to the VM. If no external public IP address, additional configuration is required to allow the VM to access Google Services. See https://cloud.google.com/vpc/docs/configure-private-google-access and https://cloud.google.com/nat/docs/gce-example#create-nat for more information.
"subnetwork": "A String", # The URL of an existing subnetwork resource in the network. You can specify the subnetwork as a full or partial URL. For example, the following are all valid URLs: https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/subnetworks/{subnetwork} projects/{project}/regions/{region}/subnetworks/{subnetwork} regions/{region}/subnetworks/{subnetwork}
},
],
},
"serviceAccount": { # Carries information about a Google Cloud service account. # Service account that VMs will run as.
"email": "A String", # Email address of the service account. If not specified, the default Compute Engine service account for the project will be used. If instance template is being used, the service account has to be specified in the instance template and it has to match the email field here.
},
},
"createTime": "A String", # Output only. When the Job was created.
"labels": { # Labels for the Job. Labels could be user provided or system generated. For example, "labels": { "department": "finance", "environment": "test" } You can assign up to 64 labels. [Google Compute Engine label restrictions](https://cloud.google.com/compute/docs/labeling-resources#restrictions) apply. Label names that start with "goog-" or "google-" are reserved.
"a_key": "A String",
},
"logsPolicy": { # LogsPolicy describes how outputs from a Job's Tasks (stdout/stderr) will be preserved. # Log preservation policy for the Job.
"destination": "A String", # Where logs should be saved.
"logsPath": "A String", # The path to which logs are saved when the destination = PATH. This can be a local file path on the VM, or under the mount point of a Persistent Disk or Filestore, or a Cloud Storage path.
},
"name": "A String", # Output only. Job name. For example: "projects/123456/locations/us-central1/jobs/job01".
"notifications": [ # Notification configurations.
{ # Notification configurations.
"message": { # Message details. Describe the attribute that a message should have. Without specified message attributes, no message will be sent by default. # The attribute requirements of messages to be sent to this Pub/Sub topic. Without this field, no message will be sent.
"newJobState": "A String", # The new job state.
"newTaskState": "A String", # The new task state.
"type": "A String", # The message type.
},
"pubsubTopic": "A 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. If not specified, no Pub/Sub messages will be sent. Topic format: `projects/{project}/topics/{topic}`.
},
],
"priority": "A String", # Priority of the Job. The valid value range is [0, 100). A job with higher priority value is more likely to run earlier if all other requirements are satisfied.
"status": { # Job status. # Output only. Job status. It is read only for users.
"runDuration": "A String", # The duration of time that the Job spent in status RUNNING.
"state": "A String", # Job state
"statusEvents": [ # Job status events
{ # Status event
"description": "A String", # Description of the event.
"eventTime": "A String", # The time this event occurred.
"taskExecution": { # This Task Execution field includes detail information for task execution procedures, based on StatusEvent types. # Task Execution
"exitCode": 42, # When task is completed as the status of FAILED or SUCCEEDED, exit code is for one task execution result, default is 0 as success.
},
"type": "A String", # Type of the event.
},
],
"taskGroups": { # Aggregated task status for each TaskGroup in the Job. The map key is TaskGroup ID.
"a_key": { # Aggregated task status for a TaskGroup.
"counts": { # Count of task in each state in the TaskGroup. The map key is task state name.
"a_key": "A String",
},
"instances": [ # Status of instances allocated for the TaskGroup.
{ # VM instance status.
"machineType": "A String", # The Compute Engine machine type.
"provisioningModel": "A String", # The VM instance provisioning model.
"taskPack": "A String", # The max number of tasks can be assigned to this instance type.
},
],
},
},
},
"taskGroups": [ # Required. TaskGroups in the Job. Only one TaskGroup is supported now.
{ # A TaskGroup contains one or multiple Tasks that share the same Runnable but with different runtime parameters.
"name": "A String", # Output only. TaskGroup name. The system generates this field based on parent Job name. For example: "projects/123456/locations/us-west1/jobs/job01/taskGroups/group01".
"parallelism": "A String", # Max number of tasks that can run in parallel. Default to min(task_count, 1000).
"permissiveSsh": True or False, # When true, Batch will configure SSH to allow passwordless login between VMs running the Batch tasks in the same TaskGroup.
"requireHostsFile": True or False, # When true, Batch will populate a file with a list of all VMs assigned to the TaskGroup and set the BATCH_HOSTS_FILE environment variable to the path of that file. Defaults to false.
"taskCount": "A String", # Number of Tasks in the TaskGroup. default is 1
"taskCountPerNode": "A String", # Max number of tasks that can be run on a VM at the same time. If not specified, the system will decide a value based on available compute resources on a VM and task requirements.
"taskEnvironments": [ # An array of environment variable mappings, which are passed to Tasks with matching indices. If task_environments is used then task_count should not be specified in the request (and will be ignored). Task count will be the length of task_environments. Tasks get a BATCH_TASK_INDEX and BATCH_TASK_COUNT environment variable, in addition to any environment variables set in task_environments, specifying the number of Tasks in the Task's parent TaskGroup, and the specific Task's index in the TaskGroup (0 through BATCH_TASK_COUNT - 1). task_environments supports up to 200 entries.
{ # An Environment describes a collection of environment variables to set when executing Tasks.
"variables": { # A map of environment variable names to values.
"a_key": "A String",
},
},
],
"taskSpec": { # Spec of a task # Required. Tasks in the group share the same task spec.
"computeResource": { # Compute resource requirements # ComputeResource requirements.
"bootDiskMib": "A String", # Extra boot disk size in MiB for each task.
"cpuMilli": "A String", # The milliCPU count.
"memoryMib": "A String", # Memory in MiB.
},
"environment": { # An Environment describes a collection of environment variables to set when executing Tasks. # Environment variables to set before running the Task.
"variables": { # A map of environment variable names to values.
"a_key": "A String",
},
},
"environments": { # Deprecated: please use environment(non-plural) instead.
"a_key": "A String",
},
"lifecyclePolicies": [ # Lifecycle management schema when any task in a task group is failed. The valid size of lifecycle policies are [0, 10]. For each lifecycle policy, when the condition is met, the action in that policy will execute. If there are multiple policies that the task execution result matches, we use the action from the first matched policy. If task execution result does not meet with any of the defined lifecycle policy, we consider it as the default policy. Default policy means if the exit code is 0, exit task. If task ends with non-zero exit code, retry the task with max_retry_count.
{ # LifecyclePolicy describes how to deal with task failures based on different conditions.
"action": "A String", # Action to execute when ActionCondition is true.
"actionCondition": { # Conditions for actions to deal with task failures. # Conditions that decide why a task failure is dealt with a specific action.
"exitCodes": [ # Exit codes of a task execution. If there are more than 1 exit codes, when task executes with any of the exit code in the list, the condition is met and the action will be executed.
42,
],
},
},
],
"maxRetryCount": 42, # Maximum number of retries on failures. The default, 0, which means never retry. The valid value range is [0, 10].
"maxRunDuration": "A String", # Maximum duration the task should run. The task will be killed and marked as FAILED if over this limit.
"runnables": [ # The sequence of scripts or containers to run for this Task. Each Task using this TaskSpec executes its list of runnables in order. The Task succeeds if all of its runnables either exit with a zero status or any that exit with a non-zero status have the ignore_exit_status flag. Background runnables are killed automatically (if they have not already exited) a short time after all foreground runnables have completed. Even though this is likely to result in a non-zero exit status for the background runnable, these automatic kills are not treated as Task failures.
{ # Runnable describes instructions for executing a specific script or container as part of a Task.
"alwaysRun": True or False, # By default, after a Runnable fails, no further Runnable are executed. This flag indicates that this Runnable must be run even if the Task has already failed. This is useful for Runnables that copy output files off of the VM or for debugging. The always_run flag does not override the Task's overall max_run_duration. If the max_run_duration has expired then no further Runnables will execute, not even always_run Runnables.
"background": True or False, # This flag allows a Runnable to continue running in the background while the Task executes subsequent Runnables. This is useful to provide services to other Runnables (or to provide debugging support tools like SSH servers).