PHP Class Elastica\Cluster\Health\Index

See link: http://www.elasticsearch.org/guide/reference/api/admin-cluster-health.html
Author: Ray Ward ([email protected])
Show file Open project: ruflin/elastica Class Usage Examples

Protected Properties

Property Type Description
$_data The index health data.
$_name The name of the index.

Public Methods

Method Description
__construct ( string $name, array $data )
getActivePrimaryShards ( ) : integer Gets the number of active primary shards.
getActiveShards ( ) : integer Gets the number of active shards.
getInitializingShards ( ) : integer Gets the number of initializing shards.
getName ( ) : string Gets the name of the index.
getNumberOfReplicas ( ) : integer Gets the number of data nodes in the index.
getNumberOfShards ( ) : integer Gets the number of nodes in the index.
getRelocatingShards ( ) : integer Gets the number of relocating shards.
getShards ( ) : Elastica\Cluster\Health\Shard[] Gets the health of the shards in this index.
getStatus ( ) : string Gets the status of the index.
getUnassignedShards ( ) : integer Gets the number of unassigned shards.

Method Details

__construct() public method

public __construct ( string $name, array $data )
$name string The name of the index.
$data array The index health data.

getActivePrimaryShards() public method

Gets the number of active primary shards.
public getActivePrimaryShards ( ) : integer
return integer

getActiveShards() public method

Gets the number of active shards.
public getActiveShards ( ) : integer
return integer

getInitializingShards() public method

Gets the number of initializing shards.
public getInitializingShards ( ) : integer
return integer

getName() public method

Gets the name of the index.
public getName ( ) : string
return string

getNumberOfReplicas() public method

Gets the number of data nodes in the index.
public getNumberOfReplicas ( ) : integer
return integer

getNumberOfShards() public method

Gets the number of nodes in the index.
public getNumberOfShards ( ) : integer
return integer

getRelocatingShards() public method

Gets the number of relocating shards.
public getRelocatingShards ( ) : integer
return integer

getShards() public method

Gets the health of the shards in this index.
public getShards ( ) : Elastica\Cluster\Health\Shard[]
return Elastica\Cluster\Health\Shard[]

getStatus() public method

Gets the status of the index.
public getStatus ( ) : string
return string green, yellow or red.

getUnassignedShards() public method

Gets the number of unassigned shards.
public getUnassignedShards ( ) : integer
return integer

Property Details

$_data protected property

The index health data.
protected $_data

$_name protected property

The name of the index.
protected $_name