Class CloudBuildGrpc.CloudBuildFutureStub (3.48.0)

public static final class CloudBuildGrpc.CloudBuildFutureStub extends AbstractFutureStub<CloudBuildGrpc.CloudBuildFutureStub>

A stub to allow clients to do ListenableFuture-style rpc calls to service CloudBuild.

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.

Inheritance

java.lang.Object > io.grpc.stub.AbstractStub > io.grpc.stub.AbstractFutureStub > CloudBuildGrpc.CloudBuildFutureStub

Inherited Members

io.grpc.stub.AbstractFutureStub.<T>newStub(io.grpc.stub.AbstractStub.StubFactory<T>,io.grpc.Channel)

io.grpc.stub.AbstractFutureStub.<T>newStub(io.grpc.stub.AbstractStub.StubFactory<T>,io.grpc.Channel,io.grpc.CallOptions)

io.grpc.stub.AbstractStub.<T>withOption(io.grpc.CallOptions.Key<T>,T)

io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)

io.grpc.stub.AbstractStub.getCallOptions()

io.grpc.stub.AbstractStub.getChannel()

io.grpc.stub.AbstractStub.withCallCredentials(io.grpc.CallCredentials)

io.grpc.stub.AbstractStub.withChannel(io.grpc.Channel)

io.grpc.stub.AbstractStub.withCompression(java.lang.String)

io.grpc.stub.AbstractStub.withDeadline(io.grpc.Deadline)

io.grpc.stub.AbstractStub.withDeadlineAfter(long,java.util.concurrent.TimeUnit)

io.grpc.stub.AbstractStub.withExecutor(java.util.concurrent.Executor)

io.grpc.stub.AbstractStub.withInterceptors(io.grpc.ClientInterceptor...)

io.grpc.stub.AbstractStub.withMaxInboundMessageSize(int)

io.grpc.stub.AbstractStub.withMaxOutboundMessageSize(int)

io.grpc.stub.AbstractStub.withWaitForReady()

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)

Methods

approveBuild(ApproveBuildRequest request)

public ListenableFuture<Operation> approveBuild(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.

Parameter
Name	Description
`request`	`ApproveBuildRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<Operation>`

build(Channel channel, CallOptions callOptions)

protected CloudBuildGrpc.CloudBuildFutureStub build(Channel channel, CallOptions callOptions)

Parameters
Name	Description
`channel`	`io.grpc.Channel`
`callOptions`	`io.grpc.CallOptions`

Returns
Type	Description
`CloudBuildGrpc.CloudBuildFutureStub`

Overrides

io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)

cancelBuild(CancelBuildRequest request)

public ListenableFuture<Build> cancelBuild(CancelBuildRequest request)

Cancels a build in progress.

Parameter
Name	Description
`request`	`CancelBuildRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<Build>`

createBuild(CreateBuildRequest request)

public ListenableFuture<Operation> createBuild(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).

Parameter
Name	Description
`request`	`CreateBuildRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<Operation>`

createBuildTrigger(CreateBuildTriggerRequest request)

public ListenableFuture<BuildTrigger> createBuildTrigger(CreateBuildTriggerRequest request)

Creates a new BuildTrigger. This API is experimental.

Parameter
Name	Description
`request`	`CreateBuildTriggerRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<BuildTrigger>`

createWorkerPool(CreateWorkerPoolRequest request)

public ListenableFuture<Operation> createWorkerPool(CreateWorkerPoolRequest request)

Creates a WorkerPool.

Parameter
Name	Description
`request`	`CreateWorkerPoolRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<Operation>`

deleteBuildTrigger(DeleteBuildTriggerRequest request)

public ListenableFuture<Empty> deleteBuildTrigger(DeleteBuildTriggerRequest request)

Deletes a BuildTrigger by its project ID and trigger ID. This API is experimental.

Parameter
Name	Description
`request`	`DeleteBuildTriggerRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<Empty>`

deleteWorkerPool(DeleteWorkerPoolRequest request)

public ListenableFuture<Operation> deleteWorkerPool(DeleteWorkerPoolRequest request)

Deletes a WorkerPool.

Parameter
Name	Description
`request`	`DeleteWorkerPoolRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<Operation>`

getBuild(GetBuildRequest request)

public ListenableFuture<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.

Parameter
Name	Description
`request`	`GetBuildRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<Build>`

getBuildTrigger(GetBuildTriggerRequest request)

public ListenableFuture<BuildTrigger> getBuildTrigger(GetBuildTriggerRequest request)

Returns information about a BuildTrigger. This API is experimental.

Parameter
Name	Description
`request`	`GetBuildTriggerRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<BuildTrigger>`

getWorkerPool(GetWorkerPoolRequest request)

public ListenableFuture<WorkerPool> getWorkerPool(GetWorkerPoolRequest request)

Returns details of a WorkerPool.

Parameter
Name	Description
`request`	`GetWorkerPoolRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<WorkerPool>`

listBuildTriggers(ListBuildTriggersRequest request)

public ListenableFuture<ListBuildTriggersResponse> listBuildTriggers(ListBuildTriggersRequest request)

Lists existing BuildTriggers. This API is experimental.

Parameter
Name	Description
`request`	`ListBuildTriggersRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<ListBuildTriggersResponse>`

listBuilds(ListBuildsRequest request)

public ListenableFuture<ListBuildsResponse> listBuilds(ListBuildsRequest request)

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

Parameter
Name	Description
`request`	`ListBuildsRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<ListBuildsResponse>`

listWorkerPools(ListWorkerPoolsRequest request)

public ListenableFuture<ListWorkerPoolsResponse> listWorkerPools(ListWorkerPoolsRequest request)

Lists WorkerPools.

Parameter
Name	Description
`request`	`ListWorkerPoolsRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<ListWorkerPoolsResponse>`

receiveTriggerWebhook(ReceiveTriggerWebhookRequest request)

public ListenableFuture<ReceiveTriggerWebhookResponse> receiveTriggerWebhook(ReceiveTriggerWebhookRequest request)

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

Parameter
Name	Description
`request`	`ReceiveTriggerWebhookRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<ReceiveTriggerWebhookResponse>`

retryBuild(RetryBuildRequest request)

public ListenableFuture<Operation> retryBuild(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 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.

Parameter
Name	Description
`request`	`RetryBuildRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<Operation>`

runBuildTrigger(RunBuildTriggerRequest request)

public ListenableFuture<Operation> runBuildTrigger(RunBuildTriggerRequest request)

Runs a BuildTrigger at a particular source revision. To run a regional or global trigger, use the POST request that includes the location endpoint in the path (ex. v1/projects/{projectId}/locations/{region}/triggers/{triggerId}:run). The POST request that does not include the location endpoint in the path can only be used when running global triggers.

Parameter
Name	Description
`request`	`RunBuildTriggerRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<Operation>`

updateBuildTrigger(UpdateBuildTriggerRequest request)

public ListenableFuture<BuildTrigger> updateBuildTrigger(UpdateBuildTriggerRequest request)

Updates a BuildTrigger by its project ID and trigger ID. This API is experimental.

Parameter
Name	Description
`request`	`UpdateBuildTriggerRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<BuildTrigger>`

updateWorkerPool(UpdateWorkerPoolRequest request)

public ListenableFuture<Operation> updateWorkerPool(UpdateWorkerPoolRequest request)

Updates a WorkerPool.

Parameter
Name	Description
`request`	`UpdateWorkerPoolRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<Operation>`