ListStreamObjectsPager(
method: typing.Callable[
[...], google.cloud.datastream_v1.types.datastream.ListStreamObjectsResponse
],
request: google.cloud.datastream_v1.types.datastream.ListStreamObjectsRequest,
response: google.cloud.datastream_v1.types.datastream.ListStreamObjectsResponse,
*,
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_stream_objects
requests.
This class thinly wraps an initial
ListStreamObjectsResponse object, and
provides an __iter__
method to iterate through its
stream_objects
field.
If there are more pages, the __iter__
method will make additional
ListStreamObjects
requests and continue to iterate
through the stream_objects
field on the
corresponding responses.
All the usual ListStreamObjectsResponse 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
ListStreamObjectsPager
ListStreamObjectsPager(
method: typing.Callable[
[...], google.cloud.datastream_v1.types.datastream.ListStreamObjectsResponse
],
request: google.cloud.datastream_v1.types.datastream.ListStreamObjectsRequest,
response: google.cloud.datastream_v1.types.datastream.ListStreamObjectsResponse,
*,
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.datastream_v1.types.ListStreamObjectsRequest
The initial request object. |
response |
google.cloud.datastream_v1.types.ListStreamObjectsResponse
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. |