Package google.cloud.batch.v1alpha

Stay organized with collections Save and categorize content based on your preferences.

Index

BatchService

Google Batch Service. The service manages user submitted batch jobs and allocates Google Compute Engine VM instances to run the jobs.

CreateJob

rpc CreateJob(CreateJobRequest) returns (Job)

Create a Job.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

DeleteJob

rpc DeleteJob(DeleteJobRequest) returns (Operation)

Delete a Job.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

GetJob

rpc GetJob(GetJobRequest) returns (Job)

Get a Job specified by its resource name.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

GetTask

rpc GetTask(GetTaskRequest) returns (Task)

Return a single Task.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

ListJobs

rpc ListJobs(ListJobsRequest) returns (ListJobsResponse)

List all Jobs for a project within a region.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

ListTasks

rpc ListTasks(ListTasksRequest) returns (ListTasksResponse)

List Tasks associated with a job.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

AllocationPolicy

A Job's resource allocation policy describes when, where, and how compute resources should be allocated for the Job.

Fields
location

LocationPolicy

Location where compute resources should be allocated for the Job.

instance
(deprecated)

InstancePolicy

Deprecated: please use instances[0].policy instead.

instances[]

InstancePolicyOrTemplate

Describe instances that can be created by this AllocationPolicy. Only instances[0] is supported now.

instance_templates[]
(deprecated)

string

Deprecated: please use instances[0].template instead.

provisioning_models[]
(deprecated)

ProvisioningModel

Deprecated: please use instances[i].policy.provisioning_model instead.

service_account_email
(deprecated)

string

Deprecated: please use service_account instead.

service_account

ServiceAccount

Service account that VMs will run as.

labels

map<string, string>

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.

network

NetworkPolicy

The network policy.

Accelerator

Accelerator describes Compute Engine accelerators to be attached to VMs.

Fields
type

string

The accelerator type. For example, "nvidia-tesla-t4". See gcloud compute accelerator-types list.

count

int64

The number of accelerators of this type.

install_gpu_drivers
(deprecated)

bool

Deprecated: please use instances[0].install_gpu_drivers instead.

AttachedDisk

A new or an existing persistent disk or a local ssd attached to a VM instance.

Fields
device_name

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.

Union field attached.

attached can be only one of the following:

new_disk

Disk

existing_disk

string

Name of an existing PD.

Disk

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.

Fields
type

string

Disk type as shown in gcloud compute disk-types list For example, "pd-ssd", "pd-standard", "pd-balanced", "local-ssd".

size_gb

int64

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.

disk_interface

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.

Union field data_source. A data source from which a PD will be created. data_source can be only one of the following:
image

string

Name of a public or custom image used as the data source.

snapshot

string

Name of a snapshot used as the data source.

InstancePolicy

InstancePolicy describes an instance type and resources attached to each VM created by this InstancePolicy.

Fields
allowed_machine_types[]
(deprecated)

string

Deprecated: please use machine_type instead.

machine_type

string

The Compute Engine machine type.

min_cpu_platform

string

The minimum CPU platform. See https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform. Not yet implemented.

provisioning_model

ProvisioningModel

The provisioning model.

accelerators[]

Accelerator

The accelerators attached to each VM instance. Not yet implemented.

disks[]

AttachedDisk

Non-boot disks to be attached for each VM created by this InstancePolicy. New disks will be deleted when the attached VM is deleted.

InstancePolicyOrTemplate

Either an InstancePolicy or an instance template.

Fields
install_gpu_drivers

bool

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.

Union field policy_template.

policy_template can be only one of the following:

policy

InstancePolicy

InstancePolicy.

instance_template

string

Name of an instance template used to create VMs. Named the field as 'instance_template' instead of 'template' to avoid c++ keyword conflict.

LocationPolicy

Fields
allowed_locations[]

string

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.

denied_locations[]

string

A list of denied location names.

Not yet implemented.

NetworkInterface

A network interface.

Fields
network

string

The URL of the network resource.

subnetwork

string

The URL of the Subnetwork resource.

no_external_ip_address

bool

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.

NetworkPolicy

NetworkPolicy describes VM instance network configurations.

Fields
network_interfaces[]

NetworkInterface

Network configurations.

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.

ComputeResource

Compute resource requirements

Fields
cpu_milli

int64

The milliCPU count.

memory_mib

int64

Memory in MiB.

gpu_count

int64

The GPU count.

Not yet implemented.

boot_disk_mib

int64

Extra boot disk size in MiB for each task.

CreateJobRequest

CreateJob Request.

Fields
parent

string

Required. The parent resource name where the Job will be created. Pattern: "projects/{project}/locations/{location}"

job_id

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}".

job

Job

Required. The Job to create.

request_id

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).

DeleteJobRequest

DeleteJob Request.

Fields
name

string

Job name.

reason

string

Optional. Reason for this deletion.

request_id

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).

Environment

An Environment describes a collection of environment variables to set when executing Tasks.

Fields
variables

map<string, string>

A map of environment variable names to values.

secret_variables

map<string, string>

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.

encrypted_variables

