Cloud FTP v1 API - Class CloudFtpSettings (1.0.0-beta01)

public sealed class CloudFtpSettings : ServiceSettingsBase

Reference documentation and code samples for the Cloud FTP v1 API class CloudFtpSettings.

Settings for CloudFtpClient instances.

Inheritance

object > ServiceSettingsBase > CloudFtpSettings

Inherited Members

ServiceSettingsBase.VersionHeaderBuilder

ServiceSettingsBase.CallSettings

ServiceSettingsBase.Clock

ServiceSettingsBase.Scheduler

ServiceSettingsBase.Interceptor

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.Ftp.V1

Assembly

Google.Cloud.Ftp.V1.dll

Constructors

CloudFtpSettings()

public CloudFtpSettings()

Constructs a new CloudFtpSettings object with default settings.

Properties

CreateServerOperationsSettings

public OperationsSettings CreateServerOperationsSettings { get; set; }

Long Running Operation settings for calls to CloudFtpClient.CreateServer and CloudFtpClient.CreateServerAsync.

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.

CreateServerSettings

public CallSettings CreateServerSettings { get; set; }

CallSettings for synchronous and asynchronous calls to CloudFtpClient.CreateServer and CloudFtpClient.CreateServerAsync.

Property Value
Type	Description
CallSettings

Remarks

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

CreateUserOperationsSettings

public OperationsSettings CreateUserOperationsSettings { get; set; }

Long Running Operation settings for calls to CloudFtpClient.CreateUser and CloudFtpClient.CreateUserAsync.

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.

CreateUserSettings

public CallSettings CreateUserSettings { get; set; }

CallSettings for synchronous and asynchronous calls to CloudFtpClient.CreateUser and CloudFtpClient.CreateUserAsync.

Property Value
Type	Description
CallSettings

Remarks

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

DeleteServerOperationsSettings

public OperationsSettings DeleteServerOperationsSettings { get; set; }

Long Running Operation settings for calls to CloudFtpClient.DeleteServer and CloudFtpClient.DeleteServerAsync.

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.

DeleteServerSettings

public CallSettings DeleteServerSettings { get; set; }

CallSettings for synchronous and asynchronous calls to CloudFtpClient.DeleteServer and CloudFtpClient.DeleteServerAsync.

Property Value
Type	Description
CallSettings

Remarks

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

DeleteUserOperationsSettings

public OperationsSettings DeleteUserOperationsSettings { get; set; }

Long Running Operation settings for calls to CloudFtpClient.DeleteUser and CloudFtpClient.DeleteUserAsync.

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.

DeleteUserSettings

public CallSettings DeleteUserSettings { get; set; }

CallSettings for synchronous and asynchronous calls to CloudFtpClient.DeleteUser and CloudFtpClient.DeleteUserAsync.

Property Value
Type	Description
CallSettings

Remarks

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

GetServerSettings

public CallSettings GetServerSettings { get; set; }

CallSettings for synchronous and asynchronous calls to CloudFtpClient.GetServer and CloudFtpClient.GetServerAsync.

Property Value
Type	Description
CallSettings

Remarks

• Initial retry delay: 1000 milliseconds.
• Retry delay multiplier: 1.3
• Retry maximum delay: 10000 milliseconds.
• Maximum attempts: 5
• Retriable status codes: Unavailable.
• Timeout: 60 seconds.

GetUserSettings

public CallSettings GetUserSettings { get; set; }

CallSettings for synchronous and asynchronous calls to CloudFtpClient.GetUser and CloudFtpClient.GetUserAsync.

Property Value
Type	Description
CallSettings

Remarks

• Initial retry delay: 1000 milliseconds.
• Retry delay multiplier: 1.3
• Retry maximum delay: 10000 milliseconds.
• Maximum attempts: 5
• Retriable status codes: Unavailable.
• Timeout: 60 seconds.

ListServersSettings

public CallSettings ListServersSettings { get; set; }

CallSettings for synchronous and asynchronous calls to CloudFtpClient.ListServers and CloudFtpClient.ListServersAsync.

Property Value
Type	Description
CallSettings

Remarks

• Initial retry delay: 1000 milliseconds.
• Retry delay multiplier: 1.3
• Retry maximum delay: 10000 milliseconds.
• Maximum attempts: 5
• Retriable status codes: Unavailable.
• Timeout: 60 seconds.

ListUsersSettings

public CallSettings ListUsersSettings { get; set; }

CallSettings for synchronous and asynchronous calls to CloudFtpClient.ListUsers and CloudFtpClient.ListUsersAsync.

Property Value
Type	Description
CallSettings

Remarks

• Initial retry delay: 1000 milliseconds.
• Retry delay multiplier: 1.3
• Retry maximum delay: 10000 milliseconds.
• Maximum attempts: 5
• Retriable status codes: Unavailable.
• Timeout: 60 seconds.

LocationsSettings

public LocationsSettings LocationsSettings { get; set; }

The settings to use for the LocationsClient associated with the client.

Property Value
Type	Description
LocationsSettings

StartServerOperationsSettings

public OperationsSettings StartServerOperationsSettings { get; set; }

Long Running Operation settings for calls to CloudFtpClient.StartServer and CloudFtpClient.StartServerAsync.

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.

StartServerSettings

public CallSettings StartServerSettings { get; set; }

CallSettings for synchronous and asynchronous calls to CloudFtpClient.StartServer and CloudFtpClient.StartServerAsync.

Property Value
Type	Description
CallSettings

Remarks

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

StopServerOperationsSettings

public OperationsSettings StopServerOperationsSettings { get; set; }

Long Running Operation settings for calls to CloudFtpClient.StopServer and CloudFtpClient.StopServerAsync.

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.

StopServerSettings

public CallSettings StopServerSettings { get; set; }

CallSettings for synchronous and asynchronous calls to CloudFtpClient.StopServer and CloudFtpClient.StopServerAsync.

Property Value
Type	Description
CallSettings

Remarks

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

UpdateServerOperationsSettings

public OperationsSettings UpdateServerOperationsSettings { get; set; }

Long Running Operation settings for calls to CloudFtpClient.UpdateServer and CloudFtpClient.UpdateServerAsync.

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.

UpdateServerSettings

public CallSettings UpdateServerSettings { get; set; }

CallSettings for synchronous and asynchronous calls to CloudFtpClient.UpdateServer and CloudFtpClient.UpdateServerAsync.

Property Value
Type	Description
CallSettings

Remarks

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

UpdateUserOperationsSettings

public OperationsSettings UpdateUserOperationsSettings { get; set; }

Long Running Operation settings for calls to CloudFtpClient.UpdateUser and CloudFtpClient.UpdateUserAsync.

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.

UpdateUserSettings

public CallSettings UpdateUserSettings { get; set; }

CallSettings for synchronous and asynchronous calls to CloudFtpClient.UpdateUser and CloudFtpClient.UpdateUserAsync.

Property Value
Type	Description
CallSettings

Remarks

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

Methods

Clone()

public CloudFtpSettings Clone()

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

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

GetDefault()

public static CloudFtpSettings GetDefault()

Get a new instance of the default CloudFtpSettings.

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