Google Cloud Spanner Database Administration v1 API - Class DatabaseAdminSettings (5.0.0-beta05)

public sealed class DatabaseAdminSettings : ServiceSettingsBase

Reference documentation and code samples for the Google Cloud Spanner Database Administration v1 API class DatabaseAdminSettings.

Settings for DatabaseAdminClient instances.

Inheritance

object > ServiceSettingsBase > DatabaseAdminSettings

Inherited Members

ServiceSettingsBase.VersionHeaderBuilder

ServiceSettingsBase.CallSettings

ServiceSettingsBase.Clock

ServiceSettingsBase.Scheduler

ServiceSettingsBase.Interceptor

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.Spanner.Admin.Database.V1

Assembly

Google.Cloud.Spanner.Admin.Database.V1.dll

Constructors

DatabaseAdminSettings()

public DatabaseAdminSettings()

Constructs a new DatabaseAdminSettings object with default settings.

Properties

CopyBackupOperationsSettings

public OperationsSettings CopyBackupOperationsSettings { get; set; }

Long Running Operation settings for calls to DatabaseAdminClient.CopyBackup and DatabaseAdminClient.CopyBackupAsync.

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.

CopyBackupSettings

public CallSettings CopyBackupSettings { get; set; }

CallSettings for synchronous and asynchronous calls to DatabaseAdminClient.CopyBackup and DatabaseAdminClient.CopyBackupAsync.

Property Value
Type	Description
`CallSettings`

Remarks

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

CreateBackupOperationsSettings

public OperationsSettings CreateBackupOperationsSettings { get; set; }

Long Running Operation settings for calls to DatabaseAdminClient.CreateBackup and DatabaseAdminClient.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.

CreateBackupScheduleSettings

public CallSettings CreateBackupScheduleSettings { get; set; }

CallSettings for synchronous and asynchronous calls to DatabaseAdminClient.CreateBackupSchedule and DatabaseAdminClient.CreateBackupScheduleAsync.

Property Value
Type	Description
`CallSettings`

Remarks

Initial retry delay: 1000 milliseconds.
Retry delay multiplier: 1.3
Retry maximum delay: 32000 milliseconds.
Maximum attempts: Unlimited
Retriable status codes: Unavailable, DeadlineExceeded.
Timeout: 3600 seconds.

CreateBackupSettings

public CallSettings CreateBackupSettings { get; set; }

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

Property Value
Type	Description
`CallSettings`

Remarks

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

CreateDatabaseOperationsSettings

public OperationsSettings CreateDatabaseOperationsSettings { get; set; }

Long Running Operation settings for calls to DatabaseAdminClient.CreateDatabase and DatabaseAdminClient.CreateDatabaseAsync.

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.

CreateDatabaseSettings

public CallSettings CreateDatabaseSettings { get; set; }

CallSettings for synchronous and asynchronous calls to DatabaseAdminClient.CreateDatabase and DatabaseAdminClient.CreateDatabaseAsync.

Property Value
Type	Description
`CallSettings`

Remarks

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

DeleteBackupScheduleSettings

public CallSettings DeleteBackupScheduleSettings { get; set; }

CallSettings for synchronous and asynchronous calls to DatabaseAdminClient.DeleteBackupSchedule and DatabaseAdminClient.DeleteBackupScheduleAsync.

Property Value
Type	Description
`CallSettings`

Remarks

Initial retry delay: 1000 milliseconds.
Retry delay multiplier: 1.3
Retry maximum delay: 32000 milliseconds.
Maximum attempts: Unlimited
Retriable status codes: Unavailable, DeadlineExceeded.
Timeout: 3600 seconds.

DeleteBackupSettings

public CallSettings DeleteBackupSettings { get; set; }

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

Property Value
Type	Description
`CallSettings`

Remarks

Initial retry delay: 1000 milliseconds.
Retry delay multiplier: 1.3
Retry maximum delay: 32000 milliseconds.
Maximum attempts: Unlimited
Retriable status codes: Unavailable, DeadlineExceeded.
Timeout: 3600 seconds.

DropDatabaseSettings

public CallSettings DropDatabaseSettings { get; set; }

CallSettings for synchronous and asynchronous calls to DatabaseAdminClient.DropDatabase and DatabaseAdminClient.DropDatabaseAsync.

Property Value
Type	Description
`CallSettings`

Remarks

Initial retry delay: 1000 milliseconds.
Retry delay multiplier: 1.3
Retry maximum delay: 32000 milliseconds.
Maximum attempts: Unlimited
Retriable status codes: Unavailable, DeadlineExceeded.
Timeout: 3600 seconds.

GetBackupScheduleSettings

public CallSettings GetBackupScheduleSettings { get; set; }

CallSettings for synchronous and asynchronous calls to DatabaseAdminClient.GetBackupSchedule and DatabaseAdminClient.GetBackupScheduleAsync.

Property Value
Type	Description
`CallSettings`

Remarks

