elasticsearch-api 9.1.2 → 9.1.3

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.
Files changed (68) hide show
  1. checksums.yaml +4 -4
  2. data/lib/elasticsearch/api/actions/async_search/submit.rb +4 -4
  3. data/lib/elasticsearch/api/actions/cat/aliases.rb +9 -0
  4. data/lib/elasticsearch/api/actions/cat/allocation.rb +9 -1
  5. data/lib/elasticsearch/api/actions/cat/component_templates.rb +9 -0
  6. data/lib/elasticsearch/api/actions/cat/count.rb +9 -0
  7. data/lib/elasticsearch/api/actions/cat/fielddata.rb +9 -1
  8. data/lib/elasticsearch/api/actions/cat/health.rb +10 -2
  9. data/lib/elasticsearch/api/actions/cat/indices.rb +10 -3
  10. data/lib/elasticsearch/api/actions/cat/master.rb +10 -1
  11. data/lib/elasticsearch/api/actions/cat/ml_data_frame_analytics.rb +11 -3
  12. data/lib/elasticsearch/api/actions/cat/ml_datafeeds.rb +9 -1
  13. data/lib/elasticsearch/api/actions/cat/ml_jobs.rb +9 -2
  14. data/lib/elasticsearch/api/actions/cat/ml_trained_models.rb +11 -4
  15. data/lib/elasticsearch/api/actions/cat/nodeattrs.rb +10 -1
  16. data/lib/elasticsearch/api/actions/cat/nodes.rb +9 -2
  17. data/lib/elasticsearch/api/actions/cat/pending_tasks.rb +10 -2
  18. data/lib/elasticsearch/api/actions/cat/plugins.rb +10 -1
  19. data/lib/elasticsearch/api/actions/cat/recovery.rb +9 -2
  20. data/lib/elasticsearch/api/actions/cat/repositories.rb +9 -0
  21. data/lib/elasticsearch/api/actions/cat/segments.rb +19 -1
  22. data/lib/elasticsearch/api/actions/cat/shards.rb +9 -2
  23. data/lib/elasticsearch/api/actions/cat/snapshots.rb +9 -1
  24. data/lib/elasticsearch/api/actions/cat/tasks.rb +10 -2
  25. data/lib/elasticsearch/api/actions/cat/templates.rb +10 -1
  26. data/lib/elasticsearch/api/actions/cat/thread_pool.rb +9 -1
  27. data/lib/elasticsearch/api/actions/cat/transforms.rb +9 -1
  28. data/lib/elasticsearch/api/actions/connector/delete.rb +1 -1
  29. data/lib/elasticsearch/api/actions/connector/list.rb +2 -2
  30. data/lib/elasticsearch/api/actions/connector/sync_job_list.rb +2 -2
  31. data/lib/elasticsearch/api/actions/cross_cluster_replication/follow.rb +1 -1
  32. data/lib/elasticsearch/api/actions/dangling_indices/delete_dangling_index.rb +1 -1
  33. data/lib/elasticsearch/api/actions/dangling_indices/import_dangling_index.rb +1 -1
  34. data/lib/elasticsearch/api/actions/eql/get.rb +1 -1
  35. data/lib/elasticsearch/api/actions/esql/async_query.rb +1 -1
  36. data/lib/elasticsearch/api/actions/esql/query.rb +1 -1
  37. data/lib/elasticsearch/api/actions/get_script.rb +1 -1
  38. data/lib/elasticsearch/api/actions/indices/create_from.rb +0 -1
  39. data/lib/elasticsearch/api/actions/indices/delete_data_lifecycle.rb +1 -1
  40. data/lib/elasticsearch/api/actions/indices/delete_data_stream_options.rb +1 -1
  41. data/lib/elasticsearch/api/actions/indices/explain_data_lifecycle.rb +1 -1
  42. data/lib/elasticsearch/api/actions/indices/forcemerge.rb +1 -1
  43. data/lib/elasticsearch/api/actions/indices/put_index_template.rb +1 -1
  44. data/lib/elasticsearch/api/actions/indices/put_template.rb +1 -1
  45. data/lib/elasticsearch/api/actions/indices/refresh.rb +1 -0
  46. data/lib/elasticsearch/api/actions/indices/simulate_index_template.rb +2 -1
  47. data/lib/elasticsearch/api/actions/indices/simulate_template.rb +1 -1
  48. data/lib/elasticsearch/api/actions/indices/stats.rb +1 -1
  49. data/lib/elasticsearch/api/actions/logstash/put_pipeline.rb +2 -1
  50. data/lib/elasticsearch/api/actions/nodes/stats.rb +1 -1
  51. data/lib/elasticsearch/api/actions/query_rules/list_rulesets.rb +1 -1
  52. data/lib/elasticsearch/api/actions/reindex.rb +1 -1
  53. data/lib/elasticsearch/api/actions/search_mvt.rb +1 -1
  54. data/lib/elasticsearch/api/actions/searchable_snapshots/stats.rb +1 -1
  55. data/lib/elasticsearch/api/actions/security/get_settings.rb +1 -1
  56. data/lib/elasticsearch/api/actions/security/update_settings.rb +1 -1
  57. data/lib/elasticsearch/api/actions/snapshot/get_repository.rb +1 -1
  58. data/lib/elasticsearch/api/actions/sql/get_async.rb +1 -1
  59. data/lib/elasticsearch/api/actions/streams/logs_disable.rb +23 -3
  60. data/lib/elasticsearch/api/actions/streams/logs_enable.rb +26 -3
  61. data/lib/elasticsearch/api/actions/streams/status.rb +20 -3
  62. data/lib/elasticsearch/api/actions/tasks/list.rb +1 -1
  63. data/lib/elasticsearch/api/actions/transform/get_node_stats.rb +1 -1
  64. data/lib/elasticsearch/api/actions/watcher/get_settings.rb +1 -1
  65. data/lib/elasticsearch/api/actions/watcher/put_watch.rb +1 -0
  66. data/lib/elasticsearch/api/actions/watcher/update_settings.rb +1 -1
  67. data/lib/elasticsearch/api/version.rb +2 -2
  68. metadata +2 -2
