Represents a CloudBuild
Inheritance
$protobuf.rpc.Service > protos.google.devtools.cloudbuild.v1.CloudBuildPackage
@google-cloud/cloudbuildConstructors
(constructor)(rpcImpl, requestDelimited, responseDelimited)
constructor(rpcImpl: $protobuf.RPCImpl, requestDelimited?: boolean, responseDelimited?: boolean);Constructs a new CloudBuild service.
| Parameters | |
|---|---|
| Name | Description |
rpcImpl |
$protobuf.RPCImpl
RPC implementation |
requestDelimited |
boolean
Whether requests are length-delimited |
responseDelimited |
boolean
Whether responses are length-delimited |
Methods
approveBuild(request, callback)
public approveBuild(request: google.devtools.cloudbuild.v1.IApproveBuildRequest, callback: google.devtools.cloudbuild.v1.CloudBuild.ApproveBuildCallback): void;Calls ApproveBuild.
| Parameters | |
|---|---|
| Name | Description |
request |
IApproveBuildRequest
ApproveBuildRequest message or plain object |
callback |
ApproveBuildCallback
Node-style callback called with the error, if any, and Operation |
| Returns | |
|---|---|
| Type | Description |
void | |
approveBuild(request)
public approveBuild(request: google.devtools.cloudbuild.v1.IApproveBuildRequest): Promise<google.longrunning.Operation>;Calls ApproveBuild.
| Parameter | |
|---|---|
| Name | Description |
request |
IApproveBuildRequest
ApproveBuildRequest message or plain object |
| Returns | |
|---|---|
| Type | Description |
Promise<google.longrunning.Operation> | Promise |
cancelBuild(request, callback)
public cancelBuild(request: google.devtools.cloudbuild.v1.ICancelBuildRequest, callback: google.devtools.cloudbuild.v1.CloudBuild.CancelBuildCallback): void;Calls CancelBuild.
| Parameters | |
|---|---|
| Name | Description |
request |
ICancelBuildRequest
CancelBuildRequest message or plain object |
callback |
CancelBuildCallback
Node-style callback called with the error, if any, and Build |
| Returns | |
|---|---|
| Type | Description |
void | |
cancelBuild(request)
public cancelBuild(request: google.devtools.cloudbuild.v1.ICancelBuildRequest): Promise<google.devtools.cloudbuild.v1.Build>;Calls CancelBuild.
| Parameter | |
|---|---|
| Name | Description |
request |
ICancelBuildRequest
CancelBuildRequest message or plain object |
| Returns | |
|---|---|
| Type | Description |
Promise<google.devtools.cloudbuild.v1.Build> | Promise |
create(rpcImpl, requestDelimited, responseDelimited)
public static create(rpcImpl: $protobuf.RPCImpl, requestDelimited?: boolean, responseDelimited?: boolean): CloudBuild;Creates new CloudBuild service using the specified rpc implementation.
| Parameters | |
|---|---|
| Name | Description |
rpcImpl |
$protobuf.RPCImpl
RPC implementation |
requestDelimited |
boolean
Whether requests are length-delimited |
responseDelimited |
boolean
Whether responses are length-delimited |
| Returns | |
|---|---|
| Type | Description |
CloudBuild | RPC service. Useful where requests and/or responses are streamed. |
createBuild(request, callback)
public createBuild(request: google.devtools.cloudbuild.v1.ICreateBuildRequest, callback: google.devtools.cloudbuild.v1.CloudBuild.CreateBuildCallback): void;Calls CreateBuild.
| Parameters | |
|---|---|
| Name | Description |
request |
ICreateBuildRequest
CreateBuildRequest message or plain object |
callback |
CreateBuildCallback
Node-style callback called with the error, if any, and Operation |
| Returns | |
|---|---|
| Type | Description |
void | |
createBuild(request)
public createBuild(request: google.devtools.cloudbuild.v1.ICreateBuildRequest): Promise<google.longrunning.Operation>;Calls CreateBuild.
| Parameter | |
|---|---|
| Name | Description |
request |
ICreateBuildRequest
CreateBuildRequest message or plain object |
| Returns | |
|---|---|
| Type | Description |
Promise<google.longrunning.Operation> | Promise |
createBuildTrigger(request, callback)
public createBuildTrigger(request: google.devtools.cloudbuild.v1.ICreateBuildTriggerRequest, callback: google.devtools.cloudbuild.v1.CloudBuild.CreateBuildTriggerCallback): void;Calls CreateBuildTrigger.
| Parameters | |
|---|---|
| Name | Description |
request |
ICreateBuildTriggerRequest
CreateBuildTriggerRequest message or plain object |
callback |
CreateBuildTriggerCallback
Node-style callback called with the error, if any, and BuildTrigger |
| Returns | |
|---|---|
| Type | Description |
void | |
createBuildTrigger(request)
public createBuildTrigger(request: google.devtools.cloudbuild.v1.ICreateBuildTriggerRequest): Promise<google.devtools.cloudbuild.v1.BuildTrigger>;Calls CreateBuildTrigger.
| Parameter | |
|---|---|
| Name | Description |
request |
ICreateBuildTriggerRequest
CreateBuildTriggerRequest message or plain object |
| Returns | |
|---|---|
| Type | Description |
Promise<google.devtools.cloudbuild.v1.BuildTrigger> | Promise |
createWorkerPool(request, callback)
public createWorkerPool(request: google.devtools.cloudbuild.v1.ICreateWorkerPoolRequest, callback: google.devtools.cloudbuild.v1.CloudBuild.CreateWorkerPoolCallback): void;Calls CreateWorkerPool.
| Parameters | |
|---|---|
| Name | Description |
request |
ICreateWorkerPoolRequest
CreateWorkerPoolRequest message or plain object |
callback |
CreateWorkerPoolCallback
Node-style callback called with the error, if any, and Operation |
| Returns | |
|---|---|
| Type | Description |
void | |
createWorkerPool(request)
public createWorkerPool(request: google.devtools.cloudbuild.v1.ICreateWorkerPoolRequest): Promise<google.longrunning.Operation>;Calls CreateWorkerPool.
| Parameter | |
|---|---|
| Name | Description |
request |
ICreateWorkerPoolRequest
CreateWorkerPoolRequest message or plain object |
| Returns | |
|---|---|
| Type | Description |
Promise<google.longrunning.Operation> | Promise |
deleteBuildTrigger(request, callback)
public deleteBuildTrigger(request: google.devtools.cloudbuild.v1.IDeleteBuildTriggerRequest, callback: google.devtools.cloudbuild.v1.CloudBuild.DeleteBuildTriggerCallback): void;Calls DeleteBuildTrigger.
| Parameters | |
|---|---|
| Name | Description |
request |
IDeleteBuildTriggerRequest
DeleteBuildTriggerRequest message or plain object |
callback |
DeleteBuildTriggerCallback
Node-style callback called with the error, if any, and Empty |
| Returns | |
|---|---|
| Type | Description |
void | |
deleteBuildTrigger(request)
public deleteBuildTrigger(request: google.devtools.cloudbuild.v1.IDeleteBuildTriggerRequest): Promise<google.protobuf.Empty>;Calls DeleteBuildTrigger.
| Parameter | |
|---|---|
| Name | Description |
request |
IDeleteBuildTriggerRequest
DeleteBuildTriggerRequest message or plain object |
| Returns | |
|---|---|
| Type | Description |
Promise<google.protobuf.Empty> | Promise |
deleteWorkerPool(request, callback)
public deleteWorkerPool(request: google.devtools.cloudbuild.v1.IDeleteWorkerPoolRequest, callback: google.devtools.cloudbuild.v1.CloudBuild.DeleteWorkerPoolCallback): void;Calls DeleteWorkerPool.
| Parameters | |
|---|---|
| Name | Description |
request |
IDeleteWorkerPoolRequest
DeleteWorkerPoolRequest message or plain object |
callback |
DeleteWorkerPoolCallback
Node-style callback called with the error, if any, and Operation |
| Returns | |
|---|---|
| Type | Description |
void | |
deleteWorkerPool(request)
public deleteWorkerPool(request: google.devtools.cloudbuild.v1.IDeleteWorkerPoolRequest): Promise<google.longrunning.Operation>;Calls DeleteWorkerPool.
| Parameter | |
|---|---|
| Name | Description |
request |
IDeleteWorkerPoolRequest
DeleteWorkerPoolRequest message or plain object |
| Returns | |
|---|---|
| Type | Description |
Promise<google.longrunning.Operation> | Promise |
getBuild(request, callback)
public getBuild(request: google.devtools.cloudbuild.v1.IGetBuildRequest, callback: google.devtools.cloudbuild.v1.CloudBuild.GetBuildCallback): void;Calls GetBuild.
| Parameters | |
|---|---|
| Name | Description |
request |
IGetBuildRequest
GetBuildRequest message or plain object |
callback |
GetBuildCallback
Node-style callback called with the error, if any, and Build |
| Returns | |
|---|---|
| Type | Description |
void | |
getBuild(request)
public getBuild(request: google.devtools.cloudbuild.v1.IGetBuildRequest): Promise<google.devtools.cloudbuild.v1.Build>;Calls GetBuild.
| Parameter | |
|---|---|
| Name | Description |
request |
IGetBuildRequest
GetBuildRequest message or plain object |
| Returns | |
|---|---|
| Type | Description |
Promise<google.devtools.cloudbuild.v1.Build> | Promise |
getBuildTrigger(request, callback)
public getBuildTrigger(request: google.devtools.cloudbuild.v1.IGetBuildTriggerRequest, callback: google.devtools.cloudbuild.v1.CloudBuild.GetBuildTriggerCallback): void;Calls GetBuildTrigger.
| Parameters | |
|---|---|
| Name | Description |
request |
IGetBuildTriggerRequest
GetBuildTriggerRequest message or plain object |
callback |
GetBuildTriggerCallback
Node-style callback called with the error, if any, and BuildTrigger |
| Returns | |
|---|---|
| Type | Description |
void | |
getBuildTrigger(request)
public getBuildTrigger(request: google.devtools.cloudbuild.v1.IGetBuildTriggerRequest): Promise<google.devtools.cloudbuild.v1.BuildTrigger>;Calls GetBuildTrigger.
| Parameter | |
|---|---|
| Name | Description |
request |
IGetBuildTriggerRequest
GetBuildTriggerRequest message or plain object |
| Returns | |
|---|---|
| Type | Description |
Promise<google.devtools.cloudbuild.v1.BuildTrigger> | Promise |
getWorkerPool(request, callback)
public getWorkerPool(request: google.devtools.cloudbuild.v1.IGetWorkerPoolRequest, callback: google.devtools.cloudbuild.v1.CloudBuild.GetWorkerPoolCallback): void;Calls GetWorkerPool.
| Parameters | |
|---|---|
| Name | Description |
request |
IGetWorkerPoolRequest
GetWorkerPoolRequest message or plain object |
callback |
GetWorkerPoolCallback
Node-style callback called with the error, if any, and WorkerPool |
| Returns | |
|---|---|
| Type | Description |
void | |
getWorkerPool(request)
public getWorkerPool(request: google.devtools.cloudbuild.v1.IGetWorkerPoolRequest): Promise<google.devtools.cloudbuild.v1.WorkerPool>;Calls GetWorkerPool.
| Parameter | |
|---|---|
| Name | Description |
request |
IGetWorkerPoolRequest
GetWorkerPoolRequest message or plain object |
| Returns | |
|---|---|
| Type | Description |
Promise<google.devtools.cloudbuild.v1.WorkerPool> | Promise |
listBuilds(request, callback)
public listBuilds(request: google.devtools.cloudbuild.v1.IListBuildsRequest, callback: google.devtools.cloudbuild.v1.CloudBuild.ListBuildsCallback): void;Calls ListBuilds.
| Parameters | |
|---|---|
| Name | Description |
request |
IListBuildsRequest
ListBuildsRequest message or plain object |
callback |
ListBuildsCallback
Node-style callback called with the error, if any, and ListBuildsResponse |
| Returns | |
|---|---|
| Type | Description |
void | |
listBuilds(request)
public listBuilds(request: google.devtools.cloudbuild.v1.IListBuildsRequest): Promise<google.devtools.cloudbuild.v1.ListBuildsResponse>;Calls ListBuilds.
| Parameter | |
|---|---|
| Name | Description |
request |
IListBuildsRequest
ListBuildsRequest message or plain object |
| Returns | |
|---|---|
| Type | Description |
Promise<google.devtools.cloudbuild.v1.ListBuildsResponse> | Promise |
listBuildTriggers(request, callback)
public listBuildTriggers(request: google.devtools.cloudbuild.v1.IListBuildTriggersRequest, callback: google.devtools.cloudbuild.v1.CloudBuild.ListBuildTriggersCallback): void;Calls ListBuildTriggers.
| Parameters | |
|---|---|
| Name | Description |
request |
IListBuildTriggersRequest
ListBuildTriggersRequest message or plain object |
callback |
ListBuildTriggersCallback
Node-style callback called with the error, if any, and ListBuildTriggersResponse |
| Returns | |
|---|---|
| Type | Description |
void | |
listBuildTriggers(request)
public listBuildTriggers(request: google.devtools.cloudbuild.v1.IListBuildTriggersRequest): Promise<google.devtools.cloudbuild.v1.ListBuildTriggersResponse>;Calls ListBuildTriggers.
| Parameter | |
|---|---|
| Name | Description |
request |
IListBuildTriggersRequest
ListBuildTriggersRequest message or plain object |
| Returns | |
|---|---|
| Type | Description |
Promise<google.devtools.cloudbuild.v1.ListBuildTriggersResponse> | Promise |
listWorkerPools(request, callback)
public listWorkerPools(request: google.devtools.cloudbuild.v1.IListWorkerPoolsRequest, callback: google.devtools.cloudbuild.v1.CloudBuild.ListWorkerPoolsCallback): void;Calls ListWorkerPools.
| Parameters | |
|---|---|
| Name | Description |
request |
IListWorkerPoolsRequest
ListWorkerPoolsRequest message or plain object |
callback |
ListWorkerPoolsCallback
Node-style callback called with the error, if any, and ListWorkerPoolsResponse |
| Returns | |
|---|---|
| Type | Description |
void | |
listWorkerPools(request)
public listWorkerPools(request: google.devtools.cloudbuild.v1.IListWorkerPoolsRequest): Promise<google.devtools.cloudbuild.v1.ListWorkerPoolsResponse>;Calls ListWorkerPools.
| Parameter | |
|---|---|
| Name | Description |
request |
IListWorkerPoolsRequest
ListWorkerPoolsRequest message or plain object |
| Returns | |
|---|---|
| Type | Description |
Promise<google.devtools.cloudbuild.v1.ListWorkerPoolsResponse> | Promise |
receiveTriggerWebhook(request, callback)
public receiveTriggerWebhook(request: google.devtools.cloudbuild.v1.IReceiveTriggerWebhookRequest, callback: google.devtools.cloudbuild.v1.CloudBuild.ReceiveTriggerWebhookCallback): void;Calls ReceiveTriggerWebhook.
| Parameters | |
|---|---|
| Name | Description |
request |
IReceiveTriggerWebhookRequest
ReceiveTriggerWebhookRequest message or plain object |
callback |
ReceiveTriggerWebhookCallback
Node-style callback called with the error, if any, and ReceiveTriggerWebhookResponse |
| Returns | |
|---|---|
| Type | Description |
void | |
receiveTriggerWebhook(request)
public receiveTriggerWebhook(request: google.devtools.cloudbuild.v1.IReceiveTriggerWebhookRequest): Promise<google.devtools.cloudbuild.v1.ReceiveTriggerWebhookResponse>;Calls ReceiveTriggerWebhook.
| Parameter | |
|---|---|
| Name | Description |
request |
IReceiveTriggerWebhookRequest
ReceiveTriggerWebhookRequest message or plain object |
| Returns | |
|---|---|
| Type | Description |
Promise<google.devtools.cloudbuild.v1.ReceiveTriggerWebhookResponse> | Promise |
retryBuild(request, callback)
public retryBuild(request: google.devtools.cloudbuild.v1.IRetryBuildRequest, callback: google.devtools.cloudbuild.v1.CloudBuild.RetryBuildCallback): void;Calls RetryBuild.
| Parameters | |
|---|---|
| Name | Description |
request |
IRetryBuildRequest
RetryBuildRequest message or plain object |
callback |
RetryBuildCallback
Node-style callback called with the error, if any, and Operation |
| Returns | |
|---|---|
| Type | Description |
void | |
retryBuild(request)
public retryBuild(request: google.devtools.cloudbuild.v1.IRetryBuildRequest): Promise<google.longrunning.Operation>;Calls RetryBuild.
| Parameter | |
|---|---|
| Name | Description |
request |
IRetryBuildRequest
RetryBuildRequest message or plain object |
| Returns | |
|---|---|
| Type | Description |
Promise<google.longrunning.Operation> | Promise |
runBuildTrigger(request, callback)
public runBuildTrigger(request: google.devtools.cloudbuild.v1.IRunBuildTriggerRequest, callback: google.devtools.cloudbuild.v1.CloudBuild.RunBuildTriggerCallback): void;Calls RunBuildTrigger.
| Parameters | |
|---|---|
| Name | Description |
request |
IRunBuildTriggerRequest
RunBuildTriggerRequest message or plain object |
callback |
RunBuildTriggerCallback
Node-style callback called with the error, if any, and Operation |
| Returns | |
|---|---|
| Type | Description |
void | |
runBuildTrigger(request)
public runBuildTrigger(request: google.devtools.cloudbuild.v1.IRunBuildTriggerRequest): Promise<google.longrunning.Operation>;Calls RunBuildTrigger.
| Parameter | |
|---|---|
| Name | Description |
request |
IRunBuildTriggerRequest
RunBuildTriggerRequest message or plain object |
| Returns | |
|---|---|
| Type | Description |
Promise<google.longrunning.Operation> | Promise |
updateBuildTrigger(request, callback)
public updateBuildTrigger(request: google.devtools.cloudbuild.v1.IUpdateBuildTriggerRequest, callback: google.devtools.cloudbuild.v1.CloudBuild.UpdateBuildTriggerCallback): void;Calls UpdateBuildTrigger.
| Parameters | |
|---|---|
| Name | Description |
request |
IUpdateBuildTriggerRequest
UpdateBuildTriggerRequest message or plain object |
callback |
UpdateBuildTriggerCallback
Node-style callback called with the error, if any, and BuildTrigger |
| Returns | |
|---|---|
| Type | Description |
void | |
updateBuildTrigger(request)
public updateBuildTrigger(request: google.devtools.cloudbuild.v1.IUpdateBuildTriggerRequest): Promise<google.devtools.cloudbuild.v1.BuildTrigger>;Calls UpdateBuildTrigger.
| Parameter | |
|---|---|
| Name | Description |
request |
IUpdateBuildTriggerRequest
UpdateBuildTriggerRequest message or plain object |
| Returns | |
|---|---|
| Type | Description |
Promise<google.devtools.cloudbuild.v1.BuildTrigger> | Promise |
updateWorkerPool(request, callback)
public updateWorkerPool(request: google.devtools.cloudbuild.v1.IUpdateWorkerPoolRequest, callback: google.devtools.cloudbuild.v1.CloudBuild.UpdateWorkerPoolCallback): void;Calls UpdateWorkerPool.
| Parameters | |
|---|---|
| Name | Description |
request |
IUpdateWorkerPoolRequest
UpdateWorkerPoolRequest message or plain object |
callback |
UpdateWorkerPoolCallback
Node-style callback called with the error, if any, and Operation |
| Returns | |
|---|---|
| Type | Description |
void | |
updateWorkerPool(request)
public updateWorkerPool(request: google.devtools.cloudbuild.v1.IUpdateWorkerPoolRequest): Promise<google.longrunning.Operation>;Calls UpdateWorkerPool.
| Parameter | |
|---|---|
| Name | Description |
request |
IUpdateWorkerPoolRequest
UpdateWorkerPoolRequest message or plain object |
| Returns | |
|---|---|
| Type | Description |
Promise<google.longrunning.Operation> | Promise |