com.google.api.services.cloudbuild.v1

Class CloudBuild.Projects.Locations.Builds

java.lang.Object

com.google.api.services.cloudbuild.v1.CloudBuild.Projects.Locations.Builds

Enclosing class:

CloudBuild.Projects.Locations

public class CloudBuild.Projects.Locations.Builds
extends Object

The "builds" collection of methods.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	CloudBuild.Projects.Locations.Builds.Approve
class	CloudBuild.Projects.Locations.Builds.Cancel
class	CloudBuild.Projects.Locations.Builds.Create
class	CloudBuild.Projects.Locations.Builds.Get
class	CloudBuild.Projects.Locations.Builds.List
class	CloudBuild.Projects.Locations.Builds.Retry

Constructor Summary

Constructors

Constructor and Description
Builds()

Method Summary

Modifier and Type	Method and Description
CloudBuild.Projects.Locations.Builds.Approve	approve(String name, ApproveBuildRequest content) Approves or rejects a pending build.
CloudBuild.Projects.Locations.Builds.Cancel	cancel(String name, CancelBuildRequest content) Cancels a build in progress.
CloudBuild.Projects.Locations.Builds.Create	create(String parent, Build content) Starts a build with the specified configuration.
CloudBuild.Projects.Locations.Builds.Get	get(String name) Returns information about a previously requested build.
CloudBuild.Projects.Locations.Builds.List	list(String parent) Lists previously requested builds.
CloudBuild.Projects.Locations.Builds.Retry	retry(String name, RetryBuildRequest content) Creates a new build based on the specified build.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builds

public Builds()

Method Detail

approve

public CloudBuild.Projects.Locations.Builds.Approve approve(String name,
                                                            ApproveBuildRequest content)
                                                     throws IOException

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. Create a request for the method "builds.approve". This request holds the parameters needed by the cloudbuild server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

name - Required. Name of the target build. For example: "projects/{$project_id}/builds/{$build_id}"

content - the ApproveBuildRequest

Returns:

the request

Throws:

IOException

cancel

public CloudBuild.Projects.Locations.Builds.Cancel cancel(String name,
                                                          CancelBuildRequest content)
                                                   throws IOException

Cancels a build in progress. Create a request for the method "builds.cancel". This request holds the parameters needed by the cloudbuild server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

name - The name of the `Build` to cancel. Format: `projects/{project}/locations/{location}/builds/{build}`

content - the CancelBuildRequest

Returns:

the request

Throws:

IOException

create

public CloudBuild.Projects.Locations.Builds.Create create(String parent,
                                                          Build content)
                                                   throws IOException

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`). Create a request for the method "builds.create". This request holds the parameters needed by the cloudbuild server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

parent - The parent resource where this build will be created. Format: `projects/{project}/locations/{location}`

content - the Build

Returns:

the request

Throws:

IOException

get

public CloudBuild.Projects.Locations.Builds.Get get(String name)
                                             throws IOException

Returns information about a previously requested build. The `Build` that is returned includes its status (such as `SUCCESS`, `FAILURE`, or `WORKING`), and timing information. Create a request for the method "builds.get". This request holds the parameters needed by the cloudbuild server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

name - The name of the `Build` to retrieve. Format: `projects/{project}/locations/{location}/builds/{build}`

Returns:

the request

Throws:

IOException

list

public CloudBuild.Projects.Locations.Builds.List list(String parent)
                                               throws IOException

Lists previously requested builds. Previously requested builds may still be in-progress, or may have finished successfully or unsuccessfully. Create a request for the method "builds.list". This request holds the parameters needed by the cloudbuild server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

parent - The parent of the collection of `Builds`. Format: `projects/{project}/locations/{location}`

Returns:

the request

Throws:

IOException

retry

public CloudBuild.Projects.Locations.Builds.Retry retry(String name,
                                                        RetryBuildRequest content)
                                                 throws IOException

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 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. Create a request for the method "builds.retry". This request holds the parameters needed by the cloudbuild server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

name - The name of the `Build` to retry. Format: `projects/{project}/locations/{location}/builds/{build}`

content - the RetryBuildRequest

Returns:

the request

Throws:

IOException