Cloud Build v1 API - Class CloudBuild.CloudBuildClient (2.11.0)

public class CloudBuild.CloudBuildClient : ClientBase<CloudBuild.CloudBuildClient>

Reference documentation and code samples for the Cloud Build v1 API class CloudBuild.CloudBuildClient.

Client for CloudBuild

Inheritance

object > ClientBase > ClientBaseCloudBuildCloudBuildClient > CloudBuild.CloudBuildClient

Namespace

Google.Cloud.CloudBuild.V1

Assembly

Google.Cloud.CloudBuild.V1.dll

Constructors

CloudBuildClient()

protected CloudBuildClient()

Protected parameterless constructor to allow creation of test doubles.

CloudBuildClient(CallInvoker)

public CloudBuildClient(CallInvoker callInvoker)

Creates a new client for CloudBuild that uses a custom CallInvoker.

Parameter
Name Description
callInvoker CallInvoker

The callInvoker to use to make remote calls.

CloudBuildClient(ChannelBase)

public CloudBuildClient(ChannelBase channel)

Creates a new client for CloudBuild

Parameter
Name Description
channel ChannelBase

The channel to use to make remote calls.

CloudBuildClient(ClientBaseConfiguration)

protected CloudBuildClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
Name Description
configuration ClientBaseClientBaseConfiguration

The client configuration.

Methods

ApproveBuild(ApproveBuildRequest, CallOptions)

public virtual Operation ApproveBuild(ApproveBuildRequest request, CallOptions options)

Approves or rejects a pending build.

If approved, the returned LRO will be analogous to the LRO returned from a CreateBuild call.

If rejected, the returned LRO will be immediately done.

Parameters
Name Description
request ApproveBuildRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
Operation

The response received from the server.

