Class v1.CloudBuildClient (2.5.0)

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. v1

Package

@google-cloud/cloudbuild!

Constructors

(constructor)(opts)

constructor(opts?: ClientOptions);

Construct an instance of CloudBuildClient.

Parameter

Name	Description
opts	`ClientOptions`

Properties

apiEndpoint

static get apiEndpoint(): string;

The DNS address for this API service - same as servicePath(), exists for compatibility reasons.

Property Value

Type	Description
string

auth

auth: gax.GoogleAuth;

Property Value

Type	Description
gax.GoogleAuth

cloudBuildStub

cloudBuildStub?: Promise<{
        [name: string]: Function;
    }>;

Property Value

Type	Description
Promise<{ [name: string]: Function; }>

descriptors

descriptors: Descriptors;

Property Value

Type	Description
Descriptors

innerApiCalls

innerApiCalls: {
        [name: string]: Function;
    };

Property Value

Type	Description
{ [name: string]: Function; }

operationsClient

operationsClient: gax.OperationsClient;

Property Value

Type	Description
gax.OperationsClient

pathTemplates

pathTemplates: {
        [name: string]: gax.PathTemplate;
    };

Property Value

Type	Description
{ [name: string]: gax.PathTemplate; }

port

static get port(): number;

The port for this API service.

Property Value

Type	Description
number

scopes

static get scopes(): string[];

The scopes needed to make gRPC calls for every method defined in this service.

Property Value

Type	Description
string[]

servicePath

static get servicePath(): string;

The DNS address for this API service.

Property Value

Type	Description
string

warn

warn: (code: string, message: string, warnType?: string) => void;

Property Value

Type	Description
(code: string, message: string, warnType?: string) => void

Methods

approveBuild(request, options)

approveBuild(request?: protos.google.devtools.cloudbuild.v1.IApproveBuildRequest, options?: CallOptions): Promise<[LROperation<protos.google.devtools.cloudbuild.v1.IBuild, protos.google.devtools.cloudbuild.v1.IBuildOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined]>;

Parameters

Name	Description
request	`protos.google.devtools.cloudbuild.v1.IApproveBuildRequest`
options	`CallOptions`

Returns

Type	Description
Promise<[LROperation<protos.google.devtools.cloudbuild.v1.IBuild, protos.google.devtools.cloudbuild.v1.IBuildOperationMetadata>, protos.google.longrunning.IOperation \| undefined, {} \| undefined]>

approveBuild(request, options, callback)

