Package com.google.cloud.ftp.v1 (0.4.0)

GitHub Repository

Client Classes

Client classes are the main entry point to using a package. They contain several variations of Java methods for each of the API's methods.

Client Description
com.google.cloud.ftp.v1.CloudFtpClient Service Description: Service describing handlers for resources

This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:

Settings Classes

Settings classes can be used to configure credentials, endpoints, and retry settings for a Client.

Settings Description
com.google.cloud.ftp.v1.CloudFtpSettings Settings class to configure an instance of CloudFtpClient.

The default instance has everything set to sensible defaults:

Classes

Class Description
com.google.cloud.ftp.v1.CloudFtpClient.ListLocationsFixedSizeCollection
com.google.cloud.ftp.v1.CloudFtpClient.ListLocationsPage
com.google.cloud.ftp.v1.CloudFtpClient.ListLocationsPagedResponse
com.google.cloud.ftp.v1.CloudFtpClient.ListServersFixedSizeCollection
com.google.cloud.ftp.v1.CloudFtpClient.ListServersPage
com.google.cloud.ftp.v1.CloudFtpClient.ListServersPagedResponse
com.google.cloud.ftp.v1.CloudFtpClient.ListUsersFixedSizeCollection
com.google.cloud.ftp.v1.CloudFtpClient.ListUsersPage
com.google.cloud.ftp.v1.CloudFtpClient.ListUsersPagedResponse
com.google.cloud.ftp.v1.CloudFtpSettings.Builder Builder for CloudFtpSettings.
com.google.cloud.ftp.v1.CreateServerRequest Message for creating a Server
com.google.cloud.ftp.v1.CreateServerRequest.Builder Message for creating a Server
com.google.cloud.ftp.v1.CreateUserRequest Message for creating a User
com.google.cloud.ftp.v1.CreateUserRequest.Builder Message for creating a User
com.google.cloud.ftp.v1.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.
com.google.cloud.ftp.v1.DeleteServerRequest.Builder 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.
com.google.cloud.ftp.v1.DeleteUserRequest Message for deleting a User
com.google.cloud.ftp.v1.DeleteUserRequest.Builder Message for deleting a User
com.google.cloud.ftp.v1.ExternalServerConfig Configuration for external server.
com.google.cloud.ftp.v1.ExternalServerConfig.Builder Configuration for external server.
com.google.cloud.ftp.v1.GetServerRequest Message for getting a Server
com.google.cloud.ftp.v1.GetServerRequest.Builder Message for getting a Server
com.google.cloud.ftp.v1.GetUserRequest Message for getting a User
com.google.cloud.ftp.v1.GetUserRequest.Builder Message for getting a User
com.google.cloud.ftp.v1.InternalServerConfig Configuration for private server accessible via PSC.
com.google.cloud.ftp.v1.InternalServerConfig.AllowedConsumer A consumer project or network that is permitted to connect to the server via PSC.
com.google.cloud.ftp.v1.InternalServerConfig.AllowedConsumer.Builder A consumer project or network that is permitted to connect to the server via PSC.
com.google.cloud.ftp.v1.InternalServerConfig.Builder Configuration for private server accessible via PSC.
com.google.cloud.ftp.v1.InternalServerConfig.DeniedConsumer A consumer project or network that is denied to connect to the server via PSC.
com.google.cloud.ftp.v1.InternalServerConfig.DeniedConsumer.Builder A consumer project or network that is denied to connect to the server via PSC.
com.google.cloud.ftp.v1.InternalServerConfig.PscEndpoint Details of PSC endpoint created by customer.
com.google.cloud.ftp.v1.InternalServerConfig.PscEndpoint.Builder Details of PSC endpoint created by customer.
com.google.cloud.ftp.v1.ListServersRequest Message for requesting list of Servers
com.google.cloud.ftp.v1.ListServersRequest.Builder Message for requesting list of Servers
com.google.cloud.ftp.v1.ListServersResponse Message for response to listing Servers
com.google.cloud.ftp.v1.ListServersResponse.Builder Message for response to listing Servers
com.google.cloud.ftp.v1.ListUsersRequest Message for requesting list of Users
com.google.cloud.ftp.v1.ListUsersRequest.Builder Message for requesting list of Users
com.google.cloud.ftp.v1.ListUsersResponse Message for response to listing Users
com.google.cloud.ftp.v1.ListUsersResponse.Builder Message for response to listing Users
com.google.cloud.ftp.v1.LocationName
com.google.cloud.ftp.v1.LocationName.Builder Builder for projects/{project}/locations/{location}.
com.google.cloud.ftp.v1.OperationMetadata Represents the metadata of the long-running operation.
com.google.cloud.ftp.v1.OperationMetadata.Builder Represents the metadata of the long-running operation.
com.google.cloud.ftp.v1.Server Message describing Server object
com.google.cloud.ftp.v1.Server.Builder Message describing Server object
com.google.cloud.ftp.v1.ServerCredential Represents credentials of an FTP Server.
com.google.cloud.ftp.v1.ServerCredential.Builder Represents credentials of an FTP Server.
com.google.cloud.ftp.v1.ServerName
com.google.cloud.ftp.v1.ServerName.Builder Builder for projects/{project}/locations/{location}/servers/{server}.
com.google.cloud.ftp.v1.ServiceProto
com.google.cloud.ftp.v1.StartServerRequest Request message for starting a Server.
com.google.cloud.ftp.v1.StartServerRequest.Builder Request message for starting a Server.
com.google.cloud.ftp.v1.StopServerRequest Request message for stopping a Server.
com.google.cloud.ftp.v1.StopServerRequest.Builder Request message for stopping a Server.
com.google.cloud.ftp.v1.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 '/'.
com.google.cloud.ftp.v1.StorageDirectoryMapping.Builder 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 '/'.
com.google.cloud.ftp.v1.UpdateServerRequest Message for updating a Server
com.google.cloud.ftp.v1.UpdateServerRequest.Builder Message for updating a Server
com.google.cloud.ftp.v1.UpdateUserRequest Message for updating a User
com.google.cloud.ftp.v1.UpdateUserRequest.Builder Message for updating a User
com.google.cloud.ftp.v1.User Message describing User object
com.google.cloud.ftp.v1.User.Builder Message describing User object
com.google.cloud.ftp.v1.UserCredential Message describing UserCredential object
com.google.cloud.ftp.v1.UserCredential.Builder Message describing UserCredential object
com.google.cloud.ftp.v1.UserName
com.google.cloud.ftp.v1.UserName.Builder Builder for projects/{project}/locations/{location}/servers/{server}/users/{user}.

