Cloud Build v1 API - Class CloudBuildClientImpl (2.9.0)

Version latest

• 2.9.0 (latest)
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.0
• 2.4.0
• 2.3.0
• 2.2.0
• 2.1.0
• 2.0.0
• 1.4.0
• 1.3.0
• 1.2.0
• 1.1.0
• 1.0.0

public sealed class CloudBuildClientImpl : CloudBuildClient

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

CloudBuild client wrapper implementation, for convenient use.

Inheritance

object > CloudBuildClient > CloudBuildClientImpl

Inherited Members

CloudBuildClient.DefaultEndpoint

CloudBuildClient.DefaultScopes

CloudBuildClient.ServiceMetadata

CloudBuildClient.CreateAsync(CancellationToken)

CloudBuildClient.Create()

CloudBuildClient.ShutdownDefaultChannelsAsync()

CloudBuildClient.CreateBuildAsync(CreateBuildRequest, CancellationToken)

CloudBuildClient.PollOnceCreateBuild(string, CallSettings)

CloudBuildClient.PollOnceCreateBuildAsync(string, CallSettings)

CloudBuildClient.CreateBuild(string, Build, CallSettings)

CloudBuildClient.CreateBuildAsync(string, Build, CallSettings)

CloudBuildClient.CreateBuildAsync(string, Build, CancellationToken)

CloudBuildClient.GetBuildAsync(GetBuildRequest, CancellationToken)

CloudBuildClient.GetBuild(string, string, CallSettings)

CloudBuildClient.GetBuildAsync(string, string, CallSettings)

CloudBuildClient.GetBuildAsync(string, string, CancellationToken)

CloudBuildClient.ListBuilds(string, string, string, int?, CallSettings)

CloudBuildClient.ListBuildsAsync(string, string, string, int?, CallSettings)

CloudBuildClient.CancelBuildAsync(CancelBuildRequest, CancellationToken)

CloudBuildClient.CancelBuild(string, string, CallSettings)

CloudBuildClient.CancelBuildAsync(string, string, CallSettings)

CloudBuildClient.CancelBuildAsync(string, string, CancellationToken)

CloudBuildClient.RetryBuildAsync(RetryBuildRequest, CancellationToken)

CloudBuildClient.PollOnceRetryBuild(string, CallSettings)

CloudBuildClient.PollOnceRetryBuildAsync(string, CallSettings)

CloudBuildClient.RetryBuild(string, string, CallSettings)

CloudBuildClient.RetryBuildAsync(string, string, CallSettings)

CloudBuildClient.RetryBuildAsync(string, string, CancellationToken)

CloudBuildClient.ApproveBuildAsync(ApproveBuildRequest, CancellationToken)

CloudBuildClient.PollOnceApproveBuild(string, CallSettings)

CloudBuildClient.PollOnceApproveBuildAsync(string, CallSettings)

CloudBuildClient.ApproveBuild(string, ApprovalResult, CallSettings)

CloudBuildClient.ApproveBuildAsync(string, ApprovalResult, CallSettings)

CloudBuildClient.ApproveBuildAsync(string, ApprovalResult, CancellationToken)

CloudBuildClient.CreateBuildTriggerAsync(CreateBuildTriggerRequest, CancellationToken)

CloudBuildClient.CreateBuildTrigger(string, BuildTrigger, CallSettings)

CloudBuildClient.CreateBuildTriggerAsync(string, BuildTrigger, CallSettings)

CloudBuildClient.CreateBuildTriggerAsync(string, BuildTrigger, CancellationToken)

CloudBuildClient.GetBuildTriggerAsync(GetBuildTriggerRequest, CancellationToken)

CloudBuildClient.GetBuildTrigger(string, string, CallSettings)

CloudBuildClient.GetBuildTriggerAsync(string, string, CallSettings)

CloudBuildClient.GetBuildTriggerAsync(string, string, CancellationToken)

CloudBuildClient.ListBuildTriggers(string, string, int?, CallSettings)

CloudBuildClient.ListBuildTriggersAsync(string, string, int?, CallSettings)

