opensearch-api 2.0.2 → 2.1.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (87) hide show
  1. checksums.yaml +4 -4
  2. checksums.yaml.gz.sig +0 -0
  3. data/Gemfile +2 -2
  4. data/Rakefile +3 -3
  5. data/lib/opensearch/api/actions/cat/allocation.rb +4 -2
  6. data/lib/opensearch/api/actions/cat/cluster_manager.rb +54 -0
  7. data/lib/opensearch/api/actions/cat/indices.rb +4 -2
  8. data/lib/opensearch/api/actions/cat/master.rb +3 -1
  9. data/lib/opensearch/api/actions/cat/nodeattrs.rb +4 -2
  10. data/lib/opensearch/api/actions/cat/nodes.rb +4 -2
  11. data/lib/opensearch/api/actions/cat/pending_tasks.rb +4 -2
  12. data/lib/opensearch/api/actions/cat/plugins.rb +4 -2
  13. data/lib/opensearch/api/actions/cat/repositories.rb +4 -2
  14. data/lib/opensearch/api/actions/cat/shards.rb +4 -2
  15. data/lib/opensearch/api/actions/cat/snapshots.rb +3 -1
  16. data/lib/opensearch/api/actions/cat/templates.rb +4 -2
  17. data/lib/opensearch/api/actions/cat/thread_pool.rb +4 -2
  18. data/lib/opensearch/api/actions/cluster/delete_component_template.rb +4 -2
  19. data/lib/opensearch/api/actions/cluster/exists_component_template.rb +4 -2
  20. data/lib/opensearch/api/actions/cluster/get_component_template.rb +4 -2
  21. data/lib/opensearch/api/actions/cluster/get_settings.rb +3 -1
  22. data/lib/opensearch/api/actions/cluster/health.rb +4 -2
  23. data/lib/opensearch/api/actions/cluster/pending_tasks.rb +5 -3
  24. data/lib/opensearch/api/actions/cluster/put_component_template.rb +4 -2
  25. data/lib/opensearch/api/actions/cluster/put_settings.rb +3 -1
  26. data/lib/opensearch/api/actions/cluster/reroute.rb +4 -2
  27. data/lib/opensearch/api/actions/cluster/state.rb +4 -2
  28. data/lib/opensearch/api/actions/dangling_indices/delete_dangling_index.rb +4 -2
  29. data/lib/opensearch/api/actions/dangling_indices/import_dangling_index.rb +4 -2
  30. data/lib/opensearch/api/actions/delete_script.rb +4 -2
  31. data/lib/opensearch/api/actions/features/get_features.rb +4 -2
  32. data/lib/opensearch/api/actions/get_script.rb +4 -2
  33. data/lib/opensearch/api/actions/indices/add_block.rb +3 -1
  34. data/lib/opensearch/api/actions/indices/clone.rb +3 -1
  35. data/lib/opensearch/api/actions/indices/close.rb +3 -1
  36. data/lib/opensearch/api/actions/indices/create.rb +4 -2
  37. data/lib/opensearch/api/actions/indices/delete.rb +3 -1
  38. data/lib/opensearch/api/actions/indices/delete_alias.rb +4 -2
  39. data/lib/opensearch/api/actions/indices/delete_index_template.rb +4 -2
  40. data/lib/opensearch/api/actions/indices/delete_template.rb +4 -2
  41. data/lib/opensearch/api/actions/indices/exists_index_template.rb +4 -2
  42. data/lib/opensearch/api/actions/indices/exists_template.rb +4 -2
  43. data/lib/opensearch/api/actions/indices/get.rb +4 -2
  44. data/lib/opensearch/api/actions/indices/get_index_template.rb +4 -2
  45. data/lib/opensearch/api/actions/indices/get_mapping.rb +4 -2
  46. data/lib/opensearch/api/actions/indices/get_settings.rb +3 -1
  47. data/lib/opensearch/api/actions/indices/get_template.rb +4 -2
  48. data/lib/opensearch/api/actions/indices/open.rb +3 -1
  49. data/lib/opensearch/api/actions/indices/put_alias.rb +4 -2
  50. data/lib/opensearch/api/actions/indices/put_index_template.rb +4 -2
  51. data/lib/opensearch/api/actions/indices/put_mapping.rb +3 -1
  52. data/lib/opensearch/api/actions/indices/put_settings.rb +3 -1
  53. data/lib/opensearch/api/actions/indices/put_template.rb +4 -2
  54. data/lib/opensearch/api/actions/indices/rollover.rb +3 -1
  55. data/lib/opensearch/api/actions/indices/shrink.rb +3 -1
  56. data/lib/opensearch/api/actions/indices/simulate_index_template.rb +4 -2
  57. data/lib/opensearch/api/actions/indices/simulate_template.rb +4 -2
  58. data/lib/opensearch/api/actions/indices/split.rb +3 -1
  59. data/lib/opensearch/api/actions/indices/update_aliases.rb +4 -2
  60. data/lib/opensearch/api/actions/ingest/delete_pipeline.rb +3 -1
  61. data/lib/opensearch/api/actions/ingest/get_pipeline.rb +4 -2
  62. data/lib/opensearch/api/actions/ingest/put_pipeline.rb +3 -1
  63. data/lib/opensearch/api/actions/put_script.rb +3 -1
  64. data/lib/opensearch/api/actions/search_shards.rb +1 -1
  65. data/lib/opensearch/api/actions/snapshot/cleanup_repository.rb +3 -1
  66. data/lib/opensearch/api/actions/snapshot/clone.rb +4 -2
  67. data/lib/opensearch/api/actions/snapshot/create.rb +3 -1
  68. data/lib/opensearch/api/actions/snapshot/create_repository.rb +3 -1
  69. data/lib/opensearch/api/actions/snapshot/delete.rb +4 -2
  70. data/lib/opensearch/api/actions/snapshot/delete_repository.rb +3 -1
  71. data/lib/opensearch/api/actions/snapshot/get.rb +3 -1
  72. data/lib/opensearch/api/actions/snapshot/get_features.rb +4 -2
  73. data/lib/opensearch/api/actions/snapshot/get_repository.rb +3 -2
  74. data/lib/opensearch/api/actions/snapshot/restore.rb +3 -1
  75. data/lib/opensearch/api/actions/snapshot/status.rb +3 -1
  76. data/lib/opensearch/api/actions/snapshot/verify_repository.rb +3 -1
  77. data/lib/opensearch/api/utils.rb +4 -4
  78. data/lib/opensearch/api/version.rb +1 -1
  79. data/spec/opensearch/api/actions/cat/allocation_spec.rb +6 -7
  80. data/spec/opensearch/api/actions/cat/cluster_manager_spec.rb +26 -0
  81. data/spec/opensearch/api/actions/get_script_spec.rb +2 -2
  82. data/spec/opensearch/api/actions/hashie_spec.rb +0 -2
  83. data/spec/opensearch/api/actions/indices/clone_spec.rb +2 -2
  84. data/spec/opensearch/api/utils_spec.rb +6 -6
  85. data.tar.gz.sig +0 -0
  86. metadata +14 -11
  87. metadata.gz.sig +0 -0
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 51853db273e9ec1c68dcbc6a9e0f47dec778abf7b3983ff406d45ab2c7a8c6a4
4
- data.tar.gz: ec3001aa95a793ebe2473b4991cf1b203164627f51fa0bf0317e3b64de6ee92e
3
+ metadata.gz: 120d26d2c00900982e0318694e71ac6ad804b2f19ffe11539005b69eadf9775f
4
+ data.tar.gz: 5beaf8317d9f30aedf3b05765f518cd7d2bb853192c0d7fc7ab86747fd1e8aad
5
5
  SHA512:
