\Elastica\IndexStats

Elastica index stats object.

Summary

Methods

Properties

Constants

__construct()
getData()
get()
getIndex()
getResponse()
refresh()

No public properties found

No constants found

No protected methods found

$_response
$_data
$_index

N/A

No private methods found

No private properties found

N/A

File: Index/Stats.php
Package: Default
Class hierarchy: \Elastica\Index\Stats
See also: https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-stats.html

Properties

$_response

$_response : \Elastica\Response

Response.

Type

\Elastica\Response — Response object

$_data

$_data : array

Stats info.

Type

array — Stats info

$_index

$_index : \Elastica\Index

Index.

Type

\Elastica\Index — Index object

Methods

__construct()

__construct(\Elastica\Index  $index)

Construct.

Parameters

\Elastica\Index

$index

Index object

getData()

getData() : array

Returns the raw stats info.

Returns

array —

Stats info

get()

get() : mixed

Returns the entry in the data array based on the params.

Various params possible.

Returns

mixed —

Data array entry or null if not found

getIndex()

getIndex() : \Elastica\Index

Returns the index object.

Returns

\Elastica\Index —

Index object

getResponse()

getResponse() : \Elastica\Response

Returns response object.

Returns

\Elastica\Response —

Response object

refresh()

refresh()

Reloads all status data of this object.