Interfaces

Interface Description
com.google.cloud.ftp.v1.CreateServerRequestOrBuilder
com.google.cloud.ftp.v1.CreateUserRequestOrBuilder
com.google.cloud.ftp.v1.DeleteServerRequestOrBuilder
com.google.cloud.ftp.v1.DeleteUserRequestOrBuilder
com.google.cloud.ftp.v1.ExternalServerConfigOrBuilder
com.google.cloud.ftp.v1.GetServerRequestOrBuilder
com.google.cloud.ftp.v1.GetUserRequestOrBuilder
com.google.cloud.ftp.v1.InternalServerConfig.AllowedConsumerOrBuilder
com.google.cloud.ftp.v1.InternalServerConfig.DeniedConsumerOrBuilder
com.google.cloud.ftp.v1.InternalServerConfig.PscEndpointOrBuilder
com.google.cloud.ftp.v1.InternalServerConfigOrBuilder
com.google.cloud.ftp.v1.ListServersRequestOrBuilder
com.google.cloud.ftp.v1.ListServersResponseOrBuilder
com.google.cloud.ftp.v1.ListUsersRequestOrBuilder
com.google.cloud.ftp.v1.ListUsersResponseOrBuilder
com.google.cloud.ftp.v1.OperationMetadataOrBuilder
com.google.cloud.ftp.v1.ServerCredentialOrBuilder
com.google.cloud.ftp.v1.ServerOrBuilder
com.google.cloud.ftp.v1.StartServerRequestOrBuilder
com.google.cloud.ftp.v1.StopServerRequestOrBuilder
com.google.cloud.ftp.v1.StorageDirectoryMappingOrBuilder
com.google.cloud.ftp.v1.UpdateServerRequestOrBuilder
com.google.cloud.ftp.v1.UpdateUserRequestOrBuilder
com.google.cloud.ftp.v1.UserCredentialOrBuilder
com.google.cloud.ftp.v1.UserOrBuilder

Enums

Enum Description
com.google.cloud.ftp.v1.InternalServerConfig.AllowedConsumer.ConsumerTypeCase
com.google.cloud.ftp.v1.InternalServerConfig.DeniedConsumer.ConsumerTypeCase
com.google.cloud.ftp.v1.Server.AccessConfigCase
com.google.cloud.ftp.v1.Server.AccessType The access type of the Server.
com.google.cloud.ftp.v1.Server.State Tracks Server status.
com.google.cloud.ftp.v1.ServerView View for Server resource.
com.google.cloud.ftp.v1.StorageDirectoryMapping.Permission Tracks read/write access to the bucket.
com.google.cloud.ftp.v1.User.State Tracks user creation.
com.google.cloud.ftp.v1.UserCredential.Type Type of credential.
com.google.cloud.ftp.v1.UserView View for User resource.