6
- metadata.gz: 894cc99cd81a9a9e5d3a3960ac3856de63e34efc4798286eb4aa99faff06c68d43974ca53e3f176efa3671c1a7575fbcde67bfff4acdf1f0d657d6135e906763
7
- data.tar.gz: d9eaab4e5888fec4f1b11686b90d8141f04d5a03b7cc0e0688ea0691c0d7b5b643082059c3fec2d35bc20874e282ad3cbab83e26c1d8c8e6a7e2af641213e666
6
+ metadata.gz: daea96255b4d9a9ae424b03bb6ee49e1d6a62bc1a11e4cffcf50359e640350b22f37f0aa37ff5ed1fe069c1c5a313c2504e4b077308c6b19af3c34a4bff8898b
7
+ data.tar.gz: e2aff66e8cfad49e553e708a5f77e0ad100e1d601006f4a9987901782ddb22e586c06cb125b14db9ca65defdfa50cd903c935b5d0a7abe6420408544d5bcb353
checksums.yaml.gz.sig CHANGED
Binary file
data/Gemfile CHANGED
@@ -33,8 +33,8 @@ if File.exist? File.expand_path("../../opensearch-transport", __FILE__)
33
33
  gem 'opensearch-transport', path: File.expand_path("../../opensearch-transport", __FILE__), require: true
34
34
  end
35
35
 
36
- if File.exist? File.expand_path("../../opensearch/opensearch.gemspec", __FILE__)
37
- gem 'opensearch-ruby', path: File.expand_path("../../opensearch", __FILE__), require: false
36
+ if File.exist? File.expand_path("../../opensearch-ruby/opensearch-ruby.gemspec", __FILE__)
37
+ gem 'opensearch-ruby', path: File.expand_path("../../opensearch-ruby", __FILE__), require: false
38
38
  end
39
39
 
40
40
  group :development do
data/Rakefile CHANGED
@@ -56,9 +56,9 @@ namespace :test do
56
56
  url = ENV['TEST_CLUSTER_URL'] || ENV['TEST_OPENSEARCH_SERVER']
57
57
  url = "http://localhost:#{ENV['TEST_CLUSTER_PORT'] || 9200}" unless url
58
58
  client = OpenSearch::Client.new :url => url
59
- es_version_info = client.info['version']
60
- version_number = es_version_info['number']
61
- build_hash = es_version_info['build_hash']
59
+ os_version_info = client.info['version']
60
+ version_number = os_version_info['number']
61
+ build_hash = os_version_info['build_hash']
62
62
  rescue Faraday::ConnectionFailed
