Google Cloud Chronicle V1 Client - Class CustomAPIPagination (0.7.1)

Reference documentation and code samples for the Google Cloud Chronicle V1 Client class CustomAPIPagination.

Pagination strategy for the request.

Generated from protobuf message google.cloud.chronicle.v1.CustomAPIPagination

Namespace

Google \ Cloud \ Chronicle \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ none`	`CustomAPIPagination\NonePagination` Fetch data in a single request without paging.
`↳ token`	`CustomAPIPagination\TokenPagination` Use tokens (custom keys) to get the next page of data.
`↳ link`	`CustomAPIPagination\LinkPagination` Follow links provided in the response to get more data.
`↳ offset`	`CustomAPIPagination\OffsetPagination` Skip a set number of records to get the next set.
`↳ page_number`	`CustomAPIPagination\PageNumberPagination` Go to the next page number (e.g., page 2).

getNone

Fetch data in a single request without paging.

Returns
Type	Description
`CustomAPIPagination\NonePagination\|null`

hasNone

setNone

Fetch data in a single request without paging.

Parameter
Name	Description
`var`	`CustomAPIPagination\NonePagination`

Returns
Type	Description
`$this`

getToken

Use tokens (custom keys) to get the next page of data.

Returns
Type	Description
`CustomAPIPagination\TokenPagination\|null`

hasToken

setToken

Use tokens (custom keys) to get the next page of data.

Parameter
Name	Description
`var`	`CustomAPIPagination\TokenPagination`

Returns
Type	Description
`$this`

getLink

Follow links provided in the response to get more data.

Returns
Type	Description
`CustomAPIPagination\LinkPagination\|null`

hasLink

setLink

Follow links provided in the response to get more data.

Parameter
Name	Description
`var`	`CustomAPIPagination\LinkPagination`

Returns
Type	Description
`$this`

getOffset

Skip a set number of records to get the next set.

Returns
Type	Description
`CustomAPIPagination\OffsetPagination\|null`

hasOffset

setOffset