include/SugarSearchEngine/Elastic/Elastica/Index/Status.php

Show: inherited
Table of Contents

Elastica index status object

Author
Nicolas Ruflin  
Category
Xodoa  
Link
http://www.elasticsearch.org/guide/reference/api/admin-indices-status.html  
Package
Elastica  

\Elastica_Index_Status

Package: Elastica

Elastica index status object

Author
Nicolas Ruflin  
Category
Xodoa  
Link
http://www.elasticsearch.org/guide/reference/api/admin-indices-status.html  

Properties

Propertyprotected  $_data= 'array()'
Default valuearray()Details
Type
n/a
Propertyprotected  $_name= ''''
Default value''Details
Type
n/a
Propertyprotected  $_response= 'null'
Default valuenullDetails
Type
n/a

Methods

methodpublic__construct( \Elastica_Index $index ) : void

Parameters
Name Type Description
$index \Elastica_Index

Index object

methodpublicget( ) : mixed

Returns the entry in the data array based on the params.

Various params possible.

Returns
Type Description
mixed Data array entry or null if not found
methodpublicgetAliases( ) : array

Returns all index aliases

Returns
Type Description
array Aliases
methodpublicgetData( ) : array

Returns all status info

Returns
Type Description
array Status info
methodpublicgetIndex( ) : \Elastica_Index

Returns the index object

Returns
Type Description
\Elastica_Index Index object
methodpublicgetResponse( ) : \Elastica_Response

Returns response object

Returns
Type Description
\Elastica_Response Response object
methodpublicgetSettings( ) : array

Returns all index settings

Returns
Type Description
array Index settings
methodpublichasAlias( string $name ) : void

Checks if the index has the given alias

Parameters
Name Type Description
$name string

Alias name

methodpublicrefresh( ) : void

Reloads all status data of this object

Documentation was generated by DocBlox 0.18.1.