Google Cloud Spanner Instance Administration v1 API - Class InstanceAdminSettings (4.3.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

Namespace

GoogleCloudGoogle.Cloud.SpannerGoogle.Cloud.Spanner.AdminGoogle.Cloud.Spanner.Admin.InstanceV1

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
TypeDescription
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
TypeDescription
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
TypeDescription
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 InstanceAdminClient.CreateInstance and InstanceAdminClient.CreateInstanceAsync.

Property Value
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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.

GetInstanceSettings

public CallSettings GetInstanceSettings { get; set; }

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

Property Value
TypeDescription
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
TypeDescription
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
TypeDescription
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.

ListInstancesSettings

public CallSettings ListInstancesSettings { get; set; }

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

Property Value
TypeDescription
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.

SetIamPolicySettings

public CallSettings SetIamPolicySettings { get; set; }

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

Property Value
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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 InstanceAdminClient.UpdateInstance and InstanceAdminClient.UpdateInstanceAsync.

Property Value
TypeDescription
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
TypeDescription
InstanceAdminSettings

A deep clone of this InstanceAdminSettings object.

GetDefault()

public static InstanceAdminSettings GetDefault()

Get a new instance of the default InstanceAdminSettings.

Returns
TypeDescription
InstanceAdminSettings

A new instance of the default InstanceAdminSettings.