package google.events.cloud.batch.v1

Get desktop application:
View/edit binary Protocol Buffers messages

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

Used in: Job

• optional AllocationPolicy.LocationPolicy location = 1

  Location where compute resources should be allocated for the Job.

• repeated AllocationPolicy.InstancePolicyOrTemplate instances = 8

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

• optional ServiceAccount service_account = 9

  Service account that VMs will run as.

• map<string, string> labels = 6

  Labels applied to all VM instances and other resources created by AllocationPolicy. Labels could be user provided or system generated. You can assign up to 64 labels. [Google Compute Engine label restrictions](https://cloud.google.com/compute/docs/labeling-resources#restrictions) apply. Label names that start with "goog-" or "google-" are reserved.

• optional AllocationPolicy.NetworkPolicy network = 7

  The network policy.

• optional AllocationPolicy.PlacementPolicy placement = 10

  The placement policy.

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

Used in: InstancePolicy

• string type = 1

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

• int64 count = 2

  The number of accelerators of this type.

• bool install_gpu_drivers = 3

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

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

Used in: InstancePolicy

• oneof attached

  • Disk new_disk = 1

  • string existing_disk = 2

    Name of an existing PD.

• string device_name = 3

  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.

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.

Used in: AttachedDisk, InstancePolicy, JobStatus.InstanceStatus

• oneof data_source

  A data source from which a PD will be created.

  • string image = 4

    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. * "batch-hpc-centos": use Batch HPC CentOS images.

  • string snapshot = 5

    Name of a snapshot used as the data source. Snapshot is not supported as boot disk now.

• string type = 1

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

• int64 size_gb = 2

  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.

• string disk_interface = 6

  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.

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

Used in: InstancePolicyOrTemplate

• string machine_type = 2

  The Compute Engine machine type.

• string min_cpu_platform = 3

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

• ProvisioningModel provisioning_model = 4

  The provisioning model.

• repeated Accelerator accelerators = 5

  The accelerators attached to each VM instance.

• optional Disk boot_disk = 8

  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.

• repeated AttachedDisk disks = 6

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

Either an InstancePolicy or an instance template.

Used in: AllocationPolicy

• oneof policy_template

  • InstancePolicy policy = 1

    InstancePolicy.

  • string instance_template = 2

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

• bool install_gpu_drivers = 3

  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.

Used in: AllocationPolicy

• repeated string allowed_locations = 1

  A list of allowed location names represented by internal URLs. Each location can be a region or a zone. Only one region or multiple zones in one region is supported now. For example, ["regions/us-central1"] allow VMs in any zones in region us-central1. ["zones/us-central1-a", "zones/us-central1-c"] only allow VMs in zones us-central1-a and us-central1-c. All locations end up in different regions would cause errors. For example, ["regions/us-central1", "zones/us-central1-a", "zones/us-central1-b", "zones/us-west1-a"] contains 2 regions "us-central1" and "us-west1". An error is expected in this case.

A network interface.

Used in: NetworkPolicy

• string network = 1

  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}

• string subnetwork = 2

  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}

• bool no_external_ip_address = 3

  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 describes VM instance network configurations.

Used in: AllocationPolicy

• repeated NetworkInterface network_interfaces = 1

  Network configurations.

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

Used in: AllocationPolicy

• string collocation = 1

  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.

• int64 max_distance = 2

  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

Compute Engine VM instance provisioning model.

Used in: InstancePolicy, JobStatus.InstanceStatus

• PROVISIONING_MODEL_UNSPECIFIED = 0

  Unspecified.

• STANDARD = 1

  Standard VM.

• SPOT = 2

  SPOT VM.

• PREEMPTIBLE = 3

  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.

Compute resource requirements

Used in: TaskSpec

• int64 cpu_milli = 1

  The milliCPU count.

• int64 memory_mib = 2

  Memory in MiB.

• int64 boot_disk_mib = 4

  Extra boot disk size in MiB for each task.

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

Used in: Runnable, TaskGroup, TaskSpec

• map<string, string> variables = 1

  A map of environment variable names to values.

• map<string, string> secret_variables = 2

  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.

• optional Environment.KMSEnvMap encrypted_variables = 3

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

Used in: Environment

• string key_name = 1

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

• string cipher_text = 2

  The value of the cipherText response from the `encrypt` method.

Represents a Google Cloud Storage volume.

Used in: Volume

• string remote_path = 1

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

The Cloud Batch Job description.

