Cloud Build v1 API - Class CloudBuildSettings (2.11.0)

public sealed class CloudBuildSettings : ServiceSettingsBase

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

Settings for CloudBuildClient instances.

Inheritance

object > ServiceSettingsBase > CloudBuildSettings

Namespace

Google.Cloud.CloudBuild.V1

Assembly

Google.Cloud.CloudBuild.V1.dll

Constructors

CloudBuildSettings()

public CloudBuildSettings()

Constructs a new CloudBuildSettings object with default settings.

Properties

ApproveBuildOperationsSettings

public OperationsSettings ApproveBuildOperationsSettings { get; set; }

Long Running Operation settings for calls to CloudBuildClient.ApproveBuild and CloudBuildClient.ApproveBuildAsync.

Property Value
Type Description
OperationsSettings
Remarks

Uses default PollSettings of:

  • Initial delay: 20 seconds.
  • Delay multiplier: 1.5
  • Maximum delay: 45 seconds.
  • Total timeout: 24 hours.

ApproveBuildSettings

public CallSettings ApproveBuildSettings { get; set; }

CallSettings for synchronous and asynchronous calls to CloudBuildClient.ApproveBuild and CloudBuildClient.ApproveBuildAsync.

Property Value
Type Description
CallSettings
Remarks
  • This call will not be retried.
  • No timeout is applied.

CancelBuildSettings

public CallSettings CancelBuildSettings { get; set; }

CallSettings for synchronous and asynchronous calls to CloudBuildClient.CancelBuild and CloudBuildClient.CancelBuildAsync.

Property Value
Type Description
CallSettings
Remarks
  • This call will not be retried.
  • Timeout: 600 seconds.

CreateBuildOperationsSettings

public OperationsSettings CreateBuildOperationsSettings { get; set; }

Long Running Operation settings for calls to CloudBuildClient.CreateBuild and CloudBuildClient.CreateBuildAsync.

Property Value
Type Description
OperationsSettings
Remarks

Uses default PollSettings of:

  • Initial delay: 20 seconds.
  • Delay multiplier: 1.5
  • Maximum delay: 45 seconds.
  • Total timeout: 24 hours.

CreateBuildSettings

public CallSettings CreateBuildSettings { get; set; }

CallSettings for synchronous and asynchronous calls to CloudBuildClient.CreateBuild and CloudBuildClient.CreateBuildAsync.

Property Value
Type Description
CallSettings
Remarks
  • This call will not be retried.
  • Timeout: 600 seconds.

CreateBuildTriggerSettings

public CallSettings CreateBuildTriggerSettings { get; set; }

CallSettings for synchronous and asynchronous calls to CloudBuildClient.CreateBuildTrigger and CloudBuildClient.CreateBuildTriggerAsync.

Property Value
Type Description
CallSettings
Remarks
  • This call will not be retried.
  • Timeout: 600 seconds.

CreateWorkerPoolOperationsSettings

public OperationsSettings CreateWorkerPoolOperationsSettings { get; set; }

Long Running Operation settings for calls to CloudBuildClient.CreateWorkerPool and CloudBuildClient.CreateWorkerPoolAsync.

Property Value
Type Description
OperationsSettings
Remarks

Uses default PollSettings of:

  • Initial delay: 20 seconds.
  • Delay multiplier: 1.5
  • Maximum delay: 45 seconds.
  • Total timeout: 24 hours.

CreateWorkerPoolSettings

public CallSettings CreateWorkerPoolSettings { get; set; }

CallSettings for synchronous and asynchronous calls to CloudBuildClient.CreateWorkerPool and CloudBuildClient.CreateWorkerPoolAsync.

Property Value
Type Description
CallSettings
Remarks
  • This call will not be retried.
  • Timeout: 600 seconds.

DeleteBuildTriggerSettings

public CallSettings DeleteBuildTriggerSettings { get; set; }

CallSettings for synchronous and asynchronous calls to CloudBuildClient.DeleteBuildTrigger and CloudBuildClient.DeleteBuildTriggerAsync.

