IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.
« Elasticsearch\Namespaces\ClusterNamespace Elasticsearch\Namespaces\NodesNamespace »
Elastic Docs ›Elasticsearch-PHP [2.x] ›Reference - Endpoints

Elasticsearch\Namespaces\IndicesNamespace

edit

Elasticsearch\Namespaces\IndicesNamespace

edit

Class IndicesNamespace

Methods

The class defines the following methods:

exists()

/*
$params['index']              = (list) A comma-separated list of indices to check (Required)
       ['ignore_unavailable'] = (boolean) Whether specified concrete indices should be ignored when unavailable
(missing or closed)
       ['allow_no_indices']   = (boolean) Whether to ignore if a wildcard indices expression resolves into no
concrete indices. (This includes `_all` string or when no indices have been specified)
       ['expand_wildcards']   = (enum) Whether to expand wildcard expression to concrete indices that are open,
closed or both. (open,closed,none,all) (default: open)
       ['local']              = (boolean) Return local information, do not retrieve the state from master node
(default: false)
       ['body']  = (array) Request body
*/

$params = [
    // ...
];

$client = ClientBuilder::create()->build();
$response = $client->indices()->exists($params);

get()

/*
$params['index']              = (list) A comma-separated list of index names (Required)
       ['feature']            = (list) A comma-separated list of features
       ['local']              = (boolean) Return local information, do not retrieve the state from master node
(default: false)
       ['ignore_unavailable'] = (boolean) Ignore unavailable indexes (default: false)
       ['allow_no_indices']   = (boolean) Ignore if a wildcard expression resolves to no concrete indices
(default: false)
       ['expand_wildcards']   = (enum) Whether wildcard expressions should get expanded to open or closed
indices (default: open) (open,closed,none,all) (default: open)
       ['flat_settings']      = (boolean) Return settings in flat format (default: false)
       ['human']              = (boolean) Whether to return version and creation date values in human-readable
format. (default: false)
       ['body']  = (array) Request body
*/

$params = [
    // ...
];

$client = ClientBuilder::create()->build();
$response = $client->indices()->get($params);

segments()

/*
$params['index']               = (list) A comma-separated list of index names; use `_all` or empty string to
perform the operation on all indices
       ['ignore_unavailable']  = (boolean) Whether specified concrete indices should be ignored when unavailable
(missing or closed)
       ['allow_no_indices']    = (boolean) Whether to ignore if a wildcard indices expression resolves into no
concrete indices. (This includes `_all` string or when no indices have been specified)
       ['expand_wildcards']    = (enum) Whether to expand wildcard expression to concrete indices that are open,
closed or both. (open,closed,none,all) (default: open)
       ['human']               = (boolean) Whether to return time and byte values in human-readable format.
       ['body']  = (array) Request body
*/

$params = [
    // ...
];

$client = ClientBuilder::create()->build();
$response = $client->indices()->segments($params);

deleteTemplate()

/*
$params['name']           = (string) The name of the template (Required)
       ['timeout']        = (time) Explicit operation timeout
       ['master_timeout'] = (time) Specify timeout for connection to master
       ['body']  = (array) Request body
*/

$params = [
    // ...
];

$client = ClientBuilder::create()->build();
$response = $client->indices()->deleteTemplate($params);

deleteWarmer()

/*
$params['index']          = (list) A comma-separated list of index names to delete warmers from (supports
wildcards); use `_all` to perform the operation on all indices. (Required)
       ['name']           = (list) A comma-separated list of warmer names to delete (supports wildcards); use
`_all` to delete all warmers in the specified indices. You must specify a name either in the uri or in the
parameters.
       ['body']  = (array) Request body
*/

$params = [
    // ...
];

$client = ClientBuilder::create()->build();
$response = $client->indices()->deleteWarmer($params);

delete()

/*
$params['index']          = (list) A comma-separated list of indices to delete; use `_all` or `*` string to
delete all indices (Required)
       ['timeout']        = (time) Explicit operation timeout
       ['master_timeout'] = (time) Specify timeout for connection to master
       ['body']  = (array) Request body
*/

