batch library

Classes

Accelerator
Accelerator describes Compute Engine accelerators to be attached to the VM.
AcceleratorResponse
Accelerator describes Compute Engine accelerators to be attached to the VM.
ActionCondition
Conditions for actions to deal with task failures.
ActionConditionResponse
Conditions for actions to deal with task failures.
AllocationPolicy
A Job's resource allocation policy describes when, where, and how compute resources should be allocated for the Job.
AllocationPolicyResponse
A Job's resource allocation policy describes when, where, and how compute resources should be allocated for the Job.
AttachedDisk
A new or an existing persistent disk (PD) or a local ssd attached to a VM instance.
AttachedDiskResponse
A new or an existing persistent disk (PD) or a local ssd attached to a VM instance.
Barrier
Barrier runnable blocks until all tasks in a taskgroup reach it.
BarrierResponse
Barrier runnable blocks until all tasks in a taskgroup reach it.
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.
ComputeResourceResponse
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.
Container
Container runnable.
ContainerResponse
Container runnable.
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.
DiskResponse
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.
Environment
An Environment describes a collection of environment variables to set when executing Tasks.
EnvironmentResponse
An Environment describes a collection of environment variables to set when executing Tasks.
GCS
Represents a Google Cloud Storage volume.
GCSResponse
Represents a Google Cloud Storage volume.
GetJobArgs
Arguments for getJob. Arguments for getJob.
GetJobResult
Result data returned by getJob.
InstancePolicy
InstancePolicy describes an instance type and resources attached to each VM created by this InstancePolicy.
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.
InstancePolicyOrTemplateResponse
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.
InstancePolicyResponse
InstancePolicy describes an instance type and resources attached to each VM created by this InstancePolicy.
Job
Create a Job. Auto-naming is currently not supported for this resource.
JobArgs
The set of arguments for Job. The set of arguments for Job.
JobNotification
Notification configurations.
JobNotificationResponse
Notification configurations.
JobStatusResponse
Job status.
KMSEnvMap
KMSEnvMapResponse
LifecyclePolicy
LifecyclePolicy describes how to deal with task failures based on different conditions.
LifecyclePolicyResponse
LifecyclePolicy describes how to deal with task failures based on different conditions.
LocationPolicy
LocationPolicyResponse
LogsPolicy
LogsPolicy describes how outputs from a Job's Tasks (stdout/stderr) will be preserved.
LogsPolicyResponse
LogsPolicy describes how outputs from a Job's Tasks (stdout/stderr) will be preserved.
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.
MessageResponse
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.
NetworkInterface
A network interface.
NetworkInterfaceResponse
A network interface.
NetworkPolicy
NetworkPolicy describes VM instance network configurations.
NetworkPolicyResponse
NetworkPolicy describes VM instance network configurations.
NFS
Represents an NFS volume.
NFSResponse
Represents an NFS volume.
PlacementPolicy
PlacementPolicy describes a group placement policy for the VMs controlled by this AllocationPolicy.
PlacementPolicyResponse
PlacementPolicy describes a group placement policy for the VMs controlled by this AllocationPolicy.
Runnable
Runnable describes instructions for executing a specific script or container as part of a Task.
RunnableResponse
Runnable describes instructions for executing a specific script or container as part of a Task.
Script
Script runnable.
ScriptResponse
Script runnable.
ServiceAccount
Carries information about a Google Cloud service account.
ServiceAccountResponse
Carries information about a Google Cloud service account.
StatusEventResponse
Status event
TaskExecutionResponse
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.
TaskGroupResponse
A TaskGroup defines one or more Tasks that all share the same TaskSpec.
TaskSpec
Spec of a task
TaskSpecResponse
Spec of a task
Volume
Volume describes a volume and parameters for it to be mounted to a VM.
VolumeResponse
Volume describes a volume and parameters for it to be mounted to a VM.

Enums

InstancePolicyProvisioningModel
The provisioning model.
LifecyclePolicyAction
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.
LogsPolicyDestination
Where logs should be saved.
MessageNewJobState
The new job state.
MessageNewTaskState
The new task state.
MessageType
The message type.
TaskGroupSchedulingPolicy
Scheduling policy for Tasks in the TaskGroup. The default value is AS_SOON_AS_POSSIBLE.

Functions

getJob(GetJobArgs args, {InvokeOptions? options}) → Future<GetJobResult>
Get a Job specified by its resource name. args Arguments passed to this invoke. Arguments for getJob. options Invoke options controlling this call.