CloudBuildClient.DeleteBuildTriggerAsync(DeleteBuildTriggerRequest, CancellationToken)

CloudBuildClient.DeleteBuildTrigger(string, string, CallSettings)

CloudBuildClient.DeleteBuildTriggerAsync(string, string, CallSettings)

CloudBuildClient.DeleteBuildTriggerAsync(string, string, CancellationToken)

CloudBuildClient.UpdateBuildTriggerAsync(UpdateBuildTriggerRequest, CancellationToken)

CloudBuildClient.UpdateBuildTrigger(string, string, BuildTrigger, CallSettings)

CloudBuildClient.UpdateBuildTriggerAsync(string, string, BuildTrigger, CallSettings)

CloudBuildClient.UpdateBuildTriggerAsync(string, string, BuildTrigger, CancellationToken)

CloudBuildClient.RunBuildTriggerAsync(RunBuildTriggerRequest, CancellationToken)

CloudBuildClient.PollOnceRunBuildTrigger(string, CallSettings)

CloudBuildClient.PollOnceRunBuildTriggerAsync(string, CallSettings)

CloudBuildClient.RunBuildTrigger(string, string, RepoSource, CallSettings)

CloudBuildClient.RunBuildTriggerAsync(string, string, RepoSource, CallSettings)

CloudBuildClient.RunBuildTriggerAsync(string, string, RepoSource, CancellationToken)

CloudBuildClient.ReceiveTriggerWebhookAsync(ReceiveTriggerWebhookRequest, CancellationToken)

CloudBuildClient.CreateWorkerPoolAsync(CreateWorkerPoolRequest, CancellationToken)

CloudBuildClient.PollOnceCreateWorkerPool(string, CallSettings)

CloudBuildClient.PollOnceCreateWorkerPoolAsync(string, CallSettings)

CloudBuildClient.CreateWorkerPool(string, WorkerPool, string, CallSettings)

CloudBuildClient.CreateWorkerPoolAsync(string, WorkerPool, string, CallSettings)

CloudBuildClient.CreateWorkerPoolAsync(string, WorkerPool, string, CancellationToken)

CloudBuildClient.CreateWorkerPool(LocationName, WorkerPool, string, CallSettings)

CloudBuildClient.CreateWorkerPoolAsync(LocationName, WorkerPool, string, CallSettings)

CloudBuildClient.CreateWorkerPoolAsync(LocationName, WorkerPool, string, CancellationToken)

CloudBuildClient.GetWorkerPoolAsync(GetWorkerPoolRequest, CancellationToken)

CloudBuildClient.GetWorkerPool(string, CallSettings)

CloudBuildClient.GetWorkerPoolAsync(string, CallSettings)

CloudBuildClient.GetWorkerPoolAsync(string, CancellationToken)

CloudBuildClient.GetWorkerPool(WorkerPoolName, CallSettings)

CloudBuildClient.GetWorkerPoolAsync(WorkerPoolName, CallSettings)

CloudBuildClient.GetWorkerPoolAsync(WorkerPoolName, CancellationToken)

CloudBuildClient.DeleteWorkerPoolAsync(DeleteWorkerPoolRequest, CancellationToken)

CloudBuildClient.PollOnceDeleteWorkerPool(string, CallSettings)

CloudBuildClient.PollOnceDeleteWorkerPoolAsync(string, CallSettings)

CloudBuildClient.DeleteWorkerPool(string, CallSettings)

CloudBuildClient.DeleteWorkerPoolAsync(string, CallSettings)

CloudBuildClient.DeleteWorkerPoolAsync(string, CancellationToken)

CloudBuildClient.DeleteWorkerPool(WorkerPoolName, CallSettings)

CloudBuildClient.DeleteWorkerPoolAsync(WorkerPoolName, CallSettings)

CloudBuildClient.DeleteWorkerPoolAsync(WorkerPoolName, CancellationToken)

CloudBuildClient.UpdateWorkerPoolAsync(UpdateWorkerPoolRequest, CancellationToken)

CloudBuildClient.PollOnceUpdateWorkerPool(string, CallSettings)

