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

Show: inherited

• Classes
  • \Elastica_Node_Info

Table of Contents

Author

Nicolas Ruflin  

Category

Xodoa  

Link

http://www.elasticsearch.org/guide/reference/api/admin-indices-status.html  

Package

Elastica  

\Elastica_Node_Info

jump to top

Package: Elastica

Elastica cluster node object

Author

Nicolas Ruflin  

Category

Xodoa  

Link

http://www.elasticsearch.org/guide/reference/api/admin-indices-status.html  

Properties

 $_data= 'array()'

Default valuearray()Details

Type

n/a

 $_node= 'null'

Default valuenullDetails

Type

n/a

 $_response= 'null'

Default valuenullDetails

Type

n/a

Methods

__construct( \Elastica_Node $node ) : void

Parameters

Name	Type	Description
$node	\Elastica_Node	Node object

get( ) : mixed

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

Several params possible.

Example 1: get('os', 'mem', 'total') returns total memory of the system the node is running on Example 2: get('os', 'mem') returns an array with all mem infos

Returns

Type	Description
mixed	Data array entry or null if not found

getData( ) : array

Return all info data

Returns

Type	Description
array	Data array

getIp( ) : string

Returns

Type	Description
string	Returns Node ip address

getNode( ) : \Elastica_Node

Returns

Type	Description
\Elastica_Node	Node object

getPort( ) : string

Returns

Type	Description
string	Returns Node port

getResponse( ) : \Elastica_Response

Returns response object

Returns

Type	Description
\Elastica_Response	Response object

refresh( ) : \Elastica_Response

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

Returns

Type	Description
\Elastica_Response	Response object