Google Cloud Spanner Instance Administration v1 API - Class InstanceAdminSettings (5.4.0)

Version latest

• 5.4.0 (latest)
• 5.3.0
• 5.2.0
• 5.1.0
• 5.0.0
• 4.6.0
• 4.5.0
• 4.4.0
• 4.3.0
• 4.2.0
• 4.1.0
• 4.0.0
• 3.15.1
• 3.14.0
• 3.13.0
• 3.12.0
• 3.11.0
• 3.10.0
• 3.9.0
• 3.8.0
• 3.7.0
• 3.6.0
• 3.5.0

public sealed class InstanceAdminSettings : ServiceSettingsBase

Reference documentation and code samples for the Google Cloud Spanner Instance Administration v1 API class InstanceAdminSettings.

Settings for InstanceAdminClient instances.

Inheritance

object > ServiceSettingsBase > InstanceAdminSettings

Inherited Members

ServiceSettingsBase.VersionHeaderBuilder

ServiceSettingsBase.CallSettings

ServiceSettingsBase.Clock

ServiceSettingsBase.Scheduler

ServiceSettingsBase.Interceptor

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.Spanner.Admin.Instance.V1

Assembly

Google.Cloud.Spanner.Admin.Instance.V1.dll

Constructors

InstanceAdminSettings()

public InstanceAdminSettings()

Constructs a new InstanceAdminSettings object with default settings.

Properties

CreateInstanceConfigOperationsSettings

public OperationsSettings CreateInstanceConfigOperationsSettings { get; set; }

Long Running Operation settings for calls to InstanceAdminClient.CreateInstanceConfig and InstanceAdminClient.CreateInstanceConfigAsync.

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.

CreateInstanceConfigSettings

public CallSettings CreateInstanceConfigSettings { get; set; }

CallSettings for synchronous and asynchronous calls to InstanceAdminClient.CreateInstanceConfig and InstanceAdminClient.CreateInstanceConfigAsync.

Property Value
Type	Description
CallSettings

Remarks

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

CreateInstanceOperationsSettings

public OperationsSettings CreateInstanceOperationsSettings { get; set; }

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

CreateInstancePartitionOperationsSettings

public OperationsSettings CreateInstancePartitionOperationsSettings { get; set; }

Long Running Operation settings for calls to InstanceAdminClient.CreateInstancePartition and InstanceAdminClient.CreateInstancePartitionAsync.

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.

CreateInstancePartitionSettings

public CallSettings CreateInstancePartitionSettings { get; set; }

CallSettings for synchronous and asynchronous calls to InstanceAdminClient.CreateInstancePartition and InstanceAdminClient.CreateInstancePartitionAsync .

Property Value
Type	Description
CallSettings

Remarks

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

CreateInstanceSettings

public CallSettings CreateInstanceSettings { get; set; }

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

Property Value
Type	Description
CallSettings

Remarks

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

DeleteInstanceConfigSettings

public CallSettings DeleteInstanceConfigSettings { get; set; }

CallSettings for synchronous and asynchronous calls to InstanceAdminClient.DeleteInstanceConfig and InstanceAdminClient.DeleteInstanceConfigAsync.

Property Value
Type	Description
CallSettings

Remarks

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

DeleteInstancePartitionSettings

public CallSettings DeleteInstancePartitionSettings { get; set; }

CallSettings for synchronous and asynchronous calls to InstanceAdminClient.DeleteInstancePartition and InstanceAdminClient.DeleteInstancePartitionAsync .

Property Value
Type	Description
CallSettings

Remarks

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

DeleteInstanceSettings

public CallSettings DeleteInstanceSettings { get; set; }

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

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 InstanceAdminClient.GetIamPolicy and InstanceAdminClient.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.

GetInstanceConfigSettings

public CallSettings GetInstanceConfigSettings { get; set; }

CallSettings for synchronous and asynchronous calls to InstanceAdminClient.GetInstanceConfig and InstanceAdminClient.GetInstanceConfigAsync.

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.

GetInstancePartitionSettings

public CallSettings GetInstancePartitionSettings { get; set; }

CallSettings for synchronous and asynchronous calls to InstanceAdminClient.GetInstancePartition and InstanceAdminClient.GetInstancePartitionAsync.

