Interface IPageManager<TRequest, TResponse, TResource> (4.0.0) 

public interface IPageManager<TRequest, TResponse, TResource>

Interface describing the relationship between requests, responses and resources for page streaming.

Namespace

Google.Api.Gax.Rest

Assembly

Google.Api.Gax.Rest.dll

Type Parameters

NameDescription
TRequest

The request type.

TResponse

The response type.

TResource

The resource type.

Methods

GetNextPageToken(TResponse)

string GetNextPageToken(TResponse response)

Extracts the next page token from a response.

Parameter
NameDescription
responseTResponse

The response to extract the next page token from.

Returns
TypeDescription
String

The next page token, or null if this is the final page of results.

GetResources(TResponse)

IEnumerable<TResource> GetResources(TResponse response)

Extracts resources from a response.

Parameter
NameDescription
responseTResponse

The response containing the resources.

Returns
TypeDescription
IEnumerable<TResource>

The resources in the response, or null if it contains no resources.

SetPageSize(TRequest, Int32)

void SetPageSize(TRequest request, int pageSize)

Applies the given page size to the given request.

Parameters
NameDescription
requestTRequest

The request to modify.

pageSizeInt32

The page size for the next remote call.

SetPageToken(TRequest, String)

void SetPageToken(TRequest request, string pageToken)

Applies the given page token to the given request.

Parameters
NameDescription
requestTRequest

The request to modify.

pageTokenString

The page token for the next remote call.