Package com.google.cloud.batch.v1alpha (0.23.0)

A client to Batch API

The interfaces provided are listed below, along with usage samples.

BatchServiceClient

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

Sample for BatchServiceClient:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BatchServiceClient batchServiceClient = BatchServiceClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   Job job = Job.newBuilder().build();
   String jobId = "jobId101296568";
   Job response = batchServiceClient.createJob(parent, job, jobId);
 }

Classes

AllocationPolicy

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

Protobuf type google.cloud.batch.v1alpha.AllocationPolicy

AllocationPolicy.Accelerator

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

Protobuf type google.cloud.batch.v1alpha.AllocationPolicy.Accelerator

AllocationPolicy.Accelerator.Builder

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

Protobuf type google.cloud.batch.v1alpha.AllocationPolicy.Accelerator

AllocationPolicy.AttachedDisk

A new or an existing persistent disk (PD) or a local ssd attached to a VM instance.

Protobuf type google.cloud.batch.v1alpha.AllocationPolicy.AttachedDisk

AllocationPolicy.AttachedDisk.Builder

A new or an existing persistent disk (PD) or a local ssd attached to a VM instance.

Protobuf type google.cloud.batch.v1alpha.AllocationPolicy.AttachedDisk

AllocationPolicy.Builder

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

Protobuf type google.cloud.batch.v1alpha.AllocationPolicy

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 https://cloud.google.com/compute/docs/disks#localssds.

Protobuf type google.cloud.batch.v1alpha.AllocationPolicy.Disk

AllocationPolicy.Disk.Builder

Protobuf type google.cloud.batch.v1alpha.AllocationPolicy.Disk

AllocationPolicy.InstancePolicy

InstancePolicy describes an instance type and resources attached to each VM created by this InstancePolicy.

Protobuf type google.cloud.batch.v1alpha.AllocationPolicy.InstancePolicy

AllocationPolicy.InstancePolicy.Builder

InstancePolicy describes an instance type and resources attached to each VM created by this InstancePolicy.

Protobuf type google.cloud.batch.v1alpha.AllocationPolicy.InstancePolicy

AllocationPolicy.InstancePolicyOrTemplate

Either an InstancePolicy or an instance template.

Protobuf type google.cloud.batch.v1alpha.AllocationPolicy.InstancePolicyOrTemplate

AllocationPolicy.InstancePolicyOrTemplate.Builder

Either an InstancePolicy or an instance template.

Protobuf type google.cloud.batch.v1alpha.AllocationPolicy.InstancePolicyOrTemplate

AllocationPolicy.LocationPolicy

Protobuf type google.cloud.batch.v1alpha.AllocationPolicy.LocationPolicy

AllocationPolicy.LocationPolicy.Builder

Protobuf type google.cloud.batch.v1alpha.AllocationPolicy.LocationPolicy

AllocationPolicy.NetworkInterface

A network interface.

Protobuf type google.cloud.batch.v1alpha.AllocationPolicy.NetworkInterface

AllocationPolicy.NetworkInterface.Builder

A network interface.

Protobuf type google.cloud.batch.v1alpha.AllocationPolicy.NetworkInterface

AllocationPolicy.NetworkPolicy

NetworkPolicy describes VM instance network configurations.

Protobuf type google.cloud.batch.v1alpha.AllocationPolicy.NetworkPolicy

AllocationPolicy.NetworkPolicy.Builder

NetworkPolicy describes VM instance network configurations.

Protobuf type google.cloud.batch.v1alpha.AllocationPolicy.NetworkPolicy

AllocationPolicy.PlacementPolicy

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

Protobuf type google.cloud.batch.v1alpha.AllocationPolicy.PlacementPolicy

AllocationPolicy.PlacementPolicy.Builder

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

Protobuf type google.cloud.batch.v1alpha.AllocationPolicy.PlacementPolicy

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 calls that map to API methods. Sample code to get started:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BatchServiceClient batchServiceClient = BatchServiceClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   Job job = Job.newBuilder().build();
   String jobId = "jobId101296568";
   Job response = batchServiceClient.createJob(parent, job, jobId);
 }

Note: close() needs to be called on the BatchServiceClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().

The surface of this class includes several types of Java methods for each of the API's methods:

A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.

See the individual methods for example code.

Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.

This class can be customized by passing in a custom instance of BatchServiceSettings to create(). For example:

To customize credentials:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 BatchServiceSettings batchServiceSettings =
     BatchServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 BatchServiceClient batchServiceClient = BatchServiceClient.create(batchServiceSettings);

To customize the endpoint:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 BatchServiceSettings batchServiceSettings =
     BatchServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 BatchServiceClient batchServiceClient = BatchServiceClient.create(batchServiceSettings);

To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 BatchServiceSettings batchServiceSettings = BatchServiceSettings.newHttpJsonBuilder().build();
 BatchServiceClient batchServiceClient = BatchServiceClient.create(batchServiceSettings);

Please refer to the GitHub repository's samples for more quickstart code snippets.

BatchServiceClient.ListJobsFixedSizeCollection

BatchServiceClient.ListJobsPage

BatchServiceClient.ListJobsPagedResponse

BatchServiceClient.ListLocationsFixedSizeCollection

BatchServiceClient.ListLocationsPage

BatchServiceClient.ListLocationsPagedResponse