Batch API . projects . locations . jobs

close()

Close httplib2 connections.

create(parent, body=None, jobId=None, requestId=None, x__xgafv=None)

Create a Job.

Args:
  parent: string, Required. The parent resource name where the Job will be created. Pattern: "projects/{project}/locations/{location}" (required)
  body: object, The request body.
    The object takes the form of:

{ # The Cloud Batch Job description.
  "allocationPolicy": { # A Job's resource allocation policy describes when, where, and how compute resources should be allocated for the Job. # Compute resource allocation for all TaskGroups in the Job.
    "instances": [ # Describe instances that can be created by this AllocationPolicy. Only instances[0] is supported now.
      { # InstancePolicyOrTemplate lets you define the type of resources to use for this job either with an InstancePolicy or an instance template. If undefined, Batch picks the type of VM to use and doesn't include optional VM resources such as GPUs and extra disks.
        "blockProjectSshKeys": True or False, # 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
        "installGpuDrivers": True or False, # 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. For non Container-Optimized Image cases, following https://github.com/GoogleCloudPlatform/compute-gpu-installation/blob/main/linux/install_gpu_driver.py.
        "installOpsAgent": True or False, # Optional. Set this field true if you want Batch to install Ops Agent on your behalf. Default is false.
        "instanceTemplate": "A String", # 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": { # InstancePolicy describes an instance type and resources attached to each VM created by this InstancePolicy. # InstancePolicy.
          "accelerators": [ # The accelerators attached to each VM instance.
            { # Accelerator describes Compute Engine accelerators to be attached to the VM.
              "count": "A String", # The number of accelerators of this type.
              "driverVersion": "A String", # Optional. The NVIDIA GPU driver version that should be installed for this type. You can define the specific driver version such as "470.103.01", following the driver version requirements in https://cloud.google.com/compute/docs/gpus/install-drivers-gpu#minimum-driver. Batch will install the specific accelerator driver if qualified.
              "installGpuDrivers": True or False, # Deprecated: please use instances[0].install_gpu_drivers instead.
              "type": "A String", # The accelerator type. For example, "nvidia-tesla-t4". See `gcloud compute accelerator-types list`.
            },
          ],
          "bootDisk": { # 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. # 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.
            "diskInterface": "A String", # 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.
            "image": "A String", # 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.
            "sizeGb": "A String", # 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": "A String", # Name of a snapshot used as the data source. Snapshot is not supported as boot disk now.
            "type": "A 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". 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": [ # 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.
            { # A new or an existing persistent disk (PD) or a local ssd attached to a VM instance.
              "deviceName": "A 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": "A String", # Name of an existing PD.
              "newDisk": { # 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.
                "diskInterface": "A String", # 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.
                "image": "A String", # 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.
                "sizeGb": "A String", # 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": "A String", # Name of a snapshot used as the data source. Snapshot is not supported as boot disk now.
                "type": "A 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". 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.
              },
            },
          ],
          "machineType": "A String", # The Compute Engine machine type.
          "minCpuPlatform": "A String", # The minimum CPU platform. See https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform.
          "provisioningModel": "A String", # The provisioning model.
          "reservation": "A String", # 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.
        },
      },
    ],
    "labels": { # Custom labels to apply to the job and all the Compute Engine resources that both are created by this allocation policy and support labels. Use labels to group and describe the resources they are applied to. Batch automatically applies predefined labels and supports multiple `labels` fields for each job, which each let you apply custom labels to various resources. Label names that start with "goog-" or "google-" are reserved for predefined labels. For more information about labels with Batch, see [Organize resources using labels](https://cloud.google.com/batch/docs/organize-resources-using-labels).
      "a_key": "A String",
    },
    "location": { # Location where compute resources should be allocated for the Job.
      "allowedLocations": [ # A list of allowed location names represented by internal URLs. Each location can be a region or a zone. Only one region or multiple zones in one region is supported now. For example, ["regions/us-central1"] allow VMs in any zones in region us-central1. ["zones/us-central1-a", "zones/us-central1-c"] only allow VMs in zones us-central1-a and us-central1-c. Mixing locations from different regions would cause errors. For example, ["regions/us-central1", "zones/us-central1-a", "zones/us-central1-b", "zones/us-west1-a"] contains locations from two distinct regions: us-central1 and us-west1. This combination will trigger an error.
        "A String",
      ],
    },
    "network": { # NetworkPolicy describes VM instance network configurations. # 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.
      "networkInterfaces": [ # Network configurations.
        { # A network interface.
          "network": "A 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": True or False, # 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": "A 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}
        },
      ],
    },
    "placement": { # PlacementPolicy describes a group placement policy for the VMs controlled by this AllocationPolicy. # The placement policy.
      "collocation": "A 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": "A String", # 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
    },
    "serviceAccount": { # Carries information about a Google Cloud service account. # 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": "A String", # Email address of the service account.
      "scopes": [ # List of scopes to be enabled for this service account.
        "A String",
      ],
    },
    "tags": [ # Optional. Tags applied to the VM instances. The tags identify valid sources or targets for network firewalls. Each tag must be 1-63 characters long, and comply with [RFC1035](https://www.ietf.org/rfc/rfc1035.txt).
      "A String",
    ],
  },
  "createTime": "A String", # Output only. When the Job was created.
  "labels": { # Custom labels to apply to the job and any Cloud Logging [LogEntry](https://cloud.google.com/logging/docs/reference/v2/rest/v2/LogEntry) that it generates. Use labels to group and describe the resources they are applied to. Batch automatically applies predefined labels and supports multiple `labels` fields for each job, which each let you apply custom labels to various resources. Label names that start with "goog-" or "google-" are reserved for predefined labels. For more information about labels with Batch, see [Organize resources using labels](https://cloud.google.com/batch/docs/organize-resources-using-labels).
    "a_key": "A String",
  },
  "logsPolicy": { # LogsPolicy describes if and how a job's logs are preserved. Logs include information that is automatically written by the Batch service agent and any information that you configured the job's runnables to write to the `stdout` or `stderr` streams. # Log preservation policy for the Job.
    "cloudLoggingOption": { # `CloudLoggingOption` contains additional settings for Cloud Logging logs generated by Batch job. # Optional. When `destination` is set to `CLOUD_LOGGING`, you can optionally set this field to configure additional settings for Cloud Logging.
      "useGenericTaskMonitoredResource": True or False, # 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": "A String", # If and where logs should be saved.
    "logsPath": "A String", # 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": "A String", # Output only. Job name. For example: "projects/123456/locations/us-central1/jobs/job01".
  "notifications": [ # Notification configurations.
    { # Notification configurations.
      "message": { # Message details. Describe the conditions under which messages will be sent. If no attribute is defined, no message will be sent by default. One message should specify either the job or the task level attributes, but not both. For example, job level: JOB_STATE_CHANGED and/or a specified new_job_state; task level: TASK_STATE_CHANGED and/or a specified new_task_state. # The attribute requirements of messages to be sent to this Pub/Sub topic. Without this field, no message will be sent.
        "newJobState": "A String", # The new job state.
        "newTaskState": "A String", # The new task state.
        "type": "A String", # The message type.
      },
      "pubsubTopic": "A String", # 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.
    },
  ],
  "priority": "A String", # 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": { # Job status. # Output only. Job status. It is read only for users.
    "runDuration": "A String", # The duration of time that the Job spent in status RUNNING.
    "state": "A String", # Job state
    "statusEvents": [ # Job status events
      { # Status event.
        "description": "A String", # Description of the event.
        "eventTime": "A String", # The time this event occurred.
        "taskExecution": { # This Task Execution field includes detail information for task execution procedures, based on StatusEvent types. # Task Execution. This field is only defined for task-level status events where the task fails.
          "exitCode": 42, # 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. * Batch runnable execution failures; you can rely on Batch logs to further diagnose: https://cloud.google.com/batch/docs/analyze-job-using-logs. If there are multiple runnables failures, Batch only exposes the first error.
        },
        "taskState": "A String", # Task State. This field is only defined for task-level status events.
        "type": "A String", # Type of the event.
      },
    ],
    "taskGroups": { # Aggregated task status for each TaskGroup in the Job. The map key is TaskGroup ID.
      "a_key": { # Aggregated task status for a TaskGroup.
        "counts": { # Count of task in each state in the TaskGroup. The map key is task state name.
          "a_key": "A String",
        },
        "instances": [ # Status of instances allocated for the TaskGroup.
          { # VM instance status.
            "bootDisk": { # 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. # The VM boot disk.
              "diskInterface": "A String", # 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.
              "image": "A String", # 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.
              "sizeGb": "A String", # 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": "A String", # Name of a snapshot used as the data source. Snapshot is not supported as boot disk now.
              "type": "A 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". 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.
            },
            "machineType": "A String", # The Compute Engine machine type.
            "provisioningModel": "A String", # The VM instance provisioning model.
            "taskPack": "A String", # The max number of tasks can be assigned to this instance type.
          },
        ],
      },
    },
  },
  "taskGroups": [ # Required. TaskGroups in the Job. Only one TaskGroup is supported now.
    { # A TaskGroup defines one or more Tasks that all share the same TaskSpec.
      "name": "A 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": "A String", # 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.
      "permissiveSsh": True or False, # When true, Batch will configure SSH to allow passwordless login between VMs running the Batch tasks in the same TaskGroup.
      "requireHostsFile": True or False, # 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.
      "runAsNonRoot": True or False, # 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).
      "schedulingPolicy": "A String", # Scheduling policy for Tasks in the TaskGroup. The default value is AS_SOON_AS_POSSIBLE.
      "taskCount": "A String", # Number of Tasks in the TaskGroup. Default is 1.
      "taskCountPerNode": "A String", # 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": [ # 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).
        { # An Environment describes a collection of environment variables to set when executing Tasks.
          "encryptedVariables": { # An encrypted JSON dictionary where the key/value pairs correspond to environment variable names and their values.
            "cipherText": "A String", # The value of the cipherText response from the `encrypt` method.
            "keyName": "A String", # The name of the KMS key that will be used to decrypt the cipher text.
          },
          "secretVariables": { # A map of environment variable names to Secret Manager secret names. The VM will access the named secrets to set the value of each environment variable.
            "a_key": "A String",
          },
          "variables": { # A map of environment variable names to values.
            "a_key": "A String",
          },
        },
      ],
      "taskSpec": { # Spec of a task # Required. Tasks in the group share the same task spec.
        "computeResource": { # Compute resource requirements. ComputeResource defines the amount of resources required for each task. Make sure your tasks have enough resources to successfully run. If you also define the types of resources for a job to use with the [InstancePolicyOrTemplate](https://cloud.google.com/batch/docs/reference/rest/v1/projects.locations.jobs#instancepolicyortemplate) field, make sure both fields are compatible with each other. # ComputeResource requirements.
          "bootDiskMib": "A String", # Extra boot disk size in MiB for each task.
          "cpuMilli": "A String", # 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.
          "memoryMib": "A String", # 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": { # An Environment describes a collection of environment variables to set when executing Tasks. # Environment variables to set before running the Task.
          "encryptedVariables": { # An encrypted JSON dictionary where the key/value pairs correspond to environment variable names and their values.
            "cipherText": "A String", # The value of the cipherText response from the `encrypt` method.
            "keyName": "A String", # The name of the KMS key that will be used to decrypt the cipher text.
          },
          "secretVariables": { # A map of environment variable names to Secret Manager secret names. The VM will access the named secrets to set the value of each environment variable.
            "a_key": "A String",
          },
          "variables": { # A map of environment variable names to values.
            "a_key": "A String",
          },
        },
        "environments": { # Deprecated: please use environment(non-plural) instead.
          "a_key": "A String",
        },
        "lifecyclePolicies": [ # Lifecycle management schema when any task in a task group is failed. Currently we only support one lifecycle policy. When the lifecycle policy condition is met, the action in the policy will execute. If task execution result does not meet with the defined lifecycle policy, we consider it as the default policy. Default policy means if the exit code is 0, exit task. If task ends with non-zero exit code, retry the task with max_retry_count.
          { # LifecyclePolicy describes how to deal with task failures based on different conditions.
            "action": "A String", # Action to execute when ActionCondition is true. When RETRY_TASK is specified, we will retry failed tasks if we notice any exit code match and fail tasks if no match is found. Likewise, when FAIL_TASK is specified, we will fail tasks if we notice any exit code match and retry tasks if no match is found.
            "actionCondition": { # Conditions for actions to deal with task failures. # Conditions that decide why a task failure is dealt with a specific action.
              "exitCodes": [ # Exit codes of a task execution. If there are more than 1 exit codes, when task executes with any of the exit code in the list, the condition is met and the action will be executed.
                42,
              ],
            },
          },
        ],
        "maxRetryCount": 42, # Maximum number of retries on failures. The default, 0, which means never retry. The valid value range is [0, 10].
        "maxRunDuration": "A String", # 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; 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.
        "runnables": [ # Required. The sequence of one or more runnables (executable scripts, executable containers, and/or barriers) for each task in this task group to run. Each task runs this list of runnables in order. For a task to succeed, all of its script and container runnables each must meet at least one of the following conditions: + 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.
          { # Runnable describes instructions for executing a specific script or container as part of a Task.
            "alwaysRun": True or False, # 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": True or False, # 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": { # A barrier runnable automatically blocks the execution of subsequent runnables until all the tasks in the task group reach the barrier. # Barrier runnable.
              "name": "A String", # Barriers are identified by their index in runnable list. Names are not required, but if present should be an identifier.
            },
            "container": { # Container runnable. # Container runnable.
              "blockExternalNetwork": True or False, # 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": [ # 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`.
                "A String",
              ],
              "enableImageStreaming": True or False, # 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": "A String", # Required for some container images. Overrides the `ENTRYPOINT` specified in the container.
              "imageUri": "A String", # Required. The URI to pull the container image from.
              "options": "A String", # 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": "A String", # 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": "A String", # 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": [ # 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.
                "A String",
              ],
            },
            "displayName": "A String", # 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.
            "environment": { # An Environment describes a collection of environment variables to set when executing Tasks. # Environment variables for this Runnable (overrides variables set for the whole Task or TaskGroup).
              "encryptedVariables": { # An encrypted JSON dictionary where the key/value pairs correspond to environment variable names and their values.
                "cipherText": "A String", # The value of the cipherText response from the `encrypt` method.
                "keyName": "A String", # The name of the KMS key that will be used to decrypt the cipher text.
              },
              "secretVariables": { # A map of environment variable names to Secret Manager secret names. The VM will access the named secrets to set the value of each environment variable.
                "a_key": "A String",
              },
              "variables": { # A map of environment variable names to values.
                "a_key": "A String",
              },
            },
            "ignoreExitStatus": True or False, # 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.
            "labels": { # Labels for this Runnable.
              "a_key": "A String",
            },
            "script": { # Script runnable. # Script runnable.
              "path": "A String", # 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) 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": "A String", # 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) 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": "A String", # Timeout for this Runnable.
          },
        ],
        "volumes": [ # Volumes to mount before running Tasks using this TaskSpec.
          { # Volume describes a volume and parameters for it to be mounted to a VM.
            "deviceName": "A 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": { # Represents a Google Cloud Storage volume. # A Google Cloud Storage (GCS) volume.
              "remotePath": "A String", # Remote path, either a bucket name or a subdirectory of a bucket, e.g.: bucket_name, bucket_name/subdirectory/
            },
            "mountOptions": [ # 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.
              "A String",
            ],
            "mountPath": "A String", # The mount path for the volume, e.g. /mnt/disks/share.
            "nfs": { # Represents an NFS volume. # A Network File System (NFS) volume. For example, a Filestore file share.
              "remotePath": "A String", # Remote source path exported from the NFS, e.g., "/share".
              "server": "A String", # The IP address of the NFS.
            },
          },
        ],
      },
    },
  ],
  "uid": "A String", # Output only. A system generated unique ID for the Job.
  "updateTime": "A String", # Output only. The last time the Job was updated.
}

  jobId: string, ID used to uniquely identify the Job within its parent scope. This field should contain at most 63 characters and must start with lowercase characters. Only lowercase characters, numbers and '-' are accepted. The '-' character cannot be the first or the last one. A system generated ID will be used if the field is not set. The job.name field in the request will be ignored and the created resource name of the Job will be "{parent}/jobs/{job_id}".
  requestId: string, Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # The Cloud Batch Job description.
  "allocationPolicy": { # A Job's resource allocation policy describes when, where, and how compute resources should be allocated for the Job. # Compute resource allocation for all TaskGroups in the Job.
    "instances": [ # Describe instances that can be created by this AllocationPolicy. Only instances[0] is supported now.
      { # InstancePolicyOrTemplate lets you define the type of resources to use for this job either with an InstancePolicy or an instance template. If undefined, Batch picks the type of VM to use and doesn't include optional VM resources such as GPUs and extra disks.
        "blockProjectSshKeys": True or False, # 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
        "installGpuDrivers": True or False, # 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. For non Container-Optimized Image cases, following https://github.com/GoogleCloudPlatform/compute-gpu-installation/blob/main/linux/install_gpu_driver.py.
        "installOpsAgent": True or False, # Optional. Set this field true if you want Batch to install Ops Agent on your behalf. Default is false.
        "instanceTemplate": "A String", # 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": { # InstancePolicy describes an instance type and resources attached to each VM created by this InstancePolicy. # InstancePolicy.
          "accelerators": [ # The accelerators attached to each VM instance.
            { # Accelerator describes Compute Engine accelerators to be attached to the VM.
              "count": "A String", # The number of accelerators of this type.
              "driverVersion": "A String", # Optional. The NVIDIA GPU driver version that should be installed for this type. You can define the specific driver version such as "470.103.01", following the driver version requirements in https://cloud.google.com/compute/docs/gpus/install-drivers-gpu#minimum-driver. Batch will install the specific accelerator driver if qualified.
              "installGpuDrivers": True or False, # Deprecated: please use instances[0].install_gpu_drivers instead.
              "type": "A String", # The accelerator type. For example, "nvidia-tesla-t4". See `gcloud compute accelerator-types list`.
            },
          ],
          "bootDisk": { # 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. # 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.
            "diskInterface": "A String", # 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.
            "image": "A String", # 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.
            "sizeGb": "A String", # 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": "A String", # Name of a snapshot used as the data source. Snapshot is not supported as boot disk now.
            "type": "A 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". 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": [ # 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.
            { # A new or an existing persistent disk (PD) or a local ssd attached to a VM instance.
              "deviceName": "A 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": "A String", # Name of an existing PD.
              "newDisk": { # 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.
                "diskInterface": "A String", # 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.
                "image": "A String", # 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.
                "sizeGb": "A String", # 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": "A String", # Name of a snapshot used as the data source. Snapshot is not supported as boot disk now.
                "type": "A 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". 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.
              },
            },
          ],
          "machineType": "A String", # The Compute Engine machine type.
          "minCpuPlatform": "A String", # The minimum CPU platform. See https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform.
          "provisioningModel": "A String", # The provisioning model.
          "reservation": "A String", # 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.
        },
      },
    ],
    "labels": { # Custom labels to apply to the job and all the Compute Engine resources that both are created by this allocation policy and support labels. Use labels to group and describe the resources they are applied to. Batch automatically applies predefined labels and supports multiple `labels` fields for each job, which each let you apply custom labels to various resources. Label names that start with "goog-" or "google-" are reserved for predefined labels. For more information about labels with Batch, see [Organize resources using labels](https://cloud.google.com/batch/docs/organize-resources-using-labels).
      "a_key": "A String",
    },
    "location": { # Location where compute resources should be allocated for the Job.
      "allowedLocations": [ # A list of allowed location names represented by internal URLs. Each location can be a region or a zone. Only one region or multiple zones in one region is supported now. For example, ["regions/us-central1"] allow VMs in any zones in region us-central1. ["zones/us-central1-a", "zones/us-central1-c"] only allow VMs in zones us-central1-a and us-central1-c. Mixing locations from different regions would cause errors. For example, ["regions/us-central1", "zones/us-central1-a", "zones/us-central1-b", "zones/us-west1-a"] contains locations from two distinct regions: us-central1 and us-west1. This combination will trigger an error.
        "A String",
      ],
    },
    "network": { # NetworkPolicy describes VM instance network configurations. # 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.
      "networkInterfaces": [ # Network configurations.
        { # A network interface.
          "network": "A 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": True or False, # 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": "A 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}
        },
      ],
    },
    "placement": { # PlacementPolicy describes a group placement policy for the VMs controlled by this AllocationPolicy. # The placement policy.
      "collocation": "A 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": "A String", # 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
    },
    "serviceAccount": { # Carries information about a Google Cloud service account. # 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": "A String", # Email address of the service account.
      "scopes": [ # List of scopes to be enabled for this service account.
        "A String",
      ],
    },
    "tags": [ # Optional. Tags applied to the VM instances. The tags identify valid sources or targets for network firewalls. Each tag must be 1-63 characters long, and comply with [RFC1035](https://www.ietf.org/rfc/rfc1035.txt).
      "A String",
    ],
  },
  "createTime": "A String", # Output only. When the Job was created.
  "labels": { # Custom labels to apply to the job and any Cloud Logging [LogEntry](https://cloud.google.com/logging/docs/reference/v2/rest/v2/LogEntry) that it generates. Use labels to group and describe the resources they are applied to. Batch automatically applies predefined labels and supports multiple `labels` fields for each job, which each let you apply custom labels to various resources. Label names that start with "goog-" or "google-" are reserved for predefined labels. For more information about labels with Batch, see [Organize resources using labels](https://cloud.google.com/batch/docs/organize-resources-using-labels).
    "a_key": "A String",
  },
  "logsPolicy": { # LogsPolicy describes if and how a job's logs are preserved. Logs include information that is automatically written by the Batch service agent and any information that you configured the job's runnables to write to the `stdout` or `stderr` streams. # Log preservation policy for the Job.
    "cloudLoggingOption": { # `CloudLoggingOption` contains additional settings for Cloud Logging logs generated by Batch job. # Optional. When `destination` is set to `CLOUD_LOGGING`, you can optionally set this field to configure additional settings for Cloud Logging.
      "useGenericTaskMonitoredResource": True or False, # 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": "A String", # If and where logs should be saved.
    "logsPath": "A String", # 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": "A String", # Output only. Job name. For example: "projects/123456/locations/us-central1/jobs/job01".
  "notifications": [ # Notification configurations.
    { # Notification configurations.
      "message": { # Message details. Describe the conditions under which messages will be sent. If no attribute is defined, no message will be sent by default. One message should specify either the job or the task level attributes, but not both. For example, job level: JOB_STATE_CHANGED and/or a specified new_job_state; task level: TASK_STATE_CHANGED and/or a specified new_task_state. # The attribute requirements of messages to be sent to this Pub/Sub topic. Without this field, no message will be sent.
        "newJobState": "A String", # The new job state.
        "newTaskState": "A String", # The new task state.
        "type": "A String", # The message type.
      },
      "pubsubTopic": "A String", # 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.
    },
  ],
  "priority": "A String", # 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": { # Job status. # Output only. Job status. It is read only for users.
    "runDuration": "A String", # The duration of time that the Job spent in status RUNNING.
    "state": "A String", # Job state
    "statusEvents": [ # Job status events
      { # Status event.
        "description": "A String", # Description of the event.
        "eventTime": "A String", # The time this event occurred.
        "taskExecution": { # This Task Execution field includes detail information for task execution procedures, based on StatusEvent types. # Task Execution. This field is only defined for task-level status events where the task fails.
          "exitCode": 42, # 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. * Batch runnable execution failures; you can rely on Batch logs to further diagnose: https://cloud.google.com/batch/docs/analyze-job-using-logs. If there are multiple runnables failures, Batch only exposes the first error.
        },
        "taskState": "A String", # Task State. This field is only defined for task-level status events.
        "type": "A String", # Type of the event.
      },
    ],
    "taskGroups": { # Aggregated task status for each TaskGroup in the Job. The map key is TaskGroup ID.
      "a_key": { # Aggregated task status for a TaskGroup.
        "counts": { # Count of task in each state in the TaskGroup. The map key is task state name.
          "a_key": "A String",
        },
        "instances": [ # Status of instances allocated for the TaskGroup.
          { # VM instance status.
            "bootDisk": { # 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. # The VM boot disk.
              "diskInterface": "A String", # 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.
              "image": "A String", # 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.
              "sizeGb": "A String", # 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": "A String", # Name of a snapshot used as the data source. Snapshot is not supported as boot disk now.
              "type": "A 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". 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.
            },
            "machineType": "A String", # The Compute Engine machine type.
            "provisioningModel": "A String", # The VM instance provisioning model.
            "taskPack": "A String", # The max number of tasks can be assigned to this instance type.
          },
        ],
      },
    },
  },
  "taskGroups": [ # Required. TaskGroups in the Job. Only one TaskGroup is supported now.
    { # A TaskGroup defines one or more Tasks that all share the same TaskSpec.
      "name": "A 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": "A String", # 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.
      "permissiveSsh": True or False, # When true, Batch will configure SSH to allow passwordless login between VMs running the Batch tasks in the same TaskGroup.
      "requireHostsFile": True or False, # 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.
      "runAsNonRoot": True or False, # 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).
      "schedulingPolicy": "A String", # Scheduling policy for Tasks in the TaskGroup. The default value is AS_SOON_AS_POSSIBLE.
      "taskCount": "A String", # Number of Tasks in the TaskGroup. Default is 1.
      "taskCountPerNode": "A String", # 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": [ # 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).
        { # An Environment describes a collection of environment variables to set when executing Tasks.
          "encryptedVariables": { # An encrypted JSON dictionary where the key/value pairs correspond to environment variable names and their values.
            "cipherText": "A String", # The value of the cipherText response from the `encrypt` method.
            "keyName": "A String", # The name of the KMS key that will be used to decrypt the cipher text.
          },
          "secretVariables": { # A map of environment variable names to Secret Manager secret names. The VM will access the named secrets to set the value of each environment variable.
            "a_key": "A String",
          },
          "variables": { # A map of environment variable names to values.
            "a_key": "A String",
          },
        },
      ],
      "taskSpec": { # Spec of a task # Required. Tasks in the group share the same task spec.
        "computeResource": { # Compute resource requirements. ComputeResource defines the amount of resources required for each task. Make sure your tasks have enough resources to successfully run. If you also define the types of resources for a job to use with the [InstancePolicyOrTemplate](https://cloud.google.com/batch/docs/reference/rest/v1/projects.locations.jobs#instancepolicyortemplate) field, make sure both fields are compatible with each other. # ComputeResource requirements.
          "bootDiskMib": "A String", # Extra boot disk size in MiB for each task.
          "cpuMilli": "A String", # 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.
          "memoryMib": "A String", # 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": { # An Environment describes a collection of environment variables to set when executing Tasks. # Environment variables to set before running the Task.
          "encryptedVariables": { # An encrypted JSON dictionary where the key/value pairs correspond to environment variable names and their values.
            "cipherText": "A String", # The value of the cipherText response from the `encrypt` method.
            "keyName": "A String", # The name of the KMS key that will be used to decrypt the cipher text.
          },
          "secretVariables": { # A map of environment variable names to Secret Manager secret names. The VM will access the named secrets to set the value of each environment variable.
            "a_key": "A String",
          },
          "variables": { # A map of environment variable names to values.
            "a_key": "A String",
          },
        },
        "environments": { # Deprecated: please use environment(non-plural) instead.
          "a_key": "A String",
        },
        "lifecyclePolicies": [ # Lifecycle management schema when any task in a task group is failed. Currently we only support one lifecycle policy. When the lifecycle policy condition is met, the action in the policy will execute. If task execution result does not meet with the defined lifecycle policy, we consider it as the default policy. Default policy means if the exit code is 0, exit task. If task ends with non-zero exit code, retry the task with max_retry_count.
          { # LifecyclePolicy describes how to deal with task failures based on different conditions.
            "action": "A String", # Action to execute when ActionCondition is true. When RETRY_TASK is specified, we will retry failed tasks if we notice any exit code match and fail tasks if no match is found. Likewise, when FAIL_TASK is specified, we will fail tasks if we notice any exit code match and retry tasks if no match is found.
            "actionCondition": { # Conditions for actions to deal with task failures. # Conditions that decide why a task failure is dealt with a specific action.
              "exitCodes": [ # Exit codes of a task execution. If there are more than 1 exit codes, when task executes with any of the exit code in the list, the condition is met and the action will be executed.
                42,
              ],
            },
          },
        ],
        "maxRetryCount": 42, # Maximum number of retries on failures. The default, 0, which means never retry. The valid value range is [0, 10].
        "maxRunDuration": "A String", # 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; 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.
        "runnables": [ # Required. The sequence of one or more runnables (executable scripts, executable containers, and/or barriers) for each task in this task group to run. Each task runs this list of runnables in order. For a task to succeed, all of its script and container runnables each must meet at least one of the following conditions: + 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.
          { # Runnable describes instructions for executing a specific script or container as part of a Task.
            "alwaysRun": True or False, # 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": True or False, # 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": { # A barrier runnable automatically blocks the execution of subsequent runnables until all the tasks in the task group reach the barrier. # Barrier runnable.
              "name": "A String", # Barriers are identified by their index in runnable list. Names are not required, but if present should be an identifier.
            },
            "container": { # Container runnable. # Container runnable.
              "blockExternalNetwork": True or False, # 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": [ # 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`.
                "A String",
              ],
              "enableImageStreaming": True or False, # 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": "A String", # Required for some container images. Overrides the `ENTRYPOINT` specified in the container.
              "imageUri": "A String", # Required. The URI to pull the container image from.
              "options": "A String", # 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": "A String", # 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": "A String", # 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": [ # 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.
                "A String",
              ],
            },
            "displayName": "A String", # 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.
            "environment": { # An Environment describes a collection of environment variables to set when executing Tasks. # Environment variables for this Runnable (overrides variables set for the whole Task or TaskGroup).
              "encryptedVariables": { # An encrypted JSON dictionary where the key/value pairs correspond to environment variable names and their values.
                "cipherText": "A String", # The value of the cipherText response from the `encrypt` method.
                "keyName": "A String", # The name of the KMS key that will be used to decrypt the cipher text.
              },
              "secretVariables": { # A map of environment variable names to Secret Manager secret names. The VM will access the named secrets to set the value of each environment variable.
                "a_key": "A String",
              },
              "variables": { # A map of environment variable names to values.
                "a_key": "A String",
              },
            },
            "ignoreExitStatus": True or False, # 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.
            "labels": { # Labels for this Runnable.
              "a_key": "A String",
            },
            "script": { # Script runnable. # Script runnable.
              "path": "A String", # 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) 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": "A String", # 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) 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": "A String", # Timeout for this Runnable.
          },
        ],
        "volumes": [ # Volumes to mount before running Tasks using this TaskSpec.
          { # Volume describes a volume and parameters for it to be mounted to a VM.
            "deviceName": "A 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": { # Represents a Google Cloud Storage volume. # A Google Cloud Storage (GCS) volume.
              "remotePath": "A String", # Remote path, either a bucket name or a subdirectory of a bucket, e.g.: bucket_name, bucket_name/subdirectory/
            },
            "mountOptions": [ # 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.
              "A String",
            ],
            "mountPath": "A String", # The mount path for the volume, e.g. /mnt/disks/share.
            "nfs": { # Represents an NFS volume. # A Network File System (NFS) volume. For example, a Filestore file share.
              "remotePath": "A String", # Remote source path exported from the NFS, e.g., "/share".
              "server": "A String", # The IP address of the NFS.
            },
          },
        ],
      },
    },
  ],
  "uid": "A String", # Output only. A system generated unique ID for the Job.
  "updateTime": "A String", # Output only. The last time the Job was updated.
}

