Google Cloud Deploy v1 API - Class CloudDeploySettings (2.4.0)

public sealed class CloudDeploySettings : ServiceSettingsBase

Reference documentation and code samples for the Google Cloud Deploy v1 API class CloudDeploySettings.

Settings for CloudDeployClient instances.

Inheritance

object > ServiceSettingsBase > CloudDeploySettings

Inherited Members

ServiceSettingsBase.VersionHeaderBuilder

ServiceSettingsBase.CallSettings

ServiceSettingsBase.Clock

ServiceSettingsBase.Scheduler

ServiceSettingsBase.Interceptor

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.Deploy.V1

Assembly

Google.Cloud.Deploy.V1.dll

Constructors

CloudDeploySettings()

public CloudDeploySettings()

Constructs a new CloudDeploySettings object with default settings.

Properties

AbandonReleaseSettings

public CallSettings AbandonReleaseSettings { get; set; }

CallSettings for synchronous and asynchronous calls to CloudDeployClient.AbandonRelease and CloudDeployClient.AbandonReleaseAsync.

Property Value
Type	Description
`CallSettings`

Remarks

This call will not be retried.
Timeout: 60 seconds.

AdvanceRolloutSettings

public CallSettings AdvanceRolloutSettings { get; set; }

CallSettings for synchronous and asynchronous calls to CloudDeployClient.AdvanceRollout and CloudDeployClient.AdvanceRolloutAsync.

Property Value
Type	Description
`CallSettings`

Remarks

This call will not be retried.
Timeout: 60 seconds.

ApproveRolloutSettings

public CallSettings ApproveRolloutSettings { get; set; }

CallSettings for synchronous and asynchronous calls to CloudDeployClient.ApproveRollout and CloudDeployClient.ApproveRolloutAsync.

Property Value
Type	Description
`CallSettings`

Remarks

This call will not be retried.
Timeout: 60 seconds.

CancelRolloutSettings

public CallSettings CancelRolloutSettings { get; set; }

CallSettings for synchronous and asynchronous calls to CloudDeployClient.CancelRollout and CloudDeployClient.CancelRolloutAsync.

Property Value
Type	Description
`CallSettings`

Remarks

This call will not be retried.
Timeout: 60 seconds.

CreateDeliveryPipelineOperationsSettings

public OperationsSettings CreateDeliveryPipelineOperationsSettings { get; set; }

Long Running Operation settings for calls to CloudDeployClient.CreateDeliveryPipeline and CloudDeployClient.CreateDeliveryPipelineAsync.

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.

CreateDeliveryPipelineSettings

public CallSettings CreateDeliveryPipelineSettings { get; set; }

CallSettings for synchronous and asynchronous calls to CloudDeployClient.CreateDeliveryPipeline and CloudDeployClient.CreateDeliveryPipelineAsync.

Property Value
Type	Description
`CallSettings`

Remarks

This call will not be retried.
Timeout: 60 seconds.

CreateReleaseOperationsSettings

public OperationsSettings CreateReleaseOperationsSettings { get; set; }

Long Running Operation settings for calls to CloudDeployClient.CreateRelease and CloudDeployClient.CreateReleaseAsync.

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.

CreateReleaseSettings

public CallSettings CreateReleaseSettings { get; set; }

CallSettings for synchronous and asynchronous calls to CloudDeployClient.CreateRelease and CloudDeployClient.CreateReleaseAsync.

Property Value
Type	Description
`CallSettings`

Remarks

This call will not be retried.
Timeout: 60 seconds.

CreateRolloutOperationsSettings

public OperationsSettings CreateRolloutOperationsSettings { get; set; }

Long Running Operation settings for calls to CloudDeployClient.CreateRollout and CloudDeployClient.CreateRolloutAsync.

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.

CreateRolloutSettings

public CallSettings CreateRolloutSettings { get; set; }

CallSettings for synchronous and asynchronous calls to CloudDeployClient.CreateRollout and CloudDeployClient.CreateRolloutAsync.

Property Value
Type	Description
`CallSettings`

Remarks

This call will not be retried.
Timeout: 60 seconds.

CreateTargetOperationsSettings

public OperationsSettings CreateTargetOperationsSettings { get; set; }

Long Running Operation settings for calls to CloudDeployClient.CreateTarget and CloudDeployClient.CreateTargetAsync.

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.

CreateTargetSettings

public CallSettings CreateTargetSettings { get; set; }

CallSettings for synchronous and asynchronous calls to CloudDeployClient.CreateTarget and CloudDeployClient.CreateTargetAsync.

Property Value
Type	Description
`CallSettings`

Remarks

This call will not be retried.
Timeout: 60 seconds.

DeleteDeliveryPipelineOperationsSettings

public OperationsSettings DeleteDeliveryPipelineOperationsSettings { get; set; }

Long Running Operation settings for calls to CloudDeployClient.DeleteDeliveryPipeline and CloudDeployClient.DeleteDeliveryPipelineAsync.

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.

