Google Cloud Bigtable Administration v2 API - Class BigtableTableAdminSettings (3.3.0)

public sealed class BigtableTableAdminSettings : ServiceSettingsBase

Reference documentation and code samples for the Google Cloud Bigtable Administration v2 API class BigtableTableAdminSettings.

Settings for BigtableTableAdminClient instances.

Inheritance

Object > ServiceSettingsBase > BigtableTableAdminSettings

Inherited Members

ServiceSettingsBase.VersionHeaderBuilder

ServiceSettingsBase.CallSettings

ServiceSettingsBase.Clock

ServiceSettingsBase.Scheduler

ServiceSettingsBase.Interceptor

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Object.ToString()

Namespace

Google.Cloud.Bigtable.Admin.V2

Assembly

Google.Cloud.Bigtable.Admin.V2.dll

Constructors

BigtableTableAdminSettings()

public BigtableTableAdminSettings()

Constructs a new BigtableTableAdminSettings object with default settings.

Properties

CheckConsistencySettings

public CallSettings CheckConsistencySettings { get; set; }

CallSettings for synchronous and asynchronous calls to BigtableTableAdminClient.CheckConsistency and BigtableTableAdminClient.CheckConsistencyAsync.

Property Value
Type	Description
`CallSettings`

Remarks

Initial retry delay: 1000 milliseconds.
Retry delay multiplier: 2
Retry maximum delay: 60000 milliseconds.
Maximum attempts: 5
Retriable status codes: Unavailable, DeadlineExceeded.
Timeout: 60 seconds.

CreateBackupOperationsSettings

public OperationsSettings CreateBackupOperationsSettings { get; set; }

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

Property Value
Type	Description
`CallSettings`

Remarks

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

CreateTableFromSnapshotOperationsSettings

public OperationsSettings CreateTableFromSnapshotOperationsSettings { get; set; }

Long Running Operation settings for calls to BigtableTableAdminClient.CreateTableFromSnapshot and BigtableTableAdminClient.CreateTableFromSnapshotAsync.

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.

CreateTableFromSnapshotSettings

public CallSettings CreateTableFromSnapshotSettings { get; set; }

CallSettings for synchronous and asynchronous calls to BigtableTableAdminClient.CreateTableFromSnapshot and BigtableTableAdminClient.CreateTableFromSnapshotAsync.

Property Value
Type	Description
`CallSettings`

Remarks

This call will not be retried.
No timeout is applied.

CreateTableSettings

public CallSettings CreateTableSettings { get; set; }

CallSettings for synchronous and asynchronous calls to BigtableTableAdminClient.CreateTable and BigtableTableAdminClient.CreateTableAsync.

Property Value
Type	Description
`CallSettings`

Remarks

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

DeleteBackupSettings

public CallSettings DeleteBackupSettings { get; set; }

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

Property Value
Type	Description
`CallSettings`

Remarks

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

DeleteSnapshotSettings

public CallSettings DeleteSnapshotSettings { get; set; }

CallSettings for synchronous and asynchronous calls to BigtableTableAdminClient.DeleteSnapshot and BigtableTableAdminClient.DeleteSnapshotAsync.

Property Value
Type	Description
`CallSettings`

Remarks

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

DeleteTableSettings

public CallSettings DeleteTableSettings { get; set; }

CallSettings for synchronous and asynchronous calls to BigtableTableAdminClient.DeleteTable and BigtableTableAdminClient.DeleteTableAsync.

Property Value
Type	Description
`CallSettings`

Remarks

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

DropRowRangeSettings

public CallSettings DropRowRangeSettings { get; set; }

CallSettings for synchronous and asynchronous calls to BigtableTableAdminClient.DropRowRange and BigtableTableAdminClient.DropRowRangeAsync.

Property Value
Type	Description
`CallSettings`

Remarks

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

GenerateConsistencyTokenSettings

public CallSettings GenerateConsistencyTokenSettings { get; set; }

CallSettings for synchronous and asynchronous calls to BigtableTableAdminClient.GenerateConsistencyToken and BigtableTableAdminClient.GenerateConsistencyTokenAsync.

Property Value
Type	Description
`CallSettings`

Remarks

Initial retry delay: 1000 milliseconds.
Retry delay multiplier: 2
Retry maximum delay: 60000 milliseconds.
Maximum attempts: 5
Retriable status codes: Unavailable, DeadlineExceeded.
Timeout: 60 seconds.

GetBackupSettings

public CallSettings GetBackupSettings { get; set; }

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

Property Value
Type	Description
`CallSettings`

Remarks

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

GetIamPolicySettings

public CallSettings GetIamPolicySettings { get; set; }

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

Property Value
Type	Description
`CallSettings`

Remarks

Initial retry delay: 1000 milliseconds.
Retry delay multiplier: 2
Retry maximum delay: 60000 milliseconds.
Maximum attempts: 5
Retriable status codes: Unavailable, DeadlineExceeded.
Timeout: 60 seconds.

GetSnapshotSettings

public CallSettings GetSnapshotSettings { get; set; }

