- 0.54.0 (latest)
- 0.53.0
- 0.52.0
- 0.51.0
- 0.49.0
- 0.48.0
- 0.47.0
- 0.46.0
- 0.45.0
- 0.44.0
- 0.43.0
- 0.42.0
- 0.41.0
- 0.40.0
- 0.39.0
- 0.37.0
- 0.36.0
- 0.35.0
- 0.34.0
- 0.33.0
- 0.32.0
- 0.31.0
- 0.30.0
- 0.29.0
- 0.28.0
- 0.27.0
- 0.24.0
- 0.23.0
- 0.22.0
- 0.21.0
- 0.20.0
- 0.19.0
- 0.18.0
- 0.17.0
- 0.16.0
- 0.15.0
- 0.14.0
- 0.13.0
- 0.12.0
- 0.11.0
- 0.10.0
- 0.9.0
- 0.8.0
- 0.7.0
- 0.6.0
- 0.5.0
- 0.4.0
- 0.3.2
- 0.2.2
- 0.1.1
Package com.google.cloud.batch.v1 (0.53.0)
| GitHub Repository |
Client Classes
Client classes are the main entry point to using a package. They contain several variations of Java methods for each of the API's methods.
| Client | Description |
|---|---|
| com.google.cloud.batch.v1.BatchServiceClient |
Service Description: Google Batch Service. The service manages user submitted batch jobs and
allocates Google Compute Engine VM instances to run the jobs.
This class provides the ability to make remote calls to the backing service through method |
Settings Classes
Settings classes can be used to configure credentials, endpoints, and retry settings for a Client.
| Settings | Description |
|---|---|
| com.google.cloud.batch.v1.BatchServiceSettings |
Settings class to configure an instance of BatchServiceClient.
The default instance has everything set to sensible defaults: |
Classes
| Class | Description |
|---|---|
| com.google.cloud.batch.v1.AllocationPolicy | A Job's resource allocation policy describes when, where, and how compute resources should be allocated for the Job. |
| com.google.cloud.batch.v1.AllocationPolicy.Accelerator | Accelerator describes Compute Engine accelerators to be attached to the VM. |
| com.google.cloud.batch.v1.AllocationPolicy.Accelerator.Builder | Accelerator describes Compute Engine accelerators to be attached to the VM. |
| com.google.cloud.batch.v1.AllocationPolicy.AttachedDisk | A new or an existing persistent disk (PD) or a local ssd attached to a VM instance. |
| com.google.cloud.batch.v1.AllocationPolicy.AttachedDisk.Builder | A new or an existing persistent disk (PD) or a local ssd attached to a VM instance. |
| com.google.cloud.batch.v1.AllocationPolicy.Builder | A Job's resource allocation policy describes when, where, and how compute resources should be allocated for the Job. |
| com.google.cloud.batch.v1.AllocationPolicy.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 |
| com.google.cloud.batch.v1.AllocationPolicy.Disk.Builder | 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 |
| com.google.cloud.batch.v1.AllocationPolicy.InstancePolicy | InstancePolicy describes an instance type and resources attached to each VM created by this InstancePolicy. |
| com.google.cloud.batch.v1.AllocationPolicy.InstancePolicy.Builder | InstancePolicy describes an instance type and resources attached to each VM created by this InstancePolicy. |
| com.google.cloud.batch.v1.AllocationPolicy.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 |
| com.google.cloud.batch.v1.AllocationPolicy.InstancePolicyOrTemplate.Builder | 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 |
| com.google.cloud.batch.v1.AllocationPolicy.LocationPolicy |
Protobuf type google.cloud.batch.v1.AllocationPolicy.LocationPolicy |
| com.google.cloud.batch.v1.AllocationPolicy.LocationPolicy.Builder |
Protobuf type google.cloud.batch.v1.AllocationPolicy.LocationPolicy |
| com.google.cloud.batch.v1.AllocationPolicy.NetworkInterface | A network interface. |
| com.google.cloud.batch.v1.AllocationPolicy.NetworkInterface.Builder | A network interface. |
| com.google.cloud.batch.v1.AllocationPolicy.NetworkPolicy | NetworkPolicy describes VM instance network configurations. |
| com.google.cloud.batch.v1.AllocationPolicy.NetworkPolicy.Builder | NetworkPolicy describes VM instance network configurations. |
| com.google.cloud.batch.v1.AllocationPolicy.PlacementPolicy | PlacementPolicy describes a group placement policy for the VMs controlled by this AllocationPolicy. |
| com.google.cloud.batch.v1.AllocationPolicy.PlacementPolicy.Builder | PlacementPolicy describes a group placement policy for the VMs controlled by this AllocationPolicy. |
| com.google.cloud.batch.v1.BatchProto | |
| com.google.cloud.batch.v1.BatchServiceClient.ListJobsFixedSizeCollection | |
| com.google.cloud.batch.v1.BatchServiceClient.ListJobsPage | |
| com.google.cloud.batch.v1.BatchServiceClient.ListJobsPagedResponse | |
| com.google.cloud.batch.v1.BatchServiceClient.ListLocationsFixedSizeCollection | |
| com.google.cloud.batch.v1.BatchServiceClient.ListLocationsPage | |
| com.google.cloud.batch.v1.BatchServiceClient.ListLocationsPagedResponse | |
| com.google.cloud.batch.v1.BatchServiceClient.ListTasksFixedSizeCollection | |
| com.google.cloud.batch.v1.BatchServiceClient.ListTasksPage | |
| com.google.cloud.batch.v1.BatchServiceClient.ListTasksPagedResponse | |
| com.google.cloud.batch.v1.BatchServiceGrpc | Google Batch Service. The service manages user submitted batch jobs and allocates Google Compute Engine VM instances to run the jobs. |
| com.google.cloud.batch.v1.BatchServiceGrpc.BatchServiceImplBase | Base class for the server implementation of the service BatchService. Google Batch Service. |
| com.google.cloud.batch.v1.BatchServiceSettings.Builder | Builder for BatchServiceSettings. |
| com.google.cloud.batch.v1.ComputeResource | Compute resource requirements. ComputeResource defines the amount of resources required for each task. |
| com.google.cloud.batch.v1.ComputeResource.Builder | Compute resource requirements. ComputeResource defines the amount of resources required for each task. |
| com.google.cloud.batch.v1.CreateJobRequest | CreateJob Request. |
| com.google.cloud.batch.v1.CreateJobRequest.Builder | CreateJob Request. |
| com.google.cloud.batch.v1.DeleteJobRequest | DeleteJob Request. |
| com.google.cloud.batch.v1.DeleteJobRequest.Builder | DeleteJob Request. |
| com.google.cloud.batch.v1.Environment | An Environment describes a collection of environment variables to set when executing Tasks. |
| com.google.cloud.batch.v1.Environment.Builder | An Environment describes a collection of environment variables to set when executing Tasks. |
| com.google.cloud.batch.v1.Environment.KMSEnvMap |
Protobuf type google.cloud.batch.v1.Environment.KMSEnvMap |
| com.google.cloud.batch.v1.Environment.KMSEnvMap.Builder |
Protobuf type google.cloud.batch.v1.Environment.KMSEnvMap |
| com.google.cloud.batch.v1.GCS | Represents a Google Cloud Storage volume. |
| com.google.cloud.batch.v1.GCS.Builder | Represents a Google Cloud Storage volume. |
| com.google.cloud.batch.v1.GetJobRequest | GetJob Request. |
| com.google.cloud.batch.v1.GetJobRequest.Builder | GetJob Request. |
| com.google.cloud.batch.v1.GetTaskRequest | Request for a single Task by name. |
| com.google.cloud.batch.v1.GetTaskRequest.Builder | Request for a single Task by name. |
| com.google.cloud.batch.v1.Job | The Cloud Batch Job description. |
| com.google.cloud.batch.v1.Job.Builder | The Cloud Batch Job description. |
| com.google.cloud.batch.v1.JobName | |
| com.google.cloud.batch.v1.JobName.Builder | Builder for projects/{project}/locations/{location}/jobs/{job}. |
| com.google.cloud.batch.v1.JobNotification | Notification configurations. |
| com.google.cloud.batch.v1.JobNotification.Builder | Notification configurations. |
| com.google.cloud.batch.v1.JobNotification.Message | Message details. Describe the conditions under which messages will be sent. If no attribute is defined, no message will be sent by default. |
| com.google.cloud.batch.v1.JobNotification.Message.Builder | Message details. Describe the conditions under which messages will be sent. If no attribute is defined, no message will be sent by default. |
| com.google.cloud.batch.v1.JobProto | |
| com.google.cloud.batch.v1.JobStatus | Job status. |
| com.google.cloud.batch.v1.JobStatus.Builder | Job status. |
| com.google.cloud.batch.v1.JobStatus.InstanceStatus | VM instance status. |
| com.google.cloud.batch.v1.JobStatus.InstanceStatus.Builder | VM instance status. |
| com.google.cloud.batch.v1.JobStatus.TaskGroupStatus | Aggregated task status for a TaskGroup. |
| com.google.cloud.batch.v1.JobStatus.TaskGroupStatus.Builder | Aggregated task status for a TaskGroup. |
| com.google.cloud.batch.v1.LifecyclePolicy | LifecyclePolicy describes how to deal with task failures based on different conditions. |
| com.google.cloud.batch.v1.LifecyclePolicy.ActionCondition | Conditions for actions to deal with task failures. |
| com.google.cloud.batch.v1.LifecyclePolicy.ActionCondition.Builder | Conditions for actions to deal with task failures. |
| com.google.cloud.batch.v1.LifecyclePolicy.Builder | LifecyclePolicy describes how to deal with task failures based on different conditions. |
| com.google.cloud.batch.v1.ListJobsRequest | ListJob Request. |
| com.google.cloud.batch.v1.ListJobsRequest.Builder | ListJob Request. |
| com.google.cloud.batch.v1.ListJobsResponse | ListJob Response. |
| com.google.cloud.batch.v1.ListJobsResponse.Builder | ListJob Response. |
| com.google.cloud.batch.v1.ListTasksRequest | ListTasks Request. |
| com.google.cloud.batch.v1.ListTasksRequest.Builder | ListTasks Request. |
| com.google.cloud.batch.v1.ListTasksResponse | ListTasks Response. |
| com.google.cloud.batch.v1.ListTasksResponse.Builder | ListTasks Response. |
| com.google.cloud.batch.v1.LocationName | |
| com.google.cloud.batch.v1.LocationName.Builder | Builder for projects/{project}/locations/{location}. |
| com.google.cloud.batch.v1.LogsPolicy | LogsPolicy describes how outputs from a Job's Tasks (stdout/stderr) will be preserved. |
| com.google.cloud.batch.v1.LogsPolicy.Builder | LogsPolicy describes how outputs from a Job's Tasks (stdout/stderr) will be preserved. |
| com.google.cloud.batch.v1.LogsPolicy.CloudLoggingOption |
CloudLoggingOption contains additional settings for Cloud Logging logs
generated by Batch job.
|
| com.google.cloud.batch.v1.LogsPolicy.CloudLoggingOption.Builder |
CloudLoggingOption contains additional settings for Cloud Logging logs
generated by Batch job.
|
| com.google.cloud.batch.v1.NFS | Represents an NFS volume. |
| com.google.cloud.batch.v1.NFS.Builder | Represents an NFS volume. |
| com.google.cloud.batch.v1.OperationMetadata | Represents the metadata of the long-running operation. |
| com.google.cloud.batch.v1.OperationMetadata.Builder | Represents the metadata of the long-running operation. |
| com.google.cloud.batch.v1.Runnable | Runnable describes instructions for executing a specific script or container as part of a Task. |
| com.google.cloud.batch.v1.Runnable.Barrier | A barrier runnable automatically blocks the execution of subsequent runnables until all the tasks in the task group reach the barrier. |
| com.google.cloud.batch.v1.Runnable.Barrier.Builder | A barrier runnable automatically blocks the execution of subsequent runnables until all the tasks in the task group reach the barrier. |
| com.google.cloud.batch.v1.Runnable.Builder | Runnable describes instructions for executing a specific script or container as part of a Task. |
| com.google.cloud.batch.v1.Runnable.Container | Container runnable. |
| com.google.cloud.batch.v1.Runnable.Container.Builder | Container runnable. |
| com.google.cloud.batch.v1.Runnable.Script | Script runnable. |
| com.google.cloud.batch.v1.Runnable.Script.Builder | Script runnable. |
| com.google.cloud.batch.v1.ServiceAccount | Carries information about a Google Cloud service account. |
| com.google.cloud.batch.v1.ServiceAccount.Builder | Carries information about a Google Cloud service account. |
| com.google.cloud.batch.v1.StatusEvent | Status event. |
| com.google.cloud.batch.v1.StatusEvent.Builder | Status event. |
| com.google.cloud.batch.v1.Task | A Cloud Batch task. |
| com.google.cloud.batch.v1.Task.Builder | A Cloud Batch task. |
| com.google.cloud.batch.v1.TaskExecution | This Task Execution field includes detail information for task execution procedures, based on StatusEvent types. |
| com.google.cloud.batch.v1.TaskExecution.Builder | This Task Execution field includes detail information for task execution procedures, based on StatusEvent types. |
| com.google.cloud.batch.v1.TaskGroup | A TaskGroup defines one or more Tasks that all share the same TaskSpec. |
| com.google.cloud.batch.v1.TaskGroup.Builder | A TaskGroup defines one or more Tasks that all share the same TaskSpec. |
| com.google.cloud.batch.v1.TaskGroupName | |
| com.google.cloud.batch.v1.TaskGroupName.Builder | Builder for projects/{project}/locations/{location}/jobs/{job}/taskGroups/{task_group}. |
| com.google.cloud.batch.v1.TaskName | |
| com.google.cloud.batch.v1.TaskName.Builder | Builder for projects/{project}/locations/{location}/jobs/{job}/taskGroups/{task_group}/tasks/{task}. |
| com.google.cloud.batch.v1.TaskProto | |
| com.google.cloud.batch.v1.TaskSpec | Spec of a task |
| com.google.cloud.batch.v1.TaskSpec.Builder | Spec of a task |
| com.google.cloud.batch.v1.TaskStatus | Status of a task. |
| com.google.cloud.batch.v1.TaskStatus.Builder | Status of a task. |
| com.google.cloud.batch.v1.Volume | Volume describes a volume and parameters for it to be mounted to a VM. |
| com.google.cloud.batch.v1.Volume.Builder | Volume describes a volume and parameters for it to be mounted to a VM. |
| com.google.cloud.batch.v1.VolumeProto |
Interfaces
Enums
| Enum | Description |
|---|---|
| com.google.cloud.batch.v1.AllocationPolicy.AttachedDisk.AttachedCase | |
| com.google.cloud.batch.v1.AllocationPolicy.Disk.DataSourceCase | |
| com.google.cloud.batch.v1.AllocationPolicy.InstancePolicyOrTemplate.PolicyTemplateCase | |
| com.google.cloud.batch.v1.AllocationPolicy.ProvisioningModel | Compute Engine VM instance provisioning model. |
| com.google.cloud.batch.v1.JobNotification.Type | The message type. |
| com.google.cloud.batch.v1.JobStatus.State | Valid Job states. |
| com.google.cloud.batch.v1.LifecyclePolicy.Action | Action on task failures based on different conditions. |
| com.google.cloud.batch.v1.LogsPolicy.Destination | The destination (if any) for logs. |
| com.google.cloud.batch.v1.Runnable.ExecutableCase | |
| com.google.cloud.batch.v1.Runnable.Script.CommandCase | |
| com.google.cloud.batch.v1.TaskGroup.SchedulingPolicy | How Tasks in the TaskGroup should be scheduled relative to each other. |
| com.google.cloud.batch.v1.TaskStatus.State | Task states. |
| com.google.cloud.batch.v1.Volume.SourceCase |