Class ListRuleSetsPager (0.7.11)

ListRuleSetsPager(
    method: typing.Callable[
        [...],
        google.cloud.contentwarehouse_v1.types.ruleset_service_request.ListRuleSetsResponse,
    ],
    request: google.cloud.contentwarehouse_v1.types.ruleset_service_request.ListRuleSetsRequest,
    response: google.cloud.contentwarehouse_v1.types.ruleset_service_request.ListRuleSetsResponse,
    *,
    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_rule_sets requests.

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

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

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

ListRuleSetsPager

ListRuleSetsPager(
    method: typing.Callable[
        [...],
        google.cloud.contentwarehouse_v1.types.ruleset_service_request.ListRuleSetsResponse,
    ],
    request: google.cloud.contentwarehouse_v1.types.ruleset_service_request.ListRuleSetsRequest,
    response: google.cloud.contentwarehouse_v1.types.ruleset_service_request.ListRuleSetsResponse,
    *,
    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]] = ()
)

Instantiate the pager.

Parameters
Name	Description
`method`	`Callable` The method that was originally called, and which instantiated this pager.
`request`	`google.cloud.contentwarehouse_v1.types.ListRuleSetsRequest` The initial request object.
`response`	`google.cloud.contentwarehouse_v1.types.ListRuleSetsResponse` 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, str]]` Strings which should be sent along with the request as metadata.