Types for Google Cloud Batch v1alpha API¶
- class google.cloud.batch_v1alpha.types.AllocationPolicy(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA Job’s resource allocation policy describes when, where, and how compute resources should be allocated for the Job.
- location¶
Location where compute resources should be allocated for the Job.
- instance¶
Deprecated: please use instances[0].policy instead.
- instances¶
Describe instances that can be created by this AllocationPolicy. Only instances[0] is supported now.
- Type
MutableSequence[google.cloud.batch_v1alpha.types.AllocationPolicy.InstancePolicyOrTemplate]
- provisioning_models¶
Deprecated: please use instances[0].policy.provisioning_model instead.
- Type
MutableSequence[google.cloud.batch_v1alpha.types.AllocationPolicy.ProvisioningModel]
- service_account¶
Defines the service account for Batch-created VMs. If omitted, the default Compute Engine 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)
- labels¶
Labels applied to all VM instances and other resources created by AllocationPolicy. Labels could be user provided or system generated. You can assign up to 64 labels. Google Compute Engine label restrictions apply. Label names that start with “goog-” or “google-” are reserved.
- network¶
The network policy.
If you define an instance template in the
InstancePolicyOrTemplatefield, Batch will use the network settings in the instance template instead of this field.
- placement¶
The placement policy.
- 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.
- Type
MutableSequence[str]
- class Accelerator(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageAccelerator describes Compute Engine accelerators to be attached to the VM.
- type_¶
The accelerator type. For example, “nvidia-tesla-t4”. See
gcloud compute accelerator-types list.- Type
- driver_version¶
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.
- Type
- class AttachedDisk(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA new or an existing persistent disk (PD) or a local ssd attached to a VM instance.
This message has oneof fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.
- class Disk(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA 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.
This message has oneof fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.
- image¶
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.
This field is a member of oneof
data_source.- Type
- snapshot¶
Name of a snapshot used as the data source. Snapshot is not supported as boot disk now.
This field is a member of oneof
data_source.- Type
- type_¶
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.- Type
- size_gb¶
Disk size in GB.
Non-Boot Disk: If the
typespecifies a persistent disk, this field is ignored ifdata_sourceis set asimageorsnapshot. If thetypespecifies 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_mibfield in task spec’scompute_resourceare defined, Batch will only honor this field. Also, this field should be no smaller than the source disk’s size when thedata_sourceis set assnapshotorimage. For example, if you set an image as thedata_sourcefield 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.- Type
- disk_interface¶
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.
- Type
- class InstancePolicy(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageInstancePolicy describes an instance type and resources attached to each VM created by this InstancePolicy.
- min_cpu_platform¶
The minimum CPU platform. See https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform.
- Type
- provisioning_model¶
The provisioning model.
- accelerators¶
The accelerators attached to each VM instance.
- Type
MutableSequence[google.cloud.batch_v1alpha.types.AllocationPolicy.Accelerator]
- boot_disk¶
Boot disk to be created and attached to each VM by this InstancePolicy. Boot disk will be deleted when the VM is deleted. Batch API now only supports booting from image.
- disks¶
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.
- Type
MutableSequence[google.cloud.batch_v1alpha.types.AllocationPolicy.AttachedDisk]
- class InstancePolicyOrTemplate(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageInstancePolicyOrTemplate 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.
This message has oneof fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.
- instance_template¶
Name of an instance template used to create VMs. Named the field as ‘instance_template’ instead of ‘template’ to avoid c++ keyword conflict.
This field is a member of oneof
policy_template.- Type
- install_gpu_drivers¶
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.acceleratorsorinstance_templateon 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.
- Type
- install_ops_agent¶
Optional. Set this field true if you want Batch to install Ops Agent on your behalf. Default is false.
- Type
- block_project_ssh_keys¶
Optional. Set this field to
trueif 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
- Type
- class LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)¶
Bases:
proto.message.Message
- class LocationPolicy(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.Message- allowed_locations¶
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.
- Type
MutableSequence[str]
- class NetworkInterface(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA network interface.
- network¶
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}
- Type
- subnetwork¶
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}
- Type
- no_external_ip_address¶
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.
- Type
- class NetworkPolicy(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageNetworkPolicy describes VM instance network configurations.
- network_interfaces¶
Network configurations.
- Type
MutableSequence[google.cloud.batch_v1alpha.types.AllocationPolicy.NetworkInterface]
- class PlacementPolicy(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessagePlacementPolicy describes a group placement policy for the VMs controlled by this AllocationPolicy.
- collocation¶
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.
- Type
- max_distance¶
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
- Type
- class ProvisioningModel(value)[source]¶
Bases:
proto.enums.EnumCompute Engine VM instance provisioning model.
- Values:
- PROVISIONING_MODEL_UNSPECIFIED (0):
Unspecified.
- STANDARD (1):
Standard VM.
- SPOT (2):
SPOT VM.
- PREEMPTIBLE (3):
Preemptible VM (PVM).
Above SPOT VM is the preferable model for preemptible VM instances: the old preemptible VM model (indicated by this field) is the older model, and has been migrated to use the SPOT model as the underlying technology. This old model will still be supported.
- class google.cloud.batch_v1alpha.types.CalendarPeriod(value)[source]¶
Bases:
proto.enums.EnumA
CalendarPeriodrepresents the abstract concept of a time period that has a canonical start. All calendar times begin at 12 AM US and Canadian Pacific Time (UTC-8).- Values:
- CALENDAR_PERIOD_UNSPECIFIED (0):
Unspecified.
- MONTH (1):
The month starts on the first date of the month and resets at the beginning of each month.
- QUARTER (2):
The quarter starts on dates January 1, April 1, July 1, and October 1 of each year and resets at the beginning of the next quarter.
- YEAR (3):
The year starts on January 1 and resets at the beginning of the next year.
- WEEK (4):
The week period starts and resets every Monday.
- DAY (5):
The day starts at 12:00am.
- class google.cloud.batch_v1alpha.types.CancelJobRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageCancelJob Request.
- request_id¶
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).
- Type
- class google.cloud.batch_v1alpha.types.CancelJobResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageResponse to the CancelJob request.
- class google.cloud.batch_v1alpha.types.ComputeResource(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageCompute 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 field, make sure both fields are compatible with each other.
- cpu_milli¶
The milliCPU count.
cpuMillidefines the amount of CPU resources per task in milliCPU units. For example,1000corresponds to 1 vCPU per task. If undefined, the default value is2000.If you also define the VM’s machine type using the
machineTypein InstancePolicy field or inside theinstanceTemplatein the 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-2machine type, which has 2 vCPUs each, you are recommended to setcpuMillino more than2000, or you are recommended to run two tasks on the same VM if you setcpuMillito1000or less.- Type
- memory_mib¶
Memory in MiB.
memoryMibdefines the amount of memory per task in MiB units. If undefined, the default value is2000. If you also define the VM’s machine type using themachineTypein InstancePolicy field or inside theinstanceTemplatein the 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-2machine type, which has 8 GiB each, you are recommended to setmemoryMibto no more than8192, or you are recommended to run two tasks on the same VM if you setmemoryMibto4096or less.- Type
- class google.cloud.batch_v1alpha.types.CreateJobRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageCreateJob Request.
- parent¶
Required. The parent resource name where the Job will be created. Pattern: “projects/{project}/locations/{location}”.
- Type
- job_id¶
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}”.
- Type
- job¶
Required. The Job to create.
- request_id¶
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).
- Type
- class google.cloud.batch_v1alpha.types.CreateResourceAllowanceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageCreateResourceAllowance Request.
- parent¶
Required. The parent resource name where the ResourceAllowance will be created. Pattern: “projects/{project}/locations/{location}”.
- Type
- resource_allowance_id¶
ID used to uniquely identify the ResourceAllowance 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 resource_allowance.name field in the request will be ignored and the created resource name of the ResourceAllowance will be “{parent}/resourceAllowances/{resource_allowance_id}”.
- Type
- resource_allowance¶
Required. The ResourceAllowance to create.
- request_id¶
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).
- Type
- class google.cloud.batch_v1alpha.types.DeleteJobRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageDeleteJob Request.
- request_id¶
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).
- Type
- class google.cloud.batch_v1alpha.types.DeleteResourceAllowanceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageDeleteResourceAllowance Request.
- request_id¶
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).
- Type
- class google.cloud.batch_v1alpha.types.Environment(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageAn Environment describes a collection of environment variables to set when executing Tasks.
- secret_variables¶
A map of environment variable names to Secret Manager secret names. The VM will access the named secrets to set the value of each environment variable.
- encrypted_variables¶
An encrypted JSON dictionary where the key/value pairs correspond to environment variable names and their values.
- class KMSEnvMap(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.Message
- class SecretVariablesEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)¶
Bases:
proto.message.Message
- class VariablesEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)¶
Bases:
proto.message.Message
- class google.cloud.batch_v1alpha.types.GCS(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRepresents a Google Cloud Storage volume.
- class google.cloud.batch_v1alpha.types.GetJobRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageGetJob Request.
- class google.cloud.batch_v1alpha.types.GetResourceAllowanceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageGetResourceAllowance Request.
- class google.cloud.batch_v1alpha.types.GetTaskRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest for a single Task by name.
- class google.cloud.batch_v1alpha.types.Job(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageThe Cloud Batch Job description.
- name¶
Output only. Job name. For example: “projects/123456/locations/us-central1/jobs/job01”.
- Type
- priority¶
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.
- Type
- task_groups¶
Required. TaskGroups in the Job. Only one TaskGroup is supported now.
- Type
MutableSequence[google.cloud.batch_v1alpha.types.TaskGroup]
- scheduling_policy¶
Scheduling policy for TaskGroups in the job.
- dependencies¶
At least one of the dependencies must be satisfied before the Job is scheduled to run. Only one JobDependency is supported now. Not yet implemented.
- Type
MutableSequence[google.cloud.batch_v1alpha.types.JobDependency]
- allocation_policy¶
Compute resource allocation for all TaskGroups in the Job.
- labels¶
Labels for the Job. Labels could be user provided or system generated. For example, “labels”: { “department”: “finance”, “environment”: “test” } You can assign up to 64 labels. Google Compute Engine label restrictions apply. Label names that start with “goog-” or “google-” are reserved.
- status¶
Output only. Job status. It is read only for users.
- notification¶
Deprecated: please use notifications instead.
- create_time¶
Output only. When the Job was created.
- update_time¶
Output only. The last time the Job was updated.
- logs_policy¶
Log preservation policy for the Job.
- notifications¶
Notification configurations.
- Type
MutableSequence[google.cloud.batch_v1alpha.types.JobNotification]
- class LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)¶
Bases:
proto.message.Message
- class SchedulingPolicy(value)[source]¶
Bases:
proto.enums.EnumThe order that TaskGroups are scheduled relative to each other. Not yet implemented.
- Values:
- SCHEDULING_POLICY_UNSPECIFIED (0):
Unspecified.
- AS_SOON_AS_POSSIBLE (1):
Run all TaskGroups as soon as possible.
- class google.cloud.batch_v1alpha.types.JobDependency(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageJobDependency describes the state of other Jobs that the start of this Job depends on. All dependent Jobs must have been submitted in the same region.
- items¶
Each item maps a Job name to a Type. All items must be satisfied for the JobDependency to be satisfied (the AND operation). Once a condition for one item becomes true, it won’t go back to false even the dependent Job state changes again.
- Type
MutableMapping[str, google.cloud.batch_v1alpha.types.JobDependency.Type]
- class ItemsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)¶
Bases:
proto.message.Message
- class Type(value)[source]¶
Bases:
proto.enums.EnumDependency type.
- Values:
- TYPE_UNSPECIFIED (0):
Unspecified.
- SUCCEEDED (1):
The dependent Job has succeeded.
- FAILED (2):
The dependent Job has failed.
- FINISHED (3):
SUCCEEDED or FAILED.
- class google.cloud.batch_v1alpha.types.JobNotification(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageNotification configurations.
- pubsub_topic¶
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.
- Type
- message¶
The attribute requirements of messages to be sent to this Pub/Sub topic. Without this field, no message will be sent.
- class Message(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageMessage 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.
- type_¶
The message type.
- new_job_state¶
The new job state.
- new_task_state¶
The new task state.
- class Type(value)[source]¶
Bases:
proto.enums.EnumThe message type.
- Values:
- TYPE_UNSPECIFIED (0):
Unspecified.
- JOB_STATE_CHANGED (1):
Notify users that the job state has changed.
- TASK_STATE_CHANGED (2):
Notify users that the task state has changed.
- class google.cloud.batch_v1alpha.types.JobStatus(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageJob status.
- state¶
Job state
- status_events¶
Job status events
- Type
MutableSequence[google.cloud.batch_v1alpha.types.StatusEvent]
- task_groups¶
Aggregated task status for each TaskGroup in the Job. The map key is TaskGroup ID.
- Type
MutableMapping[str, google.cloud.batch_v1alpha.types.JobStatus.TaskGroupStatus]
- run_duration¶
The duration of time that the Job spent in status RUNNING.
- resource_usage¶
The resource usage of the job.
- class InstanceStatus(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageVM instance status.
- provisioning_model¶
The VM instance provisioning model.
- boot_disk¶
The VM boot disk.
- class State(value)[source]¶
Bases:
proto.enums.EnumValid Job states.
- Values:
- STATE_UNSPECIFIED (0):
Job state unspecified.
- QUEUED (1):
Job is admitted (validated and persisted) and waiting for resources.
- SCHEDULED (2):
Job is scheduled to run as soon as resource allocation is ready. The resource allocation may happen at a later time but with a high chance to succeed.
- RUNNING (3):
Resource allocation has been successful. At least one Task in the Job is RUNNING.
- SUCCEEDED (4):
All Tasks in the Job have finished successfully.
- FAILED (5):
At least one Task in the Job has failed.
- DELETION_IN_PROGRESS (6):
The Job will be deleted, but has not been deleted yet. Typically this is because resources used by the Job are still being cleaned up.
- CANCELLATION_IN_PROGRESS (7):
The Job cancellation is in progress, this is because the resources used by the Job are still being cleaned up.
- CANCELLED (8):
The Job has been cancelled, the task executions were stopped and the resources were cleaned up.
- class TaskGroupStatus(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageAggregated task status for a TaskGroup.
- counts¶
Count of task in each state in the TaskGroup. The map key is task state name.
- instances¶
Status of instances allocated for the TaskGroup.
- Type
MutableSequence[google.cloud.batch_v1alpha.types.JobStatus.InstanceStatus]
- class CountsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)¶
Bases:
proto.message.Message
- class TaskGroupsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)¶
Bases:
proto.message.Message
- class google.cloud.batch_v1alpha.types.LifecyclePolicy(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageLifecyclePolicy describes how to deal with task failures based on different conditions.
- action¶
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.
- action_condition¶
Conditions that decide why a task failure is dealt with a specific action.
- class Action(value)[source]¶
Bases:
proto.enums.EnumAction on task failures based on different conditions.
- Values:
- ACTION_UNSPECIFIED (0):
Action unspecified.
- RETRY_TASK (1):
Action that tasks in the group will be scheduled to re-execute.
- FAIL_TASK (2):
Action that tasks in the group will be stopped immediately.
- class ActionCondition(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageConditions for actions to deal with task failures.
- class google.cloud.batch_v1alpha.types.ListJobsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageListJob Request.
- order_by¶
Optional. Sort results. Supported are “name”, “name desc”, “create_time”, and “create_time desc”.
- Type
- class google.cloud.batch_v1alpha.types.ListJobsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageListJob Response.
- jobs¶
Jobs.
- Type
MutableSequence[google.cloud.batch_v1alpha.types.Job]
- class google.cloud.batch_v1alpha.types.ListResourceAllowancesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageListResourceAllowances Request.
- class google.cloud.batch_v1alpha.types.ListResourceAllowancesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageListResourceAllowances Response.
- resource_allowances¶
ResourceAllowances.
- Type
MutableSequence[google.cloud.batch_v1alpha.types.ResourceAllowance]
- class google.cloud.batch_v1alpha.types.ListTasksRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageListTasks Request.
- parent¶
Required. Name of a TaskGroup from which Tasks are being requested. Pattern: “projects/{project}/locations/{location}/jobs/{job}/taskGroups/{task_group}”.
- Type
- filter¶
Task filter, null filter matches all Tasks. Filter string should be of the format State=TaskStatus.State e.g. State=RUNNING
- Type
- class google.cloud.batch_v1alpha.types.ListTasksResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageListTasks Response.
- tasks¶
Tasks.
- Type
MutableSequence[google.cloud.batch_v1alpha.types.Task]
- class google.cloud.batch_v1alpha.types.LogsPolicy(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageLogsPolicy describes how outputs from a Job’s Tasks (stdout/stderr) will be preserved.
- destination¶
Where logs should be saved.
- logs_path¶
The path to which logs are saved when the destination = PATH. This can be a local file path on the VM, or under the mount point of a Persistent Disk or Filestore, or a Cloud Storage path.
- Type
- cloud_logging_option¶
Optional. Additional settings for Cloud Logging. It will only take effect when the destination of
LogsPolicyis set toCLOUD_LOGGING.
- class CloudLoggingOption(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageCloudLoggingOptioncontains additional settings for Cloud Logging logs generated by Batch job.- use_generic_task_monitored_resource¶
Optional. Set this flag to true to change the monitored resource type 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.- Type
- class Destination(value)[source]¶
Bases:
proto.enums.EnumThe destination (if any) for logs.
- Values:
- DESTINATION_UNSPECIFIED (0):
Logs are not preserved.
- CLOUD_LOGGING (1):
Logs are streamed to Cloud Logging.
- PATH (2):
Logs are saved to a file path.
- class google.cloud.batch_v1alpha.types.NFS(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRepresents an NFS volume.
- class google.cloud.batch_v1alpha.types.Notification(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageNotification on resource state change.
- pubsub_topic¶
Required. The Pub/Sub topic where notifications like the resource allowance state changes will be published. The topic must exist in the same project as the job and billings will be charged to this project. If not specified, no Pub/Sub messages will be sent. Topic format:
projects/{project}/topics/{topic}.- Type
- class google.cloud.batch_v1alpha.types.OperationMetadata(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRepresents the metadata of the long-running operation.
- create_time¶
Output only. The time the operation was created.
- end_time¶
Output only. The time the operation finished running.
- requested_cancellation¶
Output only. Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have [Operation.error][] value with a [google.rpc.Status.code][google.rpc.Status.code] of 1, corresponding to
Code.CANCELLED.- Type
- class google.cloud.batch_v1alpha.types.PD(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageDeprecated: please use device_name instead.
- class google.cloud.batch_v1alpha.types.ResourceAllowance(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageThe Resource Allowance description for Cloud Batch. Only one Resource Allowance is supported now under a specific location and project.
- usage_resource_allowance¶
The detail of usage resource allowance.
This field is a member of oneof
resource_allowance.
- name¶
Identifier. ResourceAllowance name. For example:
“projects/123456/locations/us-central1/resourceAllowances/resource-allowance-1”.
- Type
- uid¶
Output only. A system generated unique ID (in UUID4 format) for the ResourceAllowance.
- Type
- create_time¶
Output only. Time when the ResourceAllowance was created.
- labels¶
Optional. Labels are attributes that can be set and used by both the user and by Batch. Labels must meet the following constraints:
Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes.
All characters must use UTF-8 encoding, and international characters are allowed.
Keys must start with a lowercase letter or international character.
Each resource is limited to a maximum of 64 labels.
Both keys and values are additionally constrained to be <= 128 bytes.
- notifications¶
Optional. Notification configurations.
- Type
MutableSequence[google.cloud.batch_v1alpha.types.Notification]
- class LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)¶
Bases:
proto.message.Message
- class google.cloud.batch_v1alpha.types.ResourceAllowanceState(value)[source]¶
Bases:
proto.enums.EnumResourceAllowance valid state.
- Values:
- RESOURCE_ALLOWANCE_STATE_UNSPECIFIED (0):
Unspecified.
- RESOURCE_ALLOWANCE_ACTIVE (1):
ResourceAllowance is active and in use.
- RESOURCE_ALLOWANCE_DEPLETED (2):
ResourceAllowance limit is reached.
- class google.cloud.batch_v1alpha.types.ResourceUsage(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageResourceUsage describes the resource usage of the job.
- class google.cloud.batch_v1alpha.types.Runnable(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRunnable describes instructions for executing a specific script or container as part of a Task.
This message has oneof fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.
- display_name¶
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.
- Type
- ignore_exit_status¶
Normally, a runnable that returns a non-zero exit status fails and causes the task to fail. However, you can set this field to
trueto allow the task to continue executing its other runnables even if this runnable fails.- Type
- background¶
Normally, a runnable that doesn’t exit causes its task to fail. However, you can set this field to
trueto 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.
- Type
- always_run¶
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.
- Type
- environment¶
Environment variables for this Runnable (overrides variables set for the whole Task or TaskGroup).
- timeout¶
Timeout for this Runnable.
- class Barrier(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA barrier runnable automatically blocks the execution of subsequent runnables until all the tasks in the task group reach the barrier.
- class Container(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageContainer runnable.
- commands¶
Required for some container images. Overrides the
CMDspecified in the container. If there is anENTRYPOINT(either in the container image or with theentrypointfield below) then these commands are appended as arguments to theENTRYPOINT.- Type
MutableSequence[str]
- entrypoint¶
Required for some container images. Overrides the
ENTRYPOINTspecified in the container.- Type
- volumes¶
Volumes to mount (bind mount) from the host machine files or directories into the container, formatted to match
--volumeoption for thedocker runcommand—for example,/foo:/baror/foo:/bar:ro.If the
TaskSpec.Volumesfield 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 inTaskSpec.Volumes. If you need different mount settings, you can explicitly configure them in this field.- Type
MutableSequence[str]
- options¶
Required for some container images. Arbitrary additional options to include in the
docker runcommand when running this container—for example,--network host. For the--volumeoption, use thevolumesfield for the container.- Type
- block_external_network¶
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.optionsfield.- Type
- username¶
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 and using Secret Manager with Batch.
- Type
- password¶
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 and using Secret Manager with Batch.
- Type
- enable_image_streaming¶
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
enableImageStreamingis set to true, the container runtime is containerd instead of Docker. Additionally, this container runnable only supports the followingcontainersubfields:imageUri,commands[],entrypoint, andvolumes[]; any othercontainersubfields are ignored.For more information about the requirements and limitations for using Image streaming with Batch, see the
`image-streamingsample on GitHub <https://github.com/GoogleCloudPlatform/batch-samples/tree/main/api-samples/image-streaming>`__.- Type
- class LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)¶
Bases:
proto.message.Message
- class Script(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageScript runnable.
This message has oneof fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.
- path¶
The path to a script file that is accessible from the host VM(s).
Unless the script file supports the default
#!/bin/shshell 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/bashas the first line of the file. Alternatively, to execute the script using Python3, include#!/usr/bin/env python3as the first line of the file.This field is a member of oneof
command.- Type
- text¶
The text for a script.
Unless the script text supports the default
#!/bin/shshell 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\nat the beginning of the text. Alternatively, to execute the script using Python3, include#!/usr/bin/env python3\nat the beginning of the text.This field is a member of oneof
command.- Type
- class google.cloud.batch_v1alpha.types.ServiceAccount(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageCarries information about a Google Cloud service account.
- class google.cloud.batch_v1alpha.types.StatusEvent(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageStatus event.
- event_time¶
The time this event occurred.
- task_execution¶
Task Execution. This field is only defined for task-level status events where the task fails.
- task_state¶
Task State. This field is only defined for task-level status events.
- class google.cloud.batch_v1alpha.types.Task(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA Cloud Batch task.
- name¶
Task name. The name is generated from the parent TaskGroup name and ‘id’ field. For example:
“projects/123456/locations/us-west1/jobs/job01/taskGroups/group01/tasks/task01”.
- Type
- status¶
Task Status.
- class google.cloud.batch_v1alpha.types.TaskExecution(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageThis Task Execution field includes detail information for task execution procedures, based on StatusEvent types.
- exit_code¶
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.
- Type
- class google.cloud.batch_v1alpha.types.TaskGroup(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA TaskGroup defines one or more Tasks that all share the same TaskSpec.
- name¶
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”.
- Type
- task_spec¶
Required. Tasks in the group share the same task spec.
- parallelism¶
Max number of tasks that can run in parallel. Default to min(task_count, parallel tasks per job limit). See: Job Limits. Field parallelism must be 1 if the scheduling_policy is IN_ORDER.
- Type
- scheduling_policy¶
Scheduling policy for Tasks in the TaskGroup. The default value is AS_SOON_AS_POSSIBLE.
- allocation_policy¶
Compute resource allocation for the TaskGroup. If specified, it overrides resources in Job.
- labels¶
Labels for the TaskGroup. Labels could be user provided or system generated. You can assign up to 64 labels. Google Compute Engine label restrictions apply. Label names that start with “goog-” or “google-” are reserved.
- task_environments¶
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).
- Type
MutableSequence[google.cloud.batch_v1alpha.types.Environment]
- task_count_per_node¶
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.
- Type
- require_hosts_file¶
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.
- Type
- permissive_ssh¶
When true, Batch will configure SSH to allow passwordless login between VMs running the Batch tasks in the same TaskGroup.
- Type
- run_as_non_root¶
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.
- Type
- service_account¶
Optional. ServiceAccount used by tasks within the task group for the access to other Cloud resources. This allows tasks to operate with permissions distinct from the service account for the VM set at
AllocationPolicy. Use this field when tasks require different access rights than those of the VM.Specify the service account’s
emailfield. Ensurescopesinclude any necessary permissions for tasks, in addition to the default ‘cloud-platform’ scope.
- class LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)¶
Bases:
proto.message.Message
- class SchedulingPolicy(value)[source]¶
Bases:
proto.enums.EnumHow Tasks in the TaskGroup should be scheduled relative to each other.
- Values:
- SCHEDULING_POLICY_UNSPECIFIED (0):
Unspecified.
- AS_SOON_AS_POSSIBLE (1):
Run Tasks as soon as resources are available.
Tasks might be executed in parallel depending on parallelism and task_count values.
- IN_ORDER (2):
Run Tasks sequentially with increased task index.
- class google.cloud.batch_v1alpha.types.TaskResourceUsage(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageTaskResourceUsage describes the resource usage of the task.
- class google.cloud.batch_v1alpha.types.TaskSpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageSpec of a task
- 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
backgroundsubfield.The runnable exited with a non-zero status, but you enabled its
ignore_exit_statussubfield.
- Type
MutableSequence[google.cloud.batch_v1alpha.types.Runnable]
- compute_resource¶
ComputeResource requirements.
- max_run_duration¶
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,3600sfor 1 hour. The field accepts any value between 0 and the maximum listed for theDurationfield 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.
- max_retry_count¶
Maximum number of retries on failures. The default, 0, which means never retry. The valid value range is [0, 10].
- Type
- lifecycle_policies¶
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.
- Type
MutableSequence[google.cloud.batch_v1alpha.types.LifecyclePolicy]
- volumes¶
Volumes to mount before running Tasks using this TaskSpec.
- Type
MutableSequence[google.cloud.batch_v1alpha.types.Volume]
- environment¶
Environment variables to set before running the Task.
- class EnvironmentsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)¶
Bases:
proto.message.Message
- class google.cloud.batch_v1alpha.types.TaskStatus(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageStatus of a task.
- state¶
Task state.
- status_events¶
Detailed info about why the state is reached.
- Type
MutableSequence[google.cloud.batch_v1alpha.types.StatusEvent]
- resource_usage¶
The resource usage of the task.
- class State(value)[source]¶
Bases:
proto.enums.EnumTask states.
- Values:
- STATE_UNSPECIFIED (0):
Unknown state.
- PENDING (1):
The Task is created and waiting for resources.
- ASSIGNED (2):
The Task is assigned to at least one VM.
- RUNNING (3):
The Task is running.
- FAILED (4):
The Task has failed.
- SUCCEEDED (5):
The Task has succeeded.
- UNEXECUTED (6):
The Task has not been executed when the Job finishes.
- class google.cloud.batch_v1alpha.types.UpdateJobRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageUpdateJob Request.
- job¶
Required. The Job to update. Only fields specified in
updateMaskare updated.
- update_mask¶
Required. Mask of fields to update.
The
jobs.patchmethod can only be used while a job is in theQUEUED,SCHEDULED, orRUNNINGstate and currently only supports increasing the value of the firsttaskCountfield in the job’staskGroupsfield. Therefore, you must set the value ofupdateMasktotaskGroups. Any other job fields in the update request will be ignored.For example, to update a job’s
taskCountto2, setupdateMasktotaskGroupsand use the following request body:{ "taskGroups":[{ "taskCount": 2 }] }
- request_id¶
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).
- Type
- class google.cloud.batch_v1alpha.types.UpdateResourceAllowanceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageUpdateResourceAllowance Request.
- resource_allowance¶
Required. The ResourceAllowance to update. Update description. Only fields specified in
update_maskare updated.
- update_mask¶
Required. Mask of fields to update.
Field mask is used to specify the fields to be overwritten in the ResourceAllowance resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.
UpdateResourceAllowance request now only supports update on
limitfield.
- request_id¶
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).
- Type
- class google.cloud.batch_v1alpha.types.UsageResourceAllowance(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageUsageResourceAllowance describes the detail of usage resource allowance.
- spec¶
Required. Spec of a usage ResourceAllowance.
- status¶
Output only. Status of a usage ResourceAllowance.
- class google.cloud.batch_v1alpha.types.UsageResourceAllowanceSpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageSpec of a usage ResourceAllowance.
- type_¶
Required. Spec type is unique for each usage ResourceAllowance. Batch now only supports type as “cpu-core-hours” for CPU usage consumption tracking.
- Type
- limit¶
Required. Threshold of a UsageResourceAllowance limiting how many resources can be consumed for each type.
- class Limit(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageUsageResourceAllowance limitation.
- calendar_period¶
Optional. A CalendarPeriod represents the abstract concept of a time period that has a canonical start.
This field is a member of oneof
duration.
- limit¶
Required. Limit value of a UsageResourceAllowance within its one duration.
Limit cannot be a negative value. Default is 0. For example, you can set
limitas 10000.0 with duration of the current month by settingcalendar_periodfield as monthly. That means in your current month, 10000.0 is the core hour limitation that your resources are allowed to consume.This field is a member of oneof
_limit.- Type
- class google.cloud.batch_v1alpha.types.UsageResourceAllowanceStatus(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageStatus of a usage ResourceAllowance.
- state¶
Output only. ResourceAllowance state.
- limit_status¶
Output only. ResourceAllowance consumption status for usage resources.
- report¶
Output only. The report of ResourceAllowance consumptions in a time period.
- class ConsumptionReport(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageConsumptionReport is the report of ResourceAllowance consumptions in a time period.
- latest_period_consumptions¶
Output only. ResourceAllowance consumptions in the latest calendar period. Key is the calendar period in string format. Batch currently supports HOUR, DAY, MONTH and YEAR.
- Type
MutableMapping[str, google.cloud.batch_v1alpha.types.UsageResourceAllowanceStatus.PeriodConsumption]
- class LatestPeriodConsumptionsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)¶
Bases:
proto.message.Message
- class LimitStatus(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageUsageResourceAllowanceStatus detail about usage consumption.
- consumption_interval¶
Output only. The consumption interval.
- Type
google.type.interval_pb2.Interval
- class PeriodConsumption(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.Message- consumption_interval¶
Output only. The consumption interval.
- Type
google.type.interval_pb2.Interval
- class google.cloud.batch_v1alpha.types.Volume(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageVolume describes a volume and parameters for it to be mounted to a VM.
This message has oneof fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.
- nfs¶
A Network File System (NFS) volume. For example, a Filestore file share.
This field is a member of oneof
source.
- device_name¶
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.
This field is a member of oneof
source.- Type
- mount_options¶
Mount options vary based on the type of storage volume:
For a Cloud Storage bucket, all the mount options provided by the
`gcsfusetool <https://cloud.google.com/storage/docs/gcsfuse-cli>`__ are supported.For an existing persistent disk, all mount options provided by the
`mountcommand <https://man7.org/linux/man-pages/man8/mount.8.html>`__ except writing are supported. This is due to restrictions of multi-writer mode.For any other disk or a Network File System (NFS), all the mount options provided by the
mountcommand are supported.
- Type
MutableSequence[str]
