\ElasticaCluster

Cluster information for elasticsearch.

Summary

Methods
Properties
Constants
__construct()
refresh()
getResponse()
getIndexNames()
getState()
getNodeNames()
getNodes()
getClient()
getInfo()
getHealth()
getSettings()
No public properties found
No constants found
No protected methods found
$_client
$_response
$_data
N/A
No private methods found
No private properties found
N/A

Properties

$_client

$_client : \Elastica\Client

Client.

Type

\Elastica\Client — Client object

$_response

$_response : \Elastica\Response

Cluster state response.

Type

\Elastica\Response

$_data

$_data : array

Cluster state data.

Type

array

Methods

__construct()

__construct(\Elastica\Client  $client) 

Creates a cluster object.

Parameters

\Elastica\Client $client

Connection client object

refresh()

refresh() 

Refreshes all cluster information (state).

getResponse()

getResponse() : \Elastica\Response

Returns the response object.

Returns

\Elastica\Response

Response object

getIndexNames()

getIndexNames() : array

Return list of index names.

Returns

array —

List of index names

getState()

getState() : array

Returns the full state of the cluster.

Returns

array —

State array

getNodeNames()

getNodeNames() : array

Returns a list of existing node names.

Returns

array —

List of node names

getNodes()

getNodes() : array<mixed,\Elastica\Node>

Returns all nodes of the cluster.

Returns

array<mixed,\Elastica\Node>

getClient()

getClient() : \Elastica\Client

Returns the client object.

Returns

\Elastica\Client

Client object

getInfo()

getInfo(array  $args) 

Returns the cluster information (not implemented yet).

Parameters

array $args

Additional arguments

Throws

\Elastica\Exception\NotImplementedException