Reference - Endpoints

This is a complete list of namespaces and their associated endpoints.

This is auto-generated documentation

• Elasticsearch\Client
• Elasticsearch\ClientBuilder
• Elasticsearch\Namespaces\CatNamespace
• Elasticsearch\Namespaces\ClusterNamespace
• Elasticsearch\Namespaces\IndicesNamespace
• Elasticsearch\Namespaces\IngestNamespace
• Elasticsearch\Namespaces\NodesNamespace
• Elasticsearch\Namespaces\RemoteNamespace
• Elasticsearch\Namespaces\SnapshotNamespace
• Elasticsearch\Namespaces\TasksNamespace

Elasticsearch\Client

Class Client

Methods

The class defines the following methods:

• info()
• ping()
• get()
• getSource()
• delete()
• deleteByQuery()
• count()
• countPercolate()
• percolate()
• mpercolate()
• termvectors()
• mtermvectors()
• exists()
• mget()
• msearch()
• msearchTemplate()
• create()
• bulk()
• index()
• reindex()
• suggest()
• explain()
• search()
• searchShards()
• searchTemplate()
• scroll()
• clearScroll()
• update()
• updateByQuery()
• getScript()
• deleteScript()
• putScript()
• getTemplate()
• deleteTemplate()
• fieldStats()
• fieldCaps()
• renderSearchTemplate()
• indices()
• cluster()
• nodes()
• snapshot()
• cat()
• ingest()
• tasks()
• remote()
• __call()
• extractArgument()

info()

/*
*/
$params = [
    // ...
];
$client = ClientBuilder::create()->build();
$response = $client->info($params);

ping()

/*
*/
$params = [
    // ...
];
$client = ClientBuilder::create()->build();
$response = $client->ping($params);

get()

/*
$params['id']              = (string) The document ID (Required)
       ['index']           = (string) The name of the index (Required)
       ['type']            = (string) The type of the document (use `_all` to fetch the first document matching the ID across all types) (Required)
       ['ignore_missing']  = ??
       ['fields']          = (list) A comma-separated list of fields to return in the response
       ['parent']          = (string) The ID of the parent document
       ['preference']      = (string) Specify the node or shard the operation should be performed on (default: random)
       ['realtime']        = (boolean) Specify whether to perform the operation in realtime or search mode
       ['refresh']         = (boolean) Refresh the shard containing the document before performing the operation
       ['routing']         = (string) Specific routing value
       ['_source']         = (list) True or false to return the _source field or not, or a list of fields to return
       ['_source_exclude'] = (list) A list of fields to exclude from the returned _source field
       ['_source_include'] = (list) A list of fields to extract and return from the _source field
       ['body']  = (array) Request body
*/
$params = [
    // ...
];
$client = ClientBuilder::create()->build();
$response = $client->get($params);

getSource()

/*
$params['id']             = (string) The document ID (Required)
       ['index']          = (string) The name of the index (Required)
       ['type']           = (string) The type of the document (use `_all` to fetch the first document matching the ID across all types) (Required)
       ['ignore_missing'] = ??
       ['parent']         = (string) The ID of the parent document
       ['preference']     = (string) Specify the node or shard the operation should be performed on (default: random)
       ['realtime']       = (boolean) Specify whether to perform the operation in realtime or search mode
       ['refresh']        = (boolean) Refresh the shard containing the document before performing the operation
       ['routing']        = (string) Specific routing value
       ['body']  = (array) Request body
*/
$params = [
    // ...
];
$client = ClientBuilder::create()->build();
$response = $client->getSource($params);

delete()

/*
$params['id']           = (string) The document ID (Required)
       ['index']        = (string) The name of the index (Required)
       ['type']         = (string) The type of the document (Required)
       ['consistency']  = (enum) Specific write consistency setting for the operation
       ['parent']       = (string) ID of parent document
       ['refresh']      = (boolean) Refresh the index after performing the operation
       ['replication']  = (enum) Specific replication type
       ['routing']      = (string) Specific routing value
       ['timeout']      = (time) Explicit operation timeout
       ['version_type'] = (enum) Specific version type
       ['body']  = (array) Request body
*/
$params = [
    // ...
];
$client = ClientBuilder::create()->build();
$response = $client->delete($params);

deleteByQuery()

/*
$params['_source'] = (list) True or false to return the _source field or not, or a list of fields to return
       ['_source_exclude'] = (array) A list of fields to exclude from the returned _source field
       ['_source_include'] = (array) A list of fields to extract and return from the _source field
       ['allow_no_indices'] = (bool) Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)
       ['analyze_wildcard'] = (bool) Specify whether wildcard and prefix queries should be analyzed (default: false)
       ['analyzer'] = (string) The analyzer to use for the query string
       ['conflicts'] = (enum) What to do when the delete-by-query hits version conflicts?
       ['default_operator'] = (enum) The default operator for query string query (AND or OR)
       ['df'] = (string) The field to use as default where no field prefix is given in the query string
       ['expand_wildcards'] = (enum) Whether to expand wildcard expression to concrete indices that are open, closed or both.
       ['body']  = (array) Request body
*/
$params = [
    // ...
];
$client = ClientBuilder::create()->build();
$response = $client->deleteByQuery($params);

count()

/*
$params['index']              = (list) A comma-separated list of indices to restrict the results
       ['type']               = (list) A comma-separated list of types to restrict the results
       ['min_score']          = (number) Include only documents with a specific `_score` value in the result
       ['preference']         = (string) Specify the node or shard the operation should be performed on (default: random)
       ['routing']            = (string) Specific routing value
       ['source']             = (string) The URL-encoded query definition (instead of using the request body)
       ['body']               = (array) A query to restrict the results (optional)
       ['ignore_unavailable'] = (bool) Whether specified concrete indices should be ignored when unavailable (missing or closed)
       ['allow_no_indices']   = (bool) 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.
       ['body']  = (array) Request body
*/
$params = [
    // ...
];
$client = ClientBuilder::create()->build();
$response = $client->count($params);

countPercolate()

/*
$params['index']              = (list) A comma-separated list of indices to restrict the results
       ['type']               = (list) A comma-separated list of types to restrict the results
       ['id']                 = (string) ID of document
       ['ignore_unavailable'] = (boolean) Whether specified concrete indices should be ignored when unavailable (missing or closed)
       ['preference']         = (string) Specify the node or shard the operation should be performed on (default: random)
       ['routing']            = (string) Specific routing value
       ['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)
       ['body']               = (array) A query to restrict the results (optional)
       ['ignore_unavailable'] = (bool) Whether specified concrete indices should be ignored when unavailable (missing or closed)
       ['percolate_index']    = (string) The index to count percolate the document into. Defaults to index.
       ['body']  = (array) Request body
*/
$params = [
    // ...
];
$client = ClientBuilder::create()->build();
$response = $client->countPercolate($params);

percolate()

