| Methods |
public
|
addBlock(array $params = []): array
Adds a block to an index.
Adds a block to an index.
$params['block'] = (string) The block to add (one of read, write, read_only or metadata)
$params['index'] = (array) A comma separated list of indexes to add a block to
$params['allow_no_indices'] = (boolean) Whether to ignore if a wildcard indexes expression resolves into no concrete indexes. (This includes _all string or when no indexes have been specified)
$params['cluster_manager_timeout'] = (string) Operation timeout for connection to cluster-manager node.
$params['expand_wildcards'] = (any) Whether to expand wildcard expression to concrete indexes that are open, closed or both.
$params['ignore_unavailable'] = (boolean) Whether specified concrete indexes should be ignored when unavailable (missing or closed)
$params['master_timeout'] = (string) Specify timeout for connection to master
$params['timeout'] = (string) Explicit operation timeout
$params['pretty'] = (boolean) Whether to pretty format the returned JSON response. (Default = false)
$params['human'] = (boolean) Whether to return human readable values for statistics. (Default = true)
$params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. (Default = false)
$params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
$params['filter_path'] = (any) Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with "-".
Parameters
| $params |
Associative array of parameters
|
|
#
|
public
|
analyze(array $params = []): array
Performs the analysis process on a text and return the tokens breakdown of the text.
Performs the analysis process on a text and return the tokens breakdown of the text.
$params['index'] = (string) Index used to derive the analyzer. If specified, the analyzer or field parameter overrides this value. If no index is specified or the index does not have a default analyzer, the analyze API uses the standard analyzer.
$params['pretty'] = (boolean) Whether to pretty format the returned JSON response. (Default = false)
$params['human'] = (boolean) Whether to return human readable values for statistics. (Default = true)
$params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. (Default = false)
$params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
$params['filter_path'] = (any) Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with "-".
$params['body'] = (array) Define analyzer/tokenizer parameters and the text on which the analysis should be performed
Parameters
| $params |
Associative array of parameters
|
|
#
|
public
|
clearCache(array $params = []): array
Clears all or specific caches for one or more indexes.
Clears all or specific caches for one or more indexes.
$params['index'] = (array) Comma-separated list of data streams, indexes, and aliases used to limit the request. Supports wildcards (*). To target all data streams and indexes, omit this parameter or use * or _all.
$params['allow_no_indices'] = (boolean) If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indexes.This behavior applies even if the request targets other open indexes.
$params['expand_wildcards'] = (any) Type of index that wildcard patterns can match.If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.Supports comma-separated values, such as open,hidden.Valid values are: all, open, closed, hidden, none.
$params['fielddata'] = (boolean) If true, clears the fields cache.Use the fields parameter to clear the cache of specific fields only.
$params['fields'] = (any) Comma-separated list of field names used to limit the fielddata parameter.
$params['file'] = (boolean) If true, clears the unused entries from the file cache on nodes with the Search role. (Default = false)
$params['ignore_unavailable'] = (boolean) If false, the request returns an error if it targets a missing or closed index.
$params['query'] = (boolean) If true, clears the query cache.
$params['request'] = (boolean) If true, clears the request cache.
$params['pretty'] = (boolean) Whether to pretty format the returned JSON response. (Default = false)
$params['human'] = (boolean) Whether to return human readable values for statistics. (Default = true)
$params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. (Default = false)
$params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
$params['filter_path'] = (any) Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with "-".
Parameters
| $params |
Associative array of parameters
|
|
#
|
public
|
clone(array $params = []): array
Clones an index.
Clones an index.
$params['index'] = (string) Name of the source index to clone.
$params['target'] = (string) Name of the target index to create.
$params['cluster_manager_timeout'] = (string) Operation timeout for connection to cluster-manager node.
$params['master_timeout'] = (string) Period to wait for a connection to the master node.If no response is received before the timeout expires, the request fails and returns an error.
$params['task_execution_timeout'] = (string) Explicit task execution timeout, only useful when wait_for_completion is false, defaults to 1h.
$params['timeout'] = (string) Period to wait for a response.If no response is received before the timeout expires, the request fails and returns an error.
$params['wait_for_active_shards'] = (any) The number of shard copies that must be active before proceeding with the operation.Set to all or any positive integer up to the total number of shards in the index (number_of_replicas+1).
$params['wait_for_completion'] = (boolean) Should this request wait until the operation has completed before returning. (Default = true)
$params['pretty'] = (boolean) Whether to pretty format the returned JSON response. (Default = false)
$params['human'] = (boolean) Whether to return human readable values for statistics. (Default = true)
$params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. (Default = false)
$params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
$params['filter_path'] = (any) Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with "-".
$params['body'] = (array) The configuration for the target index (settings and aliases)
Parameters
| $params |
Associative array of parameters
|
|
#
|
public
|
close(array $params = []): array
Closes an index.
Closes an index.
$params['index'] = (array) Comma-separated list or wildcard expression of index names used to limit the request.
$params['allow_no_indices'] = (boolean) If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indexes.This behavior applies even if the request targets other open indexes.
$params['cluster_manager_timeout'] = (string) Operation timeout for connection to cluster-manager node.
$params['expand_wildcards'] = (any) Type of index that wildcard patterns can match.If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.Supports comma-separated values, such as open,hidden.Valid values are: all, open, closed, hidden, none.
$params['ignore_unavailable'] = (boolean) If false, the request returns an error if it targets a missing or closed index.
$params['master_timeout'] = (string) Period to wait for a connection to the master node.If no response is received before the timeout expires, the request fails and returns an error.
$params['timeout'] = (string) Period to wait for a response.If no response is received before the timeout expires, the request fails and returns an error.
$params['wait_for_active_shards'] = (any) The number of shard copies that must be active before proceeding with the operation.Set to all or any positive integer up to the total number of shards in the index (number_of_replicas+1).
$params['pretty'] = (boolean) Whether to pretty format the returned JSON response. (Default = false)
$params['human'] = (boolean) Whether to return human readable values for statistics. (Default = true)
$params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. (Default = false)
$params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
$params['filter_path'] = (any) Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with "-".
Parameters
| $params |
Associative array of parameters
|
|
#
|
public
|
create(array $params = []): array
Creates an index with optional settings and mappings.
Creates an index with optional settings and mappings.
$params['index'] = (string) Name of the index you wish to create.
$params['cluster_manager_timeout'] = (string) Operation timeout for connection to cluster-manager node.
$params['master_timeout'] = (string) Period to wait for a connection to the master node.If no response is received before the timeout expires, the request fails and returns an error.
$params['timeout'] = (string) Period to wait for a response.If no response is received before the timeout expires, the request fails and returns an error.
$params['wait_for_active_shards'] = (any) The number of shard copies that must be active before proceeding with the operation. Set to all or any positive integer up to the total number of shards in the index (number_of_replicas+1).
$params['pretty'] = (boolean) Whether to pretty format the returned JSON response. (Default = false)
$params['human'] = (boolean) Whether to return human readable values for statistics. (Default = true)
$params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. (Default = false)
$params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
$params['filter_path'] = (any) Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with "-".
$params['body'] = (array) The configuration for the index (settings and mappings)
Parameters
| $params |
Associative array of parameters
|
|
#
|
public
|
createDataStream(array $params = []): array
Creates or updates a data stream.
Creates or updates a data stream.
$params['name'] = (string) Name of the data stream, which must meet the following criteria: Lowercase only; Cannot include \, /, *, ?, ", <, >, |, ,, #, :, or a space character; Cannot start with -, _, +, or .ds-; Cannot be . or ..; Cannot be longer than 255 bytes. Multi-byte characters count towards this limit faster.
$params['pretty'] = (boolean) Whether to pretty format the returned JSON response. (Default = false)
$params['human'] = (boolean) Whether to return human readable values for statistics. (Default = true)
$params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. (Default = false)
$params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
$params['filter_path'] = (any) Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with "-".
$params['body'] = (array) The data stream definition
Parameters
| $params |
Associative array of parameters
|
|
#
|
public
|
dataStreamsStats(array $params = []): array
Provides statistics on operations happening in a data stream.
Provides statistics on operations happening in a data stream.
$params['name'] = (array) Comma-separated list of data streams used to limit the request. Wildcard expressions (*) are supported. To target all data streams in a cluster, omit this parameter or use *.
$params['pretty'] = (boolean) Whether to pretty format the returned JSON response. (Default = false)
$params['human'] = (boolean) Whether to return human readable values for statistics. (Default = true)
$params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. (Default = false)
$params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
$params['filter_path'] = (any) Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with "-".
Parameters
| $params |
Associative array of parameters
|
|
#
|
public
|
delete(array $params = []): array
Deletes an index.
Deletes an index.
$params['index'] = (array) Comma-separated list of indexes to delete. You cannot specify index aliases. By default, this parameter does not support wildcards (*) or _all. To use wildcards or _all, set the action.destructive_requires_name cluster setting to false.
$params['allow_no_indices'] = (boolean) If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indexes.This behavior applies even if the request targets other open indexes. (Default = false)
$params['cluster_manager_timeout'] = (string) Operation timeout for connection to cluster-manager node.
$params['expand_wildcards'] = (any) Type of index that wildcard patterns can match.If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.Supports comma-separated values, such as open,hidden.Valid values are: all, open, closed, hidden, none.
$params['ignore_unavailable'] = (boolean) If false, the request returns an error if it targets a missing or closed index. (Default = false)
$params['master_timeout'] = (string) Period to wait for a connection to the master node.If no response is received before the timeout expires, the request fails and returns an error.
$params['timeout'] = (string) Period to wait for a response.If no response is received before the timeout expires, the request fails and returns an error.
$params['pretty'] = (boolean) Whether to pretty format the returned JSON response. (Default = false)
$params['human'] = (boolean) Whether to return human readable values for statistics. (Default = true)
$params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. (Default = false)
$params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
$params['filter_path'] = (any) Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with "-".
Parameters
| $params |
Associative array of parameters
|
|
#
|
public
|
deleteAlias(array $params = []): array
Deletes an alias.
Deletes an alias.
$params['index'] = (array) Comma-separated list of data streams or indexes used to limit the request. Supports wildcards (*). (Required)
$params['name'] = (array) Comma-separated list of aliases to remove. Supports wildcards (*). To remove all aliases, use * or _all. (Required)
$params['cluster_manager_timeout'] = (string) Operation timeout for connection to cluster-manager node.
$params['master_timeout'] = (string) Period to wait for a connection to the master node.If no response is received before the timeout expires, the request fails and returns an error.
$params['timeout'] = (string) Period to wait for a response.If no response is received before the timeout expires, the request fails and returns an error.
$params['pretty'] = (boolean) Whether to pretty format the returned JSON response. (Default = false)
$params['human'] = (boolean) Whether to return human readable values for statistics. (Default = true)
$params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. (Default = false)
$params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
$params['filter_path'] = (any) Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with "-".
Parameters
| $params |
Associative array of parameters
|
|
#
|
public
|
deleteDataStream(array $params = []): array
Deletes a data stream.
Deletes a data stream.
$params['name'] = (array) Comma-separated list of data streams to delete. Wildcard (*) expressions are supported.
$params['pretty'] = (boolean) Whether to pretty format the returned JSON response. (Default = false)
$params['human'] = (boolean) Whether to return human readable values for statistics. (Default = true)
$params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. (Default = false)
$params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
$params['filter_path'] = (any) Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with "-".
Parameters
| $params |
Associative array of parameters
|
|
#
|
public
|
deleteIndexTemplate(array $params = []): array
Deletes an index template.
Deletes an index template.
$params['name'] = (string) Name of the index template to delete. Wildcard (*) expressions are supported.
$params['cluster_manager_timeout'] = (string) Operation timeout for connection to cluster-manager node.
$params['master_timeout'] = (string) Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.
$params['timeout'] = (string) Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.
$params['pretty'] = (boolean) Whether to pretty format the returned JSON response. (Default = false)
$params['human'] = (boolean) Whether to return human readable values for statistics. (Default = true)
$params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. (Default = false)
$params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
$params['filter_path'] = (any) Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with "-".
Parameters
| $params |
Associative array of parameters
|
|
#
|
public
|
deleteTemplate(array $params = []): array
Deletes an index template.
Deletes an index template.
$params['name'] = (string) The name of the legacy index template to delete. Wildcard (*) expressions are supported.
$params['cluster_manager_timeout'] = (string) Operation timeout for connection to cluster-manager node.
$params['master_timeout'] = (string) Period to wait for a connection to the master node.If no response is received before the timeout expires, the request fails and returns an error.
$params['timeout'] = (string) Period to wait for a response.If no response is received before the timeout expires, the request fails and returns an error.
$params['pretty'] = (boolean) Whether to pretty format the returned JSON response. (Default = false)
$params['human'] = (boolean) Whether to return human readable values for statistics. (Default = true)
$params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. (Default = false)
$params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
$params['filter_path'] = (any) Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with "-".
Parameters
| $params |
Associative array of parameters
|
|
#
|
public
|
exists(array $params = []): bool
Returns information about whether a particular index exists.
Returns information about whether a particular index exists.
$params['index'] = (array) Comma-separated list of data streams, indexes, and aliases. Supports wildcards (*).
$params['allow_no_indices'] = (boolean) If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indexes.This behavior applies even if the request targets other open indexes. (Default = false)
$params['cluster_manager_timeout'] = (string) Operation timeout for connection to cluster-manager node.
$params['expand_wildcards'] = (any) Type of index that wildcard patterns can match.If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.Supports comma-separated values, such as open,hidden.Valid values are: all, open, closed, hidden, none.
$params['flat_settings'] = (boolean) If true, returns settings in flat format. (Default = false)
$params['ignore_unavailable'] = (boolean) If false, the request returns an error if it targets a missing or closed index. (Default = false)
$params['include_defaults'] = (boolean) If true, return all default settings in the response. (Default = false)
$params['local'] = (boolean) If true, the request retrieves information from the local node only. (Default = false)
$params['pretty'] = (boolean) Whether to pretty format the returned JSON response. (Default = false)
$params['human'] = (boolean) Whether to return human readable values for statistics. (Default = true)
$params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. (Default = false)
$params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
$params['filter_path'] = (any) Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with "-".
Parameters
| $params |
Associative array of parameters
|
|
#
|
public
|
existsAlias(array $params = []): bool
Returns information about whether a particular alias exists.
Returns information about whether a particular alias exists.
$params['name'] = (array) Comma-separated list of aliases to check. Supports wildcards (*). (Required)
$params['index'] = (array) Comma-separated list of data streams or indexes used to limit the request. Supports wildcards (*). To target all data streams and indexes, omit this parameter or use * or _all.
$params['allow_no_indices'] = (boolean) If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indexes.This behavior applies even if the request targets other open indexes.
$params['expand_wildcards'] = (any) Type of index that wildcard patterns can match.If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.Supports comma-separated values, such as open,hidden.Valid values are: all, open, closed, hidden, none.
$params['ignore_unavailable'] = (boolean) If false, requests that include a missing data stream or index in the target indexes or data streams return an error.
$params['local'] = (boolean) If true, the request retrieves information from the local node only. (Default = false)
$params['pretty'] = (boolean) Whether to pretty format the returned JSON response. (Default = false)
$params['human'] = (boolean) Whether to return human readable values for statistics. (Default = true)
$params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. (Default = false)
$params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
$params['filter_path'] = (any) Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with "-".
Parameters
| $params |
Associative array of parameters
|
|
#
|
public
|
existsIndexTemplate(array $params = []): bool
Returns information about whether a particular index template exists.
Returns information about whether a particular index template exists.
$params['name'] = (string) Name of the index template to check existence of. Wildcard (*) expressions are supported.
$params['cluster_manager_timeout'] = (string) Operation timeout for connection to cluster-manager node.
$params['flat_settings'] = (boolean) Return settings in flat format. (Default = false)
$params['local'] = (boolean) Return local information, do not retrieve the state from cluster-manager node. (Default = false)
$params['master_timeout'] = (string) Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.
$params['pretty'] = (boolean) Whether to pretty format the returned JSON response. (Default = false)
$params['human'] = (boolean) Whether to return human readable values for statistics. (Default = true)
$params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. (Default = false)
$params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
$params['filter_path'] = (any) Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with "-".
Parameters
| $params |
Associative array of parameters
|
|
#
|
public
|
existsTemplate(array $params = []): bool
Returns information about whether a particular index template exists.
Returns information about whether a particular index template exists.
$params['name'] = (array) The comma separated names of the index templates
$params['cluster_manager_timeout'] = (string) Operation timeout for connection to cluster-manager node.
$params['flat_settings'] = (boolean) Return settings in flat format. (Default = false)
$params['local'] = (boolean) Return local information, do not retrieve the state from cluster-manager node. (Default = false)
$params['master_timeout'] = (string) Explicit operation timeout for connection to master node
$params['pretty'] = (boolean) Whether to pretty format the returned JSON response. (Default = false)
$params['human'] = (boolean) Whether to return human readable values for statistics. (Default = true)
$params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. (Default = false)
$params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
$params['filter_path'] = (any) Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with "-".
Parameters
| $params |
Associative array of parameters
|
|
#
|
public
|
flush(array $params = []): array
Performs the flush operation on one or more indexes.
Performs the flush operation on one or more indexes.
$params['index'] = (array) Comma-separated list of data streams, indexes, and aliases to flush. Supports wildcards (*). To flush all data streams and indexes, omit this parameter or use * or _all.
$params['allow_no_indices'] = (boolean) If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indexes.This behavior applies even if the request targets other open indexes.
$params['expand_wildcards'] = (any) Type of index that wildcard patterns can match.If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.Supports comma-separated values, such as open,hidden.Valid values are: all, open, closed, hidden, none.
$params['force'] = (boolean) If true, the request forces a flush even if there are no changes to commit to the index.
$params['ignore_unavailable'] = (boolean) If false, the request returns an error if it targets a missing or closed index.
$params['wait_if_ongoing'] = (boolean) If true, the flush operation blocks until execution when another flush operation is running.If false, OpenSearch returns an error if you request a flush when another flush operation is running. (Default = true)
$params['pretty'] = (boolean) Whether to pretty format the returned JSON response. (Default = false)
$params['human'] = (boolean) Whether to return human readable values for statistics. (Default = true)
$params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. (Default = false)
$params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
$params['filter_path'] = (any) Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with "-".
Parameters
| $params |
Associative array of parameters
|
|
#
|
public
|
forcemerge(array $params = []): array
Performs the force merge operation on one or more indexes.
Performs the force merge operation on one or more indexes.
$params['index'] = (array) A comma-separated list of index names; use _all or empty string to perform the operation on all indexes
$params['allow_no_indices'] = (boolean) Whether to ignore if a wildcard indexes expression resolves into no concrete indexes. (This includes _all string or when no indexes have been specified)
$params['expand_wildcards'] = (any) Whether to expand wildcard expression to concrete indexes that are open, closed or both.
$params['flush'] = (boolean) Specify whether the index should be flushed after performing the operation. (Default = true)
$params['ignore_unavailable'] = (boolean) Whether specified concrete indexes should be ignored when unavailable (missing or closed)
$params['max_num_segments'] = (number) The number of larger segments into which smaller segments are merged.Set this parameter to 1 to merge all segments into one segment.The default behavior is to perform the merge as necessary.
$params['only_expunge_deletes'] = (boolean) Specify whether the operation should only expunge deleted documents
$params['primary_only'] = (boolean) Specify whether the operation should only perform on primary shards. Defaults to false. (Default = false)
$params['wait_for_completion'] = (boolean) Should the request wait until the force merge is completed. (Default = true)
$params['pretty'] = (boolean) Whether to pretty format the returned JSON response. (Default = false)
$params['human'] = (boolean) Whether to return human readable values for statistics. (Default = true)
$params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. (Default = false)
$params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
$params['filter_path'] = (any) Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with "-".
Parameters
| $params |
Associative array of parameters
|
|
#
|
public
|
get(array $params = []): array
Returns information about one or more indexes.
Returns information about one or more indexes.
$params['index'] = (array) Comma-separated list of data streams, indexes, and index aliases used to limit the request. Wildcard expressions () are supported.
$params['allow_no_indices'] = (boolean) If false, the request returns an error if any wildcard expression, index alias, or _all value targets onlymissing or closed indexes. This behavior applies even if the request targets other open indexes. For example,a request targeting foo,bar* returns an error if an index starts with foo but no index starts with bar. (Default = false)
$params['cluster_manager_timeout'] = (string) Operation timeout for connection to cluster-manager node.
$params['expand_wildcards'] = (any) Type of index that wildcard expressions can match. If the request can target data streams, this argumentdetermines whether wildcard expressions match hidden data streams. Supports comma-separated values,such as open,hidden.
$params['flat_settings'] = (boolean) If true, returns settings in flat format. (Default = false)
$params['ignore_unavailable'] = (boolean) If false, requests that target a missing index return an error. (Default = false)
$params['include_defaults'] = (boolean) If true, return all default settings in the response. (Default = false)
$params['local'] = (boolean) If true, the request retrieves information from the local node only. Defaults to false, which means information is retrieved from the master node. (Default = false)
$params['master_timeout'] = (string) Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.
$params['pretty'] = (boolean) Whether to pretty format the returned JSON response. (Default = false)
$params['human'] = (boolean) Whether to return human readable values for statistics. (Default = true)
$params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. (Default = false)
$params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
$params['filter_path'] = (any) Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with "-".
Parameters
| $params |
Associative array of parameters
|
|
#
|
public
|
getAlias(array $params = []): array
Returns an alias.
Returns an alias.
$params['name'] = (array) Comma-separated list of aliases to retrieve. Supports wildcards (*). To retrieve all aliases, omit this parameter or use * or _all.
$params['index'] = (array) Comma-separated list of data streams or indexes used to limit the request. Supports wildcards (*). To target all data streams and indexes, omit this parameter or use * or _all.
$params['allow_no_indices'] = (boolean) If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indexes.This behavior applies even if the request targets other open indexes.
$params['expand_wildcards'] = (any) Type of index that wildcard patterns can match.If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.Supports comma-separated values, such as open,hidden.Valid values are: all, open, closed, hidden, none.
$params['ignore_unavailable'] = (boolean) If false, the request returns an error if it targets a missing or closed index.
$params['local'] = (boolean) If true, the request retrieves information from the local node only. (Default = false)
$params['pretty'] = (boolean) Whether to pretty format the returned JSON response. (Default = false)
$params['human'] = (boolean) Whether to return human readable values for statistics. (Default = true)
$params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. (Default = false)
$params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
$params['filter_path'] = (any) Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with "-".
Parameters
| $params |
Associative array of parameters
|
|
#
|
public
|
getDataStream(array $params = []): array
Returns data streams.
Returns data streams.
$params['name'] = (array) Comma-separated list of data stream names used to limit the request. Wildcard (*) expressions are supported. If omitted, all data streams are returned.
$params['pretty'] = (boolean) Whether to pretty format the returned JSON response. (Default = false)
$params['human'] = (boolean) Whether to return human readable values for statistics. (Default = true)
$params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. (Default = false)
$params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
$params['filter_path'] = (any) Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with "-".
Parameters
| $params |
Associative array of parameters
|
|
#
|
public
|
getFieldMapping(array $params = []): array
Returns mapping for one or more fields.
Returns mapping for one or more fields.
$params['fields'] = (array) Comma-separated list or wildcard expression of fields used to limit returned information. (Required)
$params['index'] = (array) Comma-separated list of data streams, indexes, and aliases used to limit the request. Supports wildcards (*). To target all data streams and indexes, omit this parameter or use * or _all.
$params['allow_no_indices'] = (boolean) If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indexes.This behavior applies even if the request targets other open indexes.
$params['expand_wildcards'] = (any) Type of index that wildcard patterns can match.If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.Supports comma-separated values, such as open,hidden.Valid values are: all, open, closed, hidden, none.
$params['ignore_unavailable'] = (boolean) If false, the request returns an error if it targets a missing or closed index.
$params['include_defaults'] = (boolean) If true, return all default settings in the response.
$params['local'] = (boolean) If true, the request retrieves information from the local node only. (Default = false)
$params['pretty'] = (boolean) Whether to pretty format the returned JSON response. (Default = false)
$params['human'] = (boolean) Whether to return human readable values for statistics. (Default = true)
$params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. (Default = false)
$params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
$params['filter_path'] = (any) Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with "-".
Parameters
| $params |
Associative array of parameters
|
|
#
|
public
|
getIndexTemplate(array $params = []): array
Returns an index template.
Returns an index template.
$params['name'] = (array) Name of the index template to retrieve. Wildcard (*) expressions are supported.
$params['cluster_manager_timeout'] = (string) Operation timeout for connection to cluster-manager node.
$params['flat_settings'] = (boolean) If true, returns settings in flat format. (Default = false)
$params['local'] = (boolean) If true, the request retrieves information from the local node only. Defaults to false, which means information is retrieved from the master node. (Default = false)
$params['master_timeout'] = (string) Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.
$params['pretty'] = (boolean) Whether to pretty format the returned JSON response. (Default = false)
$params['human'] = (boolean) Whether to return human readable values for statistics. (Default = true)
$params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. (Default = false)
$params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
$params['filter_path'] = (any) Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with "-".
Parameters
| $params |
Associative array of parameters
|
|
#
|
public
|
getMapping(array $params = []): array
Returns mappings for one or more indexes.
Returns mappings for one or more indexes.
$params['index'] = (array) Comma-separated list of data streams, indexes, and aliases used to limit the request. Supports wildcards (*). To target all data streams and indexes, omit this parameter or use * or _all.
$params['allow_no_indices'] = (boolean) If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indexes.This behavior applies even if the request targets other open indexes.
$params['cluster_manager_timeout'] = (string) Operation timeout for connection to cluster-manager node.
$params['expand_wildcards'] = (any) Type of index that wildcard patterns can match.If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.Supports comma-separated values, such as open,hidden.Valid values are: all, open, closed, hidden, none.
$params['ignore_unavailable'] = (boolean) If false, the request returns an error if it targets a missing or closed index.
$params['local'] = (boolean) If true, the request retrieves information from the local node only. (Default = false)
$params['master_timeout'] = (string) Period to wait for a connection to the master node.If no response is received before the timeout expires, the request fails and returns an error.
$params['pretty'] = (boolean) Whether to pretty format the returned JSON response. (Default = false)
$params['human'] = (boolean) Whether to return human readable values for statistics. (Default = true)
$params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. (Default = false)
$params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
$params['filter_path'] = (any) Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with "-".
Parameters
| $params |
Associative array of parameters
|
|
#
|
public
|
getSettings(array $params = []): array
Returns settings for one or more indexes.
Returns settings for one or more indexes.
$params['name'] = (array) Comma-separated list or wildcard expression of settings to retrieve.
$params['index'] = (array) Comma-separated list of data streams, indexes, and aliases used to limit the request. Supports wildcards (*). To target all data streams and indexes, omit this parameter or use * or _all.
$params['allow_no_indices'] = (boolean) If false, the request returns an error if any wildcard expression, indexalias, or _all value targets only missing or closed indexes. Thisbehavior applies even if the request targets other open indexes. Forexample, a request targeting foo*,bar* returns an error if an indexstarts with foo but no index starts with bar.
$params['cluster_manager_timeout'] = (string) Operation timeout for connection to cluster-manager node.
$params['expand_wildcards'] = (any) Type of index that wildcard patterns can match.If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.Supports comma-separated values, such as open,hidden.
$params['flat_settings'] = (boolean) If true, returns settings in flat format. (Default = false)
$params['ignore_unavailable'] = (boolean) If false, the request returns an error if it targets a missing or closed index.
$params['include_defaults'] = (boolean) If true, return all default settings in the response. (Default = false)
$params['local'] = (boolean) If true, the request retrieves information from the local node only. Iffalse, information is retrieved from the master node. (Default = false)
$params['master_timeout'] = (string) Period to wait for a connection to the master node. If no response isreceived before the timeout expires, the request fails and returns anerror.
$params['pretty'] = (boolean) Whether to pretty format the returned JSON response. (Default = false)
$params['human'] = (boolean) Whether to return human readable values for statistics. (Default = true)
$params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. (Default = false)
$params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
$params['filter_path'] = (any) Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with "-".
Parameters
| $params |
Associative array of parameters
|
|
#
|
public
|
getTemplate(array $params = []): array
Returns an index template.
Returns an index template.
$params['name'] = (array) Comma-separated list of index template names used to limit the request. Wildcard (*) expressions are supported. To return all index templates, omit this parameter or use a value of _all or *.
$params['cluster_manager_timeout'] = (string) Operation timeout for connection to cluster-manager node.
$params['flat_settings'] = (boolean) If true, returns settings in flat format. (Default = false)
$params['local'] = (boolean) If true, the request retrieves information from the local node only. (Default = false)
$params['master_timeout'] = (string) Period to wait for a connection to the master node.If no response is received before the timeout expires, the request fails and returns an error.
$params['pretty'] = (boolean) Whether to pretty format the returned JSON response. (Default = false)
$params['human'] = (boolean) Whether to return human readable values for statistics. (Default = true)
$params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. (Default = false)
$params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
$params['filter_path'] = (any) Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with "-".
Parameters
| $params |
Associative array of parameters
|
|
#
|
public
|
getUpgrade(array $params = []): array
The _upgrade API is no longer useful and will be removed.
The _upgrade API is no longer useful and will be removed.
$params['index'] = (array) Comma-separated list of indexes; use _all or empty string to perform the operation on all indexes.
$params['allow_no_indices'] = (boolean) Whether to ignore if a wildcard indexes expression resolves into no concrete indexes. (This includes _all string or when no indexes have been specified).
$params['expand_wildcards'] = (any) Whether to expand wildcard expression to concrete indexes that are open, closed or both.
$params['ignore_unavailable'] = (boolean) Whether specified concrete indexes should be ignored when unavailable (missing or closed).
$params['pretty'] = (boolean) Whether to pretty format the returned JSON response. (Default = false)
$params['human'] = (boolean) Whether to return human readable values for statistics. (Default = true)
$params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. (Default = false)
$params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
$params['filter_path'] = (any) Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with "-".
Parameters
| $params |
Associative array of parameters
|
|
#
|
public
|
open(array $params = []): array
Opens an index.
Opens an index.
$params['index'] = (array) Comma-separated list of data streams, indexes, and aliases used to limit the request. Supports wildcards (*). By default, you must explicitly name the indexes you using to limit the request. To limit a request using _all, *, or other wildcard expressions, change the action.destructive_requires_name setting to false. You can update this setting in the opensearch.yml file or using the cluster update settings API.
$params['allow_no_indices'] = (boolean) If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indexes.This behavior applies even if the request targets other open indexes.
$params['cluster_manager_timeout'] = (string) Operation timeout for connection to cluster-manager node.
$params['expand_wildcards'] = (any) Type of index that wildcard patterns can match.If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.Supports comma-separated values, such as open,hidden.Valid values are: all, open, closed, hidden, none.
$params['ignore_unavailable'] = (boolean) If false, the request returns an error if it targets a missing or closed index.
$params['master_timeout'] = (string) Period to wait for a connection to the master node.If no response is received before the timeout expires, the request fails and returns an error.
$params['task_execution_timeout'] = (string) Explicit task execution timeout, only useful when wait_for_completion is false, defaults to 1h.
$params['timeout'] = (string) Period to wait for a response.If no response is received before the timeout expires, the request fails and returns an error.
$params['wait_for_active_shards'] = (any) The number of shard copies that must be active before proceeding with the operation.Set to all or any positive integer up to the total number of shards in the index (number_of_replicas+1).
$params['wait_for_completion'] = (boolean) Should this request wait until the operation has completed before returning. (Default = true)
$params['pretty'] = (boolean) Whether to pretty format the returned JSON response. (Default = false)
$params['human'] = (boolean) Whether to return human readable values for statistics. (Default = true)
$params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. (Default = false)
$params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
$params['filter_path'] = (any) Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with "-".
Parameters
| $params |
Associative array of parameters
|
|
#
|
public
|
putAlias(array $params = []): array
Creates or updates an alias.
Creates or updates an alias.
$params['name'] = (string) Alias to update. If the alias doesn't exist, the request creates it. Index alias names support date math.
$params['index'] = (array) Comma-separated list of data streams or indexes to add. Supports wildcards (*). Wildcard patterns that match both data streams and indexes return an error.
$params['cluster_manager_timeout'] = (string) Operation timeout for connection to cluster-manager node.
$params['master_timeout'] = (string) Period to wait for a connection to the master node.If no response is received before the timeout expires, the request fails and returns an error.
$params['timeout'] = (string) Period to wait for a response.If no response is received before the timeout expires, the request fails and returns an error.
$params['pretty'] = (boolean) Whether to pretty format the returned JSON response. (Default = false)
$params['human'] = (boolean) Whether to return human readable values for statistics. (Default = true)
$params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. (Default = false)
$params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
$params['filter_path'] = (any) Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with "-".
$params['body'] = (array) The settings for the alias, such as routing or filter
Parameters
| $params |
Associative array of parameters
|
|
#
|
public
|
putIndexTemplate(array $params = []): array
Creates or updates an index template.
Creates or updates an index template.
$params['name'] = (string) Index or template name
$params['cause'] = (string) User defined reason for creating/updating the index template. (Default = false)
$params['cluster_manager_timeout'] = (string) Operation timeout for connection to cluster-manager node.
$params['create'] = (boolean) If true, this request cannot replace or update existing index templates. (Default = false)
$params['master_timeout'] = (string) Operation timeout for connection to master node.
$params['pretty'] = (boolean) Whether to pretty format the returned JSON response. (Default = false)
$params['human'] = (boolean) Whether to return human readable values for statistics. (Default = true)
$params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. (Default = false)
$params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
$params['filter_path'] = (any) Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with "-".
$params['body'] = (array) The template definition (Required)
Parameters
| $params |
Associative array of parameters
|
|
#
|
public
|
putMapping(array $params = []): array
Updates the index mappings.
Updates the index mappings.
$params['index'] = (array) 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 indexes.
$params['allow_no_indices'] = (boolean) If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indexes.This behavior applies even if the request targets other open indexes.
$params['cluster_manager_timeout'] = (string) Operation timeout for connection to cluster-manager node.
$params['expand_wildcards'] = (any) Type of index that wildcard patterns can match.If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.Supports comma-separated values, such as open,hidden.Valid values are: all, open, closed, hidden, none.
$params['ignore_unavailable'] = (boolean) If false, the request returns an error if it targets a missing or closed index.
$params['master_timeout'] = (string) Period to wait for a connection to the master node.If no response is received before the timeout expires, the request fails and returns an error.
$params['timeout'] = (string) Period to wait for a response.If no response is received before the timeout expires, the request fails and returns an error.
$params['write_index_only'] = (boolean) If true, the mappings are applied only to the current write index for the target. (Default = false)
$params['pretty'] = (boolean) Whether to pretty format the returned JSON response. (Default = false)
$params['human'] = (boolean) Whether to return human readable values for statistics. (Default = true)
$params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. (Default = false)
$params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
$params['filter_path'] = (any) Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with "-".
$params['body'] = (array) The mapping definition (Required)
Parameters
| $params |
Associative array of parameters
|
|
#
|
public
|
putSettings(array $params = []): array
Updates the index settings.
Updates the index settings.
$params['index'] = (array) Comma-separated list of data streams, indexes, and aliases used to limit the request. Supports wildcards (*). To target all data streams and indexes, omit this parameter or use * or _all.
$params['allow_no_indices'] = (boolean) If false, the request returns an error if any wildcard expression, indexalias, or _all value targets only missing or closed indexes. Thisbehavior applies even if the request targets other open indexes. Forexample, a request targeting foo*,bar* returns an error if an indexstarts with foo but no index starts with bar.
$params['cluster_manager_timeout'] = (string) Operation timeout for connection to cluster-manager node.
$params['expand_wildcards'] = (any) Type of index that wildcard patterns can match. If the request can targetdata streams, this argument determines whether wildcard expressions matchhidden data streams. Supports comma-separated values, such asopen,hidden.
$params['flat_settings'] = (boolean) If true, returns settings in flat format. (Default = false)
$params['ignore_unavailable'] = (boolean) Whether specified concrete indexes should be ignored when unavailable (missing or closed).
$params['master_timeout'] = (string) Period to wait for a connection to the master node. If no response isreceived before the timeout expires, the request fails and returns anerror.
$params['preserve_existing'] = (boolean) If true, existing index settings remain unchanged. (Default = false)
$params['timeout'] = (string) Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.
$params['pretty'] = (boolean) Whether to pretty format the returned JSON response. (Default = false)
$params['human'] = (boolean) Whether to return human readable values for statistics. (Default = true)
$params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. (Default = false)
$params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
$params['filter_path'] = (any) Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with "-".
Parameters
| $params |
Associative array of parameters
|
|
#
|
public
|
putTemplate(array $params = []): array
Creates or updates an index template.
Creates or updates an index template.
$params['name'] = (string) The name of the template
$params['cluster_manager_timeout'] = (string) Operation timeout for connection to cluster-manager node.
$params['create'] = (boolean) If true, this request cannot replace or update existing index templates. (Default = false)
$params['master_timeout'] = (string) Period to wait for a connection to the master node. If no response isreceived before the timeout expires, the request fails and returns an error.
$params['order'] = (number) Order in which OpenSearch applies this template if indexmatches multiple templates.Templates with lower 'order' values are merged first. Templates with higher'order' values are merged later, overriding templates with lower values.
$params['pretty'] = (boolean) Whether to pretty format the returned JSON response. (Default = false)
$params['human'] = (boolean) Whether to return human readable values for statistics. (Default = true)
$params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. (Default = false)
$params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
$params['filter_path'] = (any) Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with "-".
$params['body'] = (array) The template definition (Required)
Parameters
| $params |
Associative array of parameters
|
|
#
|
public
|
recovery(array $params = []): array
Returns information about ongoing index shard recoveries.
Returns information about ongoing index shard recoveries.
$params['index'] = (array) Comma-separated list of data streams, indexes, and aliases used to limit the request. Supports wildcards (*). To target all data streams and indexes, omit this parameter or use * or _all.
$params['active_only'] = (boolean) If true, the response only includes ongoing shard recoveries. (Default = false)
$params['detailed'] = (boolean) If true, the response includes detailed information about shard recoveries. (Default = false)
$params['pretty'] = (boolean) Whether to pretty format the returned JSON response. (Default = false)
$params['human'] = (boolean) Whether to return human readable values for statistics. (Default = true)
$params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. (Default = false)
$params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
$params['filter_path'] = (any) Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with "-".
Parameters
| $params |
Associative array of parameters
|
|
#
|
public
|
refresh(array $params = []): array
Performs the refresh operation in one or more indexes.
Performs the refresh operation in one or more indexes.
$params['index'] = (array) Comma-separated list of data streams, indexes, and aliases used to limit the request. Supports wildcards (*). To target all data streams and indexes, omit this parameter or use * or _all.
$params['allow_no_indices'] = (boolean) If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indexes.This behavior applies even if the request targets other open indexes.
$params['expand_wildcards'] = (any) Type of index that wildcard patterns can match.If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.Supports comma-separated values, such as open,hidden.Valid values are: all, open, closed, hidden, none.
$params['ignore_unavailable'] = (boolean) If false, the request returns an error if it targets a missing or closed index.
$params['pretty'] = (boolean) Whether to pretty format the returned JSON response. (Default = false)
$params['human'] = (boolean) Whether to return human readable values for statistics. (Default = true)
$params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. (Default = false)
$params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
$params['filter_path'] = (any) Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with "-".
Parameters
| $params |
Associative array of parameters
|
|
#
|
public
|
resolveIndex(array $params = []): array
Returns information about any matching indexes, aliases, and data streams.
Returns information about any matching indexes, aliases, and data streams.
$params['name'] = (array) Comma-separated name(s) or index pattern(s) of the indexes, aliases, and data streams to resolve. Resources on remote clusters can be specified using the <cluster>:<name> syntax.
$params['expand_wildcards'] = (any) Type of index that wildcard patterns can match.If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.Supports comma-separated values, such as open,hidden.Valid values are: all, open, closed, hidden, none.
$params['pretty'] = (boolean) Whether to pretty format the returned JSON response. (Default = false)
$params['human'] = (boolean) Whether to return human readable values for statistics. (Default = true)
$params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. (Default = false)
$params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
$params['filter_path'] = (any) Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with "-".
Parameters
| $params |
Associative array of parameters
|
|
#
|
public
|
rollover(array $params = []): array
Updates an alias to point to a new index when the existing indexis considered to be too large or too old.
Updates an alias to point to a new index when the existing indexis considered to be too large or too old.
$params['alias'] = (string) Name of the data stream or index alias to roll over. (Required)
$params['new_index'] = (string) Name of the index to create. Supports date math. Data streams do not support this parameter.
$params['cluster_manager_timeout'] = (string) Operation timeout for connection to cluster-manager node.
$params['dry_run'] = (boolean) If true, checks whether the current index satisfies the specified conditions but does not perform a rollover. (Default = false)
$params['master_timeout'] = (string) Period to wait for a connection to the master node.If no response is received before the timeout expires, the request fails and returns an error.
$params['timeout'] = (string) Period to wait for a response.If no response is received before the timeout expires, the request fails and returns an error.
$params['wait_for_active_shards'] = (any) The number of shard copies that must be active before proceeding with the operation.Set to all or any positive integer up to the total number of shards in the index (number_of_replicas+1).
$params['pretty'] = (boolean) Whether to pretty format the returned JSON response. (Default = false)
$params['human'] = (boolean) Whether to return human readable values for statistics. (Default = true)
$params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. (Default = false)
$params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
$params['filter_path'] = (any) Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with "-".
$params['body'] = (array) The conditions that needs to be met for executing rollover
Parameters
| $params |
Associative array of parameters
|
|
#
|
public
|
segments(array $params = []): array
Provides low-level information about segments in a Lucene index.
Provides low-level information about segments in a Lucene index.
$params['index'] = (array) Comma-separated list of data streams, indexes, and aliases used to limit the request. Supports wildcards (*). To target all data streams and indexes, omit this parameter or use * or _all.
$params['allow_no_indices'] = (boolean) If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indexes.This behavior applies even if the request targets other open indexes.
$params['expand_wildcards'] = (any) Type of index that wildcard patterns can match.If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.Supports comma-separated values, such as open,hidden.Valid values are: all, open, closed, hidden, none.
$params['ignore_unavailable'] = (boolean) If false, the request returns an error if it targets a missing or closed index.
$params['verbose'] = (boolean) If true, the request returns a verbose response. (Default = false)
$params['pretty'] = (boolean) Whether to pretty format the returned JSON response. (Default = false)
$params['human'] = (boolean) Whether to return human readable values for statistics. (Default = true)
$params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. (Default = false)
$params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
$params['filter_path'] = (any) Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with "-".
Parameters
| $params |
Associative array of parameters
|
|
#
|
public
|
shardStores(array $params = []): array
Provides store information for shard copies of indexes.
Provides store information for shard copies of indexes.
$params['index'] = (array) List of data streams, indexes, and aliases used to limit the request.
$params['allow_no_indices'] = (boolean) If false, the request returns an error if any wildcard expression, index alias, or _allvalue targets only missing or closed indexes. This behavior applies even if the requesttargets other open indexes.
$params['expand_wildcards'] = (any) Type of index that wildcard patterns can match. If the request can target data streams,this argument determines whether wildcard expressions match hidden data streams.
$params['ignore_unavailable'] = (boolean) If true, missing or closed indexes are not included in the response.
$params['status'] = (any) List of shard health statuses used to limit the request.
$params['pretty'] = (boolean) Whether to pretty format the returned JSON response. (Default = false)
$params['human'] = (boolean) Whether to return human readable values for statistics. (Default = true)
$params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. (Default = false)
$params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
$params['filter_path'] = (any) Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with "-".
Parameters
| $params |
Associative array of parameters
|
|
#
|
public
|
shrink(array $params = []): array
Allow to shrink an existing index into a new index with fewer primary shards.
Allow to shrink an existing index into a new index with fewer primary shards.
$params['index'] = (string) Name of the source index to shrink.
$params['target'] = (string) Name of the target index to create.
$params['cluster_manager_timeout'] = (string) Operation timeout for connection to cluster-manager node.
$params['copy_settings'] = (boolean) whether or not to copy settings from the source index. (Default = false)
$params['master_timeout'] = (string) Period to wait for a connection to the master node.If no response is received before the timeout expires, the request fails and returns an error.
$params['task_execution_timeout'] = (string) Explicit task execution timeout, only useful when wait_for_completion is false, defaults to 1h.
$params['timeout'] = (string) Period to wait for a response.If no response is received before the timeout expires, the request fails and returns an error.
$params['wait_for_active_shards'] = (any) The number of shard copies that must be active before proceeding with the operation.Set to all or any positive integer up to the total number of shards in the index (number_of_replicas+1).
$params['wait_for_completion'] = (boolean) Should this request wait until the operation has completed before returning. (Default = true)
$params['pretty'] = (boolean) Whether to pretty format the returned JSON response. (Default = false)
$params['human'] = (boolean) Whether to return human readable values for statistics. (Default = true)
$params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. (Default = false)
$params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
$params['filter_path'] = (any) Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with "-".
$params['body'] = (array) The configuration for the target index (settings and aliases)
Parameters
| $params |
Associative array of parameters
|
|
#
|
public
|
simulateIndexTemplate(array $params = []): array
Simulate matching the given index name against the index templates in the system.
Simulate matching the given index name against the index templates in the system.
$params['name'] = (string) Index or template name to simulate
$params['cause'] = (string) User defined reason for dry-run creating the new template for simulation purposes. (Default = false)
$params['cluster_manager_timeout'] = (string) Operation timeout for connection to cluster-manager node.
$params['create'] = (boolean) If true, the template passed in the body is only used if no existingtemplates match the same index patterns. If false, the simulation usesthe template with the highest priority. Note that the template is notpermanently added or updated in either case; it is only used for thesimulation. (Default = false)
$params['master_timeout'] = (string) Period to wait for a connection to the master node. If no response is receivedbefore the timeout expires, the request fails and returns an error.
$params['pretty'] = (boolean) Whether to pretty format the returned JSON response. (Default = false)
$params['human'] = (boolean) Whether to return human readable values for statistics. (Default = true)
$params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. (Default = false)
$params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
$params['filter_path'] = (any) Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with "-".
$params['body'] = (array) New index template definition, which will be included in the simulation, as if it already exists in the system
Parameters
| $params |
Associative array of parameters
|
|
#
|
public
|
simulateTemplate(array $params = []): array
Simulate resolving the given template name or body.
Simulate resolving the given template name or body.
$params['name'] = (string) Name of the index template to simulate. To test a template configuration before you add it to the cluster, omit this parameter and specify the template configuration in the request body.
$params['cause'] = (string) User defined reason for dry-run creating the new template for simulation purposes. (Default = false)
$params['cluster_manager_timeout'] = (string) Operation timeout for connection to cluster-manager node.
$params['create'] = (boolean) If true, the template passed in the body is only used if no existing templates match the same index patterns. If false, the simulation uses the template with the highest priority. Note that the template is not permanently added or updated in either case; it is only used for the simulation. (Default = false)
$params['master_timeout'] = (string) Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.
$params['pretty'] = (boolean) Whether to pretty format the returned JSON response. (Default = false)
$params['human'] = (boolean) Whether to return human readable values for statistics. (Default = true)
$params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. (Default = false)
$params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
$params['filter_path'] = (any) Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with "-".
Parameters
| $params |
Associative array of parameters
|
|
#
|
public
|
split(array $params = []): array
Allows you to split an existing index into a new index with more primary shards.
Allows you to split an existing index into a new index with more primary shards.
$params['index'] = (string) Name of the source index to split.
$params['target'] = (string) Name of the target index to create.
$params['cluster_manager_timeout'] = (string) Operation timeout for connection to cluster-manager node.
$params['copy_settings'] = (boolean) whether or not to copy settings from the source index. (Default = false)
$params['master_timeout'] = (string) Period to wait for a connection to the master node.If no response is received before the timeout expires, the request fails and returns an error.
$params['task_execution_timeout'] = (string) Explicit task execution timeout, only useful when wait_for_completion is false, defaults to 1h.
$params['timeout'] = (string) Period to wait for a response.If no response is received before the timeout expires, the request fails and returns an error.
$params['wait_for_active_shards'] = (any) The number of shard copies that must be active before proceeding with the operation.Set to all or any positive integer up to the total number of shards in the index (number_of_replicas+1).
$params['wait_for_completion'] = (boolean) Should this request wait until the operation has completed before returning. (Default = true)
$params['pretty'] = (boolean) Whether to pretty format the returned JSON response. (Default = false)
$params['human'] = (boolean) Whether to return human readable values for statistics. (Default = true)
$params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. (Default = false)
$params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
$params['filter_path'] = (any) Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with "-".
$params['body'] = (array) The configuration for the target index (settings and aliases)
Parameters
| $params |
Associative array of parameters
|
|
#
|
public
|
stats(array $params = []): array
Provides statistics on operations happening in an index.
Provides statistics on operations happening in an index.
$params['metric'] = (array) Limit the information returned the specific metrics.
$params['index'] = (array) A comma-separated list of index names; use _all or empty string to perform the operation on all indexes
$params['completion_fields'] = (any) Comma-separated list or wildcard expressions of fields to include in fielddata and suggest statistics.
$params['expand_wildcards'] = (any) Type of index that wildcard patterns can match. If the request can target data streams, this argumentdetermines whether wildcard expressions match hidden data streams. Supports comma-separated values,such as open,hidden.
$params['fielddata_fields'] = (any) Comma-separated list or wildcard expressions of fields to include in fielddata statistics.
$params['fields'] = (any) Comma-separated list or wildcard expressions of fields to include in the statistics.
$params['forbid_closed_indices'] = (boolean) If true, statistics are not collected from closed indexes. (Default = true)
$params['groups'] = (any) Comma-separated list of search groups to include in the search statistics.
$params['include_segment_file_sizes'] = (boolean) If true, the call reports the aggregated disk usage of each one of the Lucene index files (only applies if segment stats are requested). (Default = false)
$params['include_unloaded_segments'] = (boolean) If true, the response includes information from segments that are not loaded into memory. (Default = false)
$params['level'] = (enum) Indicates whether statistics are aggregated at the cluster, index, or shard level. (Options = cluster,indices,shards)
$params['pretty'] = (boolean) Whether to pretty format the returned JSON response. (Default = false)
$params['human'] = (boolean) Whether to return human readable values for statistics. (Default = true)
$params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. (Default = false)
$params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
$params['filter_path'] = (any) Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with "-".
Parameters
| $params |
Associative array of parameters
|
|
#
|
public
|
updateAliases(array $params = []): array
Updates index aliases.
Updates index aliases.
$params['cluster_manager_timeout'] = (string) Operation timeout for connection to cluster-manager node.
$params['master_timeout'] = (string) Period to wait for a connection to the master node.If no response is received before the timeout expires, the request fails and returns an error.
$params['timeout'] = (string) Period to wait for a response.If no response is received before the timeout expires, the request fails and returns an error.
$params['pretty'] = (boolean) Whether to pretty format the returned JSON response. (Default = false)
$params['human'] = (boolean) Whether to return human readable values for statistics. (Default = true)
$params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. (Default = false)
$params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
$params['filter_path'] = (any) Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with "-".
$params['body'] = (array) The definition of actions to perform (Required)
Parameters
| $params |
Associative array of parameters
|
|
#
|
public
|
upgrade(array $params = []): array
The _upgrade API is no longer useful and will be removed.
The _upgrade API is no longer useful and will be removed.
$params['index'] = (array) Comma-separated list of indexes; use _all or empty string to perform the operation on all indexes.
$params['allow_no_indices'] = (boolean) Whether to ignore if a wildcard indexes expression resolves into no concrete indexes. (This includes _all string or when no indexes have been specified).
$params['expand_wildcards'] = (any) Whether to expand wildcard expression to concrete indexes that are open, closed or both.
$params['ignore_unavailable'] = (boolean) Whether specified concrete indexes should be ignored when unavailable (missing or closed).
$params['only_ancient_segments'] = (boolean) If true, only ancient (an older Lucene major release) segments will be upgraded.
$params['wait_for_completion'] = (boolean) Should this request wait until the operation has completed before returning. (Default = false)
$params['pretty'] = (boolean) Whether to pretty format the returned JSON response. (Default = false)
$params['human'] = (boolean) Whether to return human readable values for statistics. (Default = true)
$params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. (Default = false)
$params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
$params['filter_path'] = (any) Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with "-".
Parameters
| $params |
Associative array of parameters
|
|
#
|
public
|
validateQuery(array $params = []): array
Allows a user to validate a potentially expensive query without executing it.
Allows a user to validate a potentially expensive query without executing it.
$params['index'] = (array) Comma-separated list of data streams, indexes, and aliases to search. Supports wildcards (*). To search all data streams or indexes, omit this parameter or use * or _all.
$params['all_shards'] = (boolean) If true, the validation is executed on all shards instead of one random shard per index.
$params['allow_no_indices'] = (boolean) If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indexes.This behavior applies even if the request targets other open indexes.
$params['analyze_wildcard'] = (boolean) If true, wildcard and prefix queries are analyzed. (Default = false)
$params['analyzer'] = (string) Analyzer to use for the query string.This parameter can only be used when the q query string parameter is specified.
$params['default_operator'] = (enum) The default operator for query string query: AND or OR. (Options = and,or)
$params['df'] = (string) Field to use as default where no field prefix is given in the query string.This parameter can only be used when the q query string parameter is specified.
$params['expand_wildcards'] = (any) Type of index that wildcard patterns can match.If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.Supports comma-separated values, such as open,hidden.Valid values are: all, open, closed, hidden, none.
$params['explain'] = (boolean) If true, the response returns detailed information if an error has occurred.
$params['ignore_unavailable'] = (boolean) If false, the request returns an error if it targets a missing or closed index.
$params['lenient'] = (boolean) If true, format-based query failures (such as providing text to a numeric field) in the query string will be ignored.
$params['q'] = (string) Query in the Lucene query string syntax.
$params['rewrite'] = (boolean) If true, returns a more detailed explanation showing the actual Lucene query that will be executed.
$params['pretty'] = (boolean) Whether to pretty format the returned JSON response. (Default = false)
$params['human'] = (boolean) Whether to return human readable values for statistics. (Default = true)
$params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. (Default = false)
$params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
$params['filter_path'] = (any) Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with "-".
$params['body'] = (array) The query definition specified with the Query DSL
Parameters
| $params |
Associative array of parameters
|
|
#
|
public
|
getAliases(array $params = [])
Alias function to getAlias()
Alias function to getAlias()
Deprecated
added to prevent BC break introduced in 7.2.0
|
#
|
public
|
refreshSearchAnalyzers(array $params = []): array
$params['index'] = (list) A comma-separated list of index names to refresh analyzers for
$params['index'] = (list) A comma-separated list of index names to refresh analyzers for
Parameters
| $params |
Associative array of parameters
|
|
#
|