AlloyDB v1 API - Class AlloyDBAdminSettings (1.6.0)

public sealed class AlloyDBAdminSettings : ServiceSettingsBase

Reference documentation and code samples for the AlloyDB v1 API class AlloyDBAdminSettings.

Settings for AlloyDBAdminClient instances.

Inheritance

object > ServiceSettingsBase > AlloyDBAdminSettings

Inherited Members

ServiceSettingsBase.VersionHeaderBuilder

ServiceSettingsBase.CallSettings

ServiceSettingsBase.Clock

ServiceSettingsBase.Scheduler

ServiceSettingsBase.Interceptor

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.AlloyDb.V1

Assembly

Google.Cloud.AlloyDb.V1.dll

Constructors

AlloyDBAdminSettings()

public AlloyDBAdminSettings()

Constructs a new AlloyDBAdminSettings object with default settings.

Properties

BatchCreateInstancesOperationsSettings

public OperationsSettings BatchCreateInstancesOperationsSettings { get; set; }

Long Running Operation settings for calls to AlloyDBAdminClient.BatchCreateInstances and AlloyDBAdminClient.BatchCreateInstancesAsync.

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.

BatchCreateInstancesSettings

public CallSettings BatchCreateInstancesSettings { get; set; }

CallSettings for synchronous and asynchronous calls to AlloyDBAdminClient.BatchCreateInstances and AlloyDBAdminClient.BatchCreateInstancesAsync.

Property Value
Type	Description
`CallSettings`

Remarks

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

CreateBackupOperationsSettings

public OperationsSettings CreateBackupOperationsSettings { get; set; }

Long Running Operation settings for calls to AlloyDBAdminClient.CreateBackup and AlloyDBAdminClient.CreateBackupAsync.

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.

CreateBackupSettings

public CallSettings CreateBackupSettings { get; set; }

CallSettings for synchronous and asynchronous calls to AlloyDBAdminClient.CreateBackup and AlloyDBAdminClient.CreateBackupAsync.

Property Value
Type	Description
`CallSettings`

Remarks

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

CreateClusterOperationsSettings

public OperationsSettings CreateClusterOperationsSettings { get; set; }

Long Running Operation settings for calls to AlloyDBAdminClient.CreateCluster and AlloyDBAdminClient.CreateClusterAsync.

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.

CreateClusterSettings

public CallSettings CreateClusterSettings { get; set; }

CallSettings for synchronous and asynchronous calls to AlloyDBAdminClient.CreateCluster and AlloyDBAdminClient.CreateClusterAsync.

Property Value
Type	Description
`CallSettings`

Remarks

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

CreateInstanceOperationsSettings

public OperationsSettings CreateInstanceOperationsSettings { get; set; }

Long Running Operation settings for calls to AlloyDBAdminClient.CreateInstance and AlloyDBAdminClient.CreateInstanceAsync.

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.

CreateInstanceSettings

public CallSettings CreateInstanceSettings { get; set; }

CallSettings for synchronous and asynchronous calls to AlloyDBAdminClient.CreateInstance and AlloyDBAdminClient.CreateInstanceAsync.

Property Value
Type	Description
`CallSettings`

Remarks

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

CreateSecondaryClusterOperationsSettings

public OperationsSettings CreateSecondaryClusterOperationsSettings { get; set; }

Long Running Operation settings for calls to AlloyDBAdminClient.CreateSecondaryCluster and AlloyDBAdminClient.CreateSecondaryClusterAsync.

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.

CreateSecondaryClusterSettings

public CallSettings CreateSecondaryClusterSettings { get; set; }

CallSettings for synchronous and asynchronous calls to AlloyDBAdminClient.CreateSecondaryCluster and AlloyDBAdminClient.CreateSecondaryClusterAsync.

Property Value
Type	Description
`CallSettings`

Remarks

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

CreateSecondaryInstanceOperationsSettings

public OperationsSettings CreateSecondaryInstanceOperationsSettings { get; set; }

Long Running Operation settings for calls to AlloyDBAdminClient.CreateSecondaryInstance and AlloyDBAdminClient.CreateSecondaryInstanceAsync.

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.

CreateSecondaryInstanceSettings

public CallSettings CreateSecondaryInstanceSettings { get; set; }

CallSettings for synchronous and asynchronous calls to AlloyDBAdminClient.CreateSecondaryInstance and AlloyDBAdminClient.CreateSecondaryInstanceAsync .

Property Value
Type	Description
`CallSettings`

Remarks

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

CreateUserSettings

public CallSettings CreateUserSettings { get; set; }

CallSettings for synchronous and asynchronous calls to AlloyDBAdminClient.CreateUser and AlloyDBAdminClient.CreateUserAsync.

Property Value
Type	Description
`CallSettings`

Remarks

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

DeleteBackupOperationsSettings

public OperationsSettings DeleteBackupOperationsSettings { get; set; }

