Types overview

Accelerator

Accelerator describes Compute Engine accelerators to be attached to the VM.

Fields

Fields
`count`	`string (int64 format)` The number of accelerators of this type.
`installGpuDrivers`	`boolean` Deprecated: please use instances[0].install_gpu_drivers instead.
`type`	`string` The accelerator type. For example, "nvidia-tesla-t4". See `gcloud compute accelerator-types list`.

count

string (int64 format)

The number of accelerators of this type.

installGpuDrivers

boolean

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

type

string

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

ActionCondition

Conditions for actions to deal with task failures.

Fields

Fields
`exitCodes[]`	`integer (int32 format)` 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.

exitCodes[]

integer (int32 format)

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.

AgentInfo

VM Agent Info.

Fields
`jobId`	`string` The assigned Job ID
`reportTime`	`string (Timestamp format)` When the AgentInfo is generated.
`state`	`enum` Agent state.
Enum type. Can be one of the following:
`AGENT_STATE_UNSPECIFIED`	Unspecified state.
`AGENT_STARTING`	The agent is starting on the VM instance.
`AGENT_RUNNING`	The agent is running. The agent in the RUNNING state can never go back to the STARTING state.
`AGENT_STOPPED`	The agent has stopped, either on request or due to a failure.

`taskGroupId`	`string` The assigned task group ID.
`tasks[]`	`object (AgentTaskInfo)` Task Info.

AgentMetadata

VM Agent Metadata.

Fields
`creationTime`	`string (Timestamp format)` When the VM agent started. Use agent_startup_time instead.
`creator`	`string` Full name of the entity that created this vm. For MIG, this path is: projects/{project}/regions/{region}/InstanceGroupManagers/{igm} The value is retrieved from the vm metadata key of "created-by".
`imageVersion`	`string` image version for the VM that this agent is installed on.
`instance`	`string` GCP instance name.
`instanceId`	`string (uint64 format)` GCP instance ID.
`instancePreemptionNoticeReceived`	`boolean` If the GCP instance has received preemption notice.
`osRelease`	`map (key: string, value: string)` parsed contents of /etc/os-release
`version`	`string` agent binary version running on VM
`zone`	`string` Agent zone.

AgentTask

Fields
`intendedState`	`enum` The intended state of the task.
Enum type. Can be one of the following:
`INTENDED_STATE_UNSPECIFIED`	Unspecified state.
`ASSIGNED`	Assigned state (includes running and finished).
`CANCELLED`	The agent should cancel the execution of this task.
`DELETED`	Delete task from agent storage, stop reporting its state.

`reachedBarrier`	`string (int64 format)` The highest barrier reached by all tasks in the task's TaskGroup.
`spec`	`object (TaskSpec)` Task Spec.
`status`	`object (TaskStatus)` Task status.
`task`	`string` Task name.
`taskSource`	`enum` TaskSource represents the source of the task.
Enum type. Can be one of the following:
`TASK_SOURCE_UNSPECIFIED`	Unspecified task source.
`BATCH_INTERNAL`	The AgentTask from this source is generated by Batch server. E.g. all the VMActions are from this source. When Batch Agent execute AgentTask from BATCH_INTERNAL, it will log stdout/err with "batch_agent_logs" log name.
`USER`	The AgentTask from this source is provided by Batch users. When Batch Agent execute AgentTask from USER, it will log stdout/err with "batch_task_logs" log name.

AgentTaskInfo

Task Info

Fields

Fields
`runnable`	`string (int64 format)` The highest index of a runnable started by the agent for this task. The runnables are indexed from 1. Value 0 is undefined.
`taskId`	`string` ID of the Task
`taskStatus`	`object (TaskStatus)` The status of the Task. If we need agent specific fields we should fork the public TaskStatus into an agent specific one. Or add them below.

runnable

string (int64 format)

