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\Cluster\HealthIndex

Wraps status information for an index.

Summary

Methods
Properties
Constants
__construct()
getName()
getStatus()
getNumberOfShards()
getNumberOfReplicas()
getActivePrimaryShards()
getActiveShards()
getRelocatingShards()
getInitializingShards()
getUnassignedShards()
getShards()
No public properties found
No constants found
No protected methods found
$_name
$_data
N/A
No private methods found
No private properties found
N/A

Properties

$_name

$_name : string

Type

string — the name of the index

$_data

$_data : array

Type

array — the index health data

Methods

__construct()

__construct(string  $name, array  $data)

Parameters

string $name

the name of the index
array $data

the index health data

getName()

getName() : string

Gets the name of the index.

Returns

string

getStatus()

getStatus() : string

Gets the status of the index.

Returns

string —

green, yellow or red

getNumberOfShards()

getNumberOfShards() : integer

Gets the number of nodes in the index.

Returns

integer

getNumberOfReplicas()

getNumberOfReplicas() : integer

Gets the number of data nodes in the index.

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

getShards()

getShards() : array<mixed,\Elastica\Cluster\Health\Shard>

Gets the health of the shards in this index.

Returns

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