ApproveBuild(ApproveBuildRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation ApproveBuild(ApproveBuildRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Approves or rejects a pending build.

If approved, the returned LRO will be analogous to the LRO returned from a CreateBuild call.

If rejected, the returned LRO will be immediately done.

Parameters
Name Description
request ApproveBuildRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
Operation

The response received from the server.

ApproveBuildAsync(ApproveBuildRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> ApproveBuildAsync(ApproveBuildRequest request, CallOptions options)

Approves or rejects a pending build.

If approved, the returned LRO will be analogous to the LRO returned from a CreateBuild call.

If rejected, the returned LRO will be immediately done.

Parameters
Name Description
request ApproveBuildRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCallOperation

The call object.

ApproveBuildAsync(ApproveBuildRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> ApproveBuildAsync(ApproveBuildRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Approves or rejects a pending build.

If approved, the returned LRO will be analogous to the LRO returned from a CreateBuild call.

If rejected, the returned LRO will be immediately done.

Parameters
Name Description
request ApproveBuildRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
AsyncUnaryCallOperation

The call object.

CancelBuild(CancelBuildRequest, CallOptions)

public virtual Build CancelBuild(CancelBuildRequest request, CallOptions options)

Cancels a build in progress.

Parameters
Name Description
request CancelBuildRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
Build

The response received from the server.

CancelBuild(CancelBuildRequest, Metadata, DateTime?, CancellationToken)

public virtual Build CancelBuild(CancelBuildRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Cancels a build in progress.

Parameters
Name Description
request CancelBuildRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
Build

The response received from the server.

CancelBuildAsync(CancelBuildRequest, CallOptions)

public virtual AsyncUnaryCall<Build> CancelBuildAsync(CancelBuildRequest request, CallOptions options)

Cancels a build in progress.

Parameters
Name Description
request CancelBuildRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCallBuild

The call object.

CancelBuildAsync(CancelBuildRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Build> CancelBuildAsync(CancelBuildRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Cancels a build in progress.

Parameters
Name Description
request CancelBuildRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
AsyncUnaryCallBuild

The call object.

CreateBuild(CreateBuildRequest, CallOptions)

public virtual Operation CreateBuild(CreateBuildRequest request, CallOptions options)

Starts a build with the specified configuration.

This method returns a long-running Operation, which includes the build ID. Pass the build ID to GetBuild to determine the build status (such as SUCCESS or FAILURE).

Parameters
Name Description
request CreateBuildRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
Operation

The response received from the server.

CreateBuild(CreateBuildRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation CreateBuild(CreateBuildRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Starts a build with the specified configuration.

This method returns a long-running Operation, which includes the build ID. Pass the build ID to GetBuild to determine the build status (such as SUCCESS or FAILURE).

Parameters
Name Description
request CreateBuildRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
Operation

The response received from the server.

CreateBuildAsync(CreateBuildRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> CreateBuildAsync(CreateBuildRequest request, CallOptions options)

Starts a build with the specified configuration.

This method returns a long-running Operation, which includes the build ID. Pass the build ID to GetBuild to determine the build status (such as SUCCESS or FAILURE).

Parameters
Name Description
request CreateBuildRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCallOperation

The call object.

CreateBuildAsync(CreateBuildRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> CreateBuildAsync(CreateBuildRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Starts a build with the specified configuration.

This method returns a long-running Operation, which includes the build ID. Pass the build ID to GetBuild to determine the build status (such as SUCCESS or FAILURE).

Parameters
Name Description
request CreateBuildRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
AsyncUnaryCallOperation

The call object.

CreateBuildTrigger(CreateBuildTriggerRequest, CallOptions)

public virtual BuildTrigger CreateBuildTrigger(CreateBuildTriggerRequest request, CallOptions options)

Creates a new BuildTrigger.

This API is experimental.

Parameters
Name Description
request CreateBuildTriggerRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
BuildTrigger

The response received from the server.

CreateBuildTrigger(CreateBuildTriggerRequest, Metadata, DateTime?, CancellationToken)

public virtual BuildTrigger CreateBuildTrigger(CreateBuildTriggerRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Creates a new BuildTrigger.

This API is experimental.

Parameters
Name Description
request CreateBuildTriggerRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
BuildTrigger

The response received from the server.

CreateBuildTriggerAsync(CreateBuildTriggerRequest, CallOptions)

public virtual AsyncUnaryCall<BuildTrigger> CreateBuildTriggerAsync(CreateBuildTriggerRequest request, CallOptions options)

Creates a new BuildTrigger.

This API is experimental.

Parameters
Name Description
request CreateBuildTriggerRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCallBuildTrigger

The call object.

CreateBuildTriggerAsync(CreateBuildTriggerRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<BuildTrigger> CreateBuildTriggerAsync(CreateBuildTriggerRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Creates a new BuildTrigger.

This API is experimental.

Parameters
Name Description
request CreateBuildTriggerRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
AsyncUnaryCallBuildTrigger

The call object.

CreateOperationsClient()

public virtual Operations.OperationsClient CreateOperationsClient()

Creates a new instance of Operations.OperationsClient using the same call invoker as this client.

Returns
Type Description
OperationsOperationsClient

A new Operations client for the same target as this client.

CreateWorkerPool(CreateWorkerPoolRequest, CallOptions)

public virtual Operation CreateWorkerPool(CreateWorkerPoolRequest request, CallOptions options)

Creates a WorkerPool.

Parameters
Name Description
request CreateWorkerPoolRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
Operation

The response received from the server.

CreateWorkerPool(CreateWorkerPoolRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation CreateWorkerPool(CreateWorkerPoolRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Creates a WorkerPool.

Parameters
Name Description
request CreateWorkerPoolRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
Operation

The response received from the server.

CreateWorkerPoolAsync(CreateWorkerPoolRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> CreateWorkerPoolAsync(CreateWorkerPoolRequest request, CallOptions options)

Creates a WorkerPool.

Parameters
Name Description
request CreateWorkerPoolRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCallOperation

The call object.

CreateWorkerPoolAsync(CreateWorkerPoolRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> CreateWorkerPoolAsync(CreateWorkerPoolRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Creates a WorkerPool.

Parameters
Name Description
request CreateWorkerPoolRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
AsyncUnaryCallOperation

The call object.

DeleteBuildTrigger(DeleteBuildTriggerRequest, CallOptions)

public virtual Empty DeleteBuildTrigger(DeleteBuildTriggerRequest request, CallOptions options)

Deletes a BuildTrigger by its project ID and trigger ID.

This API is experimental.

Parameters
Name Description
request DeleteBuildTriggerRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
Empty

The response received from the server.

DeleteBuildTrigger(DeleteBuildTriggerRequest, Metadata, DateTime?, CancellationToken)

public virtual Empty DeleteBuildTrigger(DeleteBuildTriggerRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Deletes a BuildTrigger by its project ID and trigger ID.

This API is experimental.

Parameters
Name Description
request DeleteBuildTriggerRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
Empty

The response received from the server.

DeleteBuildTriggerAsync(DeleteBuildTriggerRequest, CallOptions)

public virtual AsyncUnaryCall<Empty> DeleteBuildTriggerAsync(DeleteBuildTriggerRequest request, CallOptions options)

Deletes a BuildTrigger by its project ID and trigger ID.

This API is experimental.

Parameters
Name Description
request DeleteBuildTriggerRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCallEmpty

The call object.

DeleteBuildTriggerAsync(DeleteBuildTriggerRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Empty> DeleteBuildTriggerAsync(DeleteBuildTriggerRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Deletes a BuildTrigger by its project ID and trigger ID.

This API is experimental.

Parameters
Name Description
request DeleteBuildTriggerRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
AsyncUnaryCallEmpty

The call object.

DeleteWorkerPool(DeleteWorkerPoolRequest, CallOptions)

public virtual Operation DeleteWorkerPool(DeleteWorkerPoolRequest request, CallOptions options)

Deletes a WorkerPool.

Parameters
Name Description
request DeleteWorkerPoolRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
Operation

The response received from the server.

DeleteWorkerPool(DeleteWorkerPoolRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation DeleteWorkerPool(DeleteWorkerPoolRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Deletes a WorkerPool.

Parameters
Name Description
request DeleteWorkerPoolRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
Operation

The response received from the server.

DeleteWorkerPoolAsync(DeleteWorkerPoolRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> DeleteWorkerPoolAsync(DeleteWorkerPoolRequest request, CallOptions options)

Deletes a WorkerPool.

Parameters
Name Description
request DeleteWorkerPoolRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCallOperation

The call object.

DeleteWorkerPoolAsync(DeleteWorkerPoolRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> DeleteWorkerPoolAsync(DeleteWorkerPoolRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Deletes a WorkerPool.

Parameters
Name Description
request DeleteWorkerPoolRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
AsyncUnaryCallOperation

The call object.

GetBuild(GetBuildRequest, CallOptions)

public virtual Build GetBuild(GetBuildRequest request, CallOptions options)

Returns information about a previously requested build.

The Build that is returned includes its status (such as SUCCESS, FAILURE, or WORKING), and timing information.

Parameters
Name Description
request GetBuildRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
Build

The response received from the server.

GetBuild(GetBuildRequest, Metadata, DateTime?, CancellationToken)

public virtual Build GetBuild(GetBuildRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Returns information about a previously requested build.

The Build that is returned includes its status (such as SUCCESS, FAILURE, or WORKING), and timing information.

Parameters
Name Description
request GetBuildRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
Build

The response received from the server.

GetBuildAsync(GetBuildRequest, CallOptions)

public virtual AsyncUnaryCall<Build> GetBuildAsync(GetBuildRequest request, CallOptions options)

Returns information about a previously requested build.

The Build that is returned includes its status (such as SUCCESS, FAILURE, or WORKING), and timing information.

Parameters
Name Description
request GetBuildRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCallBuild

The call object.

GetBuildAsync(GetBuildRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Build> GetBuildAsync(GetBuildRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Returns information about a previously requested build.

The Build that is returned includes its status (such as SUCCESS, FAILURE, or WORKING), and timing information.

Parameters
Name Description
request GetBuildRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
AsyncUnaryCallBuild

The call object.

GetBuildTrigger(GetBuildTriggerRequest, CallOptions)

public virtual BuildTrigger GetBuildTrigger(GetBuildTriggerRequest request, CallOptions options)

Returns information about a BuildTrigger.

This API is experimental.

Parameters
Name Description
request GetBuildTriggerRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
BuildTrigger

The response received from the server.

GetBuildTrigger(GetBuildTriggerRequest, Metadata, DateTime?, CancellationToken)

public virtual BuildTrigger GetBuildTrigger(GetBuildTriggerRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Returns information about a BuildTrigger.

This API is experimental.

Parameters
Name Description
request GetBuildTriggerRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
BuildTrigger

The response received from the server.

GetBuildTriggerAsync(GetBuildTriggerRequest, CallOptions)

public virtual AsyncUnaryCall<BuildTrigger> GetBuildTriggerAsync(GetBuildTriggerRequest request, CallOptions options)

Returns information about a BuildTrigger.

This API is experimental.

Parameters
Name Description
request GetBuildTriggerRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCallBuildTrigger

The call object.

GetBuildTriggerAsync(GetBuildTriggerRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<BuildTrigger> GetBuildTriggerAsync(GetBuildTriggerRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Returns information about a BuildTrigger.

This API is experimental.

Parameters
Name Description
request GetBuildTriggerRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
AsyncUnaryCallBuildTrigger

The call object.

GetWorkerPool(GetWorkerPoolRequest, CallOptions)

public virtual WorkerPool GetWorkerPool(GetWorkerPoolRequest request, CallOptions options)

Returns details of a WorkerPool.

Parameters
Name Description
request GetWorkerPoolRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
WorkerPool

The response received from the server.

GetWorkerPool(GetWorkerPoolRequest, Metadata, DateTime?, CancellationToken)

public virtual WorkerPool GetWorkerPool(GetWorkerPoolRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Returns details of a WorkerPool.

Parameters
Name Description
request GetWorkerPoolRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
WorkerPool

The response received from the server.

GetWorkerPoolAsync(GetWorkerPoolRequest, CallOptions)

public virtual AsyncUnaryCall<WorkerPool> GetWorkerPoolAsync(GetWorkerPoolRequest request, CallOptions options)

Returns details of a WorkerPool.

Parameters
Name Description
request GetWorkerPoolRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCallWorkerPool

The call object.

GetWorkerPoolAsync(GetWorkerPoolRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<WorkerPool> GetWorkerPoolAsync(GetWorkerPoolRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Returns details of a WorkerPool.

Parameters
Name Description
request GetWorkerPoolRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
AsyncUnaryCallWorkerPool

The call object.

ListBuildTriggers(ListBuildTriggersRequest, CallOptions)

public virtual ListBuildTriggersResponse ListBuildTriggers(ListBuildTriggersRequest request, CallOptions options)

Lists existing BuildTriggers.

This API is experimental.

Parameters
Name Description
request ListBuildTriggersRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
ListBuildTriggersResponse

The response received from the server.

ListBuildTriggers(ListBuildTriggersRequest, Metadata, DateTime?, CancellationToken)

public virtual ListBuildTriggersResponse ListBuildTriggers(ListBuildTriggersRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists existing BuildTriggers.

This API is experimental.

Parameters
Name Description
request ListBuildTriggersRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
ListBuildTriggersResponse

The response received from the server.

ListBuildTriggersAsync(ListBuildTriggersRequest, CallOptions)

public virtual AsyncUnaryCall<ListBuildTriggersResponse> ListBuildTriggersAsync(ListBuildTriggersRequest request, CallOptions options)

Lists existing BuildTriggers.

This API is experimental.

Parameters
Name Description
request ListBuildTriggersRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCallListBuildTriggersResponse

The call object.

ListBuildTriggersAsync(ListBuildTriggersRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListBuildTriggersResponse> ListBuildTriggersAsync(ListBuildTriggersRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists existing BuildTriggers.

This API is experimental.

Parameters
Name Description
request ListBuildTriggersRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
AsyncUnaryCallListBuildTriggersResponse

The call object.

ListBuilds(ListBuildsRequest, CallOptions)

public virtual ListBuildsResponse ListBuilds(ListBuildsRequest request, CallOptions options)

Lists previously requested builds.

Previously requested builds may still be in-progress, or may have finished successfully or unsuccessfully.

Parameters
Name Description
request ListBuildsRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
ListBuildsResponse

The response received from the server.

ListBuilds(ListBuildsRequest, Metadata, DateTime?, CancellationToken)

public virtual ListBuildsResponse ListBuilds(ListBuildsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists previously requested builds.

Previously requested builds may still be in-progress, or may have finished successfully or unsuccessfully.

Parameters
Name Description
request ListBuildsRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
ListBuildsResponse

The response received from the server.

ListBuildsAsync(ListBuildsRequest, CallOptions)

public virtual AsyncUnaryCall<ListBuildsResponse> ListBuildsAsync(ListBuildsRequest request, CallOptions options)

Lists previously requested builds.

Previously requested builds may still be in-progress, or may have finished successfully or unsuccessfully.

Parameters
Name Description
request ListBuildsRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCallListBuildsResponse

The call object.

ListBuildsAsync(ListBuildsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListBuildsResponse> ListBuildsAsync(ListBuildsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists previously requested builds.

Previously requested builds may still be in-progress, or may have finished successfully or unsuccessfully.

Parameters
Name Description
request ListBuildsRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
AsyncUnaryCallListBuildsResponse

The call object.

ListWorkerPools(ListWorkerPoolsRequest, CallOptions)

public virtual ListWorkerPoolsResponse ListWorkerPools(ListWorkerPoolsRequest request, CallOptions options)

Lists WorkerPools.

Parameters
Name Description
request ListWorkerPoolsRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
ListWorkerPoolsResponse

The response received from the server.

ListWorkerPools(ListWorkerPoolsRequest, Metadata, DateTime?, CancellationToken)

public virtual ListWorkerPoolsResponse ListWorkerPools(ListWorkerPoolsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists WorkerPools.

Parameters
Name Description
request ListWorkerPoolsRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
ListWorkerPoolsResponse

The response received from the server.

ListWorkerPoolsAsync(ListWorkerPoolsRequest, CallOptions)

public virtual AsyncUnaryCall<ListWorkerPoolsResponse> ListWorkerPoolsAsync(ListWorkerPoolsRequest request, CallOptions options)

Lists WorkerPools.

Parameters
Name Description
request ListWorkerPoolsRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCallListWorkerPoolsResponse

The call object.

ListWorkerPoolsAsync(ListWorkerPoolsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListWorkerPoolsResponse> ListWorkerPoolsAsync(ListWorkerPoolsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists WorkerPools.

Parameters
Name Description
request ListWorkerPoolsRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
AsyncUnaryCallListWorkerPoolsResponse

The call object.

NewInstance(ClientBaseConfiguration)

protected override CloudBuild.CloudBuildClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name Description
configuration ClientBaseClientBaseConfiguration
Returns
Type Description
CloudBuildCloudBuildClient
Overrides

ReceiveTriggerWebhook(ReceiveTriggerWebhookRequest, CallOptions)

public virtual ReceiveTriggerWebhookResponse ReceiveTriggerWebhook(ReceiveTriggerWebhookRequest request, CallOptions options)

ReceiveTriggerWebhook [Experimental] is called when the API receives a webhook request targeted at a specific trigger.

Parameters
Name Description
request ReceiveTriggerWebhookRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
ReceiveTriggerWebhookResponse

The response received from the server.

ReceiveTriggerWebhook(ReceiveTriggerWebhookRequest, Metadata, DateTime?, CancellationToken)

public virtual ReceiveTriggerWebhookResponse ReceiveTriggerWebhook(ReceiveTriggerWebhookRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

ReceiveTriggerWebhook [Experimental] is called when the API receives a webhook request targeted at a specific trigger.

Parameters
Name Description
request ReceiveTriggerWebhookRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
ReceiveTriggerWebhookResponse

The response received from the server.

ReceiveTriggerWebhookAsync(ReceiveTriggerWebhookRequest, CallOptions)

public virtual AsyncUnaryCall<ReceiveTriggerWebhookResponse> ReceiveTriggerWebhookAsync(ReceiveTriggerWebhookRequest request, CallOptions options)

ReceiveTriggerWebhook [Experimental] is called when the API receives a webhook request targeted at a specific trigger.

Parameters
Name Description
request ReceiveTriggerWebhookRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCallReceiveTriggerWebhookResponse

The call object.

ReceiveTriggerWebhookAsync(ReceiveTriggerWebhookRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ReceiveTriggerWebhookResponse> ReceiveTriggerWebhookAsync(ReceiveTriggerWebhookRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

ReceiveTriggerWebhook [Experimental] is called when the API receives a webhook request targeted at a specific trigger.

Parameters
Name Description
request ReceiveTriggerWebhookRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
AsyncUnaryCallReceiveTriggerWebhookResponse

The call object.

RetryBuild(RetryBuildRequest, CallOptions)

public virtual Operation RetryBuild(RetryBuildRequest request, CallOptions options)

Creates a new build based on the specified build.

This method creates a new build using the original build request, which may or may not result in an identical build.

For triggered builds:

  • Triggered builds resolve to a precise revision; therefore a retry of a triggered build will result in a build that uses the same revision.

For non-triggered builds that specify RepoSource:

  • If the original build built from the tip of a branch, the retried build will build from the tip of that branch, which may not be the same revision as the original build.
  • If the original build specified a commit sha or revision ID, the retried build will use the identical source.

For builds that specify StorageSource:

  • If the original build pulled source from Cloud Storage without specifying the generation of the object, the new build will use the current object, which may be different from the original build source.
  • If the original build pulled source from Cloud Storage and specified the generation of the object, the new build will attempt to use the same object, which may or may not be available depending on the bucket's lifecycle management settings.
Parameters
Name Description
request RetryBuildRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
Operation

The response received from the server.

RetryBuild(RetryBuildRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation RetryBuild(RetryBuildRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Creates a new build based on the specified build.

This method creates a new build using the original build request, which may or may not result in an identical build.

For triggered builds:

  • Triggered builds resolve to a precise revision; therefore a retry of a triggered build will result in a build that uses the same revision.

For non-triggered builds that specify RepoSource:

  • If the original build built from the tip of a branch, the retried build will build from the tip of that branch, which may not be the same revision as the original build.
  • If the original build specified a commit sha or revision ID, the retried build will use the identical source.

For builds that specify StorageSource:

  • If the original build pulled source from Cloud Storage without specifying the generation of the object, the new build will use the current object, which may be different from the original build source.
  • If the original build pulled source from Cloud Storage and specified the generation of the object, the new build will attempt to use the same object, which may or may not be available depending on the bucket's lifecycle management settings.
Parameters
Name Description
request RetryBuildRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
Operation

The response received from the server.

RetryBuildAsync(RetryBuildRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> RetryBuildAsync(RetryBuildRequest request, CallOptions options)

Creates a new build based on the specified build.

This method creates a new build using the original build request, which may or may not result in an identical build.

For triggered builds:

  • Triggered builds resolve to a precise revision; therefore a retry of a triggered build will result in a build that uses the same revision.

For non-triggered builds that specify RepoSource:

  • If the original build built from the tip of a branch, the retried build will build from the tip of that branch, which may not be the same revision as the original build.
  • If the original build specified a commit sha or revision ID, the retried build will use the identical source.

For builds that specify StorageSource:

  • If the original build pulled source from Cloud Storage without specifying the generation of the object, the new build will use the current object, which may be different from the original build source.
  • If the original build pulled source from Cloud Storage and specified the generation of the object, the new build will attempt to use the same object, which may or may not be available depending on the bucket's lifecycle management settings.
Parameters
Name Description
request RetryBuildRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCallOperation

The call object.

RetryBuildAsync(RetryBuildRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> RetryBuildAsync(RetryBuildRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Creates a new build based on the specified build.

This method creates a new build using the original build request, which may or may not result in an identical build.

For triggered builds:

  • Triggered builds resolve to a precise revision; therefore a retry of a triggered build will result in a build that uses the same revision.

For non-triggered builds that specify RepoSource:

  • If the original build built from the tip of a branch, the retried build will build from the tip of that branch, which may not be the same revision as the original build.
  • If the original build specified a commit sha or revision ID, the retried build will use the identical source.

For builds that specify StorageSource:

  • If the original build pulled source from Cloud Storage without specifying the generation of the object, the new build will use the current object, which may be different from the original build source.
  • If the original build pulled source from Cloud Storage and specified the generation of the object, the new build will attempt to use the same object, which may or may not be available depending on the bucket's lifecycle management settings.
Parameters
Name Description
request RetryBuildRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
AsyncUnaryCallOperation

The call object.

RunBuildTrigger(RunBuildTriggerRequest, CallOptions)

public virtual Operation RunBuildTrigger(RunBuildTriggerRequest request, CallOptions options)

Runs a BuildTrigger at a particular source revision.

To run a regional or global trigger, use the POST request that includes the location endpoint in the path (ex. v1/projects/{projectId}/locations/{region}/triggers/{triggerId}:run). The POST request that does not include the location endpoint in the path can only be used when running global triggers.

Parameters
Name Description
request RunBuildTriggerRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
Operation

The response received from the server.

RunBuildTrigger(RunBuildTriggerRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation RunBuildTrigger(RunBuildTriggerRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Runs a BuildTrigger at a particular source revision.

To run a regional or global trigger, use the POST request that includes the location endpoint in the path (ex. v1/projects/{projectId}/locations/{region}/triggers/{triggerId}:run). The POST request that does not include the location endpoint in the path can only be used when running global triggers.

Parameters
Name Description
request RunBuildTriggerRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
Operation

The response received from the server.

RunBuildTriggerAsync(RunBuildTriggerRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> RunBuildTriggerAsync(RunBuildTriggerRequest request, CallOptions options)

Runs a BuildTrigger at a particular source revision.

To run a regional or global trigger, use the POST request that includes the location endpoint in the path (ex. v1/projects/{projectId}/locations/{region}/triggers/{triggerId}:run). The POST request that does not include the location endpoint in the path can only be used when running global triggers.

Parameters
Name Description
request RunBuildTriggerRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCallOperation

The call object.

RunBuildTriggerAsync(RunBuildTriggerRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> RunBuildTriggerAsync(RunBuildTriggerRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Runs a BuildTrigger at a particular source revision.

To run a regional or global trigger, use the POST request that includes the location endpoint in the path (ex. v1/projects/{projectId}/locations/{region}/triggers/{triggerId}:run). The POST request that does not include the location endpoint in the path can only be used when running global triggers.

Parameters
Name Description
request RunBuildTriggerRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
AsyncUnaryCallOperation

The call object.

UpdateBuildTrigger(UpdateBuildTriggerRequest, CallOptions)

public virtual BuildTrigger UpdateBuildTrigger(UpdateBuildTriggerRequest request, CallOptions options)

Updates a BuildTrigger by its project ID and trigger ID.

This API is experimental.

Parameters
Name Description
request UpdateBuildTriggerRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
BuildTrigger

The response received from the server.

UpdateBuildTrigger(UpdateBuildTriggerRequest, Metadata, DateTime?, CancellationToken)

public virtual BuildTrigger UpdateBuildTrigger(UpdateBuildTriggerRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Updates a BuildTrigger by its project ID and trigger ID.

This API is experimental.

Parameters
Name Description
request UpdateBuildTriggerRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
BuildTrigger

The response received from the server.

UpdateBuildTriggerAsync(UpdateBuildTriggerRequest, CallOptions)

public virtual AsyncUnaryCall<BuildTrigger> UpdateBuildTriggerAsync(UpdateBuildTriggerRequest request, CallOptions options)

Updates a BuildTrigger by its project ID and trigger ID.

This API is experimental.

Parameters
Name Description
request UpdateBuildTriggerRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCallBuildTrigger

The call object.

UpdateBuildTriggerAsync(UpdateBuildTriggerRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<BuildTrigger> UpdateBuildTriggerAsync(UpdateBuildTriggerRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Updates a BuildTrigger by its project ID and trigger ID.

This API is experimental.

Parameters
Name Description
request UpdateBuildTriggerRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
AsyncUnaryCallBuildTrigger

The call object.

UpdateWorkerPool(UpdateWorkerPoolRequest, CallOptions)

public virtual Operation UpdateWorkerPool(UpdateWorkerPoolRequest request, CallOptions options)

Updates a WorkerPool.

Parameters
Name Description
request UpdateWorkerPoolRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
Operation

The response received from the server.

UpdateWorkerPool(UpdateWorkerPoolRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation UpdateWorkerPool(UpdateWorkerPoolRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Updates a WorkerPool.

Parameters
Name Description
request UpdateWorkerPoolRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
Operation

The response received from the server.

UpdateWorkerPoolAsync(UpdateWorkerPoolRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> UpdateWorkerPoolAsync(UpdateWorkerPoolRequest request, CallOptions options)

Updates a WorkerPool.

Parameters
Name Description
request UpdateWorkerPoolRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCallOperation

The call object.

UpdateWorkerPoolAsync(UpdateWorkerPoolRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> UpdateWorkerPoolAsync(UpdateWorkerPoolRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Updates a WorkerPool.

Parameters
Name Description
request UpdateWorkerPoolRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
AsyncUnaryCallOperation

The call object.