Class CloudFtpClient (3.9.0-rc)

Service describing handlers for resources.

Equality

Instances of this class created via copy-construction or copy-assignment always compare equal. Instances created with equal std::shared_ptr<*Connection> objects compare equal. Objects that compare equal share the same underlying resources.

Performance

Creating a new instance of this class is a relatively expensive operation, new objects establish new connections to the service. In contrast, copy-construction, move-construction, and the corresponding assignment operations are relatively efficient as the copies share all underlying resources.

Thread Safety

Concurrent access to different instances of this class, even if they compare equal, is guaranteed to work. Two or more threads operating on the same instance of this class is not guaranteed to work. Since copy-construction and move-construction is a relatively efficient operation, consider using such a copy when using this class from multiple threads.

Constructors

CloudFtpClient(CloudFtpClient const &)

Copy and move support

Parameter
Name	Description
	CloudFtpClient const &

CloudFtpClient(CloudFtpClient &&)

Copy and move support

Parameter
Name	Description
	CloudFtpClient &&

CloudFtpClient(std::shared_ptr< CloudFtpConnection >, Options)

Parameters
Name	Description
connection	std::shared_ptr< CloudFtpConnection >
opts	Options

Operators

operator=(CloudFtpClient const &)

Copy and move support

Parameter
Name	Description
	CloudFtpClient const &

Returns
Type	Description
CloudFtpClient &

operator=(CloudFtpClient &&)

Copy and move support

Parameter
Name	Description
	CloudFtpClient &&

Returns
Type	Description
CloudFtpClient &

Functions

ListServers(std::string const &, Options)

Lists Servers in a given project and location.

Parameters
Name	Description
parent	std::string const & Required. Parent value for ListServersRequest
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StreamRange< google::cloud::ftp::v1::Server >	a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.ftp.v1.Server, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListServers(google::cloud::ftp::v1::ListServersRequest, Options)

Lists Servers in a given project and location.

Parameters
Name	Description
request	google::cloud::ftp::v1::ListServersRequest Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.ftp.v1.ListServersRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StreamRange< google::cloud::ftp::v1::Server >	a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.ftp.v1.Server, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

GetServer(std::string const &, Options)

Gets details of a single Server.

Parameters
Name	Description
name	std::string const & Required. Name of the resource
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StatusOr< google::cloud::ftp::v1::Server >	the result of the RPC. The response message type (google.cloud.ftp.v1.Server) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetServer(google::cloud::ftp::v1::GetServerRequest const &, Options)

Gets details of a single Server.

Parameters
Name	Description
request	google::cloud::ftp::v1::GetServerRequest const & Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.ftp.v1.GetServerRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StatusOr< google::cloud::ftp::v1::Server >	the result of the RPC. The response message type (google.cloud.ftp.v1.Server) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

CreateServer(std::string const &, google::cloud::ftp::v1::Server const &, std::string const &, Options)

Creates a new Server in a given project and location.

Parameters
Name	Description
parent	std::string const & Required. Value for parent.
server	google::cloud::ftp::v1::Server const & Required. The resource being created
server_id	std::string const & Required. A unique ID for the server. Must start with a lowercase letter, and end with a lowercase letter or number. Can contain lowercase letters, numbers, and hyphens. Maximum length is 30 characters.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
future< StatusOr< google::cloud::ftp::v1::Server > >	A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.ftp.v1.Server proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateServer(NoAwaitTag, std::string const &, google::cloud::ftp::v1::Server const &, std::string const &, Options)

Creates a new Server in a given project and location.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name	Description
	NoAwaitTag
parent	std::string const &
server	google::cloud::ftp::v1::Server const &
server_id	std::string const &
opts	Options

Returns
Type	Description
StatusOr< google::longrunning::Operation >

CreateServer(google::cloud::ftp::v1::CreateServerRequest const &, Options)

Creates a new Server in a given project and location.

Parameters
Name	Description
request	google::cloud::ftp::v1::CreateServerRequest const & Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.ftp.v1.CreateServerRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
future< StatusOr< google::cloud::ftp::v1::Server > >	A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.ftp.v1.Server proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateServer(NoAwaitTag, google::cloud::ftp::v1::CreateServerRequest const &, Options)

