Cloud Storage v2 API - Class StorageControlSettings (1.0.0-beta01)

public sealed class StorageControlSettings : ServiceSettingsBase

Reference documentation and code samples for the Cloud Storage v2 API class StorageControlSettings.

Settings for StorageControlClient instances.

Inheritance

object > ServiceSettingsBase > StorageControlSettings

Inherited Members

ServiceSettingsBase.VersionHeaderBuilder

ServiceSettingsBase.CallSettings

ServiceSettingsBase.Clock

ServiceSettingsBase.Scheduler

ServiceSettingsBase.Interceptor

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.Storage.Control.V2

Assembly

Google.Cloud.Storage.Control.V2.dll

Constructors

StorageControlSettings()

public StorageControlSettings()

Constructs a new StorageControlSettings object with default settings.

Properties

CreateFolderSettings

public CallSettings CreateFolderSettings { get; set; }

CallSettings for synchronous and asynchronous calls to StorageControlClient.CreateFolder and StorageControlClient.CreateFolderAsync.

Property Value
Type	Description
`CallSettings`

Remarks

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

DeleteFolderSettings

public CallSettings DeleteFolderSettings { get; set; }

CallSettings for synchronous and asynchronous calls to StorageControlClient.DeleteFolder and StorageControlClient.DeleteFolderAsync.

Property Value
Type	Description
`CallSettings`

Remarks

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

GetFolderSettings

public CallSettings GetFolderSettings { get; set; }

CallSettings for synchronous and asynchronous calls to StorageControlClient.GetFolder and StorageControlClient.GetFolderAsync.

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: ResourceExhausted, Unavailable, DeadlineExceeded, Internal, Unknown.
Timeout: 60 seconds.

GetStorageLayoutSettings

public CallSettings GetStorageLayoutSettings { get; set; }

CallSettings for synchronous and asynchronous calls to StorageControlClient.GetStorageLayout and StorageControlClient.GetStorageLayoutAsync.

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: ResourceExhausted, Unavailable, DeadlineExceeded, Internal, Unknown.
Timeout: 60 seconds.

ListFoldersSettings

public CallSettings ListFoldersSettings { get; set; }

CallSettings for synchronous and asynchronous calls to StorageControlClient.ListFolders and StorageControlClient.ListFoldersAsync.

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: ResourceExhausted, Unavailable, DeadlineExceeded, Internal, Unknown.
Timeout: 60 seconds.

RenameFolderOperationsSettings

public OperationsSettings RenameFolderOperationsSettings { get; set; }

Long Running Operation settings for calls to StorageControlClient.RenameFolder and StorageControlClient.RenameFolderAsync.

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.

RenameFolderSettings

public CallSettings RenameFolderSettings { get; set; }

CallSettings for synchronous and asynchronous calls to StorageControlClient.RenameFolder and StorageControlClient.RenameFolderAsync.

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: ResourceExhausted, Unavailable, DeadlineExceeded, Internal, Unknown.
Timeout: 60 seconds.

Methods

Clone()

public StorageControlSettings Clone()

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

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

GetDefault()

public static StorageControlSettings GetDefault()

Get a new instance of the default StorageControlSettings.

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