Class CloudFtpConnection (3.9.0-rc)
This interface defines virtual methods for each of the user-facing overload sets in CloudFtpClient. This allows users to inject custom behavior (e.g., with a Google Mock object) when writing tests that use objects of type CloudFtpClient.
To create a concrete instance, see MakeCloudFtpConnection().
For mocking, see ftp_v1_mocks::MockCloudFtpConnection.
Functions
virtual options()
| Returns |
| Type |
Description |
Options |
|
virtual ListServers(google::cloud::ftp::v1::ListServersRequest)
| Parameter |
| Name |
Description |
request |
google::cloud::ftp::v1::ListServersRequest
|
| Returns |
| Type |
Description |
StreamRange< google::cloud::ftp::v1::Server > |
|
virtual GetServer(google::cloud::ftp::v1::GetServerRequest const &)
| Parameter |
| Name |
Description |
request |
google::cloud::ftp::v1::GetServerRequest const &
|
| Returns |
| Type |
Description |
StatusOr< google::cloud::ftp::v1::Server > |
|
virtual CreateServer(google::cloud::ftp::v1::CreateServerRequest const &)
| Parameter |
| Name |
Description |
request |
google::cloud::ftp::v1::CreateServerRequest const &
|
| Returns |
| Type |
Description |
future< StatusOr< google::cloud::ftp::v1::Server > > |
|
virtual CreateServer(NoAwaitTag, google::cloud::ftp::v1::CreateServerRequest const &)
| Parameters |
| Name |
Description |
|
NoAwaitTag
|
request |
google::cloud::ftp::v1::CreateServerRequest const &
|
| Returns |
| Type |
Description |
StatusOr< google::longrunning::Operation > |
|
virtual CreateServer(google::longrunning::Operation const &)
| Parameter |
| Name |
Description |
operation |
google::longrunning::Operation const &
|
| Returns |
| Type |
Description |
future< StatusOr< google::cloud::ftp::v1::Server > > |
|
virtual UpdateServer(google::cloud::ftp::v1::UpdateServerRequest const &)
| Parameter |
| Name |
Description |
request |
google::cloud::ftp::v1::UpdateServerRequest const &
|
| Returns |
| Type |
Description |
future< StatusOr< google::cloud::ftp::v1::Server > > |
|
virtual UpdateServer(NoAwaitTag, google::cloud::ftp::v1::UpdateServerRequest const &)
| Parameters |
| Name |
Description |
|
NoAwaitTag
|
request |
google::cloud::ftp::v1::UpdateServerRequest const &
|
| Returns |
| Type |
Description |
StatusOr< google::longrunning::Operation > |
|
virtual UpdateServer(google::longrunning::Operation const &)
| Parameter |
| Name |
Description |
operation |
google::longrunning::Operation const &
|
| Returns |
| Type |
Description |
future< StatusOr< google::cloud::ftp::v1::Server > > |
|
virtual DeleteServer(google::cloud::ftp::v1::DeleteServerRequest const &)
| Parameter |
| Name |
Description |
request |
google::cloud::ftp::v1::DeleteServerRequest const &
|
| Returns |
| Type |
Description |
future< StatusOr< google::cloud::ftp::v1::OperationMetadata > > |
|
virtual DeleteServer(NoAwaitTag, google::cloud::ftp::v1::DeleteServerRequest const &)
| Parameters |
| Name |
Description |
|
NoAwaitTag
|
request |
google::cloud::ftp::v1::DeleteServerRequest const &
|
| Returns |
| Type |
Description |
StatusOr< google::longrunning::Operation > |
|
virtual DeleteServer(google::longrunning::Operation const &)
| Parameter |
| Name |
Description |
operation |
google::longrunning::Operation const &
|
| Returns |
| Type |
Description |
future< StatusOr< google::cloud::ftp::v1::OperationMetadata > > |
|
virtual ListUsers(google::cloud::ftp::v1::ListUsersRequest)
| Parameter |
| Name |
Description |
request |
google::cloud::ftp::v1::ListUsersRequest
|
| Returns |
| Type |
Description |
StreamRange< google::cloud::ftp::v1::User > |
|
virtual GetUser(google::cloud::ftp::v1::GetUserRequest const &)
| Parameter |
| Name |
Description |
request |
google::cloud::ftp::v1::GetUserRequest const &
|
| Returns |
| Type |
Description |
StatusOr< google::cloud::ftp::v1::User > |
|
virtual CreateUser(google::cloud::ftp::v1::CreateUserRequest const &)
| Parameter |
| Name |
Description |
request |
google::cloud::ftp::v1::CreateUserRequest const &
|
| Returns |
| Type |
Description |
future< StatusOr< google::cloud::ftp::v1::User > > |
|
virtual CreateUser(NoAwaitTag, google::cloud::ftp::v1::CreateUserRequest const &)
| Parameters |
| Name |
Description |
|
NoAwaitTag
|
request |
google::cloud::ftp::v1::CreateUserRequest const &
|
| Returns |
| Type |
Description |
StatusOr< google::longrunning::Operation > |
|
virtual CreateUser(google::longrunning::Operation const &)
| Parameter |
| Name |
Description |
operation |
google::longrunning::Operation const &
|
| Returns |
| Type |
Description |
future< StatusOr< google::cloud::ftp::v1::User > > |
|
virtual UpdateUser(google::cloud::ftp::v1::UpdateUserRequest const &)
| Parameter |
| Name |
Description |
request |
google::cloud::ftp::v1::UpdateUserRequest const &
|
| Returns |
| Type |
Description |
future< StatusOr< google::cloud::ftp::v1::User > > |
|
virtual UpdateUser(NoAwaitTag, google::cloud::ftp::v1::UpdateUserRequest const &)
| Parameters |
| Name |
Description |
|
NoAwaitTag
|
request |
google::cloud::ftp::v1::UpdateUserRequest const &
|
| Returns |
| Type |
Description |
StatusOr< google::longrunning::Operation > |
|
virtual UpdateUser(google::longrunning::Operation const &)
| Parameter |
| Name |
Description |
operation |
google::longrunning::Operation const &
|
| Returns |
| Type |
Description |
future< StatusOr< google::cloud::ftp::v1::User > > |
|
virtual DeleteUser(google::cloud::ftp::v1::DeleteUserRequest const &)
| Parameter |
| Name |
Description |
request |
google::cloud::ftp::v1::DeleteUserRequest const &
|
| Returns |
| Type |
Description |
future< StatusOr< google::cloud::ftp::v1::OperationMetadata > > |
|
virtual DeleteUser(NoAwaitTag, google::cloud::ftp::v1::DeleteUserRequest const &)
| Parameters |
| Name |
Description |
|
NoAwaitTag
|
request |
google::cloud::ftp::v1::DeleteUserRequest const &
|
| Returns |
| Type |
Description |
StatusOr< google::longrunning::Operation > |
|
virtual DeleteUser(google::longrunning::Operation const &)
| Parameter |
| Name |
Description |
operation |
google::longrunning::Operation const &
|
| Returns |
| Type |
Description |
future< StatusOr< google::cloud::ftp::v1::OperationMetadata > > |
|
virtual StartServer(google::cloud::ftp::v1::StartServerRequest const &)
| Parameter |
| Name |
Description |
request |
google::cloud::ftp::v1::StartServerRequest const &
|
| Returns |
| Type |
Description |
future< StatusOr< google::cloud::ftp::v1::Server > > |
|
virtual StartServer(NoAwaitTag, google::cloud::ftp::v1::StartServerRequest const &)
| Parameters |
| Name |
Description |
|
NoAwaitTag
|
request |
google::cloud::ftp::v1::StartServerRequest const &
|
| Returns |
| Type |
Description |
StatusOr< google::longrunning::Operation > |
|
virtual StartServer(google::longrunning::Operation const &)
| Parameter |
| Name |
Description |
operation |
google::longrunning::Operation const &
|
| Returns |
| Type |
Description |
future< StatusOr< google::cloud::ftp::v1::Server > > |
|
virtual StopServer(google::cloud::ftp::v1::StopServerRequest const &)
| Parameter |
| Name |
Description |
request |
google::cloud::ftp::v1::StopServerRequest const &
|
| Returns |
| Type |
Description |
future< StatusOr< google::cloud::ftp::v1::Server > > |
|
virtual StopServer(NoAwaitTag, google::cloud::ftp::v1::StopServerRequest const &)
| Parameters |
| Name |
Description |
|
NoAwaitTag
|
request |
google::cloud::ftp::v1::StopServerRequest const &
|
| Returns |
| Type |
Description |
StatusOr< google::longrunning::Operation > |
|
virtual StopServer(google::longrunning::Operation const &)
| Parameter |
| Name |
Description |
operation |
google::longrunning::Operation const &
|
| Returns |
| Type |
Description |
future< StatusOr< google::cloud::ftp::v1::Server > > |
|
virtual ListLocations(google::cloud::location::ListLocationsRequest)
| Parameter |
| Name |
Description |
request |
google::cloud::location::ListLocationsRequest
|
| Returns |
| Type |
Description |
StreamRange< google::cloud::location::Location > |
|
virtual GetLocation(google::cloud::location::GetLocationRequest const &)
| Parameter |
| Name |
Description |
request |
google::cloud::location::GetLocationRequest const &
|
| Returns |
| Type |
Description |
StatusOr< google::cloud::location::Location > |
|
virtual ListOperations(google::longrunning::ListOperationsRequest)
| Parameter |
| Name |
Description |
request |
google::longrunning::ListOperationsRequest
|
| Returns |
| Type |
Description |
StreamRange< google::longrunning::Operation > |
|
virtual GetOperation(google::longrunning::GetOperationRequest const &)
| Parameter |
| Name |
Description |
request |
google::longrunning::GetOperationRequest const &
|
| Returns |
| Type |
Description |
StatusOr< google::longrunning::Operation > |
|
virtual DeleteOperation(google::longrunning::DeleteOperationRequest const &)
| Parameter |
| Name |
Description |
request |
google::longrunning::DeleteOperationRequest const &
|
| Returns |
| Type |
Description |
Status |
|
virtual CancelOperation(google::longrunning::CancelOperationRequest const &)
| Parameter |
| Name |
Description |
request |
google::longrunning::CancelOperationRequest const &
|
| Returns |
| Type |
Description |
Status |
|
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2026-08-21 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2026-08-21 UTC."],[],[]]
