Class QueryDirectoryContentsAsyncPager (0.5.13)

Version latest

• 0.5.13 (latest)
• 0.5.12
• 0.4.1
• 0.3.0
• 0.2.3
• 0.1.0

QueryDirectoryContentsAsyncPager(
    method: typing.Callable[
        [...],
        typing.Awaitable[
            google.cloud.dataform_v1beta1.types.dataform.QueryDirectoryContentsResponse
        ],
    ],
    request: google.cloud.dataform_v1beta1.types.dataform.QueryDirectoryContentsRequest,
    response: google.cloud.dataform_v1beta1.types.dataform.QueryDirectoryContentsResponse,
    *,
    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 query_directory_contents requests.

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

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

All the usual QueryDirectoryContentsResponse 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

QueryDirectoryContentsAsyncPager

QueryDirectoryContentsAsyncPager(
    method: typing.Callable[
        [...],
        typing.Awaitable[
            google.cloud.dataform_v1beta1.types.dataform.QueryDirectoryContentsResponse
        ],
    ],
    request: google.cloud.dataform_v1beta1.types.dataform.QueryDirectoryContentsRequest,
    response: google.cloud.dataform_v1beta1.types.dataform.QueryDirectoryContentsResponse,
    *,
    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]] = ()
)

Instantiates the pager.

Parameters
Name	Description
method	Callable The method that was originally called, and which instantiated this pager.
request	google.cloud.dataform_v1beta1.types.QueryDirectoryContentsRequest The initial request object.
response	google.cloud.dataform_v1beta1.types.QueryDirectoryContentsResponse The initial response object.
retry	google.api_core.retry.AsyncRetry Designation of what errors, if any, should be retried.
timeout	float The timeout for this request.
metadata	Sequence[Tuple[str, str]] Strings which should be sent along with the request as metadata.