Long Running Operation settings for calls to AlloyDBAdminClient.DeleteBackup and AlloyDBAdminClient.DeleteBackupAsync.

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.

DeleteBackupSettings

public CallSettings DeleteBackupSettings { get; set; }

CallSettings for synchronous and asynchronous calls to AlloyDBAdminClient.DeleteBackup and AlloyDBAdminClient.DeleteBackupAsync.

Property Value
Type	Description
`CallSettings`

Remarks

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

DeleteClusterOperationsSettings

public OperationsSettings DeleteClusterOperationsSettings { get; set; }

Long Running Operation settings for calls to AlloyDBAdminClient.DeleteCluster and AlloyDBAdminClient.DeleteClusterAsync.

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.

DeleteClusterSettings

public CallSettings DeleteClusterSettings { get; set; }

CallSettings for synchronous and asynchronous calls to AlloyDBAdminClient.DeleteCluster and AlloyDBAdminClient.DeleteClusterAsync.

Property Value
Type	Description
`CallSettings`

Remarks

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

DeleteInstanceOperationsSettings

public OperationsSettings DeleteInstanceOperationsSettings { get; set; }

Long Running Operation settings for calls to AlloyDBAdminClient.DeleteInstance and AlloyDBAdminClient.DeleteInstanceAsync.

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.

DeleteInstanceSettings

public CallSettings DeleteInstanceSettings { get; set; }

CallSettings for synchronous and asynchronous calls to AlloyDBAdminClient.DeleteInstance and AlloyDBAdminClient.DeleteInstanceAsync.

Property Value
Type	Description
`CallSettings`

Remarks

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

DeleteUserSettings

public CallSettings DeleteUserSettings { get; set; }

CallSettings for synchronous and asynchronous calls to AlloyDBAdminClient.DeleteUser and AlloyDBAdminClient.DeleteUserAsync.

Property Value
Type	Description
`CallSettings`

Remarks

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

FailoverInstanceOperationsSettings

public OperationsSettings FailoverInstanceOperationsSettings { get; set; }

Long Running Operation settings for calls to AlloyDBAdminClient.FailoverInstance and AlloyDBAdminClient.FailoverInstanceAsync.

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.

FailoverInstanceSettings

public CallSettings FailoverInstanceSettings { get; set; }

CallSettings for synchronous and asynchronous calls to AlloyDBAdminClient.FailoverInstance and AlloyDBAdminClient.FailoverInstanceAsync.

Property Value
Type	Description
`CallSettings`

Remarks

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

GenerateClientCertificateSettings

public CallSettings GenerateClientCertificateSettings { get; set; }

CallSettings for synchronous and asynchronous calls to AlloyDBAdminClient.GenerateClientCertificate and AlloyDBAdminClient.GenerateClientCertificateAsync .

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.

GetBackupSettings

public CallSettings GetBackupSettings { get; set; }

CallSettings for synchronous and asynchronous calls to AlloyDBAdminClient.GetBackup and AlloyDBAdminClient.GetBackupAsync.

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.

GetClusterSettings

public CallSettings GetClusterSettings { get; set; }

CallSettings for synchronous and asynchronous calls to AlloyDBAdminClient.GetCluster and AlloyDBAdminClient.GetClusterAsync.

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.

GetConnectionInfoSettings

public CallSettings GetConnectionInfoSettings { get; set; }

CallSettings for synchronous and asynchronous calls to AlloyDBAdminClient.GetConnectionInfo and AlloyDBAdminClient.GetConnectionInfoAsync.

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.

GetInstanceSettings

public CallSettings GetInstanceSettings { get; set; }

CallSettings for synchronous and asynchronous calls to AlloyDBAdminClient.GetInstance and AlloyDBAdminClient.GetInstanceAsync.

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.

GetUserSettings

public CallSettings GetUserSettings { get; set; }

CallSettings for synchronous and asynchronous calls to AlloyDBAdminClient.GetUser and AlloyDBAdminClient.GetUserAsync.

Property Value
Type	Description
`CallSettings`

Remarks

