View Source API Reference google_api_batch v0.2.2
Modules
API client metadata for GoogleApi.Batch.V1.
API calls for all endpoints tagged Projects
.
Handle Tesla connections for GoogleApi.Batch.V1.
Accelerator describes Compute Engine accelerators to be attached to the VM.
Conditions for actions to deal with task failures.
Container runnable representation on the agent side.
AgentEnvironment is the Environment representation between Agent and CLH communication. The environment is used in both task level and agent level.
VM Agent Info.
AgentKMSEnvMap contains the encrypted key/value pair to be used in the environment on the Agent side.
VM Agent Metadata.
Script runnable representation on the agent side.
TODO(b/182501497) The message needs to be redefined when the Agent API server updates data in storage per the backend design.
Task Info
AgentTaskRunnable is the Runnable representation between Agent and CLH communication.
AgentTaskSpec is the user's TaskSpec representation between Agent and CLH communication.
AgentTaskUserAccount contains the information of a POSIX account on the guest os which is used to execute the runnables.
VM timing information
A Job's resource allocation policy describes when, where, and how compute resources should be allocated for the Job.
A new or an existing persistent disk (PD) or a local ssd attached to a VM instance.
Barrier runnable blocks until all tasks in a taskgroup reach it.
The request message for Operations.CancelOperation.
CloudLoggingOption
contains additional settings for Cloud Logging logs generated by Batch job.
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 runnable.
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.
A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
An Environment describes a collection of environment variables to set when executing Tasks.
Represents a Google Cloud Storage volume.
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.
VM instance status.
The Cloud Batch Job description.
Notification configurations.
Job status.
LifecyclePolicy describes how to deal with task failures based on different conditions.
ListJob Response.
The response message for Locations.ListLocations.
The response message for Operations.ListOperations.
ListTasks Response.
A resource that represents a Google Cloud location.
Attributes
-
allowedLocations
(type:list(String.t)
, default:nil
) - A list of allowed location names represented by internal URLs. Each location can be a region or a zone. Only one region or multiple zones in one region is supported now. For example, ["regions/us-central1"] allow VMs in any zones in region us-central1. ["zones/us-central1-a", "zones/us-central1-c"] only allow VMs in zones us-central1-a and us-central1-c. All locations end up in different regions would cause errors. For example, ["regions/us-central1", "zones/us-central1-a", "zones/us-central1-b", "zones/us-west1-a"] contains 2 regions "us-central1" and "us-west1". An error is expected in this case.
LogsPolicy describes how outputs from a Job's Tasks (stdout/stderr) will be preserved.
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.
Represents an NFS volume.
A network interface.
NetworkPolicy describes VM instance network configurations.
This resource represents a long-running operation that is the result of a network API call.
Represents the metadata of the long-running operation.
PlacementPolicy describes a group placement policy for the VMs controlled by this AllocationPolicy.
Request to report agent's state. The Request itself implies the agent is healthy.
Response to ReportAgentStateRequest.
Runnable describes instructions for executing a specific script or container as part of a Task.
Script runnable.
Carries information about a Google Cloud service account.
The Status
type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status
message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide.
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.
Aggregated task status for a TaskGroup.
Spec of a task
Status of a task
Volume describes a volume and parameters for it to be mounted to a VM.