Google Cloud Bigtable Administration v2 API - Class BigtableInstanceAdminSettings (3.20.0)

public sealed class BigtableInstanceAdminSettings : ServiceSettingsBase

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

Settings for BigtableInstanceAdminClient instances.

Inheritance

object > ServiceSettingsBase > BigtableInstanceAdminSettings

Inherited Members

ServiceSettingsBase.VersionHeaderBuilder

ServiceSettingsBase.CallSettings

ServiceSettingsBase.Clock

ServiceSettingsBase.Scheduler

ServiceSettingsBase.Interceptor

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.Bigtable.Admin.V2

Assembly

Google.Cloud.Bigtable.Admin.V2.dll

Constructors

BigtableInstanceAdminSettings()

public BigtableInstanceAdminSettings()

Constructs a new BigtableInstanceAdminSettings object with default settings.

Properties

CreateAppProfileSettings

public CallSettings CreateAppProfileSettings { get; set; }

CallSettings for synchronous and asynchronous calls to BigtableInstanceAdminClient.CreateAppProfile and BigtableInstanceAdminClient.CreateAppProfileAsync .

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 BigtableInstanceAdminClient.CreateCluster and BigtableInstanceAdminClient.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 BigtableInstanceAdminClient.CreateCluster and BigtableInstanceAdminClient.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 BigtableInstanceAdminClient.CreateInstance and BigtableInstanceAdminClient.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 BigtableInstanceAdminClient.CreateInstance and BigtableInstanceAdminClient.CreateInstanceAsync .

Property Value
Type	Description
`CallSettings`

Remarks

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

DeleteAppProfileSettings

public CallSettings DeleteAppProfileSettings { get; set; }

CallSettings for synchronous and asynchronous calls to BigtableInstanceAdminClient.DeleteAppProfile and BigtableInstanceAdminClient.DeleteAppProfileAsync .

Property Value
Type	Description
`CallSettings`

Remarks

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

DeleteClusterSettings

public CallSettings DeleteClusterSettings { get; set; }

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

Property Value
Type	Description
`CallSettings`

Remarks

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

DeleteInstanceSettings

public CallSettings DeleteInstanceSettings { get; set; }

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

Property Value
Type	Description
`CallSettings`

Remarks

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

GetAppProfileSettings

public CallSettings GetAppProfileSettings { get; set; }

CallSettings for synchronous and asynchronous calls to BigtableInstanceAdminClient.GetAppProfile and BigtableInstanceAdminClient.GetAppProfileAsync.

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.

GetClusterSettings

public CallSettings GetClusterSettings { get; set; }

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

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.

GetIamPolicySettings

public CallSettings GetIamPolicySettings { get; set; }

CallSettings for synchronous and asynchronous calls to BigtableInstanceAdminClient.GetIamPolicy and BigtableInstanceAdminClient.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.

GetInstanceSettings

public CallSettings GetInstanceSettings { get; set; }

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

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.

ListAppProfilesSettings

public CallSettings ListAppProfilesSettings { get; set; }

CallSettings for synchronous and asynchronous calls to BigtableInstanceAdminClient.ListAppProfiles and BigtableInstanceAdminClient.ListAppProfilesAsync .

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.

ListClustersSettings

public CallSettings ListClustersSettings { get; set; }

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

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.

ListHotTabletsSettings

public CallSettings ListHotTabletsSettings { get; set; }

CallSettings for synchronous and asynchronous calls to BigtableInstanceAdminClient.ListHotTablets and BigtableInstanceAdminClient.ListHotTabletsAsync .

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.

ListInstancesSettings

public CallSettings ListInstancesSettings { get; set; }

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

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.

PartialUpdateClusterOperationsSettings

public OperationsSettings PartialUpdateClusterOperationsSettings { get; set; }

Long Running Operation settings for calls to BigtableInstanceAdminClient.PartialUpdateCluster and BigtableInstanceAdminClient.PartialUpdateClusterAsync.

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.

PartialUpdateClusterSettings

public CallSettings PartialUpdateClusterSettings { get; set; }

CallSettings for synchronous and asynchronous calls to BigtableInstanceAdminClient.PartialUpdateCluster and BigtableInstanceAdminClient.PartialUpdateClusterAsync.

Property Value
Type	Description
`CallSettings`

Remarks

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

PartialUpdateInstanceOperationsSettings

public OperationsSettings PartialUpdateInstanceOperationsSettings { get; set; }

Long Running Operation settings for calls to BigtableInstanceAdminClient.PartialUpdateInstance and BigtableInstanceAdminClient.PartialUpdateInstanceAsync.

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.

PartialUpdateInstanceSettings

public CallSettings PartialUpdateInstanceSettings { get; set; }

CallSettings for synchronous and asynchronous calls to BigtableInstanceAdminClient.PartialUpdateInstance and BigtableInstanceAdminClient.PartialUpdateInstanceAsync.

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.

SetIamPolicySettings

public CallSettings SetIamPolicySettings { get; set; }

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

Property Value
Type	Description
`CallSettings`

Remarks

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

TestIamPermissionsSettings

public CallSettings TestIamPermissionsSettings { get; set; }

CallSettings for synchronous and asynchronous calls to BigtableInstanceAdminClient.TestIamPermissions and BigtableInstanceAdminClient.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.

UpdateAppProfileOperationsSettings

public OperationsSettings UpdateAppProfileOperationsSettings { get; set; }

Long Running Operation settings for calls to BigtableInstanceAdminClient.UpdateAppProfile and BigtableInstanceAdminClient.UpdateAppProfileAsync.

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.

UpdateAppProfileSettings

public CallSettings UpdateAppProfileSettings { get; set; }

CallSettings for synchronous and asynchronous calls to BigtableInstanceAdminClient.UpdateAppProfile and BigtableInstanceAdminClient.UpdateAppProfileAsync .

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.

UpdateClusterOperationsSettings

public OperationsSettings UpdateClusterOperationsSettings { get; set; }

Long Running Operation settings for calls to BigtableInstanceAdminClient.UpdateCluster and BigtableInstanceAdminClient.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 BigtableInstanceAdminClient.UpdateCluster and BigtableInstanceAdminClient.UpdateClusterAsync.

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.

UpdateInstanceSettings

public CallSettings UpdateInstanceSettings { get; set; }

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

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.

Methods

Clone()

public BigtableInstanceAdminSettings Clone()

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

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

GetDefault()

public static BigtableInstanceAdminSettings GetDefault()

Get a new instance of the default BigtableInstanceAdminSettings.

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