Class ListCapacityCommitmentsPager (1.14.0)

Version 1.14.0

• 1.14.1 (latest)
• 1.14.0
• 1.13.5
• 1.12.0
• 1.11.3
• 1.10.0
• 1.9.1
• 1.8.0
• 1.7.3
• 1.6.3
• 1.5.0
• 1.4.1
• 1.3.1
• 1.2.2
• 1.1.0
• 1.0.1
• 0.4.2
• 0.3.0
• 0.2.0
• 0.1.0

ListCapacityCommitmentsPager(
    method: typing.Callable[
        [...],
        google.cloud.bigquery_reservation_v1.types.reservation.ListCapacityCommitmentsResponse,
    ],
    request: google.cloud.bigquery_reservation_v1.types.reservation.ListCapacityCommitmentsRequest,
    response: google.cloud.bigquery_reservation_v1.types.reservation.ListCapacityCommitmentsResponse,
    *,
    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_capacity_commitments requests.

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

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

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

ListCapacityCommitmentsPager

ListCapacityCommitmentsPager(
    method: typing.Callable[
        [...],
        google.cloud.bigquery_reservation_v1.types.reservation.ListCapacityCommitmentsResponse,
    ],
    request: google.cloud.bigquery_reservation_v1.types.reservation.ListCapacityCommitmentsRequest,
    response: google.cloud.bigquery_reservation_v1.types.reservation.ListCapacityCommitmentsResponse,
    *,
    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
Name	Description
method	Callable The method that was originally called, and which instantiated this pager.
request	google.cloud.bigquery_reservation_v1.types.ListCapacityCommitmentsRequest The initial request object.
response	google.cloud.bigquery_reservation_v1.types.ListCapacityCommitmentsResponse 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, str]] Strings which should be sent along with the request as metadata.