Creates a new Server in a given project and location.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name	Description
	NoAwaitTag
request	google::cloud::ftp::v1::CreateServerRequest const &
opts	Options

Returns
Type	Description
StatusOr< google::longrunning::Operation >

CreateServer(google::longrunning::Operation const &, Options)

Creates a new Server in a given project and location.

This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.

Parameters
Name	Description
operation	google::longrunning::Operation const &
opts	Options

Returns
Type	Description
future< StatusOr< google::cloud::ftp::v1::Server > >

UpdateServer(google::cloud::ftp::v1::Server const &, google::protobuf::FieldMask const &, Options)

Updates the parameters of a single Server.

Parameters
Name	Description
server	google::cloud::ftp::v1::Server const & Required. The resource being updated
update_mask	google::protobuf::FieldMask const & Optional. Field mask is used to specify the fields to be overwritten in the Server resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields present in the request will be overwritten.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
future< StatusOr< google::cloud::ftp::v1::Server > >	A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.ftp.v1.Server proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

UpdateServer(NoAwaitTag, google::cloud::ftp::v1::Server const &, google::protobuf::FieldMask const &, Options)

Updates the parameters of a single Server.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name	Description
	NoAwaitTag
server	google::cloud::ftp::v1::Server const &
update_mask	google::protobuf::FieldMask const &
opts	Options

Returns
Type	Description
StatusOr< google::longrunning::Operation >

UpdateServer(google::cloud::ftp::v1::UpdateServerRequest const &, Options)

Updates the parameters of a single Server.

Parameters
Name	Description
request	google::cloud::ftp::v1::UpdateServerRequest const & Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.ftp.v1.UpdateServerRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
future< StatusOr< google::cloud::ftp::v1::Server > >	A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.ftp.v1.Server proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

UpdateServer(NoAwaitTag, google::cloud::ftp::v1::UpdateServerRequest const &, Options)

Updates the parameters of a single Server.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name	Description
	NoAwaitTag
request	google::cloud::ftp::v1::UpdateServerRequest const &
opts	Options

Returns
Type	Description
StatusOr< google::longrunning::Operation >

UpdateServer(google::longrunning::Operation const &, Options)

Updates the parameters of a single Server.

This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.

Parameters
Name	Description
operation	google::longrunning::Operation const &
opts	Options

Returns
Type	Description
future< StatusOr< google::cloud::ftp::v1::Server > >

DeleteServer(std::string const &, Options)

Deletes a single Server.

Parameters
Name	Description
name	std::string const & Required. Name of the resource
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
future< StatusOr< google::cloud::ftp::v1::OperationMetadata > >	A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.ftp.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeleteServer(NoAwaitTag, std::string const &, Options)

Deletes a single Server.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name	Description
	NoAwaitTag
name	std::string const &
opts	Options

Returns
Type	Description
StatusOr< google::longrunning::Operation >

DeleteServer(google::cloud::ftp::v1::DeleteServerRequest const &, Options)

Deletes a single Server.

Parameters
Name	Description
request	google::cloud::ftp::v1::DeleteServerRequest const & Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.ftp.v1.DeleteServerRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
future< StatusOr< google::cloud::ftp::v1::OperationMetadata > >	A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.ftp.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeleteServer(NoAwaitTag, google::cloud::ftp::v1::DeleteServerRequest const &, Options)

Deletes a single Server.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name	Description
	NoAwaitTag
request	google::cloud::ftp::v1::DeleteServerRequest const &
opts	Options

Returns
Type	Description
StatusOr< google::longrunning::Operation >

DeleteServer(google::longrunning::Operation const &, Options)

Deletes a single Server.

This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.

Parameters
Name	Description
operation	google::longrunning::Operation const &
opts	Options

Returns
Type	Description
future< StatusOr< google::cloud::ftp::v1::OperationMetadata > >

ListUsers(std::string const &, Options)

Lists Users in a given project and location.

