Class CloudBuildClient (3.3.12)

Version 3.3.12

• 3.55.0 (latest)
• 3.54.0
• 3.53.0
• 3.51.0
• 3.50.0
• 3.49.0
• 3.48.0
• 3.47.0
• 3.46.0
• 3.45.0
• 3.44.0
• 3.43.0
• 3.42.0
• 3.41.0
• 3.39.0
• 3.38.0
• 3.37.0
• 3.36.0
• 3.35.0
• 3.34.0
• 3.33.0
• 3.32.0
• 3.31.0
• 3.30.0
• 3.29.0
• 3.26.0
• 3.25.0
• 3.24.0
• 3.23.0
• 3.22.0
• 3.21.0
• 3.20.0
• 3.19.0
• 3.18.0
• 3.17.0
• 3.16.0
• 3.15.0
• 3.14.0
• 3.13.0
• 3.12.0
• 3.11.0
• 3.10.0
• 3.9.0
• 3.8.0
• 3.7.0
• 3.6.0
• 3.5.6
• 3.4.1
• 3.3.12

public class CloudBuildClient implements BackgroundResource

Service Description: Creates and manages builds on Google Cloud Platform.

The main concept used by this API is a Build, which describes the location of the source to build, how to build the source, and where to store the built artifacts, if any.

A user can list previously-requested builds or get builds by their ID to determine the status of the build.

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:

 try (CloudBuildClient cloudBuildClient = CloudBuildClient.create()) {
   String projectId = "projectId-894832108";
   String id = "id3355";
   Build response = cloudBuildClient.getBuild(projectId, id);
 }
 

Note: close() needs to be called on the CloudBuildClient 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:

1. 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.
2. 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.
3. 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 CloudBuildSettings to create(). For example:

To customize credentials:

 CloudBuildSettings cloudBuildSettings =
     CloudBuildSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 CloudBuildClient cloudBuildClient = CloudBuildClient.create(cloudBuildSettings);
 

To customize the endpoint:

 CloudBuildSettings cloudBuildSettings =
     CloudBuildSettings.newBuilder().setEndpoint(myEndpoint).build();
 CloudBuildClient cloudBuildClient = CloudBuildClient.create(cloudBuildSettings);
 

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

Inheritance

java.lang.Object > CloudBuildClient

Implements

BackgroundResource

Inherited Members

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.toString()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

create()

public static final CloudBuildClient create()

Constructs an instance of CloudBuildClient with default settings.

Returns

Type	Description
CloudBuildClient

Exceptions

Type	Description
IOException

create(CloudBuildSettings settings)

public static final CloudBuildClient create(CloudBuildSettings settings)

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

Parameter

Name	Description
settings	CloudBuildSettings

Returns

Type	Description
CloudBuildClient

Exceptions

Type	Description
IOException

create(CloudBuildStub stub)

public static final CloudBuildClient create(CloudBuildStub stub)

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

Parameter

Name	Description
stub	CloudBuildStub

Returns

Type	Description
CloudBuildClient

Constructors

CloudBuildClient(CloudBuildSettings settings)

protected CloudBuildClient(CloudBuildSettings settings)

Constructs an instance of CloudBuildClient, 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.

Parameter

Name	Description
settings	CloudBuildSettings

CloudBuildClient(CloudBuildStub stub)

protected CloudBuildClient(CloudBuildStub stub)

Parameter

Name	Description
stub	CloudBuildStub

Methods

approveBuildAsync(ApproveBuildRequest request)

public final OperationFuture<Build,BuildOperationMetadata> approveBuildAsync(ApproveBuildRequest request)

Approves or rejects a pending build.

If approved, the returned LRO will be analogous to the LRO returned from a CreateBuild call.

If rejected, the returned LRO will be immediately done.

Sample code:

 try (CloudBuildClient cloudBuildClient = CloudBuildClient.create()) {
   ApproveBuildRequest request =
       ApproveBuildRequest.newBuilder()
           .setName("name3373707")
           .setApprovalResult(ApprovalResult.newBuilder().build())
           .build();
   Build response = cloudBuildClient.approveBuildAsync(request).get();
 }
 

Parameter

Name	Description
request	ApproveBuildRequest The request object containing all of the parameters for the API call.

Returns

Type	Description
OperationFuture<Build,BuildOperationMetadata>

approveBuildAsync(String name, ApprovalResult approvalResult)

public final OperationFuture<Build,BuildOperationMetadata> approveBuildAsync(String name, ApprovalResult approvalResult)

Approves or rejects a pending build.

If approved, the returned LRO will be analogous to the LRO returned from a CreateBuild call.

If rejected, the returned LRO will be immediately done.

Sample code:

 try (CloudBuildClient cloudBuildClient = CloudBuildClient.create()) {
   String name = "name3373707";
   ApprovalResult approvalResult = ApprovalResult.newBuilder().build();
   Build response = cloudBuildClient.approveBuildAsync(name, approvalResult).get();
 }
 

Parameters

Name	Description
name	String Required. Name of the target build. For example: "projects/{$project_id}/builds/{$build_id}"
approvalResult	ApprovalResult Approval decision and metadata.

Returns

Type	Description
OperationFuture<Build,BuildOperationMetadata>

approveBuildCallable()

public final UnaryCallable<ApproveBuildRequest,Operation> approveBuildCallable()

Approves or rejects a pending build.

If approved, the returned LRO will be analogous to the LRO returned from a CreateBuild call.

If rejected, the returned LRO will be immediately done.