DeleteDeliveryPipelineSettings

public CallSettings DeleteDeliveryPipelineSettings { get; set; }

CallSettings for synchronous and asynchronous calls to CloudDeployClient.DeleteDeliveryPipeline and CloudDeployClient.DeleteDeliveryPipelineAsync.

Property Value
Type	Description
`CallSettings`

Remarks

This call will not be retried.
Timeout: 60 seconds.

DeleteTargetOperationsSettings

public OperationsSettings DeleteTargetOperationsSettings { get; set; }

Long Running Operation settings for calls to CloudDeployClient.DeleteTarget and CloudDeployClient.DeleteTargetAsync.

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.

DeleteTargetSettings

public CallSettings DeleteTargetSettings { get; set; }

CallSettings for synchronous and asynchronous calls to CloudDeployClient.DeleteTarget and CloudDeployClient.DeleteTargetAsync.

Property Value
Type	Description
`CallSettings`

Remarks

This call will not be retried.
Timeout: 60 seconds.

GetConfigSettings

public CallSettings GetConfigSettings { get; set; }

CallSettings for synchronous and asynchronous calls to CloudDeployClient.GetConfig and CloudDeployClient.GetConfigAsync.

Property Value
Type	Description
`CallSettings`

Remarks

Initial retry delay: 1000 milliseconds.
Retry delay multiplier: 1.3
Retry maximum delay: 60000 milliseconds.
Maximum attempts: Unlimited
Retriable status codes: Unavailable.
Timeout: 60 seconds.

GetDeliveryPipelineSettings

public CallSettings GetDeliveryPipelineSettings { get; set; }

CallSettings for synchronous and asynchronous calls to CloudDeployClient.GetDeliveryPipeline and CloudDeployClient.GetDeliveryPipelineAsync.

Property Value
Type	Description
`CallSettings`

Remarks

Initial retry delay: 1000 milliseconds.
Retry delay multiplier: 1.3
Retry maximum delay: 60000 milliseconds.
Maximum attempts: Unlimited
Retriable status codes: Unavailable.
Timeout: 60 seconds.

GetJobRunSettings

public CallSettings GetJobRunSettings { get; set; }

CallSettings for synchronous and asynchronous calls to CloudDeployClient.GetJobRun and CloudDeployClient.GetJobRunAsync.

Property Value
Type	Description
`CallSettings`

Remarks

Initial retry delay: 1000 milliseconds.
Retry delay multiplier: 1.3
Retry maximum delay: 60000 milliseconds.
Maximum attempts: Unlimited
Retriable status codes: Unavailable.
Timeout: 60 seconds.

GetReleaseSettings

public CallSettings GetReleaseSettings { get; set; }

CallSettings for synchronous and asynchronous calls to CloudDeployClient.GetRelease and CloudDeployClient.GetReleaseAsync.

Property Value
Type	Description
`CallSettings`

Remarks

Initial retry delay: 1000 milliseconds.
Retry delay multiplier: 1.3
Retry maximum delay: 60000 milliseconds.
Maximum attempts: Unlimited
Retriable status codes: Unavailable.
Timeout: 60 seconds.

GetRolloutSettings

public CallSettings GetRolloutSettings { get; set; }

CallSettings for synchronous and asynchronous calls to CloudDeployClient.GetRollout and CloudDeployClient.GetRolloutAsync.

Property Value
Type	Description
`CallSettings`

Remarks

Initial retry delay: 1000 milliseconds.
Retry delay multiplier: 1.3
Retry maximum delay: 60000 milliseconds.
Maximum attempts: Unlimited
Retriable status codes: Unavailable.
Timeout: 60 seconds.

GetTargetSettings

public CallSettings GetTargetSettings { get; set; }

CallSettings for synchronous and asynchronous calls to CloudDeployClient.GetTarget and CloudDeployClient.GetTargetAsync.

Property Value
Type	Description
`CallSettings`

Remarks

Initial retry delay: 1000 milliseconds.
Retry delay multiplier: 1.3
Retry maximum delay: 60000 milliseconds.
Maximum attempts: Unlimited
Retriable status codes: Unavailable.
Timeout: 60 seconds.

IAMPolicySettings

public IAMPolicySettings IAMPolicySettings { get; set; }

The settings to use for the IAMPolicyClient associated with the client.

Property Value
Type	Description
`IAMPolicySettings`

IgnoreJobSettings

public CallSettings IgnoreJobSettings { get; set; }

CallSettings for synchronous and asynchronous calls to CloudDeployClient.IgnoreJob and CloudDeployClient.IgnoreJobAsync.

Property Value
Type	Description
`CallSettings`

Remarks

This call will not be retried.
Timeout: 60 seconds.

ListDeliveryPipelinesSettings

public CallSettings ListDeliveryPipelinesSettings { get; set; }

CallSettings for synchronous and asynchronous calls to CloudDeployClient.ListDeliveryPipelines and CloudDeployClient.ListDeliveryPipelinesAsync.

