Class ListRolesPager (2.16.1)

Version latest

• 2.16.1 (latest)
• 2.16.0
• 2.15.2
• 2.14.3
• 2.13.0
• 2.12.1
• 2.11.2
• 2.10.0
• 2.9.0
• 2.8.2
• 2.7.0
• 2.6.2
• 2.5.1
• 2.4.0
• 2.3.2
• 2.2.0
• 2.1.0
• 2.0.0
• 1.0.3
• 0.3.2
• 0.2.0

ListRolesPager(
    method: typing.Callable[
        [...], google.cloud.iam_admin_v1.types.iam.ListRolesResponse
    ],
    request: google.cloud.iam_admin_v1.types.iam.ListRolesRequest,
    response: google.cloud.iam_admin_v1.types.iam.ListRolesResponse,
    *,
    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_roles requests.

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

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

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

ListRolesPager

ListRolesPager(
    method: typing.Callable[
        [...], google.cloud.iam_admin_v1.types.iam.ListRolesResponse
    ],
    request: google.cloud.iam_admin_v1.types.iam.ListRolesRequest,
    response: google.cloud.iam_admin_v1.types.iam.ListRolesResponse,
    *,
    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.iam_admin_v1.types.ListRolesRequest The initial request object.
response	google.cloud.iam_admin_v1.types.ListRolesResponse 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.