Class ListPolicyBasedRoutesPager (2.4.5)

ListPolicyBasedRoutesPager(
    method: typing.Callable[
        [...],
        google.cloud.networkconnectivity_v1.types.policy_based_routing.ListPolicyBasedRoutesResponse,
    ],
    request: google.cloud.networkconnectivity_v1.types.policy_based_routing.ListPolicyBasedRoutesRequest,
    response: google.cloud.networkconnectivity_v1.types.policy_based_routing.ListPolicyBasedRoutesResponse,
    *,
    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_policy_based_routes requests.

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

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

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

ListPolicyBasedRoutesPager

ListPolicyBasedRoutesPager(
    method: typing.Callable[
        [...],
        google.cloud.networkconnectivity_v1.types.policy_based_routing.ListPolicyBasedRoutesResponse,
    ],
    request: google.cloud.networkconnectivity_v1.types.policy_based_routing.ListPolicyBasedRoutesRequest,
    response: google.cloud.networkconnectivity_v1.types.policy_based_routing.ListPolicyBasedRoutesResponse,
    *,
    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.networkconnectivity_v1.types.ListPolicyBasedRoutesRequest

The initial request object.

response google.cloud.networkconnectivity_v1.types.ListPolicyBasedRoutesResponse

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.