63
63
  STDERR.puts "[!] Test cluster not running?"
64
64
  exit 1
@@ -33,8 +33,9 @@ module OpenSearch
33
33
  # @option arguments [List] :node_id A comma-separated list of node IDs or names to limit the returned information
34
34
  # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml
35
35
  # @option arguments [String] :bytes The unit in which to display byte values (options: b, k, kb, m, mb, g, gb, t, tb, p, pb)
36
- # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false)
37
- # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
36
+ # @option arguments [Boolean] :local Return local information, do not retrieve the state from cluster_manager node (default: false)
37
+ # @option arguments [Time] :master_timeout (DEPRECATED: use cluster_manager_timeout instead) Explicit operation timeout for connection to master node
38
+ # @option arguments [Time] :cluster_manager_timeout Explicit operation timeout for connection to cluster_manager node
38
39
  # @option arguments [List] :h Comma-separated list of column names to display
39
40
  # @option arguments [Boolean] :help Return help information
40
41
  # @option arguments [List] :s Comma-separated list of column names or column aliases to sort by
@@ -70,6 +71,7 @@ module OpenSearch
70
71
  :bytes,
71
72
  :local,
72
73
  :master_timeout,
74
+ :cluster_manager_timeout,
73
75
  :h,
74
76
  :help,
75
77
  :s,
@@ -0,0 +1,54 @@
1
+ # SPDX-License-Identifier: Apache-2.0
2
+ #
3
+ # The OpenSearch Contributors require contributions made to
4
+ # this file be licensed under the Apache-2.0 license or a
5
+ # compatible open source license.
6
+ #
7
+ # Modifications Copyright OpenSearch Contributors. See
8
+ # GitHub history for details.
9
+
10
+ module OpenSearch
11
+ module API
12
+ module Cat
13
+ module Actions
14
+ # Returns information about the cluster_manager node.
15
+ #
16
+ # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml
17
+ # @option arguments [Boolean] :local Return local information, do not retrieve the state from cluster_manager node (default: false)
18
+ # @option arguments [Time] :cluster_manager_timeout Explicit operation timeout for connection to cluster_manager node
19
+ # @option arguments [List] :h Comma-separated list of column names to display
20
+ # @option arguments [Boolean] :help Return help information
21
+ # @option arguments [List] :s Comma-separated list of column names or column aliases to sort by
22
+ # @option arguments [Boolean] :v Verbose mode. Display column headers
23
+ # @option arguments [Hash] :headers Custom HTTP headers
24
+ #
25
+ #
26
+ def cluster_manager(arguments = {})
27
+ headers = arguments.delete(:headers) || {}
28
+
29
+ arguments = arguments.clone
30
+
31
+ method = OpenSearch::API::HTTP_GET
32
+ path = '_cat/cluster_manager'
33
+ params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
34
+
35
+ body = nil
36
+ perform_request(method, path, params, body, headers).body
37
+ end
38
+
39
+ # Register this action with its valid params when the module is loaded.
40
+ #
41
+ # @since 6.2.0
42
+ ParamsRegistry.register(:cluster_manager, %i[
43
+ format
44
+ local
45
+ cluster_manager_timeout
46
+ h
47
+ help
48
+ s
49
+ v
50
+ ].freeze)
51
+ end
52
+ end
53
+ end
54
+ end
@@ -33,8 +33,9 @@ module OpenSearch
33
33
  # @option arguments [List] :index A comma-separated list of index names to limit the returned information
34
34
  # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml
35
35
  # @option arguments [String] :bytes The unit in which to display byte values (options: b, k, kb, m, mb, g, gb, t, tb, p, pb)
36
- # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false) *Deprecated*
37
- # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
36
+ # @option arguments [Boolean] :local Return local information, do not retrieve the state from cluster_manager node (default: false)
37
+ # @option arguments [Time] :master_timeout (DEPRECATED: use cluster_manager_timeout instead) Explicit operation timeout for connection to master node
38
+ # @option arguments [Time] :cluster_manager_timeout Explicit operation timeout for connection to cluster_manager node
38
39
  # @option arguments [List] :h Comma-separated list of column names to display
39
40
  # @option arguments [String] :health A health status ("green", "yellow", or "red" to filter only indices matching the specified health status (options: green, yellow, red)
40
41
  # @option arguments [Boolean] :help Return help information
@@ -75,6 +76,7 @@ module OpenSearch
75
76
  :bytes,
76
77
  :local,
77
78
  :master_timeout,
79
+ :cluster_manager_timeout,
78
80
  :h,
79
81
  :health,
80
82
  :help,
@@ -23,7 +23,8 @@
23
23
  # KIND, either express or implied. See the License for the
24
24
  # specific language governing permissions and limitations
25
25
  # under the License.
26
-
26
+
27
+ # @deprecated Please use cluster_manager instead.
27
28
  module OpenSearch
28
29
  module API
29
30
  module Cat
@@ -60,6 +61,7 @@ module OpenSearch
60
61
  :format,
61
62
  :local,
62
63
  :master_timeout,
64
+ :cluster_manager_timeout,
63
65
  :h,
64
66
  :help,
65
67
  :s,
