Cloud Shell v1 API - Class CloudShellServiceSettings (2.3.0)

public sealed class CloudShellServiceSettings : ServiceSettingsBase

Reference documentation and code samples for the Cloud Shell v1 API class CloudShellServiceSettings.

Settings for CloudShellServiceClient instances.

Inheritance

object > ServiceSettingsBase > CloudShellServiceSettings

Inherited Members

ServiceSettingsBase.VersionHeaderBuilder

ServiceSettingsBase.CallSettings

ServiceSettingsBase.Clock

ServiceSettingsBase.Scheduler

ServiceSettingsBase.Interceptor

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.Shell.V1

Assembly

Google.Cloud.Shell.V1.dll

Constructors

CloudShellServiceSettings()

public CloudShellServiceSettings()

Constructs a new CloudShellServiceSettings object with default settings.

Properties

AddPublicKeyOperationsSettings

public OperationsSettings AddPublicKeyOperationsSettings { get; set; }

Long Running Operation settings for calls to CloudShellServiceClient.AddPublicKey and CloudShellServiceClient.AddPublicKeyAsync.

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.

AddPublicKeySettings

public CallSettings AddPublicKeySettings { get; set; }

CallSettings for synchronous and asynchronous calls to CloudShellServiceClient.AddPublicKey and CloudShellServiceClient.AddPublicKeyAsync.

Property Value
Type	Description
`CallSettings`

Remarks

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

AuthorizeEnvironmentOperationsSettings

public OperationsSettings AuthorizeEnvironmentOperationsSettings { get; set; }

Long Running Operation settings for calls to CloudShellServiceClient.AuthorizeEnvironment and CloudShellServiceClient.AuthorizeEnvironmentAsync.

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.

AuthorizeEnvironmentSettings

public CallSettings AuthorizeEnvironmentSettings { get; set; }

CallSettings for synchronous and asynchronous calls to CloudShellServiceClient.AuthorizeEnvironment and CloudShellServiceClient.AuthorizeEnvironmentAsync .

Property Value
Type	Description
`CallSettings`

Remarks

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

GetEnvironmentSettings

public CallSettings GetEnvironmentSettings { get; set; }

CallSettings for synchronous and asynchronous calls to CloudShellServiceClient.GetEnvironment and CloudShellServiceClient.GetEnvironmentAsync.

Property Value
Type	Description
`CallSettings`

Remarks

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

RemovePublicKeyOperationsSettings

public OperationsSettings RemovePublicKeyOperationsSettings { get; set; }

Long Running Operation settings for calls to CloudShellServiceClient.RemovePublicKey and CloudShellServiceClient.RemovePublicKeyAsync.

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.

RemovePublicKeySettings

public CallSettings RemovePublicKeySettings { get; set; }

CallSettings for synchronous and asynchronous calls to CloudShellServiceClient.RemovePublicKey and CloudShellServiceClient.RemovePublicKeyAsync.

Property Value
Type	Description
`CallSettings`

Remarks

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

StartEnvironmentOperationsSettings

public OperationsSettings StartEnvironmentOperationsSettings { get; set; }

Long Running Operation settings for calls to CloudShellServiceClient.StartEnvironment and CloudShellServiceClient.StartEnvironmentAsync.

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.

StartEnvironmentSettings

public CallSettings StartEnvironmentSettings { get; set; }

CallSettings for synchronous and asynchronous calls to CloudShellServiceClient.StartEnvironment and CloudShellServiceClient.StartEnvironmentAsync.

Property Value
Type	Description
`CallSettings`

Remarks

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

Methods

Clone()

public CloudShellServiceSettings Clone()

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

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

GetDefault()

public static CloudShellServiceSettings GetDefault()

Get a new instance of the default CloudShellServiceSettings.

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