This call will not be retried.
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`

InjectFaultOperationsSettings

public OperationsSettings InjectFaultOperationsSettings { get; set; }

Long Running Operation settings for calls to AlloyDBAdminClient.InjectFault and AlloyDBAdminClient.InjectFaultAsync.

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.

InjectFaultSettings

public CallSettings InjectFaultSettings { get; set; }

CallSettings for synchronous and asynchronous calls to AlloyDBAdminClient.InjectFault and AlloyDBAdminClient.InjectFaultAsync.

Property Value
Type	Description
`CallSettings`

Remarks

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

ListBackupsSettings

public CallSettings ListBackupsSettings { get; set; }

CallSettings for synchronous and asynchronous calls to AlloyDBAdminClient.ListBackups and AlloyDBAdminClient.ListBackupsAsync.

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.

ListClustersSettings

public CallSettings ListClustersSettings { get; set; }

CallSettings for synchronous and asynchronous calls to AlloyDBAdminClient.ListClusters and AlloyDBAdminClient.ListClustersAsync.

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.

ListInstancesSettings

public CallSettings ListInstancesSettings { get; set; }

CallSettings for synchronous and asynchronous calls to AlloyDBAdminClient.ListInstances and AlloyDBAdminClient.ListInstancesAsync.

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.

ListSupportedDatabaseFlagsSettings

public CallSettings ListSupportedDatabaseFlagsSettings { get; set; }

CallSettings for synchronous and asynchronous calls to AlloyDBAdminClient.ListSupportedDatabaseFlags and AlloyDBAdminClient.ListSupportedDatabaseFlagsAsync.

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.

ListUsersSettings

public CallSettings ListUsersSettings { get; set; }

CallSettings for synchronous and asynchronous calls to AlloyDBAdminClient.ListUsers and AlloyDBAdminClient.ListUsersAsync.

Property Value
Type	Description
`CallSettings`

Remarks

This call will not be retried.
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`

PromoteClusterOperationsSettings

public OperationsSettings PromoteClusterOperationsSettings { get; set; }

Long Running Operation settings for calls to AlloyDBAdminClient.PromoteCluster and AlloyDBAdminClient.PromoteClusterAsync.

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.

PromoteClusterSettings

public CallSettings PromoteClusterSettings { get; set; }

CallSettings for synchronous and asynchronous calls to AlloyDBAdminClient.PromoteCluster and AlloyDBAdminClient.PromoteClusterAsync.

Property Value
Type	Description
`CallSettings`

Remarks

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

RestartInstanceOperationsSettings

public OperationsSettings RestartInstanceOperationsSettings { get; set; }

Long Running Operation settings for calls to AlloyDBAdminClient.RestartInstance and AlloyDBAdminClient.RestartInstanceAsync.

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.

RestartInstanceSettings

public CallSettings RestartInstanceSettings { get; set; }

CallSettings for synchronous and asynchronous calls to AlloyDBAdminClient.RestartInstance and AlloyDBAdminClient.RestartInstanceAsync.

Property Value
Type	Description
`CallSettings`

Remarks

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

RestoreClusterOperationsSettings

public OperationsSettings RestoreClusterOperationsSettings { get; set; }

Long Running Operation settings for calls to AlloyDBAdminClient.RestoreCluster and AlloyDBAdminClient.RestoreClusterAsync.

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.

RestoreClusterSettings

public CallSettings RestoreClusterSettings { get; set; }

CallSettings for synchronous and asynchronous calls to AlloyDBAdminClient.RestoreCluster and AlloyDBAdminClient.RestoreClusterAsync.

Property Value
Type	Description
`CallSettings`

Remarks

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

UpdateBackupOperationsSettings

public OperationsSettings UpdateBackupOperationsSettings { get; set; }

Long Running Operation settings for calls to AlloyDBAdminClient.UpdateBackup and AlloyDBAdminClient.UpdateBackupAsync.

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.

UpdateBackupSettings

public CallSettings UpdateBackupSettings { get; set; }

CallSettings for synchronous and asynchronous calls to AlloyDBAdminClient.UpdateBackup and AlloyDBAdminClient.UpdateBackupAsync.

Property Value
Type	Description
`CallSettings`

Remarks

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

UpdateClusterOperationsSettings

public OperationsSettings UpdateClusterOperationsSettings { get; set; }

Long Running Operation settings for calls to AlloyDBAdminClient.UpdateCluster and AlloyDBAdminClient.UpdateClusterAsync.

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.

UpdateClusterSettings

public CallSettings UpdateClusterSettings { get; set; }

CallSettings for synchronous and asynchronous calls to AlloyDBAdminClient.UpdateCluster and AlloyDBAdminClient.UpdateClusterAsync.

Property Value
Type	Description
`CallSettings`

Remarks

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

UpdateInstanceOperationsSettings

public OperationsSettings UpdateInstanceOperationsSettings { get; set; }

Long Running Operation settings for calls to AlloyDBAdminClient.UpdateInstance and AlloyDBAdminClient.UpdateInstanceAsync.

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.

UpdateInstanceSettings

public CallSettings UpdateInstanceSettings { get; set; }

CallSettings for synchronous and asynchronous calls to AlloyDBAdminClient.UpdateInstance and AlloyDBAdminClient.UpdateInstanceAsync.

Property Value
Type	Description
`CallSettings`

Remarks

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

UpdateUserSettings

public CallSettings UpdateUserSettings { get; set; }

CallSettings for synchronous and asynchronous calls to AlloyDBAdminClient.UpdateUser and AlloyDBAdminClient.UpdateUserAsync.

Property Value
Type	Description
`CallSettings`

Remarks

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

Methods

Clone()

public AlloyDBAdminSettings Clone()

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

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

GetDefault()

public static AlloyDBAdminSettings GetDefault()

Get a new instance of the default AlloyDBAdminSettings.

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