@@ -38,12 +38,20 @@ module Elasticsearch
38
38
  # Sorting defaults to ascending and can be changed by setting `:asc`
39
39
  # or `:desc` as a suffix to the column name.
40
40
  # @option arguments [Time] :master_timeout Period to wait for a connection to the master node. Server default: 30s.
41
- # @option arguments [String] :time Unit used to display time values.
42
41
  # @option arguments [String] :format Specifies the format to return the columnar data in, can be set to
43
42
  # `text`, `json`, `cbor`, `yaml`, or `smile`. Server default: text.
44
43
  # @option arguments [Boolean] :help When set to `true` will output available columns. This option
45
44
  # can't be combined with any other query string option.
46
45
  # @option arguments [Boolean] :v When set to `true` will enable verbose output.
46
+ # @option arguments [String] :bytes Sets the units for columns that contain a byte-size value.
47
+ # Note that byte-size value units work in terms of powers of 1024. For instance `1kb` means 1024 bytes, not 1000 bytes.
48
+ # If omitted, byte-size values are rendered with a suffix such as `kb`, `mb`, or `gb`, chosen such that the numeric value of the column is as small as possible whilst still being at least `1.0`.
49
+ # If given, byte-size values are rendered as an integer with no suffix, representing the value of the column in the chosen unit.
50
+ # Values that are not an exact multiple of the chosen unit are rounded down.
51
+ # @option arguments [String] :time Sets the units for columns that contain a time duration.
52
+ # If omitted, time duration values are rendered with a suffix such as `ms`, `s`, `m` or `h`, chosen such that the numeric value of the column is as small as possible whilst still being at least `1.0`.
53
+ # If given, time duration values are rendered as an integer with no suffix.
54
+ # Values that are not an exact multiple of the chosen unit are rounded down.
47
55
  # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
48
56
  # when they occur.
49
57
  # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
@@ -34,11 +34,10 @@ module Elasticsearch
34
34
  # @option arguments [Boolean] :detailed If `true`, the response includes detailed information about shard recoveries.
35
35
  # @option arguments [Array<String>] :nodes Unique node identifiers, which are used to limit the response.
36
36
  # @option arguments [String] :parent_task_id The parent task identifier, which is used to limit the response.
37
- # @option arguments [String, Array<String>] :h List of columns to appear in the response. Supports simple wildcards.
37
+ # @option arguments [String, Array<String>] :h A comma-separated list of columns names to display. It supports simple wildcards.
38
38
  # @option arguments [String, Array<String>] :s List of columns that determine how the table should be sorted.
39
39
  # Sorting defaults to ascending and can be changed by setting `:asc`
40
40
  # or `:desc` as a suffix to the column name.
41
- # @option arguments [String] :time Unit used to display time values.
42
41
  # @option arguments [Time] :timeout Period to wait for a response.
43
42
  # If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s.
44
43
  # @option arguments [Boolean] :wait_for_completion If `true`, the request blocks until the task has completed.
@@ -47,6 +46,15 @@ module Elasticsearch
47
46
  # @option arguments [Boolean] :help When set to `true` will output available columns. This option
48
47
  # can't be combined with any other query string option.
49
48
  # @option arguments [Boolean] :v When set to `true` will enable verbose output.
49
+ # @option arguments [String] :bytes Sets the units for columns that contain a byte-size value.
50
+ # Note that byte-size value units work in terms of powers of 1024. For instance `1kb` means 1024 bytes, not 1000 bytes.
51
+ # If omitted, byte-size values are rendered with a suffix such as `kb`, `mb`, or `gb`, chosen such that the numeric value of the column is as small as possible whilst still being at least `1.0`.
52
+ # If given, byte-size values are rendered as an integer with no suffix, representing the value of the column in the chosen unit.
53
+ # Values that are not an exact multiple of the chosen unit are rounded down.
54
+ # @option arguments [String] :time Sets the units for columns that contain a time duration.
55
+ # If omitted, time duration values are rendered with a suffix such as `ms`, `s`, `m` or `h`, chosen such that the numeric value of the column is as small as possible whilst still being at least `1.0`.
56
+ # If given, time duration values are rendered as an integer with no suffix.
57
+ # Values that are not an exact multiple of the chosen unit are rounded down.
50
58
  # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
