Show / Hide Table of Contents

Namespace Google.Apis.Batch.v1.Data

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. The environment is used in both task level and agent level.

AgentInfo

VM Agent Info.

AgentKMSEnvMap

AgentKMSEnvMap contains the encrypted key/value pair to be used in the environment on the Agent side.

AgentMetadata

VM Agent Metadata.

AgentScript

Script runnable representation on the agent side.

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

AgentTaskLoggingOption

AgentTaskLoggingOption contains the options for the logging of the task.

AgentTaskRunnable

AgentTaskRunnable is the Runnable representation between Agent and CLH communication.

AgentTaskSpec

AgentTaskSpec is the user's TaskSpec representation between Agent and CLH communication.

AgentTaskUserAccount

AgentTaskUserAccount contains the information of a POSIX account on the guest os which is used to execute the runnables.

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

A barrier runnable automatically blocks the execution of subsequent runnables until all the tasks in the task group reach the barrier.

CancelJobRequest

CancelJob Request.

CancelOperationRequest

The request message for Operations.CancelOperation.

CloudLoggingOption

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

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 field, make sure both fields are compatible with each other.

Container

Container runnable.

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.

Empty

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); }

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. If undefined, Batch picks the type of VM to use and doesn't include optional VM resources such as GPUs and extra disks.

InstanceStatus

VM instance status.

Job

The Cloud Batch Job description.

JobNotification

Notification configurations.

JobStatus

Job status.

KMSEnvMap

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.

Location

A resource that represents a Google Cloud location.

LocationPolicy

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.

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.

NFS

Represents an NFS volume.

NetworkInterface

A network interface.

NetworkPolicy

NetworkPolicy describes VM instance network configurations.

Operation

This resource represents a long-running operation that is the result of a network API call.

OperationMetadata

Represents the metadata of the long-running operation.

PlacementPolicy

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

ReportAgentStateRequest

Request to report agent's state. The Request itself implies the agent is healthy.

ReportAgentStateResponse

Response to ReportAgentStateRequest.

Runnable

Runnable describes instructions for executing a specific script or container as part of a Task.

Script

Script runnable.

ServiceAccount

Carries information about a Google Cloud service account.

Status

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.

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.

In this article
Back to top Generated by DocFX