Parameters
Name	Description
parent	std::string const & Required. Parent value for ListUsersRequest
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StreamRange< google::cloud::ftp::v1::User >	a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.ftp.v1.User, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListUsers(google::cloud::ftp::v1::ListUsersRequest, Options)

Lists Users in a given project and location.

Parameters
Name	Description
request	google::cloud::ftp::v1::ListUsersRequest Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.ftp.v1.ListUsersRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StreamRange< google::cloud::ftp::v1::User >	a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.ftp.v1.User, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

GetUser(std::string const &, Options)

Gets details of a single User.

Parameters
Name	Description
name	std::string const & Required. Name of the resource
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StatusOr< google::cloud::ftp::v1::User >	the result of the RPC. The response message type (google.cloud.ftp.v1.User) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetUser(google::cloud::ftp::v1::GetUserRequest const &, Options)

Gets details of a single User.

Parameters
Name	Description
request	google::cloud::ftp::v1::GetUserRequest const & Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.ftp.v1.GetUserRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StatusOr< google::cloud::ftp::v1::User >	the result of the RPC. The response message type (google.cloud.ftp.v1.User) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

CreateUser(std::string const &, google::cloud::ftp::v1::User const &, std::string const &, Options)

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

Parameters
Name	Description
parent	std::string const & Required. Value for parent.
user	google::cloud::ftp::v1::User const & Required. The resource being created
user_id	std::string const & Required. A unique user ID for the SFTP user. The user ID must start with a lowercase letter and can include lowercase letters, numbers, or hyphens.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
future< StatusOr< google::cloud::ftp::v1::User > >	A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.ftp.v1.User proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateUser(NoAwaitTag, std::string const &, google::cloud::ftp::v1::User const &, std::string const &, Options)

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

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name	Description
	NoAwaitTag
parent	std::string const &
user	google::cloud::ftp::v1::User const &
user_id	std::string const &
opts	Options

Returns
Type	Description
StatusOr< google::longrunning::Operation >

CreateUser(google::cloud::ftp::v1::CreateUserRequest const &, Options)

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

Parameters
Name	Description
request	google::cloud::ftp::v1::CreateUserRequest const & Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.ftp.v1.CreateUserRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
future< StatusOr< google::cloud::ftp::v1::User > >	A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.ftp.v1.User proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateUser(NoAwaitTag, google::cloud::ftp::v1::CreateUserRequest const &, Options)

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

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name	Description
	NoAwaitTag
request	google::cloud::ftp::v1::CreateUserRequest const &
opts	Options

Returns
Type	Description
StatusOr< google::longrunning::Operation >

CreateUser(google::longrunning::Operation const &, Options)

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

This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.

Parameters
Name	Description
operation	google::longrunning::Operation const &
opts	Options

Returns
Type	Description
future< StatusOr< google::cloud::ftp::v1::User > >

UpdateUser(google::cloud::ftp::v1::User const &, google::protobuf::FieldMask const &, Options)

Updates the parameters of a single User.

Parameters
Name	Description
user	google::cloud::ftp::v1::User const & Required. The resource being updated
update_mask	google::protobuf::FieldMask const & Optional. Field mask is used to specify the fields to be overwritten in the User resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields present in the request will be overwritten.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
future< StatusOr< google::cloud::ftp::v1::User > >	A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.ftp.v1.User proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

UpdateUser(NoAwaitTag, google::cloud::ftp::v1::User const &, google::protobuf::FieldMask const &, Options)

Updates the parameters of a single User.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name	Description
	NoAwaitTag
user	google::cloud::ftp::v1::User const &
update_mask	google::protobuf::FieldMask const &
opts	Options

Returns
Type	Description
StatusOr< google::longrunning::Operation >

UpdateUser(google::cloud::ftp::v1::UpdateUserRequest const &, Options)

Updates the parameters of a single User.

Parameters
Name	Description
request	google::cloud::ftp::v1::UpdateUserRequest const & Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.ftp.v1.UpdateUserRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
future< StatusOr< google::cloud::ftp::v1::User > >	A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.ftp.v1.User proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