$params = [
    // ...
];

$client = ClientBuilder::create()->build();
$response = $client->indices()->delete($params);

stats()

/*
$params['index']             = (list) A comma-separated list of index names; use `_all` or empty string to
perform the operation on all indices
       ['metric']            = (list) Limit the information returned the specific metrics.
       ['body']  = (array) Request body
*/

$params = [
    // ...
];

$client = ClientBuilder::create()->build();
$response = $client->indices()->stats($params);

snapshotIndex()

/*
*/

$params = [
    // ...
];

$client = ClientBuilder::create()->build();
$response = $client->indices()->snapshotIndex($params);

putSettings()

/*
$params['index']              = (list) A comma-separated list of index names; use `_all` or empty string to
perform the operation on all indices
       ['master_timeout']     = (time) Specify timeout for connection to master
       ['ignore_unavailable'] = (boolean) Whether specified concrete indices should be ignored when unavailable
(missing or closed)
       ['allow_no_indices']   = (boolean) Whether to ignore if a wildcard indices expression resolves into no
concrete indices. (This includes `_all` string or when no indices have been specified)
       ['expand_wildcards']   = (enum) Whether to expand wildcard expression to concrete indices that are open,
closed or both. (open,closed,none,all) (default: open)
       ['flat_settings']      = (boolean) Return settings in flat format (default: false)
       ['body']               = The index settings to be updated
       ['body']  = (array) Request body
*/

$params = [
    // ...
];

$client = ClientBuilder::create()->build();
$response = $client->indices()->putSettings($params);

getMapping()

/*
$params['index']              = (list) A comma-separated list of index names
       ['type']               = (list) A comma-separated list of document types
       ['ignore_unavailable'] = (boolean) Whether specified concrete indices should be ignored when unavailable
(missing or closed)
       ['allow_no_indices']   = (boolean) Whether to ignore if a wildcard indices expression resolves into no
concrete indices. (This includes `_all` string or when no indices have been specified)
       ['expand_wildcards']   = (enum) Whether to expand wildcard expression to concrete indices that are open,
closed or both. (open,closed,none,all) (default: open)
       ['local']              = (boolean) Return local information, do not retrieve the state from master node
(default: false)
       ['body']  = (array) Request body
*/

$params = [
    // ...
];

$client = ClientBuilder::create()->build();
$response = $client->indices()->getMapping($params);

getFieldMapping()

/*
$params['index']              = (list) A comma-separated list of index names
       ['type']               = (list) A comma-separated list of document types
       ['fields']             = (list) A comma-separated list of fields (Required)
       ['include_defaults']   = (boolean) Whether the default mapping values should be returned as well
       ['ignore_unavailable'] = (boolean) Whether specified concrete indices should be ignored when unavailable
(missing or closed)
       ['allow_no_indices']   = (boolean) Whether to ignore if a wildcard indices expression resolves into no
concrete indices. (This includes `_all` string or when no indices have been specified)
       ['expand_wildcards']   = (enum) Whether to expand wildcard expression to concrete indices that are open,
closed or both. (open,closed,none,all) (default: open)
       ['local']              = (boolean) Return local information, do not retrieve the state from master node
(default: false)
       ['body']  = (array) Request body
*/

$params = [
    // ...
];

$client = ClientBuilder::create()->build();
$response = $client->indices()->getFieldMapping($params);

flushSynced()

/*
$params['index']              = (list) A comma-separated list of index names; use `_all` or empty string for all
indices
       ['ignore_unavailable'] = (boolean) Whether specified concrete indices should be ignored when unavailable
(missing or closed)
       ['allow_no_indices']   = (boolean) Whether to ignore if a wildcard indices expression resolves into no
concrete indices. (This includes `_all` string or when no indices have been specified)
       ['expand_wildcards']   = (enum) Whether to expand wildcard expression to concrete indices that are open,
closed or both. (open,closed,none,all) (default: open)
       ['body']  = (array) Request body
*/

$params = [
    // ...
];