approveBuild(request: protos.google.devtools.cloudbuild.v1.IApproveBuildRequest, options: CallOptions, callback: Callback<LROperation<protos.google.devtools.cloudbuild.v1.IBuild, protos.google.devtools.cloudbuild.v1.IBuildOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.devtools.cloudbuild.v1.IApproveBuildRequest`
options	`CallOptions`
callback	`Callback<LROperation<protos.google.devtools.cloudbuild.v1.IBuild, protos.google.devtools.cloudbuild.v1.IBuildOperationMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

approveBuild(request, callback)

approveBuild(request: protos.google.devtools.cloudbuild.v1.IApproveBuildRequest, callback: Callback<LROperation<protos.google.devtools.cloudbuild.v1.IBuild, protos.google.devtools.cloudbuild.v1.IBuildOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.devtools.cloudbuild.v1.IApproveBuildRequest`
callback	`Callback<LROperation<protos.google.devtools.cloudbuild.v1.IBuild, protos.google.devtools.cloudbuild.v1.IBuildOperationMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

cancelBuild(request, options)

cancelBuild(request?: protos.google.devtools.cloudbuild.v1.ICancelBuildRequest, options?: CallOptions): Promise<[protos.google.devtools.cloudbuild.v1.IBuild, protos.google.devtools.cloudbuild.v1.ICancelBuildRequest | undefined, {} | undefined]>;

Parameters

Name	Description
request	`protos.google.devtools.cloudbuild.v1.ICancelBuildRequest`
options	`CallOptions`

Returns

Type	Description
Promise<[protos.google.devtools.cloudbuild.v1.IBuild, protos.google.devtools.cloudbuild.v1.ICancelBuildRequest \| undefined, {} \| undefined]>

cancelBuild(request, options, callback)

cancelBuild(request: protos.google.devtools.cloudbuild.v1.ICancelBuildRequest, options: CallOptions, callback: Callback<protos.google.devtools.cloudbuild.v1.IBuild, protos.google.devtools.cloudbuild.v1.ICancelBuildRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.devtools.cloudbuild.v1.ICancelBuildRequest`
options	`CallOptions`
callback	`Callback<protos.google.devtools.cloudbuild.v1.IBuild, protos.google.devtools.cloudbuild.v1.ICancelBuildRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

cancelBuild(request, callback)

cancelBuild(request: protos.google.devtools.cloudbuild.v1.ICancelBuildRequest, callback: Callback<protos.google.devtools.cloudbuild.v1.IBuild, protos.google.devtools.cloudbuild.v1.ICancelBuildRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.devtools.cloudbuild.v1.ICancelBuildRequest`
callback	`Callback<protos.google.devtools.cloudbuild.v1.IBuild, protos.google.devtools.cloudbuild.v1.ICancelBuildRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

checkApproveBuildProgress(name)

checkApproveBuildProgress(name: string): Promise<LROperation<protos.google.devtools.cloudbuild.v1.Build, protos.google.devtools.cloudbuild.v1.BuildOperationMetadata>>;

Check the status of the long running operation returned by approveBuild().

Parameter

Name	Description
name	`string` The operation name that will be passed.

Returns

Type	Description
Promise<LROperation<protos.google.devtools.cloudbuild.v1.Build, protos.google.devtools.cloudbuild.v1.BuildOperationMetadata>>	{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

checkCreateBuildProgress(name)

checkCreateBuildProgress(name: string): Promise<LROperation<protos.google.devtools.cloudbuild.v1.Build, protos.google.devtools.cloudbuild.v1.BuildOperationMetadata>>;

Check the status of the long running operation returned by createBuild().

Parameter

Name	Description
name	`string` The operation name that will be passed.

Returns

Type	Description
Promise<LROperation<protos.google.devtools.cloudbuild.v1.Build, protos.google.devtools.cloudbuild.v1.BuildOperationMetadata>>	{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

checkCreateWorkerPoolProgress(name)

checkCreateWorkerPoolProgress(name: string): Promise<LROperation<protos.google.devtools.cloudbuild.v1.WorkerPool, protos.google.devtools.cloudbuild.v1.CreateWorkerPoolOperationMetadata>>;

Check the status of the long running operation returned by createWorkerPool().

Parameter

Name	Description
name	`string` The operation name that will be passed.

Returns

Type	Description
Promise<LROperation<protos.google.devtools.cloudbuild.v1.WorkerPool, protos.google.devtools.cloudbuild.v1.CreateWorkerPoolOperationMetadata>>	{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

checkDeleteWorkerPoolProgress(name)

checkDeleteWorkerPoolProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.devtools.cloudbuild.v1.DeleteWorkerPoolOperationMetadata>>;

Check the status of the long running operation returned by deleteWorkerPool().

Parameter

Name	Description
name	`string` The operation name that will be passed.

Returns

Type	Description
Promise<LROperation<protos.google.protobuf.Empty, protos.google.devtools.cloudbuild.v1.DeleteWorkerPoolOperationMetadata>>	{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

checkRetryBuildProgress(name)

checkRetryBuildProgress(name: string): Promise<LROperation<protos.google.devtools.cloudbuild.v1.Build, protos.google.devtools.cloudbuild.v1.BuildOperationMetadata>>;

Check the status of the long running operation returned by retryBuild().

Parameter

Name	Description
name	`string` The operation name that will be passed.

Returns

Type	Description
Promise<LROperation<protos.google.devtools.cloudbuild.v1.Build, protos.google.devtools.cloudbuild.v1.BuildOperationMetadata>>	{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

checkRunBuildTriggerProgress(name)

checkRunBuildTriggerProgress(name: string): Promise<LROperation<protos.google.devtools.cloudbuild.v1.Build, protos.google.devtools.cloudbuild.v1.BuildOperationMetadata>>;

Check the status of the long running operation returned by runBuildTrigger().

Parameter

Name	Description
name	`string` The operation name that will be passed.

Returns

Type	Description
Promise<LROperation<protos.google.devtools.cloudbuild.v1.Build, protos.google.devtools.cloudbuild.v1.BuildOperationMetadata>>	{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

checkUpdateWorkerPoolProgress(name)

checkUpdateWorkerPoolProgress(name: string): Promise<LROperation<protos.google.devtools.cloudbuild.v1.WorkerPool, protos.google.devtools.cloudbuild.v1.UpdateWorkerPoolOperationMetadata>>;

Check the status of the long running operation returned by updateWorkerPool().

Parameter

Name	Description
name	`string` The operation name that will be passed.

Returns

Type	Description
Promise<LROperation<protos.google.devtools.cloudbuild.v1.WorkerPool, protos.google.devtools.cloudbuild.v1.UpdateWorkerPoolOperationMetadata>>	{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

close()

close(): Promise<void>;

Terminate the gRPC channel and close the client.

The client will no longer be usable and all future behavior is undefined.

Returns

Type	Description
Promise<void>	{Promise} A promise that resolves when the client is closed.

createBuild(request, options)

createBuild(request?: protos.google.devtools.cloudbuild.v1.ICreateBuildRequest, options?: CallOptions): Promise<[LROperation<protos.google.devtools.cloudbuild.v1.IBuild, protos.google.devtools.cloudbuild.v1.IBuildOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined]>;

Parameters

Name	Description
request	`protos.google.devtools.cloudbuild.v1.ICreateBuildRequest`
options	`CallOptions`

Returns

Type	Description
Promise<[LROperation<protos.google.devtools.cloudbuild.v1.IBuild, protos.google.devtools.cloudbuild.v1.IBuildOperationMetadata>, protos.google.longrunning.IOperation \| undefined, {} \| undefined]>

createBuild(request, options, callback)

createBuild(request: protos.google.devtools.cloudbuild.v1.ICreateBuildRequest, options: CallOptions, callback: Callback<LROperation<protos.google.devtools.cloudbuild.v1.IBuild, protos.google.devtools.cloudbuild.v1.IBuildOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.devtools.cloudbuild.v1.ICreateBuildRequest`
options	`CallOptions`
callback	`Callback<LROperation<protos.google.devtools.cloudbuild.v1.IBuild, protos.google.devtools.cloudbuild.v1.IBuildOperationMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

createBuild(request, callback)

createBuild(request: protos.google.devtools.cloudbuild.v1.ICreateBuildRequest, callback: Callback<LROperation<protos.google.devtools.cloudbuild.v1.IBuild, protos.google.devtools.cloudbuild.v1.IBuildOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.devtools.cloudbuild.v1.ICreateBuildRequest`
callback	`Callback<LROperation<protos.google.devtools.cloudbuild.v1.IBuild, protos.google.devtools.cloudbuild.v1.IBuildOperationMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

createBuildTrigger(request, options)

createBuildTrigger(request?: protos.google.devtools.cloudbuild.v1.ICreateBuildTriggerRequest, options?: CallOptions): Promise<[protos.google.devtools.cloudbuild.v1.IBuildTrigger, (protos.google.devtools.cloudbuild.v1.ICreateBuildTriggerRequest | undefined), {} | undefined]>;

Parameters

Name	Description
request	`protos.google.devtools.cloudbuild.v1.ICreateBuildTriggerRequest`
options	`CallOptions`

Returns

Type	Description
Promise<[protos.google.devtools.cloudbuild.v1.IBuildTrigger, (protos.google.devtools.cloudbuild.v1.ICreateBuildTriggerRequest \| undefined), {} \| undefined]>

createBuildTrigger(request, options, callback)

createBuildTrigger(request: protos.google.devtools.cloudbuild.v1.ICreateBuildTriggerRequest, options: CallOptions, callback: Callback<protos.google.devtools.cloudbuild.v1.IBuildTrigger, protos.google.devtools.cloudbuild.v1.ICreateBuildTriggerRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.devtools.cloudbuild.v1.ICreateBuildTriggerRequest`
options	`CallOptions`
callback	`Callback<protos.google.devtools.cloudbuild.v1.IBuildTrigger, protos.google.devtools.cloudbuild.v1.ICreateBuildTriggerRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

createBuildTrigger(request, callback)

createBuildTrigger(request: protos.google.devtools.cloudbuild.v1.ICreateBuildTriggerRequest, callback: Callback<protos.google.devtools.cloudbuild.v1.IBuildTrigger, protos.google.devtools.cloudbuild.v1.ICreateBuildTriggerRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.devtools.cloudbuild.v1.ICreateBuildTriggerRequest`
callback	`Callback<protos.google.devtools.cloudbuild.v1.IBuildTrigger, protos.google.devtools.cloudbuild.v1.ICreateBuildTriggerRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

createWorkerPool(request, options)

createWorkerPool(request?: protos.google.devtools.cloudbuild.v1.ICreateWorkerPoolRequest, options?: CallOptions): Promise<[LROperation<protos.google.devtools.cloudbuild.v1.IWorkerPool, protos.google.devtools.cloudbuild.v1.ICreateWorkerPoolOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined]>;

Parameters

Name	Description
request	`protos.google.devtools.cloudbuild.v1.ICreateWorkerPoolRequest`
options	`CallOptions`

Returns

Type	Description
Promise<[LROperation<protos.google.devtools.cloudbuild.v1.IWorkerPool, protos.google.devtools.cloudbuild.v1.ICreateWorkerPoolOperationMetadata>, protos.google.longrunning.IOperation \| undefined, {} \| undefined]>

createWorkerPool(request, options, callback)

createWorkerPool(request: protos.google.devtools.cloudbuild.v1.ICreateWorkerPoolRequest, options: CallOptions, callback: Callback<LROperation<protos.google.devtools.cloudbuild.v1.IWorkerPool, protos.google.devtools.cloudbuild.v1.ICreateWorkerPoolOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.devtools.cloudbuild.v1.ICreateWorkerPoolRequest`
options	`CallOptions`
callback	`Callback<LROperation<protos.google.devtools.cloudbuild.v1.IWorkerPool, protos.google.devtools.cloudbuild.v1.ICreateWorkerPoolOperationMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

createWorkerPool(request, callback)

createWorkerPool(request: protos.google.devtools.cloudbuild.v1.ICreateWorkerPoolRequest, callback: Callback<LROperation<protos.google.devtools.cloudbuild.v1.IWorkerPool, protos.google.devtools.cloudbuild.v1.ICreateWorkerPoolOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.devtools.cloudbuild.v1.ICreateWorkerPoolRequest`
callback	`Callback<LROperation<protos.google.devtools.cloudbuild.v1.IWorkerPool, protos.google.devtools.cloudbuild.v1.ICreateWorkerPoolOperationMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

cryptoKeyPath(project, location, keyring, key)

cryptoKeyPath(project: string, location: string, keyring: string, key: string): string;

Return a fully-qualified cryptoKey resource name string.

Parameters

Name	Description
project	`string`
location	`string`
keyring	`string`
key	`string`

Returns

Type	Description
string	{string} Resource name string.

deleteBuildTrigger(request, options)

deleteBuildTrigger(request?: protos.google.devtools.cloudbuild.v1.IDeleteBuildTriggerRequest, options?: CallOptions): Promise<[protos.google.protobuf.IEmpty, (protos.google.devtools.cloudbuild.v1.IDeleteBuildTriggerRequest | undefined), {} | undefined]>;

Parameters

Name	Description
request	`protos.google.devtools.cloudbuild.v1.IDeleteBuildTriggerRequest`
options	`CallOptions`

Returns

Type	Description
Promise<[protos.google.protobuf.IEmpty, (protos.google.devtools.cloudbuild.v1.IDeleteBuildTriggerRequest \| undefined), {} \| undefined]>

deleteBuildTrigger(request, options, callback)

deleteBuildTrigger(request: protos.google.devtools.cloudbuild.v1.IDeleteBuildTriggerRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.devtools.cloudbuild.v1.IDeleteBuildTriggerRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.devtools.cloudbuild.v1.IDeleteBuildTriggerRequest`
options	`CallOptions`
callback	`Callback<protos.google.protobuf.IEmpty, protos.google.devtools.cloudbuild.v1.IDeleteBuildTriggerRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

deleteBuildTrigger(request, callback)

deleteBuildTrigger(request: protos.google.devtools.cloudbuild.v1.IDeleteBuildTriggerRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.devtools.cloudbuild.v1.IDeleteBuildTriggerRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.devtools.cloudbuild.v1.IDeleteBuildTriggerRequest`
callback	`Callback<protos.google.protobuf.IEmpty, protos.google.devtools.cloudbuild.v1.IDeleteBuildTriggerRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

deleteWorkerPool(request, options)

deleteWorkerPool(request?: protos.google.devtools.cloudbuild.v1.IDeleteWorkerPoolRequest, options?: CallOptions): Promise<[LROperation<protos.google.protobuf.IEmpty, protos.google.devtools.cloudbuild.v1.IDeleteWorkerPoolOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined]>;

Parameters

Name	Description
request	`protos.google.devtools.cloudbuild.v1.IDeleteWorkerPoolRequest`
options	`CallOptions`

Returns

Type	Description
Promise<[LROperation<protos.google.protobuf.IEmpty, protos.google.devtools.cloudbuild.v1.IDeleteWorkerPoolOperationMetadata>, protos.google.longrunning.IOperation \| undefined, {} \| undefined]>

deleteWorkerPool(request, options, callback)

deleteWorkerPool(request: protos.google.devtools.cloudbuild.v1.IDeleteWorkerPoolRequest, options: CallOptions, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.devtools.cloudbuild.v1.IDeleteWorkerPoolOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.devtools.cloudbuild.v1.IDeleteWorkerPoolRequest`
options	`CallOptions`
callback	`Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.devtools.cloudbuild.v1.IDeleteWorkerPoolOperationMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

deleteWorkerPool(request, callback)

deleteWorkerPool(request: protos.google.devtools.cloudbuild.v1.IDeleteWorkerPoolRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.devtools.cloudbuild.v1.IDeleteWorkerPoolOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.devtools.cloudbuild.v1.IDeleteWorkerPoolRequest`
callback	`Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.devtools.cloudbuild.v1.IDeleteWorkerPoolOperationMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

getBuild(request, options)

getBuild(request?: protos.google.devtools.cloudbuild.v1.IGetBuildRequest, options?: CallOptions): Promise<[protos.google.devtools.cloudbuild.v1.IBuild, protos.google.devtools.cloudbuild.v1.IGetBuildRequest | undefined, {} | undefined]>;

Parameters

Name	Description
request	`protos.google.devtools.cloudbuild.v1.IGetBuildRequest`
options	`CallOptions`

Returns

Type	Description
Promise<[protos.google.devtools.cloudbuild.v1.IBuild, protos.google.devtools.cloudbuild.v1.IGetBuildRequest \| undefined, {} \| undefined]>

getBuild(request, options, callback)

getBuild(request: protos.google.devtools.cloudbuild.v1.IGetBuildRequest, options: CallOptions, callback: Callback<protos.google.devtools.cloudbuild.v1.IBuild, protos.google.devtools.cloudbuild.v1.IGetBuildRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.devtools.cloudbuild.v1.IGetBuildRequest`
options	`CallOptions`
callback	`Callback<protos.google.devtools.cloudbuild.v1.IBuild, protos.google.devtools.cloudbuild.v1.IGetBuildRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

getBuild(request, callback)

getBuild(request: protos.google.devtools.cloudbuild.v1.IGetBuildRequest, callback: Callback<protos.google.devtools.cloudbuild.v1.IBuild, protos.google.devtools.cloudbuild.v1.IGetBuildRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.devtools.cloudbuild.v1.IGetBuildRequest`
callback	`Callback<protos.google.devtools.cloudbuild.v1.IBuild, protos.google.devtools.cloudbuild.v1.IGetBuildRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

getBuildTrigger(request, options)

getBuildTrigger(request?: protos.google.devtools.cloudbuild.v1.IGetBuildTriggerRequest, options?: CallOptions): Promise<[protos.google.devtools.cloudbuild.v1.IBuildTrigger, protos.google.devtools.cloudbuild.v1.IGetBuildTriggerRequest | undefined, {} | undefined]>;

Parameters

Name	Description
request	`protos.google.devtools.cloudbuild.v1.IGetBuildTriggerRequest`
options	`CallOptions`

Returns

Type	Description
Promise<[protos.google.devtools.cloudbuild.v1.IBuildTrigger, protos.google.devtools.cloudbuild.v1.IGetBuildTriggerRequest \| undefined, {} \| undefined]>

getBuildTrigger(request, options, callback)

getBuildTrigger(request: protos.google.devtools.cloudbuild.v1.IGetBuildTriggerRequest, options: CallOptions, callback: Callback<protos.google.devtools.cloudbuild.v1.IBuildTrigger, protos.google.devtools.cloudbuild.v1.IGetBuildTriggerRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.devtools.cloudbuild.v1.IGetBuildTriggerRequest`
options	`CallOptions`
callback	`Callback<protos.google.devtools.cloudbuild.v1.IBuildTrigger, protos.google.devtools.cloudbuild.v1.IGetBuildTriggerRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

getBuildTrigger(request, callback)

getBuildTrigger(request: protos.google.devtools.cloudbuild.v1.IGetBuildTriggerRequest, callback: Callback<protos.google.devtools.cloudbuild.v1.IBuildTrigger, protos.google.devtools.cloudbuild.v1.IGetBuildTriggerRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.devtools.cloudbuild.v1.IGetBuildTriggerRequest`
callback	`Callback<protos.google.devtools.cloudbuild.v1.IBuildTrigger, protos.google.devtools.cloudbuild.v1.IGetBuildTriggerRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

getProjectId()

getProjectId(): Promise<string>;

Returns

Type	Description
Promise<string>

getProjectId(callback)

getProjectId(callback: Callback<string, undefined, undefined>): void;

Parameter

Name	Description
callback	`Callback<string, undefined, undefined>`

Returns

Type	Description
void

getWorkerPool(request, options)

getWorkerPool(request?: protos.google.devtools.cloudbuild.v1.IGetWorkerPoolRequest, options?: CallOptions): Promise<[protos.google.devtools.cloudbuild.v1.IWorkerPool, protos.google.devtools.cloudbuild.v1.IGetWorkerPoolRequest | undefined, {} | undefined]>;

Parameters

Name	Description
request	`protos.google.devtools.cloudbuild.v1.IGetWorkerPoolRequest`
options	`CallOptions`

Returns

Type	Description
Promise<[protos.google.devtools.cloudbuild.v1.IWorkerPool, protos.google.devtools.cloudbuild.v1.IGetWorkerPoolRequest \| undefined, {} \| undefined]>

getWorkerPool(request, options, callback)

getWorkerPool(request: protos.google.devtools.cloudbuild.v1.IGetWorkerPoolRequest, options: CallOptions, callback: Callback<protos.google.devtools.cloudbuild.v1.IWorkerPool, protos.google.devtools.cloudbuild.v1.IGetWorkerPoolRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.devtools.cloudbuild.v1.IGetWorkerPoolRequest`
options	`CallOptions`
callback	`Callback<protos.google.devtools.cloudbuild.v1.IWorkerPool, protos.google.devtools.cloudbuild.v1.IGetWorkerPoolRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

getWorkerPool(request, callback)

getWorkerPool(request: protos.google.devtools.cloudbuild.v1.IGetWorkerPoolRequest, callback: Callback<protos.google.devtools.cloudbuild.v1.IWorkerPool, protos.google.devtools.cloudbuild.v1.IGetWorkerPoolRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.devtools.cloudbuild.v1.IGetWorkerPoolRequest`
callback	`Callback<protos.google.devtools.cloudbuild.v1.IWorkerPool, protos.google.devtools.cloudbuild.v1.IGetWorkerPoolRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

initialize()

initialize(): Promise<{
        [name: string]: Function;
    }>;

Initialize the client. Performs asynchronous operations (such as authentication) and prepares the client. This function will be called automatically when any class method is called for the first time, but if you need to initialize it before calling an actual method, feel free to call initialize() directly.

You can await on this method if you want to make sure the client is initialized.

Returns

Type	Description
Promise<{ [name: string]: Function; }>	{Promise} A promise that resolves to an authenticated service stub.

listBuilds(request, options)

listBuilds(request?: protos.google.devtools.cloudbuild.v1.IListBuildsRequest, options?: CallOptions): Promise<[protos.google.devtools.cloudbuild.v1.IBuild[], protos.google.devtools.cloudbuild.v1.IListBuildsRequest | null, protos.google.devtools.cloudbuild.v1.IListBuildsResponse]>;

Parameters

Name	Description
request	`protos.google.devtools.cloudbuild.v1.IListBuildsRequest`
options	`CallOptions`

Returns

Type	Description
Promise<[protos.google.devtools.cloudbuild.v1.IBuild[], protos.google.devtools.cloudbuild.v1.IListBuildsRequest \| null, protos.google.devtools.cloudbuild.v1.IListBuildsResponse]>

listBuilds(request, options, callback)

listBuilds(request: protos.google.devtools.cloudbuild.v1.IListBuildsRequest, options: CallOptions, callback: PaginationCallback<protos.google.devtools.cloudbuild.v1.IListBuildsRequest, protos.google.devtools.cloudbuild.v1.IListBuildsResponse | null | undefined, protos.google.devtools.cloudbuild.v1.IBuild>): void;

Parameters

Name	Description
request	`protos.google.devtools.cloudbuild.v1.IListBuildsRequest`
options	`CallOptions`
callback	`PaginationCallback<protos.google.devtools.cloudbuild.v1.IListBuildsRequest, protos.google.devtools.cloudbuild.v1.IListBuildsResponse \| null \| undefined, protos.google.devtools.cloudbuild.v1.IBuild>`

Returns

Type	Description
void

listBuilds(request, callback)

listBuilds(request: protos.google.devtools.cloudbuild.v1.IListBuildsRequest, callback: PaginationCallback<protos.google.devtools.cloudbuild.v1.IListBuildsRequest, protos.google.devtools.cloudbuild.v1.IListBuildsResponse | null | undefined, protos.google.devtools.cloudbuild.v1.IBuild>): void;

Parameters

Name	Description
request	`protos.google.devtools.cloudbuild.v1.IListBuildsRequest`
callback	`PaginationCallback<protos.google.devtools.cloudbuild.v1.IListBuildsRequest, protos.google.devtools.cloudbuild.v1.IListBuildsResponse \| null \| undefined, protos.google.devtools.cloudbuild.v1.IBuild>`

Returns

Type	Description
void

listBuildsAsync(request, options)

listBuildsAsync(request?: protos.google.devtools.cloudbuild.v1.IListBuildsRequest, options?: CallOptions): AsyncIterable<protos.google.devtools.cloudbuild.v1.IBuild>;

Equivalent to listBuilds, but returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters

Name	Description
request	`protos.google.devtools.cloudbuild.v1.IListBuildsRequest` The request object that will be sent.
options	`CallOptions` Call options. See CallOptions for more details.

Returns

Type

Description

AsyncIterable<protos.google.devtools.cloudbuild.v1.IBuild>

{Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing [Build]. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

listBuildsStream(request, options)

listBuildsStream(request?: protos.google.devtools.cloudbuild.v1.IListBuildsRequest, options?: CallOptions): Transform;

Equivalent to method.name.toCamelCase(), but returns a NodeJS Stream object.

Parameters

Name	Description
request	`protos.google.devtools.cloudbuild.v1.IListBuildsRequest` The request object that will be sent.
options	`CallOptions` Call options. See CallOptions for more details.

Returns

Type Description

Transform

{Stream} An object stream which emits an object representing [Build] on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listBuildsAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

listBuildTriggers(request, options)

listBuildTriggers(request?: protos.google.devtools.cloudbuild.v1.IListBuildTriggersRequest, options?: CallOptions): Promise<[protos.google.devtools.cloudbuild.v1.IBuildTrigger[], protos.google.devtools.cloudbuild.v1.IListBuildTriggersRequest | null, protos.google.devtools.cloudbuild.v1.IListBuildTriggersResponse]>;

Parameters

Name	Description
request	`protos.google.devtools.cloudbuild.v1.IListBuildTriggersRequest`
options	`CallOptions`

Returns

Type	Description
Promise<[protos.google.devtools.cloudbuild.v1.IBuildTrigger[], protos.google.devtools.cloudbuild.v1.IListBuildTriggersRequest \| null, protos.google.devtools.cloudbuild.v1.IListBuildTriggersResponse]>

listBuildTriggers(request, options, callback)

listBuildTriggers(request: protos.google.devtools.cloudbuild.v1.IListBuildTriggersRequest, options: CallOptions, callback: PaginationCallback<protos.google.devtools.cloudbuild.v1.IListBuildTriggersRequest, protos.google.devtools.cloudbuild.v1.IListBuildTriggersResponse | null | undefined, protos.google.devtools.cloudbuild.v1.IBuildTrigger>): void;

Parameters

Name	Description
request	`protos.google.devtools.cloudbuild.v1.IListBuildTriggersRequest`
options	`CallOptions`
callback	`PaginationCallback<protos.google.devtools.cloudbuild.v1.IListBuildTriggersRequest, protos.google.devtools.cloudbuild.v1.IListBuildTriggersResponse \| null \| undefined, protos.google.devtools.cloudbuild.v1.IBuildTrigger>`

Returns

Type	Description
void

listBuildTriggers(request, callback)

listBuildTriggers(request: protos.google.devtools.cloudbuild.v1.IListBuildTriggersRequest, callback: PaginationCallback<protos.google.devtools.cloudbuild.v1.IListBuildTriggersRequest, protos.google.devtools.cloudbuild.v1.IListBuildTriggersResponse | null | undefined, protos.google.devtools.cloudbuild.v1.IBuildTrigger>): void;

Parameters

Name	Description
request	`protos.google.devtools.cloudbuild.v1.IListBuildTriggersRequest`
callback	`PaginationCallback<protos.google.devtools.cloudbuild.v1.IListBuildTriggersRequest, protos.google.devtools.cloudbuild.v1.IListBuildTriggersResponse \| null \| undefined, protos.google.devtools.cloudbuild.v1.IBuildTrigger>`

Returns

Type	Description
void

listBuildTriggersAsync(request, options)

listBuildTriggersAsync(request?: protos.google.devtools.cloudbuild.v1.IListBuildTriggersRequest, options?: CallOptions): AsyncIterable<protos.google.devtools.cloudbuild.v1.IBuildTrigger>;

Equivalent to listBuildTriggers, but returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters

Name	Description
request	`protos.google.devtools.cloudbuild.v1.IListBuildTriggersRequest` The request object that will be sent.
options	`CallOptions` Call options. See CallOptions for more details.

Returns

Type

Description

AsyncIterable<protos.google.devtools.cloudbuild.v1.IBuildTrigger>

{Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing [BuildTrigger]. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

listBuildTriggersStream(request, options)

listBuildTriggersStream(request?: protos.google.devtools.cloudbuild.v1.IListBuildTriggersRequest, options?: CallOptions): Transform;

Equivalent to method.name.toCamelCase(), but returns a NodeJS Stream object.

Parameters

Name	Description
request	`protos.google.devtools.cloudbuild.v1.IListBuildTriggersRequest` The request object that will be sent.
options	`CallOptions` Call options. See CallOptions for more details.

Returns

Type Description

Transform

{Stream} An object stream which emits an object representing [BuildTrigger] on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listBuildTriggersAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

listWorkerPools(request, options)

listWorkerPools(request?: protos.google.devtools.cloudbuild.v1.IListWorkerPoolsRequest, options?: CallOptions): Promise<[protos.google.devtools.cloudbuild.v1.IWorkerPool[], protos.google.devtools.cloudbuild.v1.IListWorkerPoolsRequest | null, protos.google.devtools.cloudbuild.v1.IListWorkerPoolsResponse]>;

Parameters

Name	Description
request	`protos.google.devtools.cloudbuild.v1.IListWorkerPoolsRequest`
options	`CallOptions`

Returns

Type	Description
Promise<[protos.google.devtools.cloudbuild.v1.IWorkerPool[], protos.google.devtools.cloudbuild.v1.IListWorkerPoolsRequest \| null, protos.google.devtools.cloudbuild.v1.IListWorkerPoolsResponse]>

listWorkerPools(request, options, callback)

listWorkerPools(request: protos.google.devtools.cloudbuild.v1.IListWorkerPoolsRequest, options: CallOptions, callback: PaginationCallback<protos.google.devtools.cloudbuild.v1.IListWorkerPoolsRequest, protos.google.devtools.cloudbuild.v1.IListWorkerPoolsResponse | null | undefined, protos.google.devtools.cloudbuild.v1.IWorkerPool>): void;

Parameters

Name	Description
request	`protos.google.devtools.cloudbuild.v1.IListWorkerPoolsRequest`
options	`CallOptions`
callback	`PaginationCallback<protos.google.devtools.cloudbuild.v1.IListWorkerPoolsRequest, protos.google.devtools.cloudbuild.v1.IListWorkerPoolsResponse \| null \| undefined, protos.google.devtools.cloudbuild.v1.IWorkerPool>`

Returns

Type	Description
void

listWorkerPools(request, callback)

listWorkerPools(request: protos.google.devtools.cloudbuild.v1.IListWorkerPoolsRequest, callback: PaginationCallback<protos.google.devtools.cloudbuild.v1.IListWorkerPoolsRequest, protos.google.devtools.cloudbuild.v1.IListWorkerPoolsResponse | null | undefined, protos.google.devtools.cloudbuild.v1.IWorkerPool>): void;

Parameters

Name	Description
request	`protos.google.devtools.cloudbuild.v1.IListWorkerPoolsRequest`
callback	`PaginationCallback<protos.google.devtools.cloudbuild.v1.IListWorkerPoolsRequest, protos.google.devtools.cloudbuild.v1.IListWorkerPoolsResponse \| null \| undefined, protos.google.devtools.cloudbuild.v1.IWorkerPool>`

Returns

Type	Description
void

listWorkerPoolsAsync(request, options)

listWorkerPoolsAsync(request?: protos.google.devtools.cloudbuild.v1.IListWorkerPoolsRequest, options?: CallOptions): AsyncIterable<protos.google.devtools.cloudbuild.v1.IWorkerPool>;

Equivalent to listWorkerPools, but returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters

Name	Description
request	`protos.google.devtools.cloudbuild.v1.IListWorkerPoolsRequest` The request object that will be sent.
options	`CallOptions` Call options. See CallOptions for more details.

Returns

Type

Description

AsyncIterable<protos.google.devtools.cloudbuild.v1.IWorkerPool>

{Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing [WorkerPool]. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

listWorkerPoolsStream(request, options)

listWorkerPoolsStream(request?: protos.google.devtools.cloudbuild.v1.IListWorkerPoolsRequest, options?: CallOptions): Transform;

Equivalent to method.name.toCamelCase(), but returns a NodeJS Stream object.

Parameters

Name	Description
request	`protos.google.devtools.cloudbuild.v1.IListWorkerPoolsRequest` The request object that will be sent.
options	`CallOptions` Call options. See CallOptions for more details.

Returns

Type Description

Transform

{Stream} An object stream which emits an object representing [WorkerPool] on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listWorkerPoolsAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

locationPath(project, location)

locationPath(project: string, location: string): string;

Return a fully-qualified location resource name string.

Parameters

Name	Description
project	`string`
location	`string`

Returns

Type	Description
string	{string} Resource name string.

matchBuildFromProjectBuildName(projectBuildName)

matchBuildFromProjectBuildName(projectBuildName: string): string | number;

Parse the build from ProjectBuild resource.

Parameter

Name	Description
projectBuildName	`string` A fully-qualified path representing project_build resource.

Returns

Type	Description
string \| number	{string} A string representing the build.

matchBuildFromProjectLocationBuildName(projectLocationBuildName)

matchBuildFromProjectLocationBuildName(projectLocationBuildName: string): string | number;

Parse the build from ProjectLocationBuild resource.

Parameter

Name	Description
projectLocationBuildName	`string` A fully-qualified path representing project_location_build resource.

Returns

Type	Description
string \| number	{string} A string representing the build.

matchKeyFromCryptoKeyName(cryptoKeyName)

matchKeyFromCryptoKeyName(cryptoKeyName: string): string | number;

Parse the key from CryptoKey resource.

Parameter

Name	Description
cryptoKeyName	`string` A fully-qualified path representing CryptoKey resource.

Returns

Type	Description
string \| number	{string} A string representing the key.

matchKeyringFromCryptoKeyName(cryptoKeyName)

matchKeyringFromCryptoKeyName(cryptoKeyName: string): string | number;

Parse the keyring from CryptoKey resource.

Parameter

Name	Description
cryptoKeyName	`string` A fully-qualified path representing CryptoKey resource.

Returns

Type	Description
string \| number	{string} A string representing the keyring.

matchLocationFromCryptoKeyName(cryptoKeyName)

matchLocationFromCryptoKeyName(cryptoKeyName: string): string | number;

Parse the location from CryptoKey resource.

Parameter

Name	Description
cryptoKeyName	`string` A fully-qualified path representing CryptoKey resource.

Returns

Type	Description
string \| number	{string} A string representing the location.

matchLocationFromLocationName(locationName)

matchLocationFromLocationName(locationName: string): string | number;

Parse the location from Location resource.

Parameter

Name	Description
locationName	`string` A fully-qualified path representing Location resource.

Returns

Type	Description
string \| number	{string} A string representing the location.

matchLocationFromProjectLocationBuildName(projectLocationBuildName)

matchLocationFromProjectLocationBuildName(projectLocationBuildName: string): string | number;

Parse the location from ProjectLocationBuild resource.

Parameter

Name	Description
projectLocationBuildName	`string` A fully-qualified path representing project_location_build resource.

Returns

Type	Description
string \| number	{string} A string representing the location.

matchLocationFromProjectLocationTriggerName(projectLocationTriggerName)

matchLocationFromProjectLocationTriggerName(projectLocationTriggerName: string): string | number;

Parse the location from ProjectLocationTrigger resource.

Parameter

Name	Description
projectLocationTriggerName	`string` A fully-qualified path representing project_location_trigger resource.

Returns

Type	Description
string \| number	{string} A string representing the location.

matchLocationFromWorkerPoolName(workerPoolName)

matchLocationFromWorkerPoolName(workerPoolName: string): string | number;

Parse the location from WorkerPool resource.

Parameter

Name	Description
workerPoolName	`string` A fully-qualified path representing WorkerPool resource.

Returns

Type	Description
string \| number	{string} A string representing the location.

matchProjectFromCryptoKeyName(cryptoKeyName)

matchProjectFromCryptoKeyName(cryptoKeyName: string): string | number;

Parse the project from CryptoKey resource.

Parameter

Name	Description
cryptoKeyName	`string` A fully-qualified path representing CryptoKey resource.

Returns

Type	Description
string \| number	{string} A string representing the project.

matchProjectFromLocationName(locationName)

matchProjectFromLocationName(locationName: string): string | number;

Parse the project from Location resource.

Parameter

Name	Description
locationName	`string` A fully-qualified path representing Location resource.

Returns

Type	Description
string \| number	{string} A string representing the project.

matchProjectFromProjectBuildName(projectBuildName)

matchProjectFromProjectBuildName(projectBuildName: string): string | number;

Parse the project from ProjectBuild resource.

Parameter

Name	Description
projectBuildName	`string` A fully-qualified path representing project_build resource.

Returns

Type	Description
string \| number	{string} A string representing the project.

matchProjectFromProjectLocationBuildName(projectLocationBuildName)

matchProjectFromProjectLocationBuildName(projectLocationBuildName: string): string | number;

Parse the project from ProjectLocationBuild resource.

Parameter

Name	Description
projectLocationBuildName	`string` A fully-qualified path representing project_location_build resource.

Returns

Type	Description
string \| number	{string} A string representing the project.

matchProjectFromProjectLocationTriggerName(projectLocationTriggerName)

matchProjectFromProjectLocationTriggerName(projectLocationTriggerName: string): string | number;

Parse the project from ProjectLocationTrigger resource.

Parameter

Name	Description
projectLocationTriggerName	`string` A fully-qualified path representing project_location_trigger resource.

Returns

Type	Description
string \| number	{string} A string representing the project.

matchProjectFromProjectName(projectName)

matchProjectFromProjectName(projectName: string): string | number;

Parse the project from Project resource.

Parameter

Name	Description
projectName	`string` A fully-qualified path representing Project resource.

Returns

Type	Description
string \| number	{string} A string representing the project.

matchProjectFromProjectTriggerName(projectTriggerName)

matchProjectFromProjectTriggerName(projectTriggerName: string): string | number;

Parse the project from ProjectTrigger resource.

Parameter

Name	Description
projectTriggerName	`string` A fully-qualified path representing project_trigger resource.

Returns

Type	Description
string \| number	{string} A string representing the project.

matchProjectFromSecretVersionName(secretVersionName)

matchProjectFromSecretVersionName(secretVersionName: string): string | number;

Parse the project from SecretVersion resource.

Parameter

Name	Description
secretVersionName	`string` A fully-qualified path representing SecretVersion resource.

Returns

Type	Description
string \| number	{string} A string representing the project.

matchProjectFromServiceAccountName(serviceAccountName)

matchProjectFromServiceAccountName(serviceAccountName: string): string | number;

Parse the project from ServiceAccount resource.

Parameter

Name	Description
serviceAccountName	`string` A fully-qualified path representing ServiceAccount resource.

Returns

Type	Description
string \| number	{string} A string representing the project.

matchProjectFromSubscriptionName(subscriptionName)

matchProjectFromSubscriptionName(subscriptionName: string): string | number;

Parse the project from Subscription resource.

Parameter

Name	Description
subscriptionName	`string` A fully-qualified path representing Subscription resource.

Returns

Type	Description
string \| number	{string} A string representing the project.

matchProjectFromTopicName(topicName)

matchProjectFromTopicName(topicName: string): string | number;

Parse the project from Topic resource.

Parameter

Name	Description
topicName	`string` A fully-qualified path representing Topic resource.

Returns

Type	Description
string \| number	{string} A string representing the project.

matchProjectFromWorkerPoolName(workerPoolName)

matchProjectFromWorkerPoolName(workerPoolName: string): string | number;

Parse the project from WorkerPool resource.

Parameter

Name	Description
workerPoolName	`string` A fully-qualified path representing WorkerPool resource.

Returns

Type	Description
string \| number	{string} A string representing the project.

matchSecretFromSecretVersionName(secretVersionName)

matchSecretFromSecretVersionName(secretVersionName: string): string | number;

Parse the secret from SecretVersion resource.

Parameter

Name	Description
secretVersionName	`string` A fully-qualified path representing SecretVersion resource.

Returns

Type	Description
string \| number	{string} A string representing the secret.

matchServiceAccountFromServiceAccountName(serviceAccountName)

matchServiceAccountFromServiceAccountName(serviceAccountName: string): string | number;

Parse the service_account from ServiceAccount resource.

Parameter

Name	Description
serviceAccountName	`string` A fully-qualified path representing ServiceAccount resource.

Returns

Type	Description
string \| number	{string} A string representing the service_account.

matchSubscriptionFromSubscriptionName(subscriptionName)

matchSubscriptionFromSubscriptionName(subscriptionName: string): string | number;

Parse the subscription from Subscription resource.

Parameter

Name	Description
subscriptionName	`string` A fully-qualified path representing Subscription resource.

Returns

Type	Description
string \| number	{string} A string representing the subscription.

matchTopicFromTopicName(topicName)

matchTopicFromTopicName(topicName: string): string | number;

Parse the topic from Topic resource.

Parameter

Name	Description
topicName	`string` A fully-qualified path representing Topic resource.

Returns

Type	Description
string \| number	{string} A string representing the topic.

matchTriggerFromProjectLocationTriggerName(projectLocationTriggerName)

matchTriggerFromProjectLocationTriggerName(projectLocationTriggerName: string): string | number;

Parse the trigger from ProjectLocationTrigger resource.

Parameter

Name	Description
projectLocationTriggerName	`string` A fully-qualified path representing project_location_trigger resource.

Returns

Type	Description
string \| number	{string} A string representing the trigger.

matchTriggerFromProjectTriggerName(projectTriggerName)

matchTriggerFromProjectTriggerName(projectTriggerName: string): string | number;

Parse the trigger from ProjectTrigger resource.

Parameter

Name	Description
projectTriggerName	`string` A fully-qualified path representing project_trigger resource.

Returns

Type	Description
string \| number	{string} A string representing the trigger.

matchVersionFromSecretVersionName(secretVersionName)

matchVersionFromSecretVersionName(secretVersionName: string): string | number;

Parse the version from SecretVersion resource.

Parameter

Name	Description
secretVersionName	`string` A fully-qualified path representing SecretVersion resource.

Returns

Type	Description
string \| number	{string} A string representing the version.

matchWorkerPoolFromWorkerPoolName(workerPoolName)

matchWorkerPoolFromWorkerPoolName(workerPoolName: string): string | number;

Parse the worker_pool from WorkerPool resource.

Parameter

Name	Description
workerPoolName	`string` A fully-qualified path representing WorkerPool resource.

Returns

Type	Description
string \| number	{string} A string representing the worker_pool.

projectBuildPath(project, build)

projectBuildPath(project: string, build: string): string;

Return a fully-qualified projectBuild resource name string.

Parameters

Name	Description
project	`string`
build	`string`

Returns

Type	Description
string	{string} Resource name string.

projectLocationBuildPath(project, location, build)

projectLocationBuildPath(project: string, location: string, build: string): string;

Return a fully-qualified projectLocationBuild resource name string.

Parameters

Name	Description
project	`string`
location	`string`
build	`string`

Returns

Type	Description
string	{string} Resource name string.

projectLocationTriggerPath(project, location, trigger)

projectLocationTriggerPath(project: string, location: string, trigger: string): string;

Return a fully-qualified projectLocationTrigger resource name string.

Parameters

Name	Description
project	`string`
location	`string`
trigger	`string`

Returns

Type	Description
string	{string} Resource name string.

projectPath(project)

projectPath(project: string): string;

Return a fully-qualified project resource name string.

Parameter

Name	Description
project	`string`

Returns

Type	Description
string	{string} Resource name string.

projectTriggerPath(project, trigger)

projectTriggerPath(project: string, trigger: string): string;

Return a fully-qualified projectTrigger resource name string.

Parameters

Name	Description
project	`string`
trigger	`string`

Returns

Type	Description
string	{string} Resource name string.

receiveTriggerWebhook(request, options)

receiveTriggerWebhook(request?: protos.google.devtools.cloudbuild.v1.IReceiveTriggerWebhookRequest, options?: CallOptions): Promise<[protos.google.devtools.cloudbuild.v1.IReceiveTriggerWebhookResponse, (protos.google.devtools.cloudbuild.v1.IReceiveTriggerWebhookRequest | undefined), {} | undefined]>;

Parameters

Name	Description
request	`protos.google.devtools.cloudbuild.v1.IReceiveTriggerWebhookRequest`
options	`CallOptions`

Returns

Type	Description
Promise<[protos.google.devtools.cloudbuild.v1.IReceiveTriggerWebhookResponse, (protos.google.devtools.cloudbuild.v1.IReceiveTriggerWebhookRequest \| undefined), {} \| undefined]>

receiveTriggerWebhook(request, options, callback)

receiveTriggerWebhook(request: protos.google.devtools.cloudbuild.v1.IReceiveTriggerWebhookRequest, options: CallOptions, callback: Callback<protos.google.devtools.cloudbuild.v1.IReceiveTriggerWebhookResponse, protos.google.devtools.cloudbuild.v1.IReceiveTriggerWebhookRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.devtools.cloudbuild.v1.IReceiveTriggerWebhookRequest`
options	`CallOptions`
callback	`Callback<protos.google.devtools.cloudbuild.v1.IReceiveTriggerWebhookResponse, protos.google.devtools.cloudbuild.v1.IReceiveTriggerWebhookRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

receiveTriggerWebhook(request, callback)

receiveTriggerWebhook(request: protos.google.devtools.cloudbuild.v1.IReceiveTriggerWebhookRequest, callback: Callback<protos.google.devtools.cloudbuild.v1.IReceiveTriggerWebhookResponse, protos.google.devtools.cloudbuild.v1.IReceiveTriggerWebhookRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.devtools.cloudbuild.v1.IReceiveTriggerWebhookRequest`
callback	`Callback<protos.google.devtools.cloudbuild.v1.IReceiveTriggerWebhookResponse, protos.google.devtools.cloudbuild.v1.IReceiveTriggerWebhookRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

retryBuild(request, options)

retryBuild(request?: protos.google.devtools.cloudbuild.v1.IRetryBuildRequest, options?: CallOptions): Promise<[LROperation<protos.google.devtools.cloudbuild.v1.IBuild, protos.google.devtools.cloudbuild.v1.IBuildOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined]>;

Parameters

Name	Description
request	`protos.google.devtools.cloudbuild.v1.IRetryBuildRequest`
options	`CallOptions`

Returns

Type	Description
Promise<[LROperation<protos.google.devtools.cloudbuild.v1.IBuild, protos.google.devtools.cloudbuild.v1.IBuildOperationMetadata>, protos.google.longrunning.IOperation \| undefined, {} \| undefined]>

retryBuild(request, options, callback)

retryBuild(request: protos.google.devtools.cloudbuild.v1.IRetryBuildRequest, options: CallOptions, callback: Callback<LROperation<protos.google.devtools.cloudbuild.v1.IBuild, protos.google.devtools.cloudbuild.v1.IBuildOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.devtools.cloudbuild.v1.IRetryBuildRequest`
options	`CallOptions`
callback	`Callback<LROperation<protos.google.devtools.cloudbuild.v1.IBuild, protos.google.devtools.cloudbuild.v1.IBuildOperationMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

retryBuild(request, callback)

retryBuild(request: protos.google.devtools.cloudbuild.v1.IRetryBuildRequest, callback: Callback<LROperation<protos.google.devtools.cloudbuild.v1.IBuild, protos.google.devtools.cloudbuild.v1.IBuildOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.devtools.cloudbuild.v1.IRetryBuildRequest`
callback	`Callback<LROperation<protos.google.devtools.cloudbuild.v1.IBuild, protos.google.devtools.cloudbuild.v1.IBuildOperationMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

runBuildTrigger(request, options)

runBuildTrigger(request?: protos.google.devtools.cloudbuild.v1.IRunBuildTriggerRequest, options?: CallOptions): Promise<[LROperation<protos.google.devtools.cloudbuild.v1.IBuild, protos.google.devtools.cloudbuild.v1.IBuildOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined]>;

Parameters

Name	Description
request	`protos.google.devtools.cloudbuild.v1.IRunBuildTriggerRequest`
options	`CallOptions`

Returns

Type	Description
Promise<[LROperation<protos.google.devtools.cloudbuild.v1.IBuild, protos.google.devtools.cloudbuild.v1.IBuildOperationMetadata>, protos.google.longrunning.IOperation \| undefined, {} \| undefined]>

runBuildTrigger(request, options, callback)

runBuildTrigger(request: protos.google.devtools.cloudbuild.v1.IRunBuildTriggerRequest, options: CallOptions, callback: Callback<LROperation<protos.google.devtools.cloudbuild.v1.IBuild, protos.google.devtools.cloudbuild.v1.IBuildOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.devtools.cloudbuild.v1.IRunBuildTriggerRequest`
options	`CallOptions`
callback	`Callback<LROperation<protos.google.devtools.cloudbuild.v1.IBuild, protos.google.devtools.cloudbuild.v1.IBuildOperationMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

runBuildTrigger(request, callback)

runBuildTrigger(request: protos.google.devtools.cloudbuild.v1.IRunBuildTriggerRequest, callback: Callback<LROperation<protos.google.devtools.cloudbuild.v1.IBuild, protos.google.devtools.cloudbuild.v1.IBuildOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.devtools.cloudbuild.v1.IRunBuildTriggerRequest`
callback	`Callback<LROperation<protos.google.devtools.cloudbuild.v1.IBuild, protos.google.devtools.cloudbuild.v1.IBuildOperationMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

secretVersionPath(project, secret, version)

secretVersionPath(project: string, secret: string, version: string): string;

Return a fully-qualified secretVersion resource name string.

Parameters

Name	Description
project	`string`
secret	`string`
version	`string`

Returns

Type	Description
string	{string} Resource name string.

serviceAccountPath(project, serviceAccount)

serviceAccountPath(project: string, serviceAccount: string): string;

Return a fully-qualified serviceAccount resource name string.

Parameters

Name	Description
project	`string`
serviceAccount	`string`

Returns

Type	Description
string	{string} Resource name string.

subscriptionPath(project, subscription)

subscriptionPath(project: string, subscription: string): string;

Return a fully-qualified subscription resource name string.

Parameters

Name	Description
project	`string`
subscription	`string`

Returns

Type	Description
string	{string} Resource name string.

topicPath(project, topic)

topicPath(project: string, topic: string): string;

Return a fully-qualified topic resource name string.

Parameters

Name	Description
project	`string`
topic	`string`

Returns

Type	Description
string	{string} Resource name string.

updateBuildTrigger(request, options)

updateBuildTrigger(request?: protos.google.devtools.cloudbuild.v1.IUpdateBuildTriggerRequest, options?: CallOptions): Promise<[protos.google.devtools.cloudbuild.v1.IBuildTrigger, (protos.google.devtools.cloudbuild.v1.IUpdateBuildTriggerRequest | undefined), {} | undefined]>;

Parameters

Name	Description
request	`protos.google.devtools.cloudbuild.v1.IUpdateBuildTriggerRequest`
options	`CallOptions`

Returns

Type	Description
Promise<[protos.google.devtools.cloudbuild.v1.IBuildTrigger, (protos.google.devtools.cloudbuild.v1.IUpdateBuildTriggerRequest \| undefined), {} \| undefined]>

updateBuildTrigger(request, options, callback)

updateBuildTrigger(request: protos.google.devtools.cloudbuild.v1.IUpdateBuildTriggerRequest, options: CallOptions, callback: Callback<protos.google.devtools.cloudbuild.v1.IBuildTrigger, protos.google.devtools.cloudbuild.v1.IUpdateBuildTriggerRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.devtools.cloudbuild.v1.IUpdateBuildTriggerRequest`
options	`CallOptions`
callback	`Callback<protos.google.devtools.cloudbuild.v1.IBuildTrigger, protos.google.devtools.cloudbuild.v1.IUpdateBuildTriggerRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

updateBuildTrigger(request, callback)

updateBuildTrigger(request: protos.google.devtools.cloudbuild.v1.IUpdateBuildTriggerRequest, callback: Callback<protos.google.devtools.cloudbuild.v1.IBuildTrigger, protos.google.devtools.cloudbuild.v1.IUpdateBuildTriggerRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.devtools.cloudbuild.v1.IUpdateBuildTriggerRequest`
callback	`Callback<protos.google.devtools.cloudbuild.v1.IBuildTrigger, protos.google.devtools.cloudbuild.v1.IUpdateBuildTriggerRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

updateWorkerPool(request, options)

updateWorkerPool(request?: protos.google.devtools.cloudbuild.v1.IUpdateWorkerPoolRequest, options?: CallOptions): Promise<[LROperation<protos.google.devtools.cloudbuild.v1.IWorkerPool, protos.google.devtools.cloudbuild.v1.IUpdateWorkerPoolOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined]>;

Parameters

Name	Description
request	`protos.google.devtools.cloudbuild.v1.IUpdateWorkerPoolRequest`
options	`CallOptions`

Returns

Type	Description
Promise<[LROperation<protos.google.devtools.cloudbuild.v1.IWorkerPool, protos.google.devtools.cloudbuild.v1.IUpdateWorkerPoolOperationMetadata>, protos.google.longrunning.IOperation \| undefined, {} \| undefined]>

updateWorkerPool(request, options, callback)

updateWorkerPool(request: protos.google.devtools.cloudbuild.v1.IUpdateWorkerPoolRequest, options: CallOptions, callback: Callback<LROperation<protos.google.devtools.cloudbuild.v1.IWorkerPool, protos.google.devtools.cloudbuild.v1.IUpdateWorkerPoolOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.devtools.cloudbuild.v1.IUpdateWorkerPoolRequest`
options	`CallOptions`
callback	`Callback<LROperation<protos.google.devtools.cloudbuild.v1.IWorkerPool, protos.google.devtools.cloudbuild.v1.IUpdateWorkerPoolOperationMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

updateWorkerPool(request, callback)

updateWorkerPool(request: protos.google.devtools.cloudbuild.v1.IUpdateWorkerPoolRequest, callback: Callback<LROperation<protos.google.devtools.cloudbuild.v1.IWorkerPool, protos.google.devtools.cloudbuild.v1.IUpdateWorkerPoolOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.devtools.cloudbuild.v1.IUpdateWorkerPoolRequest`
callback	`Callback<LROperation<protos.google.devtools.cloudbuild.v1.IWorkerPool, protos.google.devtools.cloudbuild.v1.IUpdateWorkerPoolOperationMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

workerPoolPath(project, location, workerPool)

workerPoolPath(project: string, location: string, workerPool: string): string;

Return a fully-qualified workerPool resource name string.

Parameters

Name	Description
project	`string`
location	`string`
workerPool	`string`

Returns

Type	Description
string	{string} Resource name string.