Module pagers (0.1.3)

API documentation for memorystore_v1.services.memorystore.pagers module.

Classes

ListBackupCollectionsPager

ListBackupCollectionsPager(
    method: typing.Callable[
        [...],
        google.cloud.memorystore_v1.types.memorystore.ListBackupCollectionsResponse,
    ],
    request: google.cloud.memorystore_v1.types.memorystore.ListBackupCollectionsRequest,
    response: google.cloud.memorystore_v1.types.memorystore.ListBackupCollectionsResponse,
    *,
    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_backup_collections requests.

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

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

All the usual ListBackupCollectionsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListBackupsPager

ListBackupsPager(
    method: typing.Callable[
        [...], google.cloud.memorystore_v1.types.memorystore.ListBackupsResponse
    ],
    request: google.cloud.memorystore_v1.types.memorystore.ListBackupsRequest,
    response: google.cloud.memorystore_v1.types.memorystore.ListBackupsResponse,
    *,
    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_backups requests.

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

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

All the usual ListBackupsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListInstancesPager

ListInstancesPager(
    method: typing.Callable[
        [...], google.cloud.memorystore_v1.types.memorystore.ListInstancesResponse
    ],
    request: google.cloud.memorystore_v1.types.memorystore.ListInstancesRequest,
    response: google.cloud.memorystore_v1.types.memorystore.ListInstancesResponse,
    *,
    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_instances requests.

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

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

All the usual ListInstancesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.