Class ListSettingsPager (1.11.0)

Version latest

• 1.11.0 (latest)
• 1.10.1
• 1.9.6
• 1.8.0
• 1.7.1
• 1.6.1
• 1.5.0
• 1.4.3
• 1.3.2
• 1.2.1
• 1.1.0
• 1.0.2
• 0.3.2
• 0.2.0
• 0.1.0

ListSettingsPager(
    method: typing.Callable[
        [...],
        google.cloud.resourcesettings_v1.types.resource_settings.ListSettingsResponse,
    ],
    request: google.cloud.resourcesettings_v1.types.resource_settings.ListSettingsRequest,
    response: google.cloud.resourcesettings_v1.types.resource_settings.ListSettingsResponse,
    *,
    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 list_settings requests.

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

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

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

ListSettingsPager

ListSettingsPager(
    method: typing.Callable[
        [...],
        google.cloud.resourcesettings_v1.types.resource_settings.ListSettingsResponse,
    ],
    request: google.cloud.resourcesettings_v1.types.resource_settings.ListSettingsRequest,
    response: google.cloud.resourcesettings_v1.types.resource_settings.ListSettingsResponse,
    *,
    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.resourcesettings_v1.types.ListSettingsRequest The initial request object.
response	google.cloud.resourcesettings_v1.types.ListSettingsResponse 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.