Used in: JobEventData

• string name = 1

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

• string uid = 2

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

• int64 priority = 3

  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.

• repeated TaskGroup task_groups = 4

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

• optional AllocationPolicy allocation_policy = 7

  Compute resource allocation for all TaskGroups in the Job.

• map<string, string> labels = 8

  Labels for the Job. Labels could be user provided or system generated. For example, "labels": { "department": "finance", "environment": "test" } You can assign up to 64 labels. [Google Compute Engine label restrictions](https://cloud.google.com/compute/docs/labeling-resources#restrictions) apply. Label names that start with "goog-" or "google-" are reserved.

• optional JobStatus status = 9

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

• optional protobuf.Timestamp create_time = 11

  Output only. When the Job was created.

• optional protobuf.Timestamp update_time = 12

  Output only. The last time the Job was updated.

• optional LogsPolicy logs_policy = 13

  Log preservation policy for the Job.

• repeated JobNotification notifications = 14

  Notification configurations.

The CloudEvent raised when a Job is created.

• optional JobEventData data = 1

  The data associated with the event.

The CloudEvent raised when a Job is deleted.

• optional JobEventData data = 1

  The data associated with the event.

The data within all Job events.

Used in: JobCreatedEvent, JobDeletedEvent

• optional Job payload = 1

  Optional. The Job event payload. Unset for deletion events.

Notification configurations.

Used in: Job

• string pubsub_topic = 1

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

• optional JobNotification.Message message = 2

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

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

Used in: JobNotification

• Type type = 1

  The message type.

• JobStatus.State new_job_state = 2

  The new job state.

• TaskStatus.State new_task_state = 3

  The new task state.

The message type.

Used in: Message

• TYPE_UNSPECIFIED = 0

  Unspecified.

• JOB_STATE_CHANGED = 1

  Notify users that the job state has changed.

• TASK_STATE_CHANGED = 2

  Notify users that the task state has changed.

Job status.

Used in: Job

• JobStatus.State state = 1

  Job state

• repeated StatusEvent status_events = 2

  Job status events

• map<string, JobStatus.TaskGroupStatus> task_groups = 4

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

• optional protobuf.Duration run_duration = 5

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

VM instance status.

Used in: TaskGroupStatus

• string machine_type = 1

  The Compute Engine machine type.

• AllocationPolicy.ProvisioningModel provisioning_model = 2

  The VM instance provisioning model.

• int64 task_pack = 3

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

• optional AllocationPolicy.Disk boot_disk = 4

  The VM boot disk.

Valid Job states.

Used in: JobNotification.Message, JobStatus

• STATE_UNSPECIFIED = 0

  Job state unspecified.

• QUEUED = 1

  Job is admitted (validated and persisted) and waiting for resources.

• SCHEDULED = 2

  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 = 3

  Resource allocation has been successful. At least one Task in the Job is RUNNING.

• SUCCEEDED = 4

  All Tasks in the Job have finished successfully.

• FAILED = 5

  At least one Task in the Job has failed.

• DELETION_IN_PROGRESS = 6

  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.

Aggregated task status for a TaskGroup.

Used in: JobStatus

• map<string, int64> counts = 1

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

• repeated InstanceStatus instances = 2

  Status of instances allocated for the TaskGroup.

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

Used in: TaskSpec

• LifecyclePolicy.Action action = 1

  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.

• optional LifecyclePolicy.ActionCondition action_condition = 2

  Conditions that decide why a task failure is dealt with a specific action.

Action on task failures based on different conditions.

Used in: LifecyclePolicy

• ACTION_UNSPECIFIED = 0

  Action unspecified.

• RETRY_TASK = 1

  Action that tasks in the group will be scheduled to re-execute.

• FAIL_TASK = 2

  Action that tasks in the group will be stopped immediately.

Conditions for actions to deal with task failures.

Used in: LifecyclePolicy

• repeated int32 exit_codes = 1

  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.

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

Used in: Job

• LogsPolicy.Destination destination = 1

  Where logs should be saved.

• string logs_path = 2

  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.

The destination (if any) for logs.

Used in: LogsPolicy

• DESTINATION_UNSPECIFIED = 0

  Logs are not preserved.

• CLOUD_LOGGING = 1

  Logs are streamed to Cloud Logging.

• PATH = 2

  Logs are saved to a file path.

Represents an NFS volume.

Used in: Volume

• string server = 1

  The IP address of the NFS.

• string remote_path = 2

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

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

Used in: TaskSpec

• oneof executable

  The script or container to run.

  • Runnable.Container container = 1

    Container runnable.

  • Runnable.Script script = 2

    Script runnable.

  • Runnable.Barrier barrier = 6

    Barrier runnable.

• bool ignore_exit_status = 3

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

• bool background = 4

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

• bool always_run = 5

  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.

• optional Environment environment = 7

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

• optional protobuf.Duration timeout = 8

  Timeout for this Runnable.

• map<string, string> labels = 9

  Labels for this Runnable.

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

Used in: Runnable

• string name = 1

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

Container runnable.

Used in: Runnable

• string image_uri = 1

  The URI to pull the container image from.

• repeated string commands = 2

  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.

• string entrypoint = 3

  Overrides the `ENTRYPOINT` specified in the container.

• repeated string volumes = 7

  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

• string options = 8

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

• bool block_external_network = 9

  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.

• string username = 10

  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.

• string password = 11

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

Used in: Runnable

• oneof command

  • string path = 1

    Script file path on the host VM. To specify an interpreter, please add a `#!<interpreter>`(also known as [shebang line](https://en.wikipedia.org/wiki/Shebang_(Unix))) 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`.

  • string text = 2

    Shell script text. To specify an interpreter, please add a `#!<interpreter>\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`.

Carries information about a Google Cloud service account.

Used in: AllocationPolicy

• string email = 1

  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.

• repeated string scopes = 2

  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 event

Used in: JobStatus

• string type = 3

  Type of the event.

• string description = 1

  Description of the event.

• optional protobuf.Timestamp event_time = 2

  The time this event occurred.

• optional TaskExecution task_execution = 4

  Task Execution

• TaskStatus.State task_state = 5

  Task State

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

Used in: StatusEvent

• int32 exit_code = 1

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

A TaskGroup defines one or more Tasks that all share the same TaskSpec.

Used in: Job

• string name = 1

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

• optional TaskSpec task_spec = 3

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

• int64 task_count = 4

  Number of Tasks in the TaskGroup. Default is 1.

• int64 parallelism = 5

  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.

• TaskGroup.SchedulingPolicy scheduling_policy = 6

  Scheduling policy for Tasks in the TaskGroup. The default value is AS_SOON_AS_POSSIBLE.

• repeated Environment task_environments = 9

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

• int64 task_count_per_node = 10

  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.

• bool require_hosts_file = 11

  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.

• bool permissive_ssh = 12

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

How Tasks in the TaskGroup should be scheduled relative to each other.

Used in: TaskGroup

• SCHEDULING_POLICY_UNSPECIFIED = 0

  Unspecified.

• AS_SOON_AS_POSSIBLE = 1

  Run Tasks as soon as resources are available. Tasks might be executed in parallel depending on parallelism and task_count values.

• IN_ORDER = 2

  Run Tasks sequentially with increased task index.

Spec of a task

Used in: TaskGroup

• repeated Runnable runnables = 8

  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.

• optional ComputeResource compute_resource = 3

  ComputeResource requirements.

• optional protobuf.Duration max_run_duration = 4

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

• int32 max_retry_count = 5

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

• repeated LifecyclePolicy lifecycle_policies = 9

  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.

• map<string, string> environments = 6

  Deprecated: please use environment(non-plural) instead.

• repeated Volume volumes = 7

  Volumes to mount before running Tasks using this TaskSpec.

• optional Environment environment = 10

  Environment variables to set before running the Task.

Status of a task

(message has no fields)

Task states.

Used in: JobNotification.Message, StatusEvent

• STATE_UNSPECIFIED = 0

  Unknown state.

• PENDING = 1

  The Task is created and waiting for resources.

• ASSIGNED = 2

  The Task is assigned to at least one VM.

• RUNNING = 3

  The Task is running.

• FAILED = 4

  The Task has failed.

• SUCCEEDED = 5

  The Task has succeeded.

• UNEXECUTED = 6

  The Task has not been executed when the Job finishes.

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

Used in: TaskSpec

• oneof source

  The source for the volume.

  • NFS nfs = 1

    A Network File System (NFS) volume. For example, a Filestore file share.

  • GCS gcs = 3

    A Google Cloud Storage (GCS) volume.

  • string device_name = 6

    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.

• string mount_path = 4

  The mount path for the volume, e.g. /mnt/disks/share.

• repeated string mount_options = 5

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