Class ListEnvironmentsPager (1.1.2)

Stay organized with collections Save and categorize content based on your preferences.
ListEnvironmentsPager(
    method: Callable[
        [...], google.cloud.dataplex_v1.types.service.ListEnvironmentsResponse
    ],
    request: google.cloud.dataplex_v1.types.service.ListEnvironmentsRequest,
    response: google.cloud.dataplex_v1.types.service.ListEnvironmentsResponse,
    *,
    metadata: Sequence[Tuple[str, str]] = ()
)

A pager for iterating through list_environments requests.

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

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

All the usual ListEnvironmentsResponse 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 > ListEnvironmentsPager

Methods

ListEnvironmentsPager

ListEnvironmentsPager(
    method: Callable[
        [...], google.cloud.dataplex_v1.types.service.ListEnvironmentsResponse
    ],
    request: google.cloud.dataplex_v1.types.service.ListEnvironmentsRequest,
    response: google.cloud.dataplex_v1.types.service.ListEnvironmentsResponse,
    *,
    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.dataplex_v1.types.ListEnvironmentsRequest

The initial request object.

response google.cloud.dataplex_v1.types.ListEnvironmentsResponse

The initial response object.

metadata Sequence[Tuple[str, str]]

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