51
59
  # when they occur.
52
60
  # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
@@ -29,7 +29,7 @@ module Elasticsearch
29
29
  #
30
30
  # @option arguments [String] :name The name of the template to return.
31
31
  # Accepts wildcard expressions. If omitted, all templates are returned.
32
- # @option arguments [String, Array<String>] :h List of columns to appear in the response. Supports simple wildcards.
32
+ # @option arguments [String, Array<String>] :h A comma-separated list of columns names to display. It supports simple wildcards.
33
33
  # @option arguments [String, Array<String>] :s List of columns that determine how the table should be sorted.
34
34
  # Sorting defaults to ascending and can be changed by setting `:asc`
35
35
  # or `:desc` as a suffix to the column name.
@@ -43,6 +43,15 @@ module Elasticsearch
43
43
  # @option arguments [Boolean] :help When set to `true` will output available columns. This option
44
44
  # can't be combined with any other query string option.
45
45
  # @option arguments [Boolean] :v When set to `true` will enable verbose output.
46
+ # @option arguments [String] :bytes Sets the units for columns that contain a byte-size value.
47
+ # Note that byte-size value units work in terms of powers of 1024. For instance `1kb` means 1024 bytes, not 1000 bytes.
48
+ # If omitted, byte-size values are rendered with a suffix such as `kb`, `mb`, or `gb`, chosen such that the numeric value of the column is as small as possible whilst still being at least `1.0`.
49
+ # If given, byte-size values are rendered as an integer with no suffix, representing the value of the column in the chosen unit.
50
+ # Values that are not an exact multiple of the chosen unit are rounded down.
51
+ # @option arguments [String] :time Sets the units for columns that contain a time duration.
52
+ # If omitted, time duration values are rendered with a suffix such as `ms`, `s`, `m` or `h`, chosen such that the numeric value of the column is as small as possible whilst still being at least `1.0`.
53
+ # If given, time duration values are rendered as an integer with no suffix.
54
+ # Values that are not an exact multiple of the chosen unit are rounded down.
46
55
  # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
47
56
  # when they occur.
48
57
  # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
@@ -33,7 +33,6 @@ module Elasticsearch
33
33
  # @option arguments [String, Array<String>] :s A comma-separated list of column names or aliases that determines the sort order.
34
34
  # Sorting defaults to ascending and can be changed by setting `:asc`
35
35
  # or `:desc` as a suffix to the column name.
36
- # @option arguments [String] :time The unit used to display time values.
37
36
  # @option arguments [Boolean] :local If `true`, the request computes the list of selected nodes from the
38
37
  # local cluster state. If `false` the list of selected nodes are computed
39
38
  # from the cluster state of the master node. In both cases the coordinating
@@ -44,6 +43,15 @@ module Elasticsearch
44
43
  # @option arguments [Boolean] :help When set to `true` will output available columns. This option
45
44
  # can't be combined with any other query string option.
46
45
  # @option arguments [Boolean] :v When set to `true` will enable verbose output.
46
+ # @option arguments [String] :bytes Sets the units for columns that contain a byte-size value.
47
+ # Note that byte-size value units work in terms of powers of 1024. For instance `1kb` means 1024 bytes, not 1000 bytes.
48
+ # If omitted, byte-size values are rendered with a suffix such as `kb`, `mb`, or `gb`, chosen such that the numeric value of the column is as small as possible whilst still being at least `1.0`.
49
+ # If given, byte-size values are rendered as an integer with no suffix, representing the value of the column in the chosen unit.
50
+ # Values that are not an exact multiple of the chosen unit are rounded down.
51
+ # @option arguments [String] :time Sets the units for columns that contain a time duration.
52
+ # If omitted, time duration values are rendered with a suffix such as `ms`, `s`, `m` or `h`, chosen such that the numeric value of the column is as small as possible whilst still being at least `1.0`.
53
+ # If given, time duration values are rendered as an integer with no suffix.
54
+ # Values that are not an exact multiple of the chosen unit are rounded down.
47
55
  # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
48
56
  # when they occur.
49
57
  # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
@@ -36,13 +36,21 @@ module Elasticsearch
36
36
  # @option arguments [Integer] :from Skips the specified number of transforms. Server default: 0.
37
37
  # @option arguments [String, Array<String>] :h Comma-separated list of column names to display. Server default: changes_last_detection_time,checkpoint,checkpoint_progress,documents_processed,id,last_search_time,state.
38
38
  # @option arguments [String, Array<String>] :s Comma-separated list of column names or column aliases used to sort the response.
39
- # @option arguments [String] :time The unit used to display time values.
40
39
  # @option arguments [Integer] :size The maximum number of transforms to obtain. Server default: 100.