CallSettings for synchronous and asynchronous calls to BigtableTableAdminClient.GetSnapshot and BigtableTableAdminClient.GetSnapshotAsync.

Property Value
Type	Description
`CallSettings`

Remarks

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

GetTableSettings

public CallSettings GetTableSettings { get; set; }

CallSettings for synchronous and asynchronous calls to BigtableTableAdminClient.GetTable and BigtableTableAdminClient.GetTableAsync.

Property Value
Type	Description
`CallSettings`

Remarks

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

ListBackupsSettings

public CallSettings ListBackupsSettings { get; set; }

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

Property Value
Type	Description
`CallSettings`

Remarks

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

ListSnapshotsSettings

public CallSettings ListSnapshotsSettings { get; set; }

CallSettings for synchronous and asynchronous calls to BigtableTableAdminClient.ListSnapshots and BigtableTableAdminClient.ListSnapshotsAsync.

Property Value
Type	Description
`CallSettings`

Remarks

Initial retry delay: 1000 milliseconds.
Retry delay multiplier: 2
Retry maximum delay: 60000 milliseconds.
Maximum attempts: 5
Retriable status codes: Unavailable, DeadlineExceeded.
Timeout: 60 seconds.

ListTablesSettings

public CallSettings ListTablesSettings { get; set; }

CallSettings for synchronous and asynchronous calls to BigtableTableAdminClient.ListTables and BigtableTableAdminClient.ListTablesAsync.

Property Value
Type	Description
`CallSettings`

Remarks

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

ModifyColumnFamiliesSettings

public CallSettings ModifyColumnFamiliesSettings { get; set; }

CallSettings for synchronous and asynchronous calls to BigtableTableAdminClient.ModifyColumnFamilies and BigtableTableAdminClient.ModifyColumnFamiliesAsync.

Property Value
Type	Description
`CallSettings`

Remarks

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

RestoreTableOperationsSettings

public OperationsSettings RestoreTableOperationsSettings { get; set; }

Long Running Operation settings for calls to BigtableTableAdminClient.RestoreTable and BigtableTableAdminClient.RestoreTableAsync.

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.

RestoreTableSettings

public CallSettings RestoreTableSettings { get; set; }

CallSettings for synchronous and asynchronous calls to BigtableTableAdminClient.RestoreTable and BigtableTableAdminClient.RestoreTableAsync.

Property Value
Type	Description
`CallSettings`

Remarks

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

SetIamPolicySettings

public CallSettings SetIamPolicySettings { get; set; }

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

Property Value
Type	Description
`CallSettings`

Remarks

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

SnapshotTableOperationsSettings

public OperationsSettings SnapshotTableOperationsSettings { get; set; }

Long Running Operation settings for calls to BigtableTableAdminClient.SnapshotTable and BigtableTableAdminClient.SnapshotTableAsync.

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.

SnapshotTableSettings

public CallSettings SnapshotTableSettings { get; set; }

CallSettings for synchronous and asynchronous calls to BigtableTableAdminClient.SnapshotTable and BigtableTableAdminClient.SnapshotTableAsync.

Property Value
Type	Description
`CallSettings`

Remarks

This call will not be retried.
No timeout is applied.

TestIamPermissionsSettings

public CallSettings TestIamPermissionsSettings { get; set; }

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

Property Value
Type	Description
`CallSettings`

Remarks

Initial retry delay: 1000 milliseconds.
Retry delay multiplier: 2
Retry maximum delay: 60000 milliseconds.
Maximum attempts: 5
Retriable status codes: Unavailable, DeadlineExceeded.
Timeout: 60 seconds.

UndeleteTableOperationsSettings

public OperationsSettings UndeleteTableOperationsSettings { get; set; }

Long Running Operation settings for calls to BigtableTableAdminClient.UndeleteTable and BigtableTableAdminClient.UndeleteTableAsync.

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.

UndeleteTableSettings

public CallSettings UndeleteTableSettings { get; set; }

CallSettings for synchronous and asynchronous calls to BigtableTableAdminClient.UndeleteTable and BigtableTableAdminClient.UndeleteTableAsync.

Property Value
Type	Description
`CallSettings`

Remarks

This call will not be retried.
No timeout is applied.

UpdateBackupSettings

public CallSettings UpdateBackupSettings { get; set; }

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

Property Value
Type	Description
`CallSettings`

Remarks

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

UpdateTableOperationsSettings

public OperationsSettings UpdateTableOperationsSettings { get; set; }

Long Running Operation settings for calls to BigtableTableAdminClient.UpdateTable and BigtableTableAdminClient.UpdateTableAsync.

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.

UpdateTableSettings

public CallSettings UpdateTableSettings { get; set; }

CallSettings for synchronous and asynchronous calls to BigtableTableAdminClient.UpdateTable and BigtableTableAdminClient.UpdateTableAsync.

Property Value
Type	Description
`CallSettings`

Remarks

This call will not be retried.
No timeout is applied.

Methods

Clone()

public BigtableTableAdminSettings Clone()

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

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

GetDefault()

public static BigtableTableAdminSettings GetDefault()

Get a new instance of the default BigtableTableAdminSettings.

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