Pageable configures paging for the list applications operation in the OpenSearch High-Performance Search Edition PHP SDK.
Full class path: OpenSearch\Generated\Common\Pageable
Attributes
$page
public integer $page = null| Property | Value |
|---|---|
| Type | integer |
| Default | null |
The page number to retrieve.
$size
public integer $size = null| Property | Value |
|---|---|
| Type | integer |
| Default | null |
The number of results per page.
$start
public integer $start = null| Property | Value |
|---|---|
| Type | integer |
| Default | null |
The offset of the first result to return.
$_TSPEC
public static mixed $_TSPECUsage examples
Page-based pagination — retrieve the first page with 20 results per page:
$pageable = new \OpenSearch\Generated\Common\Pageable([
'page' => 0,
'size' => 20,
]);Offset-based pagination — retrieve results starting from position 40 with 20 results per page:
$pageable = new \OpenSearch\Generated\Common\Pageable([
'start' => 40,
'size' => 20,
]);Methods
__construct
mixed OpenSearch\Generated\Common\Pageable::__construct($vals)Parameters
| Parameter | Type | Description |
|---|---|---|
$vals | mixed | Associative array of attribute values (page, size, start) |
getName
mixed OpenSearch\Generated\Common\Pageable::getName()read
mixed OpenSearch\Generated\Common\Pageable::read($input)Parameters
| Parameter | Type | Description |
|---|---|---|
$input | mixed |
write
mixed OpenSearch\Generated\Common\Pageable::write($output)Parameters
| Parameter | Type | Description |
|---|---|---|
$output | mixed |
该文章对您有帮助吗?