- 3.56.0 (latest)
- 3.55.0
- 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 abstract static class CloudBuildGrpc.CloudBuildImplBase implements BindableService
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.
Implements
io.grpc.BindableServiceConstructors
CloudBuildImplBase()
public CloudBuildImplBase()
Methods
approveBuild(ApproveBuildRequest request, StreamObserver<Operation> responseObserver)
public void approveBuild(ApproveBuildRequest request, StreamObserver<Operation> responseObserver)
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.
Name | Description |
request | ApproveBuildRequest |
responseObserver | io.grpc.stub.StreamObserver<Operation> |
bindService()
public final ServerServiceDefinition bindService()
Type | Description |
io.grpc.ServerServiceDefinition |
cancelBuild(CancelBuildRequest request, StreamObserver<Build> responseObserver)
public void cancelBuild(CancelBuildRequest request, StreamObserver<Build> responseObserver)
Cancels a build in progress.
Name | Description |
request | CancelBuildRequest |
responseObserver | io.grpc.stub.StreamObserver<Build> |
createBuild(CreateBuildRequest request, StreamObserver<Operation> responseObserver)
public void createBuild(CreateBuildRequest request, StreamObserver<Operation> responseObserver)
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
).
Name | Description |
request | CreateBuildRequest |
responseObserver | io.grpc.stub.StreamObserver<Operation> |
createBuildTrigger(CreateBuildTriggerRequest request, StreamObserver<BuildTrigger> responseObserver)
public void createBuildTrigger(CreateBuildTriggerRequest request, StreamObserver<BuildTrigger> responseObserver)
Creates a new BuildTrigger
.
This API is experimental.
Name | Description |
request | CreateBuildTriggerRequest |
responseObserver | io.grpc.stub.StreamObserver<BuildTrigger> |
createWorkerPool(CreateWorkerPoolRequest request, StreamObserver<Operation> responseObserver)
public void createWorkerPool(CreateWorkerPoolRequest request, StreamObserver<Operation> responseObserver)
Creates a WorkerPool
.
Name | Description |
request | CreateWorkerPoolRequest |
responseObserver | io.grpc.stub.StreamObserver<Operation> |
deleteBuildTrigger(DeleteBuildTriggerRequest request, StreamObserver<Empty> responseObserver)
public void deleteBuildTrigger(DeleteBuildTriggerRequest request, StreamObserver<Empty> responseObserver)
Deletes a BuildTrigger
by its project ID and trigger ID.
This API is experimental.
Name | Description |
request | DeleteBuildTriggerRequest |
responseObserver | io.grpc.stub.StreamObserver<Empty> |
deleteWorkerPool(DeleteWorkerPoolRequest request, StreamObserver<Operation> responseObserver)
public void deleteWorkerPool(DeleteWorkerPoolRequest request, StreamObserver<Operation> responseObserver)
Deletes a WorkerPool
.
Name | Description |
request | DeleteWorkerPoolRequest |
responseObserver | io.grpc.stub.StreamObserver<Operation> |
getBuild(GetBuildRequest request, StreamObserver<Build> responseObserver)
public void getBuild(GetBuildRequest request, StreamObserver<Build> responseObserver)
Returns information about a previously requested build.
The Build
that is returned includes its status (such as SUCCESS
,
FAILURE
, or WORKING
), and timing information.
Name | Description |
request | GetBuildRequest |
responseObserver | io.grpc.stub.StreamObserver<Build> |
getBuildTrigger(GetBuildTriggerRequest request, StreamObserver<BuildTrigger> responseObserver)
public void getBuildTrigger(GetBuildTriggerRequest request, StreamObserver<BuildTrigger> responseObserver)
Returns information about a BuildTrigger
.
This API is experimental.
Name | Description |
request | GetBuildTriggerRequest |
responseObserver | io.grpc.stub.StreamObserver<BuildTrigger> |
getWorkerPool(GetWorkerPoolRequest request, StreamObserver<WorkerPool> responseObserver)
public void getWorkerPool(GetWorkerPoolRequest request, StreamObserver<WorkerPool> responseObserver)
Returns details of a WorkerPool
.
Name | Description |
request | GetWorkerPoolRequest |
responseObserver | io.grpc.stub.StreamObserver<WorkerPool> |
listBuildTriggers(ListBuildTriggersRequest request, StreamObserver<ListBuildTriggersResponse> responseObserver)
public void listBuildTriggers(ListBuildTriggersRequest request, StreamObserver<ListBuildTriggersResponse> responseObserver)
Lists existing BuildTrigger
s.
This API is experimental.
Name | Description |
request | ListBuildTriggersRequest |
responseObserver | io.grpc.stub.StreamObserver<ListBuildTriggersResponse> |
listBuilds(ListBuildsRequest request, StreamObserver<ListBuildsResponse> responseObserver)
public void listBuilds(ListBuildsRequest request, StreamObserver<ListBuildsResponse> responseObserver)
Lists previously requested builds. Previously requested builds may still be in-progress, or may have finished successfully or unsuccessfully.
Name | Description |
request | ListBuildsRequest |
responseObserver | io.grpc.stub.StreamObserver<ListBuildsResponse> |
listWorkerPools(ListWorkerPoolsRequest request, StreamObserver<ListWorkerPoolsResponse> responseObserver)
public void listWorkerPools(ListWorkerPoolsRequest request, StreamObserver<ListWorkerPoolsResponse> responseObserver)
Lists WorkerPool
s.
Name | Description |
request | ListWorkerPoolsRequest |
responseObserver | io.grpc.stub.StreamObserver<ListWorkerPoolsResponse> |
receiveTriggerWebhook(ReceiveTriggerWebhookRequest request, StreamObserver<ReceiveTriggerWebhookResponse> responseObserver)
public void receiveTriggerWebhook(ReceiveTriggerWebhookRequest request, StreamObserver<ReceiveTriggerWebhookResponse> responseObserver)
ReceiveTriggerWebhook [Experimental] is called when the API receives a webhook request targeted at a specific trigger.
Name | Description |
request | ReceiveTriggerWebhookRequest |
responseObserver | io.grpc.stub.StreamObserver<ReceiveTriggerWebhookResponse> |
retryBuild(RetryBuildRequest request, StreamObserver<Operation> responseObserver)
public void retryBuild(RetryBuildRequest request, StreamObserver<Operation> responseObserver)
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.
Name | Description |
request | RetryBuildRequest |
responseObserver | io.grpc.stub.StreamObserver<Operation> |
runBuildTrigger(RunBuildTriggerRequest request, StreamObserver<Operation> responseObserver)
public void runBuildTrigger(RunBuildTriggerRequest request, StreamObserver<Operation> responseObserver)
Runs a BuildTrigger
at a particular source revision.
Name | Description |
request | RunBuildTriggerRequest |
responseObserver | io.grpc.stub.StreamObserver<Operation> |
updateBuildTrigger(UpdateBuildTriggerRequest request, StreamObserver<BuildTrigger> responseObserver)
public void updateBuildTrigger(UpdateBuildTriggerRequest request, StreamObserver<BuildTrigger> responseObserver)
Updates a BuildTrigger
by its project ID and trigger ID.
This API is experimental.
Name | Description |
request | UpdateBuildTriggerRequest |
responseObserver | io.grpc.stub.StreamObserver<BuildTrigger> |
updateWorkerPool(UpdateWorkerPoolRequest request, StreamObserver<Operation> responseObserver)
public void updateWorkerPool(UpdateWorkerPoolRequest request, StreamObserver<Operation> responseObserver)
Updates a WorkerPool
.
Name | Description |
request | UpdateWorkerPoolRequest |
responseObserver | io.grpc.stub.StreamObserver<Operation> |