| Class | Description |
|---|---|
| AllocationPolicy |
A Job's resource allocation policy describes when, where, and how compute
resources should be allocated for the Job.
|
| AllocationPolicy.Accelerator |
Accelerator describes Compute Engine accelerators to be attached to the VM.
|
| AllocationPolicy.Accelerator.Builder |
Accelerator describes Compute Engine accelerators to be attached to the VM.
|
| AllocationPolicy.AttachedDisk |
A new or an existing persistent disk (PD) or a local ssd attached to a VM
instance.
|
| AllocationPolicy.AttachedDisk.Builder |
A new or an existing persistent disk (PD) or a local ssd attached to a VM
instance.
|
| AllocationPolicy.Builder |
A Job's resource allocation policy describes when, where, and how compute
resources should be allocated for the Job.
|
| AllocationPolicy.Disk |
A new persistent disk or a local ssd.
|
| AllocationPolicy.Disk.Builder |
A new persistent disk or a local ssd.
|
| AllocationPolicy.InstancePolicy |
InstancePolicy describes an instance type and resources attached to each VM
created by this InstancePolicy.
|
| AllocationPolicy.InstancePolicy.Builder |
InstancePolicy describes an instance type and resources attached to each VM
created by this InstancePolicy.
|
| AllocationPolicy.InstancePolicyOrTemplate |
InstancePolicyOrTemplate lets you define the type of resources to use for
this job either with an InstancePolicy or an instance template.
|
| AllocationPolicy.InstancePolicyOrTemplate.Builder |
InstancePolicyOrTemplate lets you define the type of resources to use for
this job either with an InstancePolicy or an instance template.
|
| AllocationPolicy.LocationPolicy |
Protobuf type
google.cloud.batch.v1.AllocationPolicy.LocationPolicy |
| AllocationPolicy.LocationPolicy.Builder |
Protobuf type
google.cloud.batch.v1.AllocationPolicy.LocationPolicy |
| AllocationPolicy.NetworkInterface |
A network interface.
|
| AllocationPolicy.NetworkInterface.Builder |
A network interface.
|
| AllocationPolicy.NetworkPolicy |
NetworkPolicy describes VM instance network configurations.
|
| AllocationPolicy.NetworkPolicy.Builder |
NetworkPolicy describes VM instance network configurations.
|
| AllocationPolicy.PlacementPolicy |
PlacementPolicy describes a group placement policy for the VMs controlled
by this AllocationPolicy.
|
| AllocationPolicy.PlacementPolicy.Builder |
PlacementPolicy describes a group placement policy for the VMs controlled
by this AllocationPolicy.
|
| BatchProto | |
| CancelJobRequest |
CancelJob Request.
|
| CancelJobRequest.Builder |
CancelJob Request.
|
| CancelJobResponse |
Response to the CancelJob request.
|
| CancelJobResponse.Builder |
Response to the CancelJob request.
|
| ComputeResource |
Compute resource requirements.
|
| ComputeResource.Builder |
Compute resource requirements.
|
| CreateJobRequest |
CreateJob Request.
|
| CreateJobRequest.Builder |
CreateJob Request.
|
| DeleteJobRequest |
DeleteJob Request.
|
| DeleteJobRequest.Builder |
DeleteJob Request.
|
| Environment |
An Environment describes a collection of environment variables to set when
executing Tasks.
|
| Environment.Builder |
An Environment describes a collection of environment variables to set when
executing Tasks.
|
| Environment.KMSEnvMap |
Protobuf type
google.cloud.batch.v1.Environment.KMSEnvMap |
| Environment.KMSEnvMap.Builder |
Protobuf type
google.cloud.batch.v1.Environment.KMSEnvMap |
| GCS |
Represents a Google Cloud Storage volume.
|
| GCS.Builder |
Represents a Google Cloud Storage volume.
|
| GetJobRequest |
GetJob Request.
|
| GetJobRequest.Builder |
GetJob Request.
|
| GetTaskRequest |
Request for a single Task by name.
|
| GetTaskRequest.Builder |
Request for a single Task by name.
|
| Job |
The Cloud Batch Job description.
|
| Job.Builder |
The Cloud Batch Job description.
|
| JobName | |
| JobName.Builder |
Builder for projects/{project}/locations/{location}/jobs/{job}.
|
| JobNotification |
Notification configurations.
|
| JobNotification.Builder |
Notification configurations.
|
| JobNotification.Message |
Message details.
|
| JobNotification.Message.Builder |
Message details.
|
| JobProto | |
| JobStatus |
Job status.
|
| JobStatus.Builder |
Job status.
|
| JobStatus.InstanceStatus |
VM instance status.
|
| JobStatus.InstanceStatus.Builder |
VM instance status.
|
| JobStatus.TaskGroupStatus |
Aggregated task status for a TaskGroup.
|
| JobStatus.TaskGroupStatus.Builder |
Aggregated task status for a TaskGroup.
|
| LifecyclePolicy |
LifecyclePolicy describes how to deal with task failures
based on different conditions.
|
| LifecyclePolicy.ActionCondition |
Conditions for actions to deal with task failures.
|
| LifecyclePolicy.ActionCondition.Builder |
Conditions for actions to deal with task failures.
|
| LifecyclePolicy.Builder |
LifecyclePolicy describes how to deal with task failures
based on different conditions.
|
| ListJobsRequest |
ListJob Request.
|
| ListJobsRequest.Builder |
ListJob Request.
|
| ListJobsResponse |
ListJob Response.
|
| ListJobsResponse.Builder |
ListJob Response.
|
| ListTasksRequest |
ListTasks Request.
|
| ListTasksRequest.Builder |
ListTasks Request.
|
| ListTasksResponse |
ListTasks Response.
|
| ListTasksResponse.Builder |
ListTasks Response.
|
| LocationName | |
| LocationName.Builder |
Builder for projects/{project}/locations/{location}.
|
| LogsPolicy |
LogsPolicy describes if and how a job's logs are preserved.
|
| LogsPolicy.Builder |
LogsPolicy describes if and how a job's logs are preserved.
|
| LogsPolicy.CloudLoggingOption |
`CloudLoggingOption` contains additional settings for Cloud Logging logs
generated by Batch job.
|
| LogsPolicy.CloudLoggingOption.Builder |
`CloudLoggingOption` contains additional settings for Cloud Logging logs
generated by Batch job.
|
| NFS |
Represents an NFS volume.
|
| NFS.Builder |
Represents an NFS volume.
|
| OperationMetadata |
Represents the metadata of the long-running operation.
|
| OperationMetadata.Builder |
Represents the metadata of the long-running operation.
|
| Runnable |
Runnable describes instructions for executing a specific script or container
as part of a Task.
|
| Runnable.Barrier |
A barrier runnable automatically blocks the execution of subsequent
runnables until all the tasks in the task group reach the barrier.
|
| Runnable.Barrier.Builder |
A barrier runnable automatically blocks the execution of subsequent
runnables until all the tasks in the task group reach the barrier.
|
| Runnable.Builder |
Runnable describes instructions for executing a specific script or container
as part of a Task.
|
| Runnable.Container |
Container runnable.
|
| Runnable.Container.Builder |
Container runnable.
|
| Runnable.Script |
Script runnable.
|
| Runnable.Script.Builder |
Script runnable.
|
| ServiceAccount |
Carries information about a Google Cloud service account.
|
| ServiceAccount.Builder |
Carries information about a Google Cloud service account.
|
| StatusEvent |
Status event.
|
| StatusEvent.Builder |
Status event.
|
| Task |
A Cloud Batch task.
|
| Task.Builder |
A Cloud Batch task.
|
| TaskExecution |
This Task Execution field includes detail information for
task execution procedures, based on StatusEvent types.
|
| TaskExecution.Builder |
This Task Execution field includes detail information for
task execution procedures, based on StatusEvent types.
|
| TaskGroup |
A TaskGroup defines one or more Tasks that all share the same TaskSpec.
|
| TaskGroup.Builder |
A TaskGroup defines one or more Tasks that all share the same TaskSpec.
|
| TaskGroupName | |
| TaskGroupName.Builder |
Builder for projects/{project}/locations/{location}/jobs/{job}/taskGroups/{task_group}.
|
| TaskName | |
| TaskName.Builder |
Builder for
projects/{project}/locations/{location}/jobs/{job}/taskGroups/{task_group}/tasks/{task}.
|
| TaskProto | |
| TaskSpec |
Spec of a task
Protobuf type
google.cloud.batch.v1.TaskSpec |
| TaskSpec.Builder |
Spec of a task
Protobuf type
google.cloud.batch.v1.TaskSpec |
| TaskStatus |
Status of a task.
|
| TaskStatus.Builder |
Status of a task.
|
| Volume |
Volume describes a volume and parameters for it to be mounted to a VM.
|
| Volume.Builder |
Volume describes a volume and parameters for it to be mounted to a VM.
|
| VolumeProto |
| Enum | Description |
|---|---|
| AllocationPolicy.AttachedDisk.AttachedCase | |
| AllocationPolicy.Disk.DataSourceCase | |
| AllocationPolicy.InstancePolicyOrTemplate.PolicyTemplateCase | |
| AllocationPolicy.ProvisioningModel |
Compute Engine VM instance provisioning model.
|
| JobNotification.Type |
The message type.
|
| JobStatus.State |
Valid Job states.
|
| LifecyclePolicy.Action |
Action on task failures based on different conditions.
|
| LogsPolicy.Destination |
The destination (if any) for logs.
|
| Runnable.ExecutableCase | |
| Runnable.Script.CommandCase | |
| TaskGroup.SchedulingPolicy |
How Tasks in the TaskGroup should be scheduled relative to each other.
|
| TaskStatus.State |
Task states.
|
| Volume.SourceCase |
Copyright © 2025 Google LLC. All rights reserved.