Properties

$_data

$_data : array

Type

array — The cluster health data.

Methods

__construct()

__construct(\Elastica\Client  $client) 

Parameters

\Elastica\Client $client

The Elastica client.

getData()

getData() : array

Gets the health data.

Returns

array

refresh()

refresh() : $this

Refreshes the health data for the cluster.

Returns

$this

getClusterName()

getClusterName() : string

Gets the name of the cluster.

Returns

string

getStatus()

getStatus() : string

Gets the status of the cluster.

Returns

string —

green, yellow or red.

getTimedOut()

getTimedOut() : boolean

TODO determine the purpose of this.

Returns

boolean

getNumberOfNodes()

getNumberOfNodes() : integer

Gets the number of nodes in the cluster.

Returns

integer

getNumberOfDataNodes()

getNumberOfDataNodes() : integer

Gets the number of data nodes in the cluster.

Returns

integer

getActivePrimaryShards()

getActivePrimaryShards() : integer

Gets the number of active primary shards.

Returns

integer

getActiveShards()

getActiveShards() : integer

Gets the number of active shards.

Returns

integer

getRelocatingShards()

getRelocatingShards() : integer

Gets the number of relocating shards.

Returns

integer

getInitializingShards()

getInitializingShards() : integer

Gets the number of initializing shards.

Returns

integer

getUnassignedShards()

getUnassignedShards() : integer

Gets the number of unassigned shards.

Returns

integer

getIndices()

getIndices() : array<mixed,\Elastica\Cluster\Health\Index>

Gets the status of the indices.

Returns

array<mixed,\Elastica\Cluster\Health\Index>

_retrieveHealthData()

_retrieveHealthData() : array

Retrieves the health data from the cluster.

Returns

array