41
40
  # @option arguments [String] :format Specifies the format to return the columnar data in, can be set to
42
41
  # `text`, `json`, `cbor`, `yaml`, or `smile`. Server default: text.
43
42
  # @option arguments [Boolean] :help When set to `true` will output available columns. This option
44
43
  # can't be combined with any other query string option.
45
44
  # @option arguments [Boolean] :v When set to `true` will enable verbose output.
45
+ # @option arguments [String] :bytes Sets the units for columns that contain a byte-size value.
46
+ # Note that byte-size value units work in terms of powers of 1024. For instance `1kb` means 1024 bytes, not 1000 bytes.
47
+ # If omitted, byte-size values are rendered with a suffix such as `kb`, `mb`, or `gb`, chosen such that the numeric value of the column is as small as possible whilst still being at least `1.0`.
48
+ # If given, byte-size values are rendered as an integer with no suffix, representing the value of the column in the chosen unit.
49
+ # Values that are not an exact multiple of the chosen unit are rounded down.
50
+ # @option arguments [String] :time Sets the units for columns that contain a time duration.
51
+ # If omitted, time duration values are rendered with a suffix such as `ms`, `s`, `m` or `h`, chosen such that the numeric value of the column is as small as possible whilst still being at least `1.0`.
52
+ # If given, time duration values are rendered as an integer with no suffix.
53
+ # Values that are not an exact multiple of the chosen unit are rounded down.
46
54
  # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
47
55
  # when they occur.
48
56
  # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
@@ -33,7 +33,7 @@ module Elasticsearch
33
33
  # SLA of official GA features.
34
34
  #
35
35
  # @option arguments [String] :connector_id The unique identifier of the connector to be deleted (*Required*)
36
- # @option arguments [Boolean] :delete_sync_jobs A flag indicating if associated sync jobs should be also removed. Defaults to false.
36
+ # @option arguments [Boolean] :delete_sync_jobs A flag indicating if associated sync jobs should be also removed.
37
37
  # @option arguments [Boolean] :hard A flag indicating if the connector should be hard deleted.
38
38
  # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
39
39
  # when they occur.
@@ -29,8 +29,8 @@ module Elasticsearch
29
29
  # as-is with no warranties. Beta features are not subject to the support
30
30
  # SLA of official GA features.
31
31
  #
32
- # @option arguments [Integer] :from Starting offset (default: 0)
33
- # @option arguments [Integer] :size Specifies a max number of results to get
32
+ # @option arguments [Integer] :from Starting offset Server default: 0.
33
+ # @option arguments [Integer] :size Specifies a max number of results to get Server default: 100.
34
34
  # @option arguments [String, Array] :index_name A comma-separated list of connector index names to fetch connector documents for
35
35
  # @option arguments [String, Array<String>] :connector_name A comma-separated list of connector names to fetch connector documents for
36
36
  # @option arguments [String, Array<String>] :service_type A comma-separated list of connector service types to fetch connector documents for
@@ -29,8 +29,8 @@ module Elasticsearch
29
29
  # as-is with no warranties. Beta features are not subject to the support
30
30
  # SLA of official GA features.
31
31
  #
32
- # @option arguments [Integer] :from Starting offset (default: 0)
33
- # @option arguments [Integer] :size Specifies a max number of results to get
32
+ # @option arguments [Integer] :from Starting offset Server default: 0.
33
+ # @option arguments [Integer] :size Specifies a max number of results to get Server default: 100.
34
34
  # @option arguments [String] :status A sync job status to fetch connector sync jobs for
35
35
  # @option arguments [String] :connector_id A connector id to fetch connector sync jobs for
36
36
  # @option arguments [String, Array<String>] :job_type A comma-separated list of job types to fetch the sync jobs for
@@ -31,7 +31,7 @@ module Elasticsearch
31
31
  # @option arguments [Integer, String] :wait_for_active_shards Specifies the number of shards to wait on being active before responding. This defaults to waiting on none of the shards to be
32
32
  # active.
33
33
  # A shard must be restored from the leader index before being active. Restoring a follower shard requires transferring all the
34
- # remote Lucene segment files to the follower index.
34
+ # remote Lucene segment files to the follower index. Server default: 0.
35
35
  # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
36
36
  # when they occur.
37
37
  # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
@@ -28,7 +28,7 @@ module Elasticsearch
28
28
  #
29
29
  # @option arguments [String] :index_uuid The UUID of the index to delete. Use the get dangling indices API to find the UUID. (*Required*)
30
30
  # @option arguments [Boolean] :accept_data_loss This parameter must be set to true to acknowledge that it will no longer be possible to recove data from the dangling index. (*Required*)
31
- # @option arguments [Time] :master_timeout Specify timeout for connection to master
31
+ # @option arguments [Time] :master_timeout Specify timeout for connection to master Server default: 30s.
32
32
  # @option arguments [Time] :timeout Explicit operation timeout
33
33
  # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
34
34
  # when they occur.
