Module pagers (1.12.0)

API documentation for storage_transfer_v1.services.storage_transfer_service.pagers module.

Classes

ListAgentPoolsAsyncPager

ListAgentPoolsAsyncPager(
    method: typing.Callable[
        [...],
        typing.Awaitable[
            google.cloud.storage_transfer_v1.types.transfer.ListAgentPoolsResponse
        ],
    ],
    request: google.cloud.storage_transfer_v1.types.transfer.ListAgentPoolsRequest,
    response: google.cloud.storage_transfer_v1.types.transfer.ListAgentPoolsResponse,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)

A pager for iterating through list_agent_pools requests.

This class thinly wraps an initial ListAgentPoolsResponse object, and provides an __aiter__ method to iterate through its agent_pools field.

If there are more pages, the __aiter__ method will make additional ListAgentPools requests and continue to iterate through the agent_pools field on the corresponding responses.

All the usual ListAgentPoolsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListAgentPoolsPager

ListAgentPoolsPager(
    method: typing.Callable[
        [...], google.cloud.storage_transfer_v1.types.transfer.ListAgentPoolsResponse
    ],
    request: google.cloud.storage_transfer_v1.types.transfer.ListAgentPoolsRequest,
    response: google.cloud.storage_transfer_v1.types.transfer.ListAgentPoolsResponse,
    *,
    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, str]] = ()
)

A pager for iterating through list_agent_pools requests.

This class thinly wraps an initial ListAgentPoolsResponse object, and provides an __iter__ method to iterate through its agent_pools field.

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

All the usual ListAgentPoolsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListTransferJobsAsyncPager

ListTransferJobsAsyncPager(
    method: typing.Callable[
        [...],
        typing.Awaitable[
            google.cloud.storage_transfer_v1.types.transfer.ListTransferJobsResponse
        ],
    ],
    request: google.cloud.storage_transfer_v1.types.transfer.ListTransferJobsRequest,
    response: google.cloud.storage_transfer_v1.types.transfer.ListTransferJobsResponse,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)

A pager for iterating through list_transfer_jobs requests.

This class thinly wraps an initial ListTransferJobsResponse object, and provides an __aiter__ method to iterate through its transfer_jobs field.

If there are more pages, the __aiter__ method will make additional ListTransferJobs requests and continue to iterate through the transfer_jobs field on the corresponding responses.

All the usual ListTransferJobsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListTransferJobsPager

ListTransferJobsPager(
    method: typing.Callable[
        [...], google.cloud.storage_transfer_v1.types.transfer.ListTransferJobsResponse
    ],
    request: google.cloud.storage_transfer_v1.types.transfer.ListTransferJobsRequest,
    response: google.cloud.storage_transfer_v1.types.transfer.ListTransferJobsResponse,
    *,
    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, str]] = ()
)

A pager for iterating through list_transfer_jobs requests.

This class thinly wraps an initial ListTransferJobsResponse object, and provides an __iter__ method to iterate through its transfer_jobs field.

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

All the usual ListTransferJobsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.