$client = ClientBuilder::create()->build();
$response = $client->indices()->flushSynced($params);

flush()

/*
$params['index']              = (list) A comma-separated list of index names; use `_all` or empty string for all
indices
       ['force']              = (boolean) Whether a flush should be forced even if it is not necessarily needed
ie. if no changes will be committed to the index. This is useful if transaction log IDs should be incremented
even if no uncommitted changes are present. (This setting can be considered as internal)
       ['full']               = (boolean) TODO: ?
       ['wait_if_ongoing']    = (boolean) If set to true the flush operation will block until the flush can be
executed if another flush operation is already executing. The default is false and will cause an exception to be
thrown on the shard level if another flush operation is already running.
       ['body']  = (array) Request body
*/

$params = [
    // ...
];

$client = ClientBuilder::create()->build();
$response = $client->indices()->flush($params);

refresh()

/*
$params['index']               = (list) A comma-separated list of index names; use `_all` or empty string to
perform the operation on all indices
       ['ignore_unavailable']  = (boolean) Whether specified concrete indices should be ignored when unavailable
(missing or closed)
       ['allow_no_indices']    = (boolean) Whether to ignore if a wildcard indices expression resolves into no
concrete indices. (This includes `_all` string or when no indices have been specified)
       ['expand_wildcards']    = (enum) Whether to expand wildcard expression to concrete indices that are open,
closed or both. (open,closed,none,all) (default: open)
       ['force']               = (boolean) Force a refresh even if not required (default: false)
       ['operation_threading'] = TODO: ?
       ['body']  = (array) Request body
*/

$params = [
    // ...
];

$client = ClientBuilder::create()->build();
$response = $client->indices()->refresh($params);

recovery()

/*
$params['index']       = (list) A comma-separated list of index names; use `_all` or empty string to perform the
operation on all indices
       ['detailed']    = (boolean) Whether to display detailed information about shard recovery (default: false)
       ['active_only'] = (boolean) Display only those recoveries that are currently on-going (default: false)
       ['human']       = (boolean) Whether to return time and byte values in human-readable format. (default:
false)
       ['body']  = (array) Request body
*/

$params = [
    // ...
];

$client = ClientBuilder::create()->build();
$response = $client->indices()->recovery($params);

existsType()

/*
$params['index']              = (list) A comma-separated list of index names; use `_all` to check the types
across all indices (Required)
       ['type']               = (list) A comma-separated list of document types to check (Required)
       ['ignore_unavailable'] = (boolean) Whether specified concrete indices should be ignored when unavailable
(missing or closed)
       ['allow_no_indices']   = (boolean) Whether to ignore if a wildcard indices expression resolves into no
concrete indices. (This includes `_all` string or when no indices have been specified)
       ['expand_wildcards']   = (enum) Whether to expand wildcard expression to concrete indices that are open,
closed or both. (open,closed,none,all) (default: open)
       ['local']              = (boolean) Return local information, do not retrieve the state from master node
(default: false)
       ['body']  = (array) Request body
*/

$params = [
    // ...
];

$client = ClientBuilder::create()->build();
$response = $client->indices()->existsType($params);

putAlias()

/*
$params['index']          = (list) A comma-separated list of index names the alias should point to (supports
wildcards); use `_all` to perform the operation on all indices. (Required)
       ['name']           = (string) The name of the alias to be created or updated (Required)
       ['timeout']        = (time) Explicit timestamp for the document
       ['master_timeout'] = (time) Specify timeout for connection to master
       ['body']           = The settings for the alias, such as `routing` or `filter`
       ['body']  = (array) Request body
*/

$params = [
    // ...
];

$client = ClientBuilder::create()->build();
$response = $client->indices()->putAlias($params);

getWarmer()