@@ -29,7 +29,7 @@ module Elasticsearch
29
29
  # @option arguments [String] :index_uuid The UUID of the index to import. Use the get dangling indices API to locate the UUID. (*Required*)
30
30
  # @option arguments [Boolean] :accept_data_loss This parameter must be set to true to import a dangling index.
31
31
  # Because Elasticsearch cannot know where the dangling index data came from or determine which shard copies are fresh and which are stale, it cannot guarantee that the imported data represents the latest state of the index when it was last in the cluster. (*Required*)
32
- # @option arguments [Time] :master_timeout Specify timeout for connection to master
32
+ # @option arguments [Time] :master_timeout Specify timeout for connection to master Server default: 30s.
33
33
  # @option arguments [Time] :timeout Explicit operation timeout
34
34
  # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
35
35
  # when they occur.
@@ -27,7 +27,7 @@ module Elasticsearch
27
27
  #
28
28
  # @option arguments [String] :id Identifier for the search. (*Required*)
29
29
  # @option arguments [Time] :keep_alive Period for which the search and its results are stored on the cluster.
30
- # Defaults to the keep_alive value set by the search’s EQL search API request.
30
+ # Defaults to the keep_alive value set by the search’s EQL search API request. Server default: 5d.
31
31
  # @option arguments [Time] :wait_for_completion_timeout Timeout duration to wait for the request to finish.
32
32
  # Defaults to no timeout, meaning the request waits for complete search results.
33
33
  # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
@@ -29,7 +29,7 @@ module Elasticsearch
29
29
  # @option arguments [Boolean] :allow_partial_results If `true`, partial results will be returned if there are shard failures, but the query can continue to execute on other clusters and shards.
30
30
  # If `false`, the query will fail if there are any failures.To override the default behavior, you can set the `esql.query.allow_partial_results` cluster setting to `false`. Server default: true.
31
31
  # @option arguments [String] :delimiter The character to use between values within a CSV row.
32
- # It is valid only for the CSV format.
32
+ # It is valid only for the CSV format. Server default: ,.
33
33
  # @option arguments [Boolean] :drop_null_columns Indicates whether columns that are entirely `null` will be removed from the `columns` and `values` portion of the results.
34
34
  # If `true`, the response will include an extra section under the name `all_columns` which has the name of all the columns.
35
35
  # @option arguments [String] :format A short version of the Accept header, e.g. json, yaml.`csv`, `tsv`, and `txt` formats will return results in a tabular format, excluding other metadata fields from the response.For async requests, nothing will be returned if the async query doesn't finish within the timeout.
@@ -29,7 +29,7 @@ module Elasticsearch
29
29
  # library is upgraded.
30
30
  #
31
31
  # @option arguments [String] :format A short version of the Accept header, e.g. json, yaml.`csv`, `tsv`, and `txt` formats will return results in a tabular format, excluding other metadata fields from the response.
32
- # @option arguments [String] :delimiter The character to use between values within a CSV row. Only valid for the CSV format.
32
+ # @option arguments [String] :delimiter The character to use between values within a CSV row. Only valid for the CSV format. Server default: ,.
33
33
  # @option arguments [Boolean] :drop_null_columns Should columns that are entirely `null` be removed from the `columns` and `values` portion of the results?
34
34
  # Defaults to `false`. If `true` then the response will include an extra section under the name `all_columns` which has the name of all columns.
35
35
  # @option arguments [Boolean] :allow_partial_results If `true`, partial results will be returned if there are shard failures, but the query can continue to execute on other clusters and shards.
@@ -27,7 +27,7 @@ module Elasticsearch
27
27
  # @option arguments [String] :id The identifier for the stored script or search template. (*Required*)
28
28
  # @option arguments [Time] :master_timeout The period to wait for the master node.
29
29
  # If the master node is not available before the timeout expires, the request fails and returns an error.
30
- # It can also be set to `-1` to indicate that the request should never timeout. Server default: .
30
+ # It can also be set to `-1` to indicate that the request should never timeout. 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
@@ -55,7 +55,6 @@ module Elasticsearch
55
55
  end
56
56
  request_opts[:defined_params] = defined_params unless defined_params.empty?
57
57
 
58
- raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
59
58
  raise ArgumentError, "Required argument 'source' missing" unless arguments[:source]
60
59
  raise ArgumentError, "Required argument 'dest' missing" unless arguments[:dest]
61
60
 
@@ -27,7 +27,7 @@ module Elasticsearch
27
27
  #
28
28
  # @option arguments [String, Array<String>] :name A comma-separated list of data streams of which the data stream lifecycle will be deleted; use `*` to get all data streams (*Required*)
29
29
  # @option arguments [String, Array<String>] :expand_wildcards Whether wildcard expressions should get expanded to open or closed indices (default: open)
30
- # @option arguments [Time] :master_timeout Specify timeout for connection to master
30
+ # @option arguments [Time] :master_timeout Specify timeout for connection to master Server default: 30s.
31
31
  # @option arguments [Time] :timeout Explicit timestamp for the document
32
32
  # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
33
33
  # when they occur.
@@ -27,7 +27,7 @@ module Elasticsearch
27
27
  #
