Class SearchFoldersPager (1.3.3)

Stay organized with collections Save and categorize content based on your preferences.
SearchFoldersPager(
    method: Callable[
        [...], google.cloud.resourcemanager_v3.types.folders.SearchFoldersResponse
    ],
    request: google.cloud.resourcemanager_v3.types.folders.SearchFoldersRequest,
    response: google.cloud.resourcemanager_v3.types.folders.SearchFoldersResponse,
    *,
    metadata: Sequence[Tuple[str, str]] = ()
)

A pager for iterating through search_folders requests.

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

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

All the usual SearchFoldersResponse 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 > SearchFoldersPager

Methods

SearchFoldersPager

SearchFoldersPager(
    method: Callable[
        [...], google.cloud.resourcemanager_v3.types.folders.SearchFoldersResponse
    ],
    request: google.cloud.resourcemanager_v3.types.folders.SearchFoldersRequest,
    response: google.cloud.resourcemanager_v3.types.folders.SearchFoldersResponse,
    *,
    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.resourcemanager_v3.types.SearchFoldersRequest

The initial request object.

response google.cloud.resourcemanager_v3.types.SearchFoldersResponse

The initial response object.

metadata Sequence[Tuple[str, str]]

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