/*
$params['index']        = (string) The name of the index with a registered percolator query (Required)
       ['type']         = (string) The document type (Required)
       ['prefer_local'] = (boolean) With `true`, specify that a local shard should be used if available, with `false`, use a random shard (default: true)
       ['body']         = (array) The document (`doc`) to percolate against registered queries; optionally also a `query` to limit the percolation to specific registered queries
       ['body']  = (array) Request body
*/
$params = [
    // ...
];
$client = ClientBuilder::create()->build();
$response = $client->percolate($params);

mpercolate()

/*
$params['index']              = (string) Default index for items which don't provide one
       ['type']               = (string) Default document type for items which don't provide one
       ['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.
       ['body']  = (array) Request body
*/
$params = [
    // ...
];
$client = ClientBuilder::create()->build();
$response = $client->mpercolate($params);

termvectors()

/*
$params['index']            = (string) Default index for items which don't provide one
       ['type']             = (string) Default document type for items which don't provide one
       ['term_statistics']  = (boolean) Specifies if total term frequency and document frequency should be returned. Applies to all returned documents unless otherwise specified in body \"params\" or \"docs\"."
       ['field_statistics'] = (boolean) Specifies if document count, sum of document frequencies and sum of total term frequencies should be returned. Applies to all returned documents unless otherwise specified in body \"params\" or \"docs\"."
       ['fields']           = (list) A comma-separated list of fields to return. Applies to all returned documents unless otherwise specified in body \"params\" or \"docs\"."
       ['offsets']          = (boolean) Specifies if term offsets should be returned. Applies to all returned documents unless otherwise specified in body \"params\" or \"docs\"."
       ['positions']        = (boolean) Specifies if term positions should be returned. Applies to all returned documents unless otherwise specified in body \"params\" or \"docs\"."
       ['payloads']         = (boolean) Specifies if term payloads should be returned. Applies to all returned documents unless otherwise specified in body \"params\" or \"docs\".
       ['body']  = (array) Request body
*/
$params = [
    // ...
];
$client = ClientBuilder::create()->build();
$response = $client->termvectors($params);

mtermvectors()

/*
$params['index']            = (string) Default index for items which don't provide one
       ['type']             = (string) Default document type for items which don't provide one
       ['ids']              = (list) A comma-separated list of documents ids. You must define ids as parameter or set \"ids\" or \"docs\" in the request body
       ['term_statistics']  = (boolean) Specifies if total term frequency and document frequency should be returned. Applies to all returned documents unless otherwise specified in body \"params\" or \"docs\"."
       ['field_statistics'] = (boolean) Specifies if document count, sum of document frequencies and sum of total term frequencies should be returned. Applies to all returned documents unless otherwise specified in body \"params\" or \"docs\"."
       ['fields']           = (list) A comma-separated list of fields to return. Applies to all returned documents unless otherwise specified in body \"params\" or \"docs\"."
       ['offsets']          = (boolean) Specifies if term offsets should be returned. Applies to all returned documents unless otherwise specified in body \"params\" or \"docs\"."
       ['positions']        = (boolean) Specifies if term positions should be returned. Applies to all returned documents unless otherwise specified in body \"params\" or \"docs\"."
       ['payloads']         = (boolean) Specifies if term payloads should be returned. Applies to all returned documents unless otherwise specified in body \"params\" or \"docs\".
       ['body']  = (array) Request body
*/
$params = [
    // ...
];
$client = ClientBuilder::create()->build();
$response = $client->mtermvectors($params);

exists()

/*
$params['id']         = (string) The document ID (Required)
       ['index']      = (string) The name of the index (Required)
       ['type']       = (string) The type of the document (use `_all` to fetch the first document matching the ID across all types) (Required)
       ['parent']     = (string) The ID of the parent document
       ['preference'] = (string) Specify the node or shard the operation should be performed on (default: random)
       ['realtime']   = (boolean) Specify whether to perform the operation in realtime or search mode
       ['refresh']    = (boolean) Refresh the shard containing the document before performing the operation
       ['routing']    = (string) Specific routing value
       ['body']  = (array) Request body
*/
$params = [
    // ...
];
$client = ClientBuilder::create()->build();
$response = $client->exists($params);

mget()

/*
$params['index']           = (string) The name of the index
       ['type']            = (string) The type of the document
       ['fields']          = (list) A comma-separated list of fields to return in the response
       ['parent']          = (string) The ID of the parent document
       ['preference']      = (string) Specify the node or shard the operation should be performed on (default: random)
       ['realtime']        = (boolean) Specify whether to perform the operation in realtime or search mode
       ['refresh']         = (boolean) Refresh the shard containing the document before performing the operation
       ['routing']         = (string) Specific routing value
       ['body']            = (array) Document identifiers; can be either `docs` (containing full document information) or `ids` (when index and type is provided in the URL.
       ['body']  = (array) Request body
*/
$params = [
    // ...
];
$client = ClientBuilder::create()->build();
$response = $client->mget($params);

msearch()

/*
$params['index']       = (list) A comma-separated list of index names to use as default
       ['type']        = (list) A comma-separated list of document types to use as default
       ['search_type'] = (enum) Search operation type
       ['body']        = (array|string) The request definitions (metadata-search request definition pairs), separated by newlines
       ['body']  = (array) Request body
*/
$params = [
    // ...
];
$client = ClientBuilder::create()->build();
$response = $client->msearch($params);

msearchTemplate()

/*
$params['index']       = (list) A comma-separated list of index names to use as default
       ['type']        = (list) A comma-separated list of document types to use as default
       ['search_type'] = (enum) Search operation type
       ['body']        = (array|string) The request definitions (metadata-search request definition pairs), separated by newlines
       ['max_concurrent_searches'] = (number) Controls the maximum number of concurrent searches the multi search api will execute
       ['body']  = (array) Request body
*/
$params = [
    // ...
];
$client = ClientBuilder::create()->build();
$response = $client->msearchTemplate($params);

create()

/*
$params['index']        = (string) The name of the index (Required)
       ['type']         = (string) The type of the document (Required)
       ['id']           = (string) Specific document ID (when the POST method is used)
       ['consistency']  = (enum) Explicit write consistency setting for the operation
       ['parent']       = (string) ID of the parent document
       ['refresh']      = (boolean) Refresh the index after performing the operation
       ['replication']  = (enum) Specific replication type
       ['routing']      = (string) Specific routing value
       ['timeout']      = (time) Explicit operation timeout
       ['timestamp']    = (time) Explicit timestamp for the document
       ['ttl']          = (duration) Expiration time for the document
       ['version']      = (number) Explicit version number for concurrency control
       ['version_type'] = (enum) Specific version type
       ['body']         = (array) The document
       ['body']  = (array) Request body
*/
$params = [
    // ...
];
$client = ClientBuilder::create()->build();
$response = $client->create($params);

bulk()

/*
$params['index']       = (string) Default index for items which don't provide one
       ['type']        = (string) Default document type for items which don't provide one
       ['consistency'] = (enum) Explicit write consistency setting for the operation
       ['refresh']     = (boolean) Refresh the index after performing the operation
       ['replication'] = (enum) Explicitly set the replication type
       ['fields']      = (list) Default comma-separated list of fields to return in the response for updates
       ['body']        = (array) The document
       ['body']  = (array) Request body
*/
$params = [
    // ...
];
$client = ClientBuilder::create()->build();
$response = $client->bulk($params);

