API documentation for ftp_v1.types package.
Classes
CreateServerRequest
Message for creating a Server
CreateUserRequest
Message for creating a User
DeleteServerRequest
Message for deleting a Server Note: Cascading delete is not supported. Any nested User resources under this Server must be deleted before the Server itself can be deleted. Attempting to delete a Server with active User resources will result in an error.
DeleteUserRequest
Message for deleting a User
ExternalServerConfig
Configuration for external server.
GetServerRequest
Message for getting a Server
GetUserRequest
Message for getting a User
InternalServerConfig
Configuration for private server accessible via PSC.
ListServersRequest
Message for requesting list of Servers
ListServersResponse
Message for response to listing Servers
ListUsersRequest
Message for requesting list of Users
ListUsersResponse
Message for response to listing Users
OperationMetadata
Represents the metadata of the long-running operation.
Server
Message describing Server object
This message has oneof_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
members.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
ServerCredential
Represents credentials of an FTP Server.
ServerView
View for Server resource.
StartServerRequest
Request message for starting a Server.
StopServerRequest
Request message for stopping a Server.
StorageDirectoryMapping
Mapping of backing Cloud Storage path to the directory where the user lands in the SFTP server. If directory is not specified, it'll default to '/'.
Eg 1 - (bucket_name: bucket, bucket_prefix: path1/path2, directory: /abc/def/username)
The user will land at /abcd/def/username, and the view there will match that of /bucket/path1/path2. The user will not be aware of Cloud Storage prefix '/bucket/path1' and there will be no such directory in the view.
Eg 2 - (bucket_name: bucket, bucket_prefix: path1/path2, directory: '')
The user will land at '/', and the view there will match that of /bucket/path1/path2. The user will not be aware of Cloud Storage prefix '/bucket/path1/path2' and there will be no such directory in the view.
UpdateServerRequest
Message for updating a Server
UpdateUserRequest
Message for updating a User
User
Message describing User object
UserCredential
Message describing UserCredential object
UserView
View for User resource.