Storage Transfer v1 API - Class StorageTransferServiceSettings (2.5.0)

public sealed class StorageTransferServiceSettings : ServiceSettingsBase

Reference documentation and code samples for the Storage Transfer v1 API class StorageTransferServiceSettings.

Settings for StorageTransferServiceClient instances.

Inheritance

object > ServiceSettingsBase > StorageTransferServiceSettings

Inherited Members

ServiceSettingsBase.VersionHeaderBuilder

ServiceSettingsBase.CallSettings

ServiceSettingsBase.Clock

ServiceSettingsBase.Scheduler

ServiceSettingsBase.Interceptor

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.StorageTransfer.V1

Assembly

Google.Cloud.StorageTransfer.V1.dll

Constructors

StorageTransferServiceSettings()

public StorageTransferServiceSettings()

Constructs a new StorageTransferServiceSettings object with default settings.

Properties

CreateAgentPoolSettings

public CallSettings CreateAgentPoolSettings { get; set; }

CallSettings for synchronous and asynchronous calls to StorageTransferServiceClient.CreateAgentPool and StorageTransferServiceClient.CreateAgentPoolAsync .

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.
Timeout: 60 seconds.

CreateTransferJobSettings

public CallSettings CreateTransferJobSettings { get; set; }

CallSettings for synchronous and asynchronous calls to StorageTransferServiceClient.CreateTransferJob and StorageTransferServiceClient.CreateTransferJobAsync.

Property Value
Type	Description
`CallSettings`

Remarks

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

DeleteAgentPoolSettings

public CallSettings DeleteAgentPoolSettings { get; set; }

CallSettings for synchronous and asynchronous calls to StorageTransferServiceClient.DeleteAgentPool and StorageTransferServiceClient.DeleteAgentPoolAsync .

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.
Timeout: 60 seconds.

DeleteTransferJobSettings

public CallSettings DeleteTransferJobSettings { get; set; }

CallSettings for synchronous and asynchronous calls to StorageTransferServiceClient.DeleteTransferJob and StorageTransferServiceClient.DeleteTransferJobAsync.

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.
Timeout: 60 seconds.

GetAgentPoolSettings

public CallSettings GetAgentPoolSettings { get; set; }

CallSettings for synchronous and asynchronous calls to StorageTransferServiceClient.GetAgentPool and StorageTransferServiceClient.GetAgentPoolAsync.

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.
Timeout: 60 seconds.

GetGoogleServiceAccountSettings

public CallSettings GetGoogleServiceAccountSettings { get; set; }

CallSettings for synchronous and asynchronous calls to StorageTransferServiceClient.GetGoogleServiceAccount and StorageTransferServiceClient.GetGoogleServiceAccountAsync.

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.
Timeout: 60 seconds.

GetTransferJobSettings

public CallSettings GetTransferJobSettings { get; set; }

CallSettings for synchronous and asynchronous calls to StorageTransferServiceClient.GetTransferJob and StorageTransferServiceClient.GetTransferJobAsync .

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.
Timeout: 60 seconds.

ListAgentPoolsSettings

public CallSettings ListAgentPoolsSettings { get; set; }

CallSettings for synchronous and asynchronous calls to StorageTransferServiceClient.ListAgentPools and StorageTransferServiceClient.ListAgentPoolsAsync .

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.
Timeout: 60 seconds.

ListTransferJobsSettings

public CallSettings ListTransferJobsSettings { get; set; }

CallSettings for synchronous and asynchronous calls to StorageTransferServiceClient.ListTransferJobs and StorageTransferServiceClient.ListTransferJobsAsync.

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.
Timeout: 60 seconds.

PauseTransferOperationSettings

public CallSettings PauseTransferOperationSettings { get; set; }

CallSettings for synchronous and asynchronous calls to StorageTransferServiceClient.PauseTransferOperation and StorageTransferServiceClient.PauseTransferOperationAsync.

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.
Timeout: 60 seconds.

ResumeTransferOperationSettings

public CallSettings ResumeTransferOperationSettings { get; set; }

CallSettings for synchronous and asynchronous calls to StorageTransferServiceClient.ResumeTransferOperation and StorageTransferServiceClient.ResumeTransferOperationAsync.

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.
Timeout: 60 seconds.

RunTransferJobOperationsSettings

public OperationsSettings RunTransferJobOperationsSettings { get; set; }

Long Running Operation settings for calls to StorageTransferServiceClient.RunTransferJob and StorageTransferServiceClient.RunTransferJobAsync.

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.

RunTransferJobSettings

public CallSettings RunTransferJobSettings { get; set; }

CallSettings for synchronous and asynchronous calls to StorageTransferServiceClient.RunTransferJob and StorageTransferServiceClient.RunTransferJobAsync .

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.
Timeout: 60 seconds.

UpdateAgentPoolSettings

public CallSettings UpdateAgentPoolSettings { get; set; }

CallSettings for synchronous and asynchronous calls to StorageTransferServiceClient.UpdateAgentPool and StorageTransferServiceClient.UpdateAgentPoolAsync .

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.
Timeout: 60 seconds.

UpdateTransferJobSettings

public CallSettings UpdateTransferJobSettings { get; set; }

CallSettings for synchronous and asynchronous calls to StorageTransferServiceClient.UpdateTransferJob and StorageTransferServiceClient.UpdateTransferJobAsync.

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.
Timeout: 60 seconds.

Methods

Clone()

public StorageTransferServiceSettings Clone()

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

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

GetDefault()

public static StorageTransferServiceSettings GetDefault()

Get a new instance of the default StorageTransferServiceSettings.

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