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

public sealed class CloudFtpClientImpl : CloudFtpClient

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

CloudFtp client wrapper implementation, for convenient use.

Inheritance

object > CloudFtpClient > CloudFtpClientImpl

Namespace

Google.Cloud.Ftp.V1

Assembly

Google.Cloud.Ftp.V1.dll

Remarks

Service describing handlers for resources

Constructors

CloudFtpClientImpl(CloudFtpClient, CloudFtpSettings, ILogger)

public CloudFtpClientImpl(CloudFtp.CloudFtpClient grpcClient, CloudFtpSettings settings, ILogger logger)

Constructs a client wrapper for the CloudFtp service, with the specified gRPC client and settings.

Parameters
Name Description
grpcClient CloudFtpCloudFtpClient

The underlying gRPC client.
settings CloudFtpSettings

The base CloudFtpSettings used within this client.
logger ILogger

Optional ILogger to use within this client.

Properties

CreateServerOperationsClient

public override OperationsClient CreateServerOperationsClient { get; }

The long-running operations client for CreateServer.

Property Value
Type Description
OperationsClient
Overrides

CreateUserOperationsClient

public override OperationsClient CreateUserOperationsClient { get; }

The long-running operations client for CreateUser.

Property Value
Type Description
OperationsClient
Overrides

DeleteServerOperationsClient

public override OperationsClient DeleteServerOperationsClient { get; }

The long-running operations client for DeleteServer.

Property Value
Type Description
OperationsClient
Overrides

DeleteUserOperationsClient

public override OperationsClient DeleteUserOperationsClient { get; }

The long-running operations client for DeleteUser.

Property Value
Type Description
OperationsClient
Overrides

GrpcClient

public override CloudFtp.CloudFtpClient GrpcClient { get; }

The underlying gRPC CloudFtp client

Property Value
Type Description
CloudFtpCloudFtpClient
Overrides

LocationsClient

public override LocationsClient LocationsClient { get; }

The LocationsClient associated with this client.

Property Value
Type Description
LocationsClient
Overrides

StartServerOperationsClient

public override OperationsClient StartServerOperationsClient { get; }

The long-running operations client for StartServer.

Property Value
Type Description
OperationsClient
Overrides

StopServerOperationsClient

public override OperationsClient StopServerOperationsClient { get; }

The long-running operations client for StopServer.

Property Value
Type Description
OperationsClient
Overrides

UpdateServerOperationsClient

public override OperationsClient UpdateServerOperationsClient { get; }

The long-running operations client for UpdateServer.

Property Value
Type Description
OperationsClient
Overrides

UpdateUserOperationsClient

public override OperationsClient UpdateUserOperationsClient { get; }

The long-running operations client for UpdateUser.

Property Value
Type Description
OperationsClient
Overrides

Methods

CreateServer(CreateServerRequest, CallSettings)

public override Operation<Server, OperationMetadata> CreateServer(CreateServerRequest request, CallSettings callSettings = null)

Creates a new Server in a given project and location.

Parameters
Name Description
request CreateServerRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationServerOperationMetadata

The RPC response.
Overrides

CreateServerAsync(CreateServerRequest, CallSettings)

public override Task<Operation<Server, OperationMetadata>> CreateServerAsync(CreateServerRequest request, CallSettings callSettings = null)

Creates a new Server in a given project and location.

Parameters
Name Description
request CreateServerRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationServerOperationMetadata

A Task containing the RPC response.
Overrides

CreateUser(CreateUserRequest, CallSettings)

public override Operation<User, OperationMetadata> CreateUser(CreateUserRequest request, CallSettings callSettings = null)

Creates a new User in a given project and location and Server.

Parameters
Name Description
request CreateUserRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationUserOperationMetadata

The RPC response.
Overrides

CreateUserAsync(CreateUserRequest, CallSettings)

public override Task<Operation<User, OperationMetadata>> CreateUserAsync(CreateUserRequest request, CallSettings callSettings = null)

Creates a new User in a given project and location and Server.

Parameters
Name Description
request CreateUserRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationUserOperationMetadata

A Task containing the RPC response.
Overrides

DeleteServer(DeleteServerRequest, CallSettings)

public override Operation<Empty, OperationMetadata> DeleteServer(DeleteServerRequest request, CallSettings callSettings = null)

Deletes a single Server.

Parameters
Name Description
request DeleteServerRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationEmptyOperationMetadata

The RPC response.
Overrides

DeleteServerAsync(DeleteServerRequest, CallSettings)

public override Task<Operation<Empty, OperationMetadata>> DeleteServerAsync(DeleteServerRequest request, CallSettings callSettings = null)

Deletes a single Server.

Parameters
Name Description
request DeleteServerRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationEmptyOperationMetadata

A Task containing the RPC response.
Overrides

DeleteUser(DeleteUserRequest, CallSettings)

public override Operation<Empty, OperationMetadata> DeleteUser(DeleteUserRequest request, CallSettings callSettings = null)

Deletes a single User.

Parameters
Name Description
request DeleteUserRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationEmptyOperationMetadata

The RPC response.
Overrides

DeleteUserAsync(DeleteUserRequest, CallSettings)