delete(name, reason=None, requestId=None, x__xgafv=None)

Delete a Job.

Args:
  name: string, Job name. (required)
  reason: string, Optional. Reason for this deletion.
  requestId: string, Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # This resource represents a long-running operation that is the result of a network API call.
  "done": True or False, # 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": { # 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](https://github.com/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](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
      {
        "a_key": "", # Properties of the object. Contains field @type with type URL.
      },
    ],
    "message": "A 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.
  },
  "metadata": { # 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.
    "a_key": "", # Properties of the object. Contains field @type with type URL.
  },
  "name": "A 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": { # The normal, successful response of the operation. 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`.
    "a_key": "", # Properties of the object. Contains field @type with type URL.
  },
}

get(name, x__xgafv=None)

Get a Job specified by its resource name.

Args:
  name: string, Required. Job name. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # The Cloud Batch Job description.
  "allocationPolicy": { # A Job's resource allocation policy describes when, where, and how compute resources should be allocated for the Job. # Compute resource allocation for all TaskGroups in the Job.
    "instances": [ # Describe instances that can be created by this AllocationPolicy. Only instances[0] is supported now.
      { # InstancePolicyOrTemplate lets you define the type of resources to use for this job either with an InstancePolicy or an instance template. If undefined, Batch picks the type of VM to use and doesn't include optional VM resources such as GPUs and extra disks.
        "blockProjectSshKeys": True or False, # 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
        "installGpuDrivers": True or False, # 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. For non Container-Optimized Image cases, following https://github.com/GoogleCloudPlatform/compute-gpu-installation/blob/main/linux/install_gpu_driver.py.
        "installOpsAgent": True or False, # Optional. Set this field true if you want Batch to install Ops Agent on your behalf. Default is false.
        "instanceTemplate": "A String", # 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": { # InstancePolicy describes an instance type and resources attached to each VM created by this InstancePolicy. # InstancePolicy.
          "accelerators": [ # The accelerators attached to each VM instance.
            { # Accelerator describes Compute Engine accelerators to be attached to the VM.
              "count": "A String", # The number of accelerators of this type.
              "driverVersion": "A String", # Optional. The NVIDIA GPU driver version that should be installed for this type. You can define the specific driver version such as "470.103.01", following the driver version requirements in https://cloud.google.com/compute/docs/gpus/install-drivers-gpu#minimum-driver. Batch will install the specific accelerator driver if qualified.
              "installGpuDrivers": True or False, # Deprecated: please use instances[0].install_gpu_drivers instead.
              "type": "A String", # The accelerator type. For example, "nvidia-tesla-t4". See `gcloud compute accelerator-types list`.
            },
          ],
          "bootDisk": { # 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. # 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.
            "diskInterface": "A String", # 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.
            "image": "A String", # 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.
            "sizeGb": "A String", # 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": "A String", # Name of a snapshot used as the data source. Snapshot is not supported as boot disk now.
            "type": "A 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". 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": [ # 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.
            { # A new or an existing persistent disk (PD) or a local ssd attached to a VM instance.
              "deviceName": "A 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": "A String", # Name of an existing PD.
              "newDisk": { # 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.
                "diskInterface": "A String", # 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.
                "image": "A String", # 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.
                "sizeGb": "A String", # 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": "A String", # Name of a snapshot used as the data source. Snapshot is not supported as boot disk now.
                "type": "A 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". 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.
              },
            },
          ],
          "machineType": "A String", # The Compute Engine machine type.
          "minCpuPlatform": "A String", # The minimum CPU platform. See https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform.
          "provisioningModel": "A String", # The provisioning model.
          "reservation": "A String", # 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.
        },
      },
    ],
    "labels": { # Custom labels to apply to the job and all the Compute Engine resources that both are created by this allocation policy and support labels. Use labels to group and describe the resources they are applied to. Batch automatically applies predefined labels and supports multiple `labels` fields for each job, which each let you apply custom labels to various resources. Label names that start with "goog-" or "google-" are reserved for predefined labels. For more information about labels with Batch, see [Organize resources using labels](https://cloud.google.com/batch/docs/organize-resources-using-labels).
      "a_key": "A String",
    },
    "location": { # Location where compute resources should be allocated for the Job.
      "allowedLocations": [ # A list of allowed location names represented by internal URLs. Each location can be a region or a zone. Only one region or multiple zones in one region is supported now. For example, ["regions/us-central1"] allow VMs in any zones in region us-central1. ["zones/us-central1-a", "zones/us-central1-c"] only allow VMs in zones us-central1-a and us-central1-c. Mixing locations from different regions would cause errors. For example, ["regions/us-central1", "zones/us-central1-a", "zones/us-central1-b", "zones/us-west1-a"] contains locations from two distinct regions: us-central1 and us-west1. This combination will trigger an error.
        "A String",
      ],
    },
    "network": { # NetworkPolicy describes VM instance network configurations. # 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.
      "networkInterfaces": [ # Network configurations.
        { # A network interface.
          "network": "A 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": True or False, # 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": "A 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}
        },
      ],
    },
    "placement": { # PlacementPolicy describes a group placement policy for the VMs controlled by this AllocationPolicy. # The placement policy.
      "collocation": "A 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": "A String", # 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
    },
    "serviceAccount": { # Carries information about a Google Cloud service account. # 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": "A String", # Email address of the service account.
      "scopes": [ # List of scopes to be enabled for this service account.
        "A String",
      ],
    },
    "tags": [ # Optional. Tags applied to the VM instances. The tags identify valid sources or targets for network firewalls. Each tag must be 1-63 characters long, and comply with [RFC1035](https://www.ietf.org/rfc/rfc1035.txt).
      "A String",
    ],
  },
  "createTime": "A String", # Output only. When the Job was created.
  "labels": { # Custom labels to apply to the job and any Cloud Logging [LogEntry](https://cloud.google.com/logging/docs/reference/v2/rest/v2/LogEntry) that it generates. Use labels to group and describe the resources they are applied to. Batch automatically applies predefined labels and supports multiple `labels` fields for each job, which each let you apply custom labels to various resources. Label names that start with "goog-" or "google-" are reserved for predefined labels. For more information about labels with Batch, see [Organize resources using labels](https://cloud.google.com/batch/docs/organize-resources-using-labels).
    "a_key": "A String",
  },
  "logsPolicy": { # LogsPolicy describes if and how a job's logs are preserved. Logs include information that is automatically written by the Batch service agent and any information that you configured the job's runnables to write to the `stdout` or `stderr` streams. # Log preservation policy for the Job.
    "cloudLoggingOption": { # `CloudLoggingOption` contains additional settings for Cloud Logging logs generated by Batch job. # Optional. When `destination` is set to `CLOUD_LOGGING`, you can optionally set this field to configure additional settings for Cloud Logging.
      "useGenericTaskMonitoredResource": True or False, # 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": "A String", # If and where logs should be saved.
    "logsPath": "A String", # 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": "A String", # Output only. Job name. For example: "projects/123456/locations/us-central1/jobs/job01".
  "notifications": [ # Notification configurations.
    { # Notification configurations.
      "message": { # Message details. Describe the conditions under which messages will be sent. If no attribute is defined, no message will be sent by default. One message should specify either the job or the task level attributes, but not both. For example, job level: JOB_STATE_CHANGED and/or a specified new_job_state; task level: TASK_STATE_CHANGED and/or a specified new_task_state. # The attribute requirements of messages to be sent to this Pub/Sub topic. Without this field, no message will be sent.
        "newJobState": "A String", # The new job state.
        "newTaskState": "A String", # The new task state.
        "type": "A String", # The message type.
      },
      "pubsubTopic": "A String", # 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.
    },
  ],
  "priority": "A String", # 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": { # Job status. # Output only. Job status. It is read only for users.
    "runDuration": "A String", # The duration of time that the Job spent in status RUNNING.
    "state": "A String", # Job state
    "statusEvents": [ # Job status events
      { # Status event.
        "description": "A String", # Description of the event.
        "eventTime": "A String", # The time this event occurred.
        "taskExecution": { # This Task Execution field includes detail information for task execution procedures, based on StatusEvent types. # Task Execution. This field is only defined for task-level status events where the task fails.
          "exitCode": 42, # 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. * Batch runnable execution failures; you can rely on Batch logs to further diagnose: https://cloud.google.com/batch/docs/analyze-job-using-logs. If there are multiple runnables failures, Batch only exposes the first error.
        },
        "taskState": "A String", # Task State. This field is only defined for task-level status events.
        "type": "A String", # Type of the event.
      },
    ],
    "taskGroups": { # Aggregated task status for each TaskGroup in the Job. The map key is TaskGroup ID.
      "a_key": { # Aggregated task status for a TaskGroup.
        "counts": { # Count of task in each state in the TaskGroup. The map key is task state name.
          "a_key": "A String",
        },
        "instances": [ # Status of instances allocated for the TaskGroup.
          { # VM instance status.
            "bootDisk": { # 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. # The VM boot disk.
              "diskInterface": "A String", # 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.
              "image": "A String", # 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.
              "sizeGb": "A String", # 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": "A String", # Name of a snapshot used as the data source. Snapshot is not supported as boot disk now.
              "type": "A 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". 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.
            },
            "machineType": "A String", # The Compute Engine machine type.
            "provisioningModel": "A String", # The VM instance provisioning model.
            "taskPack": "A String", # The max number of tasks can be assigned to this instance type.
          },
        ],
      },
    },
  },
  "taskGroups": [ # Required. TaskGroups in the Job. Only one TaskGroup is supported now.
    { # A TaskGroup defines one or more Tasks that all share the same TaskSpec.
      "name": "A 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": "A String", # 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.
      "permissiveSsh": True or False, # When true, Batch will configure SSH to allow passwordless login between VMs running the Batch tasks in the same TaskGroup.
      "requireHostsFile": True or False, # 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.
      "runAsNonRoot": True or False, # 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).
      "schedulingPolicy": "A String", # Scheduling policy for Tasks in the TaskGroup. The default value is AS_SOON_AS_POSSIBLE.
      "taskCount": "A String", # Number of Tasks in the TaskGroup. Default is 1.
      "taskCountPerNode": "A String", # 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": [ # 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).
        { # An Environment describes a collection of environment variables to set when executing Tasks.
          "encryptedVariables": { # An encrypted JSON dictionary where the key/value pairs correspond to environment variable names and their values.
            "cipherText": "A String", # The value of the cipherText response from the `encrypt` method.
            "keyName": "A String", # The name of the KMS key that will be used to decrypt the cipher text.
          },
          "secretVariables": { # A map of environment variable names to Secret Manager secret names. The VM will access the named secrets to set the value of each environment variable.
            "a_key": "A String",
          },
          "variables": { # A map of environment variable names to values.
            "a_key": "A String",
          },
        },
      ],
      "taskSpec": { # Spec of a task # Required. Tasks in the group share the same task spec.
        "computeResource": { # Compute resource requirements. ComputeResource defines the amount of resources required for each task. Make sure your tasks have enough resources to successfully run. If you also define the types of resources for a job to use with the [InstancePolicyOrTemplate](https://cloud.google.com/batch/docs/reference/rest/v1/projects.locations.jobs#instancepolicyortemplate) field, make sure both fields are compatible with each other. # ComputeResource requirements.
          "bootDiskMib": "A String", # Extra boot disk size in MiB for each task.
          "cpuMilli": "A String", # 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.
          "memoryMib": "A String", # 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": { # An Environment describes a collection of environment variables to set when executing Tasks. # Environment variables to set before running the Task.
          "encryptedVariables": { # An encrypted JSON dictionary where the key/value pairs correspond to environment variable names and their values.
            "cipherText": "A String", # The value of the cipherText response from the `encrypt` method.
            "keyName": "A String", # The name of the KMS key that will be used to decrypt the cipher text.
          },
          "secretVariables": { # A map of environment variable names to Secret Manager secret names. The VM will access the named secrets to set the value of each environment variable.
            "a_key": "A String",
          },
          "variables": { # A map of environment variable names to values.
            "a_key": "A String",
          },
        },
        "environments": { # Deprecated: please use environment(non-plural) instead.
          "a_key": "A String",
        },
        "lifecyclePolicies": [ # Lifecycle management schema when any task in a task group is failed. Currently we only support one lifecycle policy. When the lifecycle policy condition is met, the action in the policy will execute. If task execution result does not meet with the defined lifecycle policy, we consider it as the default policy. Default policy means if the exit code is 0, exit task. If task ends with non-zero exit code, retry the task with max_retry_count.
          { # LifecyclePolicy describes how to deal with task failures based on different conditions.
            "action": "A String", # Action to execute when ActionCondition is true. When RETRY_TASK is specified, we will retry failed tasks if we notice any exit code match and fail tasks if no match is found. Likewise, when FAIL_TASK is specified, we will fail tasks if we notice any exit code match and retry tasks if no match is found.
            "actionCondition": { # Conditions for actions to deal with task failures. # Conditions that decide why a task failure is dealt with a specific action.
              "exitCodes": [ # Exit codes of a task execution. If there are more than 1 exit codes, when task executes with any of the exit code in the list, the condition is met and the action will be executed.
                42,
              ],
            },
          },
        ],
        "maxRetryCount": 42, # Maximum number of retries on failures. The default, 0, which means never retry. The valid value range is [0, 10].
        "maxRunDuration": "A String", # 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; 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.
        "runnables": [ # Required. The sequence of one or more runnables (executable scripts, executable containers, and/or barriers) for each task in this task group to run. Each task runs this list of runnables in order. For a task to succeed, all of its script and container runnables each must meet at least one of the following conditions: + 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.
          { # Runnable describes instructions for executing a specific script or container as part of a Task.
            "alwaysRun": True or False, # 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": True or False, # 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": { # A barrier runnable automatically blocks the execution of subsequent runnables until all the tasks in the task group reach the barrier. # Barrier runnable.
              "name": "A String", # Barriers are identified by their index in runnable list. Names are not required, but if present should be an identifier.
            },
            "container": { # Container runnable. # Container runnable.
              "blockExternalNetwork": True or False, # 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": [ # 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`.
                "A String",
              ],
              "enableImageStreaming": True or False, # 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": "A String", # Required for some container images. Overrides the `ENTRYPOINT` specified in the container.
              "imageUri": "A String", # Required. The URI to pull the container image from.
              "options": "A String", # 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": "A String", # 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": "A String", # 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": [ # 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.
                "A String",
              ],
            },
            "displayName": "A String", # 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.
            "environment": { # An Environment describes a collection of environment variables to set when executing Tasks. # Environment variables for this Runnable (overrides variables set for the whole Task or TaskGroup).
              "encryptedVariables": { # An encrypted JSON dictionary where the key/value pairs correspond to environment variable names and their values.
                "cipherText": "A String", # The value of the cipherText response from the `encrypt` method.
                "keyName": "A String", # The name of the KMS key that will be used to decrypt the cipher text.
              },
              "secretVariables": { # A map of environment variable names to Secret Manager secret names. The VM will access the named secrets to set the value of each environment variable.
                "a_key": "A String",
              },
              "variables": { # A map of environment variable names to values.
                "a_key": "A String",
              },
            },
            "ignoreExitStatus": True or False, # 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.
            "labels": { # Labels for this Runnable.
              "a_key": "A String",
            },
            "script": { # Script runnable. # Script runnable.
              "path": "A String", # 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) 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": "A String", # 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) 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": "A String", # Timeout for this Runnable.
          },
        ],
        "volumes": [ # Volumes to mount before running Tasks using this TaskSpec.
          { # Volume describes a volume and parameters for it to be mounted to a VM.
            "deviceName": "A 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": { # Represents a Google Cloud Storage volume. # A Google Cloud Storage (GCS) volume.
              "remotePath": "A String", # Remote path, either a bucket name or a subdirectory of a bucket, e.g.: bucket_name, bucket_name/subdirectory/
            },
            "mountOptions": [ # 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.
              "A String",
            ],
            "mountPath": "A String", # The mount path for the volume, e.g. /mnt/disks/share.
            "nfs": { # Represents an NFS volume. # A Network File System (NFS) volume. For example, a Filestore file share.
              "remotePath": "A String", # Remote source path exported from the NFS, e.g., "/share".
              "server": "A String", # The IP address of the NFS.
            },
          },
        ],
      },
    },
  ],
  "uid": "A String", # Output only. A system generated unique ID for the Job.
  "updateTime": "A String", # Output only. The last time the Job was updated.
}

