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

Version latest

• 4.8.0 (latest)
• 4.4.0
• 4.3.1
• 4.2.0
• 4.0.0
• 3.2.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
Name	Description
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
Name	Description
response	TResponse The response to extract the next page token from.

Returns
Type	Description
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
Name	Description
response	TResponse The response containing the resources.

Returns
Type	Description
IEnumerable	The resources in the response, or null if it contains no resources.

SetPageSize(TRequest, int)

void SetPageSize(TRequest request, int pageSize)

Applies the given page size to the given request.

Parameters
Name	Description
request	TRequest The request to modify.
pageSize	int 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
Name	Description
request	TRequest The request to modify.
pageToken	string The page token for the next remote call.