Property Value
Type	Description
CallSettings

Remarks

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

GetInstanceSettings

public CallSettings GetInstanceSettings { get; set; }

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

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.

ListInstanceConfigOperationsSettings

public CallSettings ListInstanceConfigOperationsSettings { get; set; }

CallSettings for synchronous and asynchronous calls to InstanceAdminClient.ListInstanceConfigOperations and InstanceAdminClient.ListInstanceConfigOperationsAsync.

Property Value
Type	Description
CallSettings

Remarks

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

ListInstanceConfigsSettings

public CallSettings ListInstanceConfigsSettings { get; set; }

CallSettings for synchronous and asynchronous calls to InstanceAdminClient.ListInstanceConfigs and InstanceAdminClient.ListInstanceConfigsAsync.

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.

ListInstancePartitionOperationsSettings

public CallSettings ListInstancePartitionOperationsSettings { get; set; }

CallSettings for synchronous and asynchronous calls to InstanceAdminClient.ListInstancePartitionOperations and InstanceAdminClient.ListInstancePartitionOperationsAsync.

Property Value
Type	Description
CallSettings

Remarks

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

ListInstancePartitionsSettings

public CallSettings ListInstancePartitionsSettings { get; set; }

CallSettings for synchronous and asynchronous calls to InstanceAdminClient.ListInstancePartitions and InstanceAdminClient.ListInstancePartitionsAsync .

Property Value
Type	Description
CallSettings

Remarks

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

ListInstancesSettings

public CallSettings ListInstancesSettings { get; set; }

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

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.

MoveInstanceOperationsSettings

public OperationsSettings MoveInstanceOperationsSettings { get; set; }

Long Running Operation settings for calls to InstanceAdminClient.MoveInstance and InstanceAdminClient.MoveInstanceAsync.

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.

MoveInstanceSettings

public CallSettings MoveInstanceSettings { get; set; }

CallSettings for synchronous and asynchronous calls to InstanceAdminClient.MoveInstance and InstanceAdminClient.MoveInstanceAsync.

Property Value
Type	Description
CallSettings

Remarks

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

SetIamPolicySettings

public CallSettings SetIamPolicySettings { get; set; }

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

Property Value
Type	Description
CallSettings

Remarks

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

UpdateInstanceConfigOperationsSettings

public OperationsSettings UpdateInstanceConfigOperationsSettings { get; set; }

Long Running Operation settings for calls to InstanceAdminClient.UpdateInstanceConfig and InstanceAdminClient.UpdateInstanceConfigAsync.

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.

UpdateInstanceConfigSettings

public CallSettings UpdateInstanceConfigSettings { get; set; }

CallSettings for synchronous and asynchronous calls to InstanceAdminClient.UpdateInstanceConfig and InstanceAdminClient.UpdateInstanceConfigAsync.

Property Value
Type	Description
CallSettings

Remarks

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

UpdateInstanceOperationsSettings

public OperationsSettings UpdateInstanceOperationsSettings { get; set; }

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

UpdateInstancePartitionOperationsSettings

public OperationsSettings UpdateInstancePartitionOperationsSettings { get; set; }

Long Running Operation settings for calls to InstanceAdminClient.UpdateInstancePartition and InstanceAdminClient.UpdateInstancePartitionAsync.

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.

UpdateInstancePartitionSettings

public CallSettings UpdateInstancePartitionSettings { get; set; }

CallSettings for synchronous and asynchronous calls to InstanceAdminClient.UpdateInstancePartition and InstanceAdminClient.UpdateInstancePartitionAsync .

Property Value
Type	Description
CallSettings

Remarks

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

UpdateInstanceSettings

public CallSettings UpdateInstanceSettings { get; set; }

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

Property Value
Type	Description
CallSettings

Remarks

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

Methods

Clone()

public InstanceAdminSettings Clone()

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

Returns
Type	Description
InstanceAdminSettings	A deep clone of this InstanceAdminSettings object.

GetDefault()

public static InstanceAdminSettings GetDefault()

Get a new instance of the default InstanceAdminSettings.

Returns
Type	Description
InstanceAdminSettings	A new instance of the default InstanceAdminSettings.