elasticsearch-api 9.2.0 → 9.3.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/elasticsearch-api.gemspec +1 -0
- data/lib/elasticsearch/api/actions/async_search/submit.rb +13 -18
- data/lib/elasticsearch/api/actions/bulk.rb +2 -1
- data/lib/elasticsearch/api/actions/cat/aliases.rb +1 -1
- data/lib/elasticsearch/api/actions/cat/circuit_breaker.rb +96 -0
- data/lib/elasticsearch/api/actions/cat/count.rb +8 -10
- data/lib/elasticsearch/api/actions/cat/indices.rb +1 -1
- data/lib/elasticsearch/api/actions/cat/segments.rb +10 -0
- data/lib/elasticsearch/api/actions/cat/tasks.rb +3 -4
- data/lib/elasticsearch/api/actions/cluster/get_component_template.rb +2 -3
- data/lib/elasticsearch/api/actions/cluster/health.rb +25 -12
- data/lib/elasticsearch/api/actions/cluster/put_settings.rb +3 -3
- data/lib/elasticsearch/api/actions/cluster/reroute.rb +1 -1
- data/lib/elasticsearch/api/actions/cluster/state.rb +6 -5
- data/lib/elasticsearch/api/actions/connector/check_in.rb +3 -4
- data/lib/elasticsearch/api/actions/connector/sync_job_check_in.rb +3 -4
- data/lib/elasticsearch/api/actions/connector/sync_job_claim.rb +3 -4
- data/lib/elasticsearch/api/actions/connector/sync_job_error.rb +3 -4
- data/lib/elasticsearch/api/actions/connector/sync_job_update_stats.rb +3 -4
- data/lib/elasticsearch/api/actions/connector/update_active_filtering.rb +3 -4
- data/lib/elasticsearch/api/actions/connector/update_error.rb +3 -4
- data/lib/elasticsearch/api/actions/connector/update_features.rb +3 -4
- data/lib/elasticsearch/api/actions/connector/update_filtering_validation.rb +3 -4
- data/lib/elasticsearch/api/actions/connector/update_status.rb +3 -4
- data/lib/elasticsearch/api/actions/count.rb +1 -9
- data/lib/elasticsearch/api/actions/create.rb +1 -1
- data/lib/elasticsearch/api/actions/cross_cluster_replication/forget_follower.rb +1 -1
- data/lib/elasticsearch/api/actions/cross_cluster_replication/resume_follow.rb +1 -1
- data/lib/elasticsearch/api/actions/dangling_indices/delete_dangling_index.rb +3 -3
- data/lib/elasticsearch/api/actions/dangling_indices/import_dangling_index.rb +3 -3
- data/lib/elasticsearch/api/actions/delete.rb +1 -1
- data/lib/elasticsearch/api/actions/delete_by_query.rb +1 -1
- data/lib/elasticsearch/api/actions/delete_by_query_rethrottle.rb +1 -1
- data/lib/elasticsearch/api/actions/eql/search.rb +3 -10
- data/lib/elasticsearch/api/actions/esql/delete_view.rb +75 -0
- data/lib/elasticsearch/api/actions/esql/get_query.rb +3 -4
- data/lib/elasticsearch/api/actions/esql/get_view.rb +77 -0
- data/lib/elasticsearch/api/actions/esql/list_queries.rb +3 -4
- data/lib/elasticsearch/api/actions/esql/put_view.rb +76 -0
- data/lib/elasticsearch/api/actions/exists.rb +1 -1
- data/lib/elasticsearch/api/actions/exists_source.rb +1 -1
- data/lib/elasticsearch/api/actions/explain.rb +1 -1
- data/lib/elasticsearch/api/actions/features/reset_features.rb +3 -4
- data/lib/elasticsearch/api/actions/field_caps.rb +1 -9
- data/lib/elasticsearch/api/actions/fleet/msearch.rb +3 -4
- data/lib/elasticsearch/api/actions/fleet/search.rb +4 -5
- data/lib/elasticsearch/api/actions/get.rb +1 -1
- data/lib/elasticsearch/api/actions/get_source.rb +1 -1
- data/lib/elasticsearch/api/actions/graph/explore.rb +1 -1
- data/lib/elasticsearch/api/actions/index.rb +4 -1
- data/lib/elasticsearch/api/actions/indices/add_block.rb +1 -1
- data/lib/elasticsearch/api/actions/indices/cancel_migrate_reindex.rb +0 -4
- data/lib/elasticsearch/api/actions/indices/create_from.rb +0 -4
- data/lib/elasticsearch/api/actions/indices/data_streams_stats.rb +2 -2
- data/lib/elasticsearch/api/actions/indices/delete.rb +1 -1
- data/lib/elasticsearch/api/actions/indices/delete_data_lifecycle.rb +5 -4
- data/lib/elasticsearch/api/actions/indices/delete_data_stream_options.rb +5 -4
- data/lib/elasticsearch/api/actions/indices/delete_sample_configuration.rb +80 -0
- data/lib/elasticsearch/api/actions/indices/disk_usage.rb +3 -4
- data/lib/elasticsearch/api/actions/indices/downsample.rb +8 -6
- data/lib/elasticsearch/api/actions/indices/exists_alias.rb +1 -1
- data/lib/elasticsearch/api/actions/indices/explain_data_lifecycle.rb +3 -3
- data/lib/elasticsearch/api/actions/indices/field_usage_stats.rb +4 -5
- data/lib/elasticsearch/api/actions/indices/forcemerge.rb +5 -4
- data/lib/elasticsearch/api/actions/indices/get_alias.rb +1 -1
- data/lib/elasticsearch/api/actions/indices/get_all_sample_configuration.rb +68 -0
- data/lib/elasticsearch/api/actions/indices/get_index_template.rb +1 -1
- data/lib/elasticsearch/api/actions/indices/get_migrate_reindex_status.rb +0 -4
- data/lib/elasticsearch/api/actions/indices/get_sample.rb +74 -0
- data/lib/elasticsearch/api/actions/indices/get_sample_configuration.rb +78 -0
- data/lib/elasticsearch/api/actions/indices/get_sample_stats.rb +74 -0
- data/lib/elasticsearch/api/actions/indices/migrate_reindex.rb +0 -4
- data/lib/elasticsearch/api/actions/indices/open.rb +1 -1
- data/lib/elasticsearch/api/actions/indices/promote_data_stream.rb +1 -1
- data/lib/elasticsearch/api/actions/indices/put_index_template.rb +1 -1
- data/lib/elasticsearch/api/actions/indices/put_mapping.rb +2 -1
- data/lib/elasticsearch/api/actions/indices/put_sample_configuration.rb +82 -0
- data/lib/elasticsearch/api/actions/indices/put_template.rb +1 -1
- data/lib/elasticsearch/api/actions/indices/reload_search_analyzers.rb +3 -2
- data/lib/elasticsearch/api/actions/indices/remove_block.rb +1 -1
- data/lib/elasticsearch/api/actions/indices/resolve_index.rb +8 -10
- data/lib/elasticsearch/api/actions/indices/stats.rb +2 -2
- data/lib/elasticsearch/api/actions/inference/chat_completion_unified.rb +3 -3
- data/lib/elasticsearch/api/actions/inference/completion.rb +5 -1
- data/lib/elasticsearch/api/actions/inference/delete.rb +3 -2
- data/lib/elasticsearch/api/actions/inference/get.rb +2 -1
- data/lib/elasticsearch/api/actions/inference/put.rb +5 -2
- data/lib/elasticsearch/api/actions/inference/put_groq.rb +79 -0
- data/lib/elasticsearch/api/actions/inference/put_nvidia.rb +84 -0
- data/lib/elasticsearch/api/actions/inference/put_openshift_ai.rb +84 -0
- data/lib/elasticsearch/api/actions/inference/rerank.rb +1 -1
- data/lib/elasticsearch/api/actions/inference/sparse_embedding.rb +1 -1
- data/lib/elasticsearch/api/actions/inference/stream_completion.rb +1 -1
- data/lib/elasticsearch/api/actions/inference/text_embedding.rb +1 -1
- data/lib/elasticsearch/api/actions/ingest/get_pipeline.rb +1 -1
- data/lib/elasticsearch/api/actions/license/post_start_basic.rb +1 -1
- data/lib/elasticsearch/api/actions/license/post_start_trial.rb +2 -2
- data/lib/elasticsearch/api/actions/machine_learning/start_data_frame_analytics.rb +2 -1
- data/lib/elasticsearch/api/actions/machine_learning/start_trained_model_deployment.rb +1 -1
- data/lib/elasticsearch/api/actions/machine_learning/stop_data_frame_analytics.rb +2 -1
- data/lib/elasticsearch/api/actions/machine_learning/stop_datafeed.rb +1 -0
- data/lib/elasticsearch/api/actions/machine_learning/stop_trained_model_deployment.rb +2 -1
- data/lib/elasticsearch/api/actions/mget.rb +1 -1
- data/lib/elasticsearch/api/actions/msearch.rb +2 -2
- data/lib/elasticsearch/api/actions/mtermvectors.rb +1 -1
- data/lib/elasticsearch/api/actions/nodes/clear_repositories_metering_archive.rb +3 -4
- data/lib/elasticsearch/api/actions/nodes/get_repositories_metering_info.rb +3 -4
- data/lib/elasticsearch/api/actions/nodes/hot_threads.rb +1 -1
- data/lib/elasticsearch/api/actions/nodes/stats.rb +1 -1
- data/lib/elasticsearch/api/actions/nodes/usage.rb +3 -2
- data/lib/elasticsearch/api/actions/open_point_in_time.rb +1 -9
- data/lib/elasticsearch/api/actions/project/tags.rb +8 -6
- data/lib/elasticsearch/api/actions/rank_eval.rb +1 -1
- data/lib/elasticsearch/api/actions/reindex.rb +2 -1
- data/lib/elasticsearch/api/actions/reindex_rethrottle.rb +1 -1
- data/lib/elasticsearch/api/actions/scripts_painless_execute.rb +3 -4
- data/lib/elasticsearch/api/actions/search.rb +1 -9
- data/lib/elasticsearch/api/actions/search_application/delete_behavioral_analytics.rb +3 -4
- data/lib/elasticsearch/api/actions/search_application/get_behavioral_analytics.rb +3 -4
- data/lib/elasticsearch/api/actions/search_application/post_behavioral_analytics_event.rb +3 -4
- data/lib/elasticsearch/api/actions/search_application/put_behavioral_analytics.rb +3 -4
- data/lib/elasticsearch/api/actions/search_application/render_query.rb +3 -4
- data/lib/elasticsearch/api/actions/search_mvt.rb +12 -5
- data/lib/elasticsearch/api/actions/search_shards.rb +1 -1
- data/lib/elasticsearch/api/actions/search_template.rb +2 -2
- data/lib/elasticsearch/api/actions/searchable_snapshots/cache_stats.rb +3 -4
- data/lib/elasticsearch/api/actions/searchable_snapshots/clear_cache.rb +6 -6
- data/lib/elasticsearch/api/actions/security/clear_cached_privileges.rb +1 -1
- data/lib/elasticsearch/api/actions/security/create_service_token.rb +1 -1
- data/lib/elasticsearch/api/actions/security/delete_service_token.rb +1 -1
- data/lib/elasticsearch/api/actions/simulate/ingest.rb +3 -4
- data/lib/elasticsearch/api/actions/snapshot/delete.rb +1 -1
- data/lib/elasticsearch/api/actions/snapshot/repository_verify_integrity.rb +3 -4
- data/lib/elasticsearch/api/actions/snapshot_lifecycle_management/get_lifecycle.rb +1 -1
- data/lib/elasticsearch/api/actions/sql/query.rb +0 -8
- data/lib/elasticsearch/api/actions/streams/logs_disable.rb +3 -4
- data/lib/elasticsearch/api/actions/streams/logs_enable.rb +3 -4
- data/lib/elasticsearch/api/actions/streams/status.rb +3 -4
- data/lib/elasticsearch/api/actions/tasks/cancel.rb +3 -4
- data/lib/elasticsearch/api/actions/tasks/get.rb +3 -4
- data/lib/elasticsearch/api/actions/tasks/list.rb +3 -4
- data/lib/elasticsearch/api/actions/terms_enum.rb +1 -1
- data/lib/elasticsearch/api/actions/termvectors.rb +1 -1
- data/lib/elasticsearch/api/actions/text_structure/find_field_structure.rb +1 -1
- data/lib/elasticsearch/api/actions/text_structure/find_message_structure.rb +1 -1
- data/lib/elasticsearch/api/actions/text_structure/find_structure.rb +1 -1
- data/lib/elasticsearch/api/actions/transform/get_node_stats.rb +15 -3
- data/lib/elasticsearch/api/actions/transform/get_transform_stats.rb +1 -1
- data/lib/elasticsearch/api/actions/update.rb +1 -1
- data/lib/elasticsearch/api/actions/update_by_query.rb +2 -2
- data/lib/elasticsearch/api/actions/update_by_query_rethrottle.rb +1 -1
- data/lib/elasticsearch/api/actions/watcher/put_watch.rb +2 -2
- data/lib/elasticsearch/api/actions/xpack/info.rb +1 -1
- data/lib/elasticsearch/api/utils.rb +0 -4
- data/lib/elasticsearch/api/version.rb +2 -2
- data/lib/elasticsearch/api.rb +1 -0
- metadata +29 -2
|
@@ -25,10 +25,11 @@ module Elasticsearch
|
|
|
25
25
|
# Delete data stream lifecycles.
|
|
26
26
|
# Removes the data stream lifecycle from a data stream, rendering it not managed by the data stream lifecycle.
|
|
27
27
|
#
|
|
28
|
-
# @option arguments [String, Array<String>] :name A comma-separated list of data streams of which the data stream lifecycle will be deleted
|
|
29
|
-
#
|
|
30
|
-
# @option arguments [
|
|
31
|
-
# @option arguments [Time] :
|
|
28
|
+
# @option arguments [String, Array<String>] :name A comma-separated list of data streams of which the data stream lifecycle will be deleted.
|
|
29
|
+
# Use `*` to get all data streams (*Required*)
|
|
30
|
+
# @option arguments [String, Array<String>] :expand_wildcards Whether wildcard expressions should get expanded to open or closed indices (default: open) Server default: open.
|
|
31
|
+
# @option arguments [Time] :master_timeout The period to wait for a connection to the master node. Server default: 30s.
|
|
32
|
+
# @option arguments [Time] :timeout The period to wait for a response. Server default: 30s.
|
|
32
33
|
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
|
|
33
34
|
# when they occur.
|
|
34
35
|
# @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
|
|
@@ -25,10 +25,11 @@ module Elasticsearch
|
|
|
25
25
|
# Delete data stream options.
|
|
26
26
|
# Removes the data stream options from a data stream.
|
|
27
27
|
#
|
|
28
|
-
# @option arguments [String, Array<String>] :name A comma-separated list of data streams of which the data stream options will be deleted
|
|
29
|
-
#
|
|
30
|
-
# @option arguments [
|
|
31
|
-
# @option arguments [Time] :
|
|
28
|
+
# @option arguments [String, Array<String>] :name A comma-separated list of data streams of which the data stream options will be deleted.
|
|
29
|
+
# Use `*` to get all data streams (*Required*)
|
|
30
|
+
# @option arguments [String, Array<String>] :expand_wildcards Whether wildcard expressions should get expanded to open or closed indices Server default: open.
|
|
31
|
+
# @option arguments [Time] :master_timeout The period to wait for a connection to the master node. Server default: 30s.
|
|
32
|
+
# @option arguments [Time] :timeout The period to wait for a response. Server default: 30s.
|
|
32
33
|
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
|
|
33
34
|
# when they occur.
|
|
34
35
|
# @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
|
|
@@ -0,0 +1,80 @@
|
|
|
1
|
+
# Licensed to Elasticsearch B.V. under one or more contributor
|
|
2
|
+
# license agreements. See the NOTICE file distributed with
|
|
3
|
+
# this work for additional information regarding copyright
|
|
4
|
+
# ownership. Elasticsearch B.V. licenses this file to you under
|
|
5
|
+
# the Apache License, Version 2.0 (the "License"); you may
|
|
6
|
+
# not use this file except in compliance with the License.
|
|
7
|
+
# You may obtain a copy of the License at
|
|
8
|
+
#
|
|
9
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
|
10
|
+
#
|
|
11
|
+
# Unless required by applicable law or agreed to in writing,
|
|
12
|
+
# software distributed under the License is distributed on an
|
|
13
|
+
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
|
|
14
|
+
# KIND, either express or implied. See the License for the
|
|
15
|
+
# specific language governing permissions and limitations
|
|
16
|
+
# under the License.
|
|
17
|
+
#
|
|
18
|
+
# This code was automatically generated from the Elasticsearch Specification
|
|
19
|
+
# See https://github.com/elastic/elasticsearch-specification
|
|
20
|
+
# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash.
|
|
21
|
+
module Elasticsearch
|
|
22
|
+
module API
|
|
23
|
+
module Indices
|
|
24
|
+
module Actions
|
|
25
|
+
# Delete sampling configuration.
|
|
26
|
+
# Delete the sampling configuration for the specified index.
|
|
27
|
+
# This functionality is in technical preview and may be changed or removed in a future
|
|
28
|
+
# release. Elastic will apply best effort to fix any issues, but features in technical
|
|
29
|
+
# preview are not subject to the support SLA of official GA features.
|
|
30
|
+
#
|
|
31
|
+
# @option arguments [String] :index The name of the index. (*Required*)
|
|
32
|
+
# @option arguments [Time] :master_timeout Period to wait for a connection to the master node. If no response is
|
|
33
|
+
# received before the timeout expires, the request fails and returns an
|
|
34
|
+
# error. Server default: 30s.
|
|
35
|
+
# @option arguments [Time] :timeout Period to wait for a response.
|
|
36
|
+
# If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s.
|
|
37
|
+
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
|
|
38
|
+
# when they occur.
|
|
39
|
+
# @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
|
|
40
|
+
# returned by Elasticsearch.
|
|
41
|
+
# @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
|
|
42
|
+
# For example `"exists_time": "1h"` for humans and
|
|
43
|
+
# `"exists_time_in_millis": 3600000` for computers. When disabled the human
|
|
44
|
+
# readable values will be omitted. This makes sense for responses being consumed
|
|
45
|
+
# only by machines.
|
|
46
|
+
# @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
|
|
47
|
+
# this option for debugging only.
|
|
48
|
+
# @option arguments [Hash] :headers Custom HTTP headers
|
|
49
|
+
#
|
|
50
|
+
# @see https://www.elastic.co/docs/api/doc/elasticsearch#TODO
|
|
51
|
+
#
|
|
52
|
+
def delete_sample_configuration(arguments = {})
|
|
53
|
+
request_opts = { endpoint: arguments[:endpoint] || 'indices.delete_sample_configuration' }
|
|
54
|
+
|
|
55
|
+
defined_params = [:index].each_with_object({}) do |variable, set_variables|
|
|
56
|
+
set_variables[variable] = arguments[variable] if arguments.key?(variable)
|
|
57
|
+
end
|
|
58
|
+
request_opts[:defined_params] = defined_params unless defined_params.empty?
|
|
59
|
+
|
|
60
|
+
raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
|
|
61
|
+
|
|
62
|
+
arguments = arguments.clone
|
|
63
|
+
headers = arguments.delete(:headers) || {}
|
|
64
|
+
|
|
65
|
+
body = nil
|
|
66
|
+
|
|
67
|
+
_index = arguments.delete(:index)
|
|
68
|
+
|
|
69
|
+
method = Elasticsearch::API::HTTP_DELETE
|
|
70
|
+
path = "#{Utils.listify(_index)}/_sample/config"
|
|
71
|
+
params = Utils.process_params(arguments)
|
|
72
|
+
|
|
73
|
+
Elasticsearch::API::Response.new(
|
|
74
|
+
perform_request(method, path, params, body, headers, request_opts)
|
|
75
|
+
)
|
|
76
|
+
end
|
|
77
|
+
end
|
|
78
|
+
end
|
|
79
|
+
end
|
|
80
|
+
end
|
|
@@ -30,10 +30,9 @@ module Elasticsearch
|
|
|
30
30
|
# Since stored fields are stored together in a compressed format, the sizes of stored fields are also estimates and can be inaccurate.
|
|
31
31
|
# The stored size of the `_id` field is likely underestimated while the `_source` field is overestimated.
|
|
32
32
|
# For usage examples see the External documentation or refer to {https://www.elastic.co/docs/reference/elasticsearch/rest-apis/index-disk-usage Analyze the index disk usage example} for an example.
|
|
33
|
-
# This functionality is
|
|
34
|
-
#
|
|
35
|
-
#
|
|
36
|
-
# support SLA of official GA features.
|
|
33
|
+
# This functionality is in technical preview and may be changed or removed in a future
|
|
34
|
+
# release. Elastic will apply best effort to fix any issues, but features in technical
|
|
35
|
+
# preview are not subject to the support SLA of official GA features.
|
|
37
36
|
#
|
|
38
37
|
# @option arguments [String, Array] :index Comma-separated list of data streams, indices, and aliases used to limit the request.
|
|
39
38
|
# It’s recommended to execute this API with a single index (or the latest backing index of a data stream) as the API consumes resources significantly. (*Required*)
|
|
@@ -23,16 +23,18 @@ module Elasticsearch
|
|
|
23
23
|
module Indices
|
|
24
24
|
module Actions
|
|
25
25
|
# Downsample an index.
|
|
26
|
-
#
|
|
26
|
+
# Downsamples a time series (TSDS) index and reduces its size by keeping the last value or by pre-aggregating metrics:
|
|
27
|
+
# - When running in `aggregate` mode, it pre-calculates and stores statistical summaries (`min`, `max`, `sum`, `value_count` and `avg`)
|
|
28
|
+
# for each metric field grouped by a configured time interval and their dimensions.
|
|
29
|
+
# - When running in `last_value` mode, it keeps the last value for each metric in the configured interval and their dimensions.
|
|
27
30
|
# For example, a TSDS index that contains metrics sampled every 10 seconds can be downsampled to an hourly index.
|
|
28
31
|
# All documents within an hour interval are summarized and stored as a single document in the downsample index.
|
|
29
32
|
# NOTE: Only indices in a time series data stream are supported.
|
|
30
33
|
# Neither field nor document level security can be defined on the source index.
|
|
31
|
-
# The source index must be read
|
|
32
|
-
# This functionality is
|
|
33
|
-
#
|
|
34
|
-
#
|
|
35
|
-
# support SLA of official GA features.
|
|
34
|
+
# The source index must be read-only (`index.blocks.write: true`).
|
|
35
|
+
# This functionality is in technical preview and may be changed or removed in a future
|
|
36
|
+
# release. Elastic will apply best effort to fix any issues, but features in technical
|
|
37
|
+
# preview are not subject to the support SLA of official GA features.
|
|
36
38
|
#
|
|
37
39
|
# @option arguments [String] :index Name of the time series index to downsample. (*Required*)
|
|
38
40
|
# @option arguments [String] :target_index Name of the index to create. (*Required*)
|
|
@@ -32,7 +32,7 @@ module Elasticsearch
|
|
|
32
32
|
# This behavior applies even if the request targets other open indices. Server default: true.
|
|
33
33
|
# @option arguments [String, Array<String>] :expand_wildcards Type of index that wildcard patterns can match.
|
|
34
34
|
# If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
|
|
35
|
-
# Supports comma-separated values, such as `open,hidden`. Server default:
|
|
35
|
+
# Supports comma-separated values, such as `open,hidden`. Server default: all.
|
|
36
36
|
# @option arguments [Boolean] :ignore_unavailable If `false`, requests that include a missing data stream or index in the target indices or data streams return an error.
|
|
37
37
|
# @option arguments [Time] :master_timeout Period to wait for a connection to the master node.
|
|
38
38
|
# If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s.
|
|
@@ -25,9 +25,9 @@ module Elasticsearch
|
|
|
25
25
|
# Get the status for a data stream lifecycle.
|
|
26
26
|
# Get information about an index or data stream's current data stream lifecycle status, such as time since index creation, time since rollover, the lifecycle configuration managing the index, or any errors encountered during lifecycle execution.
|
|
27
27
|
#
|
|
28
|
-
# @option arguments [String, Array] :index
|
|
29
|
-
# @option arguments [Boolean] :include_defaults
|
|
30
|
-
# @option arguments [Time] :master_timeout
|
|
28
|
+
# @option arguments [String, Array] :index Comma-separated list of index names to explain (*Required*)
|
|
29
|
+
# @option arguments [Boolean] :include_defaults Indicates if the API should return the default values the system uses for the index's lifecycle
|
|
30
|
+
# @option arguments [Time] :master_timeout The period to wait for a connection to the master node. Server default: 30s.
|
|
31
31
|
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
|
|
32
32
|
# when they occur.
|
|
33
33
|
# @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
|
|
@@ -28,10 +28,9 @@ module Elasticsearch
|
|
|
28
28
|
# A shard-level search request that accesses a given field, even if multiple times during that request, is counted as a single use.
|
|
29
29
|
# The response body reports the per-shard usage count of the data structures that back the fields in the index.
|
|
30
30
|
# A given request will increment each count by a maximum value of 1, even if the request accesses the same field multiple times.
|
|
31
|
-
# This functionality is
|
|
32
|
-
#
|
|
33
|
-
#
|
|
34
|
-
# support SLA of official GA features.
|
|
31
|
+
# This functionality is in technical preview and may be changed or removed in a future
|
|
32
|
+
# release. Elastic will apply best effort to fix any issues, but features in technical
|
|
33
|
+
# preview are not subject to the support SLA of official GA features.
|
|
35
34
|
#
|
|
36
35
|
# @option arguments [String, Array] :index Comma-separated list or wildcard expression of index names used to limit the request. (*Required*)
|
|
37
36
|
# @option arguments [Boolean] :allow_no_indices If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices.
|
|
@@ -39,7 +38,7 @@ module Elasticsearch
|
|
|
39
38
|
# For example, a request targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`.
|
|
40
39
|
# @option arguments [String, Array<String>] :expand_wildcards Type of index that wildcard patterns can match.
|
|
41
40
|
# If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
|
|
42
|
-
# Supports comma-separated values, such as `open,hidden`.
|
|
41
|
+
# Supports comma-separated values, such as `open,hidden`. Server default: open.
|
|
43
42
|
# @option arguments [Boolean] :ignore_unavailable If `true`, missing or closed indices are not included in the response.
|
|
44
43
|
# @option arguments [String, Array<String>] :fields Comma-separated list or wildcard expressions of fields to include in the statistics.
|
|
45
44
|
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
|
|
@@ -64,13 +64,14 @@ module Elasticsearch
|
|
|
64
64
|
# ```
|
|
65
65
|
#
|
|
66
66
|
# @option arguments [String, Array] :index A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
|
|
67
|
-
# @option arguments [Boolean] :allow_no_indices Whether to ignore if a wildcard indices expression resolves into no concrete indices.
|
|
68
|
-
#
|
|
69
|
-
# @option arguments [
|
|
67
|
+
# @option arguments [Boolean] :allow_no_indices Whether to ignore if a wildcard indices expression resolves into no concrete indices.
|
|
68
|
+
# (This includes `_all` string or when no indices have been specified)
|
|
69
|
+
# @option arguments [String, Array<String>] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. Server default: open.
|
|
70
|
+
# @option arguments [Boolean] :flush Specify whether the index should be flushed after performing the operation Server default: true.
|
|
70
71
|
# @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed)
|
|
71
72
|
# @option arguments [Integer] :max_num_segments The number of segments the index should be merged into (default: dynamic)
|
|
72
73
|
# @option arguments [Boolean] :only_expunge_deletes Specify whether the operation should only expunge deleted documents
|
|
73
|
-
# @option arguments [Boolean] :wait_for_completion Should the request wait until the force merge is completed
|
|
74
|
+
# @option arguments [Boolean] :wait_for_completion Should the request wait until the force merge is completed Server default: true.
|
|
74
75
|
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
|
|
75
76
|
# when they occur.
|
|
76
77
|
# @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
|
|
@@ -35,7 +35,7 @@ module Elasticsearch
|
|
|
35
35
|
# This behavior applies even if the request targets other open indices. Server default: true.
|
|
36
36
|
# @option arguments [String, Array<String>] :expand_wildcards Type of index that wildcard patterns can match.
|
|
37
37
|
# If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
|
|
38
|
-
# Supports comma-separated values, such as `open,hidden`. Server default:
|
|
38
|
+
# Supports comma-separated values, such as `open,hidden`. Server default: all.
|
|
39
39
|
# @option arguments [Boolean] :ignore_unavailable If `false`, the request returns an error if it targets a missing or closed index.
|
|
40
40
|
# @option arguments [Time] :master_timeout Period to wait for a connection to the master node.
|
|
41
41
|
# If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s.
|
|
@@ -0,0 +1,68 @@
|
|
|
1
|
+
# Licensed to Elasticsearch B.V. under one or more contributor
|
|
2
|
+
# license agreements. See the NOTICE file distributed with
|
|
3
|
+
# this work for additional information regarding copyright
|
|
4
|
+
# ownership. Elasticsearch B.V. licenses this file to you under
|
|
5
|
+
# the Apache License, Version 2.0 (the "License"); you may
|
|
6
|
+
# not use this file except in compliance with the License.
|
|
7
|
+
# You may obtain a copy of the License at
|
|
8
|
+
#
|
|
9
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
|
10
|
+
#
|
|
11
|
+
# Unless required by applicable law or agreed to in writing,
|
|
12
|
+
# software distributed under the License is distributed on an
|
|
13
|
+
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
|
|
14
|
+
# KIND, either express or implied. See the License for the
|
|
15
|
+
# specific language governing permissions and limitations
|
|
16
|
+
# under the License.
|
|
17
|
+
#
|
|
18
|
+
# This code was automatically generated from the Elasticsearch Specification
|
|
19
|
+
# See https://github.com/elastic/elasticsearch-specification
|
|
20
|
+
# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash.
|
|
21
|
+
module Elasticsearch
|
|
22
|
+
module API
|
|
23
|
+
module Indices
|
|
24
|
+
module Actions
|
|
25
|
+
# Get all sampling configurations.
|
|
26
|
+
# Get the sampling configurations for all indices.
|
|
27
|
+
# This functionality is in technical preview and may be changed or removed in a future
|
|
28
|
+
# release. Elastic will apply best effort to fix any issues, but features in technical
|
|
29
|
+
# preview are not subject to the support SLA of official GA features.
|
|
30
|
+
#
|
|
31
|
+
# @option arguments [Time] :master_timeout Period to wait for a connection to the master node. If no response is
|
|
32
|
+
# received before the timeout expires, the request fails and returns an
|
|
33
|
+
# error. Server default: 30s.
|
|
34
|
+
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
|
|
35
|
+
# when they occur.
|
|
36
|
+
# @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
|
|
37
|
+
# returned by Elasticsearch.
|
|
38
|
+
# @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
|
|
39
|
+
# For example `"exists_time": "1h"` for humans and
|
|
40
|
+
# `"exists_time_in_millis": 3600000` for computers. When disabled the human
|
|
41
|
+
# readable values will be omitted. This makes sense for responses being consumed
|
|
42
|
+
# only by machines.
|
|
43
|
+
# @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
|
|
44
|
+
# this option for debugging only.
|
|
45
|
+
# @option arguments [Hash] :headers Custom HTTP headers
|
|
46
|
+
#
|
|
47
|
+
# @see https://www.elastic.co/docs/api/doc/elasticsearch#TODO
|
|
48
|
+
#
|
|
49
|
+
def get_all_sample_configuration(arguments = {})
|
|
50
|
+
request_opts = { endpoint: arguments[:endpoint] || 'indices.get_all_sample_configuration' }
|
|
51
|
+
|
|
52
|
+
arguments = arguments.clone
|
|
53
|
+
headers = arguments.delete(:headers) || {}
|
|
54
|
+
|
|
55
|
+
body = nil
|
|
56
|
+
|
|
57
|
+
method = Elasticsearch::API::HTTP_GET
|
|
58
|
+
path = '_sample/config'
|
|
59
|
+
params = Utils.process_params(arguments)
|
|
60
|
+
|
|
61
|
+
Elasticsearch::API::Response.new(
|
|
62
|
+
perform_request(method, path, params, body, headers, request_opts)
|
|
63
|
+
)
|
|
64
|
+
end
|
|
65
|
+
end
|
|
66
|
+
end
|
|
67
|
+
end
|
|
68
|
+
end
|
|
@@ -25,7 +25,7 @@ module Elasticsearch
|
|
|
25
25
|
# Get index templates.
|
|
26
26
|
# Get information about one or more index templates.
|
|
27
27
|
#
|
|
28
|
-
# @option arguments [String] :name
|
|
28
|
+
# @option arguments [String] :name Name of index template to retrieve. Wildcard (*) expressions are supported.
|
|
29
29
|
# @option arguments [Boolean] :local If true, the request retrieves information from the local node only. Defaults to false, which means information is retrieved from the master node.
|
|
30
30
|
# @option arguments [Boolean] :flat_settings If true, returns settings in flat format.
|
|
31
31
|
# @option arguments [Time] :master_timeout 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. Server default: 30s.
|
|
@@ -24,10 +24,6 @@ module Elasticsearch
|
|
|
24
24
|
module Actions
|
|
25
25
|
# Get the migration reindexing status.
|
|
26
26
|
# Get the status of a migration reindex attempt for a data stream or index.
|
|
27
|
-
# This functionality is Experimental and may be changed or removed
|
|
28
|
-
# completely in a future release. Elastic will take a best effort approach
|
|
29
|
-
# to fix any issues, but experimental features are not subject to the
|
|
30
|
-
# support SLA of official GA features.
|
|
31
27
|
#
|
|
32
28
|
# @option arguments [String, Array] :index The index or data stream name. (*Required*)
|
|
33
29
|
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
|
|
@@ -0,0 +1,74 @@
|
|
|
1
|
+
# Licensed to Elasticsearch B.V. under one or more contributor
|
|
2
|
+
# license agreements. See the NOTICE file distributed with
|
|
3
|
+
# this work for additional information regarding copyright
|
|
4
|
+
# ownership. Elasticsearch B.V. licenses this file to you under
|
|
5
|
+
# the Apache License, Version 2.0 (the "License"); you may
|
|
6
|
+
# not use this file except in compliance with the License.
|
|
7
|
+
# You may obtain a copy of the License at
|
|
8
|
+
#
|
|
9
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
|
10
|
+
#
|
|
11
|
+
# Unless required by applicable law or agreed to in writing,
|
|
12
|
+
# software distributed under the License is distributed on an
|
|
13
|
+
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
|
|
14
|
+
# KIND, either express or implied. See the License for the
|
|
15
|
+
# specific language governing permissions and limitations
|
|
16
|
+
# under the License.
|
|
17
|
+
#
|
|
18
|
+
# This code was automatically generated from the Elasticsearch Specification
|
|
19
|
+
# See https://github.com/elastic/elasticsearch-specification
|
|
20
|
+
# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash.
|
|
21
|
+
module Elasticsearch
|
|
22
|
+
module API
|
|
23
|
+
module Indices
|
|
24
|
+
module Actions
|
|
25
|
+
# Request for a random sample of raw documents ingested into the given index or data stream.
|
|
26
|
+
# This functionality is in technical preview and may be changed or removed in a future
|
|
27
|
+
# release. Elastic will apply best effort to fix any issues, but features in technical
|
|
28
|
+
# preview are not subject to the support SLA of official GA features.
|
|
29
|
+
#
|
|
30
|
+
# @option arguments [String] :index Single index or data stream name. Wildcards are not supported. (*Required*)
|
|
31
|
+
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
|
|
32
|
+
# when they occur.
|
|
33
|
+
# @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
|
|
34
|
+
# returned by Elasticsearch.
|
|
35
|
+
# @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
|
|
36
|
+
# For example `"exists_time": "1h"` for humans and
|
|
37
|
+
# `"exists_time_in_millis": 3600000` for computers. When disabled the human
|
|
38
|
+
# readable values will be omitted. This makes sense for responses being consumed
|
|
39
|
+
# only by machines.
|
|
40
|
+
# @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
|
|
41
|
+
# this option for debugging only.
|
|
42
|
+
# @option arguments [Hash] :headers Custom HTTP headers
|
|
43
|
+
#
|
|
44
|
+
# @see https://www.elastic.co/docs/api/doc/elasticsearch#TODO
|
|
45
|
+
#
|
|
46
|
+
def get_sample(arguments = {})
|
|
47
|
+
request_opts = { endpoint: arguments[:endpoint] || 'indices.get_sample' }
|
|
48
|
+
|
|
49
|
+
defined_params = [:index].each_with_object({}) do |variable, set_variables|
|
|
50
|
+
set_variables[variable] = arguments[variable] if arguments.key?(variable)
|
|
51
|
+
end
|
|
52
|
+
request_opts[:defined_params] = defined_params unless defined_params.empty?
|
|
53
|
+
|
|
54
|
+
raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
|
|
55
|
+
|
|
56
|
+
arguments = arguments.clone
|
|
57
|
+
headers = arguments.delete(:headers) || {}
|
|
58
|
+
|
|
59
|
+
body = nil
|
|
60
|
+
|
|
61
|
+
_index = arguments.delete(:index)
|
|
62
|
+
|
|
63
|
+
method = Elasticsearch::API::HTTP_GET
|
|
64
|
+
path = "#{Utils.listify(_index)}/_sample"
|
|
65
|
+
params = Utils.process_params(arguments)
|
|
66
|
+
|
|
67
|
+
Elasticsearch::API::Response.new(
|
|
68
|
+
perform_request(method, path, params, body, headers, request_opts)
|
|
69
|
+
)
|
|
70
|
+
end
|
|
71
|
+
end
|
|
72
|
+
end
|
|
73
|
+
end
|
|
74
|
+
end
|
|
@@ -0,0 +1,78 @@
|
|
|
1
|
+
# Licensed to Elasticsearch B.V. under one or more contributor
|
|
2
|
+
# license agreements. See the NOTICE file distributed with
|
|
3
|
+
# this work for additional information regarding copyright
|
|
4
|
+
# ownership. Elasticsearch B.V. licenses this file to you under
|
|
5
|
+
# the Apache License, Version 2.0 (the "License"); you may
|
|
6
|
+
# not use this file except in compliance with the License.
|
|
7
|
+
# You may obtain a copy of the License at
|
|
8
|
+
#
|
|
9
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
|
10
|
+
#
|
|
11
|
+
# Unless required by applicable law or agreed to in writing,
|
|
12
|
+
# software distributed under the License is distributed on an
|
|
13
|
+
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
|
|
14
|
+
# KIND, either express or implied. See the License for the
|
|
15
|
+
# specific language governing permissions and limitations
|
|
16
|
+
# under the License.
|
|
17
|
+
#
|
|
18
|
+
# This code was automatically generated from the Elasticsearch Specification
|
|
19
|
+
# See https://github.com/elastic/elasticsearch-specification
|
|
20
|
+
# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash.
|
|
21
|
+
module Elasticsearch
|
|
22
|
+
module API
|
|
23
|
+
module Indices
|
|
24
|
+
module Actions
|
|
25
|
+
# Get sampling configuration.
|
|
26
|
+
# Get the sampling configuration for the specified index.
|
|
27
|
+
# This functionality is in technical preview and may be changed or removed in a future
|
|
28
|
+
# release. Elastic will apply best effort to fix any issues, but features in technical
|
|
29
|
+
# preview are not subject to the support SLA of official GA features.
|
|
30
|
+
#
|
|
31
|
+
# @option arguments [String] :index The name of the index. (*Required*)
|
|
32
|
+
# @option arguments [Time] :master_timeout Period to wait for a connection to the master node. If no response is
|
|
33
|
+
# received before the timeout expires, the request fails and returns an
|
|
34
|
+
# error. Server default: 30s.
|
|
35
|
+
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
|
|
36
|
+
# when they occur.
|
|
37
|
+
# @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
|
|
38
|
+
# returned by Elasticsearch.
|
|
39
|
+
# @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
|
|
40
|
+
# For example `"exists_time": "1h"` for humans and
|
|
41
|
+
# `"exists_time_in_millis": 3600000` for computers. When disabled the human
|
|
42
|
+
# readable values will be omitted. This makes sense for responses being consumed
|
|
43
|
+
# only by machines.
|
|
44
|
+
# @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
|
|
45
|
+
# this option for debugging only.
|
|
46
|
+
# @option arguments [Hash] :headers Custom HTTP headers
|
|
47
|
+
#
|
|
48
|
+
# @see https://www.elastic.co/docs/api/doc/elasticsearch#TODO
|
|
49
|
+
#
|
|
50
|
+
def get_sample_configuration(arguments = {})
|
|
51
|
+
request_opts = { endpoint: arguments[:endpoint] || 'indices.get_sample_configuration' }
|
|
52
|
+
|
|
53
|
+
defined_params = [:index].each_with_object({}) do |variable, set_variables|
|
|
54
|
+
set_variables[variable] = arguments[variable] if arguments.key?(variable)
|
|
55
|
+
end
|
|
56
|
+
request_opts[:defined_params] = defined_params unless defined_params.empty?
|
|
57
|
+
|
|
58
|
+
raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
|
|
59
|
+
|
|
60
|
+
arguments = arguments.clone
|
|
61
|
+
headers = arguments.delete(:headers) || {}
|
|
62
|
+
|
|
63
|
+
body = nil
|
|
64
|
+
|
|
65
|
+
_index = arguments.delete(:index)
|
|
66
|
+
|
|
67
|
+
method = Elasticsearch::API::HTTP_GET
|
|
68
|
+
path = "#{Utils.listify(_index)}/_sample/config"
|
|
69
|
+
params = Utils.process_params(arguments)
|
|
70
|
+
|
|
71
|
+
Elasticsearch::API::Response.new(
|
|
72
|
+
perform_request(method, path, params, body, headers, request_opts)
|
|
73
|
+
)
|
|
74
|
+
end
|
|
75
|
+
end
|
|
76
|
+
end
|
|
77
|
+
end
|
|
78
|
+
end
|
|
@@ -0,0 +1,74 @@
|
|
|
1
|
+
# Licensed to Elasticsearch B.V. under one or more contributor
|
|
2
|
+
# license agreements. See the NOTICE file distributed with
|
|
3
|
+
# this work for additional information regarding copyright
|
|
4
|
+
# ownership. Elasticsearch B.V. licenses this file to you under
|
|
5
|
+
# the Apache License, Version 2.0 (the "License"); you may
|
|
6
|
+
# not use this file except in compliance with the License.
|
|
7
|
+
# You may obtain a copy of the License at
|
|
8
|
+
#
|
|
9
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
|
10
|
+
#
|
|
11
|
+
# Unless required by applicable law or agreed to in writing,
|
|
12
|
+
# software distributed under the License is distributed on an
|
|
13
|
+
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
|
|
14
|
+
# KIND, either express or implied. See the License for the
|
|
15
|
+
# specific language governing permissions and limitations
|
|
16
|
+
# under the License.
|
|
17
|
+
#
|
|
18
|
+
# This code was automatically generated from the Elasticsearch Specification
|
|
19
|
+
# See https://github.com/elastic/elasticsearch-specification
|
|
20
|
+
# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash.
|
|
21
|
+
module Elasticsearch
|
|
22
|
+
module API
|
|
23
|
+
module Indices
|
|
24
|
+
module Actions
|
|
25
|
+
# Request stats for a random sample of raw documents ingested into the given index or data stream.
|
|
26
|
+
# This functionality is in technical preview and may be changed or removed in a future
|
|
27
|
+
# release. Elastic will apply best effort to fix any issues, but features in technical
|
|
28
|
+
# preview are not subject to the support SLA of official GA features.
|
|
29
|
+
#
|
|
30
|
+
# @option arguments [String] :index Single index or data stream name. Wildcards are not supported. (*Required*)
|
|
31
|
+
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
|
|
32
|
+
# when they occur.
|
|
33
|
+
# @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
|
|
34
|
+
# returned by Elasticsearch.
|
|
35
|
+
# @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
|
|
36
|
+
# For example `"exists_time": "1h"` for humans and
|
|
37
|
+
# `"exists_time_in_millis": 3600000` for computers. When disabled the human
|
|
38
|
+
# readable values will be omitted. This makes sense for responses being consumed
|
|
39
|
+
# only by machines.
|
|
40
|
+
# @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
|
|
41
|
+
# this option for debugging only.
|
|
42
|
+
# @option arguments [Hash] :headers Custom HTTP headers
|
|
43
|
+
#
|
|
44
|
+
# @see https://www.elastic.co/docs/api/doc/elasticsearch#TODO
|
|
45
|
+
#
|
|
46
|
+
def get_sample_stats(arguments = {})
|
|
47
|
+
request_opts = { endpoint: arguments[:endpoint] || 'indices.get_sample_stats' }
|
|
48
|
+
|
|
49
|
+
defined_params = [:index].each_with_object({}) do |variable, set_variables|
|
|
50
|
+
set_variables[variable] = arguments[variable] if arguments.key?(variable)
|
|
51
|
+
end
|
|
52
|
+
request_opts[:defined_params] = defined_params unless defined_params.empty?
|
|
53
|
+
|
|
54
|
+
raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
|
|
55
|
+
|
|
56
|
+
arguments = arguments.clone
|
|
57
|
+
headers = arguments.delete(:headers) || {}
|
|
58
|
+
|
|
59
|
+
body = nil
|
|
60
|
+
|
|
61
|
+
_index = arguments.delete(:index)
|
|
62
|
+
|
|
63
|
+
method = Elasticsearch::API::HTTP_GET
|
|
64
|
+
path = "#{Utils.listify(_index)}/_sample/stats"
|
|
65
|
+
params = Utils.process_params(arguments)
|
|
66
|
+
|
|
67
|
+
Elasticsearch::API::Response.new(
|
|
68
|
+
perform_request(method, path, params, body, headers, request_opts)
|
|
69
|
+
)
|
|
70
|
+
end
|
|
71
|
+
end
|
|
72
|
+
end
|
|
73
|
+
end
|
|
74
|
+
end
|
|
@@ -26,10 +26,6 @@ module Elasticsearch
|
|
|
26
26
|
# Reindex all legacy backing indices for a data stream.
|
|
27
27
|
# This operation occurs in a persistent task.
|
|
28
28
|
# The persistent task ID is returned immediately and the reindexing work is completed in that task.
|
|
29
|
-
# This functionality is Experimental and may be changed or removed
|
|
30
|
-
# completely in a future release. Elastic will take a best effort approach
|
|
31
|
-
# to fix any issues, but experimental features are not subject to the
|
|
32
|
-
# support SLA of official GA features.
|
|
33
29
|
#
|
|
34
30
|
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
|
|
35
31
|
# when they occur.
|
|
@@ -49,7 +49,7 @@ module Elasticsearch
|
|
|
49
49
|
# This behavior applies even if the request targets other open indices. Server default: true.
|
|
50
50
|
# @option arguments [String, Array<String>] :expand_wildcards Type of index that wildcard patterns can match.
|
|
51
51
|
# If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
|
|
52
|
-
# Supports comma-separated values, such as `open,hidden`. Server default:
|
|
52
|
+
# Supports comma-separated values, such as `open,hidden`. Server default: closed.
|
|
53
53
|
# @option arguments [Boolean] :ignore_unavailable If `false`, the request returns an error if it targets a missing or closed index.
|
|
54
54
|
# @option arguments [Time] :master_timeout Period to wait for a connection to the master node.
|
|
55
55
|
# If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s.
|
|
@@ -32,7 +32,7 @@ module Elasticsearch
|
|
|
32
32
|
# If this is missing, the data stream will not be able to roll over until a matching index template is created.
|
|
33
33
|
# This will affect the lifecycle management of the data stream and interfere with the data stream size and retention.
|
|
34
34
|
#
|
|
35
|
-
# @option arguments [String] :name The name of the data stream (*Required*)
|
|
35
|
+
# @option arguments [String] :name The name of the data stream to promote (*Required*)
|
|
36
36
|
# @option arguments [Time] :master_timeout 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. Server default: 30s.
|
|
37
37
|
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
|
|
38
38
|
# when they occur.
|
|
@@ -48,7 +48,7 @@ module Elasticsearch
|
|
|
48
48
|
# @option arguments [Boolean] :create If `true`, this request cannot replace or update existing index templates.
|
|
49
49
|
# @option arguments [Time] :master_timeout Period to wait for a connection to the master node.
|
|
50
50
|
# If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s.
|
|
51
|
-
# @option arguments [String] :cause User defined reason for creating
|
|
51
|
+
# @option arguments [String] :cause User defined reason for creating or updating the index template Server default: api.
|
|
52
52
|
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
|
|
53
53
|
# when they occur.
|
|
54
54
|
# @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
|
|
@@ -34,7 +34,8 @@ module Elasticsearch
|
|
|
34
34
|
# - Rename a field using a field alias
|
|
35
35
|
# Learn how to use the update mapping API with practical examples in the {https://www.elastic.co/docs/manage-data/data-store/mapping/update-mappings-examples Update mapping API examples} guide.
|
|
36
36
|
#
|
|
37
|
-
# @option arguments [String, Array] :index A comma-separated list of index names the mapping should be added to (supports wildcards)
|
|
37
|
+
# @option arguments [String, Array] :index A comma-separated list of index names the mapping should be added to (supports wildcards).
|
|
38
|
+
# Use `_all` or omit to add the mapping on all indices. (*Required*)
|
|
38
39
|
# @option arguments [Boolean] :allow_no_indices If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices.
|
|
39
40
|
# This behavior applies even if the request targets other open indices. Server default: true.
|
|
40
41
|
# @option arguments [String, Array<String>] :expand_wildcards Type of index that wildcard patterns can match.
|