\ElasticaStatus

Elastica general status.

Summary

Methods

Properties

Constants

__construct()
getData()
getIndexNames()
indexExists()
aliasExists()
getIndicesWithAlias()
getResponse()
getShards()
refresh()

No public properties found

No constants found

No protected methods found

$_response
$_data
$_client

N/A

No private methods found

No private properties found

N/A

File: Status.php
Package: Default
Class hierarchy: \Elastica\Status
See also: https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-status.html

Properties

$_response

$_response : \Elastica\Response

Contains all status infos.

Type

\Elastica\Response — Response object

$_data

$_data : array

Data.

Type

array — Data

$_client

$_client : \Elastica\Client

Client object.

Type

\Elastica\Client — Client object

Methods

__construct()

__construct(\Elastica\Client  $client)

Constructs Status object.

Parameters

\Elastica\Client

$client

Client object

getData()

getData() : array

Returns status data.

Returns

array —

Status data

getIndexNames()

getIndexNames() : array

Returns a list of the existing index names.

Returns

array —

Index names list

indexExists()

indexExists(string  $name) : boolean

Checks if the given index exists.

Parameters

string

$name

Index name to check

Returns

boolean —

True if index exists

aliasExists()

aliasExists(string  $name) : boolean

Checks if the given alias exists.

Parameters

string

$name

Alias name

Returns

boolean —

True if alias exists

getIndicesWithAlias()

getIndicesWithAlias(string  $alias) : array|array<mixed,\Elastica\Index>

Returns an array with all indices that the given alias name points to.

Parameters

string

$alias

Alias name

Returns

array|array<mixed,\Elastica\Index> —

List of Elastica\Index

getResponse()

getResponse() : \Elastica\Response

Returns response object.

Returns

\Elastica\Response —

Response object

getShards()

getShards() : array

Return shards info.

Returns

array —

Shards info

refresh()

refresh()

Refresh status object.