/*
$params['index']              = (list) A comma-separated list of index names to restrict the operation; use
`_all` to perform the operation on all indices
       ['name']               = (list) The name of the warmer (supports wildcards); leave empty to get all
warmers
       ['type']               = (list) A comma-separated list of document types to restrict the operation; leave
empty to perform the operation on all types
       ['ignore_unavailable'] = (boolean) Whether specified concrete indices should be ignored when unavailable
(missing or closed)
       ['allow_no_indices']   = (boolean) Whether to ignore if a wildcard indices expression resolves into no
concrete indices. (This includes `_all` string or when no indices have been specified)
       ['expand_wildcards']   = (enum) Whether to expand wildcard expression to concrete indices that are open,
closed or both. (open,closed,none,all) (default: open)
       ['local']              = (boolean) Return local information, do not retrieve the state from master node
(default: false)
       ['body']  = (array) Request body
*/

$params = [
    // ...
];

$client = ClientBuilder::create()->build();
$response = $client->indices()->getWarmer($params);

putWarmer()

/*
$params['index']              = (list) A comma-separated list of index names to register the warmer for; use
`_all` or omit to perform the operation on all indices
       ['name']               = (string) The name of the warmer (Required)
       ['type']               = (list) A comma-separated list of document types to register the warmer for;
leave empty to perform the operation on all types
       ['master_timeout']     = (time) Specify timeout for connection to master
       ['ignore_unavailable'] = (boolean) Whether specified concrete indices should be ignored when unavailable
(missing or closed) in the search request to warm
       ['allow_no_indices']   = (boolean) Whether to ignore if a wildcard indices expression resolves into no
concrete indices in the search request to warm. (This includes `_all` string or when no indices have been
specified)
       ['expand_wildcards']   = (enum) Whether to expand wildcard expression to concrete indices that are open,
closed or both, in the search request to warm. (open,closed,none,all) (default: open)
       ['request_cache']      = (boolean) Specify whether the request to be warmed should use the request cache,
defaults to index level setting
       ['body']               = The search request definition for the warmer (query, filters, facets, sorting,
etc)
       ['body']  = (array) Request body
*/

$params = [
    // ...
];

$client = ClientBuilder::create()->build();
$response = $client->indices()->putWarmer($params);

putTemplate()

/*
$params['name']           = (string) The name of the template (Required)
       ['order']          = (number) The order for this template when merging multiple matching ones (higher
numbers are merged later, overriding the lower numbers)
       ['create']         = (boolean) Whether the index template should only be added if new or can also replace
an existing one (default: false)
       ['timeout']        = (time) Explicit operation timeout
       ['master_timeout'] = (time) Specify timeout for connection to master
       ['flat_settings']  = (boolean) Return settings in flat format (default: false)
       ['body']           = The template definition
       ['body']  = (array) Request body
*/

$params = [
    // ...
];

$client = ClientBuilder::create()->build();
$response = $client->indices()->putTemplate($params);

validateQuery()

/*
$params['index']                    = (list) A comma-separated list of index names to restrict the operation;
use `_all` or empty string to perform the operation on all indices
       ['type']                     = (list) A comma-separated list of document types to restrict the operation;
leave empty to perform the operation on all types
       ['explain']                  = (boolean) Return detailed information about the error
       ['ignore_indices']           = (enum) When performed on multiple indices, allows to ignore `missing` ones
       ['ignore_unavailable']       = (boolean) Whether specified concrete indices should be ignored when
unavailable (missing or closed)
       ['allow_no_indices']         = (boolean) Whether to ignore if a wildcard indices expression resolves into
no concrete indices. (This includes `_all` string or when no indices have been specified)
       ['expand_wildcards']         = (enum) Whether to expand wildcard expression to concrete indices that are
open, closed or both. (open,closed,none,all) (default: open)
       ['operation_threading']      = TODO: ?
       ['q']                        = (string) Query in the Lucene query string syntax
       ['analyzer']                 = (string) The analyzer to use for the query string
       ['analyze_wildcard']         = (boolean) Specify whether wildcard and prefix queries should be analyzed
(default: false)
       ['default_operator']         = (enum) The default operator for query string query (AND or OR) (AND,OR)
(default: OR)
       ['df']                       = (string) The field to use as default where no field prefix is given in the
query string
       ['lenient']                  = (boolean) Specify whether format-based query failures (such as providing
text to a numeric field) should be ignored
       ['lowercase_expanded_terms'] = (boolean) Specify whether query terms should be lowercased
       ['rewrite']                  = (boolean) Provide a more detailed explanation showing the actual Lucene
query that will be executed.
       ['body']  = (array) Request body
*/