The highest index of a runnable started by the agent for this task. The runnables are indexed from 1. Value 0 is undefined.

taskId

string

ID of the Task

taskStatus

object (TaskStatus)

The status of the Task. If we need agent specific fields we should fork the public TaskStatus into an agent specific one. Or add them below.

AgentTimingInfo

VM timing information

Fields

Fields
`agentStartupTime`	`string (Timestamp format)` Agent startup time
`bootTime`	`string (Timestamp format)` Boot timestamp of the VM OS
`scriptStartupTime`	`string (Timestamp format)` Startup time of the Batch VM script.

agentStartupTime

string (Timestamp format)

Agent startup time

bootTime

string (Timestamp format)

Boot timestamp of the VM OS

scriptStartupTime

string (Timestamp format)

Startup time of the Batch VM script.

AllocationPolicy

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

Fields
`instances[]`	`object (InstancePolicyOrTemplate)` Describe instances that can be created by this AllocationPolicy. Only instances[0] is supported now.
`labels`	`map (key: string, value: 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.
`location`	`object (LocationPolicy)` Location where compute resources should be allocated for the Job.
`network`	`object (NetworkPolicy)` The network policy.
`placement`	`object (PlacementPolicy)` The placement policy.
`serviceAccount`	`object (ServiceAccount)` Service account that VMs will run as.

AttachedDisk

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

Fields

Fields
`deviceName`	`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`	`string` Name of an existing PD.
`newDisk`	`object (Disk)` (No description provided)

deviceName

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

string

Name of an existing PD.

newDisk

object (Disk)

(No description provided)

Barrier

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

Fields

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

name

string

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

ComputeResource

Compute resource requirements

Fields

Fields
`bootDiskMib`	`string (int64 format)` Extra boot disk size in MiB for each task.
`cpuMilli`	`string (int64 format)` The milliCPU count.
`memoryMib`	`string (int64 format)` Memory in MiB.

bootDiskMib

string (int64 format)

Extra boot disk size in MiB for each task.

cpuMilli

string (int64 format)

The milliCPU count.

memoryMib

string (int64 format)

Memory in MiB.

Container

Container runnable.

Fields
`blockExternalNetwork`	`boolean` If set to true, external network access to and from container will be blocked, containers that are with block_external_network as true can still communicate with each other, network cannot be specified in the `container.options` field.
`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.
`imageUri`	`string` The URI to pull the container image from.
`options`	`string` Arbitrary additional options to include in the "docker run" command when running this container, e.g. "--network host".
`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;
`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.
`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

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.

Fields
`diskInterface`	`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`	`string` Name of a public or custom image used as the data source. For example, the following are all valid URLs: * Specify the image by its family name: projects/{project}/global/images/family/{image_family} * Specify the image version: projects/{project}/global/images/{image_version} You can also use Batch customized image in short names. The following image values are supported for a boot disk: * "batch-debian": use Batch Debian images. * "batch-centos": use Batch CentOS images. * "batch-cos": use Batch Container-Optimized images.
`sizeGb`	`string (int64 format)` Disk size in GB. For persistent disk, this field is ignored if `data_source` is `image` or `snapshot`. For local SSD, size_gb should be a multiple of 375GB, otherwise, the final size will be the next greater multiple of 375 GB. For 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 boot_disk_mib field in task spec's compute_resource are defined, Batch will only honor this field.
`snapshot`	`string` Name of a snapshot used as the data source. Snapshot is not supported as boot disk now.
`type`	`string` Disk type as shown in `gcloud compute disk-types list`. For example, local SSD uses type "local-ssd". Persistent disks and boot disks use "pd-balanced", "pd-extreme", "pd-ssd" or "pd-standard".

Environment

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

Fields

Fields
`encryptedVariables`	`object (KMSEnvMap)` An encrypted JSON dictionary where the key/value pairs correspond to environment variable names and their values.
`secretVariables`	`map (key: string, value: 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.
`variables`	`map (key: string, value: string)` A map of environment variable names to values.

encryptedVariables

object (KMSEnvMap)

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

secretVariables

map (key: string, value: 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.

variables

map (key: string, value: string)

A map of environment variable names to values.

GCS

Represents a Google Cloud Storage volume.

Fields

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

remotePath

string

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

InstancePolicy

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

Fields
`accelerators[]`	`object (Accelerator)` The accelerators attached to each VM instance.
`bootDisk`	`object (Disk)` 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[]`	`object (AttachedDisk)` Non-boot disks to be attached for each VM created by this InstancePolicy. New disks will be deleted when the VM is deleted.
`machineType`	`string` The Compute Engine machine type.
`minCpuPlatform`	`string` The minimum CPU platform. See https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform. Not yet implemented.
`provisioningModel`	`enum` The provisioning model.
Enum type. Can be one of the following:
`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.

InstancePolicyOrTemplate

Either an InstancePolicy or an instance template.

Fields

Fields
`installGpuDrivers`	`boolean` 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`	`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`	`object (InstancePolicy)` InstancePolicy.

installGpuDrivers

boolean

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

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

object (InstancePolicy)

InstancePolicy.

InstanceStatus

VM instance status.

Fields
`bootDisk`	`object (Disk)` The VM boot disk.
`machineType`	`string` The Compute Engine machine type.
`provisioningModel`	`enum` The VM instance provisioning model.
Enum type. Can be one of the following:
`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.

`taskPack`	`string (int64 format)` The max number of tasks can be assigned to this instance type.

Job

The Cloud Batch Job description.

Fields
`allocationPolicy`	`object (AllocationPolicy)` Compute resource allocation for all TaskGroups in the Job.
`createTime`	`string (Timestamp format)` Output only. When the Job was created.
`labels`	`map (key: string, value: 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.
`logsPolicy`	`object (LogsPolicy)` Log preservation policy for the Job.
`name`	`string` Output only. Job name. For example: "projects/123456/locations/us-central1/jobs/job01".
`notifications[]`	`object (JobNotification)` Notification configurations.
`priority`	`string (int64 format)` 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.
`status`	`object (JobStatus)` Output only. Job status. It is read only for users.
`taskGroups[]`	`object (TaskGroup)` Required. TaskGroups in the Job. Only one TaskGroup is supported now.
`uid`	`string` Output only. A system generated unique ID (in UUID4 format) for the Job.
`updateTime`	`string (Timestamp format)` Output only. The last time the Job was updated.

JobNotification

Notification configurations.

Fields

Fields
`message`	`object (Message)` The attribute requirements of messages to be sent to this Pub/Sub topic. Without this field, no message will be sent.
`pubsubTopic`	`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

object (Message)

The attribute requirements of messages to be sent to this Pub/Sub topic. Without this field, no message will be sent.

pubsubTopic

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

JobStatus

Job status.

Fields
`runDuration`	`string (Duration format)` The duration of time that the Job spent in status RUNNING.
`state`	`enum` Job state
Enum type. Can be one of the following:
`STATE_UNSPECIFIED`	(No description provided)
`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.

`statusEvents[]`	`object (StatusEvent)` Job status events
`taskGroups`	`map (key: string, value: object (TaskGroupStatus))` Aggregated task status for each TaskGroup in the Job. The map key is TaskGroup ID.

KMSEnvMap

(No description provided)

Fields

Fields
`cipherText`	`string` The value of the cipherText response from the `encrypt` method.
`keyName`	`string` The name of the KMS key that will be used to decrypt the cipher text.

cipherText

string

The value of the cipherText response from the encrypt method.

keyName

string

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

LifecyclePolicy

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

Fields
`action`	`enum` 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.
Enum type. Can be one of the following:
`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`	`object (ActionCondition)` Conditions that decide why a task failure is dealt with a specific action.

ListJobsResponse

ListJob Response.

Fields

Fields
`jobs[]`	`object (Job)` Jobs.
`nextPageToken`	`string` Next page token.
`unreachable[]`	`string` Locations that could not be reached.

jobs[]

object (Job)

Jobs.

nextPageToken

string

Next page token.

unreachable[]

string

Locations that could not be reached.

ListLocationsResponse

The response message for Locations.ListLocations.

Fields

Fields
`locations[]`	`object (Location)` A list of locations that matches the specified filter in the request.
`nextPageToken`	`string` The standard List next-page token.

locations[]

object (Location)

A list of locations that matches the specified filter in the request.

nextPageToken

string

The standard List next-page token.

ListOperationsResponse

The response message for Operations.ListOperations.

Fields

Fields
`nextPageToken`	`string` The standard List next-page token.
`operations[]`	`object (Operation)` A list of operations that matches the specified filter in the request.

nextPageToken

string

The standard List next-page token.

operations[]

object (Operation)

A list of operations that matches the specified filter in the request.

ListTasksResponse

ListTasks Response.

Fields

Fields
`nextPageToken`	`string` Next page token.
`tasks[]`	`object (Task)` Tasks.
`unreachable[]`	`string` Locations that could not be reached.

nextPageToken

string

Next page token.

tasks[]

object (Task)

Tasks.

unreachable[]

string

Locations that could not be reached.

Location

A resource that represents Google Cloud Platform location.

Fields
`displayName`	`string` The friendly name for this location, typically a nearby city name. For example, "Tokyo".
`labels`	`map (key: string, value: string)` Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"}
`locationId`	`string` The canonical id for this location. For example: `"us-east1"`.
`metadata`	`map (key: string, value: any)` Service-specific metadata. For example the available capacity at the given location.
`name`	`string` Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"`

LocationPolicy

(No description provided)

Fields

Fields
`allowedLocations[]`	`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.

allowedLocations[]

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.

LogsPolicy

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

Fields
`destination`	`enum` Where logs should be saved.
Enum type. Can be one of the following:
`DESTINATION_UNSPECIFIED`	Logs are not preserved.
`CLOUD_LOGGING`	Logs are streamed to Cloud Logging.
`PATH`	Logs are saved to a file path.

`logsPath`	`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.

Message

Message details. Describe the attribute that a message should have. Without specified message attributes, no message will be sent by default.

Fields
`newJobState`	`enum` The new job state.
Enum type. Can be one of the following:
`STATE_UNSPECIFIED`	(No description provided)
`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.

`newTaskState`	`enum` The new task state.
Enum type. Can be one of the following:
`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.
`UNEXECUTED`	The Task has not been executed when the Job finishes.

`type`	`enum` The message type.
Enum type. Can be one of the following:
`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.

NFS

Represents an NFS volume.

Fields

Fields
`remotePath`	`string` Remote source path exported from the NFS, e.g., "/share".
`server`	`string` The IP address of the NFS.

remotePath

string

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

server

string

The IP address of the NFS.

NetworkInterface

A network interface.

Fields

Fields
`network`	`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`	`boolean` 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`	`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}

network

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

boolean

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

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}

NetworkPolicy

NetworkPolicy describes VM instance network configurations.

Fields

Fields
`networkInterfaces[]`	`object (NetworkInterface)` Network configurations.

networkInterfaces[]

object (NetworkInterface)

Network configurations.

Operation

This resource represents a long-running operation that is the result of a network API call.

Fields
`done`	`boolean` 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`	`object (Status)` The error result of the operation in case of failure or cancellation.
`metadata`	`map (key: string, value: any)` 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.
`name`	`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`	`map (key: string, value: any)` 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`.

OperationMetadata

Represents the metadata of the long-running operation.

Fields
`apiVersion`	`string` Output only. API version used to start the operation.
`createTime`	`string (Timestamp format)` Output only. The time the operation was created.
`endTime`	`string (Timestamp format)` Output only. The time the operation finished running.
`requestedCancellation`	`boolean` 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`.
`statusMessage`	`string` Output only. Human-readable status of the operation, if any.
`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.

PlacementPolicy

PlacementPolicy describes a group placement policy for the VMs controlled by this AllocationPolicy.

Fields

Fields
`collocation`	`string` 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`	`string (int64 format)` When specified, causes the job to fail if more than max_distance logical switches are required between VMs. Batch uses the most compact possible placement of VMs even when max_distance is not specified. An explicit max_distance makes that level of compactness a strict requirement. Not yet implemented

collocation

string

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

string (int64 format)

When specified, causes the job to fail if more than max_distance logical switches are required between VMs. Batch uses the most compact possible placement of VMs even when max_distance is not specified. An explicit max_distance makes that level of compactness a strict requirement. Not yet implemented

ReportAgentStateRequest

Request to report agent's state. The Request itself implies the agent is healthy.

Fields

Fields
`agentInfo`	`object (AgentInfo)` Agent info.
`agentTimingInfo`	`object (AgentTimingInfo)` Agent timing info.
`metadata`	`object (AgentMetadata)` Agent metadata.

agentInfo

object (AgentInfo)

Agent info.

agentTimingInfo

object (AgentTimingInfo)

Agent timing info.

metadata

object (AgentMetadata)

Agent metadata.

ReportAgentStateResponse

Response to ReportAgentStateRequest.

Fields

Fields
`defaultReportInterval`	`string (Duration format)` Default report interval override
`minReportInterval`	`string (Duration format)` Minimum report interval override
`tasks[]`	`object (AgentTask)` Tasks assigned to the agent

defaultReportInterval

string (Duration format)

Default report interval override

minReportInterval

string (Duration format)

Minimum report interval override

tasks[]

object (AgentTask)

Tasks assigned to the agent

Runnable

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

Fields
`alwaysRun`	`boolean` 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`	`boolean` 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`	`object (Barrier)` Barrier runnable.
`container`	`object (Container)` Container runnable.
`environment`	`object (Environment)` Environment variables for this Runnable (overrides variables set for the whole Task or TaskGroup).
`ignoreExitStatus`	`boolean` Normally, a non-zero exit status causes the Task to fail. This flag allows execution of other Runnables to continue instead.
`labels`	`map (key: string, value: string)` Labels for this Runnable.
`script`	`object (Script)` Script runnable.
`timeout`	`string (Duration format)` Timeout for this Runnable.

Script

Script runnable.

Fields

Fields
`path`	`string` Script file path on the host VM. To specify an interpreter, please add a `#!`(also known as shebang line) as the first line of the file.(For example, to execute the script using bash, `#!/bin/bash` should be the first line of the file. To execute the script using`Python3`, `#!/usr/bin/env python3` should be the first line of the file.) Otherwise, the file will by default be excuted by `/bin/sh`.
`text`	`string` Shell script text. To specify an interpreter, please add a `#!\n` at the beginning of the text.(For example, to execute the script using bash, `#!/bin/bash\n` should be added. To execute the script using`Python3`, `#!/usr/bin/env python3\n` should be added.) Otherwise, the script will by default be excuted by `/bin/sh`.

path

string

Script file path on the host VM. To specify an interpreter, please add a #!(also known as shebang line) as the first line of the file.(For example, to execute the script using bash, #!/bin/bash should be the first line of the file. To execute the script usingPython3, #!/usr/bin/env python3 should be the first line of the file.) Otherwise, the file will by default be excuted by /bin/sh.

text

string

Shell script text. To specify an interpreter, please add a #!\n at the beginning of the text.(For example, to execute the script using bash, #!/bin/bash\n should be added. To execute the script usingPython3, #!/usr/bin/env python3\n should be added.) Otherwise, the script will by default be excuted by /bin/sh.

ServiceAccount

Carries information about a Google Cloud service account.

Fields

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[]`	`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.

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[]

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.

Status

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

Fields

Fields
`code`	`integer (int32 format)` The status code, which should be an enum value of google.rpc.Code.
`details[]`	`object` A list of messages that carry the error details. There is a common set of message types for APIs to use.
`message`	`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.

code

integer (int32 format)

The status code, which should be an enum value of google.rpc.Code.

details[]

object

A list of messages that carry the error details. There is a common set of message types for APIs to use.

message

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.

StatusEvent

Status event

Fields
`description`	`string` Description of the event.
`eventTime`	`string (Timestamp format)` The time this event occurred.
`taskExecution`	`object (TaskExecution)` Task Execution
`taskState`	`enum` Task State
Enum type. Can be one of the following:
`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.
`UNEXECUTED`	The Task has not been executed when the Job finishes.

`type`	`string` Type of the event.

Task

A Cloud Batch task.

Fields

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`	`object (TaskStatus)` Task Status.

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

object (TaskStatus)

Task Status.

TaskExecution

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

Fields

Fields
`exitCode`	`integer (int32 format)` When task is completed as the status of FAILED or SUCCEEDED, exit code is for one task execution result, default is 0 as success.

exitCode

integer (int32 format)

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".
`parallelism`	`string (int64 format)` Max number of tasks that can run in parallel. Default to min(task_count, 1000). Field parallelism must be 1 if the scheduling_policy is IN_ORDER.
`permissiveSsh`	`boolean` When true, Batch will configure SSH to allow passwordless login between VMs running the Batch tasks in the same TaskGroup.
`requireHostsFile`	`boolean` 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`	`string (int64 format)` Number of Tasks in the TaskGroup. Default is 1.
`taskCountPerNode`	`string (int64 format)` 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[]`	`object (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.
`taskSpec`	`object (TaskSpec)` Required. Tasks in the group share the same task spec.

TaskGroupStatus

Aggregated task status for a TaskGroup.

Fields

Fields
`counts`	`map (key: string, value: string (int64 format))` Count of task in each state in the TaskGroup. The map key is task state name.
`instances[]`	`object (InstanceStatus)` Status of instances allocated for the TaskGroup.

counts

map (key: string, value: string (int64 format))

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

instances[]

object (InstanceStatus)

Status of instances allocated for the TaskGroup.

TaskSpec

Spec of a task

Fields
`computeResource`	`object (ComputeResource)` ComputeResource requirements.
`environment`	`object (Environment)` Environment variables to set before running the Task.
`environments`	`map (key: string, value: string)` Deprecated: please use environment(non-plural) instead.
`lifecyclePolicies[]`	`object (LifecyclePolicy)` 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 max_retry_count.
`maxRetryCount`	`integer (int32 format)` Maximum number of retries on failures. The default, 0, which means never retry. The valid value range is [0, 10].
`maxRunDuration`	`string (Duration format)` Maximum duration the task should run. The task will be killed and marked as FAILED if over this limit.
`runnables[]`	`object (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.
`volumes[]`	`object (Volume)` Volumes to mount before running Tasks using this TaskSpec.

TaskStatus

Status of a task

Fields
`state`	`enum` Task state
Enum type. Can be one of the following:
`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.
`UNEXECUTED`	The Task has not been executed when the Job finishes.

`statusEvents[]`	`object (StatusEvent)` Detailed info about why the state is reached.

Volume

Volume describes a volume and parameters for it to be mounted to a VM.

Fields
`deviceName`	`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`	`object (GCS)` A Google Cloud Storage (GCS) volume.
`mountOptions[]`	`string` 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).
`mountPath`	`string` The mount path for the volume, e.g. /mnt/disks/share.
`nfs`	`object (NFS)` A Network File System (NFS) volume. For example, a Filestore file share.