- Resource: Job
- TaskGroup
- TaskSpec
- Runnable
- Container
- Script
- Barrier
- Environment
- KMSEnvMap
- ComputeResource
- LifecyclePolicy
- Action
- ActionCondition
- Volume
- NFS
- GCS
- SchedulingPolicy
- AllocationPolicy
- LocationPolicy
- InstancePolicyOrTemplate
- InstancePolicy
- ProvisioningModel
- Accelerator
- Disk
- AttachedDisk
- ServiceAccount
- NetworkPolicy
- NetworkInterface
- PlacementPolicy
- JobStatus
- State
- TaskGroupStatus
- InstanceStatus
- LogsPolicy
- Destination
- JobNotification
- Message
- Type
- Methods
Resource: Job
The Cloud Batch Job description.
JSON representation |
---|
{ "name": string, "uid": string, "priority": string, "taskGroups": [ { object ( |
Fields | |
---|---|
name |
Output only. Job name. For example: "projects/123456/locations/us-central1/jobs/job01". |
uid |
Output only. A system generated unique ID (in UUID4 format) for the Job. |
priority |
Priority of the Job. The valid value range is [0, 100). Default value is 0. Higher value indicates higher priority. A job with higher priority value is more likely to run earlier if all other requirements are satisfied. |
taskGroups[] |
Required. TaskGroups in the Job. Only one TaskGroup is supported now. |
allocationPolicy |
Compute resource allocation for all TaskGroups in the Job. |
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 apply. Label names that start with "goog-" or "google-" are reserved. An object containing a list of |
status |
Output only. Job status. It is read only for users. |
createTime |
Output only. When the Job was created. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
updateTime |
Output only. The last time the Job was updated. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
logsPolicy |
Log preservation policy for the Job. |
notifications[] |
Notification configurations. |
TaskGroup
A TaskGroup defines one or more Tasks that all share the same TaskSpec.
JSON representation |
---|
{ "name": string, "taskSpec": { object ( |
Fields | |
---|---|
name |
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". |
taskSpec |
Required. Tasks in the group share the same task spec. |
taskCount |
Number of Tasks in the TaskGroup. Default is 1. |
parallelism |
Max number of tasks that can run in parallel. Default to min(taskCount, 1000). Field parallelism must be 1 if the schedulingPolicy is IN_ORDER. |
schedulingPolicy |
Scheduling policy for Tasks in the TaskGroup. The default value is AS_SOON_AS_POSSIBLE. |
taskEnvironments[] |
An array of environment variable mappings, which are passed to Tasks with matching indices. If taskEnvironments is used then taskCount should not be specified in the request (and will be ignored). Task count will be the length of taskEnvironments. Tasks get a BATCH_TASK_INDEX and BATCH_TASK_COUNT environment variable, in addition to any environment variables set in taskEnvironments, 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). |
taskCountPerNode |
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. |
requireHostsFile |
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. |
permissiveSsh |
When true, Batch will configure SSH to allow passwordless login between VMs running the Batch tasks in the same TaskGroup. |
TaskSpec
Spec of a task
JSON representation |
---|
{ "runnables": [ { object ( |
Fields | |
---|---|
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 ignoreExitStatus 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. |
computeResource |
ComputeResource requirements. |
maxRunDuration |
Maximum duration the task should run. The task will be killed and marked as FAILED if over this limit. A duration in seconds with up to nine fractional digits, ending with ' |
maxRetryCount |
Maximum number of retries on failures. The default, 0, which means never retry. The valid value range is [0, 10]. |
lifecyclePolicies[] |
Lifecycle management schema when any task in a task group is failed. Currently we only support one lifecycle policy. When the lifecycle policy condition is met, the action in the policy will execute. If task execution result does not meet with 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 maxRetryCount. |
environments |
Deprecated: please use environment(non-plural) instead. An object containing a list of |
volumes[] |
Volumes to mount before running Tasks using this TaskSpec. |
environment |
Environment variables to set before running the Task. |
Runnable
Runnable describes instructions for executing a specific script or container as part of a Task.
JSON representation |
---|
{ "ignoreExitStatus": boolean, "background": boolean, "alwaysRun": boolean, "environment": { object ( |
Fields | |
---|---|
ignoreExitStatus |
Normally, a non-zero exit status causes the Task to fail. This flag allows execution of other Runnables to continue instead. |
background |
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). |
alwaysRun |
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 alwaysRun flag does not override the Task's overall maxRunDuration. If the maxRunDuration has expired then no further Runnables will execute, not even alwaysRun Runnables. |
environment |
Environment variables for this Runnable (overrides variables set for the whole Task or TaskGroup). |
timeout |
Timeout for this Runnable. A duration in seconds with up to nine fractional digits, ending with ' |
labels |
Labels for this Runnable. An object containing a list of |
Union field executable . The script or container to run. executable can be only one of the following: |
|
container |
Container runnable. |
script |
Script runnable. |
barrier |
Barrier runnable. |
Container
Container runnable.
JSON representation |
---|
{ "imageUri": string, "commands": [ string ], "entrypoint": string, "volumes": [ string ], "options": string, "blockExternalNetwork": boolean, "username": string, "password": string } |
Fields | |
---|---|
imageUri |
The URI to pull the container image from. |
commands[] |
Overrides the |
entrypoint |
Overrides the |
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 |
options |
Arbitrary additional options to include in the "docker run" command when running this container, e.g. "--network host". |
blockExternalNetwork |
If set to true, external network access to and from container will be blocked, containers that are with blockExternalNetwork as true can still communicate with each other, network cannot be specified in the |
username |
Optional username for logging in to a docker registry. If username matches |
password |
Optional password for logging in to a docker registry. If password matches |
Script
Script runnable.
JSON representation |
---|
{ // Union field |
Fields | |
---|---|
Union field
|
|
path |
Script file path on the host VM. To specify an interpreter, please add a |
text |
Shell script text. To specify an interpreter, please add a |
Barrier
Barrier runnable blocks until all tasks in a taskgroup reach it.
JSON representation |
---|
{ "name": string } |
Fields | |
---|---|
name |
Barriers are identified by their index in runnable list. Names are not required, but if present should be an identifier. |
Environment
An Environment describes a collection of environment variables to set when executing Tasks.
JSON representation |
---|
{
"variables": {
string: string,
...
},
"secretVariables": {
string: string,
...
},
"encryptedVariables": {
object ( |
Fields | |
---|---|
variables |
A map of environment variable names to values. An object containing a list of |
secretVariables |
A map of environment variable names to Secret Manager secret names. The VM will access the named secrets to set the value of each environment variable. An object containing a list of |
encryptedVariables |
An encrypted JSON dictionary where the key/value pairs correspond to environment variable names and their values. |
KMSEnvMap
JSON representation |
---|
{ "keyName": string, "cipherText": string } |
Fields | |
---|---|
keyName |
The name of the KMS key that will be used to decrypt the cipher text. |
cipherText |
The value of the cipherText response from the |
ComputeResource
Compute resource requirements
JSON representation |
---|
{ "cpuMilli": string, "memoryMib": string, "bootDiskMib": string } |
Fields | |
---|---|
cpuMilli |
The milliCPU count. |
memoryMib |
Memory in MiB. |
bootDiskMib |
Extra boot disk size in MiB for each task. |
LifecyclePolicy
LifecyclePolicy describes how to deal with task failures based on different conditions.
JSON representation |
---|
{ "action": enum ( |
Fields | |
---|---|
action |
Action to execute when ActionCondition is true. When RETRY_TASK is specified, we will retry failed tasks if we notice any exit code match and fail tasks if no match is found. Likewise, when FAIL_TASK is specified, we will fail tasks if we notice any exit code match and retry tasks if no match is found. |
actionCondition |
Conditions that decide why a task failure is dealt with a specific action. |
Action
Action on task failures based on different conditions.
Enums | |
---|---|
ACTION_UNSPECIFIED |
Action unspecified. |
RETRY_TASK |
Action that tasks in the group will be scheduled to re-execute. |
FAIL_TASK |
Action that tasks in the group will be stopped immediately. |
ActionCondition
Conditions for actions to deal with task failures.
JSON representation |
---|
{ "exitCodes": [ integer ] } |
Fields | |
---|---|
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. |
Volume
Volume describes a volume and parameters for it to be mounted to a VM.
JSON representation |
---|
{ "mountPath": string, "mountOptions": [ string ], // Union field |
Fields | |
---|---|
mountPath |
The mount path for the volume, e.g. /mnt/disks/share. |
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). |
Union field source . The source for the volume. source can be only one of the following: |
|
nfs |
A Network File System (NFS) volume. For example, a Filestore file share. |
gcs |
A Google Cloud Storage (GCS) volume. |
deviceName |
Device name of an attached disk volume, which should align with a deviceName 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. |
NFS
Represents an NFS volume.
JSON representation |
---|
{ "server": string, "remotePath": string } |
Fields | |
---|---|
server |
The IP address of the NFS. |
remotePath |
Remote source path exported from the NFS, e.g., "/share". |
GCS
Represents a Google Cloud Storage volume.
JSON representation |
---|
{ "remotePath": string } |
Fields | |
---|---|
remotePath |
Remote path, either a bucket name or a subdirectory of a bucket, e.g.: bucket_name, bucket_name/subdirectory/ |
SchedulingPolicy
How Tasks in the TaskGroup should be scheduled relative to each other.
Enums | |
---|---|
SCHEDULING_POLICY_UNSPECIFIED |
Unspecified. |
AS_SOON_AS_POSSIBLE |
Run Tasks as soon as resources are available. Tasks might be executed in parallel depending on parallelism and taskCount values. |
IN_ORDER |
Run Tasks sequentially with increased task index. |
AllocationPolicy
A Job's resource allocation policy describes when, where, and how compute resources should be allocated for the Job.
JSON representation |
---|
{ "location": { object ( |
Fields | |
---|---|
location |
Location where compute resources should be allocated for the Job. |
instances[] |
Describe instances that can be created by this AllocationPolicy. Only instances[0] is supported now. |
serviceAccount |
Service account that VMs will run as. |
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 apply. Label names that start with "goog-" or "google-" are reserved. An object containing a list of |
network |
The network policy. |
placement |
The placement policy. |
LocationPolicy
JSON representation |
---|
{ "allowedLocations": [ string ] } |
Fields | |
---|---|
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. |
InstancePolicyOrTemplate
Either an InstancePolicy or an instance template.
JSON representation |
---|
{ "installGpuDrivers": boolean, // Union field |
Fields | |
---|---|
installGpuDrivers |
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 instanceTemplate on their behalf. Default is false. |
Union field
|
|
policy |
InstancePolicy. |
instanceTemplate |
Name of an instance template used to create VMs. Named the field as 'instanceTemplate' instead of 'template' to avoid c++ keyword conflict. |
InstancePolicy
InstancePolicy describes an instance type and resources attached to each VM created by this InstancePolicy.
JSON representation |
---|
{ "machineType": string, "minCpuPlatform": string, "provisioningModel": enum ( |
Fields | |
---|---|
machineType |
The Compute Engine machine type. |
minCpuPlatform |
The minimum CPU platform. See https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform. |
provisioningModel |
The provisioning model. |
accelerators[] |
The accelerators attached to each VM instance. |
bootDisk |
Boot disk to be created and attached to each VM by this InstancePolicy. Boot disk will be deleted when the VM is deleted. Batch API now only supports booting from image. |
disks[] |
Non-boot disks to be attached for each VM created by this InstancePolicy. New disks will be deleted when the VM is deleted. |
ProvisioningModel
Compute Engine VM instance provisioning model.
Enums | |
---|---|
PROVISIONING_MODEL_UNSPECIFIED |
Unspecified. |
STANDARD |
Standard VM. |
SPOT |
SPOT VM. |
PREEMPTIBLE |
Preemptible VM (PVM). Above SPOT VM is the preferable model for preemptible VM instances: the old preemptible VM model (indicated by this field) is the older model, and has been migrated to use the SPOT model as the underlying technology. This old model will still be supported. |
Accelerator
Accelerator describes Compute Engine accelerators to be attached to the VM.
JSON representation |
---|
{ "type": string, "count": string, "installGpuDrivers": boolean } |
Fields | |
---|---|
type |
The accelerator type. For example, "nvidia-tesla-t4". See |
count |
The number of accelerators of this type. |
installGpuDrivers |
Deprecated: please use instances[0].install_gpu_drivers instead. |
Disk
A new persistent disk or a local ssd. A VM can only have one local SSD setting but multiple local SSD partitions. See https://cloud.google.com/compute/docs/disks#pdspecs and https://cloud.google.com/compute/docs/disks#localssds.
JSON representation |
---|
{ "type": string, "sizeGb": string, "diskInterface": string, // Union field |
Fields | |
---|---|
type |
Disk type as shown in |
sizeGb |
Disk size in GB. For persistent disk, this field is ignored if |
diskInterface |
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. |
Union field data_source . A data source from which a PD will be created. data_source can be only one of the following: |
|
image |
Name of a public or custom image used as the data source. For example, the following are all valid URLs:
You can also use Batch customized image in short names. The following image values are supported for a boot disk:
|
snapshot |
Name of a snapshot used as the data source. Snapshot is not supported as boot disk now. |
AttachedDisk
A new or an existing persistent disk (PD) or a local ssd attached to a VM instance.
JSON representation |
---|
{ "deviceName": string, // Union field |
Fields | |
---|---|
deviceName |
Device name that the guest operating system will see. It is used by Runnable.volumes field to mount disks. So please specify the deviceName if you want Batch to help mount the disk, and it should match the deviceName field in volumes. |
Union field
|
|
newDisk |
|
existingDisk |
Name of an existing PD. |
ServiceAccount
Carries information about a Google Cloud service account.
JSON representation |
---|
{ "email": string, "scopes": [ string ] } |
Fields | |
---|---|
email |
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. |
scopes[] |
List of scopes to be enabled for this service account on the VM, in addition to the cloud-platform API scope that will be added by default. |
NetworkPolicy
NetworkPolicy describes VM instance network configurations.
JSON representation |
---|
{
"networkInterfaces": [
{
object ( |
Fields | |
---|---|
networkInterfaces[] |
Network configurations. |
NetworkInterface
A network interface.
JSON representation |
---|
{ "network": string, "subnetwork": string, "noExternalIpAddress": boolean } |
Fields | |
---|---|
network |
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:
|
subnetwork |
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:
|
noExternalIpAddress |
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. |
PlacementPolicy
PlacementPolicy describes a group placement policy for the VMs controlled by this AllocationPolicy.
JSON representation |
---|
{ "collocation": string, "maxDistance": string } |
Fields | |
---|---|
collocation |
UNSPECIFIED vs. COLLOCATED (default UNSPECIFIED). Use COLLOCATED when you want VMs to be located close to each other for low network latency between the VMs. No placement policy will be generated when collocation is UNSPECIFIED. |
maxDistance |
When specified, causes the job to fail if more than maxDistance logical switches are required between VMs. Batch uses the most compact possible placement of VMs even when maxDistance is not specified. An explicit maxDistance makes that level of compactness a strict requirement. Not yet implemented |
JobStatus
Job status.
JSON representation |
---|
{ "state": enum ( |
Fields | |
---|---|
state |
Job state |
statusEvents[] |
Job status events |
taskGroups |
Aggregated task status for each TaskGroup in the Job. The map key is TaskGroup ID. An object containing a list of |
runDuration |
The duration of time that the Job spent in status RUNNING. A duration in seconds with up to nine fractional digits, ending with ' |
State
Valid Job states.
Enums | |
---|---|
STATE_UNSPECIFIED |
|
QUEUED |
Job is admitted (validated and persisted) and waiting for resources. |
SCHEDULED |
Job is scheduled to run as soon as resource allocation is ready. The resource allocation may happen at a later time but with a high chance to succeed. |
RUNNING |
Resource allocation has been successful. At least one Task in the Job is RUNNING. |
SUCCEEDED |
All Tasks in the Job have finished successfully. |
FAILED |
At least one Task in the Job has failed. |
DELETION_IN_PROGRESS |
The Job will be deleted, but has not been deleted yet. Typically this is because resources used by the Job are still being cleaned up. |
TaskGroupStatus
Aggregated task status for a TaskGroup.
JSON representation |
---|
{
"counts": {
string: string,
...
},
"instances": [
{
object ( |
Fields | |
---|---|
counts |
Count of task in each state in the TaskGroup. The map key is task state name. An object containing a list of |
instances[] |
Status of instances allocated for the TaskGroup. |
InstanceStatus
VM instance status.
JSON representation |
---|
{ "machineType": string, "provisioningModel": enum ( |
Fields | |
---|---|
machineType |
The Compute Engine machine type. |
provisioningModel |
The VM instance provisioning model. |
taskPack |
The max number of tasks can be assigned to this instance type. |
bootDisk |
The VM boot disk. |
LogsPolicy
LogsPolicy describes how outputs from a Job's Tasks (stdout/stderr) will be preserved.
JSON representation |
---|
{
"destination": enum ( |
Fields | |
---|---|
destination |
Where logs should be saved. |
logsPath |
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. |
Destination
The destination (if any) for logs.
Enums | |
---|---|
DESTINATION_UNSPECIFIED |
Logs are not preserved. |
CLOUD_LOGGING |
Logs are streamed to Cloud Logging. |
PATH |
Logs are saved to a file path. |
JobNotification
Notification configurations.
JSON representation |
---|
{
"pubsubTopic": string,
"message": {
object ( |
Fields | |
---|---|
pubsubTopic |
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: |
message |
The attribute requirements of messages to be sent to this Pub/Sub topic. Without this field, no message will be sent. |
Message
Message details. Describe the attribute that a message should have. Without specified message attributes, no message will be sent by default.
JSON representation |
---|
{ "type": enum ( |
Fields | |
---|---|
type |
The message type. |
newJobState |
The new job state. |
newTaskState |
The new task state. |
Type
The message type.
Enums | |
---|---|
TYPE_UNSPECIFIED |
Unspecified. |
JOB_STATE_CHANGED |
Notify users that the job state has changed. |
TASK_STATE_CHANGED |
Notify users that the task state has changed. |
Methods |
|
---|---|
|
Create a Job. |
|
Delete a Job. |
|
Get a Job specified by its resource name. |
|
List all Jobs for a project within a region. |