28
28
  # @option arguments [String, Array<String>] :name A comma-separated list of data streams of which the data stream options will be deleted; use `*` to get all data streams (*Required*)
29
29
  # @option arguments [String, Array<String>] :expand_wildcards Whether wildcard expressions should get expanded to open or closed indices (default: open)
30
- # @option arguments [Time] :master_timeout Specify timeout for connection to master
30
+ # @option arguments [Time] :master_timeout Specify timeout for connection to master Server default: 30s.
31
31
  # @option arguments [Time] :timeout Explicit timestamp for the document
32
32
  # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
33
33
  # when they occur.
@@ -27,7 +27,7 @@ module Elasticsearch
27
27
  #
28
28
  # @option arguments [String, Array] :index The name of the index to explain (*Required*)
29
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 Specify timeout for connection to master
30
+ # @option arguments [Time] :master_timeout Specify timeout for connection to master 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
@@ -70,7 +70,7 @@ module Elasticsearch
70
70
  # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed)
71
71
  # @option arguments [Integer] :max_num_segments The number of segments the index should be merged into (default: dynamic)
72
72
  # @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.
73
+ # @option arguments [Boolean] :wait_for_completion Should the request wait until the force merge is completed. Server default: true.
74
74
  # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
75
75
  # when they occur.
76
76
  # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
@@ -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/updating the index template
51
+ # @option arguments [String] :cause User defined reason for creating/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
@@ -45,7 +45,7 @@ module Elasticsearch
45
45
  # @option arguments [Integer] :order Order in which Elasticsearch applies this template if index
46
46
  # matches multiple templates.Templates with lower 'order' values are merged first. Templates with higher
47
47
  # 'order' values are merged later, overriding templates with lower values.
48
- # @option arguments [String] :cause User defined reason for creating/updating the index template
48
+ # @option arguments [String] :cause User defined reason for creating/updating the index template Server default: .
49
49
  # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
50
50
  # when they occur.
51
51
  # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
@@ -27,6 +27,7 @@ module Elasticsearch
27
27
  # For data streams, the API runs the refresh operation on the stream’s backing indices.
28
28
  # By default, Elasticsearch periodically refreshes indices every second, but only on indices that have received one search request or more in the last 30 seconds.
29
29
  # You can change this default interval with the `index.refresh_interval` setting.
30
+ # In Elastic Cloud Serverless, the default refresh interval is 5 seconds across all indices.
30
31
  # Refresh requests are synchronous and do not return a response until the refresh operation completes.
31
32
  # Refreshes are resource-intensive.
32
33
  # To ensure good cluster performance, it's recommended to wait for Elasticsearch's periodic refresh rather than performing an explicit refresh when possible.
@@ -42,6 +42,7 @@ module Elasticsearch
42
42
  # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
43
43
  # this option for debugging only.
44
44
  # @option arguments [Hash] :headers Custom HTTP headers
45
+ # @option arguments [Hash] :body index_template
45
46
  #
46
47
  # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-simulate-index-template
47
48
  #
@@ -58,7 +59,7 @@ module Elasticsearch
58
59
  arguments = arguments.clone
59
60
  headers = arguments.delete(:headers) || {}
60
61
 
61
- body = nil
62
+ body = arguments.delete(:body)
62
63
 
63
64
  _name = arguments.delete(:name)
64
65
 
@@ -28,7 +28,7 @@ module Elasticsearch
28
28
  # @option arguments [String] :name Name of the index template to simulate. To test a template configuration before you add it to the cluster, omit
29
29
  # this parameter and specify the template configuration in the request body.
30
30
  # @option arguments [Boolean] :create 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.
31
- # @option arguments [String] :cause User defined reason for dry-run creating the new template for simulation purposes
31
+ # @option arguments [String] :cause User defined reason for dry-run creating the new template for simulation purposes Server default: false.
32
32
  # @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.
33
33
  # @option arguments [Boolean] :include_defaults If true, returns all relevant default configurations for the index template.
34
34
  # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
@@ -43,7 +43,7 @@ module Elasticsearch
43
43
  # @option arguments [String, Array<String>] :groups Comma-separated list of search groups to include in the search statistics.
44
44
  # @option arguments [Boolean] :include_segment_file_sizes If true, the call reports the aggregated disk usage of each one of the Lucene index files (only applies if segment stats are requested).
45
45
  # @option arguments [Boolean] :include_unloaded_segments If true, the response includes information from segments that are not loaded into memory.
46
- # @option arguments [String] :level Indicates whether statistics are aggregated at the cluster, index, or shard level.
46
+ # @option arguments [String] :level Indicates whether statistics are aggregated at the cluster, indices, or shards level. Server default: indices.
47
47
  # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
48
48
  # when they occur.
49
49
  # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
@@ -26,7 +26,8 @@ module Elasticsearch
26
26
  # Create a pipeline that is used for Logstash Central Management.
27
27
  # If the specified pipeline exists, it is replaced.
28
28
  #