index()

/*
$params['index']        = (string) The name of the index (Required)
       ['type']         = (string) The type of the document (Required)
       ['id']           = (string) Specific document ID (when the POST method is used)
       ['consistency']  = (enum) Explicit write consistency setting for the operation
       ['op_type']      = (enum) Explicit operation type
       ['parent']       = (string) ID of the parent document
       ['refresh']      = (boolean) Refresh the index after performing the operation
       ['replication']  = (enum) Specific replication type
       ['routing']      = (string) Specific routing value
       ['timeout']      = (time) Explicit operation timeout
       ['timestamp']    = (time) Explicit timestamp for the document
       ['ttl']          = (duration) Expiration time for the document
       ['version']      = (number) Explicit version number for concurrency control
       ['version_type'] = (enum) Specific version type
       ['body']         = (array) The document
       ['body']  = (array) Request body
*/
$params = [
    // ...
];
$client = ClientBuilder::create()->build();
$response = $client->index($params);

reindex()

/*
$params['refresh']             = (boolean) Should the effected indexes be refreshed?
       ['timeout']             = (time) Time each individual bulk request should wait for shards that are unavailable
       ['consistency']         = (enum) Explicit write consistency setting for the operation
       ['wait_for_completion'] = (boolean) Should the request should block until the reindex is complete
       ['requests_per_second'] = (float) The throttle for this request in sub-requests per second. 0 means set no throttle
       ['body']                = (array) The search definition using the Query DSL and the prototype for the index request (Required)
       ['body']  = (array) Request body
*/
$params = [
    // ...
];
$client = ClientBuilder::create()->build();
$response = $client->reindex($params);

suggest()

/*
$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
       ['ignore_indices'] = (enum) When performed on multiple indices, allows to ignore `missing` ones
       ['preference']     = (string) Specify the node or shard the operation should be performed on (default: random)
       ['routing']        = (string) Specific routing value
       ['source']         = (string) The URL-encoded request definition (instead of using request body)
       ['body']           = (array) The request definition
       ['body']  = (array) Request body
*/
$params = [
    // ...
];
$client = ClientBuilder::create()->build();
$response = $client->suggest($params);

explain()

/*
$params['id']                       = (string) The document ID (Required)
       ['index']                    = (string) The name of the index (Required)
       ['type']                     = (string) The type of the document (Required)
       ['analyze_wildcard']         = (boolean) Specify whether wildcards and prefix queries in the query string query should be analyzed (default: false)
       ['analyzer']                 = (string) The analyzer for the query string query
       ['default_operator']         = (enum) The default operator for query string query (AND or OR)
       ['df']                       = (string) The default field for query string query (default: _all)
       ['fields']                   = (list) A comma-separated list of fields to return in the response
       ['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
       ['parent']                   = (string) The ID of the parent document
       ['preference']               = (string) Specify the node or shard the operation should be performed on (default: random)
       ['q']                        = (string) Query in the Lucene query string syntax
       ['routing']                  = (string) Specific routing value
       ['source']                   = (string) The URL-encoded query definition (instead of using the request body)
       ['_source']                  = (list) True or false to return the _source field or not, or a list of fields to return
       ['_source_exclude']          = (list) A list of fields to exclude from the returned _source field
       ['_source_include']          = (list) A list of fields to extract and return from the _source field
       ['body']                     = (string) The URL-encoded query definition (instead of using the request body)
       ['body']  = (array) Request body
*/
$params = [
    // ...
];
$client = ClientBuilder::create()->build();
$response = $client->explain($params);

search()

/*
$params['index']                    = (list) A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices
       ['type']                     = (list) A comma-separated list of document types to search; leave empty to perform the operation on all types
       ['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)
       ['df']                       = (string) The field to use as default where no field prefix is given in the query string
       ['explain']                  = (boolean) Specify whether to return detailed information about score computation as part of a hit
       ['fields']                   = (list) A comma-separated list of fields to return as part of a hit
       ['from']                     = (number) Starting offset (default: 0)
       ['ignore_indices']           = (enum) When performed on multiple indices, allows to ignore `missing` ones
       ['indices_boost']            = (list) Comma-separated list of index boosts
       ['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
       ['preference']               = (string) Specify the node or shard the operation should be performed on (default: random)
       ['q']                        = (string) Query in the Lucene query string syntax
       ['query_cache']              = (boolean) Enable query cache for this request
       ['request_cache']            = (boolean) Enable request cache for this request
       ['routing']                  = (list) A comma-separated list of specific routing values
       ['scroll']                   = (duration) Specify how long a consistent view of the index should be maintained for scrolled search
       ['search_type']              = (enum) Search operation type
       ['size']                     = (number) Number of hits to return (default: 10)
       ['sort']                     = (list) A comma-separated list of <field>:<direction> pairs
       ['source']                   = (string) The URL-encoded request definition using the Query DSL (instead of using request body)
       ['_source']                  = (list) True or false to return the _source field or not, or a list of fields to return
       ['_source_exclude']          = (list) A list of fields to exclude from the returned _source field
       ['_source_include']          = (list) A list of fields to extract and return from the _source field
       ['stats']                    = (list) Specific 'tag' of the request for logging and statistical purposes
       ['suggest_field']            = (string) Specify which field to use for suggestions
       ['suggest_mode']             = (enum) Specify suggest mode
       ['suggest_size']             = (number) How many suggestions to return in response
       ['suggest_text']             = (text) The source text for which the suggestions should be returned
       ['timeout']                  = (time) Explicit operation timeout
       ['terminate_after']          = (number) The maximum number of documents to collect for each shard, upon reaching which the query execution will terminate early.
       ['body']  = (array) Request body
*/
$params = [
    // ...
];
$client = ClientBuilder::create()->build();
$response = $client->search($params);

searchShards()

/*
$params['index']              = (list) A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices
       ['type']               = (list) A comma-separated list of document types to search; leave empty to perform the operation on all types
       ['preference']         = (string) Specify the node or shard the operation should be performed on (default: random)
       ['routing']            = (string) Specific routing value
       ['local']              = (bool) Return local information, do not retrieve the state from master node (default: false)
       ['ignore_unavailable'] = (bool) Whether specified concrete indices should be ignored when unavailable (missing or closed)
       ['allow_no_indices']   = (bool) 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.
       ['body']  = (array) Request body
*/
$params = [
    // ...
];
$client = ClientBuilder::create()->build();
$response = $client->searchShards($params);

searchTemplate()

/*
$params['index']                    = (list) A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices
       ['type']                     = (list) A comma-separated list of document types to search; leave empty to perform the operation on all types
       ['body']  = (array) Request body
*/
$params = [
    // ...
];
$client = ClientBuilder::create()->build();
$response = $client->searchTemplate($params);

scroll()

