Class QueryCapacityPlansPager (0.1.0) 

QueryCapacityPlansPager(
    method: typing.Callable[
        [...],
        google.cloud.capacityplanner_v1beta.types.capacity_planning_service.QueryCapacityPlansResponse,
    ],
    request: google.cloud.capacityplanner_v1beta.types.capacity_planning_service.QueryCapacityPlansRequest,
    response: google.cloud.capacityplanner_v1beta.types.capacity_planning_service.QueryCapacityPlansResponse,
    *,
    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, typing.Union[str, bytes]]] = ()
)

A pager for iterating through query_capacity_plans requests.

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

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

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

QueryCapacityPlansPager

QueryCapacityPlansPager(
    method: typing.Callable[
        [...],
        google.cloud.capacityplanner_v1beta.types.capacity_planning_service.QueryCapacityPlansResponse,
    ],
    request: google.cloud.capacityplanner_v1beta.types.capacity_planning_service.QueryCapacityPlansRequest,
    response: google.cloud.capacityplanner_v1beta.types.capacity_planning_service.QueryCapacityPlansResponse,
    *,
    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, typing.Union[str, bytes]]] = ()
)

Instantiate the pager.

Parameters
Name Description
method Callable

The method that was originally called, and which instantiated this pager.
request google.cloud.capacityplanner_v1beta.types.QueryCapacityPlansRequest

The initial request object.
response google.cloud.capacityplanner_v1beta.types.QueryCapacityPlansResponse

The initial response object.
retry google.api_core.retry.Retry

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

The timeout for this request.
metadata Sequence[Tuple[str, Union[str, bytes]]]

Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.