CloudBuild - Documentation

CloudBuild

google .devtools .cloudbuild .v1. CloudBuild

Represents a CloudBuild

Constructor

new CloudBuild(rpcImpl, requestDelimitedopt, responseDelimitedopt)

Constructs a new CloudBuild service.

Parameters:

Name	Type	Attributes	Default	Description
`rpcImpl`	$protobuf.RPCImpl			RPC implementation
`requestDelimited`	boolean	<optional>	false	Whether requests are length-delimited
`responseDelimited`	boolean	<optional>	false	Whether responses are length-delimited

Extends

$protobuf.rpc.Service

Methods

approveBuild(request, callback) → {undefined}

Calls ApproveBuild.

Parameters:

Name	Type	Description
`request`	google.devtools.cloudbuild.v1.IApproveBuildRequest	ApproveBuildRequest message or plain object
`callback`	google.devtools.cloudbuild.v1.CloudBuild.ApproveBuildCallback	Node-style callback called with the error, if any, and Operation

Returns:

Type	Description
undefined

approveBuild(request) → {Promise.<google.longrunning.Operation>}

Calls ApproveBuild.

Parameters:

Name	Type	Description
`request`	google.devtools.cloudbuild.v1.IApproveBuildRequest	ApproveBuildRequest message or plain object

Returns:

Type	Description
Promise.<google.longrunning.Operation>	Promise

cancelBuild(request, callback) → {undefined}

Calls CancelBuild.

Parameters:

Name	Type	Description
`request`	google.devtools.cloudbuild.v1.ICancelBuildRequest	CancelBuildRequest message or plain object
`callback`	google.devtools.cloudbuild.v1.CloudBuild.CancelBuildCallback	Node-style callback called with the error, if any, and Build

Returns:

Type	Description
undefined

cancelBuild(request) → {Promise.<google.devtools.cloudbuild.v1.Build>}

Calls CancelBuild.

Parameters:

Name	Type	Description
`request`	google.devtools.cloudbuild.v1.ICancelBuildRequest	CancelBuildRequest message or plain object

Returns:

Type	Description
Promise.<google.devtools.cloudbuild.v1.Build>	Promise

createBuild(request, callback) → {undefined}

Calls CreateBuild.

Parameters:

Name	Type	Description
`request`	google.devtools.cloudbuild.v1.ICreateBuildRequest	CreateBuildRequest message or plain object
`callback`	google.devtools.cloudbuild.v1.CloudBuild.CreateBuildCallback	Node-style callback called with the error, if any, and Operation

Returns:

Type	Description
undefined

createBuild(request) → {Promise.<google.longrunning.Operation>}

Calls CreateBuild.

Parameters:

Name	Type	Description
`request`	google.devtools.cloudbuild.v1.ICreateBuildRequest	CreateBuildRequest message or plain object

Returns:

Type	Description
Promise.<google.longrunning.Operation>	Promise

createBuildTrigger(request, callback) → {undefined}

Calls CreateBuildTrigger.

Parameters:

Name	Type	Description
`request`	google.devtools.cloudbuild.v1.ICreateBuildTriggerRequest	CreateBuildTriggerRequest message or plain object
`callback`	google.devtools.cloudbuild.v1.CloudBuild.CreateBuildTriggerCallback	Node-style callback called with the error, if any, and BuildTrigger

Returns:

Type	Description
undefined

createBuildTrigger(request) → {Promise.<google.devtools.cloudbuild.v1.BuildTrigger>}

Calls CreateBuildTrigger.

Parameters:

Name	Type	Description
`request`	google.devtools.cloudbuild.v1.ICreateBuildTriggerRequest	CreateBuildTriggerRequest message or plain object

Returns:

Type	Description
Promise.<google.devtools.cloudbuild.v1.BuildTrigger>	Promise

createWorkerPool(request, callback) → {undefined}

Calls CreateWorkerPool.