/*
$params['scroll_id'] = (string) The scroll ID for scrolled search
       ['scroll']    = (duration) Specify how long a consistent view of the index should be maintained for scrolled search
       ['body']      = (string) The scroll ID for scrolled search
       ['body']  = (array) Request body
*/
$params = [
    // ...
];
$client = ClientBuilder::create()->build();
$response = $client->scroll($params);

clearScroll()

/*
$params['scroll_id'] = (string) The scroll ID for scrolled search
       ['scroll']    = (duration) Specify how long a consistent view of the index should be maintained for scrolled search
       ['body']      = (string) The scroll ID for scrolled search
       ['body']  = (array) Request body
*/
$params = [
    // ...
];
$client = ClientBuilder::create()->build();
$response = $client->clearScroll($params);

update()

/*
$params['id']                = (string) Document ID (Required)
       ['index']             = (string) The name of the index (Required)
       ['type']              = (string) The type of the document (Required)
       ['consistency']       = (enum) Explicit write consistency setting for the operation
       ['fields']            = (list) A comma-separated list of fields to return in the response
       ['lang']              = (string) The script language (default: mvel)
       ['parent']            = (string) ID of the parent document
       ['refresh']           = (boolean) Refresh the index after performing the operation
       ['replication']       = (enum) Specific replication type
       ['retry_on_conflict'] = (number) Specify how many times should the operation be retried when a conflict occurs (default: 0)
       ['routing']           = (string) Specific routing value
       ['script']            = () The URL-encoded script definition (instead of using request body)
       ['timeout']           = (time) Explicit operation timeout
       ['timestamp']         = (time) Explicit timestamp for the document
       ['ttl']               = (duration) Expiration time for the document
       ['version_type']      = (number) Explicit version number for concurrency control
       ['body']              = (array) The request definition using either `script` or partial `doc`
       ['body']  = (array) Request body
*/
$params = [
    // ...
];
$client = ClientBuilder::create()->build();
$response = $client->update($params);

updateByQuery()

/*
$params['index']                    = (list) A comma-separated list of index names to search; use `_all` or
empty string to perform the operation on all indices (Required)
       ['type']                     = (list) A comma-separated list of document types to search; leave empty to
perform the operation on all types
       ['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
       ['explain']                  = (boolean) Specify whether to return detailed information about score
computation as part of a hit
       ['fields']                   = (list) A comma-separated list of fields to return as part of a hit
       ['fielddata_fields']         = (list) A comma-separated list of fields to return as the field data
representation of a field for each hit
       ['from']                     = (number) Starting offset (default: 0)
       ['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)
       ['conflicts']                = (enum) What to do when the reindex hits version conflicts? (abort,proceed)
(default: abort)
       ['expand_wildcards']         = (enum) Whether to expand wildcard expression to concrete indices that are
open, closed or both. (open,closed,none,all) (default: open)
       ['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
       ['preference']               = (string) Specify the node or shard the operation should be performed on
(default: random)
       ['q']                        = (string) Query in the Lucene query string syntax
       ['routing']                  = (list) A comma-separated list of specific routing values
       ['scroll']                   = (duration) Specify how long a consistent view of the index should be
maintained for scrolled search
       ['search_type']              = (enum) Search operation type (query_then_fetch,dfs_query_then_fetch)
       ['search_timeout']           = (time) Explicit timeout for each search request. Defaults to no timeout.
       ['body']  = (array) Request body
*/
$params = [
    // ...
];
$client = ClientBuilder::create()->build();
$response = $client->updateByQuery($params);

getScript()

/*
$params['id']   = (string) The script ID (Required)
       ['lang'] = (string) The script language (Required)
       ['body']  = (array) Request body
*/
$params = [
    // ...
];
$client = ClientBuilder::create()->build();
$response = $client->getScript($params);

deleteScript()

/*
$params['id']   = (string) The script ID (Required)
       ['lang'] = (string) The script language (Required)
       ['body']  = (array) Request body
*/
$params = [
    // ...
];
$client = ClientBuilder::create()->build();
$response = $client->deleteScript($params);

putScript()

/*
$params['id']   = (string) The script ID (Required)
       ['lang'] = (string) The script language (Required)
       ['body']  = (array) Request body
*/
$params = [
    // ...
];
$client = ClientBuilder::create()->build();
$response = $client->putScript($params);

getTemplate()

/*
$params['id']   = (string) The search template ID (Required)
       ['body']  = (array) Request body
*/
$params = [
    // ...
];
$client = ClientBuilder::create()->build();
$response = $client->getTemplate($params);

deleteTemplate()

/*
$params['id']   = (string) The search template ID (Required)
       ['body']  = (array) Request body
*/
$params = [
    // ...
];
$client = ClientBuilder::create()->build();
$response = $client->deleteTemplate($params);

fieldStats()

/*
$params['index']              = (list) A comma-separated list of indices to restrict the results
       ['fields']             = (list) A comma-separated list of fields for to get field statistics for (min value, max value, and more)
       ['level']              = (enum) Defines if field stats should be returned on a per index level or on a cluster wide level
       ['ignore_unavailable'] = (bool) Whether specified concrete indices should be ignored when unavailable (missing or closed)
       ['allow_no_indices']   = (bool) 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.
       ['body']  = (array) Request body
*/
$params = [
    // ...
];
$client = ClientBuilder::create()->build();
$response = $client->fieldStats($params);

fieldCaps()

/*
$params['index']              = (list) A comma-separated list of indices to restrict the results
       ['ignore_unavailable'] = (bool) Whether specified concrete indices should be ignored when unavailable (missing or closed)
       ['allow_no_indices']   = (bool) 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.
       ['body']  = (array) Request body
*/
$params = [
    // ...
];
$client = ClientBuilder::create()->build();
$response = $client->fieldCaps($params);

renderSearchTemplate()

/*
$params['id']                 = (string) ID of the template to render
       ['body']  = (array) Request body
*/
$params = [
    // ...
];
$client = ClientBuilder::create()->build();
$response = $client->renderSearchTemplate($params);

indices()

/*
Operate on the Indices Namespace of commands
       ['body']  = (array) Request body
*/
$params = [
    // ...
];
$client = ClientBuilder::create()->build();
$response = $client->indices();

cluster()

/*
Operate on the Cluster namespace of commands
       ['body']  = (array) Request body
*/
$params = [
    // ...
];
$client = ClientBuilder::create()->build();
$response = $client->cluster();

nodes()

/*
Operate on the Nodes namespace of commands
       ['body']  = (array) Request body
*/
$params = [
    // ...
];
$client = ClientBuilder::create()->build();
$response = $client->nodes();

snapshot()

/*
Operate on the Snapshot namespace of commands
       ['body']  = (array) Request body
*/
$params = [
    // ...
];
$client = ClientBuilder::create()->build();
$response = $client->snapshot();

cat()

/*
Operate on the Cat namespace of commands
       ['body']  = (array) Request body
*/
$params = [
    // ...
];
$client = ClientBuilder::create()->build();
$response = $client->cat();

ingest()

