Module pagers (2.16.0)

API documentation for iam_v2.services.policies.pagers module.

Classes

ListPoliciesAsyncPager

ListPoliciesAsyncPager(
    method: typing.Callable[
        [...], typing.Awaitable[google.cloud.iam_v2.types.policy.ListPoliciesResponse]
    ],
    request: google.cloud.iam_v2.types.policy.ListPoliciesRequest,
    response: google.cloud.iam_v2.types.policy.ListPoliciesResponse,
    *,
    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_policies requests.

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

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

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

ListPoliciesPager

ListPoliciesPager(
    method: typing.Callable[
        [...], google.cloud.iam_v2.types.policy.ListPoliciesResponse
    ],
    request: google.cloud.iam_v2.types.policy.ListPoliciesRequest,
    response: google.cloud.iam_v2.types.policy.ListPoliciesResponse,
    *,
    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_policies requests.

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

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

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