Classes
CloudFtp
Service describing handlers for resources
CloudFtp.CloudFtpBase
Base class for server-side implementations of CloudFtp
CloudFtp.CloudFtpClient
Client for CloudFtp
CloudFtpClient
CloudFtp client wrapper, for convenient use.
CloudFtpClientBuilder
Builder class for CloudFtpClient to provide simple configuration of credentials, endpoint etc.
CloudFtpClientImpl
CloudFtp client wrapper implementation, for convenient use.
CloudFtpSettings
Settings for CloudFtpClient instances.
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.
ForwardingRuleName
Resource name for the ForwardingRule resource.
GetServerRequest
Message for getting a Server
GetUserRequest
Message for getting a User
InternalServerConfig
Configuration for private server accessible via PSC.
InternalServerConfig.Types
Container for nested types declared in the InternalServerConfig message type.
InternalServerConfig.Types.AllowedConsumer
A consumer project or network that is permitted to connect to the server via PSC.
InternalServerConfig.Types.DeniedConsumer
A consumer project or network that is denied to connect to the server via PSC.
InternalServerConfig.Types.PscEndpoint
Details of PSC endpoint created by customer.
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
NetworkName
Resource name for the Network resource.
OperationMetadata
Represents the metadata of the long-running operation.
Server
Message describing Server object
Server.Types
Container for nested types declared in the Server message type.
ServerCredential
Represents credentials of an FTP Server.
ServerName
Resource name for the Server resource.
ServiceAttachmentName
Resource name for the ServiceAttachment 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.
StorageDirectoryMapping.Types
Container for nested types declared in the StorageDirectoryMapping message type.
UpdateServerRequest
Message for updating a Server
UpdateUserRequest
Message for updating a User
User
Message describing User object
User.Types
Container for nested types declared in the User message type.
UserCredential
Message describing UserCredential object
UserCredential.Types
Container for nested types declared in the UserCredential message type.
UserName
Resource name for the User resource.
Enums
ForwardingRuleName.ResourceNameType
The possible contents of ForwardingRuleName.
InternalServerConfig.Types.AllowedConsumer.ConsumerTypeOneofCase
Enum of possible cases for the "consumer_type" oneof.
InternalServerConfig.Types.DeniedConsumer.ConsumerTypeOneofCase
Enum of possible cases for the "consumer_type" oneof.
NetworkName.ResourceNameType
The possible contents of NetworkName.
Server.AccessConfigOneofCase
Enum of possible cases for the "access_config" oneof.
Server.Types.AccessType
The access type of the Server.
Server.Types.State
Tracks Server status.
ServerName.ResourceNameType
The possible contents of ServerName.
ServerView
View for Server resource.
ServiceAttachmentName.ResourceNameType
The possible contents of ServiceAttachmentName.
StorageDirectoryMapping.Types.Permission
Tracks read/write access to the bucket.
User.Types.State
Tracks user creation.
UserCredential.Types.Type
Type of credential.
UserName.ResourceNameType
The possible contents of UserName.
UserView
View for User resource.