/*
Operate on the Ingest namespace of commands
       ['body']  = (array) Request body
*/
$params = [
    // ...
];
$client = ClientBuilder::create()->build();
$response = $client->ingest();

tasks()

/*
Operate on the Tasks namespace of commands
       ['body']  = (array) Request body
*/
$params = [
    // ...
];
$client = ClientBuilder::create()->build();
$response = $client->tasks();

remote()

/*
Operate on the Remote namespace of commands
       ['body']  = (array) Request body
*/
$params = [
    // ...
];
$client = ClientBuilder::create()->build();
$response = $client->remote();

__call()

/*
Catchall for registered namespaces
       ['body']  = (array) Request body
*/
$params = [
    // ...
];
$client = ClientBuilder::create()->build();
$response = $client->__call($name,$arguments);

extractArgument()

/*
*/
$params = [
    // ...
];
$client = ClientBuilder::create()->build();
$response = $client->extractArgument($params,$arg);

Elasticsearch\ClientBuilder

Class ClientBuilder

Methods

The class defines the following methods:

• create()
• getTransport()
• getEndpoint()
• getRegisteredNamespacesBuilders()
• fromConfig()
• defaultHandler()
• multiHandler()
• singleHandler()
• setConnectionFactory()
• setConnectionPool()
• setEndpoint()
• registerNamespace()
• setTransport()
• setHandler()
• setLogger()
• setTracer()
• setSerializer()
• setHosts()
• setConnectionParams()
• setRetries()
• setSelector()
• setSniffOnStart()
• setSSLCert()
• setSSLKey()
• setSSLVerification()
• build()
• instantiate()

create()

/*
*/

getTransport()

/*
    Can supply first parm to Client::__construct() when invoking manually or with dependency injection
    ['body']  = (array) Request body
*/

getEndpoint()

/*
    Can supply second parm to Client::__construct() when invoking manually or with dependency injection
    ['body']  = (array) Request body
*/

getRegisteredNamespacesBuilders()

/*
    Can supply third parm to Client::__construct() when invoking manually or with dependency injection
    ['body']  = (array) Request body
*/

fromConfig()

/*
    Build a new client from the provided config.  Hash keys
should correspond to the method name e.g. ['connectionPool']
corresponds to setConnectionPool().
    ['body']  = (array) Request body
*/

defaultHandler()

/*
*/

multiHandler()

/*
*/

singleHandler()

/*
*/

setConnectionFactory()

/*
*/

setConnectionPool()

/*
*/

setEndpoint()

/*
*/

registerNamespace()

/*
*/

setTransport()

/*
*/

setHandler()

/*
*/

setLogger()

/*
*/

setTracer()

/*
*/

setSerializer()

/*
*/

setHosts()

/*
*/

setConnectionParams()

/*
*/

setRetries()

/*
*/

setSelector()

/*
*/

setSniffOnStart()

/*
*/

setSSLCert()

/*
*/

setSSLKey()

/*
*/

setSSLVerification()

/*
*/

build()

/*
*/

instantiate()

/*
*/

Elasticsearch\Namespaces\CatNamespace

Class CatNamespace

Methods

The class defines the following methods:

• aliases()
• allocation()
• count()
• health()
• help()
• indices()
• master()
• nodes()
• nodeAttrs()
• pendingTasks()
• recovery()
• repositories()
• shards()
• snapshots()
• threadPool()
• fielddata()
• plugins()
• segments()
• tasks()
• templates()

aliases()

/*
$params['local']          = (bool) Return local information, do not retrieve the state from master node (default: false)
       ['master_timeout'] = (time) Explicit operation timeout for connection to master node
       ['h']              = (list) Comma-separated list of column names to display
       ['help']           = (bool) Return help information
       ['v']              = (bool) Verbose mode. Display column headers
       ['body']  = (array) Request body
*/
$params = [
    // ...
];
$client = ClientBuilder::create()->build();
$response = $client->cat()->aliases($params);

allocation()

/*
$params['local']          = (bool) Return local information, do not retrieve the state from master node (default: false)
       ['master_timeout'] = (time) Explicit operation timeout for connection to master node
       ['h']              = (list) Comma-separated list of column names to display
       ['help']           = (bool) Return help information
       ['v']              = (bool) Verbose mode. Display column headers
       ['bytes']          = (enum) The unit in which to display byte values
       ['body']  = (array) Request body
*/
$params = [
    // ...
];
$client = ClientBuilder::create()->build();
$response = $client->cat()->allocation($params);

count()

/*
$params['local']          = (bool) Return local information, do not retrieve the state from master node (default: false)
       ['master_timeout'] = (time) Explicit operation timeout for connection to master node
       ['h']              = (list) Comma-separated list of column names to display
       ['help']           = (bool) Return help information
       ['v']              = (bool) Verbose mode. Display column headers
       ['body']  = (array) Request body
*/
$params = [
    // ...
];
$client = ClientBuilder::create()->build();
$response = $client->cat()->count($params);

health()

/*
$params['local']          = (bool) Return local information, do not retrieve the state from master node (default: false)
       ['master_timeout'] = (time) Explicit operation timeout for connection to master node
       ['h']              = (list) Comma-separated list of column names to display
       ['help']           = (bool) Return help information
       ['v']              = (bool) Verbose mode. Display column headers
       ['ts']             = (bool) Set to false to disable timestamping
       ['body']  = (array) Request body
*/
$params = [
    // ...
];
$client = ClientBuilder::create()->build();
$response = $client->cat()->health($params);

help()

/*
$params['help'] = (bool) Return help information
       ['body']  = (array) Request body
*/
$params = [
    // ...
];
$client = ClientBuilder::create()->build();
$response = $client->cat()->help($params);

indices()

/*
$params['local']          = (bool) Return local information, do not retrieve the state from master node (default: false)
       ['master_timeout'] = (time) Explicit operation timeout for connection to master node
       ['h']              = (list) Comma-separated list of column names to display
       ['help']           = (bool) Return help information
       ['v']              = (bool) Verbose mode. Display column headers
       ['bytes']          = (enum) The unit in which to display byte values
       ['pri']            = (bool) Set to true to return stats only for primary shards
       ['body']  = (array) Request body
*/
$params = [
    // ...
];
$client = ClientBuilder::create()->build();
$response = $client->cat()->indices($params);

master()

/*
$params['local']          = (bool) Return local information, do not retrieve the state from master node (default: false)
       ['master_timeout'] = (time) Explicit operation timeout for connection to master node
       ['h']              = (list) Comma-separated list of column names to display
       ['help']           = (bool) Return help information
       ['v']              = (bool) Verbose mode. Display column headers
       ['body']  = (array) Request body
*/
$params = [
    // ...
];
$client = ClientBuilder::create()->build();
$response = $client->cat()->master($params);

nodes()

/*
$params['local']          = (bool) Return local information, do not retrieve the state from master node (default: false)
       ['master_timeout'] = (time) Explicit operation timeout for connection to master node
       ['h']              = (list) Comma-separated list of column names to display
       ['help']           = (bool) Return help information
       ['v']              = (bool) Verbose mode. Display column headers
       ['body']  = (array) Request body
*/
$params = [
    // ...
];
$client = ClientBuilder::create()->build();
$response = $client->cat()->nodes($params);