29
- # @option arguments [String] :id An identifier for the pipeline. (*Required*)
29
+ # @option arguments [String] :id An identifier for the pipeline.
30
+ # Pipeline IDs must begin with a letter or underscore and contain only letters, underscores, dashes, hyphens and numbers. (*Required*)
30
31
  # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
31
32
  # when they occur.
32
33
  # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
@@ -34,7 +34,7 @@ module Elasticsearch
34
34
  # @option arguments [String, Array<String>] :fields Comma-separated list or wildcard expressions of fields to include in the statistics.
35
35
  # @option arguments [Boolean] :groups Comma-separated list of search groups to include in the search statistics.
36
36
  # @option arguments [Boolean] :include_segment_file_sizes If true, the call reports the aggregated disk usage of each one of the Lucene index files (only applies if segment stats are requested).
37
- # @option arguments [String] :level Indicates whether statistics are aggregated at the cluster, index, or shard level.
37
+ # @option arguments [String] :level Indicates whether statistics are aggregated at the node, indices, or shards level. Server default: node.
38
38
  # @option arguments [Time] :timeout Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s.
39
39
  # @option arguments [Array<String>] :types A comma-separated list of document types for the indexing index metric.
40
40
  # @option arguments [Boolean] :include_unloaded_segments If `true`, the response includes information from segments that are not loaded into memory.
@@ -26,7 +26,7 @@ module Elasticsearch
26
26
  # Get summarized information about the query rulesets.
27
27
  #
28
28
  # @option arguments [Integer] :from The offset from the first result to fetch. Server default: 0.
29
- # @option arguments [Integer] :size The maximum number of results to retrieve.
29
+ # @option arguments [Integer] :size The maximum number of results to retrieve. Server default: 100.
30
30
  # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
31
31
  # when they occur.
32
32
  # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
@@ -61,7 +61,7 @@ module Elasticsearch
61
61
  # @option arguments [Boolean] :refresh If `true`, the request refreshes affected shards to make this operation visible to search.
62
62
  # @option arguments [Float] :requests_per_second The throttle for this request in sub-requests per second.
63
63
  # By default, there is no throttle. Server default: -1.
64
- # @option arguments [Time] :scroll The period of time that a consistent view of the index should be maintained for scrolled search.
64
+ # @option arguments [Time] :scroll The period of time that a consistent view of the index should be maintained for scrolled search. Server default: 5m.
65
65
  # @option arguments [Integer, String] :slices The number of slices this task should be divided into.
66
66
  # It defaults to one slice, which means the task isn't sliced into subtasks.Reindex supports sliced scroll to parallelize the reindexing process.
67
67
  # This parallelization can improve efficiency and provide a convenient way to break the request down into smaller parts.NOTE: Reindexing from remote clusters does not support manual or automatic slicing.If set to `auto`, Elasticsearch chooses the number of slices to use.
@@ -107,7 +107,7 @@ module Elasticsearch
107
107
  # the <zoom>/<x>/<y> tile with wrap_longitude set to false. The resulting
108
108
  # bounding box may be larger than the vector tile.
109
109
  # @option arguments [Integer] :extent The size, in pixels, of a side of the tile. Vector tiles are square with equal sides. Server default: 4096.
110
- # @option arguments [String] :grid_agg Aggregation used to create a grid for `field`.
110
+ # @option arguments [String] :grid_agg Aggregation used to create a grid for `field`. Server default: geotile.
111
111
  # @option arguments [Integer] :grid_precision Additional zoom levels available through the aggs layer. For example, if <zoom> is 7
112
112
  # and grid_precision is 8, you can zoom in up to level 15. Accepts 0-8. If 0, results
113
113
  # don't include the aggs layer. Server default: 8.
@@ -25,7 +25,7 @@ module Elasticsearch
25
25
  # Get searchable snapshot statistics.
26
26
  #
27
27
  # @option arguments [String, Array] :index A comma-separated list of data streams and indices to retrieve statistics for.
28
- # @option arguments [String] :level Return stats aggregated at cluster, index or shard level
28
+ # @option arguments [String] :level Return stats aggregated at cluster, index or shard level Server default: indices.
29
29
  # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
30
30
  # when they occur.
31
31
  # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
@@ -30,7 +30,7 @@ module Elasticsearch
30
30
  # * `index.number_of_replicas`
31
31
  #
32
32
  # @option arguments [Time] :master_timeout Period to wait for a connection to the master node.
33
- # If no response is received before the timeout expires, the request fails and returns an error.
33
+ # If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s.
34
34
  # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
35
35
  # when they occur.
36
36
  # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
@@ -29,7 +29,7 @@ module Elasticsearch
29
29
  # This API does not yet support configuring the settings for indices before they are in use.
30
30
  #
31
31
  # @option arguments [Time] :master_timeout The period to wait for a connection to the master node.
32
- # If no response is received before the timeout expires, the request fails and returns an error.
32
+ # If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s.
33
33
  # @option arguments [Time] :timeout The period to wait for a response.
34
34
  # If no response is received before the timeout expires, the request fails and returns an error.
