PHP Класс Elastica\Cluster\Health

См. ссылку: https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-health.html
Автор: Ray Ward ([email protected])
Показать файл Открыть проект Примеры использования класса

Защищенные свойства (Protected)

Свойство Тип Описание
$_client Client object.
$_data The cluster health data.

Открытые методы

Метод Описание
__construct ( Client $client )
getActivePrimaryShards ( ) : integer Gets the number of active primary shards.
getActiveShards ( ) : integer Gets the number of active shards.
getClusterName ( ) : string Gets the name of the cluster.
getData ( ) : array Gets the health data.
getIndices ( ) : Index[] Gets the status of the indices.
getInitializingShards ( ) : integer Gets the number of initializing shards.
getNumberOfDataNodes ( ) : integer Gets the number of data nodes in the cluster.
getNumberOfNodes ( ) : integer Gets the number of nodes in the cluster.
getRelocatingShards ( ) : integer Gets the number of relocating shards.
getStatus ( ) : string Gets the status of the cluster.
getTimedOut ( ) : boolean TODO determine the purpose of this.
getUnassignedShards ( ) : integer Gets the number of unassigned shards.
refresh ( ) Refreshes the health data for the cluster.

Защищенные методы

Метод Описание
_retrieveHealthData ( ) : array Retrieves the health data from the cluster.

Описание методов

__construct() публичный Метод

public __construct ( Client $client )
$client Elastica\Client The Elastica client.

_retrieveHealthData() защищенный Метод

Retrieves the health data from the cluster.
protected _retrieveHealthData ( ) : array
Результат array

getActivePrimaryShards() публичный Метод

Gets the number of active primary shards.
public getActivePrimaryShards ( ) : integer
Результат integer

getActiveShards() публичный Метод

Gets the number of active shards.
public getActiveShards ( ) : integer
Результат integer

getClusterName() публичный Метод

Gets the name of the cluster.
public getClusterName ( ) : string
Результат string

getData() публичный Метод

Gets the health data.
public getData ( ) : array
Результат array

getIndices() публичный Метод

Gets the status of the indices.
public getIndices ( ) : Index[]
Результат Elastica\Cluster\Health\Index[]

getInitializingShards() публичный Метод

Gets the number of initializing shards.
public getInitializingShards ( ) : integer
Результат integer

getNumberOfDataNodes() публичный Метод

Gets the number of data nodes in the cluster.
public getNumberOfDataNodes ( ) : integer
Результат integer

getNumberOfNodes() публичный Метод

Gets the number of nodes in the cluster.
public getNumberOfNodes ( ) : integer
Результат integer

getRelocatingShards() публичный Метод

Gets the number of relocating shards.
public getRelocatingShards ( ) : integer
Результат integer

getStatus() публичный Метод

Gets the status of the cluster.
public getStatus ( ) : string
Результат string green, yellow or red.

getTimedOut() публичный Метод

TODO determine the purpose of this.
public getTimedOut ( ) : boolean
Результат boolean

getUnassignedShards() публичный Метод

Gets the number of unassigned shards.
public getUnassignedShards ( ) : integer
Результат integer

refresh() публичный Метод

Refreshes the health data for the cluster.
public refresh ( )

Описание свойств

$_client защищенное свойство

Client object.
protected $_client

$_data защищенное свойство

The cluster health data.
protected $_data