nodeAttrs()

/*
$params['local']          = (bool) Return local information, do not retrieve the state from master node (default: false)
       ['master_timeout'] = (time) Explicit operation timeout for connection to master node
       ['h']              = (list) Comma-separated list of column names to display
       ['help']           = (bool) Return help information
       ['v']              = (bool) Verbose mode. Display column headers
       ['body']  = (array) Request body
*/
$params = [
    // ...
];
$client = ClientBuilder::create()->build();
$response = $client->cat()->nodeAttrs($params);

pendingTasks()

/*
$params['local']          = (bool) Return local information, do not retrieve the state from master node (default: false)
       ['master_timeout'] = (time) Explicit operation timeout for connection to master node
       ['h']              = (list) Comma-separated list of column names to display
       ['help']           = (bool) Return help information
       ['v']              = (bool) Verbose mode. Display column headers
       ['body']  = (array) Request body
*/
$params = [
    // ...
];
$client = ClientBuilder::create()->build();
$response = $client->cat()->pendingTasks($params);

recovery()

/*
$params['local']          = (bool) Return local information, do not retrieve the state from master node (default: false)
       ['master_timeout'] = (time) Explicit operation timeout for connection to master node
       ['h']              = (list) Comma-separated list of column names to display
       ['help']           = (bool) Return help information
       ['v']              = (bool) Verbose mode. Display column headers
       ['bytes']          = (enum) The unit in which to display byte values
       ['body']  = (array) Request body
*/
$params = [
    // ...
];
$client = ClientBuilder::create()->build();
$response = $client->cat()->recovery($params);

repositories()

/*
$params['local']          = (bool) Return local information, do not retrieve the state from master node (default: false)
       ['master_timeout'] = (time) Explicit operation timeout for connection to master node
       ['h']              = (list) Comma-separated list of column names to display
       ['help']           = (bool) Return help information
       ['v']              = (bool) Verbose mode. Display column headers
       ['body']  = (array) Request body
*/
$params = [
    // ...
];
$client = ClientBuilder::create()->build();
$response = $client->cat()->repositories($params);

shards()

/*
$params['local']          = (bool) Return local information, do not retrieve the state from master node (default: false)
       ['master_timeout'] = (time) Explicit operation timeout for connection to master node
       ['h']              = (list) Comma-separated list of column names to display
       ['help']           = (bool) Return help information
       ['v']              = (bool) Verbose mode. Display column headers
       ['bytes']          = (enum) The unit in which to display byte values
       ['body']  = (array) Request body
*/
$params = [
    // ...
];
$client = ClientBuilder::create()->build();
$response = $client->cat()->shards($params);

snapshots()

/*
$params['local']          = (bool) Return local information, do not retrieve the state from master node (default: false)
       ['master_timeout'] = (time) Explicit operation timeout for connection to master node
       ['h']              = (list) Comma-separated list of column names to display
       ['help']           = (bool) Return help information
       ['v']              = (bool) Verbose mode. Display column headers
       ['bytes']          = (enum) The unit in which to display byte values
       ['repository']     = (string) Name of repository from which to fetch the snapshot information
       ['body']  = (array) Request body
*/
$params = [
    // ...
];
$client = ClientBuilder::create()->build();
$response = $client->cat()->snapshots($params);

threadPool()

/*
$params['local']          = (bool) Return local information, do not retrieve the state from master node (default: false)
       ['master_timeout'] = (time) Explicit operation timeout for connection to master node
       ['h']              = (list) Comma-separated list of column names to display
       ['help']           = (bool) Return help information
       ['v']              = (bool) Verbose mode. Display column headers
       ['full_id']        = (bool) Enables displaying the complete node ids
       ['size']           = (enum) The multiplier in which to display values ([ "", "k", "m", "g", "t", "p" ])
       ['body']  = (array) Request body
*/
$params = [
    // ...
];
$client = ClientBuilder::create()->build();
$response = $client->cat()->threadPool($params);

fielddata()

/*
$params['local']          = (bool) Return local information, do not retrieve the state from master node (default: false)
       ['master_timeout'] = (time) Explicit operation timeout for connection to master node
       ['h']              = (list) Comma-separated list of column names to display
       ['help']           = (bool) Return help information
       ['v']              = (bool) Verbose mode. Display column headers
       ['bytes']          = (enum) The unit in which to display byte values
       ['fields']         = (list) A comma-separated list of fields to return the fielddata size
       ['body']  = (array) Request body
*/
$params = [
    // ...
];
$client = ClientBuilder::create()->build();
$response = $client->cat()->fielddata($params);

plugins()

/*
$params['local']          = (bool) Return local information, do not retrieve the state from master node (default: false)
       ['master_timeout'] = (time) Explicit operation timeout for connection to master node
       ['h']              = (list) Comma-separated list of column names to display
       ['help']           = (bool) Return help information
       ['v']              = (bool) Verbose mode. Display column headers
       ['body']  = (array) Request body
*/
$params = [
    // ...
];
$client = ClientBuilder::create()->build();
$response = $client->cat()->plugins($params);

segments()

/*
$params['h']              = (list) Comma-separated list of column names to display
       ['help']           = (bool) Return help information
       ['v']              = (bool) Verbose mode. Display column headers
       ['body']  = (array) Request body
*/
$params = [
    // ...
];
$client = ClientBuilder::create()->build();
$response = $client->cat()->segments($params);

tasks()

/*
$params['format']         = (string) a short version of the Accept header, e.g. json, yaml
       ['node_id']        = (list) A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes
       ['format']         = (string) a short version of the Accept header, e.g. json, yaml
       ['actions']        = (list) A comma-separated list of actions that should be returned. Leave empty to return all.
       ['body']  = (array) Request body
*/
$params = [
    // ...
];
$client = ClientBuilder::create()->build();
$response = $client->cat()->tasks($params);

templates()

/*
$params['local']          = (bool) Return local information, do not retrieve the state from master node (default: false)
       ['master_timeout'] = (time) Explicit operation timeout for connection to master node
       ['h']              = (list) Comma-separated list of column names to display
       ['help']           = (bool) Return help information
       ['v']              = (bool) Verbose mode. Display column headers
       ['bytes']          = (enum) The unit in which to display byte values
       ['body']  = (array) Request body
*/
$params = [
    // ...
];
$client = ClientBuilder::create()->build();
$response = $client->cat()->templates($params);

Elasticsearch\Namespaces\ClusterNamespace

Class ClusterNamespace

Methods

The class defines the following methods:

• health()
• reroute()
• state()
• stats()
• putSettings()
• getSettings()
• pendingTasks()
• allocationExplain()
• remoteInfo()

health()