public override Task<Operation<Empty, OperationMetadata>> DeleteUserAsync(DeleteUserRequest request, CallSettings callSettings = null)

Deletes a single User.

Parameters
Name Description
request DeleteUserRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationEmptyOperationMetadata

A Task containing the RPC response.
Overrides

GetServer(GetServerRequest, CallSettings)

public override Server GetServer(GetServerRequest request, CallSettings callSettings = null)

Gets details of a single Server.

Parameters
Name Description
request GetServerRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Server

The RPC response.
Overrides

GetServerAsync(GetServerRequest, CallSettings)

public override Task<Server> GetServerAsync(GetServerRequest request, CallSettings callSettings = null)

Gets details of a single Server.

Parameters
Name Description
request GetServerRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskServer

A Task containing the RPC response.
Overrides

GetUser(GetUserRequest, CallSettings)

public override User GetUser(GetUserRequest request, CallSettings callSettings = null)

Gets details of a single User.

Parameters
Name Description
request GetUserRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
User

The RPC response.
Overrides

GetUserAsync(GetUserRequest, CallSettings)

public override Task<User> GetUserAsync(GetUserRequest request, CallSettings callSettings = null)

Gets details of a single User.

Parameters
Name Description
request GetUserRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskUser

A Task containing the RPC response.
Overrides

ListServers(ListServersRequest, CallSettings)

public override PagedEnumerable<ListServersResponse, Server> ListServers(ListServersRequest request, CallSettings callSettings = null)

Lists Servers in a given project and location.

Parameters
Name Description
request ListServersRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerableListServersResponseServer

A pageable sequence of Server resources.
Overrides

ListServersAsync(ListServersRequest, CallSettings)

public override PagedAsyncEnumerable<ListServersResponse, Server> ListServersAsync(ListServersRequest request, CallSettings callSettings = null)

Lists Servers in a given project and location.

Parameters
Name Description
request ListServersRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerableListServersResponseServer

A pageable asynchronous sequence of Server resources.
Overrides

ListUsers(ListUsersRequest, CallSettings)

public override PagedEnumerable<ListUsersResponse, User> ListUsers(ListUsersRequest request, CallSettings callSettings = null)

Lists Users in a given project and location.

Parameters
Name Description
request ListUsersRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerableListUsersResponseUser

A pageable sequence of User resources.
Overrides

ListUsersAsync(ListUsersRequest, CallSettings)

public override PagedAsyncEnumerable<ListUsersResponse, User> ListUsersAsync(ListUsersRequest request, CallSettings callSettings = null)

Lists Users in a given project and location.

Parameters
Name Description
request ListUsersRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerableListUsersResponseUser

A pageable asynchronous sequence of User resources.
Overrides

StartServer(StartServerRequest, CallSettings)

public override Operation<Server, OperationMetadata> StartServer(StartServerRequest request, CallSettings callSettings = null)

Starts a stopping/stopped Server.

Parameters
Name Description
request StartServerRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationServerOperationMetadata

The RPC response.
Overrides

StartServerAsync(StartServerRequest, CallSettings)

public override Task<Operation<Server, OperationMetadata>> StartServerAsync(StartServerRequest request, CallSettings callSettings = null)

Starts a stopping/stopped Server.

Parameters
Name Description
request StartServerRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationServerOperationMetadata

A Task containing the RPC response.
Overrides

StopServer(StopServerRequest, CallSettings)

public override Operation<Server, OperationMetadata> StopServer(StopServerRequest request, CallSettings callSettings = null)

Stops an active Server.

Parameters
Name Description
request StopServerRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationServerOperationMetadata

The RPC response.
Overrides

StopServerAsync(StopServerRequest, CallSettings)

public override Task<Operation<Server, OperationMetadata>> StopServerAsync(StopServerRequest request, CallSettings callSettings = null)

Stops an active Server.

Parameters
Name Description
request StopServerRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationServerOperationMetadata

A Task containing the RPC response.
Overrides

UpdateServer(UpdateServerRequest, CallSettings)

public override Operation<Server, OperationMetadata> UpdateServer(UpdateServerRequest request, CallSettings callSettings = null)

Updates the parameters of a single Server.

Parameters
Name Description
request UpdateServerRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationServerOperationMetadata

The RPC response.
Overrides

UpdateServerAsync(UpdateServerRequest, CallSettings)

public override Task<Operation<Server, OperationMetadata>> UpdateServerAsync(UpdateServerRequest request, CallSettings callSettings = null)

Updates the parameters of a single Server.

Parameters
Name Description
request UpdateServerRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationServerOperationMetadata

A Task containing the RPC response.
Overrides

UpdateUser(UpdateUserRequest, CallSettings)

public override Operation<User, OperationMetadata> UpdateUser(UpdateUserRequest request, CallSettings callSettings = null)

Updates the parameters of a single User.

Parameters
Name Description
request UpdateUserRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationUserOperationMetadata

The RPC response.
Overrides

UpdateUserAsync(UpdateUserRequest, CallSettings)

public override Task<Operation<User, OperationMetadata>> UpdateUserAsync(UpdateUserRequest request, CallSettings callSettings = null)

Updates the parameters of a single User.

Parameters
Name Description
request UpdateUserRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationUserOperationMetadata

A Task containing the RPC response.
Overrides