PHP Class Elastica\Cluster

See link: https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster.html
Author: Nicolas Ruflin ([email protected])
Mostra file Open project: ruflin/elastica Class Usage Examples

Protected Properties

Property Type Description
$_client Client.
$_data array Cluster state data.
$_response Response Cluster state response.

Public Methods

Method Description
__construct ( Client $client ) Creates a cluster object.
getClient ( ) : Client Returns the client object.
getHealth ( ) : Health Return Cluster health.
getIndexNames ( ) : array Return list of index names.
getInfo ( array $args ) Returns the cluster information (not implemented yet).
getNodeNames ( ) : array Returns a list of existing node names.
getNodes ( ) : Node[] Returns all nodes of the cluster.
getResponse ( ) : Response Returns the response object.
getSettings ( ) : Settings Return Cluster settings.
getState ( ) : array Returns the full state of the cluster.
refresh ( ) Refreshes all cluster information (state).

Method Details

__construct() public method

Creates a cluster object.
public __construct ( Client $client )
$client Client Connection client object

getClient() public method

Returns the client object.
public getClient ( ) : Client
return Client Client object

getHealth() public method

Return Cluster health.
See link: https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-health.html
public getHealth ( ) : Health
return Elastica\Cluster\Health

getIndexNames() public method

Return list of index names.
public getIndexNames ( ) : array
return array List of index names

getInfo() public method

Returns the cluster information (not implemented yet).
See link: https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-nodes-info.html
public getInfo ( array $args )
$args array Additional arguments

getNodeNames() public method

Returns a list of existing node names.
public getNodeNames ( ) : array
return array List of node names

getNodes() public method

Returns all nodes of the cluster.
public getNodes ( ) : Node[]
return Node[]

getResponse() public method

Returns the response object.
public getResponse ( ) : Response
return Response Response object

getSettings() public method

Return Cluster settings.
public getSettings ( ) : Settings
return Elastica\Cluster\Settings

getState() public method

Returns the full state of the cluster.
See link: https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-state.html
public getState ( ) : array
return array State array

refresh() public method

Refreshes all cluster information (state).
public refresh ( )

Property Details

$_client protected_oe property

Client.
protected $_client

$_data protected_oe property

Cluster state data.
protected array $_data
return array

$_response protected_oe property

Cluster state response.
protected Response,Elastica $_response
return Response