/*
$params['index']                      = (string) Limit the information returned to a specific index
       ['level']                      = (enum) Specify the level of detail for returned information
       ['local']                      = (boolean) Return local information, do not retrieve the state from master node (default: false)
       ['master_timeout']             = (time) Explicit operation timeout for connection to master node
       ['timeout']                    = (time) Explicit operation timeout
       ['wait_for_active_shards']     = (number) Wait until the specified number of shards is active
       ['wait_for_nodes']             = (number) Wait until the specified number of nodes is available
       ['wait_for_relocating_shards'] = (number) Wait until the specified number of relocating shards is finished
       ['wait_for_status']            = (enum) Wait until cluster is in a specific state
       ['body']  = (array) Request body
*/
$params = [
    // ...
];
$client = ClientBuilder::create()->build();
$response = $client->cluster()->health($params);

reroute()

/*
$params['dry_run']         = (boolean) Simulate the operation only and return the resulting state
       ['filter_metadata'] = (boolean) Don't return cluster state metadata (default: false)
       ['body']            = (boolean) Don't return cluster state metadata (default: false)
       ['explain']         = (boolean) Return an explanation of why the commands can or cannot be executed
       ['body']  = (array) Request body
*/
$params = [
    // ...
];
$client = ClientBuilder::create()->build();
$response = $client->cluster()->reroute($params);

state()

/*
$params['filter_blocks']          = (boolean) Do not return information about blocks
       ['filter_index_templates'] = (boolean) Do not return information about index templates
       ['filter_indices']         = (list) Limit returned metadata information to specific indices
       ['filter_metadata']        = (boolean) Do not return information about indices metadata
       ['filter_nodes']           = (boolean) Do not return information about nodes
       ['filter_routing_table']   = (boolean) Do not return information about shard allocation (`routing_table` and `routing_nodes`)
       ['local']                  = (boolean) Return local information, do not retrieve the state from master node (default: false)
       ['master_timeout']         = (time) Specify timeout for connection to master
       ['body']  = (array) Request body
*/
$params = [
    // ...
];
$client = ClientBuilder::create()->build();
$response = $client->cluster()->state($params);

stats()

/*
$params['flat_settings']          = (boolean) Return settings in flat format (default: false)
       ['human'] = (boolean) Whether to return time and byte values in human-readable format.
       ['body']  = (array) Request body
*/
$params = [
    // ...
];
$client = ClientBuilder::create()->build();
$response = $client->cluster()->stats($params);

putSettings()

/*
$params['body'] = ()
       ['body']  = (array) Request body
*/
$params = [
    // ...
];
$client = ClientBuilder::create()->build();
$response = $client->cluster()->putSettings($params);

getSettings()

/*
*/
$params = [
    // ...
];
$client = ClientBuilder::create()->build();
$response = $client->cluster()->getSettings($params);

pendingTasks()

/*
$params['local']   = (bool) Return local information, do not retrieve the state from master node (default: false)
       ['master_timeout']  = (time) Specify timeout for connection to master
       ['body']  = (array) Request body
*/
$params = [
    // ...
];
$client = ClientBuilder::create()->build();
$response = $client->cluster()->pendingTasks($params);

allocationExplain()

/*
$params['include_yes_decisions'] = (bool) Return 'YES' decisions in explanation (default: false)
       ['body']  = (array) Request body
*/
$params = [
    // ...
];
$client = ClientBuilder::create()->build();
$response = $client->cluster()->allocationExplain($params);

remoteInfo()

/*
$params[]
       ['body']  = (array) Request body
*/
$params = [
    // ...
];
$client = ClientBuilder::create()->build();
$response = $client->cluster()->remoteInfo($params);

Elasticsearch\Namespaces\IndicesNamespace

Class IndicesNamespace

Methods

The class defines the following methods:

• exists()
• get()
• segments()
• deleteTemplate()
• delete()
• stats()
• putSettings()
• snapshotIndex()
• shrink()
• getMapping()
• getFieldMapping()
• flush()
• flushSynced()
• refresh()
• recovery()
• existsType()
• putAlias()
• putTemplate()
• validateQuery()
• getAlias()
• putMapping()
• deleteMapping()
• getTemplate()
• existsTemplate()
• create()
• forceMerge()
• deleteAlias()
• open()
• analyze()
• clearCache()
• updateAliases()
• getAliases()
• existsAlias()
• status()
• getSettings()
• close()
• seal()
• upgrade()
• getUpgrade()
• shardStores()
• rollover()

exists()

/*
$params['index'] = (list) A comma-separated list of indices to check (Required)
       ['body']  = (array) Request body
*/
$params = [
    // ...
];
$client = ClientBuilder::create()->build();
$response = $client->indices()->exists($params);

get()

/*
$params['index'] = (list) A comma-separated list of indices to check (Required)
       ['feature'] = (list) A comma-separated list of features to return
       ['ignore_unavailable'] = (bool) Whether specified concrete indices should be ignored when unavailable (missing or closed)
       ['allow_no_indices']   = (bool) 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.
       ['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
       ['operation_threading'] = () TODO: ?
       ['ignore_unavailable'] = (bool) Whether specified concrete indices should be ignored when unavailable (missing or closed)
       ['allow_no_indices']   = (bool) 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.
       ['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
       ['body']  = (array) Request body
*/
$params = [
    // ...
];
$client = ClientBuilder::create()->build();
$response = $client->indices()->deleteTemplate($params);

delete()

/*
$params['index']   = (list) A comma-separated list of indices to delete; use `_all` or empty string to delete all indices
       ['timeout'] = (time) Explicit operation timeout
       ['body']  = (array) Request body
*/
$params = [
    // ...
];
$client = ClientBuilder::create()->build();
$response = $client->indices()->delete($params);

stats()

/*
$params['fields']         = (boolean) A comma-separated list of fields for `fielddata` metric (supports wildcards)
       ['index']          = (list) A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
       ['indexing_types'] = (list) A comma-separated list of document types to include in the `indexing` statistics
       ['metric_family']  = (enum) Limit the information returned to a specific metric
       ['search_groups']  = (list) A comma-separated list of search groups to include in the `search` statistics
       ['all']            = (boolean) Return all available information
       ['clear']          = (boolean) Reset the default level of detail
       ['docs']           = (boolean) Return information about indexed and deleted documents
       ['fielddata']      = (boolean) Return information about field data
       ['filter_cache']   = (boolean) Return information about filter cache
       ['flush']          = (boolean) Return information about flush operations
       ['get']            = (boolean) Return information about get operations
       ['groups']         = (boolean) A comma-separated list of search groups for `search` statistics
       ['id_cache']       = (boolean) Return information about ID cache
       ['ignore_indices'] = (enum) When performed on multiple indices, allows to ignore `missing` ones
       ['indexing']       = (boolean) Return information about indexing operations
       ['merge']          = (boolean) Return information about merge operations
       ['refresh']        = (boolean) Return information about refresh operations
       ['search']         = (boolean) Return information about search operations; use the `groups` parameter to include information for specific search groups
       ['store']          = (boolean) Return information about the size of the index
       ['body']  = (array) Request body
*/
$params = [
    // ...
];
$client = ClientBuilder::create()->build();
$response = $client->indices()->stats($params);

