- Ruby Client: other versions:
- Overview
- Installation
- Connecting
- Configuration
- Integrations
- Examples
- Release Notes
- 8.5 Release notes
- 8.4 Release notes
- 8.3 Release notes
- 8.2 Release notes
- 8.1 Release notes
- 8.0 Release notes
- 7.17 Release notes
- 7.16 Release notes
- 7.15 Release notes
- 7.14 Release notes
- 7.13 Release notes
- 7.12 Release notes
- 7.11 Release notes
- 7.10 Release notes
- 7.9 Release notes
- 7.8 Release notes
- 7.7 Release notes
- 7.6 Release notes
- 7.5 Release notes
- 7.0 Release notes
IMPORTANT: No additional bug fixes or documentation updates
will be released for this version. For the latest information, see the
current release documentation.
8.4 Release notes
edit8.4 Release notes
edit8.4.0 Release notes
edit- Tested versions of Ruby for 8.4.0: Ruby (MRI) 2.7, 3.0 and 3.1, JRuby 9.3.
API
editNew APIs
edit-
security.update_api_key
- Updates attributes of an existing API key. Documentation.
API Changes
edit-
get
- Adds new parameterforce_synthetic_source
(Boolean) Should this request force synthetic _source? Use this to test if the mapping supports synthetic _source and to get a sense of the worst case performance. Fetches with this enabled will be slower the enabling synthetic source natively in the index. -
machine_learning.start_trained_model_deployment
- Adds new parametercache_size
(String) A byte-size value for configuring the inference cache size. For example, 20mb. -
mget
- Adds new parameterforce_synthetic_source
(Boolean) Should this request force synthetic _source? Use this to test if the mapping supports synthetic _source and to get a sense of the worst case performance. Fetches with this enabled will be slower the enabling synthetic source natively in the index. -
search
- Adds new parameterforce_synthetic_source
(Boolean) Should this request force synthetic _source? Use this to test if the mapping supports synthetic _source and to get a sense of the worst case performance. Fetches with this enabled will be slower the enabling synthetic source natively in the index. -
snapshot.get
- Adds new parameters:-
sort
(String) Allows setting a sort order for the result. Defaults to start_time (options: start_time, duration, name, repository, index_count, shard_count, failed_shard_count). -
size
(Integer) Maximum number of snapshots to return. Defaults to 0 which means return all that match without limit. -
order
(String) Sort order (options: asc, desc). -
from_sort_value
(String) Value of the current sort column at which to start retrieval. -
after
(String) Offset identifier to start pagination from as returned by the next field in the response body. -
offset
(Integer) Numeric offset to start pagination based on the snapshots matching the request. Defaults to 0. -
slm_policy_filter
(String) Filter snapshots by a comma-separated list of SLM policy names that snapshots belong to. Accepts wildcards. Use the special pattern _none to match snapshots without an SLM policy.
-
On this page
Was this helpful?
Thank you for your feedback.