Class ListInstancesPager (1.21.0)

ListInstancesPager(
    method: typing.Callable[
        [...], google.cloud.compute_v1.types.compute.InstanceGroupsListInstances
    ],
    request: google.cloud.compute_v1.types.compute.ListInstancesInstanceGroupsRequest,
    response: google.cloud.compute_v1.types.compute.InstanceGroupsListInstances,
    *,
    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_instances requests.

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

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

All the usual InstanceGroupsListInstances 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

ListInstancesPager

ListInstancesPager(
    method: typing.Callable[
        [...], google.cloud.compute_v1.types.compute.InstanceGroupsListInstances
    ],
    request: google.cloud.compute_v1.types.compute.ListInstancesInstanceGroupsRequest,
    response: google.cloud.compute_v1.types.compute.InstanceGroupsListInstances,
    *,
    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]] = ()
)

Instantiate the pager.

Parameters
NameDescription
methodCallable

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

requestgoogle.cloud.compute_v1.types.ListInstancesInstanceGroupsRequest

The initial request object.

responsegoogle.cloud.compute_v1.types.InstanceGroupsListInstances

The initial response object.

retrygoogle.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeoutfloat

The timeout for this request.

metadataSequence[Tuple[str, str]]

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