Class ListCloudLocationsPager (0.2.0)

Version latest

• 0.2.0 (latest)
• 0.1.0

ListCloudLocationsPager(
    method: typing.Callable[
        [...],
        google.cloud.locationfinder_v1.types.cloud_location.ListCloudLocationsResponse,
    ],
    request: google.cloud.locationfinder_v1.types.cloud_location.ListCloudLocationsRequest,
    response: google.cloud.locationfinder_v1.types.cloud_location.ListCloudLocationsResponse,
    *,
    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_cloud_locations requests.

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

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

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

ListCloudLocationsPager

ListCloudLocationsPager(
    method: typing.Callable[
        [...],
        google.cloud.locationfinder_v1.types.cloud_location.ListCloudLocationsResponse,
    ],
    request: google.cloud.locationfinder_v1.types.cloud_location.ListCloudLocationsRequest,
    response: google.cloud.locationfinder_v1.types.cloud_location.ListCloudLocationsResponse,
    *,
    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.locationfinder_v1.types.ListCloudLocationsRequest The initial request object.
response	google.cloud.locationfinder_v1.types.ListCloudLocationsResponse 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.