Class ListTransferConfigsPager (3.20.0)

Version latest

• 3.20.0 (latest)
• 3.19.2
• 3.18.0
• 3.17.1
• 3.16.0
• 3.15.7
• 3.14.1
• 3.13.0
• 3.12.1
• 3.11.2
• 3.10.1
• 3.9.0
• 3.8.0
• 3.7.3
• 3.6.2
• 3.5.0
• 3.4.1
• 3.3.4
• 3.2.0
• 3.1.1
• 3.0.1
• 2.1.2
• 2.0.0
• 1.1.3
• 1.0.0
• 0.4.1

ListTransferConfigsPager(
    method: typing.Callable[
        [...],
        google.cloud.bigquery_datatransfer_v1.types.datatransfer.ListTransferConfigsResponse,
    ],
    request: google.cloud.bigquery_datatransfer_v1.types.datatransfer.ListTransferConfigsRequest,
    response: google.cloud.bigquery_datatransfer_v1.types.datatransfer.ListTransferConfigsResponse,
    *,
    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_transfer_configs requests.

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

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

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

Methods

ListTransferConfigsPager

ListTransferConfigsPager(
    method: typing.Callable[
        [...],
        google.cloud.bigquery_datatransfer_v1.types.datatransfer.ListTransferConfigsResponse,
    ],
    request: google.cloud.bigquery_datatransfer_v1.types.datatransfer.ListTransferConfigsRequest,
    response: google.cloud.bigquery_datatransfer_v1.types.datatransfer.ListTransferConfigsResponse,
    *,
    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.

Parameters
Name	Description
method	Callable The method that was originally called, and which instantiated this pager.
request	google.cloud.bigquery_datatransfer_v1.types.ListTransferConfigsRequest The initial request object.
response	google.cloud.bigquery_datatransfer_v1.types.ListTransferConfigsResponse The initial response object.
retry	google.api_core.retry.Retry Designation of what errors, if any, should be retried.
timeout	float The timeout for this request.
metadata	Sequence[Tuple[str, Union[str, bytes]]] Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.