@@ -31,8 +31,9 @@ module OpenSearch
31
31
  # Returns information about custom node attributes.
32
32
  #
33
33
  # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml
34
- # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false)
35
- # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
34
+ # @option arguments [Boolean] :local Return local information, do not retrieve the state from cluster_manager node (default: false)
35
+ # @option arguments [Time] :master_timeout (DEPRECATED: use cluster_manager_timeout instead) Explicit operation timeout for connection to master node
36
+ # @option arguments [Time] :cluster_manager_timeout Explicit operation timeout for connection to cluster_manager node
36
37
  # @option arguments [List] :h Comma-separated list of column names to display
37
38
  # @option arguments [Boolean] :help Return help information
38
39
  # @option arguments [List] :s Comma-separated list of column names or column aliases to sort by
@@ -60,6 +61,7 @@ module OpenSearch
60
61
  :format,
61
62
  :local,
62
63
  :master_timeout,
64
+ :cluster_manager_timeout,
63
65
  :h,
64
66
  :help,
65
67
  :s,
@@ -33,8 +33,9 @@ module OpenSearch
33
33
  # @option arguments [String] :bytes The unit in which to display byte values (options: b, k, kb, m, mb, g, gb, t, tb, p, pb)
34
34
  # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml
35
35
  # @option arguments [Boolean] :full_id Return the full node ID instead of the shortened version (default: false)
36
- # @option arguments [Boolean] :local Calculate the selected nodes using the local cluster state rather than the state from master node (default: false) *Deprecated*
37
- # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
36
+ # @option arguments [Boolean] :local Calculate the selected nodes using the local cluster state rather than the state from cluster_manager node (default: false) *Deprecated*
37
+ # @option arguments [Time] :master_timeout (DEPRECATED: use cluster_manager_timeout instead) Explicit operation timeout for connection to master node
38
+ # @option arguments [Time] :cluster_manager_timeout Explicit operation timeout for connection to cluster_manager node
38
39
  # @option arguments [List] :h Comma-separated list of column names to display
39
40
  # @option arguments [Boolean] :help Return help information
40
41
  # @option arguments [List] :s Comma-separated list of column names or column aliases to sort by
@@ -67,6 +68,7 @@ module OpenSearch
67
68
  :full_id,
68
69
  :local,
69
70
  :master_timeout,
71
+ :cluster_manager_timeout,
70
72
  :h,
71
73
  :help,
72
74
  :s,
@@ -31,8 +31,9 @@ module OpenSearch
31
31
  # Returns a concise representation of the cluster pending tasks.
32
32
  #
33
33
  # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml
34
- # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false)
35
- # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
34
+ # @option arguments [Boolean] :local Return local information, do not retrieve the state from cluster_manager node (default: false)
35
+ # @option arguments [Time] :master_timeout (DEPRECATED: use cluster_manager_timeout instead) Explicit operation timeout for connection to master node
36
+ # @option arguments [Time] :cluster_manager_timeout Explicit operation timeout for connection to cluster_manager node
36
37
  # @option arguments [List] :h Comma-separated list of column names to display
37
38
  # @option arguments [Boolean] :help Return help information
38
39
  # @option arguments [List] :s Comma-separated list of column names or column aliases to sort by
@@ -62,6 +63,7 @@ module OpenSearch
62
63
  :format,
63
64
  :local,
64
65
  :master_timeout,
66
+ :cluster_manager_timeout,
65
67
  :h,
66
68
  :help,
67
69
  :s,
@@ -31,8 +31,9 @@ module OpenSearch
31
31
  # Returns information about installed plugins across nodes node.
32
32
  #
33
33
  # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml
34
- # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false)
35
- # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
34
+ # @option arguments [Boolean] :local Return local information, do not retrieve the state from cluster_manager node (default: false)
35
+ # @option arguments [Time] :master_timeout (DEPRECATED: use cluster_manager_timeout instead) Explicit operation timeout for connection to master node
36
+ # @option arguments [Time] :cluster_manager_timeout Explicit operation timeout for connection to cluster_manager node
36
37
  # @option arguments [List] :h Comma-separated list of column names to display
37
38
  # @option arguments [Boolean] :help Return help information
38
39
  # @option arguments [Boolean] :include_bootstrap Include bootstrap plugins in the response
@@ -61,6 +62,7 @@ module OpenSearch
61
62
  :format,
62
63
  :local,
63
64
  :master_timeout,
65
+ :cluster_manager_timeout,
64
66
  :h,
65
67
  :help,
66
68
  :include_bootstrap,
@@ -32,8 +32,9 @@ module OpenSearch
32
32
  # Returns information about snapshot repositories registered in the cluster.
33
33
  #
34
34
  # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml
35
- # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node
36
- # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
35
+ # @option arguments [Boolean] :local Return local information, do not retrieve the state from cluster_manager node
36
+ # @option arguments [Time] :master_timeout (DEPRECATED: use cluster_manager_timeout instead) Explicit operation timeout for connection to master node
37
+ # @option arguments [Time] :cluster_manager_timeout Explicit operation timeout for connection to cluster_manager node
37
38
  # @option arguments [List] :h Comma-separated list of column names to display
