Classes
AllocationPolicy
A Job's resource allocation policy describes when, where, and how compute resources should be allocated for the Job.
AllocationPolicy.Types
Container for nested types declared in the AllocationPolicy message type.
AllocationPolicy.Types.Accelerator
Accelerator describes Compute Engine accelerators to be attached to the VM.
AllocationPolicy.Types.AttachedDisk
A new or an existing persistent disk (PD) or a local ssd attached to a VM instance.
AllocationPolicy.Types.Disk
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.
AllocationPolicy.Types.InstancePolicy
InstancePolicy describes an instance type and resources attached to each VM created by this InstancePolicy.
AllocationPolicy.Types.InstancePolicyOrTemplate
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.
AllocationPolicy.Types.LocationPolicy
AllocationPolicy.Types.NetworkInterface
A network interface.
AllocationPolicy.Types.NetworkPolicy
NetworkPolicy describes VM instance network configurations.
AllocationPolicy.Types.PlacementPolicy
PlacementPolicy describes a group placement policy for the VMs controlled by this AllocationPolicy.
BatchService
Google Batch Service. The service manages user submitted batch jobs and allocates Google Compute Engine VM instances to run the jobs.
BatchService.BatchServiceBase
Base class for server-side implementations of BatchService
BatchService.BatchServiceClient
Client for BatchService
BatchServiceClient
BatchService client wrapper, for convenient use.
BatchServiceClientBuilder
Builder class for BatchServiceClient to provide simple configuration of credentials, endpoint etc.
BatchServiceClientImpl
BatchService client wrapper implementation, for convenient use.
BatchServiceSettings
Settings for BatchServiceClient instances.
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 field, make sure both fields are compatible with each other.
CreateJobRequest
CreateJob Request.
CreateResourceAllowanceRequest
CreateResourceAllowance Request.
DeleteJobRequest
DeleteJob Request.
DeleteResourceAllowanceRequest
DeleteResourceAllowance Request.
Environment
An Environment describes a collection of environment variables to set when executing Tasks.
Environment.Types
Container for nested types declared in the Environment message type.
Environment.Types.KMSEnvMap
GCS
Represents a Google Cloud Storage volume.
GetJobRequest
GetJob Request.
GetResourceAllowanceRequest
GetResourceAllowance Request.
GetTaskRequest
Request for a single Task by name.
Job
The Cloud Batch Job description.
Job.Types
Container for nested types declared in the Job message type.
JobDependency
JobDependency 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.
JobDependency.Types
Container for nested types declared in the JobDependency message type.
JobName
Resource name for the Job resource.
JobNotification
Notification configurations.
JobNotification.Types
Container for nested types declared in the JobNotification message type.
JobNotification.Types.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.
JobStatus
Job status.
JobStatus.Types
Container for nested types declared in the JobStatus message type.
JobStatus.Types.InstanceStatus
VM instance status.
JobStatus.Types.TaskGroupStatus
Aggregated task status for a TaskGroup.
LifecyclePolicy
LifecyclePolicy describes how to deal with task failures based on different conditions.
LifecyclePolicy.Types
Container for nested types declared in the LifecyclePolicy message type.
LifecyclePolicy.Types.ActionCondition
Conditions for actions to deal with task failures.
ListJobsRequest
ListJob Request.
ListJobsResponse
ListJob Response.
ListResourceAllowancesRequest
ListResourceAllowances Request.
ListResourceAllowancesResponse
ListResourceAllowances Response.
ListTasksRequest
ListTasks Request.
ListTasksResponse
ListTasks Response.
LogsPolicy
LogsPolicy describes how outputs from a Job's Tasks (stdout/stderr) will be preserved.
LogsPolicy.Types
Container for nested types declared in the LogsPolicy message type.
LogsPolicy.Types.CloudLoggingOption
CloudLoggingOption contains additional settings for Cloud Logging logs
generated by Batch job.
NFS
Represents an NFS volume.
Notification
Notification on resource state change.
OperationMetadata
Represents the metadata of the long-running operation.
PD
Deprecated: please use device_name instead.
ResourceAllowance
The Resource Allowance description for Cloud Batch. Only one Resource Allowance is supported now under a specific location and project.
ResourceAllowanceName
Resource name for the ResourceAllowance resource.
ResourceUsage
ResourceUsage describes the resource usage of the job.
Runnable
Runnable describes instructions for executing a specific script or container as part of a Task.
Runnable.Types
Container for nested types declared in the Runnable message type.
Runnable.Types.Barrier
Barrier runnable blocks until all tasks in a taskgroup reach it.
Runnable.Types.Container
Container runnable.
Runnable.Types.Script
Script runnable.
ServiceAccount
Carries information about a Google Cloud service account.
StatusEvent
Status event
Task
A Cloud Batch task.
TaskExecution
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.Types
Container for nested types declared in the TaskGroup message type.
TaskGroupName
Resource name for the TaskGroup resource.
TaskName
Resource name for the Task resource.
TaskResourceUsage
TaskResourceUsage describes the resource usage of the task.
TaskSpec
Spec of a task
TaskStatus
Status of a task
TaskStatus.Types
Container for nested types declared in the TaskStatus message type.
UpdateResourceAllowanceRequest
UpdateResourceAllowance Request.
UsageResourceAllowance
UsageResourceAllowance describes the detail of usage resource allowance.
UsageResourceAllowanceSpec
Spec of a usage ResourceAllowance.
UsageResourceAllowanceSpec.Types
Container for nested types declared in the UsageResourceAllowanceSpec message type.
UsageResourceAllowanceSpec.Types.Limit
UsageResourceAllowance limitation.
UsageResourceAllowanceStatus
Status of a usage ResourceAllowance.
UsageResourceAllowanceStatus.Types
Container for nested types declared in the UsageResourceAllowanceStatus message type.
UsageResourceAllowanceStatus.Types.ConsumptionReport
ConsumptionReport is the report of ResourceAllowance consumptions in a time period.
UsageResourceAllowanceStatus.Types.LimitStatus
UsageResourceAllowanceStatus detail about usage consumption.
UsageResourceAllowanceStatus.Types.PeriodConsumption
Volume
Volume describes a volume and parameters for it to be mounted to a VM.
Enums
AllocationPolicy.Types.AttachedDisk.AttachedOneofCase
Enum of possible cases for the "attached" oneof.
AllocationPolicy.Types.Disk.DataSourceOneofCase
Enum of possible cases for the "data_source" oneof.
AllocationPolicy.Types.InstancePolicyOrTemplate.PolicyTemplateOneofCase
Enum of possible cases for the "policy_template" oneof.
AllocationPolicy.Types.ProvisioningModel
Compute Engine VM instance provisioning model.
CalendarPeriod
A CalendarPeriod represents 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).
Job.Types.SchedulingPolicy
The order that TaskGroups are scheduled relative to each other.
Not yet implemented.
JobDependency.Types.Type
Dependency type.
JobName.ResourceNameType
The possible contents of JobName.
JobNotification.Types.Type
The message type.
JobStatus.Types.State
Valid Job states.
LifecyclePolicy.Types.Action
Action on task failures based on different conditions.
LogsPolicy.Types.Destination
The destination (if any) for logs.
ResourceAllowance.ResourceAllowanceOneofCase
Enum of possible cases for the "resource_allowance" oneof.
ResourceAllowanceName.ResourceNameType
The possible contents of ResourceAllowanceName.
ResourceAllowanceState
ResourceAllowance valid state.
Runnable.ExecutableOneofCase
Enum of possible cases for the "executable" oneof.
Runnable.Types.Script.CommandOneofCase
Enum of possible cases for the "command" oneof.
TaskGroup.Types.SchedulingPolicy
How Tasks in the TaskGroup should be scheduled relative to each other.
TaskGroupName.ResourceNameType
The possible contents of TaskGroupName.
TaskName.ResourceNameType
The possible contents of TaskName.
TaskStatus.Types.State
Task states.
UsageResourceAllowanceSpec.Types.Limit.DurationOneofCase
Enum of possible cases for the "duration" oneof.
Volume.SourceOneofCase
Enum of possible cases for the "source" oneof.