$params = [
    // ...
];

$client = ClientBuilder::create()->build();
$response = $client->indices()->validateQuery($params);

getAlias()

/*
$params['index']              = (list) A comma-separated list of index names to filter aliases
       ['name']               = (list) A comma-separated list of alias names to return
       ['ignore_unavailable'] = (boolean) Whether specified concrete indices should be ignored when unavailable
(missing or closed)
       ['allow_no_indices']   = (boolean) Whether to ignore if a wildcard indices expression resolves into no
concrete indices. (This includes `_all` string or when no indices have been specified)
       ['expand_wildcards']   = (enum) Whether to expand wildcard expression to concrete indices that are open,
closed or both. (open,closed,none,all) (default: open)
       ['local']              = (boolean) Return local information, do not retrieve the state from master node
(default: false)
       ['body']  = (array) Request body
*/

$params = [
    // ...
];

$client = ClientBuilder::create()->build();
$response = $client->indices()->getAlias($params);

putMapping()

/*
$params['index']              = (list) A comma-separated list of index names the mapping should be added to
(supports wildcards); use `_all` or omit to add the mapping on all indices.
       ['body']  = (array) Request body
*/

$params = [
    // ...
];

$client = ClientBuilder::create()->build();
$response = $client->indices()->putMapping($params);

deleteMapping()

/*
*/

$params = [
    // ...
];

$client = ClientBuilder::create()->build();
$response = $client->indices()->deleteMapping($params);

getTemplate()

/*
$params['name']           = (list) The comma separated names of the index templates (Required)
       ['flat_settings']  = (boolean) Return settings in flat format (default: false)
       ['master_timeout'] = (time) Explicit operation timeout for connection to master node
       ['local']          = (boolean) Return local information, do not retrieve the state from master node
(default: false)
       ['body']  = (array) Request body
*/

$params = [
    // ...
];

$client = ClientBuilder::create()->build();
$response = $client->indices()->getTemplate($params);

existsTemplate()

/*
$params['name']           = (string) The name of the template (Required)
       ['master_timeout'] = (time) Explicit operation timeout for connection to master node
       ['local']          = (boolean) Return local information, do not retrieve the state from master node
(default: false)
       ['body']  = (array) Request body
*/

$params = [
    // ...
];

$client = ClientBuilder::create()->build();
$response = $client->indices()->existsTemplate($params);

create()

/*
$params['index']            = (string) The name of the index (Required)
       ['timeout']          = (time) Explicit operation timeout
       ['master_timeout']   = (time) Specify timeout for connection to master
       ['update_all_types'] = (boolean) Whether to update the mapping for all fields with the same name across
all types or not
       ['body']             = The configuration for the index (`settings` and `mappings`)
       ['body']  = (array) Request body
*/

$params = [
    // ...
];

$client = ClientBuilder::create()->build();
$response = $client->indices()->create($params);

optimize()

/*
$params['index']                = (list) A comma-separated list of index names; use `_all` or empty string to
perform the operation on all indices
       ['flush']                = (boolean) Specify whether the index should be flushed after performing the
operation (default: true)
       ['ignore_unavailable']   = (boolean) Whether specified concrete indices should be ignored when
unavailable (missing or closed)
       ['allow_no_indices']     = (boolean) Whether to ignore if a wildcard indices expression resolves into no
concrete indices. (This includes `_all` string or when no indices have been specified)
       ['expand_wildcards']     = (enum) Whether to expand wildcard expression to concrete indices that are
open, closed or both. (open,closed,none,all) (default: open)
       ['max_num_segments']     = (number) The number of segments the index should be merged into (default:
dynamic)
       ['only_expunge_deletes'] = (boolean) Specify whether the operation should only expunge deleted documents
       ['operation_threading']  = TODO: ?
       ['wait_for_merge']       = (boolean) Specify whether the request should block until the merge process is
finished (default: true)
       ['body']  = (array) Request body
*/