35
35
  # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
@@ -30,7 +30,7 @@ module Elasticsearch
30
30
  # If `false`, the request gets information from the master node.
31
31
  # @option arguments [Time] :master_timeout The period to wait for the master node.
32
32
  # If the master node is not available before the timeout expires, the request fails and returns an error.
33
- # To indicate that the request should never timeout, set it to `-1`. Server default: to 30s.
33
+ # To indicate that the request should never timeout, set it to `-1`. Server default: 30s.
34
34
  # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
35
35
  # when they occur.
36
36
  # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
@@ -33,7 +33,7 @@ module Elasticsearch
33
33
  # You must specify a format using this parameter or the `Accept` HTTP header.
34
34
  # If you specify both, the API uses this parameter.
35
35
  # @option arguments [Time] :keep_alive The retention period for the search and its results.
36
- # It defaults to the `keep_alive` period for the original SQL search.
36
+ # It defaults to the `keep_alive` period for the original SQL search. Server default: 5d.
37
37
  # @option arguments [Time] :wait_for_completion_timeout The period to wait for complete results.
38
38
  # It defaults to no timeout, meaning the request waits for complete search results.
39
39
  # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
@@ -22,11 +22,31 @@ module Elasticsearch
22
22
  module API
23
23
  module Streams
24
24
  module Actions
25
- # Disable the Logs Streams feature for this cluster
25
+ # Disable logs stream.
26
+ # Turn off the logs stream feature for this cluster.
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.
26
31
  #
32
+ # @option arguments [Time] :master_timeout The period to wait for a connection to the master node.
33
+ # If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s.
34
+ # @option arguments [Time] :timeout The period to wait for a response.
35
+ # If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s.
36
+ # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
37
+ # when they occur.
38
+ # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
39
+ # returned by Elasticsearch.
40
+ # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
41
+ # For example `"exists_time": "1h"` for humans and
42
+ # `"exists_time_in_millis": 3600000` for computers. When disabled the human
43
+ # readable values will be omitted. This makes sense for responses being consumed
44
+ # only by machines.
45
+ # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
46
+ # this option for debugging only.
27
47
  # @option arguments [Hash] :headers Custom HTTP headers
28
48
  #
29
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/streams-logs-disable.html
49
+ # @see https://www.elastic.co/docs/api/doc/elasticsearch#TODO
30
50
  #
31
51
  def logs_disable(arguments = {})
32
52
  request_opts = { endpoint: arguments[:endpoint] || 'streams.logs_disable' }
@@ -38,7 +58,7 @@ module Elasticsearch
38
58
 
39
59
  method = Elasticsearch::API::HTTP_POST
40
60
  path = '_streams/logs/_disable'
41
- params = {}
61
+ params = Utils.process_params(arguments)
42
62
 
43
63
  Elasticsearch::API::Response.new(
44
64
  perform_request(method, path, params, body, headers, request_opts)
@@ -22,11 +22,34 @@ module Elasticsearch
22
22
  module API
23
23
  module Streams
24
24
  module Actions
25
- # Enable the Logs Streams feature for this cluster
25
+ # Enable logs stream.
26
+ # Turn on the logs stream feature for this cluster.
27
+ # NOTE: To protect existing data, this feature can be turned on only if the
28
+ # cluster does not have existing indices or data streams that match the pattern `logs|logs.*`.
29
+ # If those indices or data streams exist, a `409 - Conflict` response and error is returned.
30
+ # This functionality is Experimental and may be changed or removed
31
+ # completely in a future release. Elastic will take a best effort approach
32
+ # to fix any issues, but experimental features are not subject to the
33
+ # support SLA of official GA features.
26
34
  #
35
+ # @option arguments [Time] :master_timeout The period to wait for a connection to the master node.
36
+ # If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s.
37
+ # @option arguments [Time] :timeout The period to wait for a response.
38
+ # If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s.
39
+ # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
40
+ # when they occur.
41
+ # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
42
+ # returned by Elasticsearch.
43
+ # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
44
+ # For example `"exists_time": "1h"` for humans and
45
+ # `"exists_time_in_millis": 3600000` for computers. When disabled the human
46
+ # readable values will be omitted. This makes sense for responses being consumed
47
+ # only by machines.
48
+ # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
49
+ # this option for debugging only.
27
50
  # @option arguments [Hash] :headers Custom HTTP headers
28
51
  #
29
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/streams-logs-enable.html
52
+ # @see https://www.elastic.co/docs/api/doc/elasticsearch#TODO
30
53
  #
31
54
  def logs_enable(arguments = {})
32
55
  request_opts = { endpoint: arguments[:endpoint] || 'streams.logs_enable' }
@@ -38,7 +61,7 @@ module Elasticsearch
38
61
 
39
62
  method = Elasticsearch::API::HTTP_POST
40
63
  path = '_streams/logs/_enable'
41
- params = {}
64
+ params = Utils.process_params(arguments)
42
65
 
43
66
  Elasticsearch::API::Response.new(
44
67
  perform_request(method, path, params, body, headers, request_opts)