Module pagers (0.1.0)

API documentation for locationfinder_v1.services.cloud_location_finder.pagers module.

Classes

ListCloudLocationsAsyncPager

ListCloudLocationsAsyncPager(
    method: typing.Callable[
        [...],
        typing.Awaitable[
            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_async.AsyncRetry,
            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 __aiter__ method to iterate through its cloud_locations field.

If there are more pages, the __aiter__ 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.

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]]] = ()
)

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.

SearchCloudLocationsAsyncPager

SearchCloudLocationsAsyncPager(
    method: typing.Callable[
        [...],
        typing.Awaitable[
            google.cloud.locationfinder_v1.types.cloud_location.SearchCloudLocationsResponse
        ],
    ],
    request: google.cloud.locationfinder_v1.types.cloud_location.SearchCloudLocationsRequest,
    response: google.cloud.locationfinder_v1.types.cloud_location.SearchCloudLocationsResponse,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            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 search_cloud_locations requests.

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

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

All the usual SearchCloudLocationsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

SearchCloudLocationsPager

SearchCloudLocationsPager(
    method: typing.Callable[
        [...],
        google.cloud.locationfinder_v1.types.cloud_location.SearchCloudLocationsResponse,
    ],
    request: google.cloud.locationfinder_v1.types.cloud_location.SearchCloudLocationsRequest,
    response: google.cloud.locationfinder_v1.types.cloud_location.SearchCloudLocationsResponse,
    *,
    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 search_cloud_locations requests.

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

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

All the usual SearchCloudLocationsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.