Package com.google.cloud.devtools.cloudbuild.v1 (3.24.0)

A client to Cloud Build API

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

CloudBuildClient

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.

Sample for CloudBuildClient:


 // 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 (CloudBuildClient cloudBuildClient = CloudBuildClient.create()) {
   String projectId = "projectId-894832108";
   String id = "id3355";
   Build response = cloudBuildClient.getBuild(projectId, id);
 }

Classes

CloudBuildClient

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:


 // 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 (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:


 // 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
 CloudBuildSettings cloudBuildSettings =
     CloudBuildSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 CloudBuildClient cloudBuildClient = CloudBuildClient.create(cloudBuildSettings);

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
 CloudBuildSettings cloudBuildSettings =
     CloudBuildSettings.newBuilder().setEndpoint(myEndpoint).build();
 CloudBuildClient cloudBuildClient = CloudBuildClient.create(cloudBuildSettings);

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
 CloudBuildSettings cloudBuildSettings = CloudBuildSettings.newHttpJsonBuilder().build();
 CloudBuildClient cloudBuildClient = CloudBuildClient.create(cloudBuildSettings);

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

CloudBuildClient.ListBuildTriggersFixedSizeCollection

CloudBuildClient.ListBuildTriggersPage

CloudBuildClient.ListBuildTriggersPagedResponse

CloudBuildClient.ListBuildsFixedSizeCollection

CloudBuildClient.ListBuildsPage

CloudBuildClient.ListBuildsPagedResponse

CloudBuildClient.ListWorkerPoolsFixedSizeCollection

CloudBuildClient.ListWorkerPoolsPage

CloudBuildClient.ListWorkerPoolsPagedResponse

CloudBuildSettings

Settings class to configure an instance of CloudBuildClient.

The default instance has everything set to sensible defaults:

  • The default service address (cloudbuild.googleapis.com) and default port (443) are used.
  • Credentials are acquired automatically through Application Default Credentials.
  • Retries are configured for idempotent methods but not for non-idempotent methods.

The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object.

For example, to set the total timeout of getBuild to 30 seconds:


 // 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
 CloudBuildSettings.Builder cloudBuildSettingsBuilder = CloudBuildSettings.newBuilder();
 cloudBuildSettingsBuilder
     .getBuildSettings()
     .setRetrySettings(
         cloudBuildSettingsBuilder
             .getBuildSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 CloudBuildSettings cloudBuildSettings = cloudBuildSettingsBuilder.build();

CloudBuildSettings.Builder

Builder for CloudBuildSettings.