PHP Class Elastica\Node\Stats

See link: https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-status.html
Author: Nicolas Ruflin ([email protected])
Show file Open project: ruflin/elastica

Protected Properties

Property Type Description
$_data Stats data.
$_node Node.
$_response Response.

Public Methods

Method Description
__construct ( Node $node ) Create new stats for node.
get ( ) : array Returns all node stats as array based on the arguments.
getData ( ) : array Returns all stats data.
getNode ( ) : Node Returns node object.
getResponse ( ) : Response Returns response object.
refresh ( ) : Response Reloads all nodes information. Has to be called if informations changed.

Method Details

__construct() public method

Create new stats for node.
public __construct ( Node $node )
$node Elastica\Node Elastica node object

get() public method

Several arguments can be use get('index', 'test', 'example')
public get ( ) : array
return array Node stats for the given field or null if not found

getData() public method

Returns all stats data.
public getData ( ) : array
return array Data array

getNode() public method

Returns node object.
public getNode ( ) : Node
return Elastica\Node Node object

getResponse() public method

Returns response object.
public getResponse ( ) : Response
return Elastica\Response Response object

refresh() public method

Reloads all nodes information. Has to be called if informations changed.
public refresh ( ) : Response
return Elastica\Response Response object

Property Details

$_data protected property

Stats data.
protected $_data

$_node protected property

Node.
protected $_node

$_response protected property

Response.
protected $_response