Class ListRealmsPager (1.5.1)

Version 1.5.1

• 1.8.3 (latest)
• 1.8.2
• 1.7.1
• 1.6.0
• 1.5.3
• 1.4.2
• 1.3.0
• 1.2.1
• 1.1.1
• 1.0.2
• 0.5.2
• 0.4.2
• 0.3.0
• 0.2.0
• 0.1.1

ListRealmsPager(
    method: Callable[[...], google.cloud.gaming_v1.types.realms.ListRealmsResponse],
    request: google.cloud.gaming_v1.types.realms.ListRealmsRequest,
    response: google.cloud.gaming_v1.types.realms.ListRealmsResponse,
    *,
    metadata: Sequence[Tuple[str, str]] = ()
)

A pager for iterating through list_realms requests.

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

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

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

Inheritance

builtins.object > ListRealmsPager

Methods

ListRealmsPager

ListRealmsPager(
    method: Callable[[...], google.cloud.gaming_v1.types.realms.ListRealmsResponse],
    request: google.cloud.gaming_v1.types.realms.ListRealmsRequest,
    response: google.cloud.gaming_v1.types.realms.ListRealmsResponse,
    *,
    metadata: Sequence[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.gaming_v1.types.ListRealmsRequest The initial request object.
response	google.cloud.gaming_v1.types.ListRealmsResponse The initial response object.
metadata	Sequence[Tuple[str, str]] Strings which should be sent along with the request as metadata.