putSettings()

/*
$params['index'] = (list) A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
       ['body']  = (list) A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
       ['body']  = (array) Request body
*/
$params = [
    // ...
];
$client = ClientBuilder::create()->build();
$response = $client->indices()->putSettings($params);

snapshotIndex()

/*
$params['index']              = (list) A comma-separated list of index names; use `_all` or empty string for all indices
       ['ignore_unavailable'] = (bool) Whether specified concrete indices should be ignored when unavailable (missing or closed)
       ['allow_no_indices']   = (bool) 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.
       ['body']  = (array) Request body
*/
$params = [
    // ...
];
$client = ClientBuilder::create()->build();
$response = $client->indices()->snapshotIndex($params);

shrink()

/*
$params['index']          = (string) The name of the source index to shrink
       ['target']         = (string) The name of the target index to shrink into
       ['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()->shrink($params);

getMapping()

/*
$params['index'] = (list) A comma-separated list of index names; use `_all` or empty string for all indices
       ['type']  = (list) A comma-separated list of document types
       ['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; use `_all` or empty string for all indices
       ['type']             = (list) A comma-separated list of document types
       ['field']            = (list) A comma-separated list of document fields
       ['include_defaults'] = (bool) specifies default mapping values should be returned
       ['body']  = (array) Request body
*/
$params = [
    // ...
];
$client = ClientBuilder::create()->build();
$response = $client->indices()->getFieldMapping($params);

flush()

/*
$params['index']              = (list) A comma-separated list of index names; use `_all` or empty string for all indices
       ['force']              = (boolean) TODO: ?
       ['full']               = (boolean) TODO: ?
       ['refresh']            = (boolean) Refresh the index after performing the operation
       ['ignore_unavailable'] = (bool) Whether specified concrete indices should be ignored when unavailable (missing or closed)
       ['allow_no_indices']   = (bool) 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.
       ['body']  = (array) Request body
*/
$params = [
    // ...
];
$client = ClientBuilder::create()->build();
$response = $client->indices()->flush($params);

flushSynced()

/*
$params['index']              = (list) A comma-separated list of index names; use `_all` or empty string for all indices
       ['force']              = (boolean) TODO: ?
       ['full']               = (boolean) TODO: ?
       ['refresh']            = (boolean) Refresh the index after performing the operation
       ['ignore_unavailable'] = (bool) Whether specified concrete indices should be ignored when unavailable (missing or closed)
       ['allow_no_indices']   = (bool) 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.
       ['body']  = (array) Request body
*/
$params = [
    // ...
];
$client = ClientBuilder::create()->build();
$response = $client->indices()->flushSynced($params);

refresh()

/*
$params['index']               = (list) A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
       ['operation_threading'] = () TODO: ?
       ['ignore_unavailable'] = (bool) Whether specified concrete indices should be ignored when unavailable (missing or closed)
       ['allow_no_indices']   = (bool) 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.
       ['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 for all indices
       ['detailed']    = (bool) Whether to display detailed information about shard recovery
       ['active_only'] = (bool) Display only those recoveries that are currently on-going
       ['human']       = (bool) Whether to return time and byte values in human-readable format.
       ['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'] = (bool) Whether specified concrete indices should be ignored when unavailable (missing or closed)
       ['allow_no_indices']   = (bool) 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.
       ['body']  = (array) Request body
*/
$params = [
    // ...
];
$client = ClientBuilder::create()->build();
$response = $client->indices()->existsType($params);

putAlias()

/*
$params['index']   = (string) The name of the index with an alias
       ['name']    = (string) The name of the alias to be created or updated
       ['timeout'] = (time) Explicit timestamp for the document
       ['body']    = (time) Explicit timestamp for the document
       ['body']  = (array) Request body
*/
$params = [
    // ...
];
$client = ClientBuilder::create()->build();
$response = $client->indices()->putAlias($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)
       ['timeout'] = (time) Explicit operation timeout
       ['body']    = (time) Explicit operation timeout
       ['create']  = (bool) Whether the index template should only be added if new or can also replace an existing one
       ['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
       ['operation_threading'] = () TODO: ?
       ['source']              = (string) The URL-encoded query definition (instead of using the request body)
       ['body']                = (string) The URL-encoded query definition (instead of using the request body)
       ['body']  = (array) Request body
*/
$params = [
    // ...
];
$client = ClientBuilder::create()->build();
$response = $client->indices()->validateQuery($params);

getAlias()

/*
$params['name']           = (list) A comma-separated list of alias names to return (Required)
       ['index']          = (list) A comma-separated list of index names to filter aliases
       ['ignore_indices'] = (enum) When performed on multiple indices, allows to ignore `missing` ones
       ['name']           = (list) A comma-separated list of alias names to return
       ['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; use `_all` to perform the operation on all indices (Required)
       ['type']             = (string) The name of the document type
       ['ignore_conflicts'] = (boolean) Specify whether to ignore conflicts while updating the mapping (default: false)
       ['timeout']          = (time) Explicit operation timeout
       ['body']             = (time) Explicit operation timeout
       ['body']  = (array) Request body
*/
$params = [
    // ...
];
$client = ClientBuilder::create()->build();
$response = $client->indices()->putMapping($params);

deleteMapping()

/*
$params['index'] = (list) A comma-separated list of index names; use `_all` for all indices (Required)
       ['type']  = (string) The name of the document type to delete (Required)
       ['body']  = (array) Request body
*/
$params = [
    // ...
];
$client = ClientBuilder::create()->build();
$response = $client->indices()->deleteMapping($params);

getTemplate()

/*
$params['name'] = (string) The name of the template (Required)
       ['body']  = (array) Request body
*/
$params = [
    // ...
];
$client = ClientBuilder::create()->build();
$response = $client->indices()->getTemplate($params);

existsTemplate()

/*
$params['name'] = (string) The name of the template (Required)
       ['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
       ['body']    = (time) Explicit operation timeout
       ['body']  = (array) Request body
*/
$params = [
    // ...
];
$client = ClientBuilder::create()->build();
$response = $client->indices()->create($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)
       ['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: ?
       ['refresh']              = (boolean) Specify whether the index should be refreshed after performing the operation (default: true)
       ['wait_for_merge']       = (boolean) Specify whether the request should block until the merge process is finished (default: true)
       ['ignore_unavailable']   = (bool) Whether specified concrete indices should be ignored when unavailable (missing or closed)
       ['allow_no_indices']     = (bool) 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.
       ['body']  = (array) Request body
*/
$params = [
    // ...
];
$client = ClientBuilder::create()->build();
$response = $client->indices()->forceMerge($params);

deleteAlias()

/*
$params['index']   = (string) The name of the index with an alias (Required)
       ['name']    = (string) The name of the alias to be deleted (Required)
       ['timeout'] = (time) Explicit timestamp for the document
       ['body']  = (array) Request body
*/
$params = [
    // ...
];
$client = ClientBuilder::create()->build();
$response = $client->indices()->deleteAlias($params);