1. class
  2. Google
  3. \
  4. ApiCore
  5. \
  6. PageStreamingDescriptor

PageStreamingDescriptor

class PageStreamingDescriptor (View source)

Holds the description information used for page streaming.

Methods

__construct(array $descriptor)

No description

static PageStreamingDescriptor
createFromFields(array $fields)

No description

string
getRequestPageTokenGetMethod()

No description

string
getRequestPageSizeGetMethod()

No description

bool
requestHasPageSizeField()

No description

string
getResponsePageTokenGetMethod()

No description

string
getResourcesGetMethod()

No description

string
getRequestPageTokenSetMethod()

No description

string
getRequestPageSizeSetMethod()

No description

Details

at line 55
__construct(array $descriptor)

Parameters

array $descriptor { Required. @type string $requestPageTokenGetMethod the get method for the page token in the request object. @type string $requestPageTokenSetMethod the set method for the page token in the request object. @type string $responsePageTokenGetMethod the get method for the page token in the response object. @type string resourcesGetMethod the get method for the resources in the response object.

Optional.
@type string $requestPageSizeGetMethod the get method for the page size in the request object.

}

at line 74
static PageStreamingDescriptor createFromFields(array $fields)

Parameters

array $fields { Required.

@type string $requestPageTokenField the page token field in the request object.
@type string $responsePageTokenField the page token field in the response object.
@type string $resourceField the resource field in the response object.

Optional.
@type string $requestPageSizeField the page size field in the request object.

}

Return Value

PageStreamingDescriptor

at line 109
string getRequestPageTokenGetMethod()

Return Value

string The page token get method on the request object

at line 117
string getRequestPageSizeGetMethod()

Return Value

string The page size get method on the request object

at line 125
bool requestHasPageSizeField()

Return Value

bool True if the request object has a page size field

at line 133
string getResponsePageTokenGetMethod()

Return Value

string The page token get method on the response object

at line 141
string getResourcesGetMethod()

Return Value

string The resources get method on the response object

at line 149
string getRequestPageTokenSetMethod()

Return Value

string The page token set method on the request object

at line 157
string getRequestPageSizeSetMethod()

Return Value

string The page size set method on the request object