Class ListReportDetailsPager (0.1.12)

Version latest

• 0.1.12 (latest)
• 0.1.11

ListReportDetailsPager(
    method: typing.Callable[
        [...],
        google.cloud.storageinsights_v1.types.storageinsights.ListReportDetailsResponse,
    ],
    request: google.cloud.storageinsights_v1.types.storageinsights.ListReportDetailsRequest,
    response: google.cloud.storageinsights_v1.types.storageinsights.ListReportDetailsResponse,
    *,
    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_report_details requests.

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

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

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

ListReportDetailsPager

ListReportDetailsPager(
    method: typing.Callable[
        [...],
        google.cloud.storageinsights_v1.types.storageinsights.ListReportDetailsResponse,
    ],
    request: google.cloud.storageinsights_v1.types.storageinsights.ListReportDetailsRequest,
    response: google.cloud.storageinsights_v1.types.storageinsights.ListReportDetailsResponse,
    *,
    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.storageinsights_v1.types.ListReportDetailsRequest The initial request object.
response	google.cloud.storageinsights_v1.types.ListReportDetailsResponse 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.