CloudBuildClient.PollOnceUpdateWorkerPoolAsync(string, CallSettings)

CloudBuildClient.UpdateWorkerPool(WorkerPool, FieldMask, CallSettings)

CloudBuildClient.UpdateWorkerPoolAsync(WorkerPool, FieldMask, CallSettings)

CloudBuildClient.UpdateWorkerPoolAsync(WorkerPool, FieldMask, CancellationToken)

CloudBuildClient.ListWorkerPools(string, string, int?, CallSettings)

CloudBuildClient.ListWorkerPoolsAsync(string, string, int?, CallSettings)

CloudBuildClient.ListWorkerPools(LocationName, string, int?, CallSettings)

CloudBuildClient.ListWorkerPoolsAsync(LocationName, string, int?, CallSettings)

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.CloudBuild.V1

Assembly

Google.Cloud.CloudBuild.V1.dll

Remarks

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.

Constructors

CloudBuildClientImpl(CloudBuildClient, CloudBuildSettings, ILogger)

public CloudBuildClientImpl(CloudBuild.CloudBuildClient grpcClient, CloudBuildSettings settings, ILogger logger)

Constructs a client wrapper for the CloudBuild service, with the specified gRPC client and settings.

Parameters
Name	Description
grpcClient	CloudBuildCloudBuildClient The underlying gRPC client.
settings	CloudBuildSettings The base CloudBuildSettings used within this client.
logger	ILogger Optional ILogger to use within this client.

Properties

ApproveBuildOperationsClient

public override OperationsClient ApproveBuildOperationsClient { get; }

The long-running operations client for ApproveBuild.

Property Value
Type	Description
OperationsClient

Overrides

CloudBuildClient.ApproveBuildOperationsClient

CreateBuildOperationsClient

public override OperationsClient CreateBuildOperationsClient { get; }

The long-running operations client for CreateBuild.

Property Value
Type	Description
OperationsClient

Overrides

CloudBuildClient.CreateBuildOperationsClient

CreateWorkerPoolOperationsClient

public override OperationsClient CreateWorkerPoolOperationsClient { get; }

The long-running operations client for CreateWorkerPool.

Property Value
Type	Description
OperationsClient

Overrides

CloudBuildClient.CreateWorkerPoolOperationsClient

DeleteWorkerPoolOperationsClient

public override OperationsClient DeleteWorkerPoolOperationsClient { get; }

The long-running operations client for DeleteWorkerPool.

Property Value
Type	Description
OperationsClient

Overrides

CloudBuildClient.DeleteWorkerPoolOperationsClient

GrpcClient

public override CloudBuild.CloudBuildClient GrpcClient { get; }

The underlying gRPC CloudBuild client

Property Value
Type	Description
CloudBuildCloudBuildClient

Overrides

CloudBuildClient.GrpcClient

RetryBuildOperationsClient

public override OperationsClient RetryBuildOperationsClient { get; }

The long-running operations client for RetryBuild.

Property Value
Type	Description
OperationsClient

Overrides

CloudBuildClient.RetryBuildOperationsClient

RunBuildTriggerOperationsClient

public override OperationsClient RunBuildTriggerOperationsClient { get; }

The long-running operations client for RunBuildTrigger.

Property Value
Type	Description
OperationsClient

Overrides

CloudBuildClient.RunBuildTriggerOperationsClient

UpdateWorkerPoolOperationsClient

public override OperationsClient UpdateWorkerPoolOperationsClient { get; }

The long-running operations client for UpdateWorkerPool.

Property Value
Type	Description
OperationsClient

Overrides

CloudBuildClient.UpdateWorkerPoolOperationsClient

Methods

ApproveBuild(ApproveBuildRequest, CallSettings)

