Package Classes (0.17.19)

Google Batch Service. The service manages user submitted batch jobs and allocates Google Compute Engine VM instances to run the jobs.

Google Batch Service. The service manages user submitted batch jobs and allocates Google Compute Engine VM instances to run the jobs.

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.

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.

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.

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.

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

Accelerator describes Compute Engine accelerators to be attached to the VM.

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

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 describes an instance type and resources attached to each VM created by this InstancePolicy.

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

The abstract base class for a message.

A network interface.

NetworkPolicy describes VM instance network configurations.

PlacementPolicy describes a group placement policy for the VMs controlled by this AllocationPolicy.

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.

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.

CreateJob Request.

DeleteJob Request.

An Environment describes a collection of environment variables to set when executing Tasks.

The abstract base class for a message.

The abstract base class for a message.

Represents a Google Cloud Storage volume.

GetJob Request.

Request for a single Task by name.

The Cloud Batch Job description.

The abstract base class for a message.

Notification configurations.

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.

The message type.

Job status.

VM instance status.

Valid Job states.

Aggregated task status for a TaskGroup.

The abstract base class for a message.

The abstract base class for a message.

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

Action on task failures based on different conditions.

Conditions for actions to deal with task failures.

ListJob Request.

ListJob Response.

ListTasks Request.

ListTasks Response.

LogsPolicy describes how outputs from a Job's Tasks (stdout/stderr) will be preserved.

CloudLoggingOption contains additional settings for Cloud Logging logs generated by Batch job.

The destination (if any) for logs.

Represents an NFS volume.

Represents the metadata of the long-running operation.

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 runnable blocks until all tasks in a taskgroup reach it.

Container runnable.

The abstract base class for a message.

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

Carries information about a Google Cloud service account.

Status event

A Cloud Batch task.

This Task Execution field includes detail information for task execution procedures, based on StatusEvent types.

A TaskGroup defines one or more Tasks that all share the same TaskSpec.

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.

Spec of a task

The abstract base class for a message.

Status of a task

Task states.

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

Google Batch Service. The service manages user submitted batch jobs and allocates Google Compute Engine VM instances to run the jobs.

Google Batch Service. The service manages user submitted batch jobs and allocates Google Compute Engine VM instances to run the jobs.

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.

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.

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.

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.

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.

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.

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

Accelerator describes Compute Engine accelerators to be attached to the VM.

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

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 describes an instance type and resources attached to each VM created by this InstancePolicy.

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

The abstract base class for a message.

A network interface.

NetworkPolicy describes VM instance network configurations.

PlacementPolicy describes a group placement policy for the VMs controlled by this AllocationPolicy.

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.

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

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.

CreateJob Request.

CreateResourceAllowance Request.

DeleteJob Request.

DeleteResourceAllowance Request.

An Environment describes a collection of environment variables to set when executing Tasks.

The abstract base class for a message.

The abstract base class for a message.

Represents a Google Cloud Storage volume.

GetJob Request.

GetResourceAllowance Request.

Request for a single Task by name.

The Cloud Batch Job description.

The abstract base class for a message.

The order that TaskGroups are scheduled relative to each other. Not yet implemented.

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.

The abstract base class for a message.

Dependency type.

Notification configurations.

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.

The message type.

Job status.

VM instance status.

Valid Job states.

Aggregated task status for a TaskGroup.

The abstract base class for a message.

The abstract base class for a message.

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

Action on task failures based on different conditions.

Conditions for actions to deal with task failures.

ListJob Request.

ListJob Response.

ListResourceAllowances Request.

ListResourceAllowances Response.

ListTasks Request.

ListTasks Response.

LogsPolicy describes how outputs from a Job's Tasks (stdout/stderr) will be preserved.

CloudLoggingOption contains additional settings for Cloud Logging logs generated by Batch job.

The destination (if any) for logs.

Represents an NFS volume.

Notification on resource state change.

Represents the metadata of the long-running operation.

Deprecated: please use device_name instead.

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

The abstract base class for a message.

ResourceAllowance valid state.

ResourceUsage describes the resource usage of the job.

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 runnable blocks until all tasks in a taskgroup reach it.

Container runnable.

The abstract base class for a message.

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

Carries information about a Google Cloud service account.

Status event

A Cloud Batch task.

This Task Execution field includes detail information for task execution procedures, based on StatusEvent types.

A TaskGroup defines one or more Tasks that all share the same TaskSpec.

The abstract base class for a message.

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 describes the resource usage of the task.

Spec of a task

The abstract base class for a message.

Status of a task

Task states.

UpdateResourceAllowance Request.

UsageResourceAllowance describes the detail of usage resource allowance.

Spec of a usage ResourceAllowance.

UsageResourceAllowance limitation.

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

Status of a usage ResourceAllowance.

ConsumptionReport is the report of ResourceAllowance consumptions in a time period.

The abstract base class for a message.

UsageResourceAllowanceStatus detail about usage consumption.

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

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

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

API documentation for batch_v1.services.batch_service.pagers module.

API documentation for batch_v1alpha.services.batch_service.pagers module.