include/SugarSearchEngine/Elastic/Elastica/Node.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
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


                 $_info= 'null'

Default valuenullDetails


                 $_name= ''''

Default value''Details


                 $_stats= 'null'

Default valuenullDetails

__construct(
          string $name, \Elastica_Client $client
          )
        
        :
          void

Create a new node object

Parameters

Name	Type	Description
$name	string	Node name
$client	\Elastica_Client	Node object

getClient(
          
          )
        
        :
          \Elastica_Client

Returns the current client object

Returns

Type	Description
\Elastica_Client	Client

getInfo(
          
          )
        
        :
          \Elastica_Node_Info

Returns

Type	Description
\Elastica_Node_Info	Node info object

getName(
          
          )
        
        :
          string

Returns

Type	Description
string	Node name

getStats(
          
          )
        
        :
          \Elastica_Node_Stats

Return stats object of the current node

Returns

Type	Description
\Elastica_Node_Stats	Node stats

refresh(
          
          )
        
        :
          void

Refreshs all node information

This should be called after upating a node to refresh all information

shutdown(
          string $delay
              =
              '1s'
          )
        
        :
          \Elastica_Response

Shuts this node down

Parameters

Name	Type	Description
$delay	string	OPTIONAL Delay after which node is shut down (defualt = 1s)

Returns

Type	Description
\Elastica_Response

Details

Link: http://www.elasticsearch.org/guide/reference/api/admin-cluster-nodes-shutdown.html