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

Elasticsearch\Client

edit

Elasticsearch\Client

edit

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);
« Reference - Endpoints Elasticsearch\ClientBuilder »