KMSEnvMap

An encrypted JSON dictionary where the key/value pairs correspond to environment variable names and their values.

KMSEnvMap

Fields
key_name

string

The name of the KMS key that will be used to decrypt the cipher text.

cipher_text

string

The value of the cipherText response from the encrypt method.

GCS

Represents a Google Cloud Storage volume source config.

Fields
remote_path

string

Remote path, either a bucket name or a subdirectory of a bucket, e.g.: bucket_name, bucket_name/subdirectory/

GetJobRequest

GetJob Request.

Fields
name

string

Required. Job name.

GetTaskRequest

Request for a single Task by name.

Fields
name

string

Required. Task name.

Job

The Cloud Batch Job description.

Fields
name

string

Output only. Job name. For example: "projects/123456/locations/us-central1/jobs/job01".

uid

string

Output only. A system generated unique ID (in UUID4 format) for the Job.

priority

int64

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.

task_groups[]

TaskGroup

Required. TaskGroups in the Job. Only one TaskGroup is supported now.

scheduling_policy

SchedulingPolicy

Scheduling policy for TaskGroups in the job.

dependencies[]

JobDependency

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.

allocation_policy

AllocationPolicy

Compute resource allocation for all TaskGroups in the Job.

labels

map<string, string>

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.

status

JobStatus

Output only. Job status. It is read only for users.

notification
(deprecated)

JobNotification

Deprecated: please use notifications instead.

create_time

Timestamp

Output only. When the Job was created.

update_time

Timestamp

Output only. The last time the Job was updated.

logs_policy

LogsPolicy

Log preservation policy for the Job.

notifications[]

JobNotification

Notification configurations.

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.

Fields
items

map<string, Type>

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.

Type

Dependency type.

Enums
TYPE_UNSPECIFIED Unspecified.
SUCCEEDED The dependent Job has succeeded.
FAILED The dependent Job has failed.
FINISHED SUCCEEDED or FAILED.

JobNotification

Notification configurations.

Fields
pubsub_topic

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}.

message

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.

Fields
type

Type

The message type.

new_job_state

State

The new job state.

new_task_state

State

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.

JobStatus

Job status.

Fields
state

State

Job state

status_events[]

StatusEvent

Job status events

task_groups

map<string, TaskGroupStatus>

Aggregated task status for each TaskGroup in the Job. The map key is TaskGroup ID.

run_duration

Duration

The duration of time that the Job spent in status RUNNING.

InstanceStatus

VM instance status.

Fields
machine_type

string

The Compute Engine machine type.

provisioning_model

ProvisioningModel

The VM instance provisioning model.

task_pack

int64

The max number of tasks can be assigned to this instance type.

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.

Fields
counts

map<string, int64>

Count of task in each state in the TaskGroup. The map key is task state name.

instances[]

InstanceStatus

Status of instances allocated for the TaskGroup.

LifecyclePolicy

LifecyclePolicy describes how to deal with task failures based on different conditions.

Fields
action

Action

Action to execute when ActionCondition is true.

action_condition

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.

Fields
exit_codes[]

int32

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.

ListJobsRequest

ListJob Request.

Fields
parent

string

Parent path.

filter

string

List filter.

page_size

int32

Page size.

page_token

string

Page token.

ListJobsResponse

ListJob Response.

Fields
jobs[]

Job

Jobs.

next_page_token

string

Next page token.

unreachable[]

string

Locations that could not be reached.

ListTasksRequest

ListTasks Request.

Fields
parent

string

Required. Name of a TaskGroup from which Tasks are being requested. Pattern: "projects/{project}/locations/{location}/jobs/{job}/taskGroups/{task_group}"

filter

string

Task filter, null filter matches all Tasks. Filter string should be of the format State=TaskStatus.State e.g. State=RUNNING

page_size

int32

Page size.

page_token

string

Page token.

ListTasksResponse

ListTasks Response.

Fields
tasks[]

Task

Tasks.

next_page_token

string

Next page token.

unreachable[]

string

Locations that could not be reached.

LogsPolicy

LogsPolicy describes how outputs from a Job's Tasks (stdout/stderr) will be preserved.

Fields
destination

Destination

Where logs should be saved.

logs_path

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.

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.

NFS

Represents an NFS server and remote path: :

Fields
server

string

URI of the NFS server, e.g. an IP address.

remote_path

string

Remote source path exported from NFS, e.g., "/share".

OperationMetadata

Represents the metadata of the long-running operation.

Fields
create_time

Timestamp

Output only. The time the operation was created.

end_time

Timestamp

Output only. The time the operation finished running.

target

string

Output only. Server-defined resource path for the target of the operation.

verb

string

Output only. Name of the verb executed by the operation.

status_message

string

Output only. Human-readable status of the operation, if any.

requested_cancellation

bool

Output only. Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have [Operation.error][] value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

api_version

string

Output only. API version used to start the operation.

PD

Represents a GCP persistent disk

Fields
disk

string

PD disk name, e.g. pd-1.

device

string

PD device name, e.g. persistent-disk-1.

existing
(deprecated)

