Class SearchProfilesPager (2.5.2)

Stay organized with collections Save and categorize content based on your preferences.
SearchProfilesPager(
    method: Callable[
        [...], google.cloud.talent_v4beta1.types.profile_service.SearchProfilesResponse
    ],
    request: google.cloud.talent_v4beta1.types.profile_service.SearchProfilesRequest,
    response: google.cloud.talent_v4beta1.types.profile_service.SearchProfilesResponse,
    *,
    metadata: Sequence[Tuple[str, str]] = ()
)

A pager for iterating through search_profiles requests.

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

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

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

Inheritance

builtins.object > SearchProfilesPager

Methods

SearchProfilesPager

SearchProfilesPager(
    method: Callable[
        [...], google.cloud.talent_v4beta1.types.profile_service.SearchProfilesResponse
    ],
    request: google.cloud.talent_v4beta1.types.profile_service.SearchProfilesRequest,
    response: google.cloud.talent_v4beta1.types.profile_service.SearchProfilesResponse,
    *,
    metadata: Sequence[Tuple[str, str]] = ()
)

Instantiate the pager.

Parameters
NameDescription
method Callable

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

request google.cloud.talent_v4beta1.types.SearchProfilesRequest

The initial request object.

response google.cloud.talent_v4beta1.types.SearchProfilesResponse

The initial response object.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.