public sealed class GrpcPagedAsyncEnumerable<TRequest, TResponse, TResource> : PagedAsyncEnumerable<TResponse, TResource> where TRequest : class, IPageRequest, IMessage<TRequest> where TResponse : class, IPageResponse<TResource>, IMessage<TResponse>An asynchronous sequence of resources, obtained lazily via API operations which retrieve a page at a time.
Inheritance
Object > PagedAsyncEnumerable<TResponse, TResource> > GrpcPagedAsyncEnumerable<TRequest, TResponse, TResource>Namespace
Google.Api.Gax.GrpcAssembly
Google.Api.Gax.Grpc.dll
Type Parameters | |
|---|---|
| Name | Description |
TRequest | The API request type. |
TResponse | The API response type. Each response contains a page of resources. |
TResource | The resource type contained within the response. |
Constructors
GrpcPagedAsyncEnumerable(ApiCall<TRequest, TResponse>, TRequest, CallSettings)
public GrpcPagedAsyncEnumerable(ApiCall<TRequest, TResponse> apiCall, TRequest request, CallSettings callSettings)Creates a new lazily-evaluated asynchronous sequence from the given API call, initial request, and call settings.
| Parameters | |
|---|---|
| Name | Description |
apiCall | ApiCall<TRequest, TResponse>The API call made each time a page is required. |
request | TRequestThe initial request. |
callSettings | CallSettingsThe settings to apply to each API call. |
The request is cloned each time the sequence is evaluated.
Methods
AsRawResponses()
public override IAsyncEnumerable<TResponse> AsRawResponses()Returns the sequence of raw API responses, each of which contributes a page of resources to this sequence.
| Returns | |
|---|---|
| Type | Description |
IAsyncEnumerable<TResponse> | An asynchronous sequence of raw API responses, each containing a page of resources. |
GetAsyncEnumerator(CancellationToken)
public override IAsyncEnumerator<TResource> GetAsyncEnumerator(CancellationToken cancellationToken = default(CancellationToken))| Parameter | |
|---|---|
| Name | Description |
cancellationToken | CancellationToken |
| Returns | |
|---|---|
| Type | Description |
IAsyncEnumerator<TResource> | |
ReadPageAsync(Int32, CancellationToken)
public override Task<Page<TResource>> ReadPageAsync(int pageSize, CancellationToken cancellationToken = default(CancellationToken))Eagerly (but asynchronously) reads a single page of results with a fixed maximum size. The returned page is guaranteed to have that many results, unless there is no more data available.
| Parameters | |
|---|---|
| Name | Description |
pageSize | Int32The page size. Must be greater than 0. |
cancellationToken | CancellationTokenA token to cancel the operation. |
| Returns | |
|---|---|
| Type | Description |
Task<Page<TResource>> | An asynchronous operation, the result of which is a page of resources. |
"Natural" pages returned by the API may contain a smaller number of resources than requested. For example, a request for a page with 100 resources may return a page with 80 resources but a next page token for more to be retrieved. This is suitable for batch-processing, but not for user-visible paging such as in a web application, where fixed-size pages are expected. This method may make more than one API call in order to fill the page, but after the page has been returned, all the data will have been loaded. (In particular, iterating over the items in the page multiple times will not make any further requests.)