Elastica
\
Elastica
Aggregation
Bulk
Action
Cluster
Health
Collapse
Connection
Strategy
Exception
Bulk
Response
Connection
Index
Multi
Node
Processor
Query
QueryBuilder
DSL
Version
Rescore
ResultSet
Script
Suggest
CandidateGenerator
Transport

\Elastica\ClusterHealth

Elastic cluster health.

Summary

Methods
Properties
Constants
__construct()
getData()
refresh()
getClusterName()
getStatus()
getTimedOut()
getNumberOfNodes()
getNumberOfDataNodes()
getActivePrimaryShards()
getActiveShards()
getRelocatingShards()
getInitializingShards()
getUnassignedShards()
getDelayedUnassignedShards()
getNumberOfPendingTasks()
getNumberOfInFlightFetch()
getTaskMaxWaitingInQueueMillis()
getActiveShardsPercentAsNumber()
getIndices()
No public properties found
No constants found
_retrieveHealthData()
$_client
$_data
N/A
No private methods found
No private properties found
N/A

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

getDelayedUnassignedShards()

getDelayedUnassignedShards() : integer

get the number of delayed unassined shards.

Returns

integer

getNumberOfPendingTasks()

getNumberOfPendingTasks() : integer

Returns

integer

getNumberOfInFlightFetch()

getNumberOfInFlightFetch() : integer

Returns

integer

getTaskMaxWaitingInQueueMillis()

getTaskMaxWaitingInQueueMillis() : integer

Returns

integer

getActiveShardsPercentAsNumber()

getActiveShardsPercentAsNumber() : integer

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