Initial retry delay: 1000 milliseconds.
Retry delay multiplier: 1.3
Retry maximum delay: 32000 milliseconds.
Maximum attempts: Unlimited
Retriable status codes: Unavailable, DeadlineExceeded.
Timeout: 3600 seconds.

GetBackupSettings

public CallSettings GetBackupSettings { get; set; }

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

Property Value
Type	Description
`CallSettings`

Remarks

Initial retry delay: 1000 milliseconds.
Retry delay multiplier: 1.3
Retry maximum delay: 32000 milliseconds.
Maximum attempts: Unlimited
Retriable status codes: Unavailable, DeadlineExceeded.
Timeout: 3600 seconds.

GetDatabaseDdlSettings

public CallSettings GetDatabaseDdlSettings { get; set; }

CallSettings for synchronous and asynchronous calls to DatabaseAdminClient.GetDatabaseDdl and DatabaseAdminClient.GetDatabaseDdlAsync.

Property Value
Type	Description
`CallSettings`

Remarks

Initial retry delay: 1000 milliseconds.
Retry delay multiplier: 1.3
Retry maximum delay: 32000 milliseconds.
Maximum attempts: Unlimited
Retriable status codes: Unavailable, DeadlineExceeded.
Timeout: 3600 seconds.

GetDatabaseSettings

public CallSettings GetDatabaseSettings { get; set; }

CallSettings for synchronous and asynchronous calls to DatabaseAdminClient.GetDatabase and DatabaseAdminClient.GetDatabaseAsync.

Property Value
Type	Description
`CallSettings`

Remarks

Initial retry delay: 1000 milliseconds.
Retry delay multiplier: 1.3
Retry maximum delay: 32000 milliseconds.
Maximum attempts: Unlimited
Retriable status codes: Unavailable, DeadlineExceeded.
Timeout: 3600 seconds.

GetIamPolicySettings

public CallSettings GetIamPolicySettings { get; set; }

CallSettings for synchronous and asynchronous calls to DatabaseAdminClient.GetIamPolicy and DatabaseAdminClient.GetIamPolicyAsync.

Property Value
Type	Description
`CallSettings`

Remarks

Initial retry delay: 1000 milliseconds.
Retry delay multiplier: 1.3
Retry maximum delay: 32000 milliseconds.
Maximum attempts: Unlimited
Retriable status codes: Unavailable, DeadlineExceeded.
Timeout: 30 seconds.

ListBackupOperationsSettings

public CallSettings ListBackupOperationsSettings { get; set; }

CallSettings for synchronous and asynchronous calls to DatabaseAdminClient.ListBackupOperations and DatabaseAdminClient.ListBackupOperationsAsync.

Property Value
Type	Description
`CallSettings`

Remarks

Initial retry delay: 1000 milliseconds.
Retry delay multiplier: 1.3
Retry maximum delay: 32000 milliseconds.
Maximum attempts: Unlimited
Retriable status codes: Unavailable, DeadlineExceeded.
Timeout: 3600 seconds.

ListBackupSchedulesSettings

public CallSettings ListBackupSchedulesSettings { get; set; }

CallSettings for synchronous and asynchronous calls to DatabaseAdminClient.ListBackupSchedules and DatabaseAdminClient.ListBackupSchedulesAsync.

Property Value
Type	Description
`CallSettings`

Remarks

Initial retry delay: 1000 milliseconds.
Retry delay multiplier: 1.3
Retry maximum delay: 32000 milliseconds.
Maximum attempts: Unlimited
Retriable status codes: Unavailable, DeadlineExceeded.
Timeout: 3600 seconds.

ListBackupsSettings

public CallSettings ListBackupsSettings { get; set; }

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

Property Value
Type	Description
`CallSettings`

Remarks

Initial retry delay: 1000 milliseconds.
Retry delay multiplier: 1.3
Retry maximum delay: 32000 milliseconds.
Maximum attempts: Unlimited
Retriable status codes: Unavailable, DeadlineExceeded.
Timeout: 3600 seconds.

ListDatabaseOperationsSettings

public CallSettings ListDatabaseOperationsSettings { get; set; }

CallSettings for synchronous and asynchronous calls to DatabaseAdminClient.ListDatabaseOperations and DatabaseAdminClient.ListDatabaseOperationsAsync .

Property Value
Type	Description
`CallSettings`

Remarks

Initial retry delay: 1000 milliseconds.
Retry delay multiplier: 1.3
Retry maximum delay: 32000 milliseconds.
Maximum attempts: Unlimited
Retriable status codes: Unavailable, DeadlineExceeded.
Timeout: 3600 seconds.

ListDatabaseRolesSettings

public CallSettings ListDatabaseRolesSettings { get; set; }

CallSettings for synchronous and asynchronous calls to DatabaseAdminClient.ListDatabaseRoles and DatabaseAdminClient.ListDatabaseRolesAsync.

Property Value
Type	Description
`CallSettings`

Remarks

