include/SugarSearchEngine/Elastic/Elastica/Node/Stats.php

Show: inherited
Table of Contents

Elastica cluster node object

Author
Nicolas Ruflin  
Category
Xodoa  
Link
http://www.elasticsearch.org/guide/reference/api/admin-indices-status.html  
Package
Elastica  

\Elastica_Node_Stats

Package: Elastica

Elastica cluster node object

Author
Nicolas Ruflin  
Category
Xodoa  
Link
http://www.elasticsearch.org/guide/reference/api/admin-indices-status.html  

Properties

Propertyprotected  $_data= 'array()'
Default valuearray()Details
Type
n/a
Propertyprotected  $_node= 'null'
Default valuenullDetails
Type
n/a
Propertyprotected  $_response= 'null'
Default valuenullDetails
Type
n/a

Methods

methodpublic__construct( \Elastica_Node $node ) : void

Parameters
Name Type Description
$node \Elastica_Node

Elastica node object

methodpublicget( ) : array

Returns all node stats as array based on the arguments

Several arguments can be use get('index', 'test', 'example')

Returns
Type Description
array Node stats for the given field or null if not found
methodpublicgetData( ) : array

Returns all stats data

Returns
Type Description
array Data array
methodpublicgetNode( ) : \Elastica_Node

Returns
Type Description
\Elastica_Node Node object
methodpublicgetResponse( ) : \Elastica_Response

Returns response object

Returns
Type Description
\Elastica_Response Response object
methodpublicrefresh( ) : \Elastica_Response

Reloads all nodes information. Has to be called if informations changed

Returns
Type Description
\Elastica_Response Response object
Documentation was generated by DocBlox 0.18.1.