bool

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.

Runnable

Runnable describes instructions for executing a specific script or container as part of a Task.

Fields
ignore_exit_status

bool

Normally, a non-zero exit status causes the Task to fail. This flag allows execution of other Runnables to continue instead.

background

bool

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).

always_run

bool

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.

environment

Environment

Environment variables for this Runnable (overrides variables set for the whole Task or TaskGroup).

timeout

Duration

Timeout for this Runnable.

labels

map<string, string>

Labels for this Runnable.

Union field executable. The script or container to run. executable can be only one of the following:
container

Container

Container runnable.

script

Script

Script runnable.

barrier

Barrier

Barrier runnable.

Barrier

Barrier runnable blocks until all tasks in a taskgroup reach it.

Fields
name

string

Barriers are identified by their index in runnable list. Names are not required, but if present should be an identifier.

Container

Container runnable.

Fields
image_uri

string

The URI to pull the container image from.

commands[]

string

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.

entrypoint

string

Overrides the ENTRYPOINT specified in the container.

volumes[]

string

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

string

Arbitrary additional options to include in the "docker run" command when running this container, e.g. "--network host".

block_external_network

bool

If set to true, external network access to and from container will be blocked. The container will use the default internal network 'goog-internal'.

username

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.

password

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;

Script

Script runnable.

Fields

Union field command.

command can be only one of the following:

path

string

Script file path on the host VM.

text

string

Shell script text.

ServiceAccount

Carries information about a Google Cloud service account.

Fields
email

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.

scopes[]
(deprecated)

string

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.

StatusEvent

Status event

Fields
type

string

Type of the event.

description

string

Description of the event.

event_time

Timestamp

The time this event occurred.

task_execution

TaskExecution

Task Execution

Task

A Cloud Batch task.

Fields
name

string

Task name. The name is generated from the parent TaskGroup name and 'id' field. For example: "projects/123456/locations/us-west1/jobs/job01/taskGroups/group01/tasks/task01".

status

TaskStatus

Task Status.

TaskExecution

This Task Execution field includes detail information for task execution procedures, based on StatusEvent types.

Fields
exit_code

int32

When task is completed as the status of FAILED or SUCCEEDED, exit code is for one task execution result, default is 0 as success.

TaskGroup

A TaskGroup contains one or multiple Tasks that share the same Runnable but with different runtime parameters.

Fields
name

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".

task_spec

TaskSpec

Required. Tasks in the group share the same task spec.

task_count

int64

Number of Tasks in the TaskGroup. default is 1

parallelism

int64

Max number of tasks that can run in parallel. Default to min(task_count, 1000).

scheduling_policy

SchedulingPolicy

Scheduling policy for Tasks in the TaskGroup.

allocation_policy

AllocationPolicy

Compute resource allocation for the TaskGroup. If specified, it overrides resources in Job.

labels

map<string, string>

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.

task_environments[]

Environment

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.

task_count_per_node

int64

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.

require_hosts_file

bool

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.

permissive_ssh

bool

When true, Batch will configure SSH to allow passwordless login between VMs running the Batch tasks in the same TaskGroup.

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.

TaskSpec

Spec of a task

Fields
runnables[]

Runnable

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.

compute_resource

ComputeResource

ComputeResource requirements.

max_run_duration

Duration

Maximum duration the task should run. The task will be killed and marked as FAILED if over this limit.

max_retry_count

int32

Maximum number of retries on failures. The default, 0, which means never retry. The valid value range is [0, 10].

lifecycle_policies[]

LifecyclePolicy

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.

environments
(deprecated)

map<string, string>

Environment variables to set before running the Task. You can set up to 100 environments.

volumes[]

Volume

Volumes to mount before running Tasks using this TaskSpec.

environment

Environment

Environment variables to set before running the Task.

TaskStatus

Status of a task

Fields
state

State

Task state

status_events[]

StatusEvent

Detailed info about why the state is reached.

State

Task states.

Enums
STATE_UNSPECIFIED unknown state
PENDING The Task is created and waiting for resources.
ASSIGNED The Task is assigned to at least one VM.
RUNNING The Task is running.
FAILED The Task has failed.
SUCCEEDED The Task has succeeded.

Volume

Volume and mount parameters to be associated with a TaskSpec. A TaskSpec might describe zero, one, or multiple volumes to be mounted as part of the task.

Fields
mount_path

string

Mount path for the volume, e.g. /mnt/share

mount_options[]

string

Mount options For Google Cloud Storage, mount options are the global options supported by gcsfuse tool. Batch will use them to mount the volume with the following command: "gcsfuse [global options] bucket mountpoint". For PD, NFS, mount options are these supported by /etc/fstab. Batch will use Fstab to mount such volumes. https://help.ubuntu.com/community/Fstab

Union field source. The source for the volume. source can be only one of the following:
nfs

NFS

An NFS source for the volume (could be a Filestore, for example).

pd
(deprecated)

PD

A persistent disk source for the volume.

gcs

GCS

A Google Cloud Storage source for the volume.

device_name

string

Device name of an attached disk