UpdateUser(NoAwaitTag, google::cloud::ftp::v1::UpdateUserRequest const &, Options)

Updates the parameters of a single User.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name	Description
	NoAwaitTag
request	google::cloud::ftp::v1::UpdateUserRequest const &
opts	Options

Returns
Type	Description
StatusOr< google::longrunning::Operation >

UpdateUser(google::longrunning::Operation const &, Options)

Updates the parameters of a single User.

This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.

Parameters
Name	Description
operation	google::longrunning::Operation const &
opts	Options

Returns
Type	Description
future< StatusOr< google::cloud::ftp::v1::User > >

DeleteUser(std::string const &, Options)

Deletes a single User.

Parameters
Name	Description
name	std::string const & Required. Name of the resource
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
future< StatusOr< google::cloud::ftp::v1::OperationMetadata > >	A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.ftp.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeleteUser(NoAwaitTag, std::string const &, Options)

Deletes a single User.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name	Description
	NoAwaitTag
name	std::string const &
opts	Options

Returns
Type	Description
StatusOr< google::longrunning::Operation >

DeleteUser(google::cloud::ftp::v1::DeleteUserRequest const &, Options)

Deletes a single User.

Parameters
Name	Description
request	google::cloud::ftp::v1::DeleteUserRequest const & Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.ftp.v1.DeleteUserRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
future< StatusOr< google::cloud::ftp::v1::OperationMetadata > >	A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.ftp.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeleteUser(NoAwaitTag, google::cloud::ftp::v1::DeleteUserRequest const &, Options)

Deletes a single User.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name	Description
	NoAwaitTag
request	google::cloud::ftp::v1::DeleteUserRequest const &
opts	Options

Returns
Type	Description
StatusOr< google::longrunning::Operation >

DeleteUser(google::longrunning::Operation const &, Options)

Deletes a single User.

This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.

Parameters
Name	Description
operation	google::longrunning::Operation const &
opts	Options

Returns
Type	Description
future< StatusOr< google::cloud::ftp::v1::OperationMetadata > >

StartServer(std::string const &, Options)

Starts a stopping/stopped Server.

Parameters
Name	Description
name	std::string const & Required. Name of the resource Format: projects/{project}/locations/{location}/servers/{server}
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
future< StatusOr< google::cloud::ftp::v1::Server > >	A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.ftp.v1.Server proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

StartServer(NoAwaitTag, std::string const &, Options)

Starts a stopping/stopped Server.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name	Description
	NoAwaitTag
name	std::string const &
opts	Options

Returns
Type	Description
StatusOr< google::longrunning::Operation >

StartServer(google::cloud::ftp::v1::StartServerRequest const &, Options)

Starts a stopping/stopped Server.

Parameters
Name	Description
request	google::cloud::ftp::v1::StartServerRequest const & Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.ftp.v1.StartServerRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
future< StatusOr< google::cloud::ftp::v1::Server > >	A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.ftp.v1.Server proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

StartServer(NoAwaitTag, google::cloud::ftp::v1::StartServerRequest const &, Options)

Starts a stopping/stopped Server.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name	Description
	NoAwaitTag
request	google::cloud::ftp::v1::StartServerRequest const &
opts	Options

Returns
Type	Description
StatusOr< google::longrunning::Operation >

StartServer(google::longrunning::Operation const &, Options)

Starts a stopping/stopped Server.

This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.

Parameters
Name	Description
operation	google::longrunning::Operation const &
opts	Options

Returns
Type	Description
future< StatusOr< google::cloud::ftp::v1::Server > >

StopServer(std::string const &, Options)

Stops an active Server.

Parameters
Name	Description
name	std::string const & Required. Name of the resource. Format: projects/{project}/locations/{location}/servers/{server}
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
future< StatusOr< google::cloud::ftp::v1::Server > >	A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.ftp.v1.Server proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

StopServer(NoAwaitTag, std::string const &, Options)

Stops an active Server.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name	Description
	NoAwaitTag
name	std::string const &
opts	Options

Returns
Type	Description
StatusOr< google::longrunning::Operation >