Sample code:

 try (CloudBuildClient cloudBuildClient = CloudBuildClient.create()) {
   ApproveBuildRequest request =
       ApproveBuildRequest.newBuilder()
           .setName("name3373707")
           .setApprovalResult(ApprovalResult.newBuilder().build())
           .build();
   ApiFuture<Operation> future = cloudBuildClient.approveBuildCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 

Returns

Type	Description
UnaryCallable<ApproveBuildRequest,Operation>

approveBuildOperationCallable()

public final OperationCallable<ApproveBuildRequest,Build,BuildOperationMetadata> approveBuildOperationCallable()

Approves or rejects a pending build.

If approved, the returned LRO will be analogous to the LRO returned from a CreateBuild call.

If rejected, the returned LRO will be immediately done.

Sample code:

 try (CloudBuildClient cloudBuildClient = CloudBuildClient.create()) {
   ApproveBuildRequest request =
       ApproveBuildRequest.newBuilder()
           .setName("name3373707")
           .setApprovalResult(ApprovalResult.newBuilder().build())
           .build();
   OperationFuture

Returns

Type	Description
OperationCallable<ApproveBuildRequest,Build,BuildOperationMetadata>

awaitTermination(long duration, TimeUnit unit)

public boolean awaitTermination(long duration, TimeUnit unit)

Parameters

Name	Description
duration	long
unit	TimeUnit

Returns

Type	Description
boolean

Exceptions

Type	Description
InterruptedException

cancelBuild(CancelBuildRequest request)

public final Build cancelBuild(CancelBuildRequest request)

Cancels a build in progress.

Sample code:

 try (CloudBuildClient cloudBuildClient = CloudBuildClient.create()) {
   CancelBuildRequest request =
       CancelBuildRequest.newBuilder()
           .setName(BuildName.ofProjectBuildName("[PROJECT]", "[BUILD]").toString())
           .setProjectId("projectId-894832108")
           .setId("id3355")
           .build();
   Build response = cloudBuildClient.cancelBuild(request);
 }
 

Parameter

Name	Description
request	CancelBuildRequest The request object containing all of the parameters for the API call.

Returns

Type	Description
Build

cancelBuild(String projectId, String id)

public final Build cancelBuild(String projectId, String id)

Cancels a build in progress.

Sample code:

 try (CloudBuildClient cloudBuildClient = CloudBuildClient.create()) {
   String projectId = "projectId-894832108";
   String id = "id3355";
   Build response = cloudBuildClient.cancelBuild(projectId, id);
 }
 

Parameters

Name	Description
projectId	String Required. ID of the project.
id	String Required. ID of the build.

Returns

Type	Description
Build

cancelBuildCallable()

public final UnaryCallable<CancelBuildRequest,Build> cancelBuildCallable()

Cancels a build in progress.

Sample code:

 try (CloudBuildClient cloudBuildClient = CloudBuildClient.create()) {
   CancelBuildRequest request =
       CancelBuildRequest.newBuilder()
           .setName(BuildName.ofProjectBuildName("[PROJECT]", "[BUILD]").toString())
           .setProjectId("projectId-894832108")
           .setId("id3355")
           .build();
   ApiFuture<Build> future = cloudBuildClient.cancelBuildCallable().futureCall(request);
   // Do something.
   Build response = future.get();
 }
 

Returns

Type	Description
UnaryCallable<CancelBuildRequest,Build>

close()

public final void close()

createBuildAsync(CreateBuildRequest request)

public final OperationFuture<Build,BuildOperationMetadata> createBuildAsync(CreateBuildRequest request)

Starts a build with the specified configuration.

This method returns a long-running Operation, which includes the build ID. Pass the build ID to GetBuild to determine the build status (such as SUCCESS or FAILURE).

Sample code:

 try (CloudBuildClient cloudBuildClient = CloudBuildClient.create()) {
   CreateBuildRequest request =
       CreateBuildRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setProjectId("projectId-894832108")
           .setBuild(Build.newBuilder().build())
           .build();
   Build response = cloudBuildClient.createBuildAsync(request).get();
 }
 

Parameter

Name	Description
request	CreateBuildRequest The request object containing all of the parameters for the API call.

Returns

Type	Description
OperationFuture<Build,BuildOperationMetadata>

createBuildAsync(String projectId, Build build)

public final OperationFuture<Build,BuildOperationMetadata> createBuildAsync(String projectId, Build build)

Starts a build with the specified configuration.

This method returns a long-running Operation, which includes the build ID. Pass the build ID to GetBuild to determine the build status (such as SUCCESS or FAILURE).

Sample code:

 try (CloudBuildClient cloudBuildClient = CloudBuildClient.create()) {
   String projectId = "projectId-894832108";
   Build build = Build.newBuilder().build();
   Build response = cloudBuildClient.createBuildAsync(projectId, build).get();
 }
 

Parameters

Name	Description
projectId	String Required. ID of the project.
build	Build Required. Build resource to create.

Returns

Type	Description
OperationFuture<Build,BuildOperationMetadata>

createBuildCallable()

public final UnaryCallable<CreateBuildRequest,Operation> createBuildCallable()

Starts a build with the specified configuration.

This method returns a long-running Operation, which includes the build ID. Pass the build ID to GetBuild to determine the build status (such as SUCCESS or FAILURE).

Sample code:

 try (CloudBuildClient cloudBuildClient = CloudBuildClient.create()) {
   CreateBuildRequest request =
       CreateBuildRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setProjectId("projectId-894832108")
           .setBuild(Build.newBuilder().build())
           .build();
   ApiFuture<Operation> future = cloudBuildClient.createBuildCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 

Returns

Type	Description
UnaryCallable<CreateBuildRequest,Operation>

createBuildOperationCallable()

public final OperationCallable<CreateBuildRequest,Build,BuildOperationMetadata> createBuildOperationCallable()

Starts a build with the specified configuration.

This method returns a long-running Operation, which includes the build ID. Pass the build ID to GetBuild to determine the build status (such as SUCCESS or FAILURE).

Sample code:

 try (CloudBuildClient cloudBuildClient = CloudBuildClient.create()) {
   CreateBuildRequest request =
       CreateBuildRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setProjectId("projectId-894832108")
           .setBuild(Build.newBuilder().build())
           .build();
   OperationFuture

Returns

Type	Description
OperationCallable<CreateBuildRequest,Build,BuildOperationMetadata>

createBuildTrigger(CreateBuildTriggerRequest request)

public final BuildTrigger createBuildTrigger(CreateBuildTriggerRequest request)

Creates a new BuildTrigger.

This API is experimental.

Sample code:

 try (CloudBuildClient cloudBuildClient = CloudBuildClient.create()) {
   CreateBuildTriggerRequest request =
       CreateBuildTriggerRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setProjectId("projectId-894832108")
           .setTrigger(BuildTrigger.newBuilder().build())
           .build();
   BuildTrigger response = cloudBuildClient.createBuildTrigger(request);
 }
 

Parameter

Name	Description
request	CreateBuildTriggerRequest The request object containing all of the parameters for the API call.

Returns

Type	Description
BuildTrigger

createBuildTrigger(String projectId, BuildTrigger trigger)

public final BuildTrigger createBuildTrigger(String projectId, BuildTrigger trigger)

Creates a new BuildTrigger.

This API is experimental.

Sample code:

 try (CloudBuildClient cloudBuildClient = CloudBuildClient.create()) {
   String projectId = "projectId-894832108";
   BuildTrigger trigger = BuildTrigger.newBuilder().build();
   BuildTrigger response = cloudBuildClient.createBuildTrigger(projectId, trigger);
 }
 

Parameters

Name	Description
projectId	String Required. ID of the project for which to configure automatic builds.
trigger	BuildTrigger Required. BuildTrigger to create.

Returns

Type	Description
BuildTrigger

createBuildTriggerCallable()

public final UnaryCallable<CreateBuildTriggerRequest,BuildTrigger> createBuildTriggerCallable()

Creates a new BuildTrigger.

This API is experimental.

Sample code:

 try (CloudBuildClient cloudBuildClient = CloudBuildClient.create()) {
   CreateBuildTriggerRequest request =
       CreateBuildTriggerRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setProjectId("projectId-894832108")
           .setTrigger(BuildTrigger.newBuilder().build())
           .build();
   ApiFuture

Returns

Type	Description
UnaryCallable<CreateBuildTriggerRequest,BuildTrigger>

createWorkerPoolAsync(CreateWorkerPoolRequest request)

public final OperationFuture<WorkerPool,CreateWorkerPoolOperationMetadata> createWorkerPoolAsync(CreateWorkerPoolRequest request)

Creates a WorkerPool.

Sample code:

 try (CloudBuildClient cloudBuildClient = CloudBuildClient.create()) {
   CreateWorkerPoolRequest request =
       CreateWorkerPoolRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setWorkerPool(WorkerPool.newBuilder().build())
           .setWorkerPoolId("workerPoolId-46320779")
           .setValidateOnly(true)
           .build();
   WorkerPool response = cloudBuildClient.createWorkerPoolAsync(request).get();
 }
 

Parameter

Name	Description
request	CreateWorkerPoolRequest The request object containing all of the parameters for the API call.

Returns

Type	Description
OperationFuture<WorkerPool,CreateWorkerPoolOperationMetadata>

createWorkerPoolAsync(LocationName parent, WorkerPool workerPool, String workerPoolId)

public final OperationFuture<WorkerPool,CreateWorkerPoolOperationMetadata> createWorkerPoolAsync(LocationName parent, WorkerPool workerPool, String workerPoolId)

Creates a WorkerPool.

Sample code:

 try (CloudBuildClient cloudBuildClient = CloudBuildClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   WorkerPool workerPool = WorkerPool.newBuilder().build();
   String workerPoolId = "workerPoolId-46320779";
   WorkerPool response =
       cloudBuildClient.createWorkerPoolAsync(parent, workerPool, workerPoolId).get();
 }
 

Parameters

Name	Description
parent	LocationName Required. The parent resource where this worker pool will be created. Format: projects/{project}/locations/{location}.
workerPool	WorkerPool Required. WorkerPool resource to create.
workerPoolId	String Required. Immutable. The ID to use for the WorkerPool, which will become the final component of the resource name. This value should be 1-63 characters, and valid characters are /a-z-/.

Returns

Type	Description
OperationFuture<WorkerPool,CreateWorkerPoolOperationMetadata>

createWorkerPoolAsync(String parent, WorkerPool workerPool, String workerPoolId)

public final OperationFuture<WorkerPool,CreateWorkerPoolOperationMetadata> createWorkerPoolAsync(String parent, WorkerPool workerPool, String workerPoolId)

Creates a WorkerPool.

Sample code:

 try (CloudBuildClient cloudBuildClient = CloudBuildClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   WorkerPool workerPool = WorkerPool.newBuilder().build();
   String workerPoolId = "workerPoolId-46320779";
   WorkerPool response =
       cloudBuildClient.createWorkerPoolAsync(parent, workerPool, workerPoolId).get();
 }
 

Parameters

Name	Description
parent	String Required. The parent resource where this worker pool will be created. Format: projects/{project}/locations/{location}.
workerPool	WorkerPool Required. WorkerPool resource to create.
workerPoolId	String Required. Immutable. The ID to use for the WorkerPool, which will become the final component of the resource name. This value should be 1-63 characters, and valid characters are /a-z-/.

Returns

Type	Description
OperationFuture<WorkerPool,CreateWorkerPoolOperationMetadata>

createWorkerPoolCallable()

public final UnaryCallable<CreateWorkerPoolRequest,Operation> createWorkerPoolCallable()

Creates a WorkerPool.

Sample code:

 try (CloudBuildClient cloudBuildClient = CloudBuildClient.create()) {
   CreateWorkerPoolRequest request =
       CreateWorkerPoolRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setWorkerPool(WorkerPool.newBuilder().build())
           .setWorkerPoolId("workerPoolId-46320779")
           .setValidateOnly(true)
           .build();
   ApiFuture<Operation> future = cloudBuildClient.createWorkerPoolCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 

Returns

Type	Description
UnaryCallable<CreateWorkerPoolRequest,Operation>

createWorkerPoolOperationCallable()

public final OperationCallable<CreateWorkerPoolRequest,WorkerPool,CreateWorkerPoolOperationMetadata> createWorkerPoolOperationCallable()

Creates a WorkerPool.

Sample code:

 try (CloudBuildClient cloudBuildClient = CloudBuildClient.create()) {
   CreateWorkerPoolRequest request =
       CreateWorkerPoolRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setWorkerPool(WorkerPool.newBuilder().build())
           .setWorkerPoolId("workerPoolId-46320779")
           .setValidateOnly(true)
           .build();
   OperationFuture

Returns

Type	Description
OperationCallable<CreateWorkerPoolRequest,WorkerPool,CreateWorkerPoolOperationMetadata>

deleteBuildTrigger(DeleteBuildTriggerRequest request)

public final void deleteBuildTrigger(DeleteBuildTriggerRequest request)

Deletes a BuildTrigger by its project ID and trigger ID.

This API is experimental.

Sample code:

 try (CloudBuildClient cloudBuildClient = CloudBuildClient.create()) {
   DeleteBuildTriggerRequest request =
       DeleteBuildTriggerRequest.newBuilder()
           .setName(BuildTriggerName.ofProjectTriggerName("[PROJECT]", "[TRIGGER]").toString())
           .setProjectId("projectId-894832108")
           .setTriggerId("triggerId-648752909")
           .build();
   cloudBuildClient.deleteBuildTrigger(request);
 }
 

Parameter

Name	Description
request	DeleteBuildTriggerRequest The request object containing all of the parameters for the API call.

deleteBuildTrigger(String projectId, String triggerId)

public final void deleteBuildTrigger(String projectId, String triggerId)

Deletes a BuildTrigger by its project ID and trigger ID.

This API is experimental.

Sample code:

 try (CloudBuildClient cloudBuildClient = CloudBuildClient.create()) {
   String projectId = "projectId-894832108";
   String triggerId = "triggerId-648752909";
   cloudBuildClient.deleteBuildTrigger(projectId, triggerId);
 }
 

Parameters

Name	Description
projectId	String Required. ID of the project that owns the trigger.
triggerId	String Required. ID of the BuildTrigger to delete.

deleteBuildTriggerCallable()

public final UnaryCallable<DeleteBuildTriggerRequest,Empty> deleteBuildTriggerCallable()

Deletes a BuildTrigger by its project ID and trigger ID.

This API is experimental.

Sample code:

 try (CloudBuildClient cloudBuildClient = CloudBuildClient.create()) {
   DeleteBuildTriggerRequest request =
       DeleteBuildTriggerRequest.newBuilder()
           .setName(BuildTriggerName.ofProjectTriggerName("[PROJECT]", "[TRIGGER]").toString())
           .setProjectId("projectId-894832108")
           .setTriggerId("triggerId-648752909")
           .build();
   ApiFuture<Empty> future = cloudBuildClient.deleteBuildTriggerCallable().futureCall(request);
   // Do something.
   future.get();
 }
 

Returns

Type	Description
UnaryCallable<DeleteBuildTriggerRequest,Empty>

deleteWorkerPoolAsync(DeleteWorkerPoolRequest request)

public final OperationFuture<Empty,DeleteWorkerPoolOperationMetadata> deleteWorkerPoolAsync(DeleteWorkerPoolRequest request)

Deletes a WorkerPool.

Sample code:

 try (CloudBuildClient cloudBuildClient = CloudBuildClient.create()) {
   DeleteWorkerPoolRequest request =
       DeleteWorkerPoolRequest.newBuilder()
           .setName(WorkerPoolName.of("[PROJECT]", "[LOCATION]", "[WORKER_POOL]").toString())
           .setEtag("etag3123477")
           .setAllowMissing(true)
           .setValidateOnly(true)
           .build();
   cloudBuildClient.deleteWorkerPoolAsync(request).get();
 }
 

Parameter

Name	Description
request	DeleteWorkerPoolRequest The request object containing all of the parameters for the API call.

Returns

Type	Description
OperationFuture<Empty,DeleteWorkerPoolOperationMetadata>

deleteWorkerPoolAsync(WorkerPoolName name)

public final OperationFuture<Empty,DeleteWorkerPoolOperationMetadata> deleteWorkerPoolAsync(WorkerPoolName name)

Deletes a WorkerPool.

Sample code:

 try (CloudBuildClient cloudBuildClient = CloudBuildClient.create()) {
   WorkerPoolName name = WorkerPoolName.of("[PROJECT]", "[LOCATION]", "[WORKER_POOL]");
   cloudBuildClient.deleteWorkerPoolAsync(name).get();
 }
 

Parameter

Name	Description
name	WorkerPoolName Required. The name of the WorkerPool to delete. Format: projects/{project}/locations/{workerPool}/workerPools/{workerPool}.

Returns

Type	Description
OperationFuture<Empty,DeleteWorkerPoolOperationMetadata>

deleteWorkerPoolAsync(String name)

public final OperationFuture<Empty,DeleteWorkerPoolOperationMetadata> deleteWorkerPoolAsync(String name)

Deletes a WorkerPool.

Sample code:

 try (CloudBuildClient cloudBuildClient = CloudBuildClient.create()) {
   String name = WorkerPoolName.of("[PROJECT]", "[LOCATION]", "[WORKER_POOL]").toString();
   cloudBuildClient.deleteWorkerPoolAsync(name).get();
 }
 

Parameter

Name	Description
name	String Required. The name of the WorkerPool to delete. Format: projects/{project}/locations/{workerPool}/workerPools/{workerPool}.

Returns

Type	Description
OperationFuture<Empty,DeleteWorkerPoolOperationMetadata>

deleteWorkerPoolCallable()

public final UnaryCallable<DeleteWorkerPoolRequest,Operation> deleteWorkerPoolCallable()

Deletes a WorkerPool.

Sample code:

 try (CloudBuildClient cloudBuildClient = CloudBuildClient.create()) {
   DeleteWorkerPoolRequest request =
       DeleteWorkerPoolRequest.newBuilder()
           .setName(WorkerPoolName.of("[PROJECT]", "[LOCATION]", "[WORKER_POOL]").toString())
           .setEtag("etag3123477")
           .setAllowMissing(true)
           .setValidateOnly(true)
           .build();
   ApiFuture<Operation> future = cloudBuildClient.deleteWorkerPoolCallable().futureCall(request);
   // Do something.
   future.get();
 }
 

Returns

Type	Description
UnaryCallable<DeleteWorkerPoolRequest,Operation>

deleteWorkerPoolOperationCallable()

public final OperationCallable<DeleteWorkerPoolRequest,Empty,DeleteWorkerPoolOperationMetadata> deleteWorkerPoolOperationCallable()

Deletes a WorkerPool.

Sample code:

 try (CloudBuildClient cloudBuildClient = CloudBuildClient.create()) {
   DeleteWorkerPoolRequest request =
       DeleteWorkerPoolRequest.newBuilder()
           .setName(WorkerPoolName.of("[PROJECT]", "[LOCATION]", "[WORKER_POOL]").toString())
           .setEtag("etag3123477")
           .setAllowMissing(true)
           .setValidateOnly(true)
           .build();
   OperationFuture

Returns

Type	Description
OperationCallable<DeleteWorkerPoolRequest,Empty,DeleteWorkerPoolOperationMetadata>

getBuild(GetBuildRequest request)

public final Build getBuild(GetBuildRequest request)

Returns information about a previously requested build.

The Build that is returned includes its status (such as SUCCESS, FAILURE, or WORKING), and timing information.

Sample code:

 try (CloudBuildClient cloudBuildClient = CloudBuildClient.create()) {
   GetBuildRequest request =
       GetBuildRequest.newBuilder()
           .setName(BuildName.ofProjectBuildName("[PROJECT]", "[BUILD]").toString())
           .setProjectId("projectId-894832108")
           .setId("id3355")
           .build();
   Build response = cloudBuildClient.getBuild(request);
 }
 

Parameter

Name	Description
request	GetBuildRequest The request object containing all of the parameters for the API call.

Returns

Type	Description
Build

getBuild(String projectId, String id)

public final Build getBuild(String projectId, String id)

Returns information about a previously requested build.

The Build that is returned includes its status (such as SUCCESS, FAILURE, or WORKING), and timing information.

Sample code:

 try (CloudBuildClient cloudBuildClient = CloudBuildClient.create()) {
   String projectId = "projectId-894832108";
   String id = "id3355";
   Build response = cloudBuildClient.getBuild(projectId, id);
 }
 

Parameters

Name	Description
projectId	String Required. ID of the project.
id	String Required. ID of the build.

Returns

Type	Description
Build

getBuildCallable()

public final UnaryCallable<GetBuildRequest,Build> getBuildCallable()

Returns information about a previously requested build.

The Build that is returned includes its status (such as SUCCESS, FAILURE, or WORKING), and timing information.

Sample code:

 try (CloudBuildClient cloudBuildClient = CloudBuildClient.create()) {
   GetBuildRequest request =
       GetBuildRequest.newBuilder()
           .setName(BuildName.ofProjectBuildName("[PROJECT]", "[BUILD]").toString())
           .setProjectId("projectId-894832108")
           .setId("id3355")
           .build();
   ApiFuture<Build> future = cloudBuildClient.getBuildCallable().futureCall(request);
   // Do something.
   Build response = future.get();
 }
 

Returns

Type	Description
UnaryCallable<GetBuildRequest,Build>

getBuildTrigger(GetBuildTriggerRequest request)

public final BuildTrigger getBuildTrigger(GetBuildTriggerRequest request)

Returns information about a BuildTrigger.

This API is experimental.

Sample code:

 try (CloudBuildClient cloudBuildClient = CloudBuildClient.create()) {
   GetBuildTriggerRequest request =
       GetBuildTriggerRequest.newBuilder()
           .setName(BuildTriggerName.ofProjectTriggerName("[PROJECT]", "[TRIGGER]").toString())
           .setProjectId("projectId-894832108")
           .setTriggerId("triggerId-648752909")
           .build();
   BuildTrigger response = cloudBuildClient.getBuildTrigger(request);
 }
 

Parameter

Name	Description
request	GetBuildTriggerRequest The request object containing all of the parameters for the API call.

Returns

Type	Description
BuildTrigger

getBuildTrigger(String projectId, String triggerId)

public final BuildTrigger getBuildTrigger(String projectId, String triggerId)

Returns information about a BuildTrigger.

This API is experimental.

Sample code:

 try (CloudBuildClient cloudBuildClient = CloudBuildClient.create()) {
   String projectId = "projectId-894832108";
   String triggerId = "triggerId-648752909";
   BuildTrigger response = cloudBuildClient.getBuildTrigger(projectId, triggerId);
 }
 

Parameters

Name	Description
projectId	String Required. ID of the project that owns the trigger.
triggerId	String Required. Identifier (id or name) of the BuildTrigger to get.

Returns

Type	Description
BuildTrigger

getBuildTriggerCallable()

public final UnaryCallable<GetBuildTriggerRequest,BuildTrigger> getBuildTriggerCallable()

Returns information about a BuildTrigger.

This API is experimental.

Sample code:

 try (CloudBuildClient cloudBuildClient = CloudBuildClient.create()) {
   GetBuildTriggerRequest request =
       GetBuildTriggerRequest.newBuilder()
           .setName(BuildTriggerName.ofProjectTriggerName("[PROJECT]", "[TRIGGER]").toString())
           .setProjectId("projectId-894832108")
           .setTriggerId("triggerId-648752909")
           .build();
   ApiFuture

Returns

Type	Description
UnaryCallable<GetBuildTriggerRequest,BuildTrigger>

getOperationsClient()

public final OperationsClient getOperationsClient()

Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.

Returns

Type	Description
OperationsClient

getSettings()

public final CloudBuildSettings getSettings()

Returns

Type	Description
CloudBuildSettings

getStub()

public CloudBuildStub getStub()

Returns

Type	Description
CloudBuildStub

getWorkerPool(GetWorkerPoolRequest request)

public final WorkerPool getWorkerPool(GetWorkerPoolRequest request)

Returns details of a WorkerPool.

Sample code:

 try (CloudBuildClient cloudBuildClient = CloudBuildClient.create()) {
   GetWorkerPoolRequest request =
       GetWorkerPoolRequest.newBuilder()
           .setName(WorkerPoolName.of("[PROJECT]", "[LOCATION]", "[WORKER_POOL]").toString())
           .build();
   WorkerPool response = cloudBuildClient.getWorkerPool(request);
 }
 

Parameter

Name	Description
request	GetWorkerPoolRequest The request object containing all of the parameters for the API call.

Returns

Type	Description
WorkerPool

getWorkerPool(WorkerPoolName name)

public final WorkerPool getWorkerPool(WorkerPoolName name)

Returns details of a WorkerPool.

Sample code:

 try (CloudBuildClient cloudBuildClient = CloudBuildClient.create()) {
   WorkerPoolName name = WorkerPoolName.of("[PROJECT]", "[LOCATION]", "[WORKER_POOL]");
   WorkerPool response = cloudBuildClient.getWorkerPool(name);
 }
 

Parameter

Name	Description
name	WorkerPoolName Required. The name of the WorkerPool to retrieve. Format: projects/{project}/locations/{location}/workerPools/{workerPool}.

Returns

Type	Description
WorkerPool

getWorkerPool(String name)

public final WorkerPool getWorkerPool(String name)

Returns details of a WorkerPool.

Sample code:

 try (CloudBuildClient cloudBuildClient = CloudBuildClient.create()) {
   String name = WorkerPoolName.of("[PROJECT]", "[LOCATION]", "[WORKER_POOL]").toString();
   WorkerPool response = cloudBuildClient.getWorkerPool(name);
 }
 

Parameter

Name	Description
name	String Required. The name of the WorkerPool to retrieve. Format: projects/{project}/locations/{location}/workerPools/{workerPool}.

Returns

Type	Description
WorkerPool

getWorkerPoolCallable()

public final UnaryCallable<GetWorkerPoolRequest,WorkerPool> getWorkerPoolCallable()

Returns details of a WorkerPool.

Sample code:

 try (CloudBuildClient cloudBuildClient = CloudBuildClient.create()) {
   GetWorkerPoolRequest request =
       GetWorkerPoolRequest.newBuilder()
           .setName(WorkerPoolName.of("[PROJECT]", "[LOCATION]", "[WORKER_POOL]").toString())
           .build();
   ApiFuture

Returns

Type	Description
UnaryCallable<GetWorkerPoolRequest,WorkerPool>

isShutdown()

public boolean isShutdown()

Returns

Type	Description
boolean

isTerminated()

public boolean isTerminated()

Returns

Type	Description
boolean

listBuildTriggers(ListBuildTriggersRequest request)

public final CloudBuildClient.ListBuildTriggersPagedResponse listBuildTriggers(ListBuildTriggersRequest request)

Lists existing BuildTriggers.

This API is experimental.

Sample code:

 try (CloudBuildClient cloudBuildClient = CloudBuildClient.create()) {
   ListBuildTriggersRequest request =
       ListBuildTriggersRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setProjectId("projectId-894832108")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (BuildTrigger element : cloudBuildClient.listBuildTriggers(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameter

Name	Description
request	ListBuildTriggersRequest The request object containing all of the parameters for the API call.

Returns

Type	Description
CloudBuildClient.ListBuildTriggersPagedResponse

listBuildTriggers(String projectId)

public final CloudBuildClient.ListBuildTriggersPagedResponse listBuildTriggers(String projectId)

Lists existing BuildTriggers.

This API is experimental.

Sample code:

 try (CloudBuildClient cloudBuildClient = CloudBuildClient.create()) {
   String projectId = "projectId-894832108";
   for (BuildTrigger element : cloudBuildClient.listBuildTriggers(projectId).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameter

Name	Description
projectId	String Required. ID of the project for which to list BuildTriggers.

Returns

Type	Description
CloudBuildClient.ListBuildTriggersPagedResponse

listBuildTriggersCallable()

public final UnaryCallable<ListBuildTriggersRequest,ListBuildTriggersResponse> listBuildTriggersCallable()

Lists existing BuildTriggers.

This API is experimental.

Sample code:

 try (CloudBuildClient cloudBuildClient = CloudBuildClient.create()) {
   ListBuildTriggersRequest request =
       ListBuildTriggersRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setProjectId("projectId-894832108")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListBuildTriggersResponse response =
         cloudBuildClient.listBuildTriggersCallable().call(request);
     for (BuildTrigger element : response.getResponsesList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 

Returns

Type	Description
UnaryCallable<ListBuildTriggersRequest,ListBuildTriggersResponse>

listBuildTriggersPagedCallable()

public final UnaryCallable<ListBuildTriggersRequest,CloudBuildClient.ListBuildTriggersPagedResponse> listBuildTriggersPagedCallable()

Lists existing BuildTriggers.

This API is experimental.

Sample code:

 try (CloudBuildClient cloudBuildClient = CloudBuildClient.create()) {
   ListBuildTriggersRequest request =
       ListBuildTriggersRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setProjectId("projectId-894832108")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture

Returns

Type	Description
UnaryCallable<ListBuildTriggersRequest,ListBuildTriggersPagedResponse>

listBuilds(ListBuildsRequest request)

public final CloudBuildClient.ListBuildsPagedResponse listBuilds(ListBuildsRequest request)

Lists previously requested builds.

Previously requested builds may still be in-progress, or may have finished successfully or unsuccessfully.

Sample code:

 try (CloudBuildClient cloudBuildClient = CloudBuildClient.create()) {
   ListBuildsRequest request =
       ListBuildsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setProjectId("projectId-894832108")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .build();
   for (Build element : cloudBuildClient.listBuilds(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameter

Name	Description
request	ListBuildsRequest The request object containing all of the parameters for the API call.

Returns

Type	Description
CloudBuildClient.ListBuildsPagedResponse

listBuilds(String projectId, String filter)

public final CloudBuildClient.ListBuildsPagedResponse listBuilds(String projectId, String filter)

Lists previously requested builds.

Previously requested builds may still be in-progress, or may have finished successfully or unsuccessfully.

Sample code:

 try (CloudBuildClient cloudBuildClient = CloudBuildClient.create()) {
   String projectId = "projectId-894832108";
   String filter = "filter-1274492040";
   for (Build element : cloudBuildClient.listBuilds(projectId, filter).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters

Name	Description
projectId	String Required. ID of the project.
filter	String The raw filter text to constrain the results.

Returns

Type	Description
CloudBuildClient.ListBuildsPagedResponse

listBuildsCallable()

public final UnaryCallable<ListBuildsRequest,ListBuildsResponse> listBuildsCallable()

Lists previously requested builds.

Previously requested builds may still be in-progress, or may have finished successfully or unsuccessfully.

Sample code:

 try (CloudBuildClient cloudBuildClient = CloudBuildClient.create()) {
   ListBuildsRequest request =
       ListBuildsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setProjectId("projectId-894832108")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .build();
   while (true) {
     ListBuildsResponse response = cloudBuildClient.listBuildsCallable().call(request);
     for (Build element : response.getResponsesList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 

Returns

Type	Description
UnaryCallable<ListBuildsRequest,ListBuildsResponse>

listBuildsPagedCallable()

public final UnaryCallable<ListBuildsRequest,CloudBuildClient.ListBuildsPagedResponse> listBuildsPagedCallable()

Lists previously requested builds.

Previously requested builds may still be in-progress, or may have finished successfully or unsuccessfully.

Sample code:

 try (CloudBuildClient cloudBuildClient = CloudBuildClient.create()) {
   ListBuildsRequest request =
       ListBuildsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setProjectId("projectId-894832108")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .build();
   ApiFuture<Build> future = cloudBuildClient.listBuildsPagedCallable().futureCall(request);
   // Do something.
   for (Build element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Returns

Type	Description
UnaryCallable<ListBuildsRequest,ListBuildsPagedResponse>

listWorkerPools(ListWorkerPoolsRequest request)

public final CloudBuildClient.ListWorkerPoolsPagedResponse listWorkerPools(ListWorkerPoolsRequest request)

Lists WorkerPools.

Sample code:

 try (CloudBuildClient cloudBuildClient = CloudBuildClient.create()) {
   ListWorkerPoolsRequest request =
       ListWorkerPoolsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (WorkerPool element : cloudBuildClient.listWorkerPools(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameter

Name	Description
request	ListWorkerPoolsRequest The request object containing all of the parameters for the API call.

Returns

Type	Description
CloudBuildClient.ListWorkerPoolsPagedResponse

listWorkerPools(LocationName parent)

public final CloudBuildClient.ListWorkerPoolsPagedResponse listWorkerPools(LocationName parent)

Lists WorkerPools.

Sample code:

 try (CloudBuildClient cloudBuildClient = CloudBuildClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   for (WorkerPool element : cloudBuildClient.listWorkerPools(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameter

Name	Description
parent	LocationName Required. The parent of the collection of WorkerPools. Format: projects/{project}/locations/{location}.

Returns

Type	Description
CloudBuildClient.ListWorkerPoolsPagedResponse

listWorkerPools(String parent)

public final CloudBuildClient.ListWorkerPoolsPagedResponse listWorkerPools(String parent)

Lists WorkerPools.

Sample code:

 try (CloudBuildClient cloudBuildClient = CloudBuildClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   for (WorkerPool element : cloudBuildClient.listWorkerPools(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameter

Name	Description
parent	String Required. The parent of the collection of WorkerPools. Format: projects/{project}/locations/{location}.

Returns

Type	Description
CloudBuildClient.ListWorkerPoolsPagedResponse

listWorkerPoolsCallable()

public final UnaryCallable<ListWorkerPoolsRequest,ListWorkerPoolsResponse> listWorkerPoolsCallable()

Lists WorkerPools.

Sample code:

 try (CloudBuildClient cloudBuildClient = CloudBuildClient.create()) {
   ListWorkerPoolsRequest request =
       ListWorkerPoolsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListWorkerPoolsResponse response = cloudBuildClient.listWorkerPoolsCallable().call(request);
     for (WorkerPool element : response.getResponsesList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 

Returns

Type	Description
UnaryCallable<ListWorkerPoolsRequest,ListWorkerPoolsResponse>

listWorkerPoolsPagedCallable()

public final UnaryCallable<ListWorkerPoolsRequest,CloudBuildClient.ListWorkerPoolsPagedResponse> listWorkerPoolsPagedCallable()

Lists WorkerPools.

Sample code:

 try (CloudBuildClient cloudBuildClient = CloudBuildClient.create()) {
   ListWorkerPoolsRequest request =
       ListWorkerPoolsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture

Returns

Type	Description
UnaryCallable<ListWorkerPoolsRequest,ListWorkerPoolsPagedResponse>

receiveTriggerWebhook(ReceiveTriggerWebhookRequest request)

public final ReceiveTriggerWebhookResponse receiveTriggerWebhook(ReceiveTriggerWebhookRequest request)

ReceiveTriggerWebhook [Experimental] is called when the API receives a webhook request targeted at a specific trigger.

Sample code:

 try (CloudBuildClient cloudBuildClient = CloudBuildClient.create()) {
   ReceiveTriggerWebhookRequest request =
       ReceiveTriggerWebhookRequest.newBuilder()
           .setName("name3373707")
           .setBody(HttpBody.newBuilder().build())
           .setProjectId("projectId-894832108")
           .setTrigger("trigger-1059891784")
           .setSecret("secret-906277200")
           .build();
   ReceiveTriggerWebhookResponse response = cloudBuildClient.receiveTriggerWebhook(request);
 }
 

Parameter

Name	Description
request	ReceiveTriggerWebhookRequest The request object containing all of the parameters for the API call.

Returns

Type	Description
ReceiveTriggerWebhookResponse

receiveTriggerWebhookCallable()

public final UnaryCallable<ReceiveTriggerWebhookRequest,ReceiveTriggerWebhookResponse> receiveTriggerWebhookCallable()

ReceiveTriggerWebhook [Experimental] is called when the API receives a webhook request targeted at a specific trigger.

Sample code:

 try (CloudBuildClient cloudBuildClient = CloudBuildClient.create()) {
   ReceiveTriggerWebhookRequest request =
       ReceiveTriggerWebhookRequest.newBuilder()
           .setName("name3373707")
           .setBody(HttpBody.newBuilder().build())
           .setProjectId("projectId-894832108")
           .setTrigger("trigger-1059891784")
           .setSecret("secret-906277200")
           .build();
   ApiFuture

Returns

Type	Description
UnaryCallable<ReceiveTriggerWebhookRequest,ReceiveTriggerWebhookResponse>

retryBuildAsync(RetryBuildRequest request)

public final OperationFuture<Build,BuildOperationMetadata> retryBuildAsync(RetryBuildRequest request)

Creates a new build based on the specified build.

This method creates a new build using the original build request, which may or may not result in an identical build.

For triggered builds:

• Triggered builds resolve to a precise revision; therefore a retry of a triggered build will result in a build that uses the same revision.

For non-triggered builds that specify RepoSource:

• If the original build built from the tip of a branch, the retried build will build from the tip of that branch, which may not be the same revision as the original build.
• If the original build specified a commit sha or revision ID, the retried build will use the identical source.

For builds that specify StorageSource:

• If the original build pulled source from Google Cloud Storage without specifying the generation of the object, the new build will use the current object, which may be different from the original build source.
• If the original build pulled source from Cloud Storage and specified the generation of the object, the new build will attempt to use the same object, which may or may not be available depending on the bucket's lifecycle management settings.

Sample code:

 try (CloudBuildClient cloudBuildClient = CloudBuildClient.create()) {
   RetryBuildRequest request =
       RetryBuildRequest.newBuilder()
           .setName(BuildName.ofProjectBuildName("[PROJECT]", "[BUILD]").toString())
           .setProjectId("projectId-894832108")
           .setId("id3355")
           .build();
   Build response = cloudBuildClient.retryBuildAsync(request).get();
 }
 

Parameter

Name	Description
request	RetryBuildRequest The request object containing all of the parameters for the API call.

Returns

Type	Description
OperationFuture<Build,BuildOperationMetadata>

retryBuildAsync(String projectId, String id)

public final OperationFuture<Build,BuildOperationMetadata> retryBuildAsync(String projectId, String id)

Creates a new build based on the specified build.

This method creates a new build using the original build request, which may or may not result in an identical build.

For triggered builds:

• Triggered builds resolve to a precise revision; therefore a retry of a triggered build will result in a build that uses the same revision.

For non-triggered builds that specify RepoSource:

• If the original build built from the tip of a branch, the retried build will build from the tip of that branch, which may not be the same revision as the original build.
• If the original build specified a commit sha or revision ID, the retried build will use the identical source.

For builds that specify StorageSource:

• If the original build pulled source from Google Cloud Storage without specifying the generation of the object, the new build will use the current object, which may be different from the original build source.
• If the original build pulled source from Cloud Storage and specified the generation of the object, the new build will attempt to use the same object, which may or may not be available depending on the bucket's lifecycle management settings.

Sample code:

 try (CloudBuildClient cloudBuildClient = CloudBuildClient.create()) {
   String projectId = "projectId-894832108";
   String id = "id3355";
   Build response = cloudBuildClient.retryBuildAsync(projectId, id).get();
 }
 

Parameters

Name	Description
projectId	String Required. ID of the project.
id	String Required. Build ID of the original build.

Returns

Type	Description
OperationFuture<Build,BuildOperationMetadata>

retryBuildCallable()

public final UnaryCallable<RetryBuildRequest,Operation> retryBuildCallable()

Creates a new build based on the specified build.

This method creates a new build using the original build request, which may or may not result in an identical build.

For triggered builds:

• Triggered builds resolve to a precise revision; therefore a retry of a triggered build will result in a build that uses the same revision.

For non-triggered builds that specify RepoSource:

• If the original build built from the tip of a branch, the retried build will build from the tip of that branch, which may not be the same revision as the original build.
• If the original build specified a commit sha or revision ID, the retried build will use the identical source.

For builds that specify StorageSource:

• If the original build pulled source from Google Cloud Storage without specifying the generation of the object, the new build will use the current object, which may be different from the original build source.
• If the original build pulled source from Cloud Storage and specified the generation of the object, the new build will attempt to use the same object, which may or may not be available depending on the bucket's lifecycle management settings.

Sample code:

 try (CloudBuildClient cloudBuildClient = CloudBuildClient.create()) {
   RetryBuildRequest request =
       RetryBuildRequest.newBuilder()
           .setName(BuildName.ofProjectBuildName("[PROJECT]", "[BUILD]").toString())
           .setProjectId("projectId-894832108")
           .setId("id3355")
           .build();
   ApiFuture<Operation> future = cloudBuildClient.retryBuildCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 

Returns

Type	Description
UnaryCallable<RetryBuildRequest,Operation>

retryBuildOperationCallable()

public final OperationCallable<RetryBuildRequest,Build,BuildOperationMetadata> retryBuildOperationCallable()

Creates a new build based on the specified build.

This method creates a new build using the original build request, which may or may not result in an identical build.

For triggered builds:

• Triggered builds resolve to a precise revision; therefore a retry of a triggered build will result in a build that uses the same revision.

For non-triggered builds that specify RepoSource:

• If the original build built from the tip of a branch, the retried build will build from the tip of that branch, which may not be the same revision as the original build.
• If the original build specified a commit sha or revision ID, the retried build will use the identical source.

For builds that specify StorageSource:

• If the original build pulled source from Google Cloud Storage without specifying the generation of the object, the new build will use the current object, which may be different from the original build source.
• If the original build pulled source from Cloud Storage and specified the generation of the object, the new build will attempt to use the same object, which may or may not be available depending on the bucket's lifecycle management settings.

Sample code:

 try (CloudBuildClient cloudBuildClient = CloudBuildClient.create()) {
   RetryBuildRequest request =
       RetryBuildRequest.newBuilder()
           .setName(BuildName.ofProjectBuildName("[PROJECT]", "[BUILD]").toString())
           .setProjectId("projectId-894832108")
           .setId("id3355")
           .build();
   OperationFuture

Returns

Type	Description
OperationCallable<RetryBuildRequest,Build,BuildOperationMetadata>

runBuildTriggerAsync(RunBuildTriggerRequest request)

public final OperationFuture<Build,BuildOperationMetadata> runBuildTriggerAsync(RunBuildTriggerRequest request)

Runs a BuildTrigger at a particular source revision.

Sample code:

 try (CloudBuildClient cloudBuildClient = CloudBuildClient.create()) {
   RunBuildTriggerRequest request =
       RunBuildTriggerRequest.newBuilder()
           .setName(BuildTriggerName.ofProjectTriggerName("[PROJECT]", "[TRIGGER]").toString())
           .setProjectId("projectId-894832108")
           .setTriggerId("triggerId-648752909")
           .setSource(RepoSource.newBuilder().build())
           .build();
   Build response = cloudBuildClient.runBuildTriggerAsync(request).get();
 }
 

Parameter

Name	Description
request	RunBuildTriggerRequest The request object containing all of the parameters for the API call.

Returns

Type	Description
OperationFuture<Build,BuildOperationMetadata>

runBuildTriggerAsync(String projectId, String triggerId, RepoSource source)

public final OperationFuture<Build,BuildOperationMetadata> runBuildTriggerAsync(String projectId, String triggerId, RepoSource source)

Runs a BuildTrigger at a particular source revision.

Sample code:

 try (CloudBuildClient cloudBuildClient = CloudBuildClient.create()) {
   String projectId = "projectId-894832108";
   String triggerId = "triggerId-648752909";
   RepoSource source = RepoSource.newBuilder().build();
   Build response = cloudBuildClient.runBuildTriggerAsync(projectId, triggerId, source).get();
 }
 

Parameters

Name	Description
projectId	String Required. ID of the project.
triggerId	String Required. ID of the trigger.
source	RepoSource Source to build against this trigger.

Returns

Type	Description
OperationFuture<Build,BuildOperationMetadata>

runBuildTriggerCallable()

public final UnaryCallable<RunBuildTriggerRequest,Operation> runBuildTriggerCallable()

Runs a BuildTrigger at a particular source revision.

Sample code:

 try (CloudBuildClient cloudBuildClient = CloudBuildClient.create()) {
   RunBuildTriggerRequest request =
       RunBuildTriggerRequest.newBuilder()
           .setName(BuildTriggerName.ofProjectTriggerName("[PROJECT]", "[TRIGGER]").toString())
           .setProjectId("projectId-894832108")
           .setTriggerId("triggerId-648752909")
           .setSource(RepoSource.newBuilder().build())
           .build();
   ApiFuture<Operation> future = cloudBuildClient.runBuildTriggerCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 

Returns

Type	Description
UnaryCallable<RunBuildTriggerRequest,Operation>

runBuildTriggerOperationCallable()

public final OperationCallable<RunBuildTriggerRequest,Build,BuildOperationMetadata> runBuildTriggerOperationCallable()

Runs a BuildTrigger at a particular source revision.

Sample code:

 try (CloudBuildClient cloudBuildClient = CloudBuildClient.create()) {
   RunBuildTriggerRequest request =
       RunBuildTriggerRequest.newBuilder()
           .setName(BuildTriggerName.ofProjectTriggerName("[PROJECT]", "[TRIGGER]").toString())
           .setProjectId("projectId-894832108")
           .setTriggerId("triggerId-648752909")
           .setSource(RepoSource.newBuilder().build())
           .build();
   OperationFuture

Returns

Type	Description
OperationCallable<RunBuildTriggerRequest,Build,BuildOperationMetadata>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()

updateBuildTrigger(UpdateBuildTriggerRequest request)

public final BuildTrigger updateBuildTrigger(UpdateBuildTriggerRequest request)

Updates a BuildTrigger by its project ID and trigger ID.

This API is experimental.

Sample code:

 try (CloudBuildClient cloudBuildClient = CloudBuildClient.create()) {
   UpdateBuildTriggerRequest request =
       UpdateBuildTriggerRequest.newBuilder()
           .setProjectId("projectId-894832108")
           .setTriggerId("triggerId-648752909")
           .setTrigger(BuildTrigger.newBuilder().build())
           .build();
   BuildTrigger response = cloudBuildClient.updateBuildTrigger(request);
 }
 

Parameter

Name	Description
request	UpdateBuildTriggerRequest The request object containing all of the parameters for the API call.

Returns

Type	Description
BuildTrigger

updateBuildTrigger(String projectId, String triggerId, BuildTrigger trigger)

public final BuildTrigger updateBuildTrigger(String projectId, String triggerId, BuildTrigger trigger)

Updates a BuildTrigger by its project ID and trigger ID.

This API is experimental.

Sample code:

 try (CloudBuildClient cloudBuildClient = CloudBuildClient.create()) {
   String projectId = "projectId-894832108";
   String triggerId = "triggerId-648752909";
   BuildTrigger trigger = BuildTrigger.newBuilder().build();
   BuildTrigger response = cloudBuildClient.updateBuildTrigger(projectId, triggerId, trigger);
 }
 

Parameters

Name	Description
projectId	String Required. ID of the project that owns the trigger.
triggerId	String Required. ID of the BuildTrigger to update.
trigger	BuildTrigger Required. BuildTrigger to update.

Returns

Type	Description
BuildTrigger

updateBuildTriggerCallable()

public final UnaryCallable<UpdateBuildTriggerRequest,BuildTrigger> updateBuildTriggerCallable()

Updates a BuildTrigger by its project ID and trigger ID.

This API is experimental.

Sample code:

 try (CloudBuildClient cloudBuildClient = CloudBuildClient.create()) {
   UpdateBuildTriggerRequest request =
       UpdateBuildTriggerRequest.newBuilder()
           .setProjectId("projectId-894832108")
           .setTriggerId("triggerId-648752909")
           .setTrigger(BuildTrigger.newBuilder().build())
           .build();
   ApiFuture

Returns

Type	Description
UnaryCallable<UpdateBuildTriggerRequest,BuildTrigger>

updateWorkerPoolAsync(UpdateWorkerPoolRequest request)

public final OperationFuture<WorkerPool,UpdateWorkerPoolOperationMetadata> updateWorkerPoolAsync(UpdateWorkerPoolRequest request)

Updates a WorkerPool.

Sample code:

 try (CloudBuildClient cloudBuildClient = CloudBuildClient.create()) {
   UpdateWorkerPoolRequest request =
       UpdateWorkerPoolRequest.newBuilder()
           .setWorkerPool(WorkerPool.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .setValidateOnly(true)
           .build();
   WorkerPool response = cloudBuildClient.updateWorkerPoolAsync(request).get();
 }
 

Parameter

Name	Description
request	UpdateWorkerPoolRequest The request object containing all of the parameters for the API call.

Returns

Type	Description
OperationFuture<WorkerPool,UpdateWorkerPoolOperationMetadata>

updateWorkerPoolAsync(WorkerPool workerPool, FieldMask updateMask)

public final OperationFuture<WorkerPool,UpdateWorkerPoolOperationMetadata> updateWorkerPoolAsync(WorkerPool workerPool, FieldMask updateMask)

Updates a WorkerPool.

Sample code:

 try (CloudBuildClient cloudBuildClient = CloudBuildClient.create()) {
   WorkerPool workerPool = WorkerPool.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   WorkerPool response = cloudBuildClient.updateWorkerPoolAsync(workerPool, updateMask).get();
 }
 

Parameters

Name	Description
workerPool	WorkerPool Required. The WorkerPool to update. The name field is used to identify the WorkerPool to update. Format: projects/{project}/locations/{location}/workerPools/{workerPool}.
updateMask	FieldMask A mask specifying which fields in worker_pool to update.

Returns

Type	Description
OperationFuture<WorkerPool,UpdateWorkerPoolOperationMetadata>

updateWorkerPoolCallable()

public final UnaryCallable<UpdateWorkerPoolRequest,Operation> updateWorkerPoolCallable()

Updates a WorkerPool.

Sample code:

 try (CloudBuildClient cloudBuildClient = CloudBuildClient.create()) {
   UpdateWorkerPoolRequest request =
       UpdateWorkerPoolRequest.newBuilder()
           .setWorkerPool(WorkerPool.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .setValidateOnly(true)
           .build();
   ApiFuture<Operation> future = cloudBuildClient.updateWorkerPoolCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 

Returns

Type	Description
UnaryCallable<UpdateWorkerPoolRequest,Operation>

updateWorkerPoolOperationCallable()

public final OperationCallable<UpdateWorkerPoolRequest,WorkerPool,UpdateWorkerPoolOperationMetadata> updateWorkerPoolOperationCallable()

Updates a WorkerPool.

Sample code:

 try (CloudBuildClient cloudBuildClient = CloudBuildClient.create()) {
   UpdateWorkerPoolRequest request =
       UpdateWorkerPoolRequest.newBuilder()
           .setWorkerPool(WorkerPool.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .setValidateOnly(true)
           .build();
   OperationFuture

Returns

Type	Description
OperationCallable<UpdateWorkerPoolRequest,WorkerPool,UpdateWorkerPoolOperationMetadata>