- Resource: Job
- TaskGroup
- TaskSpec
- Runnable
- Container
- Script
- Barrier
- Environment
- KMSEnvMap
- ComputeResource
- LifecyclePolicy
- Action
- ActionCondition
- Volume
- NFS
- PD
- GCS
- SchedulingPolicy
- AllocationPolicy
- LocationPolicy
- InstancePolicy
- ProvisioningModel
- Accelerator
- Disk
- AttachedDisk
- InstancePolicyOrTemplate
- ServiceAccount
- NetworkPolicy
- NetworkInterface
- PlacementPolicy
- SchedulingPolicy
- JobDependency
- Type
- JobStatus
- State
- TaskGroupStatus
- InstanceStatus
- ResourceUsage
- JobNotification
- Message
- Type
- LogsPolicy
- Destination
- CloudLoggingOption
- 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 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. |
schedulingPolicy |
Scheduling policy for TaskGroups in the job. |
dependencies[] |
At least one of the dependencies must be satisfied before the Job is scheduled to run. Only one JobDependency is supported now. Not yet implemented. |
allocationPolicy |
Compute resource allocation for all TaskGroups in the Job. |
labels |
Custom labels to apply to the job and any Cloud Logging LogEntry that it generates. Use labels to group and describe the resources they are applied to. Batch automatically applies predefined labels and supports multiple An object containing a list of |
status |
Output only. Job status. It is read only for users. |
notification |
Deprecated: please use notifications instead. |
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, parallel tasks per job limit). See: Job Limits. 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. |
allocationPolicy |
Compute resource allocation for the TaskGroup. If specified, it overrides resources in Job. |
labels |
Labels for the TaskGroup. 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 |
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. The host file supports up to 1000 VMs. |
permissiveSsh |
When true, Batch will configure SSH to allow passwordless login between VMs running the Batch tasks in the same TaskGroup. |
runAsNonRoot |
Optional. If not set or set to false, Batch uses the root user to execute runnables. If set to true, Batch runs the runnables using a non-root user. Currently, the non-root user Batch used is generated by OS Login. For more information, see About OS Login. |
serviceAccount |
Optional. ServiceAccount used by tasks within the task group for the access to other Cloud resources. This allows tasks to operate with permissions distinct from the service account for the VM set at Specify the service account's |
TaskSpec
Spec of a task
JSON representation |
---|
{ "runnables": [ { object ( |
Fields | |
---|---|
runnables[] |
Required. The sequence of one or more runnables (executable scripts, executable containers, and/or barriers) for each task in this task group to run. Each task runs this list of runnables in order. For a task to succeed, all of its script and container runnables each must meet at least one of the following conditions:
|
computeResource |
ComputeResource requirements. |
maxRunDuration |
Maximum duration the task should run before being automatically retried (if enabled) or automatically failed. Format the value of this field as a time limit in seconds followed by 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 |
---|
{ "displayName": string, "ignoreExitStatus": boolean, "background": boolean, "alwaysRun": boolean, "environment": { object ( |
Fields | |
---|---|
displayName |
Optional. DisplayName is an optional field that can be provided by the caller. If provided, it will be used in logs and other outputs to identify the script, making it easier for users to understand the logs. If not provided the index of the runnable will be used for outputs. |
ignoreExitStatus |
Normally, a runnable that returns a non-zero exit status fails and causes the task to fail. However, you can set this field to |
background |
Normally, a runnable that doesn't exit causes its task to fail. However, you can set this field to Specifically, 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. |
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 . Required. The script, container, or barrier for this runnable to execute. 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, "enableImageStreaming": boolean } |
Fields | |
---|---|
imageUri |
Required. The URI to pull the container image from. |
commands[] |
Required for some container images. Overrides the |
entrypoint |
Required for some container images. Overrides the |
volumes[] |
Volumes to mount (bind mount) from the host machine files or directories into the container, formatted to match If the |
options |
Required for some container images. Arbitrary additional options to include in the |
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 |
Required if the container image is from a private Docker registry. The username to login to the Docker registry that contains the image. You can either specify the username directly by using plain text or specify an encrypted username by using a Secret Manager secret: Caution: If you specify the username using plain text, you risk the username being exposed to any users who can view the job or its logs. To avoid this risk, specify a secret that contains the username instead. Learn more about Secret Manager and using Secret Manager with Batch. |
password |
Required if the container image is from a private Docker registry. The password to login to the Docker registry that contains the image. For security, it is strongly recommended to specify an encrypted password by using a Secret Manager secret: Warning: If you specify the password using plain text, you risk the password being exposed to any users who can view the job or its logs. To avoid this risk, specify a secret that contains the password instead. Learn more about Secret Manager and using Secret Manager with Batch. |
enableImageStreaming |
Optional. If set to true, this container runnable uses Image streaming. Use Image streaming to allow the runnable to initialize without waiting for the entire container image to download, which can significantly reduce startup time for large container images. When For more information about the requirements and limitations for using Image streaming with Batch, see the |
Script
Script runnable.
JSON representation |
---|
{ // Union field |
Fields | |
---|---|
Union field command . Required. The source code for this script runnable. command can be only one of the following: |
|
path |
The path to a script file that is accessible from the host VM(s). Unless the script file supports the default |
text |
The text for a script. Unless the script text supports the default |
Barrier
A barrier runnable automatically blocks the execution of subsequent runnables until all the tasks in the task group reach the barrier.
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.
ComputeResource defines the amount of resources required for each task. Make sure your tasks have enough resources to successfully run. If you also define the types of resources for a job to use with the InstancePolicyOrTemplate field, make sure both fields are compatible with each other.
JSON representation |
---|
{ "cpuMilli": string, "memoryMib": string, "gpuCount": string, "bootDiskMib": string } |
Fields | |
---|---|
cpuMilli |
The milliCPU count.
If you also define the VM's machine type using the For example, if you specify the |
memoryMib |
Memory in MiB.
For example, if you specify the |
gpuCount |
The GPU count. Not yet implemented. |
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[] |
Mount options vary based on the type of storage volume:
|
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. |
pd |
Deprecated: please use deviceName instead. |
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". |
PD
Deprecated: please use deviceName instead.
JSON representation |
---|
{ "disk": string, "device": string, "existing": boolean } |
Fields | |
---|---|
disk |
PD disk name, e.g. pd-1. |
device |
PD device name, e.g. persistent-disk-1. |
existing |
Whether this is an existing PD. Default is false. If false, i.e., new PD, we will format it into ext4 and mount to the given path. If true, i.e., existing PD, it should be in ext4 format and we will mount it to the given path. |
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. |
instance |
Deprecated: please use instances[0].policy instead. |
instances[] |
Describe instances that can be created by this AllocationPolicy. Only instances[0] is supported now. |
instanceTemplates[] |
Deprecated: please use instances[0].template instead. |
provisioningModels[] |
Deprecated: please use instances[0].policy.provisioning_model instead. |
serviceAccountEmail |
Deprecated: please use serviceAccount instead. |
serviceAccount |
Defines the service account for Batch-created VMs. If omitted, the default Compute Engine service account is used. Must match the service account specified in any used instance template configured in the Batch job. Includes the following fields: * email: The service account's email address. If not set, the default Compute Engine service account is used. * scopes: Additional OAuth scopes to grant the service account, beyond the default cloud-platform scope. (list of strings) |
labels |
Custom labels to apply to the job and all the Compute Engine resources that both are created by this allocation policy and support labels. Use labels to group and describe the resources they are applied to. Batch automatically applies predefined labels and supports multiple An object containing a list of |
network |
The network policy. If you define an instance template in the |
placement |
The placement policy. |
tags[] |
Optional. Tags applied to the VM instances. The tags identify valid sources or targets for network firewalls. Each tag must be 1-63 characters long, and comply with RFC1035. |
LocationPolicy
JSON representation |
---|
{ "allowedLocations": [ string ], "deniedLocations": [ 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. Mixing locations from different regions would cause errors. For example, ["regions/us-central1", "zones/us-central1-a", "zones/us-central1-b", "zones/us-west1-a"] contains locations from two distinct regions: us-central1 and us-west1. This combination will trigger an error. |
deniedLocations[] |
A list of denied location names. Not yet implemented. |
InstancePolicy
InstancePolicy describes an instance type and resources attached to each VM created by this InstancePolicy.
JSON representation |
---|
{ "allowedMachineTypes": [ string ], "machineType": string, "minCpuPlatform": string, "provisioningModel": enum ( |
Fields | |
---|---|
allowedMachineTypes[] |
Deprecated: please use machineType instead. |
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. A non-boot disk is a disk that can be of a device with a file system or a raw storage drive that is not ready for data storage and accessing. |
reservation |
Optional. If not specified (default), VMs will consume any applicable reservation. If "NO_RESERVATION" is specified, VMs will not consume any reservation. Otherwise, if specified, VMs will consume only the specified reservation. |
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, "driverVersion": string } |
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. |
driverVersion |
Optional. The NVIDIA GPU driver version that should be installed for this type. You can define the specific driver version such as "470.103.01", following the driver version requirements in https://cloud.google.com/compute/docs/gpus/install-drivers-gpu#minimum-driver. Batch will install the specific accelerator driver if qualified. |
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. Non-Boot Disk: If the Boot Disk: Batch will calculate the boot disk size based on source image and task requirements if you do not speicify the size. If both this field and the |
diskInterface |
Local SSDs are available through both "SCSI" and "NVMe" interfaces. If not indicated, "NVMe" will be the default one for local ssds. This field is ignored for persistent disks as the interface is chosen automatically. See https://cloud.google.com/compute/docs/disks/persistent-disks#choose_an_interface. |
Union field data_source . A data source from which a PD will be created. data_source can be only one of the following: |
|
image |
URL for a VM image to use as the data source for this disk. 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. |
InstancePolicyOrTemplate
InstancePolicyOrTemplate lets you define the type of resources to use for this job either with an InstancePolicy or an instance template. If undefined, Batch picks the type of VM to use and doesn't include optional VM resources such as GPUs and extra disks.
JSON representation |
---|
{ "installGpuDrivers": boolean, "installOpsAgent": boolean, "blockProjectSshKeys": boolean, // Union field |
Fields | |
---|---|
installGpuDrivers |
Set this field true if you want Batch to help fetch drivers from a third party location and install them for GPUs specified in For Container-Optimized Image cases, Batch will install the accelerator driver following milestones of https://cloud.google.com/container-optimized-os/docs/release-notes. For non Container-Optimized Image cases, following https://github.com/GoogleCloudPlatform/compute-gpu-installation/blob/main/linux/install_gpu_driver.py. |
installOpsAgent |
Optional. Set this field true if you want Batch to install Ops Agent on your behalf. Default is false. |
blockProjectSshKeys |
Optional. Set this field to Batch allows project-level SSH keys for a job's VMs only if all the following are true:
Notably, you can override this behavior by manually updating a VM to block or allow project-level SSH keys. For more information about blocking project-level SSH keys, see the Compute Engine documentation: https://cloud.google.com/compute/docs/connect/restrict-ssh-keys#block-keys |
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. Batch only supports global instance templates. You can specify the global instance template as a full or partial URL. |
ServiceAccount
Carries information about a Google Cloud service account.
JSON representation |
---|
{ "email": string, "scopes": [ string ] } |
Fields | |
---|---|
email |
Email address of the service account. |
scopes[] |
List of scopes to be enabled for this service account. |
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 |
SchedulingPolicy
The order that TaskGroups are scheduled relative to each other.
Not yet implemented.
Enums | |
---|---|
SCHEDULING_POLICY_UNSPECIFIED |
Unspecified. |
AS_SOON_AS_POSSIBLE |
Run all TaskGroups as soon as possible. |
JobDependency
JobDependency describes the state of other Jobs that the start of this Job depends on. All dependent Jobs must have been submitted in the same region.
JSON representation |
---|
{
"items": {
string: enum ( |
Fields | |
---|---|
items |
Each item maps a Job name to a Type. All items must be satisfied for the JobDependency to be satisfied (the AND operation). Once a condition for one item becomes true, it won't go back to false even the dependent Job state changes again. An object containing a list of |
Type
Dependency type.
Enums | |
---|---|
TYPE_UNSPECIFIED |
Unspecified. |
SUCCEEDED |
The dependent Job has succeeded. |
FAILED |
The dependent Job has failed. |
FINISHED |
SUCCEEDED or FAILED. |
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 ' |
resourceUsage |
The resource usage of the job. |
State
Valid Job states.
Enums | |
---|---|
STATE_UNSPECIFIED |
Job 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. |
CANCELLATION_IN_PROGRESS |
The Job cancellation is in progress, this is because the resources used by the Job are still being cleaned up. |
CANCELLED |
The Job has been cancelled, the task executions were stopped and the resources were 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. |
ResourceUsage
ResourceUsage describes the resource usage of the job.
JSON representation |
---|
{ "coreHours": number } |
Fields | |
---|---|
coreHours |
The CPU core hours that the job consumes. |
JobNotification
Notification configurations.
JSON representation |
---|
{
"pubsubTopic": string,
"message": {
object ( |
Fields | |
---|---|
pubsubTopic |
The Pub/Sub topic where notifications for the job, like state changes, will be published. If undefined, no Pub/Sub notifications are sent for this job. Specify the topic using the following format: For more information about configuring Pub/Sub notifications for a job, see https://cloud.google.com/batch/docs/enable-notifications. |
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 conditions under which messages will be sent. If no attribute is defined, no message will be sent by default. One message should specify either the job or the task level attributes, but not both. For example, job level: JOB_STATE_CHANGED and/or a specified newJobState; task level: TASK_STATE_CHANGED and/or a specified newTaskState.
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. |
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. |
cloudLoggingOption |
Optional. Additional settings for Cloud Logging. It will only take effect when the destination of |
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. |
CloudLoggingOption
CloudLoggingOption
contains additional settings for Cloud Logging logs generated by Batch job.
JSON representation |
---|
{ "useGenericTaskMonitoredResource": boolean } |
Fields | |
---|---|
useGenericTaskMonitoredResource |
Optional. Set this flag to true to change the monitored resource type for Cloud Logging logs generated by this Batch job from the |
Methods |
|
---|---|
|
Cancel a Job. |
|
Create a Job. |
|
Delete a Job. |
|
Get a Job specified by its resource name. |
|
List all Jobs for a project within a region. |
|
Update a Job. |