38
39
  # @option arguments [Boolean] :help Return help information
39
40
  # @option arguments [List] :s Comma-separated list of column names or column aliases to sort by
@@ -61,6 +62,7 @@ module OpenSearch
61
62
  :format,
62
63
  :local,
63
64
  :master_timeout,
65
+ :cluster_manager_timeout,
64
66
  :h,
65
67
  :help,
66
68
  :s,
@@ -33,8 +33,9 @@ module OpenSearch
33
33
  # @option arguments [List] :index A comma-separated list of index names to limit the returned information
34
34
  # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml
35
35
  # @option arguments [String] :bytes The unit in which to display byte values (options: b, k, kb, m, mb, g, gb, t, tb, p, pb)
36
- # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false) *Deprecated*
37
- # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
36
+ # @option arguments [Boolean] :local Return local information, do not retrieve the state from cluster_manager node (default: false) *Deprecated*
37
+ # @option arguments [Time] :master_timeout (DEPRECATED: use cluster_manager_timeout instead) Explicit operation timeout for connection to master node
38
+ # @option arguments [Time] :cluster_manager_timeout Explicit operation timeout for connection to cluster_manager node
38
39
  # @option arguments [List] :h Comma-separated list of column names to display
39
40
  # @option arguments [Boolean] :help Return help information
40
41
  # @option arguments [List] :s Comma-separated list of column names or column aliases to sort by
@@ -71,6 +72,7 @@ module OpenSearch
71
72
  :bytes,
72
73
  :local,
73
74
  :master_timeout,
75
+ :cluster_manager_timeout,
74
76
  :h,
75
77
  :help,
76
78
  :s,
@@ -33,7 +33,8 @@ module OpenSearch
33
33
  # @option arguments [List] :repository Name of repository from which to fetch the snapshot information
34
34
  # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml
35
35
  # @option arguments [Boolean] :ignore_unavailable Set to true to ignore unavailable snapshots
36
- # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
36
+ # @option arguments [Time] :master_timeout (DEPRECATED: use cluster_manager_timeout instead) Explicit operation timeout for connection to master node
37
+ # @option arguments [Time] :cluster_manager_timeout Explicit operation timeout for connection to cluster_manager node
37
38
  # @option arguments [List] :h Comma-separated list of column names to display
38
39
  # @option arguments [Boolean] :help Return help information
39
40
  # @option arguments [List] :s Comma-separated list of column names or column aliases to sort by
@@ -68,6 +69,7 @@ module OpenSearch
68
69
  :format,
69
70
  :ignore_unavailable,
70
71
  :master_timeout,
72
+ :cluster_manager_timeout,
71
73
  :h,
72
74
  :help,
73
75
  :s,
@@ -32,8 +32,9 @@ module OpenSearch
32
32
  #
33
33
  # @option arguments [String] :name A pattern that returned template names must match
34
34
  # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml
35
- # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false)
36
- # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
35
+ # @option arguments [Boolean] :local Return local information, do not retrieve the state from cluster_manager node (default: false)
36
+ # @option arguments [Time] :master_timeout (DEPRECATED: use cluster_manager_timeout instead) Explicit operation timeout for connection to master node
37
+ # @option arguments [Time] :cluster_manager_timeout Explicit operation timeout for connection to cluster_manager node
37
38
  # @option arguments [List] :h Comma-separated list of column names to display
38
39
  # @option arguments [Boolean] :help Return help information
39
40
  # @option arguments [List] :s Comma-separated list of column names or column aliases to sort by
@@ -67,6 +68,7 @@ module OpenSearch
67
68
  :format,
68
69
  :local,
69
70
  :master_timeout,
71
+ :cluster_manager_timeout,
70
72
  :h,
71
73
  :help,
72
74
  :s,
@@ -34,8 +34,9 @@ module OpenSearch
34
34
  # @option arguments [List] :thread_pool_patterns A comma-separated list of regular-expressions to filter the thread pools in the output
35
35
  # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml
36
36
  # @option arguments [String] :size The multiplier in which to display values *Deprecated* (options: , k, m, g, t, p)
37
- # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false)
38
- # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
37
+ # @option arguments [Boolean] :local Return local information, do not retrieve the state from cluster_manager node (default: false)
38
+ # @option arguments [Time] :master_timeout (DEPRECATED: use cluster_manager_timeout instead) Explicit operation timeout for connection to master node
39
+ # @option arguments [Time] :cluster_manager_timeout Explicit operation timeout for connection to cluster_manager node
39
40
  # @option arguments [List] :h Comma-separated list of column names to display
40
41
  # @option arguments [Boolean] :help Return help information
41
42
  # @option arguments [List] :s Comma-separated list of column names or column aliases to sort by
@@ -71,6 +72,7 @@ module OpenSearch
71
72
  :size,
72
73
  :local,
73
74
  :master_timeout,
75
+ :cluster_manager_timeout,
74
76
  :h,
75
77
  :help,
76
78
  :s,
@@ -32,7 +32,8 @@ module OpenSearch
32
32
  #
33
33
  # @option arguments [String] :name The name of the template
34
34
  # @option arguments [Time] :timeout Explicit operation timeout