Parameters:

Name	Type	Description
`request`	google.devtools.cloudbuild.v1.ICreateWorkerPoolRequest	CreateWorkerPoolRequest message or plain object
`callback`	google.devtools.cloudbuild.v1.CloudBuild.CreateWorkerPoolCallback	Node-style callback called with the error, if any, and Operation

Returns:

Type	Description
undefined

createWorkerPool(request) → {Promise.<google.longrunning.Operation>}

Calls CreateWorkerPool.

Parameters:

Name	Type	Description
`request`	google.devtools.cloudbuild.v1.ICreateWorkerPoolRequest	CreateWorkerPoolRequest message or plain object

Returns:

Type	Description
Promise.<google.longrunning.Operation>	Promise

deleteBuildTrigger(request, callback) → {undefined}

Calls DeleteBuildTrigger.

Parameters:

Name	Type	Description
`request`	google.devtools.cloudbuild.v1.IDeleteBuildTriggerRequest	DeleteBuildTriggerRequest message or plain object
`callback`	google.devtools.cloudbuild.v1.CloudBuild.DeleteBuildTriggerCallback	Node-style callback called with the error, if any, and Empty

Returns:

Type	Description
undefined

deleteBuildTrigger(request) → {Promise.<google.protobuf.Empty>}

Calls DeleteBuildTrigger.

Parameters:

Name	Type	Description
`request`	google.devtools.cloudbuild.v1.IDeleteBuildTriggerRequest	DeleteBuildTriggerRequest message or plain object

Returns:

Type	Description
Promise.<google.protobuf.Empty>	Promise

deleteWorkerPool(request, callback) → {undefined}

Calls DeleteWorkerPool.

Parameters:

Name	Type	Description
`request`	google.devtools.cloudbuild.v1.IDeleteWorkerPoolRequest	DeleteWorkerPoolRequest message or plain object
`callback`	google.devtools.cloudbuild.v1.CloudBuild.DeleteWorkerPoolCallback	Node-style callback called with the error, if any, and Operation

Returns:

Type	Description
undefined

deleteWorkerPool(request) → {Promise.<google.longrunning.Operation>}

Calls DeleteWorkerPool.

Parameters:

Name	Type	Description
`request`	google.devtools.cloudbuild.v1.IDeleteWorkerPoolRequest	DeleteWorkerPoolRequest message or plain object

Returns:

Type	Description
Promise.<google.longrunning.Operation>	Promise

getBuild(request, callback) → {undefined}

Calls GetBuild.

Parameters:

Name	Type	Description
`request`	google.devtools.cloudbuild.v1.IGetBuildRequest	GetBuildRequest message or plain object
`callback`	google.devtools.cloudbuild.v1.CloudBuild.GetBuildCallback	Node-style callback called with the error, if any, and Build

Returns:

Type	Description
undefined

getBuild(request) → {Promise.<google.devtools.cloudbuild.v1.Build>}

Calls GetBuild.

Parameters:

Name	Type	Description
`request`	google.devtools.cloudbuild.v1.IGetBuildRequest	GetBuildRequest message or plain object

Returns:

Type	Description
Promise.<google.devtools.cloudbuild.v1.Build>	Promise

getBuildTrigger(request, callback) → {undefined}

Calls GetBuildTrigger.

Parameters:

Name	Type	Description
`request`	google.devtools.cloudbuild.v1.IGetBuildTriggerRequest	GetBuildTriggerRequest message or plain object
`callback`	google.devtools.cloudbuild.v1.CloudBuild.GetBuildTriggerCallback	Node-style callback called with the error, if any, and BuildTrigger

Returns:

Type	Description
undefined

getBuildTrigger(request) → {Promise.<google.devtools.cloudbuild.v1.BuildTrigger>}

Calls GetBuildTrigger.

Parameters:

Name	Type	Description
`request`	google.devtools.cloudbuild.v1.IGetBuildTriggerRequest	GetBuildTriggerRequest message or plain object

Returns:

Type	Description
Promise.<google.devtools.cloudbuild.v1.BuildTrigger>	Promise

getWorkerPool(request, callback) → {undefined}

Calls GetWorkerPool.

Parameters:

Name	Type	Description
`request`	google.devtools.cloudbuild.v1.IGetWorkerPoolRequest	GetWorkerPoolRequest message or plain object
`callback`	google.devtools.cloudbuild.v1.CloudBuild.GetWorkerPoolCallback	Node-style callback called with the error, if any, and WorkerPool

Returns:

Type	Description
undefined

getWorkerPool(request) → {Promise.<google.devtools.cloudbuild.v1.WorkerPool>}

Calls GetWorkerPool.

Parameters:

Name	Type	Description
`request`	google.devtools.cloudbuild.v1.IGetWorkerPoolRequest	GetWorkerPoolRequest message or plain object

Returns:

Type	Description
Promise.<google.devtools.cloudbuild.v1.WorkerPool>	Promise

listBuildTriggers(request, callback) → {undefined}

Calls ListBuildTriggers.

Parameters:

Name	Type	Description
`request`	google.devtools.cloudbuild.v1.IListBuildTriggersRequest	ListBuildTriggersRequest message or plain object
`callback`	google.devtools.cloudbuild.v1.CloudBuild.ListBuildTriggersCallback	Node-style callback called with the error, if any, and ListBuildTriggersResponse

Returns:

Type	Description
undefined

listBuildTriggers(request) → {Promise.<google.devtools.cloudbuild.v1.ListBuildTriggersResponse>}

Calls ListBuildTriggers.

Parameters:

Name	Type	Description
`request`	google.devtools.cloudbuild.v1.IListBuildTriggersRequest	ListBuildTriggersRequest message or plain object

Returns:

Type	Description
Promise.<google.devtools.cloudbuild.v1.ListBuildTriggersResponse>	Promise

listBuilds(request, callback) → {undefined}

Calls ListBuilds.

Parameters:

Name	Type	Description
`request`	google.devtools.cloudbuild.v1.IListBuildsRequest	ListBuildsRequest message or plain object
`callback`	google.devtools.cloudbuild.v1.CloudBuild.ListBuildsCallback	Node-style callback called with the error, if any, and ListBuildsResponse

Returns:

Type	Description
undefined

listBuilds(request) → {Promise.<google.devtools.cloudbuild.v1.ListBuildsResponse>}

Calls ListBuilds.

Parameters:

Name	Type	Description
`request`	google.devtools.cloudbuild.v1.IListBuildsRequest	ListBuildsRequest message or plain object

Returns:

Type	Description
Promise.<google.devtools.cloudbuild.v1.ListBuildsResponse>	Promise

listWorkerPools(request, callback) → {undefined}

Calls ListWorkerPools.

Parameters:

Name	Type	Description
`request`	google.devtools.cloudbuild.v1.IListWorkerPoolsRequest	ListWorkerPoolsRequest message or plain object
`callback`	google.devtools.cloudbuild.v1.CloudBuild.ListWorkerPoolsCallback	Node-style callback called with the error, if any, and ListWorkerPoolsResponse

Returns:

Type	Description
undefined

listWorkerPools(request) → {Promise.<google.devtools.cloudbuild.v1.ListWorkerPoolsResponse>}

Calls ListWorkerPools.

Parameters:

Name	Type	Description
`request`	google.devtools.cloudbuild.v1.IListWorkerPoolsRequest	ListWorkerPoolsRequest message or plain object

Returns:

Type	Description
Promise.<google.devtools.cloudbuild.v1.ListWorkerPoolsResponse>	Promise

receiveTriggerWebhook(request, callback) → {undefined}

Calls ReceiveTriggerWebhook.

Parameters:

Name	Type	Description
`request`	google.devtools.cloudbuild.v1.IReceiveTriggerWebhookRequest	ReceiveTriggerWebhookRequest message or plain object
`callback`	google.devtools.cloudbuild.v1.CloudBuild.ReceiveTriggerWebhookCallback	Node-style callback called with the error, if any, and ReceiveTriggerWebhookResponse

Returns:

Type	Description
undefined

receiveTriggerWebhook(request) → {Promise.<google.devtools.cloudbuild.v1.ReceiveTriggerWebhookResponse>}

Calls ReceiveTriggerWebhook.

Parameters:

Name	Type	Description
`request`	google.devtools.cloudbuild.v1.IReceiveTriggerWebhookRequest	ReceiveTriggerWebhookRequest message or plain object

Returns:

Type	Description
Promise.<google.devtools.cloudbuild.v1.ReceiveTriggerWebhookResponse>	Promise

retryBuild(request, callback) → {undefined}

Calls RetryBuild.

Parameters:

Name	Type	Description
`request`	google.devtools.cloudbuild.v1.IRetryBuildRequest	RetryBuildRequest message or plain object
`callback`	google.devtools.cloudbuild.v1.CloudBuild.RetryBuildCallback	Node-style callback called with the error, if any, and Operation

Returns:

Type	Description
undefined

retryBuild(request) → {Promise.<google.longrunning.Operation>}

Calls RetryBuild.

Parameters:

Name	Type	Description
`request`	google.devtools.cloudbuild.v1.IRetryBuildRequest	RetryBuildRequest message or plain object

Returns:

Type	Description
Promise.<google.longrunning.Operation>	Promise

runBuildTrigger(request, callback) → {undefined}

Calls RunBuildTrigger.

Parameters:

Name	Type	Description
`request`	google.devtools.cloudbuild.v1.IRunBuildTriggerRequest	RunBuildTriggerRequest message or plain object
`callback`	google.devtools.cloudbuild.v1.CloudBuild.RunBuildTriggerCallback	Node-style callback called with the error, if any, and Operation

Returns:

Type	Description
undefined

runBuildTrigger(request) → {Promise.<google.longrunning.Operation>}

Calls RunBuildTrigger.

Parameters:

Name	Type	Description
`request`	google.devtools.cloudbuild.v1.IRunBuildTriggerRequest	RunBuildTriggerRequest message or plain object

Returns:

Type	Description
Promise.<google.longrunning.Operation>	Promise

updateBuildTrigger(request, callback) → {undefined}

Calls UpdateBuildTrigger.

Parameters:

Name	Type	Description
`request`	google.devtools.cloudbuild.v1.IUpdateBuildTriggerRequest	UpdateBuildTriggerRequest message or plain object
`callback`	google.devtools.cloudbuild.v1.CloudBuild.UpdateBuildTriggerCallback	Node-style callback called with the error, if any, and BuildTrigger

Returns:

Type	Description
undefined

updateBuildTrigger(request) → {Promise.<google.devtools.cloudbuild.v1.BuildTrigger>}

Calls UpdateBuildTrigger.

Parameters:

Name	Type	Description
`request`	google.devtools.cloudbuild.v1.IUpdateBuildTriggerRequest	UpdateBuildTriggerRequest message or plain object

Returns:

Type	Description
Promise.<google.devtools.cloudbuild.v1.BuildTrigger>	Promise

updateWorkerPool(request, callback) → {undefined}

Calls UpdateWorkerPool.

Parameters:

Name	Type	Description
`request`	google.devtools.cloudbuild.v1.IUpdateWorkerPoolRequest	UpdateWorkerPoolRequest message or plain object
`callback`	google.devtools.cloudbuild.v1.CloudBuild.UpdateWorkerPoolCallback	Node-style callback called with the error, if any, and Operation

Returns:

Type	Description
undefined

updateWorkerPool(request) → {Promise.<google.longrunning.Operation>}

