Class ListPlaybooksPager (1.41.0)

ListPlaybooksPager(
    method: typing.Callable[
        [...], google.cloud.dialogflowcx_v3beta1.types.playbook.ListPlaybooksResponse
    ],
    request: google.cloud.dialogflowcx_v3beta1.types.playbook.ListPlaybooksRequest,
    response: google.cloud.dialogflowcx_v3beta1.types.playbook.ListPlaybooksResponse,
    *,
    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_playbooks requests.

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

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

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

ListPlaybooksPager

ListPlaybooksPager(
    method: typing.Callable[
        [...], google.cloud.dialogflowcx_v3beta1.types.playbook.ListPlaybooksResponse
    ],
    request: google.cloud.dialogflowcx_v3beta1.types.playbook.ListPlaybooksRequest,
    response: google.cloud.dialogflowcx_v3beta1.types.playbook.ListPlaybooksResponse,
    *,
    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
NameDescription
methodCallable

The method that was originally called, and which instantiated this pager.

requestgoogle.cloud.dialogflowcx_v3beta1.types.ListPlaybooksRequest

The initial request object.

responsegoogle.cloud.dialogflowcx_v3beta1.types.ListPlaybooksResponse

The initial response object.

retrygoogle.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeoutfloat

The timeout for this request.

metadataSequence[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.