$params = [
    // ...
];

$client = ClientBuilder::create()->build();
$response = $client->indices()->optimize($params);

forceMerge()

/*
$params['index']                = (list) A comma-separated list of index names; use `_all` or empty string to
perform the operation on all indices
       ['flush']                = (boolean) Specify whether the index should be flushed after performing the
operation (default: true)
       ['ignore_unavailable']   = (boolean) Whether specified concrete indices should be ignored when
unavailable (missing or closed)
       ['allow_no_indices']     = (boolean) Whether to ignore if a wildcard indices expression resolves into no
concrete indices. (This includes `_all` string or when no indices have been specified)
       ['expand_wildcards']     = (enum) Whether to expand wildcard expression to concrete indices that are
open, closed or both. (open,closed,none,all) (default: open)
       ['max_num_segments']     = (number) The number of segments the index should be merged into (default:
dynamic)
       ['only_expunge_deletes'] = (boolean) Specify whether the operation should only expunge deleted documents
       ['operation_threading']  = TODO: ?
       ['wait_for_merge']       = (boolean) Specify whether the request should block until the merge process is
finished (default: true)
       ['body']  = (array) Request body
*/

$params = [
    // ...
];

$client = ClientBuilder::create()->build();
$response = $client->indices()->forceMerge($params);

deleteAlias()

/*
$params['index']          = (list) A comma-separated list of index names (supports wildcards); use `_all` for
all indices (Required)
       ['name']           = (list) A comma-separated list of aliases to delete (supports wildcards); use `_all`
to delete all aliases for the specified indices. (Required)
       ['timeout']        = (time) Explicit timestamp for the document
       ['master_timeout'] = (time) Specify timeout for connection to master
       ['body']  = (array) Request body
*/

$params = [
    // ...
];

$client = ClientBuilder::create()->build();
$response = $client->indices()->deleteAlias($params);

open()

/*
$params['index']              = (list) A comma separated list of indices to open (Required)
       ['timeout']            = (time) Explicit operation timeout
       ['master_timeout']     = (time) Specify timeout for connection to master
       ['ignore_unavailable'] = (boolean) Whether specified concrete indices should be ignored when unavailable
(missing or closed)
       ['allow_no_indices']   = (boolean) Whether to ignore if a wildcard indices expression resolves into no
concrete indices. (This includes `_all` string or when no indices have been specified)
       ['expand_wildcards']   = (enum) Whether to expand wildcard expression to concrete indices that are open,
closed or both. (open,closed,none,all) (default: closed)
       ['body']  = (array) Request body
*/

$params = [
    // ...
];

$client = ClientBuilder::create()->build();
$response = $client->indices()->open($params);

analyze()

/*
$params['index']        = (string) The name of the index to scope the operation
       ['analyzer']     = (string) The name of the analyzer to use
       ['char_filters'] = (list) Deprecated : A comma-separated list of character filters to use for the
analysis
       ['char_filter']  = (list) A comma-separated list of character filters to use for the analysis
       ['field']        = (string) Use the analyzer configured for this field (instead of passing the analyzer
name)
       ['filters']      = (list) Deprecated : A comma-separated list of filters to use for the analysis
       ['filter']       = (list) A comma-separated list of filters to use for the analysis
       ['prefer_local'] = (boolean) With `true`, specify that a local shard should be used if available, with
`false`, use a random shard (default: true)
       ['text']         = (list) The text on which the analysis should be performed (when request body is not
used)
       ['tokenizer']    = (string) The name of the tokenizer to use for the analysis
       ['explain']      = (boolean) With `true`, outputs more advanced details. (default: false)
       ['attributes']   = (list) A comma-separated list of token attributes to output, this parameter works only
with `explain=true`
       ['format']       = (enum) Format of the output (detailed,text) (default: detailed)
       ['body']         = The text on which the analysis should be performed
       ['body']  = (array) Request body
*/

