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
jump to top

Package: Elastica

Elastica index status object

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


                 $_data= 'array()'

Default valuearray()Details


                 $_name= ''''

Default value''Details


                 $_response= 'null'

Default valuenullDetails

__construct(
          \Elastica_Index $index
          )
        
        :
          void

Parameters

Name	Type	Description
$index	\Elastica_Index	Index object

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

getAliases(
          
          )
        
        :
          array

Returns all index aliases

Returns

Type	Description
array	Aliases

getData(
          
          )
        
        :
          array

Returns all status info

Returns

Type	Description
array	Status info

getIndex(
          
          )
        
        :
          \Elastica_Index

Returns the index object

Returns

Type	Description
\Elastica_Index	Index object

getResponse(
          
          )
        
        :
          \Elastica_Response

Returns response object

Returns

Type	Description
\Elastica_Response	Response object

getSettings(
          
          )
        
        :
          array

Returns all index settings

Returns

Type	Description
array	Index settings

hasAlias(
          string $name
          )
        
        :
          void

Checks if the index has the given alias

Parameters

Name	Type	Description
$name	string	Alias name

refresh(
          
          )
        
        :
          void

Reloads all status data of this object