Module pagers (0.1.0)

API documentation for capacityplanner_v1beta.services.capacity_planning_service.pagers module.

Classes

QueryCapacityPlansAsyncPager

QueryCapacityPlansAsyncPager(
    method: typing.Callable[
        [...],
        typing.Awaitable[
            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_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, typing.Union[str, bytes]]] = ()
)

A pager for iterating through query_capacity_plans requests.

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

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

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]]] = ()
)

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.