Docs
You are looking at documentation for an older release. Not what you want? See the current release documentation.
Elasticsearch-PHP [2.0] » Reference - Endpoints
«  Community Integrations    

Reference - Endpointsedit

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

Note

This is auto-generated documentation

Elasticsearch\Clientedit

Class Client

Methods

The class defines the following methods:

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
       ['version']         = (number) Explicit version number for concurrency control
       ['version_type']    = (enum) Specific version type (internal,external,external_gte,force)
       ['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)
       ['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
       ['ignore_missing']  = ??
       ['_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
       ['version']         = (number) Explicit version number for concurrency control
       ['version_type']    = (enum) Specific version type (internal,external,external_gte,force)
       ['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 (one,quorum,all)
       ['parent']       = (string) ID of parent document
       ['replication']  = (enum) Specific replication type
       ['refresh']      = (boolean) Refresh the index after performing the operation
       ['routing']      = (string) Specific routing value
       ['timeout']      = (time) Explicit operation timeout
       ['version']      = (number) Explicit version number for concurrency control
       ['version_type'] = (enum) Specific version type (internal,external,external_gte,force)
       ['body']  = (array) Request body
*/

$params = [
    // ...
];

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

deleteByQuery()

/*
*/

$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
       ['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)
       ['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)
       ['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
       ['body']                     = A query to restrict the results specified with the Query DSL (optional)
       ['body']  = (array) Request body
*/

$params = [
    // ...
];

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

countPercolate()

/*
$params['index']              = (string) The index of the document being count percolated. (Required)
       ['type']               = (string) The type of the document being count percolated. (Required)
       ['id']                 = (string) Substitute the document in the request body with a document that is
known by the specified id. On top of the id, the index and type parameter will be used to retrieve the document
from within the cluster. (Required)
       ['routing']            = (list) A comma-separated list of specific routing values
       ['preference']         = (string) Specify the node or shard the operation should be performed on
(default: random)
       ['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)
       ['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 index of the document being percolated. (Required)
       ['type']                 = (string) The type of the document being percolated. (Required)
       ['id']                   = (string) Substitute the document in the request body with a document that is
known by the specified id. On top of the id, the index and type parameter will be used to retrieve the document
from within the cluster. (Required)
       ['routing']              = (list) A comma-separated list of specific routing values
       ['preference']           = (string) Specify the node or shard the operation should be performed on
(default: random)
       ['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)
       ['percolate_index']      = (string) The index to percolate the document into. Defaults to index.
       ['body']  = (array) Request body
*/

$params = [
    // ...
];

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

mpercolate()

/*
$params['index']              = (string) The index of the document being count percolated to use as default
       ['type']               = (string) The type of the document being percolated to use as default.
       ['body']  = (array) Request body
*/

$params = [
    // ...
];

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

termvectors()

/*
$params['index']            = (string) The index in which the document resides. (Required)
       ['type']             = (string) The type of the document. (Required)
       ['id']               = (string) The id of the document, when not specified a doc param should be
supplied.
       ['body']  = (array) Request body
*/

$params = [
    // ...
];

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

termvector()

/*
$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->termvector($params);

mtermvectors()

/*
$params['index']            = (string) The index in which the document resides.
       ['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);

mlt()

/*
*/

$params = [
    // ...
];

$client = ClientBuilder::create()->build();
$response = $client->mlt($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
       ['preference']      = (string) Specify the node or shard the operation should be performed on (default:
random)
       ['parent']          = (string) The ID of the parent document
       ['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
       ['_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']            = 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
(query_then_fetch,query_and_fetch,dfs_query_then_fetch,dfs_query_and_fetch,count,scan)
       ['body']        = The request definitions (metadata-search request definition pairs), separated by
newlines
       ['body']  = (array) Request body
*/

$params = [
    // ...
];

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

create()

/*
$params['id']           = (string) Document ID
       ['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 (one,quorum,all)
       ['op_type']      = (enum) Explicit operation type (index,create) (default: index)
       ['parent']       = (string) ID of the parent document
       ['refresh']      = (boolean) Refresh the index after performing the operation
       ['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 (internal,external,external_gte,force)
       ['body']         = 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 (one,quorum,all)
       ['refresh']     = (boolean) Refresh the index after performing the operation
       ['routing']     = (string) Specific routing value
       ['timeout']     = (time) Explicit operation timeout
       ['fields']      = (list) Default comma-separated list of fields to return in the response for updates
       ['body']        = The operation definition and data (action-data pairs), separated by newlines
       ['body']  = (array) Request body
*/

$params = [
    // ...
];

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

index()

/*
$params['id']           = (string) Document ID
       ['index']        = (string) The name of the index (Required)
       ['type']         = (string) The type of the document (Required)
       ['percolate']    = (string) Percolator queries to execute while indexing the document
       ['replication']  = (enum) Specific replication type
       ['consistency']  = (enum) Explicit write consistency setting for the operation (one,quorum,all)
       ['op_type']      = (enum) Explicit operation type (index,create) (default: index)
       ['parent']       = (string) ID of the parent document
       ['refresh']      = (boolean) Refresh the index after performing the operation
       ['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 (internal,external,external_gte,force)
       ['body']         = The document
       ['body']  = (array) Request body
*/

$params = [
    // ...
];

$client = ClientBuilder::create()->build();
$response = $client->index($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_unavailable'] = (boolean) Whether specified concrete indices should be ignored when unavailable
(missing or closed)
       ['ignore_indices']     = (enum) When performed on multiple indices, allows to ignore `missing` ones
       ['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)
       ['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']               = 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) (AND,OR)
(default: 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']                     = The query definition using the Query DSL
       ['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) (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_indices']           = (enum) When performed on multiple indices, allows to ignore `missing` ones
       ['indices_boost']            = (list) Comma-separated list of index boosts
       ['query_cache']              = (boolean) Enable query cache for this request
       ['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)
       ['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,count,scan)
       ['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
       ['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);

searchExists()

/*
$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
       ['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)
       ['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
       ['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
       ['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
       ['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
       ['version']                  = (boolean) Specify whether to return document version as part of a hit
       ['body']                     = A query to restrict the results specified with the Query DSL (optional)
       ['body']  = (array) Request body
*/

$params = [
    // ...
];

$client = ClientBuilder::create()->build();
$response = $client->searchExists($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']              = (boolean) Return local information, do not retrieve the state from master node
(default: false)
       ['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->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
       ['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)
       ['preference']         = (string) Specify the node or shard the operation should be performed on
(default: random)
       ['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,query_and_fetch,dfs_query_then_fetch,dfs_query_and_fetch,count,scan)
       ['body']               = The search definition template and its params
       ['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']      = The scroll ID if not passed by URL or query parameter.
       ['body']  = (array) Request body
*/

$params = [
    // ...
];

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

clearScroll()

/*
$params['scroll_id'] = (list) A comma-separated list of scroll IDs to clear
       ['scroll']    = (duration) Specify how long a consistent view of the index should be maintained for
scrolled search
       ['body']      = A comma-separated list of scroll IDs to clear if none was specified via the scroll_id
parameter
       ['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 (one,quorum,all)
       ['fields']            = (list) A comma-separated list of fields to return in the response
       ['lang']              = (string) The script language (default: groovy)
       ['parent']            = (string) ID of the parent document. Is is only used for routing and when for the
upsert request
       ['percolate']         = (string) Perform percolation during the operation; use specific registered query
name, attribute, or wildcard
       ['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)
       ['script_id']         = The id of a stored script
       ['scripted_upsert']   = (boolean) True if the script referenced in script or script_id should be called
to perform inserts - defaults to false
       ['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 (internal,force)
       ['body']              = The request definition using either `script` or partial `doc`
       ['body']  = (array) Request body
*/

$params = [
    // ...
];

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

getScript()

/*
$params['id']           = (string) Script ID (Required)
       ['lang']         = (string) Script language (Required)
       ['version']      = (number) Explicit version number for concurrency control
       ['version_type'] = (enum) Specific version type (internal,external,external_gte,force)
       ['body']  = (array) Request body
*/

$params = [
    // ...
];

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

deleteScript()

/*
$params['id']           = (string) Script ID (Required)
       ['lang']         = (string) Script language (Required)
       ['version']      = (number) Explicit version number for concurrency control
       ['version_type'] = (enum) Specific version type (internal,external,external_gte,force)
       ['body']  = (array) Request body
*/

$params = [
    // ...
];

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

putScript()

/*
$params['id']           = (string) Script ID (Required)
       ['lang']         = (string) Script language (Required)
       ['op_type']      = (enum) Explicit operation type (index,create) (default: index)
       ['version']      = (number) Explicit version number for concurrency control
       ['version_type'] = (enum) Specific version type (internal,external,external_gte,force)
       ['body']         = The document
       ['body']  = (array) Request body
*/

$params = [
    // ...
];

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

getTemplate()

/*
$params['id']           = (string) Template ID (Required)
       ['version']      = (number) Explicit version number for concurrency control
       ['version_type'] = (enum) Specific version type (internal,external,external_gte,force)
       ['body']  = (array) Request body
*/

$params = [
    // ...
];

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

deleteTemplate()

/*
$params['id']           = (string) Template ID (Required)
       ['version']      = (number) Explicit version number for concurrency control
       ['version_type'] = (enum) Specific version type (internal,external,external_gte,force)
       ['body']  = (array) Request body
*/

$params = [
    // ...
];

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

putTemplate()

/*
$params['id']           = (string) Template ID (Required)
       ['op_type']      = (enum) Explicit operation type (index,create) (default: index)
       ['version']      = (number) Explicit version number for concurrency control
       ['version_type'] = (enum) Specific version type (internal,external,external_gte,force)
       ['body']         = The document
       ['body']  = (array) Request body
*/

$params = [
    // ...
];

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

fieldStats()

/*
$params['index']              = (list) A comma-separated list of index names; use `_all` or empty string to
perform the operation on all indices
       ['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 (indices,cluster) (default: cluster)
       ['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']               = Field json objects containing the name and optionally a range to filter out
indices result, that have results outside the defined bounds
       ['body']  = (array) Request body
*/

$params = [
    // ...
];

$client = ClientBuilder::create()->build();
$response = $client->fieldStats($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. (default: 1m)
       ['consistency']         = (enum) Explicit write consistency setting for the operation (one,quorum,all)
       ['wait_for_completion'] = (boolean) Should the request should block until the reindex is complete.
       ['body']  = (array) Request body
*/

$params = [
    // ...
];

$client = ClientBuilder::create()->build();
$response = $client->reIndex($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);

renderSearchTemplate()

/*
$params['id']   = (string) The id of the stored search template
       ['body'] = The search definition template and its params
       ['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();

tasks()

/*
Operate on the Task namespace of commands
       ['body']  = (array) Request body
*/

$params = [
    // ...
];

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

extractArgument()

/*
*/

$params = [
    // ...
];

$client = ClientBuilder::create()->build();
$response = $client->extractArgument($params,$arg);

Elasticsearch\ClientBuilderedit

Class ClientBuilder

Methods

The class defines the following methods:

create()

/*
*/

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()

/*
*/

defaultLogger()

/*
*/

setConnectionFactory()

/*
*/

setConnectionPool()

/*
*/

setEndpoint()

/*
*/

setTransport()

/*
*/

setHandler()

/*
*/

setLogger()

/*
*/

setTracer()

/*
*/

setSerializer()

/*
*/

setHosts()

/*
*/

setRetries()

/*
*/

setSelector()

/*
*/

setSniffOnStart()

/*
*/

setSSLCert()

/*
*/

setSSLKey()

/*
*/

setSSLVerification()

/*
*/

build()

/*
*/

Elasticsearch\Namespaces\CatNamespaceedit

Class CatNamespace

Methods

The class defines the following methods:

aliases()

/*
$params['name']           = (list) A comma-separated list of alias names to return
       ['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
       ['h']              = (list) Comma-separated list of column names to display
       ['help']           = (boolean) Return help information (default: false)
       ['v']              = (boolean) Verbose mode. Display column headers (default: false)
       ['body']  = (array) Request body
*/

$params = [
    // ...
];

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

allocation()

/*
$params['node_id']        = (list) A comma-separated list of node IDs or names to limit the returned information
       ['bytes']          = (enum) The unit in which to display byte values (b,k,m,g)
       ['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
       ['h']              = (list) Comma-separated list of column names to display
       ['help']           = (boolean) Return help information (default: false)
       ['v']              = (boolean) Verbose mode. Display column headers (default: false)
       ['body']  = (array) Request body
*/

$params = [
    // ...
];

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

count()

/*
$params['index']          = (list) A comma-separated list of index names to limit the 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
       ['h']              = (list) Comma-separated list of column names to display
       ['help']           = (boolean) Return help information (default: false)
       ['v']              = (boolean) Verbose mode. Display column headers (default: false)
       ['body']  = (array) Request body
*/

$params = [
    // ...
];

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

health()

/*
$params['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
       ['h']              = (list) Comma-separated list of column names to display
       ['help']           = (boolean) Return help information (default: false)
       ['ts']             = (boolean) Set to false to disable timestamping (default: true)
       ['v']              = (boolean) Verbose mode. Display column headers (default: false)
       ['body']  = (array) Request body
*/

$params = [
    // ...
];

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

help()

/*
$params['help'] = (boolean) Return help information(default: false)
       ['body']  = (array) Request body
*/

$params = [
    // ...
];

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

indices()

/*
$params['index']          = (list) A comma-separated list of index names to limit the returned information
       ['bytes']          = (enum) The unit in which to display byte values (b,k,m,g)
       ['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
       ['h']              = (list) Comma-separated list of column names to display
       ['help']           = (boolean) Return help information (default: false)
       ['pri']            = (boolean) Set to true to return stats only for primary shards (default: false)
       ['v']              = (boolean) Verbose mode. Display column headers (default: false)
       ['body']  = (array) Request body
*/

$params = [
    // ...
];

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

master()

/*
$params['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
       ['h']              = (list) Comma-separated list of column names to display
       ['help']           = (boolean) Return help information (default: false)
       ['v']              = (boolean) Verbose mode. Display column headers (default: false)
       ['body']  = (array) Request body
*/

$params = [
    // ...
];

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

nodes()

/*
$params['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
       ['h']              = (list) Comma-separated list of column names to display
       ['help']           = (boolean) Return help information (default: false)
       ['v']              = (boolean) Verbose mode. Display column headers (default: false)
       ['body']  = (array) Request body
*/

$params = [
    // ...
];

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

nodeAttrs()

/*
$params['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
       ['h']              = (list) Comma-separated list of column names to display
       ['help']           = (boolean) Return help information (default: false)
       ['v']              = (boolean) Verbose mode. Display column headers (default: false)
       ['body']  = (array) Request body
*/

$params = [
    // ...
];

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

pendingTasks()

/*
$params['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
       ['h']              = (list) Comma-separated list of column names to display
       ['help']           = (boolean) Return help information (default: false)
       ['v']              = (boolean) Verbose mode. Display column headers (default: false)
       ['body']  = (array) Request body
*/

$params = [
    // ...
];

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

recovery()

/*
$params['index']          = (list) A comma-separated list of index names to limit the returned information
       ['bytes']          = (enum) The unit in which to display byte values (b,k,m,g)
       ['master_timeout'] = (time) Explicit operation timeout for connection to master node
       ['h']              = (list) Comma-separated list of column names to display
       ['help']           = (boolean) Return help information (default: false)
       ['v']              = (boolean) Verbose mode. Display column headers (default: false)
       ['body']  = (array) Request body
*/

$params = [
    // ...
];

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

repositories()

/*
$params['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
       ['h']              = (list) Comma-separated list of column names to display
       ['help']           = (boolean) Return help information (default: false)
       ['v']              = (boolean) Verbose mode. Display column headers (default: false)
       ['body']  = (array) Request body
*/

$params = [
    // ...
];

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

shards()

/*
$params['index']          = (list) A comma-separated list of index names to limit the returned information
       ['bytes']          = (enum) The unit in which to display byte values
       ['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
       ['h']              = (list) Comma-separated list of column names to display
       ['help']           = (boolean) Return help information (default: false)
       ['v']              = (boolean) Verbose mode. Display column headers (default: false)
       ['body']  = (array) Request body
*/

$params = [
    // ...
];

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

snapshots()

/*
$params['repository']         = (list) Name of repository from which to fetch the snapshot information (Required)
       ['local']              = (bool) Return local information, do not retrieve the state from master node
(default: false)
       ['ignore_unavailable'] = (boolean) Set to true to ignore unavailable snapshots (default: false)
       ['master_timeout']     = (time) Explicit operation timeout for connection to master node
       ['h']                  = (list) Comma-separated list of column names to display
       ['help']               = (boolean) Return help information (default: false)
       ['v']                  = (boolean) Verbose mode. Display column headers (default: false)
       ['body']  = (array) Request body
*/

$params = [
    // ...
];

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

threadPool()

/*
$params['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
       ['h']              = (list) Comma-separated list of column names to display
       ['help']           = (boolean) Return help information (default: false)
       ['v']              = (boolean) Verbose mode. Display column headers (default: false)
       ['full_id']        = (boolean) Enables displaying the complete node ids (default: false)
       ['body']  = (array) Request body
*/

$params = [
    // ...
];

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

fielddata()

/*
$params['fields']         = (list) A comma-separated list of fields to return in the output
       ['bytes']          = (enum) The unit in which to display byte values (b,k,m,g)
       ['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
       ['h']              = (list) Comma-separated list of column names to display
       ['help']           = (boolean) Return help information (default: false)
       ['v']              = (boolean) Verbose mode. Display column headers (default: false)
       ['body']  = (array) Request body
*/

$params = [
    // ...
];

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

plugins()

/*
$params['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
       ['h']              = (list) Comma-separated list of column names to display
       ['help']           = (boolean) Return help information (default: false)
       ['v']              = (boolean) Verbose mode. Display column headers (default: false)
       ['body']  = (array) Request body
*/

$params = [
    // ...
];

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

segments()

/*
$params['index'] = (list) A comma-separated list of index names to limit the returned information
       ['h']     = (list) Comma-separated list of column names to display
       ['help']  = (boolean) Return help information (default: false)
       ['v']     = (boolean) Verbose mode. Display column headers (default: false)
       ['body']  = (array) Request body
*/

$params = [
    // ...
];

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

Elasticsearch\Namespaces\ClusterNamespaceedit

Class ClusterNamespace

Methods

The class defines the following methods:

health()

/*
$params['index']                      = (list) Limit the information returned to a specific index
       ['level']                      = (enum) Specify the level of detail for returned information
(cluster,indices,shards) (default: cluster)
       ['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']             = (string) 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 (green,yellow,red)
       ['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
       ['explain']         = (boolean) Return an explanation of why the commands can or cannot be executed
       ['filter_metadata'] = (boolean) Don't return cluster state metadata (default: false)
       ['metric']          = (list) Limit the information returned to the specified metrics. Defaults to all but
metadata (_all,blocks,metadata,nodes,routing_table,master_node,version)
       ['master_timeout']  = (time) Explicit operation timeout for connection to master node
       ['timeout']         = (time) Explicit operation timeout
       ['body']            = The definition of `commands` to perform (`move`, `cancel`, `allocate`)
       ['body']  = (array) Request body
*/

$params = [
    // ...
];

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

state()

/*
$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 to the specified metrics
       ['local']              = (boolean) Return local information, do not retrieve the state from master node
(default: false)
       ['master_timeout']     = (time) Specify timeout for connection to master
       ['flat_settings']      = (boolean) Return settings in flat format (default: false)
       ['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->cluster()->state($params);

stats()

/*
$params['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
       ['flat_settings'] = (boolean) Return settings in flat format (default: false)
       ['human']         = (boolean) Whether to return time and byte values in human-readable format. (default:
false)
       ['timeout']       = (time) Explicit operation timeout
       ['body']  = (array) Request body
*/

$params = [
    // ...
];

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

putSettings()

/*
$params['flat_settings']  = (boolean) Return settings in flat format (default: false)
       ['master_timeout'] = (time) Explicit operation timeout for connection to master node
       ['timeout']        = (time) Explicit operation timeout
       ['body']           = The settings to be updated. Can be either `transient` or `persistent` (survives
cluster restart).
       ['body']  = (array) Request body
*/

$params = [
    // ...
];

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

getSettings()

/*
$params['flat_settings']  = (boolean) Return settings in flat format (default: false)
       ['master_timeout'] = (time) Explicit operation timeout for connection to master node
       ['timeout']        = (time) Explicit operation timeout
       ['body']  = (array) Request body
*/

$params = [
    // ...
];

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

pendingTasks()

/*
$params['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()->pendingTasks($params);

Elasticsearch\Namespaces\IndicesNamespaceedit

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\NodesNamespaceedit

Class NodesNamespace

Methods

The class defines the following methods:

stats()

/*
$params['metric']            = (list) Limit the information returned to the specified metrics
       ['index_metric']      = (list) Limit the information returned for `indices` metric to the specific index
metrics. Isn't used if `indices` (or `all`) metric isn't specified.
       ['body']  = (array) Request body
*/

$params = [
    // ...
];

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

info()

/*
$params['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
       ['metric']        = (list) A comma-separated list of metrics you wish returned. Leave empty to return
all.
       ['body']  = (array) Request body
*/

$params = [
    // ...
];

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

hotThreads()

/*
$params['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
       ['interval']            = (time) The interval for the second sampling of threads
       ['snapshots']           = (number) Number of samples of thread stacktrace (default: 10)
       ['threads']             = (number) Specify the number of threads to provide information for (default: 3)
       ['ignore_idle_threads'] = (boolean) Don't show threads that are in known-idle places, such as waiting on
a socket select or pulling from an empty task queue (default: true)
       ['type']                = (enum) The type to sample (default: cpu) (cpu,wait,block)
       ['timeout']             = (time) Explicit operation timeout
       ['body']  = (array) Request body
*/

$params = [
    // ...
];

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

shutdown()

/*
*/

$params = [
    // ...
];

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

Elasticsearch\Namespaces\SnapshotNamespaceedit

Class SnapshotNamespace

Methods

The class defines the following methods:

create()

/*
$params['repository']          = (string) A repository name (Required)
       ['snapshot']            = (string) A snapshot name (Required)
       ['master_timeout']      = (time) Explicit operation timeout for connection to master node
       ['wait_for_completion'] = (boolean) Should this request wait until the operation has completed before
returning (default: false)
       ['body']                = The snapshot definition
       ['body']  = (array) Request body
*/

$params = [
    // ...
];

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

createRepository()

/*
$params['repository']     = (string) A repository name (Required)
       ['master_timeout'] = (time) Explicit operation timeout for connection to master node
       ['timeout']        = (time) Explicit operation timeout
       ['verify']         = (boolean) Whether to verify the repository after creation
       ['body']           = The repository definition
       ['body']  = (array) Request body
*/

$params = [
    // ...
];

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

delete()

/*
$params['repository']     = (string) A repository name (Required)
       ['snapshot']       = (string) A snapshot name (Required)
       ['master_timeout'] = (time) Explicit operation timeout for connection to master node
       ['body']  = (array) Request body
*/

$params = [
    // ...
];

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

deleteRepository()

/*
$params['repository']     = (list) A comma-separated list of repository names (Required)
       ['master_timeout'] = (time) Explicit operation timeout for connection to master node
       ['timeout']        = (time) Explicit operation timeout
       ['body']  = (array) Request body
*/

$params = [
    // ...
];

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

get()

/*
$params['repository']     = (string) A repository name (Required)
       ['snapshot']       = (list) A comma-separated list of snapshot names (Required)
       ['master_timeout'] = (time) Explicit operation timeout for connection to master node
       ['body']  = (array) Request body
*/

$params = [
    // ...
];

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

getRepository()

/*
$params['repository']     = (list) A comma-separated list of repository names
       ['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->snapshot()->getRepository($params);

restore()

/*
$params['repository']          = (string) A repository name (Required)
       ['snapshot']            = (string) A snapshot name (Required)
       ['master_timeout']      = (time) Explicit operation timeout for connection to master node
       ['wait_for_completion'] = (boolean) Should this request wait until the operation has completed before
returning (default: false)
       ['body']                = Details of what to restore
       ['body']  = (array) Request body
*/

$params = [
    // ...
];

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

status()

/*
$params['repository']     = (string) A repository name
       ['snapshot']       = (list) A comma-separated list of snapshot names
       ['master_timeout'] = (time) Explicit operation timeout for connection to master node
       ['body']  = (array) Request body
*/

$params = [
    // ...
];

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

verifyRepository()

/*
$params['repository']     = (string) A repository name (Required)
       ['master_timeout'] = (time) Explicit operation timeout for connection to master node
       ['timeout']        = (time) Explicit operation timeout
       ['body']  = (array) Request body
*/

$params = [
    // ...
];

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

Elasticsearch\Namespaces\TaskNamespaceedit

Class TaskNamespace

Methods

The class defines the following methods:

cancel()

/*
$params['task_id']     = (string) Cancel the task with specified task id (node_id:task_number)
       ['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
       ['actions']     = (list) A comma-separated list of actions that should be cancelled. Leave empty to
cancel all.
       ['body']  = (array) Request body
*/

$params = [
    // ...
];

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

show()

/*
$params['task_id']             = (string) Return the task with specified id (node_id:task_number)
       ['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
       ['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->task()->show($params);
«  Community Integrations