Class ListCustomConstraintsPager (1.11.1)

ListCustomConstraintsPager(
    method: typing.Callable[
        [...], google.cloud.orgpolicy_v2.types.orgpolicy.ListCustomConstraintsResponse
    ],
    request: google.cloud.orgpolicy_v2.types.orgpolicy.ListCustomConstraintsRequest,
    response: google.cloud.orgpolicy_v2.types.orgpolicy.ListCustomConstraintsResponse,
    *,
    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_custom_constraints requests.

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

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

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

ListCustomConstraintsPager

ListCustomConstraintsPager(
    method: typing.Callable[
        [...], google.cloud.orgpolicy_v2.types.orgpolicy.ListCustomConstraintsResponse
    ],
    request: google.cloud.orgpolicy_v2.types.orgpolicy.ListCustomConstraintsRequest,
    response: google.cloud.orgpolicy_v2.types.orgpolicy.ListCustomConstraintsResponse,
    *,
    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.orgpolicy_v2.types.ListCustomConstraintsRequest

The initial request object.

response google.cloud.orgpolicy_v2.types.ListCustomConstraintsResponse

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.