PHP Class Elastica\Status

See link: https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-status.html
Author: Nicolas Ruflin ([email protected])
Show file Open project: ruflin/elastica Class Usage Examples

Protected Properties

Property Type Description
$_client Client object.
$_data Data.
$_response Contains all status infos.

Public Methods

Method Description
__construct ( Client $client ) Constructs Status object.
aliasExists ( string $name ) : boolean Checks if the given alias exists.
getData ( ) : array Returns status data.
getIndexNames ( ) : array Returns a list of the existing index names.
getIndicesWithAlias ( string $alias ) : array | Index[] Returns an array with all indices that the given alias name points to.
getResponse ( ) : Response Returns response object.
getShards ( ) : array Return shards info.
indexExists ( string $name ) : boolean Checks if the given index exists.
refresh ( ) Refresh status object.

Method Details

__construct() public method

Constructs Status object.
public __construct ( Client $client )
$client Client Client object

aliasExists() public method

Checks if the given alias exists.
public aliasExists ( string $name ) : boolean
$name string Alias name
return boolean True if alias exists

getData() public method

Returns status data.
public getData ( ) : array
return array Status data

getIndexNames() public method

Returns a list of the existing index names.
public getIndexNames ( ) : array
return array Index names list

getIndicesWithAlias() public method

Returns an array with all indices that the given alias name points to.
public getIndicesWithAlias ( string $alias ) : array | Index[]
$alias string Alias name
return array | Index[] List of Elastica\Index

getResponse() public method

Returns response object.
public getResponse ( ) : Response
return Response Response object

getShards() public method

Return shards info.
public getShards ( ) : array
return array Shards info

indexExists() public method

Checks if the given index exists.
public indexExists ( string $name ) : boolean
$name string Index name to check
return boolean True if index exists

refresh() public method

Refresh status object.
public refresh ( )

Property Details

$_client protected property

Client object.
protected $_client

$_data protected property

Data.
protected $_data

$_response protected property

Contains all status infos.
protected $_response