$params = [
    // ...
];

$client = ClientBuilder::create()->build();
$response = $client->indices()->analyze($params);

clearCache()

/*
$params['index']              = (list) A comma-separated list of index name to limit the operation
       ['field_data']         = (boolean) Clear field data
       ['fielddata']          = (boolean) Clear field data
       ['fields']             = (list) A comma-separated list of fields to clear when using the `field_data`
parameter (default: all)
       ['query']              = (boolean) Clear query caches
       ['ignore_unavailable'] = (boolean) Whether specified concrete indices should be ignored when unavailable
(missing or closed)
       ['allow_no_indices']   = (boolean) Whether to ignore if a wildcard indices expression resolves into no
concrete indices. (This includes `_all` string or when no indices have been specified)
       ['expand_wildcards']   = (enum) Whether to expand wildcard expression to concrete indices that are open,
closed or both. (open,closed,none,all) (default: open)
       ['recycler']           = (boolean) Clear the recycler cache
       ['request']            = (boolean) Clear request cache
       ['body']  = (array) Request body
*/

$params = [
    // ...
];

$client = ClientBuilder::create()->build();
$response = $client->indices()->clearCache($params);

updateAliases()

/*
$params['timeout']        = (time) Request timeout
       ['master_timeout'] = (time) Specify timeout for connection to master
       ['body']           = The definition of `actions` to perform
       ['body']  = (array) Request body
*/

$params = [
    // ...
];

$client = ClientBuilder::create()->build();
$response = $client->indices()->updateAliases($params);

getAliases()

/*
$params['index']   = (list) A comma-separated list of index names to filter aliases
       ['name']    = (list) A comma-separated list of alias names to filter
       ['timeout'] = (time) Explicit operation timeout
       ['local']   = (boolean) Return local information, do not retrieve the state from master node (default:
false)
       ['body']  = (array) Request body
*/

$params = [
    // ...
];

$client = ClientBuilder::create()->build();
$response = $client->indices()->getAliases($params);

existsAlias()

/*
$params['index']              = (list) A comma-separated list of index names to filter aliases
       ['name']               = (list) A comma-separated list of alias names to return
       ['ignore_unavailable'] = (boolean) Whether specified concrete indices should be ignored when unavailable
(missing or closed)
       ['allow_no_indices']   = (boolean) Whether to ignore if a wildcard indices expression resolves into no
concrete indices. (This includes `_all` string or when no indices have been specified)
       ['expand_wildcards']   = (enum) Whether to expand wildcard expression to concrete indices that are open,
closed or both. (open,closed,none,all) (default: [open,closed])
       ['local']              = (boolean) Return local information, do not retrieve the state from master node
(default: false)
       ['body']  = (array) Request body
*/

$params = [
    // ...
];

$client = ClientBuilder::create()->build();
$response = $client->indices()->existsAlias($params);

status()

/*
*/

$params = [
    // ...
];

$client = ClientBuilder::create()->build();
$response = $client->indices()->status($params);

getSettings()

/*
$params['index']              = (list) A comma-separated list of index names; use `_all` or empty string to
perform the operation on all indices
       ['name']               = (list) The name of the settings that should be included
       ['ignore_unavailable'] = (boolean) Whether specified concrete indices should be ignored when unavailable
(missing or closed)
       ['allow_no_indices']   = (boolean) Whether to ignore if a wildcard indices expression resolves into no
concrete indices. (This includes `_all` string or when no indices have been specified)
       ['expand_wildcards']   = (enum) Whether to expand wildcard expression to concrete indices that are open,
closed or both. (open,closed,none,all) (default: [open,closed])
       ['flat_settings']      = (boolean) Return settings in flat format (default: false)
       ['local']              = (boolean) Return local information, do not retrieve the state from master node
(default: false)
       ['human']              = (boolean) Whether to return version and creation date values in human-readable
format. (default: false)
       ['body']  = (array) Request body
*/

$params = [
    // ...
];