Property Value
Type Description
CallSettings
Remarks
  • Initial retry delay: 100 milliseconds.
  • Retry delay multiplier: 1.3
  • Retry maximum delay: 60000 milliseconds.
  • Maximum attempts: Unlimited
  • Retriable status codes: Unavailable, DeadlineExceeded.
  • Timeout: 600 seconds.

DeleteWorkerPoolOperationsSettings

public OperationsSettings DeleteWorkerPoolOperationsSettings { get; set; }

Long Running Operation settings for calls to CloudBuildClient.DeleteWorkerPool and CloudBuildClient.DeleteWorkerPoolAsync.

Property Value
Type Description
OperationsSettings
Remarks

Uses default PollSettings of:

  • Initial delay: 20 seconds.
  • Delay multiplier: 1.5
  • Maximum delay: 45 seconds.
  • Total timeout: 24 hours.

DeleteWorkerPoolSettings

public CallSettings DeleteWorkerPoolSettings { get; set; }

CallSettings for synchronous and asynchronous calls to CloudBuildClient.DeleteWorkerPool and CloudBuildClient.DeleteWorkerPoolAsync.

Property Value
Type Description
CallSettings
Remarks
  • This call will not be retried.
  • Timeout: 600 seconds.

GetBuildSettings

public CallSettings GetBuildSettings { get; set; }

CallSettings for synchronous and asynchronous calls to CloudBuildClient.GetBuild and CloudBuildClient.GetBuildAsync.

Property Value
Type Description
CallSettings
Remarks
  • Initial retry delay: 100 milliseconds.
  • Retry delay multiplier: 1.3
  • Retry maximum delay: 60000 milliseconds.
  • Maximum attempts: Unlimited
  • Retriable status codes: Unavailable, DeadlineExceeded.
  • Timeout: 600 seconds.

GetBuildTriggerSettings

public CallSettings GetBuildTriggerSettings { get; set; }

CallSettings for synchronous and asynchronous calls to CloudBuildClient.GetBuildTrigger and CloudBuildClient.GetBuildTriggerAsync.

Property Value
Type Description
CallSettings
Remarks
  • Initial retry delay: 100 milliseconds.
  • Retry delay multiplier: 1.3
  • Retry maximum delay: 60000 milliseconds.
  • Maximum attempts: Unlimited
  • Retriable status codes: Unavailable, DeadlineExceeded.
  • Timeout: 600 seconds.

GetWorkerPoolSettings

public CallSettings GetWorkerPoolSettings { get; set; }

CallSettings for synchronous and asynchronous calls to CloudBuildClient.GetWorkerPool and CloudBuildClient.GetWorkerPoolAsync.

Property Value
Type Description
CallSettings
Remarks
  • Initial retry delay: 100 milliseconds.
  • Retry delay multiplier: 1.3
  • Retry maximum delay: 60000 milliseconds.
  • Maximum attempts: Unlimited
  • Retriable status codes: Unavailable, DeadlineExceeded.
  • Timeout: 600 seconds.

ListBuildTriggersSettings

public CallSettings ListBuildTriggersSettings { get; set; }

CallSettings for synchronous and asynchronous calls to CloudBuildClient.ListBuildTriggers and CloudBuildClient.ListBuildTriggersAsync.

Property Value
Type Description
CallSettings
Remarks
  • Initial retry delay: 100 milliseconds.
  • Retry delay multiplier: 1.3
  • Retry maximum delay: 60000 milliseconds.
  • Maximum attempts: Unlimited
  • Retriable status codes: Unavailable, DeadlineExceeded.
  • Timeout: 600 seconds.

ListBuildsSettings

public CallSettings ListBuildsSettings { get; set; }

CallSettings for synchronous and asynchronous calls to CloudBuildClient.ListBuilds and CloudBuildClient.ListBuildsAsync.

Property Value
Type Description
CallSettings
Remarks
  • Initial retry delay: 100 milliseconds.
  • Retry delay multiplier: 1.3
  • Retry maximum delay: 60000 milliseconds.
  • Maximum attempts: Unlimited
  • Retriable status codes: Unavailable, DeadlineExceeded.
  • Timeout: 600 seconds.

ListWorkerPoolsSettings

public CallSettings ListWorkerPoolsSettings { get; set; }

CallSettings for synchronous and asynchronous calls to CloudBuildClient.ListWorkerPools and CloudBuildClient.ListWorkerPoolsAsync.