public override Operation<Build, BuildOperationMetadata> ApproveBuild(ApproveBuildRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
OperationBuildBuildOperationMetadata	The RPC response.

Overrides

CloudBuildClient.ApproveBuild(ApproveBuildRequest, CallSettings)

ApproveBuildAsync(ApproveBuildRequest, CallSettings)

public override Task<Operation<Build, BuildOperationMetadata>> ApproveBuildAsync(ApproveBuildRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskOperationBuildBuildOperationMetadata	A Task containing the RPC response.

Overrides

CloudBuildClient.ApproveBuildAsync(ApproveBuildRequest, CallSettings)

CancelBuild(CancelBuildRequest, CallSettings)

public override Build CancelBuild(CancelBuildRequest request, CallSettings callSettings = null)

Cancels a build in progress.

Parameters
Name	Description
request	CancelBuildRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Build	The RPC response.

Overrides

CloudBuildClient.CancelBuild(CancelBuildRequest, CallSettings)

CancelBuildAsync(CancelBuildRequest, CallSettings)

public override Task<Build> CancelBuildAsync(CancelBuildRequest request, CallSettings callSettings = null)

Cancels a build in progress.

Parameters
Name	Description
request	CancelBuildRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskBuild	A Task containing the RPC response.

Overrides

CloudBuildClient.CancelBuildAsync(CancelBuildRequest, CallSettings)

CreateBuild(CreateBuildRequest, CallSettings)

public override Operation<Build, BuildOperationMetadata> CreateBuild(CreateBuildRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
OperationBuildBuildOperationMetadata	The RPC response.

Overrides

CloudBuildClient.CreateBuild(CreateBuildRequest, CallSettings)

CreateBuildAsync(CreateBuildRequest, CallSettings)

public override Task<Operation<Build, BuildOperationMetadata>> CreateBuildAsync(CreateBuildRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskOperationBuildBuildOperationMetadata	A Task containing the RPC response.

Overrides

CloudBuildClient.CreateBuildAsync(CreateBuildRequest, CallSettings)

CreateBuildTrigger(CreateBuildTriggerRequest, CallSettings)

public override BuildTrigger CreateBuildTrigger(CreateBuildTriggerRequest request, CallSettings callSettings = null)

Creates a new BuildTrigger.

This API is experimental.

Parameters
Name	Description
request	CreateBuildTriggerRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
BuildTrigger	The RPC response.

Overrides

CloudBuildClient.CreateBuildTrigger(CreateBuildTriggerRequest, CallSettings)

CreateBuildTriggerAsync(CreateBuildTriggerRequest, CallSettings)

public override Task<BuildTrigger> CreateBuildTriggerAsync(CreateBuildTriggerRequest request, CallSettings callSettings = null)

Creates a new BuildTrigger.

This API is experimental.

Parameters
Name	Description
request	CreateBuildTriggerRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskBuildTrigger	A Task containing the RPC response.

Overrides

CloudBuildClient.CreateBuildTriggerAsync(CreateBuildTriggerRequest, CallSettings)

CreateWorkerPool(CreateWorkerPoolRequest, CallSettings)

public override Operation<WorkerPool, CreateWorkerPoolOperationMetadata> CreateWorkerPool(CreateWorkerPoolRequest request, CallSettings callSettings = null)

Creates a WorkerPool.

Parameters
Name	Description
request	CreateWorkerPoolRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
OperationWorkerPoolCreateWorkerPoolOperationMetadata	The RPC response.

Overrides

CloudBuildClient.CreateWorkerPool(CreateWorkerPoolRequest, CallSettings)

CreateWorkerPoolAsync(CreateWorkerPoolRequest, CallSettings)

public override Task<Operation<WorkerPool, CreateWorkerPoolOperationMetadata>> CreateWorkerPoolAsync(CreateWorkerPoolRequest request, CallSettings callSettings = null)

Creates a WorkerPool.

Parameters
Name	Description
request	CreateWorkerPoolRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskOperationWorkerPoolCreateWorkerPoolOperationMetadata	A Task containing the RPC response.

Overrides

CloudBuildClient.CreateWorkerPoolAsync(CreateWorkerPoolRequest, CallSettings)

DeleteBuildTrigger(DeleteBuildTriggerRequest, CallSettings)

public override void DeleteBuildTrigger(DeleteBuildTriggerRequest request, CallSettings callSettings = null)

Deletes a BuildTrigger by its project ID and trigger ID.

This API is experimental.

Parameters
Name	Description
request	DeleteBuildTriggerRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Overrides

CloudBuildClient.DeleteBuildTrigger(DeleteBuildTriggerRequest, CallSettings)

DeleteBuildTriggerAsync(DeleteBuildTriggerRequest, CallSettings)

public override Task DeleteBuildTriggerAsync(DeleteBuildTriggerRequest request, CallSettings callSettings = null)

Deletes a BuildTrigger by its project ID and trigger ID.

This API is experimental.

Parameters
Name	Description
request	DeleteBuildTriggerRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Task	A Task containing the RPC response.

Overrides

CloudBuildClient.DeleteBuildTriggerAsync(DeleteBuildTriggerRequest, CallSettings)

DeleteWorkerPool(DeleteWorkerPoolRequest, CallSettings)

public override Operation<Empty, DeleteWorkerPoolOperationMetadata> DeleteWorkerPool(DeleteWorkerPoolRequest request, CallSettings callSettings = null)

Deletes a WorkerPool.

Parameters
Name	Description
request	DeleteWorkerPoolRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
OperationEmptyDeleteWorkerPoolOperationMetadata	The RPC response.

Overrides

CloudBuildClient.DeleteWorkerPool(DeleteWorkerPoolRequest, CallSettings)

DeleteWorkerPoolAsync(DeleteWorkerPoolRequest, CallSettings)

public override Task<Operation<Empty, DeleteWorkerPoolOperationMetadata>> DeleteWorkerPoolAsync(DeleteWorkerPoolRequest request, CallSettings callSettings = null)

Deletes a WorkerPool.

Parameters
Name	Description
request	DeleteWorkerPoolRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskOperationEmptyDeleteWorkerPoolOperationMetadata	A Task containing the RPC response.

Overrides

CloudBuildClient.DeleteWorkerPoolAsync(DeleteWorkerPoolRequest, CallSettings)

GetBuild(GetBuildRequest, CallSettings)

public override Build GetBuild(GetBuildRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Build	The RPC response.

Overrides

CloudBuildClient.GetBuild(GetBuildRequest, CallSettings)

GetBuildAsync(GetBuildRequest, CallSettings)

public override Task<Build> GetBuildAsync(GetBuildRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskBuild	A Task containing the RPC response.

Overrides

CloudBuildClient.GetBuildAsync(GetBuildRequest, CallSettings)

GetBuildTrigger(GetBuildTriggerRequest, CallSettings)

public override BuildTrigger GetBuildTrigger(GetBuildTriggerRequest request, CallSettings callSettings = null)

Returns information about a BuildTrigger.

This API is experimental.

Parameters
Name	Description
request	GetBuildTriggerRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
BuildTrigger	The RPC response.

Overrides

CloudBuildClient.GetBuildTrigger(GetBuildTriggerRequest, CallSettings)

GetBuildTriggerAsync(GetBuildTriggerRequest, CallSettings)

public override Task<BuildTrigger> GetBuildTriggerAsync(GetBuildTriggerRequest request, CallSettings callSettings = null)

Returns information about a BuildTrigger.

This API is experimental.

Parameters
Name	Description
request	GetBuildTriggerRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskBuildTrigger	A Task containing the RPC response.

Overrides

CloudBuildClient.GetBuildTriggerAsync(GetBuildTriggerRequest, CallSettings)

GetWorkerPool(GetWorkerPoolRequest, CallSettings)

public override WorkerPool GetWorkerPool(GetWorkerPoolRequest request, CallSettings callSettings = null)

Returns details of a WorkerPool.

Parameters
Name	Description
request	GetWorkerPoolRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
WorkerPool	The RPC response.

Overrides

CloudBuildClient.GetWorkerPool(GetWorkerPoolRequest, CallSettings)

GetWorkerPoolAsync(GetWorkerPoolRequest, CallSettings)

public override Task<WorkerPool> GetWorkerPoolAsync(GetWorkerPoolRequest request, CallSettings callSettings = null)

Returns details of a WorkerPool.

Parameters
Name	Description
request	GetWorkerPoolRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskWorkerPool	A Task containing the RPC response.

Overrides

CloudBuildClient.GetWorkerPoolAsync(GetWorkerPoolRequest, CallSettings)

ListBuildTriggers(ListBuildTriggersRequest, CallSettings)

public override PagedEnumerable<ListBuildTriggersResponse, BuildTrigger> ListBuildTriggers(ListBuildTriggersRequest request, CallSettings callSettings = null)

Lists existing BuildTriggers.

This API is experimental.

Parameters
Name	Description
request	ListBuildTriggersRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
PagedEnumerableListBuildTriggersResponseBuildTrigger	A pageable sequence of BuildTrigger resources.

Overrides

CloudBuildClient.ListBuildTriggers(ListBuildTriggersRequest, CallSettings)

ListBuildTriggersAsync(ListBuildTriggersRequest, CallSettings)

public override PagedAsyncEnumerable<ListBuildTriggersResponse, BuildTrigger> ListBuildTriggersAsync(ListBuildTriggersRequest request, CallSettings callSettings = null)

Lists existing BuildTriggers.

This API is experimental.

Parameters
Name	Description
request	ListBuildTriggersRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
PagedAsyncEnumerableListBuildTriggersResponseBuildTrigger	A pageable asynchronous sequence of BuildTrigger resources.

Overrides

CloudBuildClient.ListBuildTriggersAsync(ListBuildTriggersRequest, CallSettings)

ListBuilds(ListBuildsRequest, CallSettings)

public override PagedEnumerable<ListBuildsResponse, Build> ListBuilds(ListBuildsRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
PagedEnumerableListBuildsResponseBuild	A pageable sequence of Build resources.

Overrides

CloudBuildClient.ListBuilds(ListBuildsRequest, CallSettings)

ListBuildsAsync(ListBuildsRequest, CallSettings)

public override PagedAsyncEnumerable<ListBuildsResponse, Build> ListBuildsAsync(ListBuildsRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
PagedAsyncEnumerableListBuildsResponseBuild	A pageable asynchronous sequence of Build resources.

Overrides

CloudBuildClient.ListBuildsAsync(ListBuildsRequest, CallSettings)

ListWorkerPools(ListWorkerPoolsRequest, CallSettings)

public override PagedEnumerable<ListWorkerPoolsResponse, WorkerPool> ListWorkerPools(ListWorkerPoolsRequest request, CallSettings callSettings = null)

Lists WorkerPools.

Parameters
Name	Description
request	ListWorkerPoolsRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
PagedEnumerableListWorkerPoolsResponseWorkerPool	A pageable sequence of WorkerPool resources.

Overrides

CloudBuildClient.ListWorkerPools(ListWorkerPoolsRequest, CallSettings)

ListWorkerPoolsAsync(ListWorkerPoolsRequest, CallSettings)

public override PagedAsyncEnumerable<ListWorkerPoolsResponse, WorkerPool> ListWorkerPoolsAsync(ListWorkerPoolsRequest request, CallSettings callSettings = null)

Lists WorkerPools.

Parameters
Name	Description
request	ListWorkerPoolsRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
PagedAsyncEnumerableListWorkerPoolsResponseWorkerPool	A pageable asynchronous sequence of WorkerPool resources.

Overrides

CloudBuildClient.ListWorkerPoolsAsync(ListWorkerPoolsRequest, CallSettings)

ReceiveTriggerWebhook(ReceiveTriggerWebhookRequest, CallSettings)

public override ReceiveTriggerWebhookResponse ReceiveTriggerWebhook(ReceiveTriggerWebhookRequest request, CallSettings callSettings = null)

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

Parameters
Name	Description
request	ReceiveTriggerWebhookRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
ReceiveTriggerWebhookResponse	The RPC response.

Overrides

CloudBuildClient.ReceiveTriggerWebhook(ReceiveTriggerWebhookRequest, CallSettings)

ReceiveTriggerWebhookAsync(ReceiveTriggerWebhookRequest, CallSettings)

public override Task<ReceiveTriggerWebhookResponse> ReceiveTriggerWebhookAsync(ReceiveTriggerWebhookRequest request, CallSettings callSettings = null)

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

Parameters
Name	Description
request	ReceiveTriggerWebhookRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskReceiveTriggerWebhookResponse	A Task containing the RPC response.

Overrides

CloudBuildClient.ReceiveTriggerWebhookAsync(ReceiveTriggerWebhookRequest, CallSettings)

RetryBuild(RetryBuildRequest, CallSettings)

public override Operation<Build, BuildOperationMetadata> RetryBuild(RetryBuildRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
OperationBuildBuildOperationMetadata	The RPC response.

Overrides

CloudBuildClient.RetryBuild(RetryBuildRequest, CallSettings)

RetryBuildAsync(RetryBuildRequest, CallSettings)

public override Task<Operation<Build, BuildOperationMetadata>> RetryBuildAsync(RetryBuildRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskOperationBuildBuildOperationMetadata	A Task containing the RPC response.

Overrides

CloudBuildClient.RetryBuildAsync(RetryBuildRequest, CallSettings)

RunBuildTrigger(RunBuildTriggerRequest, CallSettings)

public override Operation<Build, BuildOperationMetadata> RunBuildTrigger(RunBuildTriggerRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
OperationBuildBuildOperationMetadata	The RPC response.

Overrides

CloudBuildClient.RunBuildTrigger(RunBuildTriggerRequest, CallSettings)

RunBuildTriggerAsync(RunBuildTriggerRequest, CallSettings)

public override Task<Operation<Build, BuildOperationMetadata>> RunBuildTriggerAsync(RunBuildTriggerRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskOperationBuildBuildOperationMetadata	A Task containing the RPC response.

Overrides

CloudBuildClient.RunBuildTriggerAsync(RunBuildTriggerRequest, CallSettings)

UpdateBuildTrigger(UpdateBuildTriggerRequest, CallSettings)

public override BuildTrigger UpdateBuildTrigger(UpdateBuildTriggerRequest request, CallSettings callSettings = null)

Updates a BuildTrigger by its project ID and trigger ID.

This API is experimental.

Parameters
Name	Description
request	UpdateBuildTriggerRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
BuildTrigger	The RPC response.

Overrides

CloudBuildClient.UpdateBuildTrigger(UpdateBuildTriggerRequest, CallSettings)

UpdateBuildTriggerAsync(UpdateBuildTriggerRequest, CallSettings)

public override Task<BuildTrigger> UpdateBuildTriggerAsync(UpdateBuildTriggerRequest request, CallSettings callSettings = null)

Updates a BuildTrigger by its project ID and trigger ID.

This API is experimental.

Parameters
Name	Description
request	UpdateBuildTriggerRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskBuildTrigger	A Task containing the RPC response.

Overrides

CloudBuildClient.UpdateBuildTriggerAsync(UpdateBuildTriggerRequest, CallSettings)

UpdateWorkerPool(UpdateWorkerPoolRequest, CallSettings)

public override Operation<WorkerPool, UpdateWorkerPoolOperationMetadata> UpdateWorkerPool(UpdateWorkerPoolRequest request, CallSettings callSettings = null)

Updates a WorkerPool.

Parameters
Name	Description
request	UpdateWorkerPoolRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
OperationWorkerPoolUpdateWorkerPoolOperationMetadata	The RPC response.

Overrides

CloudBuildClient.UpdateWorkerPool(UpdateWorkerPoolRequest, CallSettings)

UpdateWorkerPoolAsync(UpdateWorkerPoolRequest, CallSettings)

public override Task<Operation<WorkerPool, UpdateWorkerPoolOperationMetadata>> UpdateWorkerPoolAsync(UpdateWorkerPoolRequest request, CallSettings callSettings = null)

Updates a WorkerPool.

Parameters
Name	Description
request	UpdateWorkerPoolRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskOperationWorkerPoolUpdateWorkerPoolOperationMetadata	A Task containing the RPC response.

Overrides

CloudBuildClient.UpdateWorkerPoolAsync(UpdateWorkerPoolRequest, CallSettings)