Module pagers (1.13.0)

API documentation for resourcemanager_v3.services.folders.pagers module.

Classes

ListFoldersAsyncPager

ListFoldersAsyncPager(
    method: typing.Callable[
        [...],
        typing.Awaitable[
            google.cloud.resourcemanager_v3.types.folders.ListFoldersResponse
        ],
    ],
    request: google.cloud.resourcemanager_v3.types.folders.ListFoldersRequest,
    response: google.cloud.resourcemanager_v3.types.folders.ListFoldersResponse,
    *,
    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, str]] = ()
)

A pager for iterating through list_folders requests.

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

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

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

ListFoldersPager

ListFoldersPager(
    method: typing.Callable[
        [...], google.cloud.resourcemanager_v3.types.folders.ListFoldersResponse
    ],
    request: google.cloud.resourcemanager_v3.types.folders.ListFoldersRequest,
    response: google.cloud.resourcemanager_v3.types.folders.ListFoldersResponse,
    *,
    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, str]] = ()
)

A pager for iterating through list_folders requests.

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

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

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

SearchFoldersAsyncPager

SearchFoldersAsyncPager(
    method: typing.Callable[
        [...],
        typing.Awaitable[
            google.cloud.resourcemanager_v3.types.folders.SearchFoldersResponse
        ],
    ],
    request: google.cloud.resourcemanager_v3.types.folders.SearchFoldersRequest,
    response: google.cloud.resourcemanager_v3.types.folders.SearchFoldersResponse,
    *,
    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, str]] = ()
)

A pager for iterating through search_folders requests.

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

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

SearchFoldersPager

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