Property Value
Type Description
CallSettings
Remarks
  • Initial retry delay: 100 milliseconds.
  • Retry delay multiplier: 1.3
  • Retry maximum delay: 60000 milliseconds.
  • Maximum attempts: Unlimited
  • Retriable status codes: Unavailable, DeadlineExceeded.
  • Timeout: 600 seconds.

ReceiveTriggerWebhookSettings

public CallSettings ReceiveTriggerWebhookSettings { get; set; }

CallSettings for synchronous and asynchronous calls to CloudBuildClient.ReceiveTriggerWebhook and CloudBuildClient.ReceiveTriggerWebhookAsync.

Property Value
Type Description
CallSettings
Remarks
  • This call will not be retried.
  • No timeout is applied.

RetryBuildOperationsSettings

public OperationsSettings RetryBuildOperationsSettings { get; set; }

Long Running Operation settings for calls to CloudBuildClient.RetryBuild and CloudBuildClient.RetryBuildAsync.

Property Value
Type Description
OperationsSettings
Remarks

Uses default PollSettings of:

  • Initial delay: 20 seconds.
  • Delay multiplier: 1.5
  • Maximum delay: 45 seconds.
  • Total timeout: 24 hours.

RetryBuildSettings

public CallSettings RetryBuildSettings { get; set; }

CallSettings for synchronous and asynchronous calls to CloudBuildClient.RetryBuild and CloudBuildClient.RetryBuildAsync.

Property Value
Type Description
CallSettings
Remarks
  • This call will not be retried.
  • Timeout: 600 seconds.

RunBuildTriggerOperationsSettings

public OperationsSettings RunBuildTriggerOperationsSettings { get; set; }

Long Running Operation settings for calls to CloudBuildClient.RunBuildTrigger and CloudBuildClient.RunBuildTriggerAsync.

Property Value
Type Description
OperationsSettings
Remarks

Uses default PollSettings of:

  • Initial delay: 20 seconds.
  • Delay multiplier: 1.5
  • Maximum delay: 45 seconds.
  • Total timeout: 24 hours.

RunBuildTriggerSettings

public CallSettings RunBuildTriggerSettings { get; set; }

CallSettings for synchronous and asynchronous calls to CloudBuildClient.RunBuildTrigger and CloudBuildClient.RunBuildTriggerAsync.

Property Value
Type Description
CallSettings
Remarks
  • This call will not be retried.
  • Timeout: 600 seconds.

UpdateBuildTriggerSettings

public CallSettings UpdateBuildTriggerSettings { get; set; }

CallSettings for synchronous and asynchronous calls to CloudBuildClient.UpdateBuildTrigger and CloudBuildClient.UpdateBuildTriggerAsync.

Property Value
Type Description
CallSettings
Remarks
  • This call will not be retried.
  • Timeout: 600 seconds.

UpdateWorkerPoolOperationsSettings

public OperationsSettings UpdateWorkerPoolOperationsSettings { get; set; }

Long Running Operation settings for calls to CloudBuildClient.UpdateWorkerPool and CloudBuildClient.UpdateWorkerPoolAsync.

Property Value
Type Description
OperationsSettings
Remarks

Uses default PollSettings of:

  • Initial delay: 20 seconds.
  • Delay multiplier: 1.5
  • Maximum delay: 45 seconds.
  • Total timeout: 24 hours.

UpdateWorkerPoolSettings

public CallSettings UpdateWorkerPoolSettings { get; set; }

CallSettings for synchronous and asynchronous calls to CloudBuildClient.UpdateWorkerPool and CloudBuildClient.UpdateWorkerPoolAsync.

Property Value
Type Description
CallSettings
Remarks
  • This call will not be retried.
  • Timeout: 600 seconds.

Methods

Clone()

public CloudBuildSettings Clone()

Creates a deep clone of this object, with all the same property values.

Returns
Type Description
CloudBuildSettings

A deep clone of this CloudBuildSettings object.

GetDefault()

public static CloudBuildSettings GetDefault()

Get a new instance of the default CloudBuildSettings.

Returns
Type Description
CloudBuildSettings

A new instance of the default CloudBuildSettings.