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

### google.cloud.ftp_v1.services.cloud_ftp.CloudFtpClient

    CloudFtpClient(
        *,
        credentials: typing.Optional[google.auth.credentials.Credentials] = None,
        transport: typing.Optional[
            typing.Union[
                str,
                google.cloud.ftp_v1.services.cloud_ftp.transports.base.CloudFtpTransport,
                typing.Callable[
                    [...],
                    google.cloud.ftp_v1.services.cloud_ftp.transports.base.CloudFtpTransport,
                ],
            ]
        ] = None,
        client_options: typing.Optional[
            typing.Union[google.api_core.client_options.ClientOptions, dict]
        ] = None,
        client_info: google.api_core.gapic_v1.client_info.ClientInfo = google.api_core.gapic_v1.client_info.ClientInfo
    )

Instantiates the cloud ftp client.

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

### google.cloud.ftp_v1.services.cloud_ftp.CloudFtpClient.__exit__

    __exit__(type, value, traceback)

Releases underlying transport's resources.

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

### google.cloud.ftp_v1.services.cloud_ftp.CloudFtpClient.cancel_operation

    cancel_operation(
        request: typing.Optional[
            typing.Union[google.longrunning.operations_pb2.CancelOperationRequest, dict]
        ] = None,
        *,
        retry: typing.Optional[
            typing.Union[
                google.api_core.retry.retry_unary.Retry,
                google.api_core.gapic_v1.method._MethodDefault,
            ]
        ] = _MethodDefault._DEFAULT_VALUE,
        timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
        metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
    ) -> None

Starts asynchronous cancellation on a long-running operation.

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

### google.cloud.ftp_v1.services.cloud_ftp.CloudFtpClient.common_billing_account_path

    common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

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

### google.cloud.ftp_v1.services.cloud_ftp.CloudFtpClient.common_folder_path

    common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

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

### google.cloud.ftp_v1.services.cloud_ftp.CloudFtpClient.common_location_path

    common_location_path(project: str, location: str) -> str

Returns a fully-qualified location string.

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

### google.cloud.ftp_v1.services.cloud_ftp.CloudFtpClient.common_organization_path

    common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

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

### google.cloud.ftp_v1.services.cloud_ftp.CloudFtpClient.common_project_path

    common_project_path(project: str) -> str

Returns a fully-qualified project string.

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

### google.cloud.ftp_v1.services.cloud_ftp.CloudFtpClient.create_server

    create_server(
        request: typing.Optional[
            typing.Union[google.cloud.ftp_v1.types.service.CreateServerRequest, dict]
        ] = None,
        *,
        parent: typing.Optional[str] = None,
        server: typing.Optional[google.cloud.ftp_v1.types.service.Server] = None,
        server_id: typing.Optional[str] = None,
        retry: typing.Optional[
            typing.Union[
                google.api_core.retry.retry_unary.Retry,
                google.api_core.gapic_v1.method._MethodDefault,
            ]
        ] = _MethodDefault._DEFAULT_VALUE,
        timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
        metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
    ) -> google.api_core.operation.Operation

Creates a new Server in a given project and location.

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

### google.cloud.ftp_v1.services.cloud_ftp.CloudFtpClient.create_user

    create_user(
        request: typing.Optional[
            typing.Union[google.cloud.ftp_v1.types.service.CreateUserRequest, dict]
        ] = None,
        *,
        parent: typing.Optional[str] = None,
        user: typing.Optional[google.cloud.ftp_v1.types.service.User] = None,
        user_id: typing.Optional[str] = None,
        retry: typing.Optional[
            typing.Union[
                google.api_core.retry.retry_unary.Retry,
                google.api_core.gapic_v1.method._MethodDefault,
            ]
        ] = _MethodDefault._DEFAULT_VALUE,
        timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
        metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
    ) -> google.api_core.operation.Operation

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

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

### google.cloud.ftp_v1.services.cloud_ftp.CloudFtpClient.delete_operation

    delete_operation(
        request: typing.Optional[
            typing.Union[google.longrunning.operations_pb2.DeleteOperationRequest, dict]
        ] = None,
        *,
        retry: typing.Optional[
            typing.Union[
                google.api_core.retry.retry_unary.Retry,
                google.api_core.gapic_v1.method._MethodDefault,
            ]
        ] = _MethodDefault._DEFAULT_VALUE,
        timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
        metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
    ) -> None

Deletes a long-running operation.

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

### google.cloud.ftp_v1.services.cloud_ftp.CloudFtpClient.delete_server

    delete_server(
        request: typing.Optional[
            typing.Union[google.cloud.ftp_v1.types.service.DeleteServerRequest, dict]
        ] = None,
        *,
        name: typing.Optional[str] = None,
        retry: typing.Optional[
            typing.Union[
                google.api_core.retry.retry_unary.Retry,
                google.api_core.gapic_v1.method._MethodDefault,
            ]
        ] = _MethodDefault._DEFAULT_VALUE,
        timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
        metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
    ) -> google.api_core.operation.Operation

Deletes a single Server.

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

### google.cloud.ftp_v1.services.cloud_ftp.CloudFtpClient.delete_user

    delete_user(
        request: typing.Optional[
            typing.Union[google.cloud.ftp_v1.types.service.DeleteUserRequest, dict]
        ] = None,
        *,
        name: typing.Optional[str] = None,
        retry: typing.Optional[
            typing.Union[
                google.api_core.retry.retry_unary.Retry,
                google.api_core.gapic_v1.method._MethodDefault,
            ]
        ] = _MethodDefault._DEFAULT_VALUE,
        timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
        metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
    ) -> google.api_core.operation.Operation

Deletes a single User.

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

### google.cloud.ftp_v1.services.cloud_ftp.CloudFtpClient.forwarding_rule_path

    forwarding_rule_path(project: str, region: str, forwarding_rule: str) -> str

Returns a fully-qualified forwarding_rule string.

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

### google.cloud.ftp_v1.services.cloud_ftp.CloudFtpClient.from_service_account_file

    from_service_account_file(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials
file.

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

### google.cloud.ftp_v1.services.cloud_ftp.CloudFtpClient.from_service_account_info

    from_service_account_info(info: dict, *args, **kwargs)

Creates an instance of this client using the provided credentials
info.

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

### google.cloud.ftp_v1.services.cloud_ftp.CloudFtpClient.from_service_account_json

    from_service_account_json(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials
file.

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

### google.cloud.ftp_v1.services.cloud_ftp.CloudFtpClient.get_location

    get_location(
        request: typing.Optional[
            typing.Union[google.cloud.location.locations_pb2.GetLocationRequest, dict]
        ] = None,
        *,
        retry: typing.Optional[
            typing.Union[
                google.api_core.retry.retry_unary.Retry,
                google.api_core.gapic_v1.method._MethodDefault,
            ]
        ] = _MethodDefault._DEFAULT_VALUE,
        timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
        metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
    ) -> google.cloud.location.locations_pb2.Location

Gets information about a location.

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

### google.cloud.ftp_v1.services.cloud_ftp.CloudFtpClient.get_mtls_endpoint_and_cert_source

    get_mtls_endpoint_and_cert_source(
        client_options: typing.Optional[
            google.api_core.client_options.ClientOptions
        ] = None,
    )

Deprecated.

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

### google.cloud.ftp_v1.services.cloud_ftp.CloudFtpClient.get_operation

    get_operation(
        request: typing.Optional[
            typing.Union[google.longrunning.operations_pb2.GetOperationRequest, dict]
        ] = None,
        *,
        retry: typing.Optional[
            typing.Union[
                google.api_core.retry.retry_unary.Retry,
                google.api_core.gapic_v1.method._MethodDefault,
            ]
        ] = _MethodDefault._DEFAULT_VALUE,
        timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
        metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
    ) -> google.longrunning.operations_pb2.Operation

Gets the latest state of a long-running operation.

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

### google.cloud.ftp_v1.services.cloud_ftp.CloudFtpClient.get_server

    get_server(
        request: typing.Optional[
            typing.Union[google.cloud.ftp_v1.types.service.GetServerRequest, dict]
        ] = None,
        *,
        name: typing.Optional[str] = None,
        retry: typing.Optional[
            typing.Union[
                google.api_core.retry.retry_unary.Retry,
                google.api_core.gapic_v1.method._MethodDefault,
            ]
        ] = _MethodDefault._DEFAULT_VALUE,
        timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
        metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
    ) -> google.cloud.ftp_v1.types.service.Server

Gets details of a single Server.

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

### google.cloud.ftp_v1.services.cloud_ftp.CloudFtpClient.get_user

    get_user(
        request: typing.Optional[
            typing.Union[google.cloud.ftp_v1.types.service.GetUserRequest, dict]
        ] = None,
        *,
        name: typing.Optional[str] = None,
        retry: typing.Optional[
            typing.Union[
                google.api_core.retry.retry_unary.Retry,
                google.api_core.gapic_v1.method._MethodDefault,
            ]
        ] = _MethodDefault._DEFAULT_VALUE,
        timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
        metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
    ) -> google.cloud.ftp_v1.types.service.User

Gets details of a single User.

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

### google.cloud.ftp_v1.services.cloud_ftp.CloudFtpClient.list_locations

    list_locations(
        request: typing.Optional[
            typing.Union[google.cloud.location.locations_pb2.ListLocationsRequest, dict]
        ] = None,
        *,
        retry: typing.Optional[
            typing.Union[
                google.api_core.retry.retry_unary.Retry,
                google.api_core.gapic_v1.method._MethodDefault,
            ]
        ] = _MethodDefault._DEFAULT_VALUE,
        timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
        metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
    ) -> google.cloud.location.locations_pb2.ListLocationsResponse

Lists information about the supported locations for this service.

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

### google.cloud.ftp_v1.services.cloud_ftp.CloudFtpClient.list_operations

    list_operations(
        request: typing.Optional[
            typing.Union[google.longrunning.operations_pb2.ListOperationsRequest, dict]
        ] = None,
        *,
        retry: typing.Optional[
            typing.Union[
                google.api_core.retry.retry_unary.Retry,
                google.api_core.gapic_v1.method._MethodDefault,
            ]
        ] = _MethodDefault._DEFAULT_VALUE,
        timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
        metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
    ) -> google.longrunning.operations_pb2.ListOperationsResponse

Lists operations that match the specified filter in the request.

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

### google.cloud.ftp_v1.services.cloud_ftp.CloudFtpClient.list_servers

    list_servers(
        request: typing.Optional[
            typing.Union[google.cloud.ftp_v1.types.service.ListServersRequest, dict]
        ] = None,
        *,
        parent: typing.Optional[str] = None,
        retry: typing.Optional[
            typing.Union[
                google.api_core.retry.retry_unary.Retry,
                google.api_core.gapic_v1.method._MethodDefault,
            ]
        ] = _MethodDefault._DEFAULT_VALUE,
        timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
        metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
    ) -> google.cloud.ftp_v1.services.cloud_ftp.pagers.ListServersPager

Lists Servers in a given project and location.

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

### google.cloud.ftp_v1.services.cloud_ftp.CloudFtpClient.list_users

    list_users(
        request: typing.Optional[
            typing.Union[google.cloud.ftp_v1.types.service.ListUsersRequest, dict]
        ] = None,
        *,
        parent: typing.Optional[str] = None,
        retry: typing.Optional[
            typing.Union[
                google.api_core.retry.retry_unary.Retry,
                google.api_core.gapic_v1.method._MethodDefault,
            ]
        ] = _MethodDefault._DEFAULT_VALUE,
        timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
        metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
    ) -> google.cloud.ftp_v1.services.cloud_ftp.pagers.ListUsersPager

Lists Users in a given project and location.

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

### google.cloud.ftp_v1.services.cloud_ftp.CloudFtpClient.network_path

    network_path(project: str, network: str) -> str

Returns a fully-qualified network string.

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

### google.cloud.ftp_v1.services.cloud_ftp.CloudFtpClient.parse_common_billing_account_path

    parse_common_billing_account_path(path: str) -> typing.Dict[str, str]

Parse a billing_account path into its component segments.

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

### google.cloud.ftp_v1.services.cloud_ftp.CloudFtpClient.parse_common_folder_path

    parse_common_folder_path(path: str) -> typing.Dict[str, str]

Parse a folder path into its component segments.

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

### google.cloud.ftp_v1.services.cloud_ftp.CloudFtpClient.parse_common_location_path

    parse_common_location_path(path: str) -> typing.Dict[str, str]

Parse a location path into its component segments.

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

### google.cloud.ftp_v1.services.cloud_ftp.CloudFtpClient.parse_common_organization_path

    parse_common_organization_path(path: str) -> typing.Dict[str, str]

Parse a organization path into its component segments.

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

### google.cloud.ftp_v1.services.cloud_ftp.CloudFtpClient.parse_common_project_path

    parse_common_project_path(path: str) -> typing.Dict[str, str]

Parse a project path into its component segments.

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

### google.cloud.ftp_v1.services.cloud_ftp.CloudFtpClient.parse_forwarding_rule_path

    parse_forwarding_rule_path(path: str) -> typing.Dict[str, str]

Parses a forwarding_rule path into its component segments.

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

### google.cloud.ftp_v1.services.cloud_ftp.CloudFtpClient.parse_network_path

    parse_network_path(path: str) -> typing.Dict[str, str]

Parses a network path into its component segments.

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

### google.cloud.ftp_v1.services.cloud_ftp.CloudFtpClient.parse_server_path

    parse_server_path(path: str) -> typing.Dict[str, str]

Parses a server path into its component segments.

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

### google.cloud.ftp_v1.services.cloud_ftp.CloudFtpClient.parse_service_attachment_path

    parse_service_attachment_path(path: str) -> typing.Dict[str, str]

Parses a service_attachment path into its component segments.

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

### google.cloud.ftp_v1.services.cloud_ftp.CloudFtpClient.parse_user_path

    parse_user_path(path: str) -> typing.Dict[str, str]

Parses a user path into its component segments.

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

### google.cloud.ftp_v1.services.cloud_ftp.CloudFtpClient.server_path

    server_path(project: str, location: str, server: str) -> str

Returns a fully-qualified server string.

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

### google.cloud.ftp_v1.services.cloud_ftp.CloudFtpClient.service_attachment_path

    service_attachment_path(project: str, region: str, service_attachment: str) -> str

Returns a fully-qualified service_attachment string.

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

### google.cloud.ftp_v1.services.cloud_ftp.CloudFtpClient.start_server

    start_server(
        request: typing.Optional[
            typing.Union[google.cloud.ftp_v1.types.service.StartServerRequest, dict]
        ] = None,
        *,
        name: typing.Optional[str] = None,
        retry: typing.Optional[
            typing.Union[
                google.api_core.retry.retry_unary.Retry,
                google.api_core.gapic_v1.method._MethodDefault,
            ]
        ] = _MethodDefault._DEFAULT_VALUE,
        timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
        metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
    ) -> google.api_core.operation.Operation

Starts a stopping/stopped Server.

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

### google.cloud.ftp_v1.services.cloud_ftp.CloudFtpClient.stop_server

    stop_server(
        request: typing.Optional[
            typing.Union[google.cloud.ftp_v1.types.service.StopServerRequest, dict]
        ] = None,
        *,
        name: typing.Optional[str] = None,
        retry: typing.Optional[
            typing.Union[
                google.api_core.retry.retry_unary.Retry,
                google.api_core.gapic_v1.method._MethodDefault,
            ]
        ] = _MethodDefault._DEFAULT_VALUE,
        timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
        metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
    ) -> google.api_core.operation.Operation

Stops an active Server.

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

### google.cloud.ftp_v1.services.cloud_ftp.CloudFtpClient.update_server

    update_server(
        request: typing.Optional[
            typing.Union[google.cloud.ftp_v1.types.service.UpdateServerRequest, dict]
        ] = None,
        *,
        server: typing.Optional[google.cloud.ftp_v1.types.service.Server] = None,
        update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
        retry: typing.Optional[
            typing.Union[
                google.api_core.retry.retry_unary.Retry,
                google.api_core.gapic_v1.method._MethodDefault,
            ]
        ] = _MethodDefault._DEFAULT_VALUE,
        timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
        metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
    ) -> google.api_core.operation.Operation

Updates the parameters of a single Server.

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

### google.cloud.ftp_v1.services.cloud_ftp.CloudFtpClient.update_user

    update_user(
        request: typing.Optional[
            typing.Union[google.cloud.ftp_v1.types.service.UpdateUserRequest, dict]
        ] = None,
        *,
        user: typing.Optional[google.cloud.ftp_v1.types.service.User] = None,
        update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
        retry: typing.Optional[
            typing.Union[
                google.api_core.retry.retry_unary.Retry,
                google.api_core.gapic_v1.method._MethodDefault,
            ]
        ] = _MethodDefault._DEFAULT_VALUE,
        timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
        metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
    ) -> google.api_core.operation.Operation

Updates the parameters of a single User.

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

### google.cloud.ftp_v1.services.cloud_ftp.CloudFtpClient.user_path

    user_path(project: str, location: str, server: str, user: str) -> str

Returns a fully-qualified user string.

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

### google.cloud.ftp_v1.services.cloud_ftp.pagers.ListServersPager

    ListServersPager(
        method: typing.Callable[
            [...], google.cloud.ftp_v1.types.service.ListServersResponse
        ],
        request: google.cloud.ftp_v1.types.service.ListServersRequest,
        response: google.cloud.ftp_v1.types.service.ListServersResponse,
        *,
        retry: typing.Optional[
            typing.Union[
                google.api_core.retry.retry_unary.Retry,
                google.api_core.gapic_v1.method._MethodDefault,
            ]
        ] = _MethodDefault._DEFAULT_VALUE,
        timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
        metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
    )

Instantiate the pager.

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

### google.cloud.ftp_v1.services.cloud_ftp.pagers.ListUsersPager

    ListUsersPager(
        method: typing.Callable[[...], google.cloud.ftp_v1.types.service.ListUsersResponse],
        request: google.cloud.ftp_v1.types.service.ListUsersRequest,
        response: google.cloud.ftp_v1.types.service.ListUsersResponse,
        *,
        retry: typing.Optional[
            typing.Union[
                google.api_core.retry.retry_unary.Retry,
                google.api_core.gapic_v1.method._MethodDefault,
            ]
        ] = _MethodDefault._DEFAULT_VALUE,
        timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
        metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
    )

Instantiate the pager.

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