StopServer(google::cloud::ftp::v1::StopServerRequest const &, Options)

Stops an active Server.

Parameters
Name	Description
request	google::cloud::ftp::v1::StopServerRequest const & Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.ftp.v1.StopServerRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
future< StatusOr< google::cloud::ftp::v1::Server > >	A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.ftp.v1.Server proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

StopServer(NoAwaitTag, google::cloud::ftp::v1::StopServerRequest const &, Options)

Stops an active Server.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name	Description
	NoAwaitTag
request	google::cloud::ftp::v1::StopServerRequest const &
opts	Options

Returns
Type	Description
StatusOr< google::longrunning::Operation >

StopServer(google::longrunning::Operation const &, Options)

Stops an active Server.

This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.

Parameters
Name	Description
operation	google::longrunning::Operation const &
opts	Options

Returns
Type	Description
future< StatusOr< google::cloud::ftp::v1::Server > >

ListLocations(google::cloud::location::ListLocationsRequest, Options)

Lists information about the supported locations for this service.

Parameters
Name	Description
request	google::cloud::location::ListLocationsRequest Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.location.ListLocationsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StreamRange< google::cloud::location::Location >	a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.location.Location, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

GetLocation(google::cloud::location::GetLocationRequest const &, Options)

Gets information about a location.

Parameters
Name	Description
request	google::cloud::location::GetLocationRequest const & Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.location.GetLocationRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StatusOr< google::cloud::location::Location >	the result of the RPC. The response message type (google.cloud.location.Location) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

ListOperations(std::string const &, std::string const &, Options)

Lists operations that match the specified filter in the request.

If the server doesn't support this method, it returns UNIMPLEMENTED.

Parameters
Name	Description
name	std::string const & The name of the operation's parent resource.
filter	std::string const & The standard list filter.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StreamRange< google::longrunning::Operation >	a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.longrunning.Operation, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListOperations(google::longrunning::ListOperationsRequest, Options)

Lists operations that match the specified filter in the request.

If the server doesn't support this method, it returns UNIMPLEMENTED.

Parameters
Name	Description
request	google::longrunning::ListOperationsRequest Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.longrunning.ListOperationsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StreamRange< google::longrunning::Operation >	a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.longrunning.Operation, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

GetOperation(std::string const &, Options)

Gets the latest state of a long-running operation.

Clients can use this method to poll the operation result at intervals as recommended by the API service.

Parameters
Name	Description
name	std::string const & The name of the operation resource.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StatusOr< google::longrunning::Operation >	the result of the RPC. The response message type (google.longrunning.Operation) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetOperation(google::longrunning::GetOperationRequest const &, Options)

Gets the latest state of a long-running operation.

Clients can use this method to poll the operation result at intervals as recommended by the API service.

Parameters
Name	Description
request	google::longrunning::GetOperationRequest const & Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.longrunning.GetOperationRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StatusOr< google::longrunning::Operation >	the result of the RPC. The response message type (google.longrunning.Operation) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

DeleteOperation(std::string const &, Options)

Deletes a long-running operation.

This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.

Parameters
Name	Description
name	std::string const & The name of the operation resource to be deleted.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
Status	a Status object. If the request failed, the status contains the details of the failure.

DeleteOperation(google::longrunning::DeleteOperationRequest const &, Options)

Deletes a long-running operation.

This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.

Parameters
Name	Description
request	google::longrunning::DeleteOperationRequest const & Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.longrunning.DeleteOperationRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
Status	a Status object. If the request failed, the status contains the details of the failure.

CancelOperation(std::string const &, Options)

Starts asynchronous cancellation on a long-running operation.

The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

Parameters
Name	Description
name	std::string const & The name of the operation resource to be cancelled.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
Status	a Status object. If the request failed, the status contains the details of the failure.

CancelOperation(google::longrunning::CancelOperationRequest const &, Options)

Starts asynchronous cancellation on a long-running operation.

The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

Parameters
Name	Description
request	google::longrunning::CancelOperationRequest const & Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.longrunning.CancelOperationRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
Status	a Status object. If the request failed, the status contains the details of the failure.