Calls UpdateWorkerPool.

Parameters:

Name	Type	Description
`request`	google.devtools.cloudbuild.v1.IUpdateWorkerPoolRequest	UpdateWorkerPoolRequest message or plain object

Returns:

Type	Description
Promise.<google.longrunning.Operation>	Promise

(static) create(rpcImpl, requestDelimitedopt, responseDelimitedopt) → {CloudBuild}

Creates new CloudBuild service using the specified rpc implementation.

Parameters:

Name	Type	Attributes	Default	Description
`rpcImpl`	$protobuf.RPCImpl			RPC implementation
`requestDelimited`	boolean	<optional>	false	Whether requests are length-delimited
`responseDelimited`	boolean	<optional>	false	Whether responses are length-delimited

Returns:

Type	Description
CloudBuild	RPC service. Useful where requests and/or responses are streamed.

Type Definitions

ApproveBuildCallback(error, responseopt)

Callback as used by approveBuild.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.longrunning.Operation	<optional>	Operation

CancelBuildCallback(error, responseopt)

Callback as used by cancelBuild.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.devtools.cloudbuild.v1.Build	<optional>	Build

CreateBuildCallback(error, responseopt)

Callback as used by createBuild.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.longrunning.Operation	<optional>	Operation

CreateBuildTriggerCallback(error, responseopt)

Callback as used by createBuildTrigger.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.devtools.cloudbuild.v1.BuildTrigger	<optional>	BuildTrigger

CreateWorkerPoolCallback(error, responseopt)

Callback as used by createWorkerPool.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.longrunning.Operation	<optional>	Operation

DeleteBuildTriggerCallback(error, responseopt)

Callback as used by deleteBuildTrigger.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.protobuf.Empty	<optional>	Empty

DeleteWorkerPoolCallback(error, responseopt)

Callback as used by deleteWorkerPool.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.longrunning.Operation	<optional>	Operation

GetBuildCallback(error, responseopt)

Callback as used by getBuild.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.devtools.cloudbuild.v1.Build	<optional>	Build

GetBuildTriggerCallback(error, responseopt)

Callback as used by getBuildTrigger.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.devtools.cloudbuild.v1.BuildTrigger	<optional>	BuildTrigger

GetWorkerPoolCallback(error, responseopt)

Callback as used by getWorkerPool.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.devtools.cloudbuild.v1.WorkerPool	<optional>	WorkerPool

ListBuildTriggersCallback(error, responseopt)

Callback as used by listBuildTriggers.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.devtools.cloudbuild.v1.ListBuildTriggersResponse	<optional>	ListBuildTriggersResponse

ListBuildsCallback(error, responseopt)

Callback as used by listBuilds.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.devtools.cloudbuild.v1.ListBuildsResponse	<optional>	ListBuildsResponse

ListWorkerPoolsCallback(error, responseopt)

Callback as used by listWorkerPools.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.devtools.cloudbuild.v1.ListWorkerPoolsResponse	<optional>	ListWorkerPoolsResponse

ReceiveTriggerWebhookCallback(error, responseopt)

Callback as used by receiveTriggerWebhook.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.devtools.cloudbuild.v1.ReceiveTriggerWebhookResponse	<optional>	ReceiveTriggerWebhookResponse

RetryBuildCallback(error, responseopt)

Callback as used by retryBuild.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.longrunning.Operation	<optional>	Operation

RunBuildTriggerCallback(error, responseopt)

Callback as used by runBuildTrigger.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.longrunning.Operation	<optional>	Operation

UpdateBuildTriggerCallback(error, responseopt)

Callback as used by updateBuildTrigger.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.devtools.cloudbuild.v1.BuildTrigger	<optional>	BuildTrigger

UpdateWorkerPoolCallback(error, responseopt)

Callback as used by updateWorkerPool.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.longrunning.Operation	<optional>	Operation