Summary of entries of Classes for batch.
Classes
BatchServiceAsyncClient
Google Batch Service. The service manages user submitted batch jobs and allocates Google Compute Engine VM instances to run the jobs.
BatchServiceClient
Google Batch Service. The service manages user submitted batch jobs and allocates Google Compute Engine VM instances to run the jobs.
ListJobsAsyncPager
A pager for iterating through list_jobs requests.
This class thinly wraps an initial
ListJobsResponse object, and
provides an __aiter__ method to iterate through its
jobs field.
If there are more pages, the __aiter__ method will make additional
ListJobs requests and continue to iterate
through the jobs field on the
corresponding responses.
All the usual ListJobsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.
ListJobsPager
A pager for iterating through list_jobs requests.
This class thinly wraps an initial
ListJobsResponse object, and
provides an __iter__ method to iterate through its
jobs field.
If there are more pages, the __iter__ method will make additional
ListJobs requests and continue to iterate
through the jobs field on the
corresponding responses.
All the usual ListJobsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.
ListTasksAsyncPager
A pager for iterating through list_tasks requests.
This class thinly wraps an initial
ListTasksResponse object, and
provides an __aiter__ method to iterate through its
tasks field.
If there are more pages, the __aiter__ method will make additional
ListTasks requests and continue to iterate
through the tasks field on the
corresponding responses.
All the usual ListTasksResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.
ListTasksPager
A pager for iterating through list_tasks requests.
This class thinly wraps an initial
ListTasksResponse object, and
provides an __iter__ method to iterate through its
tasks field.
If there are more pages, the __iter__ method will make additional
ListTasks requests and continue to iterate
through the tasks field on the
corresponding responses.
All the usual ListTasksResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.
AllocationPolicy
A Job's resource allocation policy describes when, where, and how compute resources should be allocated for the Job.
Accelerator
Accelerator describes Compute Engine accelerators to be attached to the VM.
AttachedDisk
A new or an existing persistent disk (PD) or a local ssd attached to a VM instance.
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
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.
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
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.
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
LabelsEntry
The abstract base class for a message.
LocationPolicy
NetworkInterface
A network interface.
NetworkPolicy
NetworkPolicy describes VM instance network configurations.
PlacementPolicy
PlacementPolicy describes a group placement policy for the VMs controlled by this AllocationPolicy.
ProvisioningModel
Compute Engine VM instance provisioning model.
Above SPOT VM is the preferable model for
preemptible VM instances: the old preemptible VM
model (indicated by this field) is the older
model, and has been migrated to use the SPOT
model as the underlying technology. This old
model will still be supported.
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.
DeleteJobRequest
DeleteJob Request.
Environment
An Environment describes a collection of environment variables to set when executing Tasks.
KMSEnvMap
SecretVariablesEntry
The abstract base class for a message.
VariablesEntry
The abstract base class for a message.
GCS
Represents a Google Cloud Storage volume.
GetJobRequest
GetJob Request.
GetTaskRequest
Request for a single Task by name.
Job
The Cloud Batch Job description.
LabelsEntry
The abstract base class for a message.
JobNotification
Notification configurations.
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.
Type
The message type.
JobStatus
Job status.
InstanceStatus
VM instance status.
State
Valid Job states.
TaskGroupStatus
Aggregated task status for a TaskGroup.
CountsEntry
The abstract base class for a message.
TaskGroupsEntry
The abstract base class for a message.
LifecyclePolicy
LifecyclePolicy describes how to deal with task failures based on different conditions.
Action
Action on task failures based on different conditions.
ActionCondition
Conditions for actions to deal with task failures.
ListJobsRequest
ListJob Request.
ListJobsResponse
ListJob Response.
ListTasksRequest
ListTasks Request.
ListTasksResponse
ListTasks Response.
LogsPolicy
LogsPolicy describes if and how a job's logs are preserved. Logs
include information that is automatically written by the Batch
service agent and any information that you configured the job's
runnables to write to the stdout or stderr streams.
CloudLoggingOption
CloudLoggingOption contains additional settings for Cloud
Logging logs generated by Batch job.
Destination
The destination (if any) for logs.
NFS
Represents an NFS volume.
OperationMetadata
Represents the metadata of the long-running operation.
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
Barrier
A barrier runnable automatically blocks the execution of subsequent runnables until all the tasks in the task group reach the barrier.
Container
Container runnable.
LabelsEntry
The abstract base class for a message.
Script
Script runnable.
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.
SchedulingPolicy
How Tasks in the TaskGroup should be scheduled relative to each other.
Tasks might be executed in parallel depending on parallelism
and task_count values.
IN_ORDER (2):
Run Tasks sequentially with increased task
index.
TaskSpec
Spec of a task
EnvironmentsEntry
The abstract base class for a message.
TaskStatus
Status of a task.
State
Task states.
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
BatchServiceAsyncClient
Google Batch Service. The service manages user submitted batch jobs and allocates Google Compute Engine VM instances to run the jobs.
BatchServiceClient
Google Batch Service. The service manages user submitted batch jobs and allocates Google Compute Engine VM instances to run the jobs.
ListJobsAsyncPager
A pager for iterating through list_jobs requests.
This class thinly wraps an initial
ListJobsResponse object, and
provides an __aiter__ method to iterate through its
jobs field.
If there are more pages, the __aiter__ method will make additional
ListJobs requests and continue to iterate
through the jobs field on the
corresponding responses.
All the usual ListJobsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.
ListJobsPager
A pager for iterating through list_jobs requests.
This class thinly wraps an initial
ListJobsResponse object, and
provides an __iter__ method to iterate through its
jobs field.
If there are more pages, the __iter__ method will make additional
ListJobs requests and continue to iterate
through the jobs field on the
corresponding responses.
All the usual ListJobsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.
ListResourceAllowancesAsyncPager
A pager for iterating through list_resource_allowances requests.
This class thinly wraps an initial
ListResourceAllowancesResponse object, and
provides an __aiter__ method to iterate through its
resource_allowances field.
If there are more pages, the __aiter__ method will make additional
ListResourceAllowances requests and continue to iterate
through the resource_allowances field on the
corresponding responses.
All the usual ListResourceAllowancesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.
ListResourceAllowancesPager
A pager for iterating through list_resource_allowances requests.
This class thinly wraps an initial
ListResourceAllowancesResponse object, and
provides an __iter__ method to iterate through its
resource_allowances field.
If there are more pages, the __iter__ method will make additional
ListResourceAllowances requests and continue to iterate
through the resource_allowances field on the
corresponding responses.
All the usual ListResourceAllowancesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.
ListTasksAsyncPager
A pager for iterating through list_tasks requests.
This class thinly wraps an initial
ListTasksResponse object, and
provides an __aiter__ method to iterate through its
tasks field.
If there are more pages, the __aiter__ method will make additional
ListTasks requests and continue to iterate
through the tasks field on the
corresponding responses.
All the usual ListTasksResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.
ListTasksPager
A pager for iterating through list_tasks requests.
This class thinly wraps an initial
ListTasksResponse object, and
provides an __iter__ method to iterate through its
tasks field.
If there are more pages, the __iter__ method will make additional
ListTasks requests and continue to iterate
through the tasks field on the
corresponding responses.
All the usual ListTasksResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.
AllocationPolicy
A Job's resource allocation policy describes when, where, and how compute resources should be allocated for the Job.
Accelerator
Accelerator describes Compute Engine accelerators to be attached to the VM.
AttachedDisk
A new or an existing persistent disk (PD) or a local ssd attached to a VM instance.
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
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.
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
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.
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
LabelsEntry
The abstract base class for a message.
LocationPolicy
NetworkInterface
A network interface.
NetworkPolicy
NetworkPolicy describes VM instance network configurations.
PlacementPolicy
PlacementPolicy describes a group placement policy for the VMs controlled by this AllocationPolicy.
ProvisioningModel
Compute Engine VM instance provisioning model.
Above SPOT VM is the preferable model for
preemptible VM instances: the old preemptible VM
model (indicated by this field) is the older
model, and has been migrated to use the SPOT
model as the underlying technology. This old
model will still be supported.
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.
KMSEnvMap
SecretVariablesEntry
The abstract base class for a message.
VariablesEntry
The abstract base class for a message.
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.
LabelsEntry
The abstract base class for a message.
SchedulingPolicy
The order that TaskGroups are scheduled relative to each other. Not yet implemented.
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.
ItemsEntry
The abstract base class for a message.
Type
Dependency type.
JobNotification
Notification configurations.
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.
Type
The message type.
JobStatus
Job status.
InstanceStatus
VM instance status.
State
Valid Job states.
TaskGroupStatus
Aggregated task status for a TaskGroup.
CountsEntry
The abstract base class for a message.
TaskGroupsEntry
The abstract base class for a message.
LifecyclePolicy
LifecyclePolicy describes how to deal with task failures based on different conditions.
Action
Action on task failures based on different conditions.
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 if and how a job's logs are preserved. Logs
include information that is automatically written by the Batch
service agent and any information that you configured the job's
runnables to write to the stdout or stderr streams.
CloudLoggingOption
CloudLoggingOption contains additional settings for Cloud
Logging logs generated by Batch job.
Destination
The destination (if any) for logs.
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
LabelsEntry
The abstract base class for a message.
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
Barrier
A barrier runnable automatically blocks the execution of subsequent runnables until all the tasks in the task group reach the barrier.
Container
Container runnable.
LabelsEntry
The abstract base class for a message.
Script
Script runnable.
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.
LabelsEntry
The abstract base class for a message.
SchedulingPolicy
How Tasks in the TaskGroup should be scheduled relative to each other.
Tasks might be executed in parallel depending on parallelism
and task_count values.
IN_ORDER (2):
Run Tasks sequentially with increased task
index.
TaskResourceUsage
TaskResourceUsage describes the resource usage of the task.
TaskSpec
Spec of a task
EnvironmentsEntry
The abstract base class for a message.
TaskStatus
Status of a task.
State
Task states.
UpdateJobRequest
UpdateJob Request.
UpdateResourceAllowanceRequest
UpdateResourceAllowance Request.
UsageResourceAllowance
UsageResourceAllowance describes the detail of usage resource allowance.
UsageResourceAllowanceSpec
Spec of a usage ResourceAllowance.
Limit
UsageResourceAllowance limitation.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
UsageResourceAllowanceStatus
Status of a usage ResourceAllowance.
ConsumptionReport
ConsumptionReport is the report of ResourceAllowance consumptions in a time period.
LatestPeriodConsumptionsEntry
The abstract base class for a message.
LimitStatus
UsageResourceAllowanceStatus detail about usage consumption.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
PeriodConsumption
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
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
Modules
pagers
API documentation for batch_v1.services.batch_service.pagers module.
pagers
API documentation for batch_v1alpha.services.batch_service.pagers module.