extends |
AbstractNamespace |
---|
Class ListNamespace
NOTE: This file is autogenerated using util/GenerateEndpoints.php
Methods | ||||
---|---|---|---|---|
public
|
help(array $params = []): array
Returns help for the List APIs.
Returns help for the List APIs. $params['pretty'] = (boolean) Whether to pretty-format the returned JSON response. (Default = false)
$params['human'] = (boolean) Whether to return human-readable values for statistics. (Default = false)
$params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. (Default = false)
$params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
$params['filter_path'] = (any) A comma-separated list of filters used to filter the response. Use wildcards to match any field or part of a field's name. To exclude fields, use Parameters
|
# | ||
public
|
indices(array $params = []): array
Returns paginated information about indexes including number of primaries and replicas, document counts, disk size.
Returns paginated information about indexes including number of primaries and replicas, document counts, disk size. $params['index'] = (array) A comma-separated list of data streams, indexes, and aliases used to limit the request. Supports wildcards ( Parameters
|
# | ||
public
|
shards(array $params = []): array
Returns paginated details of shard allocation on nodes.
Returns paginated details of shard allocation on nodes. $params['index'] = (array) A comma-separated list of data streams, indexes, and aliases used to limit the request. Supports wildcards ( Parameters
|
# |
Methods inherited from OpenSearch\Namespaces\AbstractNamespace |
---|
__construct(), extractArgument(), performRequest() |
Properties inherited from OpenSearch\Namespaces\AbstractNamespace |
---|
$transport, $httpTransport, $endpointFactory, $endpoints |