Class ListWorkstationsPager (0.2.1)

ListWorkstationsPager(
    method: Callable[
        [...], google.cloud.workstations_v1.types.workstations.ListWorkstationsResponse
    ],
    request: google.cloud.workstations_v1.types.workstations.ListWorkstationsRequest,
    response: google.cloud.workstations_v1.types.workstations.ListWorkstationsResponse,
    *,
    metadata: Sequence[Tuple[str, str]] = ()
)

A pager for iterating through list_workstations requests.

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

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

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

Methods

ListWorkstationsPager

ListWorkstationsPager(
    method: Callable[
        [...], google.cloud.workstations_v1.types.workstations.ListWorkstationsResponse
    ],
    request: google.cloud.workstations_v1.types.workstations.ListWorkstationsRequest,
    response: google.cloud.workstations_v1.types.workstations.ListWorkstationsResponse,
    *,
    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.workstations_v1.types.ListWorkstationsRequest

The initial request object.

response google.cloud.workstations_v1.types.ListWorkstationsResponse

The initial response object.

metadata Sequence[Tuple[str, str]]

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