batch/v1 library

Batch API - v1

An API to manage the running of batch jobs on Google Cloud Platform.

For more information, see cloud.google.com/batch/

Create an instance of BatchApi to access these resources:

Classes

Accelerator
Accelerator describes Compute Engine accelerators to be attached to the VM.
ActionCondition
Conditions for actions to deal with task failures.
AgentContainer
Container runnable representation on the agent side.
AgentEnvironment
AgentEnvironment is the Environment representation between Agent and CLH communication.
AgentInfo
VM Agent Info.
AgentMetadata
VM Agent Metadata.
AgentTask
TODO(b/182501497) The message needs to be redefined when the Agent API server updates data in storage per the backend design.
AgentTaskInfo
Task Info
AgentTaskRunnable
AgentTaskRunnable is the Runnable representation between Agent and CLH communication.
AgentTaskSpec
AgentTaskSpec is the user's TaskSpec representation between Agent and CLH communication.
AgentTimingInfo
VM timing information
AllocationPolicy
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.
Barrier
Barrier runnable blocks until all tasks in a taskgroup reach it.
BatchApi
An API to manage the running of batch jobs on Google Cloud Platform.
ComputeResource
Compute resource requirements.
Container
Container runnable.
Disk
A new persistent disk or a local ssd.
Environment
An Environment describes a collection of environment variables to set when executing Tasks.
GCS
Represents a Google Cloud Storage volume.
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.
InstanceStatus
VM instance status.
Job
The Cloud Batch Job description.
JobNotification
Notification configurations.
JobStatus
Job status.
LifecyclePolicy
LifecyclePolicy describes how to deal with task failures based on different conditions.
ListJobsResponse
ListJob Response.
ListLocationsResponse
The response message for Locations.ListLocations.
ListOperationsResponse
The response message for Operations.ListOperations.
ListTasksResponse
ListTasks Response.
LocationPolicy
LogsPolicy
LogsPolicy describes how outputs from a Job's Tasks (stdout/stderr) will be preserved.
Message
Message details.
NetworkInterface
A network interface.
NetworkPolicy
NetworkPolicy describes VM instance network configurations.
NFS
Represents an NFS volume.
Operation
This resource represents a long-running operation that is the result of a network API call.
PlacementPolicy
PlacementPolicy describes a group placement policy for the VMs controlled by this AllocationPolicy.
ProjectsLocationsJobsResource
ProjectsLocationsJobsTaskGroupsResource
ProjectsLocationsJobsTaskGroupsTasksResource
ProjectsLocationsOperationsResource
ProjectsLocationsResource
ProjectsLocationsStateResource
ProjectsResource
ReportAgentStateRequest
Request to report agent's state.
ReportAgentStateResponse
Response to ReportAgentStateRequest.
Runnable
Runnable describes instructions for executing a specific script or container as part of a Task.
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.
TaskGroupStatus
Aggregated task status for a TaskGroup.
TaskSpec
Spec of a task
TaskStatus
Status of a task
Volume
Volume describes a volume and parameters for it to be mounted to a VM.

Typedefs

AgentKMSEnvMap = $KMSEnvMap
AgentKMSEnvMap contains the encrypted key/value pair to be used in the environment on the Agent side.
AgentScript = $Script
Script runnable representation on the agent side.
CancelOperationRequest = $Empty
The request message for Operations.CancelOperation.
Empty = $Empty
A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs.
KMSEnvMap = $KMSEnvMap
Location = $Location00
A resource that represents a Google Cloud location.
Script = $Script
Script runnable.
Status = $Status
The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs.

Exceptions / Errors

ApiRequestError
Represents a general error reported by the API endpoint.
DetailedApiRequestError
Represents a specific error reported by the API endpoint.