35
- # @option arguments [Time] :master_timeout Specify timeout for connection to master
35
+ # @option arguments [Time] :master_timeout (DEPRECATED: use cluster_manager_timeout instead) Specify timeout for connection to master
36
+ # @option arguments [Time] :cluster_manager_timeout Specify timeout for connection to cluster_manager
36
37
  # @option arguments [Hash] :headers Custom HTTP headers
37
38
  #
38
39
  #
@@ -58,7 +59,8 @@ module OpenSearch
58
59
  # @since 6.2.0
59
60
  ParamsRegistry.register(:delete_component_template, [
60
61
  :timeout,
61
- :master_timeout
62
+ :master_timeout,
63
+ :cluster_manager_timeout
62
64
  ].freeze)
63
65
  end
64
66
  end
@@ -31,8 +31,9 @@ module OpenSearch
31
31
  # Returns information about whether a particular component template exist
32
32
  #
33
33
  # @option arguments [String] :name The name of the template
34
- # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
35
- # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false)
34
+ # @option arguments [Time] :master_timeout (DEPRECATED: use cluster_manager_timeout instead) Explicit operation timeout for connection to master node
35
+ # @option arguments [Time] :cluster_manager_timeout Explicit operation timeout for connection to cluster_manager node
36
+ # @option arguments [Boolean] :local Return local information, do not retrieve the state from cluster_manager node (default: false)
36
37
  # @option arguments [Hash] :headers Custom HTTP headers
37
38
  #
38
39
  #
@@ -60,6 +61,7 @@ module OpenSearch
60
61
  # @since 6.2.0
61
62
  ParamsRegistry.register(:exists_component_template, [
62
63
  :master_timeout,
64
+ :cluster_manager_timeout,
63
65
  :local
64
66
  ].freeze)
65
67
  end
@@ -31,8 +31,9 @@ module OpenSearch
31
31
  # Returns one or more component templates
32
32
  #
33
33
  # @option arguments [List] :name The comma separated names of the component templates
34
- # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
35
- # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false)
34
+ # @option arguments [Time] :master_timeout (DEPRECATED: use cluster_manager_timeout instead) Explicit operation timeout for connection to master node
35
+ # @option arguments [Time] :cluster_manager_timeout Explicit operation timeout for connection to cluster_manager node
36
+ # @option arguments [Boolean] :local Return local information, do not retrieve the state from cluster_manager node (default: false)
36
37
  # @option arguments [Hash] :headers Custom HTTP headers
37
38
  #
38
39
  #
@@ -60,6 +61,7 @@ module OpenSearch
60
61
  # @since 6.2.0
61
62
  ParamsRegistry.register(:get_component_template, [
62
63
  :master_timeout,
64
+ :cluster_manager_timeout,
63
65
  :local
64
66
  ].freeze)
65
67
  end
@@ -31,7 +31,8 @@ module OpenSearch
31
31
  # Returns cluster settings.
32
32
  #
33
33
  # @option arguments [Boolean] :flat_settings Return settings in flat format (default: false)
34
- # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
34
+ # @option arguments [Time] :master_timeout (DEPRECATED: use cluster_manager_timeout instead) Explicit operation timeout for connection to master node
35
+ # @option arguments [Time] :cluster_manager_timeout Explicit operation timeout for connection to cluster_manager node
35
36
  # @option arguments [Time] :timeout Explicit operation timeout
36
37
  # @option arguments [Boolean] :include_defaults Whether to return all default clusters setting.
37
38
  # @option arguments [Hash] :headers Custom HTTP headers
@@ -56,6 +57,7 @@ module OpenSearch
56
57
  ParamsRegistry.register(:get_settings, [
57
58
  :flat_settings,
58
59
  :master_timeout,
60
+ :cluster_manager_timeout,
59
61
  :timeout,
60
62
  :include_defaults
61
63
  ].freeze)
@@ -33,8 +33,9 @@ module OpenSearch
33
33
  # @option arguments [List] :index Limit the information returned to a specific index
34
34
  # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all)
35
35
  # @option arguments [String] :level Specify the level of detail for returned information (options: cluster, indices, shards)
36
- # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false)
37
- # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
36
+ # @option arguments [Boolean] :local Return local information, do not retrieve the state from cluster_manager node (default: false)
37
+ # @option arguments [Time] :master_timeout (DEPRECATED: use cluster_manager_timeout instead) Explicit operation timeout for connection to master node
38
+ # @option arguments [Time] :cluster_manager_timeout Explicit operation timeout for connection to cluster_manager node
38
39
  # @option arguments [Time] :timeout Explicit operation timeout
39
40
  # @option arguments [String] :wait_for_active_shards Wait until the specified number of shards is active
40
41
  # @option arguments [String] :wait_for_nodes Wait until the specified number of nodes is available
@@ -72,6 +73,7 @@ module OpenSearch
72
73
  :level,
73
74
  :local,
74
75
  :master_timeout,
76
+ :cluster_manager_timeout,
75
77
  :timeout,
76
78
  :wait_for_active_shards,
77
79
  :wait_for_nodes,
@@ -31,8 +31,9 @@ module OpenSearch
31
31
  # Returns a list of any cluster-level changes (e.g. create index, update mapping,
