com.google.cloud.run.v2

Class BuildsClient

java.lang.Object

com.google.cloud.run.v2.BuildsClient

All Implemented Interfaces:

com.google.api.gax.core.BackgroundResource, AutoCloseable

@Generated(value="by gapic-generator-java")
public class BuildsClient
extends Object
implements com.google.api.gax.core.BackgroundResource

Service Description: Cloud Run Build Control Plane API

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 (BuildsClient buildsClient = BuildsClient.create()) {
   SubmitBuildRequest request =
       SubmitBuildRequest.newBuilder()
           .setParent("parent-995424086")
           .setImageUri("imageUri-859610607")
           .setServiceAccount("serviceAccount1079137720")
           .setWorkerPool(
               WorkerPoolName.of("[PROJECT]", "[LOCATION]", "[WORKER_POOL]").toString())
           .addAllTags(new ArrayList<String>())
           .build();
   SubmitBuildResponse response = buildsClient.submitBuild(request);
 }
 

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

Methods

Method	Description	Method Variants
SubmitBuild	Submits a build in a given project.	Request object method variants only take one parameter, a request object, which must be constructed before the call. submitBuild(SubmitBuildRequest request) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. submitBuildCallable()

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 BuildsSettings 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
 BuildsSettings buildsSettings =
     BuildsSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 BuildsClient buildsClient = BuildsClient.create(buildsSettings);
 

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
 BuildsSettings buildsSettings = BuildsSettings.newBuilder().setEndpoint(myEndpoint).build();
 BuildsClient buildsClient = BuildsClient.create(buildsSettings);
 

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
 BuildsSettings buildsSettings = BuildsSettings.newHttpJsonBuilder().build();
 BuildsClient buildsClient = BuildsClient.create(buildsSettings);
 

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

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BuildsClient(BuildsSettings settings) Constructs an instance of BuildsClient, using the given settings.
protected	BuildsClient(BuildsStub stub)

Method Summary

Modifier and Type	Method and Description
boolean	awaitTermination(long duration, TimeUnit unit)
void	close()
static BuildsClient	create() Constructs an instance of BuildsClient with default settings.
static BuildsClient	create(BuildsSettings settings) Constructs an instance of BuildsClient, using the given settings.
static BuildsClient	create(BuildsStub stub) Constructs an instance of BuildsClient, using the given stub for making calls.
BuildsSettings	getSettings()
BuildsStub	getStub()
boolean	isShutdown()
boolean	isTerminated()
void	shutdown()
void	shutdownNow()
SubmitBuildResponse	submitBuild(SubmitBuildRequest request) Submits a build in a given project.
com.google.api.gax.rpc.UnaryCallable<SubmitBuildRequest,SubmitBuildResponse>	submitBuildCallable() Submits a build in a given project.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BuildsClient

protected BuildsClient(BuildsSettings settings)
                throws IOException

Constructs an instance of BuildsClient, using the given settings. This is protected so that it is easy to make a subclass, but otherwise, the static factory methods should be preferred.

Throws:

IOException

BuildsClient

protected BuildsClient(BuildsStub stub)

Method Detail

create

public static final BuildsClient create()
                                 throws IOException

Constructs an instance of BuildsClient with default settings.

Throws:

IOException

create

public static final BuildsClient create(BuildsSettings settings)
                                 throws IOException

Constructs an instance of BuildsClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.

Throws:

IOException

create

public static final BuildsClient create(BuildsStub stub)

Constructs an instance of BuildsClient, using the given stub for making calls. This is for advanced usage - prefer using create(BuildsSettings).

getSettings

public final BuildsSettings getSettings()

getStub

public BuildsStub getStub()

submitBuild

public final SubmitBuildResponse submitBuild(SubmitBuildRequest request)

Submits a build in a given project.

Sample code:

 // 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 (BuildsClient buildsClient = BuildsClient.create()) {
   SubmitBuildRequest request =
       SubmitBuildRequest.newBuilder()
           .setParent("parent-995424086")
           .setImageUri("imageUri-859610607")
           .setServiceAccount("serviceAccount1079137720")
           .setWorkerPool(
               WorkerPoolName.of("[PROJECT]", "[LOCATION]", "[WORKER_POOL]").toString())
           .addAllTags(new ArrayList<String>())
           .build();
   SubmitBuildResponse response = buildsClient.submitBuild(request);
 }
 

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

submitBuildCallable

public final com.google.api.gax.rpc.UnaryCallable<SubmitBuildRequest,SubmitBuildResponse> submitBuildCallable()

Submits a build in a given project.

Sample code:

 // 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 (BuildsClient buildsClient = BuildsClient.create()) {
   SubmitBuildRequest request =
       SubmitBuildRequest.newBuilder()
           .setParent("parent-995424086")
           .setImageUri("imageUri-859610607")
           .setServiceAccount("serviceAccount1079137720")
           .setWorkerPool(
               WorkerPoolName.of("[PROJECT]", "[LOCATION]", "[WORKER_POOL]").toString())
           .addAllTags(new ArrayList<String>())
           .build();
   ApiFuture<SubmitBuildResponse> future =
       buildsClient.submitBuildCallable().futureCall(request);
   // Do something.
   SubmitBuildResponse response = future.get();
 }
 

close

public final void close()

Specified by:

close in interface AutoCloseable

shutdown

public void shutdown()

Specified by:

shutdown in interface com.google.api.gax.core.BackgroundResource

isShutdown

public boolean isShutdown()

Specified by:

isShutdown in interface com.google.api.gax.core.BackgroundResource

isTerminated

public boolean isTerminated()

Specified by:

isTerminated in interface com.google.api.gax.core.BackgroundResource

shutdownNow

public void shutdownNow()

Specified by:

shutdownNow in interface com.google.api.gax.core.BackgroundResource

awaitTermination

public boolean awaitTermination(long duration,
                                TimeUnit unit)
                         throws InterruptedException

Specified by:

awaitTermination in interface com.google.api.gax.core.BackgroundResource

Throws:

InterruptedException