Package types (0.17.30)

API documentation for batch_v1alpha.types package.

Classes

AllocationPolicy

A Job's resource allocation policy describes when, where, and how compute resources should be allocated for the Job.

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).

CancelJobRequest

CancelJob Request.

CancelJobResponse

Response to the CancelJob request.

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 <https://cloud.google.com/batch/docs/reference/rest/v1/projects.locations.jobs#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.

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.

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.

JobNotification

Notification configurations.

JobStatus

Job status.

LifecyclePolicy

LifecyclePolicy describes how to deal with task failures based on different conditions.

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.

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.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

ResourceAllowanceState

ResourceAllowance valid state.

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.

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.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

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.

TaskResourceUsage

TaskResourceUsage describes the resource usage of the task.

TaskSpec

Spec of a task

TaskStatus

Status of a task.

UpdateJobRequest

UpdateJob Request.

UpdateResourceAllowanceRequest

UpdateResourceAllowance Request.

UsageResourceAllowance

UsageResourceAllowance describes the detail of usage resource allowance.

UsageResourceAllowanceSpec

Spec of a usage ResourceAllowance.

UsageResourceAllowanceStatus

Status of a usage ResourceAllowance.

Volume

Volume 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.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields