Module pagers (0.1.0)

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

Classes

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]]] = ()
)

A pager for iterating through list_servers requests.

This class thinly wraps an initial 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 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

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]]] = ()
)

A pager for iterating through list_users requests.

This class thinly wraps an initial 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 attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.