Summary of entries of Classes for google-cloud-ftp.

## Classes

### [CloudFtpClient](https://docs.cloud.google.com/python/docs/reference/google-cloud-ftp/latest/google.cloud.ftp_v1.services.cloud_ftp.CloudFtpClient)

Service describing handlers for resources

### [ListServersPager](https://docs.cloud.google.com/python/docs/reference/google-cloud-ftp/latest/google.cloud.ftp_v1.services.cloud_ftp.pagers.ListServersPager)

A pager for iterating through `list_servers` requests.

This class thinly wraps an initial
[ListServersResponse](https://docs.cloud.google.com/python/docs/reference/google-cloud-ftp/latest/google.cloud.ftp_v1.types.ListServersResponse) object, and
provides an `__iter__` method to iterate through its
`servers` field.

If there are more pages, the `__iter__` method will make additional
`ListServers` requests and continue to iterate
through the `servers` field on the
corresponding responses.

All the usual [ListServersResponse](https://docs.cloud.google.com/python/docs/reference/google-cloud-ftp/latest/google.cloud.ftp_v1.types.ListServersResponse)
attributes are available on the pager. If multiple requests are made, only
the most recent response is retained, and thus used for attribute lookup.

### [ListUsersPager](https://docs.cloud.google.com/python/docs/reference/google-cloud-ftp/latest/google.cloud.ftp_v1.services.cloud_ftp.pagers.ListUsersPager)

A pager for iterating through `list_users` requests.

This class thinly wraps an initial
[ListUsersResponse](https://docs.cloud.google.com/python/docs/reference/google-cloud-ftp/latest/google.cloud.ftp_v1.types.ListUsersResponse) object, and
provides an `__iter__` method to iterate through its
`users` field.

If there are more pages, the `__iter__` method will make additional
`ListUsers` requests and continue to iterate
through the `users` field on the
corresponding responses.

All the usual [ListUsersResponse](https://docs.cloud.google.com/python/docs/reference/google-cloud-ftp/latest/google.cloud.ftp_v1.types.ListUsersResponse)
attributes are available on the pager. If multiple requests are made, only
the most recent response is retained, and thus used for attribute lookup.

### [CreateServerRequest](https://docs.cloud.google.com/python/docs/reference/google-cloud-ftp/latest/google.cloud.ftp_v1.types.CreateServerRequest)

Message for creating a Server

### [CreateUserRequest](https://docs.cloud.google.com/python/docs/reference/google-cloud-ftp/latest/google.cloud.ftp_v1.types.CreateUserRequest)

Message for creating a User

### [DeleteServerRequest](https://docs.cloud.google.com/python/docs/reference/google-cloud-ftp/latest/google.cloud.ftp_v1.types.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](https://docs.cloud.google.com/python/docs/reference/google-cloud-ftp/latest/google.cloud.ftp_v1.types.DeleteUserRequest)

Message for deleting a User

### [ExternalServerConfig](https://docs.cloud.google.com/python/docs/reference/google-cloud-ftp/latest/google.cloud.ftp_v1.types.ExternalServerConfig)

Configuration for external server.

### [GetServerRequest](https://docs.cloud.google.com/python/docs/reference/google-cloud-ftp/latest/google.cloud.ftp_v1.types.GetServerRequest)

Message for getting a Server

### [GetUserRequest](https://docs.cloud.google.com/python/docs/reference/google-cloud-ftp/latest/google.cloud.ftp_v1.types.GetUserRequest)

Message for getting a User

### [InternalServerConfig](https://docs.cloud.google.com/python/docs/reference/google-cloud-ftp/latest/google.cloud.ftp_v1.types.InternalServerConfig)

Configuration for private server accessible via PSC.

### [AllowedConsumer](https://docs.cloud.google.com/python/docs/reference/google-cloud-ftp/latest/google.cloud.ftp_v1.types.InternalServerConfig.AllowedConsumer)

A consumer project or network that is permitted to connect to
the server via PSC.

.. _oneof: <https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields>

### [DeniedConsumer](https://docs.cloud.google.com/python/docs/reference/google-cloud-ftp/latest/google.cloud.ftp_v1.types.InternalServerConfig.DeniedConsumer)

A consumer project or network that is denied to connect to
the server via PSC.

.. _oneof: <https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields>

### [PscEndpoint](https://docs.cloud.google.com/python/docs/reference/google-cloud-ftp/latest/google.cloud.ftp_v1.types.InternalServerConfig.PscEndpoint)

Details of PSC endpoint created by customer.

### [ListServersRequest](https://docs.cloud.google.com/python/docs/reference/google-cloud-ftp/latest/google.cloud.ftp_v1.types.ListServersRequest)

Message for requesting list of Servers

### [ListServersResponse](https://docs.cloud.google.com/python/docs/reference/google-cloud-ftp/latest/google.cloud.ftp_v1.types.ListServersResponse)

Message for response to listing Servers

### [ListUsersRequest](https://docs.cloud.google.com/python/docs/reference/google-cloud-ftp/latest/google.cloud.ftp_v1.types.ListUsersRequest)

Message for requesting list of Users

### [ListUsersResponse](https://docs.cloud.google.com/python/docs/reference/google-cloud-ftp/latest/google.cloud.ftp_v1.types.ListUsersResponse)

Message for response to listing Users

### [OperationMetadata](https://docs.cloud.google.com/python/docs/reference/google-cloud-ftp/latest/google.cloud.ftp_v1.types.OperationMetadata)

Represents the metadata of the long-running operation.

### [Server](https://docs.cloud.google.com/python/docs/reference/google-cloud-ftp/latest/google.cloud.ftp_v1.types.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>

### [AccessType](https://docs.cloud.google.com/python/docs/reference/google-cloud-ftp/latest/google.cloud.ftp_v1.types.Server.AccessType)

The access type of the Server.

### [LabelsEntry](https://docs.cloud.google.com/python/docs/reference/google-cloud-ftp/latest/google.cloud.ftp_v1.types.Server.LabelsEntry)

The abstract base class for a message.

### [State](https://docs.cloud.google.com/python/docs/reference/google-cloud-ftp/latest/google.cloud.ftp_v1.types.Server.State)

Tracks Server status.

### [ServerCredential](https://docs.cloud.google.com/python/docs/reference/google-cloud-ftp/latest/google.cloud.ftp_v1.types.ServerCredential)

Represents credentials of an FTP Server.

### [ServerView](https://docs.cloud.google.com/python/docs/reference/google-cloud-ftp/latest/google.cloud.ftp_v1.types.ServerView)

View for Server resource.

### [StartServerRequest](https://docs.cloud.google.com/python/docs/reference/google-cloud-ftp/latest/google.cloud.ftp_v1.types.StartServerRequest)

Request message for starting a Server.

### [StopServerRequest](https://docs.cloud.google.com/python/docs/reference/google-cloud-ftp/latest/google.cloud.ftp_v1.types.StopServerRequest)

Request message for stopping a Server.

### [StorageDirectoryMapping](https://docs.cloud.google.com/python/docs/reference/google-cloud-ftp/latest/google.cloud.ftp_v1.types.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.

### [Permission](https://docs.cloud.google.com/python/docs/reference/google-cloud-ftp/latest/google.cloud.ftp_v1.types.StorageDirectoryMapping.Permission)

Tracks read/write access to the bucket.

### [UpdateServerRequest](https://docs.cloud.google.com/python/docs/reference/google-cloud-ftp/latest/google.cloud.ftp_v1.types.UpdateServerRequest)

Message for updating a Server

### [UpdateUserRequest](https://docs.cloud.google.com/python/docs/reference/google-cloud-ftp/latest/google.cloud.ftp_v1.types.UpdateUserRequest)

Message for updating a User

### [User](https://docs.cloud.google.com/python/docs/reference/google-cloud-ftp/latest/google.cloud.ftp_v1.types.User)

Message describing User object

### [LabelsEntry](https://docs.cloud.google.com/python/docs/reference/google-cloud-ftp/latest/google.cloud.ftp_v1.types.User.LabelsEntry)

The abstract base class for a message.

### [State](https://docs.cloud.google.com/python/docs/reference/google-cloud-ftp/latest/google.cloud.ftp_v1.types.User.State)

Tracks user creation.

### [UserCredential](https://docs.cloud.google.com/python/docs/reference/google-cloud-ftp/latest/google.cloud.ftp_v1.types.UserCredential)

Message describing UserCredential object

### [Type](https://docs.cloud.google.com/python/docs/reference/google-cloud-ftp/latest/google.cloud.ftp_v1.types.UserCredential.Type)

Type of credential.

### [UserView](https://docs.cloud.google.com/python/docs/reference/google-cloud-ftp/latest/google.cloud.ftp_v1.types.UserView)

View for User resource.

## Modules

### [pagers](https://docs.cloud.google.com/python/docs/reference/google-cloud-ftp/latest/google.cloud.ftp_v1.services.cloud_ftp.pagers)

API documentation for `ftp_v1.services.cloud_ftp.pagers` module.