32
32
  # allocate or fail shard) which have not yet been executed.
33
33
  #
34
- # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false)
35
- # @option arguments [Time] :master_timeout Specify timeout for connection to master
34
+ # @option arguments [Boolean] :local Return local information, do not retrieve the state from cluster_manager node (default: false)
35
+ # @option arguments [Time] :master_timeout (DEPRECATED: use cluster_manager_timeout instead) Specify timeout for connection to master
36
+ # @option arguments [Time] :cluster_manager_timeout Specify timeout for connection to cluster_manager
36
37
  # @option arguments [Hash] :headers Custom HTTP headers
37
38
  #
38
39
  #
@@ -54,7 +55,8 @@ module OpenSearch
54
55
  # @since 6.2.0
55
56
  ParamsRegistry.register(:pending_tasks, [
56
57
  :local,
57
- :master_timeout
58
+ :master_timeout,
59
+ :cluster_manager_timeout
58
60
  ].freeze)
59
61
  end
60
62
  end
@@ -33,7 +33,8 @@ module OpenSearch
33
33
  # @option arguments [String] :name The name of the template
34
34
  # @option arguments [Boolean] :create Whether the index template should only be added if new or can also replace an existing one
35
35
  # @option arguments [Time] :timeout Explicit operation timeout
36
- # @option arguments [Time] :master_timeout Specify timeout for connection to master
36
+ # @option arguments [Time] :master_timeout (DEPRECATED: use cluster_manager_timeout instead) Specify timeout for connection to master
37
+ # @option arguments [Time] :cluster_manager_timeout Specify timeout for connection to cluster_manager
37
38
  # @option arguments [Hash] :headers Custom HTTP headers
38
39
  # @option arguments [Hash] :body The template definition (*Required*)
39
40
  #
@@ -62,7 +63,8 @@ module OpenSearch
62
63
  ParamsRegistry.register(:put_component_template, [
63
64
  :create,
64
65
  :timeout,
65
- :master_timeout
66
+ :master_timeout,
67
+ :cluster_manager_timeout
66
68
  ].freeze)
67
69
  end
68
70
  end
@@ -31,7 +31,8 @@ module OpenSearch
31
31
  # Updates the cluster settings.
32
32
  #
33
33
  # @option arguments [Boolean] :flat_settings Return settings in flat format (default: false)
34
- # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
34
+ # @option arguments [Time] :master_timeout (DEPRECATED: use cluster_manager_timeout instead) Explicit operation timeout for connection to master node
35
+ # @option arguments [Time] :cluster_manager_timeout Explicit operation timeout for connection to cluster_manager node
35
36
  # @option arguments [Time] :timeout Explicit operation timeout
36
37
  # @option arguments [Hash] :headers Custom HTTP headers
37
38
  # @option arguments [Hash] :body The settings to be updated. Can be either `transient` or `persistent` (survives cluster restart). (*Required*)
@@ -58,6 +59,7 @@ module OpenSearch
58
59
  ParamsRegistry.register(:put_settings, [
59
60
  :flat_settings,
60
61
  :master_timeout,
62
+ :cluster_manager_timeout,
61
63
  :timeout
62
64
  ].freeze)
63
65
  end
@@ -33,8 +33,9 @@ module OpenSearch
33
33
  # @option arguments [Boolean] :dry_run Simulate the operation only and return the resulting state
34
34
  # @option arguments [Boolean] :explain Return an explanation of why the commands can or cannot be executed
35
35
  # @option arguments [Boolean] :retry_failed Retries allocation of shards that are blocked due to too many subsequent allocation failures
36
- # @option arguments [List] :metric Limit the information returned to the specified metrics. Defaults to all but metadata (options: _all, blocks, metadata, nodes, routing_table, master_node, version)
37
- # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
36
+ # @option arguments [List] :metric Limit the information returned to the specified metrics. Defaults to all but metadata (options: _all, blocks, metadata, nodes, routing_table, cluster_manager_node, version)
37
+ # @option arguments [Time] :master_timeout (DEPRECATED: use cluster_manager_timeout instead) Explicit operation timeout for connection to master node
38
+ # @option arguments [Time] :cluster_manager_timeout Explicit operation timeout for connection to cluster_manager node
38
39
  # @option arguments [Time] :timeout Explicit operation timeout
39
40
  # @option arguments [Hash] :headers Custom HTTP headers
40
41
  # @option arguments [Hash] :body The definition of `commands` to perform (`move`, `cancel`, `allocate`)
@@ -62,6 +63,7 @@ module OpenSearch
62
63
  :retry_failed,
63
64
  :metric,
64
65
  :master_timeout,
66
+ :cluster_manager_timeout,
65
67
  :timeout
66
68
  ].freeze)
67
69
  end
@@ -32,8 +32,9 @@ module OpenSearch
32
32
  #
33
33
  # @option arguments [List] :metric Limit the information returned to the specified metrics (options: _all, blocks, metadata, nodes, routing_table, routing_nodes, master_node, version)
34
34
  # @option arguments [List] :index A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