$client = ClientBuilder::create()->build();
$response = $client->indices()->getSettings($params);

close()

/*
$params['index']              = (list) A comma separated list of indices to close (Required)
       ['timeout']            = (time) Explicit operation timeout
       ['master_timeout']     = (time) Specify timeout for connection to master
       ['ignore_unavailable'] = (boolean) Whether specified concrete indices should be ignored when unavailable
(missing or closed)
       ['allow_no_indices']   = (boolean) Whether to ignore if a wildcard indices expression resolves into no
concrete indices. (This includes `_all` string or when no indices have been specified)
       ['expand_wildcards']   = (enum) Whether to expand wildcard expression to concrete indices that are open,
closed or both. (open,closed,none,all) (default: open)
       ['body']  = (array) Request body
*/

$params = [
    // ...
];

$client = ClientBuilder::create()->build();
$response = $client->indices()->close($params);

seal()

/*
*/

$params = [
    // ...
];

$client = ClientBuilder::create()->build();
$response = $client->indices()->seal($params);

upgrade()

/*
$params['index']                 = (list) A comma-separated list of index names; use `_all` or empty string to
perform the operation on all indices
       ['allow_no_indices']      = (boolean) Whether to ignore if a wildcard indices expression resolves into no
concrete indices. (This includes `_all` string or when no indices have been specified)
       ['expand_wildcards']      = (enum) Whether to expand wildcard expression to concrete indices that are
open, closed or both. (open,closed,none,all) (default: open)
       ['ignore_unavailable']    = (boolean) Whether specified concrete indices should be ignored when
unavailable (missing or closed)
       ['wait_for_completion']   = (boolean) Specify whether the request should block until the all segments are
upgraded (default: false)
       ['only_ancient_segments'] = (boolean) If true, only ancient (an older Lucene major release) segments will
be upgraded
       ['body']  = (array) Request body
*/

$params = [
    // ...
];

$client = ClientBuilder::create()->build();
$response = $client->indices()->upgrade($params);

getUpgrade()

/*
$params['index']                 = (list) A comma-separated list of index names; use `_all` or empty string to
perform the operation on all indices
       ['ignore_unavailable']    = (boolean) Whether specified concrete indices should be ignored when
unavailable (missing or closed)
       ['wait_for_completion']   = (boolean) Specify whether the request should block until the all segments are
upgraded (default: false)
       ['only_ancient_segments'] = (boolean) If true, only ancient (an older Lucene major release) segments will
be upgraded
       ['allow_no_indices']      = (boolean) Whether to ignore if a wildcard indices expression resolves into no
concrete indices. (This includes `_all` string or when no indices have been specified)
       ['expand_wildcards']      = (enum) Whether to expand wildcard expression to concrete indices that are
open, closed or both. (open,closed,none,all) (default: open)
       ['human']                 = (boolean) Whether to return time and byte values in human-readable format.
       ['body']  = (array) Request body
*/

$params = [
    // ...
];

$client = ClientBuilder::create()->build();
$response = $client->indices()->getUpgrade($params);

shardStores()

/*
$params['index']               = (list) A comma-separated list of index names; use `_all` or empty string to
perform the operation on all indices
       ['status']              = (list) A comma-separated list of statuses used to filter on shards to get store
information for (green,yellow,red,all)
       ['ignore_unavailable']  = (boolean) Whether specified concrete indices should be ignored when unavailable
(missing or closed)
       ['allow_no_indices']    = (boolean) Whether to ignore if a wildcard indices expression resolves into no
concrete indices. (This includes `_all` string or when no indices have been specified)
       ['expand_wildcards']    = (enum) Whether to expand wildcard expression to concrete indices that are open,
closed or both. (open,closed,none,all) (default: open)
       ['operation_threading'] = TODO: ?
       ['body']  = (array) Request body
*/

$params = [
    // ...
];

$client = ClientBuilder::create()->build();
$response = $client->indices()->shardStores($params);
« Elasticsearch\Namespaces\ClusterNamespace Elasticsearch\Namespaces\NodesNamespace »