--- title: Getting Started with Datadog description: Datadog, the leading service for cloud-scale monitoring. breadcrumbs: Docs > Infrastructure > Datadog Resource Catalog --- # gcp_batch_job{% #gcp_batch_job %} ## `allocation_policy`{% #allocation_policy %} **Type**: `STRUCT`**Provider name**: `allocationPolicy`**Description**: Compute resource allocation for all TaskGroups in the Job. - `instances`**Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `instances`**Description**: Describe instances that can be created by this AllocationPolicy. Only instances[0] is supported now. - `block_project_ssh_keys`**Type**: `BOOLEAN`**Provider name**: `blockProjectSshKeys`**Description**: Optional. Set this field to `true` if you want Batch to block project-level SSH keys from accessing this job's VMs. Alternatively, you can configure the job to specify a VM instance template that blocks project-level SSH keys. In either case, Batch blocks project-level SSH keys while creating the VMs for this job. Batch allows project-level SSH keys for a job's VMs only if all the following are true: + This field is undefined or set to `false`. + The job's VM instance template (if any) doesn't block project-level SSH keys. Notably, you can override this behavior by manually updating a VM to block or allow project-level SSH keys. For more information about blocking project-level SSH keys, see the Compute Engine documentation: [https://cloud.google.com/compute/docs/connect/restrict-ssh-keys#block-keys](https://cloud.google.com/compute/docs/connect/restrict-ssh-keys#block-keys) - `install_gpu_drivers`**Type**: `BOOLEAN`**Provider name**: `installGpuDrivers`**Description**: Set this field true if you want Batch to help fetch drivers from a third party location and install them for GPUs specified in `policy.accelerators` or `instance_template` on your behalf. Default is false. For Container-Optimized Image cases, Batch will install the accelerator driver following milestones of [https://cloud.google.com/container-optimized-os/docs/release-notes](https://cloud.google.com/container-optimized-os/docs/release-notes). For non Container-Optimized Image cases, following [https://github.com/GoogleCloudPlatform/compute-gpu-installation/blob/main/linux/install_gpu_driver.py](https://github.com/GoogleCloudPlatform/compute-gpu-installation/blob/main/linux/install_gpu_driver.py). - `install_ops_agent`**Type**: `BOOLEAN`**Provider name**: `installOpsAgent`**Description**: Optional. Set this field true if you want Batch to install Ops Agent on your behalf. Default is false. - `instance_template`**Type**: `STRING`**Provider name**: `instanceTemplate`**Description**: Name of an instance template used to create VMs. Named the field as 'instance_template' instead of 'template' to avoid C++ keyword conflict. Batch only supports global instance templates from the same project as the job. You can specify the global instance template as a full or partial URL. - `policy`**Type**: `STRUCT`**Provider name**: `policy`**Description**: InstancePolicy. - `accelerators`**Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `accelerators`**Description**: The accelerators attached to each VM instance. - `count`**Type**: `INT64`**Provider name**: `count`**Description**: The number of accelerators of this type. - `driver_version`**Type**: `STRING`**Provider name**: `driverVersion`**Description**: Optional. The NVIDIA GPU driver version that should be installed for this type. You can define the specific driver version such as "470.103.01", following the driver version requirements in [https://cloud.google.com/compute/docs/gpus/install-drivers-gpu#minimum-driver](https://cloud.google.com/compute/docs/gpus/install-drivers-gpu#minimum-driver). Batch will install the specific accelerator driver if qualified. - `install_gpu_drivers`**Type**: `BOOLEAN`**Provider name**: `installGpuDrivers`**Description**: Deprecated: please use instances[0].install_gpu_drivers instead. - `type`**Type**: `STRING`**Provider name**: `type`**Description**: The accelerator type. For example, "nvidia-tesla-t4". See `gcloud compute accelerator-types list`. - `boot_disk`**Type**: `STRUCT`**Provider name**: `bootDisk`**Description**: 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. - `disk_interface`**Type**: `STRING`**Provider name**: `diskInterface`**Description**: Local SSDs are available through both "SCSI" and "NVMe" interfaces. If not indicated, "NVMe" will be the default one for local ssds. This field is ignored for persistent disks as the interface is chosen automatically. See [https://cloud.google.com/compute/docs/disks/persistent-disks#choose_an_interface](https://cloud.google.com/compute/docs/disks/persistent-disks#choose_an_interface). - `image`**Type**: `STRING`**Provider name**: `image`**Description**: URL for a VM image to use as the data source for this disk. 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-cos`: use Batch Container-Optimized images. * `batch-hpc-rocky`: use Batch HPC Rocky Linux images. - `size_gb`**Type**: `INT64`**Provider name**: `sizeGb`**Description**: Disk size in GB. **Non-Boot Disk**: If the `type` specifies a persistent disk, this field is ignored if `data_source` is set as `image` or `snapshot`. If the `type` specifies a local SSD, this field should be a multiple of 375 GB, otherwise, the final size will be the next greater multiple of 375 GB. **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. Also, this field should be no smaller than the source disk's size when the `data_source` is set as `snapshot` or `image`. For example, if you set an image as the `data_source` field and the image's default disk size 30 GB, you can only use this field to make the disk larger or equal to 30 GB. - `snapshot`**Type**: `STRING`**Provider name**: `snapshot`**Description**: Name of a snapshot used as the data source. Snapshot is not supported as boot disk now. - `type`**Type**: `STRING`**Provider name**: `type`**Description**: 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". If not specified, "pd-standard" will be used as the default type for non-boot disks, "pd-balanced" will be used as the default type for boot disks. - `disks`**Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `disks`**Description**: Non-boot disks to be attached for each VM created by this InstancePolicy. New disks will be deleted when the VM is deleted. A non-boot disk is a disk that can be of a device with a file system or a raw storage drive that is not ready for data storage and accessing. - `device_name`**Type**: `STRING`**Provider name**: `deviceName`**Description**: 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. - `existing_disk`**Type**: `STRING`**Provider name**: `existingDisk`**Description**: Name of an existing PD. - `new_disk`**Type**: `STRUCT`**Provider name**: `newDisk` - `disk_interface`**Type**: `STRING`**Provider name**: `diskInterface`**Description**: Local SSDs are available through both "SCSI" and "NVMe" interfaces. If not indicated, "NVMe" will be the default one for local ssds. This field is ignored for persistent disks as the interface is chosen automatically. See [https://cloud.google.com/compute/docs/disks/persistent-disks#choose_an_interface](https://cloud.google.com/compute/docs/disks/persistent-disks#choose_an_interface). - `image`**Type**: `STRING`**Provider name**: `image`**Description**: URL for a VM image to use as the data source for this disk. 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-cos`: use Batch Container-Optimized images. * `batch-hpc-rocky`: use Batch HPC Rocky Linux images. - `size_gb`**Type**: `INT64`**Provider name**: `sizeGb`**Description**: Disk size in GB. **Non-Boot Disk**: If the `type` specifies a persistent disk, this field is ignored if `data_source` is set as `image` or `snapshot`. If the `type` specifies a local SSD, this field should be a multiple of 375 GB, otherwise, the final size will be the next greater multiple of 375 GB. **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. Also, this field should be no smaller than the source disk's size when the `data_source` is set as `snapshot` or `image`. For example, if you set an image as the `data_source` field and the image's default disk size 30 GB, you can only use this field to make the disk larger or equal to 30 GB. - `snapshot`**Type**: `STRING`**Provider name**: `snapshot`**Description**: Name of a snapshot used as the data source. Snapshot is not supported as boot disk now. - `type`**Type**: `STRING`**Provider name**: `type`**Description**: 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". If not specified, "pd-standard" will be used as the default type for non-boot disks, "pd-balanced" will be used as the default type for boot disks. - `machine_type`**Type**: `STRING`**Provider name**: `machineType`**Description**: The Compute Engine machine type. - `min_cpu_platform`**Type**: `STRING`**Provider name**: `minCpuPlatform`**Description**: The minimum CPU platform. See [https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform). - `provisioning_model`**Type**: `STRING`**Provider name**: `provisioningModel`**Description**: The provisioning model.**Possible values**: - `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. - `reservation`**Type**: `STRING`**Provider name**: `reservation`**Description**: Optional. If not specified (default), VMs will consume any applicable reservation. If "NO_RESERVATION" is specified, VMs will not consume any reservation. Otherwise, if specified, VMs will consume only the specified reservation. - `location`**Type**: `STRUCT`**Provider name**: `location`**Description**: Location where compute resources should be allocated for the Job. - `allowed_locations`**Type**: `UNORDERED_LIST_STRING`**Provider name**: `allowedLocations`**Description**: A list of allowed location names represented by internal URLs. Each location can be a region or a zone. Only one region or multiple zones in one region is supported now. For example, ["regions/us-central1"] allow VMs in any zones in region us-central1. ["zones/us-central1-a", "zones/us-central1-c"] only allow VMs in zones us-central1-a and us-central1-c. Mixing locations from different regions would cause errors. For example, ["regions/us-central1", "zones/us-central1-a", "zones/us-central1-b", "zones/us-west1-a"] contains locations from two distinct regions: us-central1 and us-west1. This combination will trigger an error. - `network`**Type**: `STRUCT`**Provider name**: `network`**Description**: The network policy. If you define an instance template in the `InstancePolicyOrTemplate` field, Batch will use the network settings in the instance template instead of this field. - `network_interfaces`**Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `networkInterfaces`**Description**: Network configurations. - `network`**Type**: `STRING`**Provider name**: `network`**Description**: 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}](https://www.googleapis.com/compute/v1/projects/%7bproject%7d/global/networks/%7bnetwork%7d) * projects/{project}/global/networks/{network} * global/networks/{network} - `no_external_ip_address`**Type**: `BOOLEAN`**Provider name**: `noExternalIpAddress`**Description**: 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](https://cloud.google.com/vpc/docs/configure-private-google-access) and [https://cloud.google.com/nat/docs/gce-example#create-nat](https://cloud.google.com/nat/docs/gce-example#create-nat) for more information. - `subnetwork`**Type**: `STRING`**Provider name**: `subnetwork`**Description**: 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}](https://www.googleapis.com/compute/v1/projects/%7bproject%7d/regions/%7bregion%7d/subnetworks/%7bsubnetwork%7d) * projects/{project}/regions/{region}/subnetworks/{subnetwork} * regions/{region}/subnetworks/{subnetwork} - `placement`**Type**: `STRUCT`**Provider name**: `placement`**Description**: The placement policy. - `collocation`**Type**: `STRING`**Provider name**: `collocation`**Description**: 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. - `max_distance`**Type**: `INT64`**Provider name**: `maxDistance`**Description**: 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 - `service_account`**Type**: `STRUCT`**Provider name**: `serviceAccount`**Description**: Defines the service account for Batch-created VMs. If omitted, the [default Compute Engine service account](https://cloud.google.com/compute/docs/access/service-accounts#default_service_account) is used. Must match the service account specified in any used instance template configured in the Batch job. Includes the following fields: * email: The service account's email address. If not set, the default Compute Engine service account is used. * scopes: Additional OAuth scopes to grant the service account, beyond the default cloud-platform scope. (list of strings) - `email`**Type**: `STRING`**Provider name**: `email`**Description**: Email address of the service account. - `scopes`**Type**: `UNORDERED_LIST_STRING`**Provider name**: `scopes`**Description**: List of scopes to be enabled for this service account. ## `ancestors`{% #ancestors %} **Type**: `UNORDERED_LIST_STRING` ## `create_time`{% #create_time %} **Type**: `TIMESTAMP`**Provider name**: `createTime`**Description**: Output only. When the Job was created. ## `gcp_status`{% #gcp_status %} **Type**: `STRUCT`**Provider name**: `status`**Description**: Output only. Job status. It is read only for users. - `run_duration`**Type**: `STRING`**Provider name**: `runDuration`**Description**: The duration of time that the Job spent in status RUNNING. - `state`**Type**: `STRING`**Provider name**: `state`**Description**: Job state**Possible values**: - `STATE_UNSPECIFIED` - Job state unspecified. - `QUEUED` - Job is admitted (validated and persisted) and waiting for resources. - `SCHEDULED` - Job is scheduled to run as soon as resource allocation is ready. The resource allocation may happen at a later time but with a high chance to succeed. - `RUNNING` - Resource allocation has been successful. At least one Task in the Job is RUNNING. - `SUCCEEDED` - All Tasks in the Job have finished successfully. - `FAILED` - At least one Task in the Job has failed. - `DELETION_IN_PROGRESS` - The Job will be deleted, but has not been deleted yet. Typically this is because resources used by the Job are still being cleaned up. - `CANCELLATION_IN_PROGRESS` - The Job cancellation is in progress, this is because the resources used by the Job are still being cleaned up. - `CANCELLED` - The Job has been cancelled, the task executions were stopped and the resources were cleaned up. - `status_events`**Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `statusEvents`**Description**: Job status events - `description`**Type**: `STRING`**Provider name**: `description`**Description**: Description of the event. - `event_time`**Type**: `TIMESTAMP`**Provider name**: `eventTime`**Description**: The time this event occurred. - `task_execution`**Type**: `STRUCT`**Provider name**: `taskExecution`**Description**: Task Execution. This field is only defined for task-level status events where the task fails. - `exit_code`**Type**: `INT32`**Provider name**: `exitCode`**Description**: The exit code of a finished task. If the task succeeded, the exit code will be 0. If the task failed but not due to the following reasons, the exit code will be 50000. Otherwise, it can be from different sources: * Batch known failures: [https://cloud.google.com/batch/docs/troubleshooting#reserved-exit-codes](https://cloud.google.com/batch/docs/troubleshooting#reserved-exit-codes). * Batch runnable execution failures; you can rely on Batch logs to further diagnose: [https://cloud.google.com/batch/docs/analyze-job-using-logs](https://cloud.google.com/batch/docs/analyze-job-using-logs). If there are multiple runnables failures, Batch only exposes the first error. - `task_state`**Type**: `STRING`**Provider name**: `taskState`**Description**: Task State. This field is only defined for task-level status events.**Possible values**: - `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`**Type**: `STRING`**Provider name**: `type`**Description**: Type of the event. ## `labels`{% #labels %} **Type**: `UNORDERED_LIST_STRING` ## `logs_policy`{% #logs_policy %} **Type**: `STRUCT`**Provider name**: `logsPolicy`**Description**: Log preservation policy for the Job. - `cloud_logging_option`**Type**: `STRUCT`**Provider name**: `cloudLoggingOption`**Description**: Optional. When `destination` is set to `CLOUD_LOGGING`, you can optionally set this field to configure additional settings for Cloud Logging. - `use_generic_task_monitored_resource`**Type**: `BOOLEAN`**Provider name**: `useGenericTaskMonitoredResource`**Description**: Optional. Set this field to `true` to change the [monitored resource type](https://cloud.google.com/monitoring/api/resources) for Cloud Logging logs generated by this Batch job from the [`batch.googleapis.com/Job`](https://cloud.google.com/monitoring/api/resources#tag_batch.googleapis.com/Job) type to the formerly used [`generic_task`](https://cloud.google.com/monitoring/api/resources#tag_generic_task) type. - `destination`**Type**: `STRING`**Provider name**: `destination`**Description**: If and where logs should be saved.**Possible values**: - `DESTINATION_UNSPECIFIED` - (Default) Logs are not preserved. - `CLOUD_LOGGING` - Logs are streamed to Cloud Logging. Optionally, you can configure additional settings in the `cloudLoggingOption` field. - `PATH` - Logs are saved to the file path specified in the `logsPath` field. - `logs_path`**Type**: `STRING`**Provider name**: `logsPath`**Description**: When `destination` is set to `PATH`, you must set this field to the path where you want logs to be saved. This path can point to a local directory on the VM or (if congifured) a directory under the mount path of any Cloud Storage bucket, network file system (NFS), or writable persistent disk that is mounted to the job. For example, if the job has a bucket with `mountPath` set to `/mnt/disks/my-bucket`, you can write logs to the root directory of the `remotePath` of that bucket by setting this field to `/mnt/disks/my-bucket/`. ## `name`{% #name %} **Type**: `STRING`**Provider name**: `name`**Description**: Output only. Job name. For example: "projects/123456/locations/us-central1/jobs/job01". ## `notifications`{% #notifications %} **Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `notifications`**Description**: Notification configurations. - `message`**Type**: `STRUCT`**Provider name**: `message`**Description**: The attribute requirements of messages to be sent to this Pub/Sub topic. Without this field, no message will be sent. - `new_job_state`**Type**: `STRING`**Provider name**: `newJobState`**Description**: The new job state.**Possible values**: - `STATE_UNSPECIFIED` - Job state unspecified. - `QUEUED` - Job is admitted (validated and persisted) and waiting for resources. - `SCHEDULED` - Job is scheduled to run as soon as resource allocation is ready. The resource allocation may happen at a later time but with a high chance to succeed. - `RUNNING` - Resource allocation has been successful. At least one Task in the Job is RUNNING. - `SUCCEEDED` - All Tasks in the Job have finished successfully. - `FAILED` - At least one Task in the Job has failed. - `DELETION_IN_PROGRESS` - The Job will be deleted, but has not been deleted yet. Typically this is because resources used by the Job are still being cleaned up. - `CANCELLATION_IN_PROGRESS` - The Job cancellation is in progress, this is because the resources used by the Job are still being cleaned up. - `CANCELLED` - The Job has been cancelled, the task executions were stopped and the resources were cleaned up. - `new_task_state`**Type**: `STRING`**Provider name**: `newTaskState`**Description**: The new task state.**Possible values**: - `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`**Type**: `STRING`**Provider name**: `type`**Description**: The message type.**Possible values**: - `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. - `pubsub_topic`**Type**: `STRING`**Provider name**: `pubsubTopic`**Description**: The Pub/Sub topic where notifications for the job, like state changes, will be published. If undefined, no Pub/Sub notifications are sent for this job. Specify the topic using the following format: `projects/{project}/topics/{topic}`. Notably, if you want to specify a Pub/Sub topic that is in a different project than the job, your administrator must grant your project's Batch service agent permission to publish to that topic. For more information about configuring Pub/Sub notifications for a job, see [https://cloud.google.com/batch/docs/enable-notifications](https://cloud.google.com/batch/docs/enable-notifications). ## `organization_id`{% #organization_id %} **Type**: `STRING` ## `parent`{% #parent %} **Type**: `STRING` ## `priority`{% #priority %} **Type**: `INT64`**Provider name**: `priority`**Description**: 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. ## `project_id`{% #project_id %} **Type**: `STRING` ## `project_number`{% #project_number %} **Type**: `STRING` ## `region_id`{% #region_id %} **Type**: `STRING` ## `resource_name`{% #resource_name %} **Type**: `STRING` ## `tags`{% #tags %} **Type**: `UNORDERED_LIST_STRING` ## `task_groups`{% #task_groups %} **Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `taskGroups`**Description**: Required. TaskGroups in the Job. Only one TaskGroup is supported now. - `name`**Type**: `STRING`**Provider name**: `name`**Description**: 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`**Type**: `INT64`**Provider name**: `parallelism`**Description**: Max number of tasks that can run in parallel. Default to min(task_count, parallel tasks per job limit). See: [Job Limits](https://cloud.google.com/batch/quotas#job_limits). Field parallelism must be 1 if the scheduling_policy is IN_ORDER. - `permissive_ssh`**Type**: `BOOLEAN`**Provider name**: `permissiveSsh`**Description**: When true, Batch will configure SSH to allow passwordless login between VMs running the Batch tasks in the same TaskGroup. - `require_hosts_file`**Type**: `BOOLEAN`**Provider name**: `requireHostsFile`**Description**: When true, Batch will populate a file with a list of all VMs assigned to the TaskGroup and set the BATCH_HOSTS_FILE environment variable to the path of that file. Defaults to false. The host file supports up to 1000 VMs. - `run_as_non_root`**Type**: `BOOLEAN`**Provider name**: `runAsNonRoot`**Description**: Optional. If not set or set to false, Batch uses the root user to execute runnables. If set to true, Batch runs the runnables using a non-root user. Currently, the non-root user Batch used is generated by OS Login. For more information, see [About OS Login](https://cloud.google.com/compute/docs/oslogin). - `scheduling_policy`**Type**: `STRING`**Provider name**: `schedulingPolicy`**Description**: Scheduling policy for Tasks in the TaskGroup. The default value is AS_SOON_AS_POSSIBLE.**Possible values**: - `SCHEDULING_POLICY_UNSPECIFIED` - Unspecified. - `AS_SOON_AS_POSSIBLE` - Run Tasks as soon as resources are available. Tasks might be executed in parallel depending on parallelism and task_count values. - `IN_ORDER` - Run Tasks sequentially with increased task index. - `task_count`**Type**: `INT64`**Provider name**: `taskCount`**Description**: Number of Tasks in the TaskGroup. Default is 1. - `task_count_per_node`**Type**: `INT64`**Provider name**: `taskCountPerNode`**Description**: 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. - `task_environments`**Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `taskEnvironments`**Description**: 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). - `encrypted_variables`**Type**: `STRUCT`**Provider name**: `encryptedVariables`**Description**: An encrypted JSON dictionary where the key/value pairs correspond to environment variable names and their values. - `cipher_text`**Type**: `STRING`**Provider name**: `cipherText`**Description**: The value of the cipherText response from the `encrypt` method. - `key_name`**Type**: `STRING`**Provider name**: `keyName`**Description**: The name of the KMS key that will be used to decrypt the cipher text. - `task_spec`**Type**: `STRUCT`**Provider name**: `taskSpec`**Description**: Required. Tasks in the group share the same task spec. - `compute_resource`**Type**: `STRUCT`**Provider name**: `computeResource`**Description**: ComputeResource requirements. - `boot_disk_mib`**Type**: `INT64`**Provider name**: `bootDiskMib`**Description**: Extra boot disk size in MiB for each task. - `cpu_milli`**Type**: `INT64`**Provider name**: `cpuMilli`**Description**: The milliCPU count. `cpuMilli` defines the amount of CPU resources per task in milliCPU units. For example, `1000` corresponds to 1 vCPU per task. If undefined, the default value is `2000`. If you also define the VM's machine type using the `machineType` in [InstancePolicy](https://cloud.google.com/batch/docs/reference/rest/v1/projects.locations.jobs#instancepolicy) field or inside the `instanceTemplate` in the [InstancePolicyOrTemplate](https://cloud.google.com/batch/docs/reference/rest/v1/projects.locations.jobs#instancepolicyortemplate) field, make sure the CPU resources for both fields are compatible with each other and with how many tasks you want to allow to run on the same VM at the same time. For example, if you specify the `n2-standard-2` machine type, which has 2 vCPUs each, you are recommended to set `cpuMilli` no more than `2000`, or you are recommended to run two tasks on the same VM if you set `cpuMilli` to `1000` or less. - `memory_mib`**Type**: `INT64`**Provider name**: `memoryMib`**Description**: Memory in MiB. `memoryMib` defines the amount of memory per task in MiB units. If undefined, the default value is `2000`. If you also define the VM's machine type using the `machineType` in [InstancePolicy](https://cloud.google.com/batch/docs/reference/rest/v1/projects.locations.jobs#instancepolicy) field or inside the `instanceTemplate` in the [InstancePolicyOrTemplate](https://cloud.google.com/batch/docs/reference/rest/v1/projects.locations.jobs#instancepolicyortemplate) field, make sure the memory resources for both fields are compatible with each other and with how many tasks you want to allow to run on the same VM at the same time. For example, if you specify the `n2-standard-2` machine type, which has 8 GiB each, you are recommended to set `memoryMib` to no more than `8192`, or you are recommended to run two tasks on the same VM if you set `memoryMib` to `4096` or less. - `environment`**Type**: `STRUCT`**Provider name**: `environment`**Description**: Environment variables to set before running the Task. - `encrypted_variables`**Type**: `STRUCT`**Provider name**: `encryptedVariables`**Description**: An encrypted JSON dictionary where the key/value pairs correspond to environment variable names and their values. - `cipher_text`**Type**: `STRING`**Provider name**: `cipherText`**Description**: The value of the cipherText response from the `encrypt` method. - `key_name`**Type**: `STRING`**Provider name**: `keyName`**Description**: The name of the KMS key that will be used to decrypt the cipher text. - `lifecycle_policies`**Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `lifecyclePolicies`**Description**: 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. - `action`**Type**: `STRING`**Provider name**: `action`**Description**: 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.**Possible values**: - `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. - `action_condition`**Type**: `STRUCT`**Provider name**: `actionCondition`**Description**: Conditions that decide why a task failure is dealt with a specific action. - `exit_codes`**Type**: `UNORDERED_LIST_INT32`**Provider name**: `exitCodes`**Description**: 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. - `max_retry_count`**Type**: `INT32`**Provider name**: `maxRetryCount`**Description**: Maximum number of retries on failures. The default, 0, which means never retry. The valid value range is [0, 10]. - `max_run_duration`**Type**: `STRING`**Provider name**: `maxRunDuration`**Description**: Maximum duration the task should run before being automatically retried (if enabled) or automatically failed. Format the value of this field as a time limit in seconds followed by `s`—for example, `3600s` for 1 hour. The field accepts any value between 0 and the maximum listed for the `Duration` field type at [https://protobuf.dev/reference/protobuf/google.protobuf/#duration;](https://protobuf.dev/reference/protobuf/google.protobuf/#duration;) however, the actual maximum run time for a job will be limited to the maximum run time for a job listed at [https://cloud.google.com/batch/quotas#max-job-duration](https://cloud.google.com/batch/quotas#max-job-duration). - `runnables`**Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `runnables`**Description**: Required. The sequence of one or more runnables (executable scripts, executable containers, and/or barriers) for each task in this task group to run. Each task runs this list of runnables in order. For a task to succeed, all of its script and container runnables each must meet at least one of the following conditions: + The runnable exited with a zero status. + The runnable didn't finish, but you enabled its `background` subfield. + The runnable exited with a non-zero status, but you enabled its `ignore_exit_status` subfield. - `always_run`**Type**: `BOOLEAN`**Provider name**: `alwaysRun`**Description**: 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`**Type**: `BOOLEAN`**Provider name**: `background`**Description**: Normally, a runnable that doesn't exit causes its task to fail. However, you can set this field to `true` to configure a background runnable. Background runnables are allowed continue running in the background while the task executes subsequent runnables. For example, background runnables are useful for providing services to other runnables or providing debugging-support tools like SSH servers. Specifically, background runnables are killed automatically (if they have not already exited) a short time after all foreground runnables have completed. Even though this is likely to result in a non-zero exit status for the background runnable, these automatic kills are not treated as task failures. - `barrier`**Type**: `STRUCT`**Provider name**: `barrier`**Description**: Barrier runnable. - `name`**Type**: `STRING`**Provider name**: `name`**Description**: Barriers are identified by their index in runnable list. Names are not required, but if present should be an identifier. - `container`**Type**: `STRUCT`**Provider name**: `container`**Description**: Container runnable. - `block_external_network`**Type**: `BOOLEAN`**Provider name**: `blockExternalNetwork`**Description**: 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`**Type**: `UNORDERED_LIST_STRING`**Provider name**: `commands`**Description**: Required for some container images. Overrides the `CMD` specified in the container. If there is an `ENTRYPOINT` (either in the container image or with the `entrypoint` field below) then these commands are appended as arguments to the `ENTRYPOINT`. - `enable_image_streaming`**Type**: `BOOLEAN`**Provider name**: `enableImageStreaming`**Description**: Optional. If set to true, this container runnable uses Image streaming. Use Image streaming to allow the runnable to initialize without waiting for the entire container image to download, which can significantly reduce startup time for large container images. When `enableImageStreaming` is set to true, the container runtime is [containerd](https://containerd.io/) instead of Docker. Additionally, this container runnable only supports the following `container` subfields: `imageUri`, `commands[]`, `entrypoint`, and `volumes[]`; any other `container` subfields are ignored. For more information about the requirements and limitations for using Image streaming with Batch, see the [`image-streaming` sample on GitHub](https://github.com/GoogleCloudPlatform/batch-samples/tree/main/api-samples/image-streaming). - `entrypoint`**Type**: `STRING`**Provider name**: `entrypoint`**Description**: Required for some container images. Overrides the `ENTRYPOINT` specified in the container. - `image_uri`**Type**: `STRING`**Provider name**: `imageUri`**Description**: Required. The URI to pull the container image from. - `options`**Type**: `STRING`**Provider name**: `options`**Description**: Required for some container images. Arbitrary additional options to include in the `docker run` command when running this container—for example, `--network host`. For the `--volume` option, use the `volumes` field for the container. - `password`**Type**: `STRING`**Provider name**: `password`**Description**: Required if the container image is from a private Docker registry. The password to login to the Docker registry that contains the image. For security, it is strongly recommended to specify an encrypted password by using a Secret Manager secret: `projects/*/secrets/*/versions/*`. Warning: If you specify the password using plain text, you risk the password being exposed to any users who can view the job or its logs. To avoid this risk, specify a secret that contains the password instead. Learn more about [Secret Manager](https://cloud.google.com/secret-manager/docs/) and [using Secret Manager with Batch](https://cloud.google.com/batch/docs/create-run-job-secret-manager). - `username`**Type**: `STRING`**Provider name**: `username`**Description**: Required if the container image is from a private Docker registry. The username to login to the Docker registry that contains the image. You can either specify the username directly by using plain text or specify an encrypted username by using a Secret Manager secret: `projects/*/secrets/*/versions/*`. However, using a secret is recommended for enhanced security. Caution: If you specify the username using plain text, you risk the username being exposed to any users who can view the job or its logs. To avoid this risk, specify a secret that contains the username instead. Learn more about [Secret Manager](https://cloud.google.com/secret-manager/docs/) and [using Secret Manager with Batch](https://cloud.google.com/batch/docs/create-run-job-secret-manager). - `volumes`**Type**: `UNORDERED_LIST_STRING`**Provider name**: `volumes`**Description**: Volumes to mount (bind mount) from the host machine files or directories into the container, formatted to match `--volume` option for the `docker run` command—for example, `/foo:/bar` or `/foo:/bar:ro`. If the `TaskSpec.Volumes` field is specified but this field is not, Batch will mount each volume from the host machine to the container with the same mount path by default. In this case, the default mount option for containers will be read-only (`ro`) for existing persistent disks and read-write (`rw`) for other volume types, regardless of the original mount options specified in `TaskSpec.Volumes`. If you need different mount settings, you can explicitly configure them in this field. - `environment`**Type**: `STRUCT`**Provider name**: `environment`**Description**: Environment variables for this Runnable (overrides variables set for the whole Task or TaskGroup). - `encrypted_variables`**Type**: `STRUCT`**Provider name**: `encryptedVariables`**Description**: An encrypted JSON dictionary where the key/value pairs correspond to environment variable names and their values. - `cipher_text`**Type**: `STRING`**Provider name**: `cipherText`**Description**: The value of the cipherText response from the `encrypt` method. - `key_name`**Type**: `STRING`**Provider name**: `keyName`**Description**: The name of the KMS key that will be used to decrypt the cipher text. - `gcp_display_name`**Type**: `STRING`**Provider name**: `displayName`**Description**: Optional. DisplayName is an optional field that can be provided by the caller. If provided, it will be used in logs and other outputs to identify the script, making it easier for users to understand the logs. If not provided the index of the runnable will be used for outputs. - `ignore_exit_status`**Type**: `BOOLEAN`**Provider name**: `ignoreExitStatus`**Description**: Normally, a runnable that returns a non-zero exit status fails and causes the task to fail. However, you can set this field to `true` to allow the task to continue executing its other runnables even if this runnable fails. - `script`**Type**: `STRUCT`**Provider name**: `script`**Description**: Script runnable. - `path`**Type**: `STRING`**Provider name**: `path`**Description**: The path to a script file that is accessible from the host VM(s). Unless the script file supports the default `#!/bin/sh` shell interpreter, you must specify an interpreter by including a [shebang line]([https://en.wikipedia.org/wiki/Shebang_(Unix)](https://en.wikipedia.org/wiki/Shebang_%28Unix%29) as the first line of the file. For example, to execute the script using bash, include `#!/bin/bash` as the first line of the file. Alternatively, to execute the script using Python3, include `#!/usr/bin/env python3` as the first line of the file. - `text`**Type**: `STRING`**Provider name**: `text`**Description**: The text for a script. Unless the script text supports the default `#!/bin/sh` shell interpreter, you must specify an interpreter by including a [shebang line]([https://en.wikipedia.org/wiki/Shebang_(Unix)](https://en.wikipedia.org/wiki/Shebang_%28Unix%29) at the beginning of the text. For example, to execute the script using bash, include `#!/bin/bash\n` at the beginning of the text. Alternatively, to execute the script using Python3, include `#!/usr/bin/env python3\n` at the beginning of the text. - `timeout`**Type**: `STRING`**Provider name**: `timeout`**Description**: Timeout for this Runnable. - `volumes`**Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `volumes`**Description**: Volumes to mount before running Tasks using this TaskSpec. - `device_name`**Type**: `STRING`**Provider name**: `deviceName`**Description**: 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`**Type**: `STRUCT`**Provider name**: `gcs`**Description**: A Google Cloud Storage (GCS) volume. - `remote_path`**Type**: `STRING`**Provider name**: `remotePath`**Description**: Remote path, either a bucket name or a subdirectory of a bucket, e.g.: bucket_name, bucket_name/subdirectory/ - `mount_options`**Type**: `UNORDERED_LIST_STRING`**Provider name**: `mountOptions`**Description**: Mount options vary based on the type of storage volume: * For a Cloud Storage bucket, all the mount options provided by the [`gcsfuse` tool](https://cloud.google.com/storage/docs/gcsfuse-cli) are supported. * For an existing persistent disk, all 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 any other disk or a Network File System (NFS), all the mount options provided by the `mount` command are supported. - `mount_path`**Type**: `STRING`**Provider name**: `mountPath`**Description**: The mount path for the volume, e.g. /mnt/disks/share. - `nfs`**Type**: `STRUCT`**Provider name**: `nfs`**Description**: A Network File System (NFS) volume. For example, a Filestore file share. - `remote_path`**Type**: `STRING`**Provider name**: `remotePath`**Description**: Remote source path exported from the NFS, e.g., "/share". - `server`**Type**: `STRING`**Provider name**: `server`**Description**: The IP address of the NFS. ## `uid`{% #uid %} **Type**: `STRING`**Provider name**: `uid`**Description**: Output only. A system generated unique ID for the Job. ## `update_time`{% #update_time %} **Type**: `TIMESTAMP`**Provider name**: `updateTime`**Description**: Output only. The last time the Job was updated. ## `zone_id`{% #zone_id %} **Type**: `STRING`