35
- # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false)
36
- # @option arguments [Time] :master_timeout Specify timeout for connection to master
35
+ # @option arguments [Boolean] :local Return local information, do not retrieve the state from cluster_manager node (default: false)
36
+ # @option arguments [Time] :master_timeout (DEPRECATED: use cluster_manager_timeout instead) Specify timeout for connection to master
37
+ # @option arguments [Time] :cluster_manager_timeout Specify timeout for connection to cluster_manager
37
38
  # @option arguments [Boolean] :flat_settings Return settings in flat format (default: false)
38
39
  # @option arguments [Number] :wait_for_metadata_version Wait for the metadata version to be equal or greater than the specified metadata version
39
40
  # @option arguments [Time] :wait_for_timeout The maximum time to wait for wait_for_metadata_version before timing out
@@ -72,6 +73,7 @@ module OpenSearch
72
73
  ParamsRegistry.register(:state, [
73
74
  :local,
74
75
  :master_timeout,
76
+ :cluster_manager_timeout,
75
77
  :flat_settings,
76
78
  :wait_for_metadata_version,
77
79
  :wait_for_timeout,
@@ -33,7 +33,8 @@ module OpenSearch
33
33
  # @option arguments [String] :index_uuid The UUID of the dangling index
34
34
  # @option arguments [Boolean] :accept_data_loss Must be set to true in order to delete the dangling index
35
35
  # @option arguments [Time] :timeout Explicit operation timeout
36
- # @option arguments [Time] :master_timeout Specify timeout for connection to master
36
+ # @option arguments [Time] :master_timeout (DEPRECATED: use cluster_manager_timeout instead) Specify timeout for connection to master
37
+ # @option arguments [Time] :cluster_manager_timeout Specify timeout for connection to cluster_manager
37
38
  # @option arguments [Hash] :headers Custom HTTP headers
38
39
  #
39
40
  #
@@ -60,7 +61,8 @@ module OpenSearch
60
61
  ParamsRegistry.register(:delete_dangling_index, [
61
62
  :accept_data_loss,
62
63
  :timeout,
63
- :master_timeout
64
+ :master_timeout,
65
+ :cluster_manager_timeout
64
66
  ].freeze)
65
67
  end
66
68
  end
@@ -33,7 +33,8 @@ module OpenSearch
33
33
  # @option arguments [String] :index_uuid The UUID of the dangling index
34
34
  # @option arguments [Boolean] :accept_data_loss Must be set to true in order to import the dangling index
35
35
  # @option arguments [Time] :timeout Explicit operation timeout
36
- # @option arguments [Time] :master_timeout Specify timeout for connection to master
36
+ # @option arguments [Time] :master_timeout (DEPRECATED: use cluster_manager_timeout instead) Specify timeout for connection to master
37
+ # @option arguments [Time] :cluster_manager_timeout Specify timeout for connection to cluster_manager
37
38
  # @option arguments [Hash] :headers Custom HTTP headers
38
39
  #
39
40
  def import_dangling_index(arguments = {})
@@ -59,7 +60,8 @@ module OpenSearch
59
60
  ParamsRegistry.register(:import_dangling_index, [
60
61
  :accept_data_loss,
61
62
  :timeout,
62
- :master_timeout
63
+ :master_timeout,
64
+ :cluster_manager_timeout
63
65
  ].freeze)
64
66
  end
65
67
  end
@@ -31,7 +31,8 @@ module OpenSearch
31
31
  #
32
32
  # @option arguments [String] :id Script ID
33
33
  # @option arguments [Time] :timeout Explicit operation timeout
34
- # @option arguments [Time] :master_timeout Specify timeout for connection to master
34
+ # @option arguments [Time] :master_timeout (DEPRECATED: use cluster_manager_timeout instead) Specify timeout for connection to master
35
+ # @option arguments [Time] :cluster_manager_timeout Specify timeout for connection to cluster_manager
35
36
  # @option arguments [Hash] :headers Custom HTTP headers
36
37
  #
37
38
  #
@@ -57,7 +58,8 @@ module OpenSearch
57
58
  # @since 6.2.0
58
59
  ParamsRegistry.register(:delete_script, [
59
60
  :timeout,
60
- :master_timeout
61
+ :master_timeout,
62
+ :cluster_manager_timeout
61
63
  ].freeze)
62
64
  end
63
65
  end
@@ -30,7 +30,8 @@ module OpenSearch
30
30
  module Actions
31
31
  # Gets a list of features which can be included in snapshots using the feature_states field when creating a snapshot
32
32
  #
33
- # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
33
+ # @option arguments [Time] :master_timeout (DEPRECATED: use cluster_manager_timeout instead) Explicit operation timeout for connection to master node
34
+ # @option arguments [Time] :cluster_manager_timeout Explicit operation timeout for connection to cluster_manager node
34
35
  # @option arguments [Hash] :headers Custom HTTP headers
35
36
  #
36
37
  #
@@ -51,7 +52,8 @@ module OpenSearch
51
52
  #
52
53
  # @since 6.2.0
53
54
  ParamsRegistry.register(:get_features, [
54
- :master_timeout
55
+ :master_timeout,
56
+ :cluster_manager_timeout
55
57
  ].freeze)
56
58
  end
57
59
  end