Class ListExternalAddressesPager (1.7.0)

ListExternalAddressesPager(
    method: typing.Callable[
        [...],
        google.cloud.vmwareengine_v1.types.vmwareengine.ListExternalAddressesResponse,
    ],
    request: google.cloud.vmwareengine_v1.types.vmwareengine.ListExternalAddressesRequest,
    response: google.cloud.vmwareengine_v1.types.vmwareengine.ListExternalAddressesResponse,
    *,
    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, typing.Union[str, bytes]]] = ()
)

A pager for iterating through list_external_addresses requests.

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

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

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

ListExternalAddressesPager

ListExternalAddressesPager(
    method: typing.Callable[
        [...],
        google.cloud.vmwareengine_v1.types.vmwareengine.ListExternalAddressesResponse,
    ],
    request: google.cloud.vmwareengine_v1.types.vmwareengine.ListExternalAddressesRequest,
    response: google.cloud.vmwareengine_v1.types.vmwareengine.ListExternalAddressesResponse,
    *,
    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, typing.Union[str, bytes]]] = ()
)

Instantiate the pager.

Parameters
Name Description
method Callable

The method that was originally called, and which instantiated this pager.

request google.cloud.vmwareengine_v1.types.ListExternalAddressesRequest

The initial request object.

response google.cloud.vmwareengine_v1.types.ListExternalAddressesResponse

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, Union[str, bytes]]]

Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.