Property Value
Type	Description
`CallSettings`

Remarks

Initial retry delay: 1000 milliseconds.
Retry delay multiplier: 1.3
Retry maximum delay: 60000 milliseconds.
Maximum attempts: Unlimited
Retriable status codes: Unavailable.
Timeout: 60 seconds.

ListJobRunsSettings

public CallSettings ListJobRunsSettings { get; set; }

CallSettings for synchronous and asynchronous calls to CloudDeployClient.ListJobRuns and CloudDeployClient.ListJobRunsAsync.

Property Value
Type	Description
`CallSettings`

Remarks

Initial retry delay: 1000 milliseconds.
Retry delay multiplier: 1.3
Retry maximum delay: 60000 milliseconds.
Maximum attempts: Unlimited
Retriable status codes: Unavailable.
Timeout: 60 seconds.

ListReleasesSettings

public CallSettings ListReleasesSettings { get; set; }

CallSettings for synchronous and asynchronous calls to CloudDeployClient.ListReleases and CloudDeployClient.ListReleasesAsync.

Property Value
Type	Description
`CallSettings`

Remarks

Initial retry delay: 1000 milliseconds.
Retry delay multiplier: 1.3
Retry maximum delay: 60000 milliseconds.
Maximum attempts: Unlimited
Retriable status codes: Unavailable.
Timeout: 60 seconds.

ListRolloutsSettings

public CallSettings ListRolloutsSettings { get; set; }

CallSettings for synchronous and asynchronous calls to CloudDeployClient.ListRollouts and CloudDeployClient.ListRolloutsAsync.

Property Value
Type	Description
`CallSettings`

Remarks

Initial retry delay: 1000 milliseconds.
Retry delay multiplier: 1.3
Retry maximum delay: 60000 milliseconds.
Maximum attempts: Unlimited
Retriable status codes: Unavailable.
Timeout: 60 seconds.

ListTargetsSettings

public CallSettings ListTargetsSettings { get; set; }

CallSettings for synchronous and asynchronous calls to CloudDeployClient.ListTargets and CloudDeployClient.ListTargetsAsync.

Property Value
Type	Description
`CallSettings`

Remarks

Initial retry delay: 1000 milliseconds.
Retry delay multiplier: 1.3
Retry maximum delay: 60000 milliseconds.
Maximum attempts: Unlimited
Retriable status codes: Unavailable.
Timeout: 60 seconds.

LocationsSettings

public LocationsSettings LocationsSettings { get; set; }

The settings to use for the LocationsClient associated with the client.

Property Value
Type	Description
`LocationsSettings`

RetryJobSettings

public CallSettings RetryJobSettings { get; set; }

CallSettings for synchronous and asynchronous calls to CloudDeployClient.RetryJob and CloudDeployClient.RetryJobAsync.

Property Value
Type	Description
`CallSettings`

Remarks

This call will not be retried.
Timeout: 60 seconds.

TerminateJobRunSettings

public CallSettings TerminateJobRunSettings { get; set; }

CallSettings for synchronous and asynchronous calls to CloudDeployClient.TerminateJobRun and CloudDeployClient.TerminateJobRunAsync.

Property Value
Type	Description
`CallSettings`

Remarks

This call will not be retried.
Timeout: 60 seconds.

UpdateDeliveryPipelineOperationsSettings

public OperationsSettings UpdateDeliveryPipelineOperationsSettings { get; set; }

Long Running Operation settings for calls to CloudDeployClient.UpdateDeliveryPipeline and CloudDeployClient.UpdateDeliveryPipelineAsync.

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.

UpdateDeliveryPipelineSettings

public CallSettings UpdateDeliveryPipelineSettings { get; set; }

CallSettings for synchronous and asynchronous calls to CloudDeployClient.UpdateDeliveryPipeline and CloudDeployClient.UpdateDeliveryPipelineAsync.

Property Value
Type	Description
`CallSettings`

Remarks

This call will not be retried.
Timeout: 60 seconds.

UpdateTargetOperationsSettings

public OperationsSettings UpdateTargetOperationsSettings { get; set; }

Long Running Operation settings for calls to CloudDeployClient.UpdateTarget and CloudDeployClient.UpdateTargetAsync.

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.

UpdateTargetSettings

public CallSettings UpdateTargetSettings { get; set; }

CallSettings for synchronous and asynchronous calls to CloudDeployClient.UpdateTarget and CloudDeployClient.UpdateTargetAsync.

Property Value
Type	Description
`CallSettings`

Remarks

This call will not be retried.
Timeout: 60 seconds.

Methods

Clone()

public CloudDeploySettings Clone()

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

Returns
Type	Description
`CloudDeploySettings`	A deep clone of this CloudDeploySettings object.

GetDefault()

public static CloudDeploySettings GetDefault()

Get a new instance of the default CloudDeploySettings.

Returns
Type	Description
`CloudDeploySettings`	A new instance of the default CloudDeploySettings.