public static final class CloudBuildGrpc.CloudBuildBlockingStub extends AbstractBlockingStub<CloudBuildGrpc.CloudBuildBlockingStub>
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.AbstractBlockingStub >
CloudBuildGrpc.CloudBuildBlockingStub
Inherited Members
io.grpc.stub.AbstractBlockingStub.<T>newStub(io.grpc.stub.AbstractStub.StubFactory<T>,io.grpc.Channel)
io.grpc.stub.AbstractBlockingStub.<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()
Methods
approveBuild(ApproveBuildRequest request)
public 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
Returns
build(Channel channel, CallOptions callOptions)
protected CloudBuildGrpc.CloudBuildBlockingStub build(Channel channel, CallOptions callOptions)
Parameters
Name | Description |
channel | io.grpc.Channel
|
callOptions | io.grpc.CallOptions
|
Returns
Overrides
io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)
cancelBuild(CancelBuildRequest request)
public Build cancelBuild(CancelBuildRequest request)
Cancels a build in progress.
Parameter
Returns
createBuild(CreateBuildRequest request)
public 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
Returns
createBuildTrigger(CreateBuildTriggerRequest request)
public BuildTrigger createBuildTrigger(CreateBuildTriggerRequest request)
Creates a new BuildTrigger
.
This API is experimental.
Parameter
Returns
createWorkerPool(CreateWorkerPoolRequest request)
public Operation createWorkerPool(CreateWorkerPoolRequest request)
Parameter
Returns
deleteBuildTrigger(DeleteBuildTriggerRequest request)
public Empty deleteBuildTrigger(DeleteBuildTriggerRequest request)
Deletes a BuildTrigger
by its project ID and trigger ID.
This API is experimental.
Parameter
Returns
deleteWorkerPool(DeleteWorkerPoolRequest request)
public Operation deleteWorkerPool(DeleteWorkerPoolRequest request)
Parameter
Returns
getBuild(GetBuildRequest request)
public 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
Returns
getBuildTrigger(GetBuildTriggerRequest request)
public BuildTrigger getBuildTrigger(GetBuildTriggerRequest request)
Returns information about a BuildTrigger
.
This API is experimental.
Parameter
Returns
getWorkerPool(GetWorkerPoolRequest request)
public WorkerPool getWorkerPool(GetWorkerPoolRequest request)
Returns details of a WorkerPool
.
Parameter
Returns
listBuildTriggers(ListBuildTriggersRequest request)
public ListBuildTriggersResponse listBuildTriggers(ListBuildTriggersRequest request)
Lists existing BuildTrigger
s.
This API is experimental.
Parameter
Returns
listBuilds(ListBuildsRequest request)
public ListBuildsResponse listBuilds(ListBuildsRequest request)
Lists previously requested builds.
Previously requested builds may still be in-progress, or may have finished
successfully or unsuccessfully.
Parameter
Returns
listWorkerPools(ListWorkerPoolsRequest request)
public ListWorkerPoolsResponse listWorkerPools(ListWorkerPoolsRequest request)
Parameter
Returns
receiveTriggerWebhook(ReceiveTriggerWebhookRequest request)
public ReceiveTriggerWebhookResponse receiveTriggerWebhook(ReceiveTriggerWebhookRequest request)
ReceiveTriggerWebhook [Experimental] is called when the API receives a
webhook request targeted at a specific trigger.
Parameter
Returns
retryBuild(RetryBuildRequest request)
public 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 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.
Parameter
Returns
runBuildTrigger(RunBuildTriggerRequest request)
public Operation runBuildTrigger(RunBuildTriggerRequest request)
Runs a BuildTrigger
at a particular source revision.
Parameter
Returns
updateBuildTrigger(UpdateBuildTriggerRequest request)
public BuildTrigger updateBuildTrigger(UpdateBuildTriggerRequest request)
Updates a BuildTrigger
by its project ID and trigger ID.
This API is experimental.
Parameter
Returns
updateWorkerPool(UpdateWorkerPoolRequest request)
public Operation updateWorkerPool(UpdateWorkerPoolRequest request)
Parameter
Returns