list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)

List all Jobs for a project within a region.

Args:
  parent: string, Parent path. (required)
  filter: string, List filter.
  orderBy: string, Optional. Sort results. Supported are "name", "name desc", "create_time", and "create_time desc".
  pageSize: integer, Page size.
  pageToken: string, Page token.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # ListJob Response.
  "jobs": [ # Jobs.
    { # The Cloud Batch Job description.
      "allocationPolicy": { # A Job's resource allocation policy describes when, where, and how compute resources should be allocated for the Job. # Compute resource allocation for all TaskGroups in the Job.
        "instances": [ # Describe instances that can be created by this AllocationPolicy. Only instances[0] is supported now.
          { # InstancePolicyOrTemplate lets you define the type of resources to use for this job either with an InstancePolicy or an instance template. If undefined, Batch picks the type of VM to use and doesn't include optional VM resources such as GPUs and extra disks.
            "blockProjectSshKeys": True or False, # 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
            "installGpuDrivers": True or False, # 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. For non Container-Optimized Image cases, following https://github.com/GoogleCloudPlatform/compute-gpu-installation/blob/main/linux/install_gpu_driver.py.
            "installOpsAgent": True or False, # Optional. Set this field true if you want Batch to install Ops Agent on your behalf. Default is false.
            "instanceTemplate": "A String", # 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": { # InstancePolicy describes an instance type and resources attached to each VM created by this InstancePolicy. # InstancePolicy.
              "accelerators": [ # The accelerators attached to each VM instance.
                { # Accelerator describes Compute Engine accelerators to be attached to the VM.
                  "count": "A String", # The number of accelerators of this type.
                  "driverVersion": "A String", # Optional. The NVIDIA GPU driver version that should be installed for this type. You can define the specific driver version such as "470.103.01", following the driver version requirements in https://cloud.google.com/compute/docs/gpus/install-drivers-gpu#minimum-driver. Batch will install the specific accelerator driver if qualified.
                  "installGpuDrivers": True or False, # Deprecated: please use instances[0].install_gpu_drivers instead.
                  "type": "A String", # The accelerator type. For example, "nvidia-tesla-t4". See `gcloud compute accelerator-types list`.
                },
              ],
              "bootDisk": { # 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. # 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.
                "diskInterface": "A String", # 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.
                "image": "A String", # 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.
                "sizeGb": "A String", # 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": "A String", # Name of a snapshot used as the data source. Snapshot is not supported as boot disk now.
                "type": "A 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". 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": [ # 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.
                { # A new or an existing persistent disk (PD) or a local ssd attached to a VM instance.
                  "deviceName": "A 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": "A String", # Name of an existing PD.
                  "newDisk": { # 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.
                    "diskInterface": "A String", # 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.
                    "image": "A String", # 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.
                    "sizeGb": "A String", # 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": "A String", # Name of a snapshot used as the data source. Snapshot is not supported as boot disk now.
                    "type": "A 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". 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.
                  },
                },
              ],
              "machineType": "A String", # The Compute Engine machine type.
              "minCpuPlatform": "A String", # The minimum CPU platform. See https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform.
              "provisioningModel": "A String", # The provisioning model.
              "reservation": "A String", # 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.
            },
          },
        ],
        "labels": { # Custom labels to apply to the job and all the Compute Engine resources that both are created by this allocation policy and support labels. Use labels to group and describe the resources they are applied to. Batch automatically applies predefined labels and supports multiple `labels` fields for each job, which each let you apply custom labels to various resources. Label names that start with "goog-" or "google-" are reserved for predefined labels. For more information about labels with Batch, see [Organize resources using labels](https://cloud.google.com/batch/docs/organize-resources-using-labels).
          "a_key": "A String",
        },
        "location": { # Location where compute resources should be allocated for the Job.
          "allowedLocations": [ # A list of allowed location names represented by internal URLs. Each location can be a region or a zone. Only one region or multiple zones in one region is supported now. For example, ["regions/us-central1"] allow VMs in any zones in region us-central1. ["zones/us-central1-a", "zones/us-central1-c"] only allow VMs in zones us-central1-a and us-central1-c. Mixing locations from different regions would cause errors. For example, ["regions/us-central1", "zones/us-central1-a", "zones/us-central1-b", "zones/us-west1-a"] contains locations from two distinct regions: us-central1 and us-west1. This combination will trigger an error.
            "A String",
          ],
        },
        "network": { # NetworkPolicy describes VM instance network configurations. # 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.
          "networkInterfaces": [ # Network configurations.
            { # A network interface.
              "network": "A 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": True or False, # 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": "A 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}
            },
          ],
        },
        "placement": { # PlacementPolicy describes a group placement policy for the VMs controlled by this AllocationPolicy. # The placement policy.
          "collocation": "A 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": "A String", # 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
        },
        "serviceAccount": { # Carries information about a Google Cloud service account. # 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": "A String", # Email address of the service account.
          "scopes": [ # List of scopes to be enabled for this service account.
            "A String",
          ],
        },
        "tags": [ # Optional. Tags applied to the VM instances. The tags identify valid sources or targets for network firewalls. Each tag must be 1-63 characters long, and comply with [RFC1035](https://www.ietf.org/rfc/rfc1035.txt).
          "A String",
        ],
      },
      "createTime": "A String", # Output only. When the Job was created.
      "labels": { # Custom labels to apply to the job and any Cloud Logging [LogEntry](https://cloud.google.com/logging/docs/reference/v2/rest/v2/LogEntry) that it generates. Use labels to group and describe the resources they are applied to. Batch automatically applies predefined labels and supports multiple `labels` fields for each job, which each let you apply custom labels to various resources. Label names that start with "goog-" or "google-" are reserved for predefined labels. For more information about labels with Batch, see [Organize resources using labels](https://cloud.google.com/batch/docs/organize-resources-using-labels).
        "a_key": "A String",
      },
      "logsPolicy": { # LogsPolicy describes if and how a job's logs are preserved. Logs include information that is automatically written by the Batch service agent and any information that you configured the job's runnables to write to the `stdout` or `stderr` streams. # Log preservation policy for the Job.
        "cloudLoggingOption": { # `CloudLoggingOption` contains additional settings for Cloud Logging logs generated by Batch job. # Optional. When `destination` is set to `CLOUD_LOGGING`, you can optionally set this field to configure additional settings for Cloud Logging.
          "useGenericTaskMonitoredResource": True or False, # 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": "A String", # If and where logs should be saved.
        "logsPath": "A String", # 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": "A String", # Output only. Job name. For example: "projects/123456/locations/us-central1/jobs/job01".
      "notifications": [ # Notification configurations.
        { # Notification configurations.
          "message": { # Message details. Describe the conditions under which messages will be sent. If no attribute is defined, no message will be sent by default. One message should specify either the job or the task level attributes, but not both. For example, job level: JOB_STATE_CHANGED and/or a specified new_job_state; task level: TASK_STATE_CHANGED and/or a specified new_task_state. # The attribute requirements of messages to be sent to this Pub/Sub topic. Without this field, no message will be sent.
            "newJobState": "A String", # The new job state.
            "newTaskState": "A String", # The new task state.
            "type": "A String", # The message type.
          },
          "pubsubTopic": "A String", # 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.
        },
      ],
      "priority": "A String", # 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": { # Job status. # Output only. Job status. It is read only for users.
        "runDuration": "A String", # The duration of time that the Job spent in status RUNNING.
        "state": "A String", # Job state
        "statusEvents": [ # Job status events
          { # Status event.
            "description": "A String", # Description of the event.
            "eventTime": "A String", # The time this event occurred.
            "taskExecution": { # This Task Execution field includes detail information for task execution procedures, based on StatusEvent types. # Task Execution. This field is only defined for task-level status events where the task fails.
              "exitCode": 42, # 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. * Batch runnable execution failures; you can rely on Batch logs to further diagnose: https://cloud.google.com/batch/docs/analyze-job-using-logs. If there are multiple runnables failures, Batch only exposes the first error.
            },
            "taskState": "A String", # Task State. This field is only defined for task-level status events.
            "type": "A String", # Type of the event.
          },
        ],
        "taskGroups": { # Aggregated task status for each TaskGroup in the Job. The map key is TaskGroup ID.
          "a_key": { # Aggregated task status for a TaskGroup.
            "counts": { # Count of task in each state in the TaskGroup. The map key is task state name.
              "a_key": "A String",
            },
            "instances": [ # Status of instances allocated for the TaskGroup.
              { # VM instance status.
                "bootDisk": { # 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. # The VM boot disk.
                  "diskInterface": "A String", # 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.
                  "image": "A String", # 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.
                  "sizeGb": "A String", # 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": "A String", # Name of a snapshot used as the data source. Snapshot is not supported as boot disk now.
                  "type": "A 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". 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.
                },
                "machineType": "A String", # The Compute Engine machine type.
                "provisioningModel": "A String", # The VM instance provisioning model.
                "taskPack": "A String", # The max number of tasks can be assigned to this instance type.
              },
            ],
          },
        },
      },
      "taskGroups": [ # Required. TaskGroups in the Job. Only one TaskGroup is supported now.
        { # A TaskGroup defines one or more Tasks that all share the same TaskSpec.
          "name": "A 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": "A String", # 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.
          "permissiveSsh": True or False, # When true, Batch will configure SSH to allow passwordless login between VMs running the Batch tasks in the same TaskGroup.
          "requireHostsFile": True or False, # 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.
          "runAsNonRoot": True or False, # 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).
          "schedulingPolicy": "A String", # Scheduling policy for Tasks in the TaskGroup. The default value is AS_SOON_AS_POSSIBLE.
          "taskCount": "A String", # Number of Tasks in the TaskGroup. Default is 1.
          "taskCountPerNode": "A String", # 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": [ # 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).
            { # An Environment describes a collection of environment variables to set when executing Tasks.
              "encryptedVariables": { # An encrypted JSON dictionary where the key/value pairs correspond to environment variable names and their values.
                "cipherText": "A String", # The value of the cipherText response from the `encrypt` method.
                "keyName": "A String", # The name of the KMS key that will be used to decrypt the cipher text.
              },
              "secretVariables": { # A map of environment variable names to Secret Manager secret names. The VM will access the named secrets to set the value of each environment variable.
                "a_key": "A String",
              },
              "variables": { # A map of environment variable names to values.
                "a_key": "A String",
              },
            },
          ],
          "taskSpec": { # Spec of a task # Required. Tasks in the group share the same task spec.
            "computeResource": { # Compute resource requirements. ComputeResource defines the amount of resources required for each task. Make sure your tasks have enough resources to successfully run. If you also define the types of resources for a job to use with the [InstancePolicyOrTemplate](https://cloud.google.com/batch/docs/reference/rest/v1/projects.locations.jobs#instancepolicyortemplate) field, make sure both fields are compatible with each other. # ComputeResource requirements.
              "bootDiskMib": "A String", # Extra boot disk size in MiB for each task.
              "cpuMilli": "A String", # 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.
              "memoryMib": "A String", # 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": { # An Environment describes a collection of environment variables to set when executing Tasks. # Environment variables to set before running the Task.
              "encryptedVariables": { # An encrypted JSON dictionary where the key/value pairs correspond to environment variable names and their values.
                "cipherText": "A String", # The value of the cipherText response from the `encrypt` method.
                "keyName": "A String", # The name of the KMS key that will be used to decrypt the cipher text.
              },
              "secretVariables": { # A map of environment variable names to Secret Manager secret names. The VM will access the named secrets to set the value of each environment variable.
                "a_key": "A String",
              },
              "variables": { # A map of environment variable names to values.
                "a_key": "A String",
              },
            },
            "environments": { # Deprecated: please use environment(non-plural) instead.
              "a_key": "A String",
            },
            "lifecyclePolicies": [ # Lifecycle management schema when any task in a task group is failed. Currently we only support one lifecycle policy. When the lifecycle policy condition is met, the action in the policy will execute. If task execution result does not meet with the defined lifecycle policy, we consider it as the default policy. Default policy means if the exit code is 0, exit task. If task ends with non-zero exit code, retry the task with max_retry_count.
              { # LifecyclePolicy describes how to deal with task failures based on different conditions.
                "action": "A String", # Action to execute when ActionCondition is true. When RETRY_TASK is specified, we will retry failed tasks if we notice any exit code match and fail tasks if no match is found. Likewise, when FAIL_TASK is specified, we will fail tasks if we notice any exit code match and retry tasks if no match is found.
                "actionCondition": { # Conditions for actions to deal with task failures. # Conditions that decide why a task failure is dealt with a specific action.
                  "exitCodes": [ # Exit codes of a task execution. If there are more than 1 exit codes, when task executes with any of the exit code in the list, the condition is met and the action will be executed.
                    42,
                  ],
                },
              },
            ],
            "maxRetryCount": 42, # Maximum number of retries on failures. The default, 0, which means never retry. The valid value range is [0, 10].
            "maxRunDuration": "A String", # 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; 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.
            "runnables": [ # Required. The sequence of one or more runnables (executable scripts, executable containers, and/or barriers) for each task in this task group to run. Each task runs this list of runnables in order. For a task to succeed, all of its script and container runnables each must meet at least one of the following conditions: + 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.
              { # Runnable describes instructions for executing a specific script or container as part of a Task.
                "alwaysRun": True or False, # 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": True or False, # 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": { # A barrier runnable automatically blocks the execution of subsequent runnables until all the tasks in the task group reach the barrier. # Barrier runnable.
                  "name": "A String", # Barriers are identified by their index in runnable list. Names are not required, but if present should be an identifier.
                },
                "container": { # Container runnable. # Container runnable.
                  "blockExternalNetwork": True or False, # 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": [ # 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`.
                    "A String",
                  ],
                  "enableImageStreaming": True or False, # 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": "A String", # Required for some container images. Overrides the `ENTRYPOINT` specified in the container.
                  "imageUri": "A String", # Required. The URI to pull the container image from.
                  "options": "A String", # 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": "A String", # 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": "A String", # 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": [ # 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.
                    "A String",
                  ],
                },
                "displayName": "A String", # 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.
                "environment": { # An Environment describes a collection of environment variables to set when executing Tasks. # Environment variables for this Runnable (overrides variables set for the whole Task or TaskGroup).
                  "encryptedVariables": { # An encrypted JSON dictionary where the key/value pairs correspond to environment variable names and their values.
                    "cipherText": "A String", # The value of the cipherText response from the `encrypt` method.
                    "keyName": "A String", # The name of the KMS key that will be used to decrypt the cipher text.
                  },
                  "secretVariables": { # A map of environment variable names to Secret Manager secret names. The VM will access the named secrets to set the value of each environment variable.
                    "a_key": "A String",
                  },
                  "variables": { # A map of environment variable names to values.
                    "a_key": "A String",
                  },
                },
                "ignoreExitStatus": True or False, # 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.
                "labels": { # Labels for this Runnable.
                  "a_key": "A String",
                },
                "script": { # Script runnable. # Script runnable.
                  "path": "A String", # 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) 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": "A String", # 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) 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": "A String", # Timeout for this Runnable.
              },
            ],
            "volumes": [ # Volumes to mount before running Tasks using this TaskSpec.
              { # Volume describes a volume and parameters for it to be mounted to a VM.
                "deviceName": "A 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": { # Represents a Google Cloud Storage volume. # A Google Cloud Storage (GCS) volume.
                  "remotePath": "A String", # Remote path, either a bucket name or a subdirectory of a bucket, e.g.: bucket_name, bucket_name/subdirectory/
                },
                "mountOptions": [ # 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.
                  "A String",
                ],
                "mountPath": "A String", # The mount path for the volume, e.g. /mnt/disks/share.
                "nfs": { # Represents an NFS volume. # A Network File System (NFS) volume. For example, a Filestore file share.
                  "remotePath": "A String", # Remote source path exported from the NFS, e.g., "/share".
                  "server": "A String", # The IP address of the NFS.
                },
              },
            ],
          },
        },
      ],
      "uid": "A String", # Output only. A system generated unique ID for the Job.
      "updateTime": "A String", # Output only. The last time the Job was updated.
    },
  ],
  "nextPageToken": "A String", # Next page token.
  "unreachable": [ # Locations that could not be reached.
    "A String",
  ],
}

list_next()

Retrieves the next page of results.

        Args:
          previous_request: The request for the previous page. (required)
          previous_response: The response from the request for the previous page. (required)

        Returns:
          A request object that you can call 'execute()' on to request the next
          page. Returns None if there are no more items in the collection.