Initial retry delay: 1000 milliseconds.
Retry delay multiplier: 1.3
Retry maximum delay: 32000 milliseconds.
Maximum attempts: Unlimited
Retriable status codes: Unavailable, DeadlineExceeded.
Timeout: 3600 seconds.

ListDatabasesSettings

public CallSettings ListDatabasesSettings { get; set; }

CallSettings for synchronous and asynchronous calls to DatabaseAdminClient.ListDatabases and DatabaseAdminClient.ListDatabasesAsync.

Property Value
Type	Description
`CallSettings`

Remarks

Initial retry delay: 1000 milliseconds.
Retry delay multiplier: 1.3
Retry maximum delay: 32000 milliseconds.
Maximum attempts: Unlimited
Retriable status codes: Unavailable, DeadlineExceeded.
Timeout: 3600 seconds.

RestoreDatabaseOperationsSettings

public OperationsSettings RestoreDatabaseOperationsSettings { get; set; }

Long Running Operation settings for calls to DatabaseAdminClient.RestoreDatabase and DatabaseAdminClient.RestoreDatabaseAsync.

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.

RestoreDatabaseSettings

public CallSettings RestoreDatabaseSettings { get; set; }

CallSettings for synchronous and asynchronous calls to DatabaseAdminClient.RestoreDatabase and DatabaseAdminClient.RestoreDatabaseAsync.

Property Value
Type	Description
`CallSettings`

Remarks

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

SetIamPolicySettings

public CallSettings SetIamPolicySettings { get; set; }

CallSettings for synchronous and asynchronous calls to DatabaseAdminClient.SetIamPolicy and DatabaseAdminClient.SetIamPolicyAsync.

Property Value
Type	Description
`CallSettings`

Remarks

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

TestIamPermissionsSettings

public CallSettings TestIamPermissionsSettings { get; set; }

CallSettings for synchronous and asynchronous calls to DatabaseAdminClient.TestIamPermissions and DatabaseAdminClient.TestIamPermissionsAsync.

Property Value
Type	Description
`CallSettings`

Remarks

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

UpdateBackupScheduleSettings

public CallSettings UpdateBackupScheduleSettings { get; set; }

CallSettings for synchronous and asynchronous calls to DatabaseAdminClient.UpdateBackupSchedule and DatabaseAdminClient.UpdateBackupScheduleAsync.

Property Value
Type	Description
`CallSettings`

Remarks

Initial retry delay: 1000 milliseconds.
Retry delay multiplier: 1.3
Retry maximum delay: 32000 milliseconds.
Maximum attempts: Unlimited
Retriable status codes: Unavailable, DeadlineExceeded.
Timeout: 3600 seconds.

UpdateBackupSettings

public CallSettings UpdateBackupSettings { get; set; }

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

Property Value
Type	Description
`CallSettings`

Remarks

Initial retry delay: 1000 milliseconds.
Retry delay multiplier: 1.3
Retry maximum delay: 32000 milliseconds.
Maximum attempts: Unlimited
Retriable status codes: Unavailable, DeadlineExceeded.
Timeout: 3600 seconds.

UpdateDatabaseDdlOperationsSettings

public OperationsSettings UpdateDatabaseDdlOperationsSettings { get; set; }

Long Running Operation settings for calls to DatabaseAdminClient.UpdateDatabaseDdl and DatabaseAdminClient.UpdateDatabaseDdlAsync.

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.

UpdateDatabaseDdlSettings

public CallSettings UpdateDatabaseDdlSettings { get; set; }

CallSettings for synchronous and asynchronous calls to DatabaseAdminClient.UpdateDatabaseDdl and DatabaseAdminClient.UpdateDatabaseDdlAsync.

Property Value
Type	Description
`CallSettings`

Remarks

Initial retry delay: 1000 milliseconds.
Retry delay multiplier: 1.3
Retry maximum delay: 32000 milliseconds.
Maximum attempts: Unlimited
Retriable status codes: Unavailable, DeadlineExceeded.
Timeout: 3600 seconds.

UpdateDatabaseOperationsSettings

public OperationsSettings UpdateDatabaseOperationsSettings { get; set; }

Long Running Operation settings for calls to DatabaseAdminClient.UpdateDatabase and DatabaseAdminClient.UpdateDatabaseAsync.

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.

UpdateDatabaseSettings

public CallSettings UpdateDatabaseSettings { get; set; }

CallSettings for synchronous and asynchronous calls to DatabaseAdminClient.UpdateDatabase and DatabaseAdminClient.UpdateDatabaseAsync.

Property Value
Type	Description
`CallSettings`

Remarks

Initial retry delay: 1000 milliseconds.
Retry delay multiplier: 1.3
Retry maximum delay: 32000 milliseconds.
Maximum attempts: Unlimited
Retriable status codes: Unavailable, DeadlineExceeded.
Timeout: 3600 seconds.

Methods

Clone()

public DatabaseAdminSettings Clone()

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

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

GetDefault()

public static DatabaseAdminSettings GetDefault()

Get a new instance of the default DatabaseAdminSettings.

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