Google API Core Client - Class PageStreamingDescriptor (1.38.0)

Reference documentation and code samples for the Google API Core Client class PageStreamingDescriptor.

Holds the description information used for page streaming.

Namespace

Google \ ApiCore

Methods

__construct

Parameters
Name Description
descriptor array

Required.
↳ requestPageTokenGetMethod string

the get method for the page token in the request object.
↳ requestPageTokenSetMethod string

the set method for the page token in the request object.
↳ responsePageTokenGetMethod string

the get method for the page token in the response object.
↳ resourcesGetMethod string

the get method for the resources in the response object. Optional.
↳ requestPageSizeGetMethod string

the get method for the page size in the request object.

getRequestPageTokenGetMethod

Returns
Type Description
string The page token get method on the request object

getRequestPageSizeGetMethod

Returns
Type Description
string The page size get method on the request object

requestHasPageSizeField

Returns
Type Description
bool True if the request object has a page size field

getResponsePageTokenGetMethod

Returns
Type Description
string The page token get method on the response object

getResourcesGetMethod

Returns
Type Description
string The resources get method on the response object

getRequestPageTokenSetMethod

Returns
Type Description
string The page token set method on the request object

getRequestPageSizeSetMethod

Returns
Type Description
string The page size set method on the request object

static::createFromFields

Parameters
Name Description
fields array

Required.
↳ requestPageTokenField string

the page token field in the request object.
↳ responsePageTokenField string

the page token field in the response object.
↳ resourceField string

the resource field in the response object. Optional.
↳ requestPageSizeField string

the page size field in the request object.
Returns
Type Description
PageStreamingDescriptor