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
@@ -30,7 +30,8 @@ module OpenSearch
30
30
  # Returns a script.
31
31
  #
32
32
  # @option arguments [String] :id Script ID
33
- # @option arguments [Time] :master_timeout Specify timeout for connection to master
33
+ # @option arguments [Time] :master_timeout (DEPRECATED: use cluster_manager_timeout instead) Specify timeout for connection to master
34
+ # @option arguments [Time] :cluster_manager_timeout Specify timeout for connection to cluster_manager
34
35
  # @option arguments [Hash] :headers Custom HTTP headers
35
36
  #
36
37
  #
@@ -55,7 +56,8 @@ module OpenSearch
55
56
  #
56
57
  # @since 6.2.0
57
58
  ParamsRegistry.register(:get_script, [
58
- :master_timeout
59
+ :master_timeout,
60
+ :cluster_manager_timeout
59
61
  ].freeze)
60
62
  end
61
63
  end
@@ -33,7 +33,8 @@ module OpenSearch
33
33
  # @option arguments [List] :index A comma separated list of indices to add a block to
34
34
  # @option arguments [String] :block The block to add (one of read, write, read_only or metadata)
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 [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed)
38
39
  # @option arguments [Boolean] :allow_no_indices Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)
39
40
  # @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)
@@ -66,6 +67,7 @@ module OpenSearch
66
67
  ParamsRegistry.register(:add_block, [
67
68
  :timeout,
68
69
  :master_timeout,
70
+ :cluster_manager_timeout,
69
71
  :ignore_unavailable,
70
72
  :allow_no_indices,
71
73
  :expand_wildcards
@@ -33,7 +33,8 @@ module OpenSearch
33
33
  # @option arguments [String] :index The name of the source index to clone
34
34
  # @option arguments [String] :target The name of the target index to clone into
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 [String] :wait_for_active_shards Set the number of active shards to wait for on the cloned index before the operation returns.
38
39
  # @option arguments [Hash] :headers Custom HTTP headers
39
40
  # @option arguments [Hash] :body The configuration for the target index (`settings` and `aliases`)
@@ -65,6 +66,7 @@ module OpenSearch
65
66
  ParamsRegistry.register(:clone, [
66
67
  :timeout,
67
68
  :master_timeout,
69
+ :cluster_manager_timeout,
68
70
  :wait_for_active_shards
69
71
  ].freeze)
70
72
  end
@@ -32,7 +32,8 @@ module OpenSearch
32
32
  #
33
33
  # @option arguments [List] :index A comma separated list of indices to close
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 [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed)
37
38
  # @option arguments [Boolean] :allow_no_indices Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)
38
39
  # @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)
@@ -63,6 +64,7 @@ module OpenSearch
63
64
  ParamsRegistry.register(:close, [
64
65
  :timeout,
65
66
  :master_timeout,
67
+ :cluster_manager_timeout,
66
68
  :ignore_unavailable,
67
69
  :allow_no_indices,
68
70
  :expand_wildcards,
@@ -33,7 +33,8 @@ module OpenSearch
33
33
  # @option arguments [String] :index The name of the index
34
34
  # @option arguments [String] :wait_for_active_shards Set the number of active shards to wait for before the operation returns.
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 configuration for the index (`settings` and `mappings`)
39
40
  #
@@ -61,7 +62,8 @@ module OpenSearch
61
62
  ParamsRegistry.register(:create, [
62
63
  :wait_for_active_shards,
63
64
  :timeout,
64
- :master_timeout
65
+ :master_timeout,
66
+ :cluster_manager_timeout
65
67
  ].freeze)
66
68
  end
67
69
  end
@@ -32,7 +32,8 @@ module OpenSearch
32
32
  #
33
33
  # @option arguments [List] :index A comma-separated list of indices to delete; use `_all` or `*` string to delete all indices
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 [Boolean] :ignore_unavailable Ignore unavailable indexes (default: false)
37
38
  # @option arguments [Boolean] :allow_no_indices Ignore if a wildcard expression resolves to no concrete indices (default: false)
38
39
  # @option arguments [String] :expand_wildcards Whether wildcard expressions should get expanded to open or closed indices (default: open) (options: open, closed, hidden, none, all)
@@ -66,6 +67,7 @@ module OpenSearch
66
67
  ParamsRegistry.register(:delete, [
67
68
  :timeout,
68
69
  :master_timeout,
70
+ :cluster_manager_timeout,
69
71
  :ignore_unavailable,
70
72
  :allow_no_indices,
71
73
  :expand_wildcards
@@ -33,7 +33,8 @@ module OpenSearch
33
33
  # @option arguments [List] :index A comma-separated list of index names (supports wildcards); use `_all` for all indices
34
34
  # @option arguments [List] :name A comma-separated list of aliases to delete (supports wildcards); use `_all` to delete all aliases for the specified indices.
35
35
  # @option arguments [Time] :timeout Explicit timestamp for the document
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
  #
@@ -64,7 +65,8 @@ module OpenSearch
64
65
  # @since 6.2.0
65
66
  ParamsRegistry.register(:delete_alias, [
66
67
  :timeout,
67
- :master_timeout
68
+ :master_timeout,
69
+ :cluster_manager_timeout
68
70
  ].freeze)
69
71
  end
70
72
  end
@@ -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_index_template, [
60
61
  :timeout,
61
- :master_timeout
62
+ :master_timeout,
63
+ :cluster_manager_timeout
62
64
  ].freeze)
63
65
  end
64
66
  end
@@ -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
  #
@@ -62,7 +63,8 @@ module OpenSearch
62
63
  # @since 6.2.0
63
64
  ParamsRegistry.register(:delete_template, [
64
65
  :timeout,
65
- :master_timeout
66
+ :master_timeout,
67
+ :cluster_manager_timeout
66
68
  ].freeze)
67
69
  end
68
70
  end
@@ -32,8 +32,9 @@ module OpenSearch
32
32
  #
33
33
  # @option arguments [String] :name The name of the template
34
34
  # @option arguments [Boolean] :flat_settings Return settings in flat format (default: false)
35
- # @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 master 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
37
+ # @option arguments [Boolean] :local Return local information, do not retrieve the state from cluster_manager node (default: false)
37
38
  # @option arguments [Hash] :headers Custom HTTP headers
38
39
  #
39
40
  #
@@ -62,6 +63,7 @@ module OpenSearch
62
63
  ParamsRegistry.register(:exists_index_template, [
63
64
  :flat_settings,
64
65
  :master_timeout,
66
+ :cluster_manager_timeout,
65
67
  :local
66
68
  ].freeze)
67
69
  end
@@ -32,8 +32,9 @@ module OpenSearch
32
32
  #
33
33
  # @option arguments [List] :name The comma separated names of the index templates
34
34
  # @option arguments [Boolean] :flat_settings Return settings in flat format (default: false)
35
- # @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 master 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
37
+ # @option arguments [Boolean] :local Return local information, do not retrieve the state from cluster_manager node (default: false)
37
38
  # @option arguments [Hash] :headers Custom HTTP headers
38
39
  #
39
40
  #
@@ -65,6 +66,7 @@ module OpenSearch
65
66
  ParamsRegistry.register(:exists_template, [
66
67
  :flat_settings,
67
68
  :master_timeout,
69
+ :cluster_manager_timeout,
68
70
  :local
69
71
  ].freeze)
70
72
  end
@@ -37,7 +37,8 @@ module OpenSearch
37
37
  # @option arguments [String] :expand_wildcards Whether wildcard expressions should get expanded to open or closed indices (default: open) (options: open, closed, hidden, none, all)
38
38
  # @option arguments [Boolean] :flat_settings Return settings in flat format (default: false)
39
39
  # @option arguments [Boolean] :include_defaults Whether to return all default setting for each of the indices.
40
- # @option arguments [Time] :master_timeout Specify timeout for connection to master
40
+ # @option arguments [Time] :master_timeout (DEPRECATED: use cluster_manager_timeout instead) Specify timeout for connection to master
41
+ # @option arguments [Time] :cluster_manager_timeout Specify timeout for connection to cluster_manager
41
42
  # @option arguments [Hash] :headers Custom HTTP headers
42
43
  #
43
44
  #
@@ -68,7 +69,8 @@ module OpenSearch
68
69
  :expand_wildcards,
69
70
  :flat_settings,
70
71
  :include_defaults,
71
- :master_timeout
72
+ :master_timeout,
73
+ :cluster_manager_timeout
72
74
  ].freeze)
73
75
  end
74
76
  end
@@ -32,8 +32,9 @@ module OpenSearch
32
32
  #
33
33
  # @option arguments [List] :name The comma separated names of the index templates
34
34
  # @option arguments [Boolean] :flat_settings Return settings in flat format (default: false)
35
- # @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 master 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
37
+ # @option arguments [Boolean] :local Return local information, do not retrieve the state from cluster_manager node (default: false)
37
38
  # @option arguments [Hash] :headers Custom HTTP headers
38
39
  #
39
40
  #
@@ -62,6 +63,7 @@ module OpenSearch
62
63
  ParamsRegistry.register(:get_index_template, [
63
64
  :flat_settings,
64
65
  :master_timeout,
66
+ :cluster_manager_timeout,
65
67
  :local
66
68
  ].freeze)
67
69
  end
@@ -34,8 +34,9 @@ module OpenSearch
34
34
  # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed)
35
35
  # @option arguments [Boolean] :allow_no_indices Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)
36
36
  # @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)
37
- # @option arguments [Time] :master_timeout Specify timeout for connection to master
38
- # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false) *Deprecated*
37
+ # @option arguments [Time] :master_timeout (DEPRECATED: use cluster_manager_timeout instead) Specify timeout for connection to master
38
+ # @option arguments [Time] :cluster_manager_timeout Specify timeout for connection to cluster_manager
39
+ # @option arguments [Boolean] :local Return local information, do not retrieve the state from cluster_manager node (default: false) *Deprecated*
39
40
  # @option arguments [Hash] :headers Custom HTTP headers
40
41
  #
41
42
  # *Deprecation notice*:
@@ -71,6 +72,7 @@ module OpenSearch
71
72
  :allow_no_indices,
72
73
  :expand_wildcards,
73
74
  :master_timeout,
75
+ :cluster_manager_timeout,
74
76
  :local
75
77
  ].freeze)
76
78
  end
@@ -32,7 +32,8 @@ module OpenSearch
32
32
  #
33
33
  # @option arguments [List] :index A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
34
34
  # @option arguments [List] :name The name of the settings that should be included
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 [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed)
37
38
  # @option arguments [Boolean] :allow_no_indices Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)
38
39
  # @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)
@@ -72,6 +73,7 @@ module OpenSearch
72
73
  # @since 6.2.0
73
74
  ParamsRegistry.register(:get_settings, [
74
75
  :master_timeout,
76
+ :cluster_manager_timeout,
75
77
  :ignore_unavailable,
76
78
  :allow_no_indices,
77
79
  :expand_wildcards,
@@ -32,8 +32,9 @@ module OpenSearch
32
32
  #
33
33
  # @option arguments [List] :name The comma separated names of the index templates
34
34
  # @option arguments [Boolean] :flat_settings Return settings in flat format (default: false)
35
- # @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 master 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
37
+ # @option arguments [Boolean] :local Return local information, do not retrieve the state from cluster_manager node (default: false)
37
38
  # @option arguments [Hash] :headers Custom HTTP headers
38
39
  #
39
40
  #
@@ -62,6 +63,7 @@ module OpenSearch
62
63
  ParamsRegistry.register(:get_template, [
63
64
  :flat_settings,
64
65
  :master_timeout,
66
+ :cluster_manager_timeout,
65
67
  :local
66
68
  ].freeze)
67
69
  end
@@ -32,7 +32,8 @@ module OpenSearch
32
32
  #
33
33
  # @option arguments [List] :index A comma separated list of indices to open
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 Explicit operation timeout for connection to cluster_manager node
36
37
  # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed)
37
38
  # @option arguments [Boolean] :allow_no_indices Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)
38
39
  # @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)
@@ -63,6 +64,7 @@ module OpenSearch
63
64
  ParamsRegistry.register(:open, [
64
65
  :timeout,
65
66
  :master_timeout,
67
+ :cluster_manager_timeout,
66
68
  :ignore_unavailable,
67
69
  :allow_no_indices,
68
70
  :expand_wildcards,
@@ -33,7 +33,8 @@ module OpenSearch
33
33
  # @option arguments [List] :index A comma-separated list of index names the alias should point to (supports wildcards); use `_all` to perform the operation on all indices.
34
34
  # @option arguments [String] :name The name of the alias to be created or updated
35
35
  # @option arguments [Time] :timeout Explicit timestamp for the document
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 settings for the alias, such as `routing` or `filter`
39
40
  #
@@ -65,7 +66,8 @@ module OpenSearch
65
66
  # @since 6.2.0
66
67
  ParamsRegistry.register(:put_alias, [
67
68
  :timeout,
68
- :master_timeout
69
+ :master_timeout,
70
+ :cluster_manager_timeout
69
71
  ].freeze)
70
72
  end
71
73
  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 [String] :cause User defined reason for creating/updating the index template
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_index_template, [
63
64
  :create,
64
65
  :cause,
65
- :master_timeout
66
+ :master_timeout,
67
+ :cluster_manager_timeout
66
68
  ].freeze)
67
69
  end
68
70
  end
@@ -32,7 +32,8 @@ module OpenSearch
32
32
  #
33
33
  # @option arguments [List] :index A comma-separated list of index names the mapping should be added to (supports wildcards); use `_all` or omit to add the mapping on all indices.
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 [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed)
37
38
  # @option arguments [Boolean] :allow_no_indices Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)
38
39
  # @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)
@@ -69,6 +70,7 @@ module OpenSearch
69
70
  ParamsRegistry.register(:put_mapping, [
70
71
  :timeout,
71
72
  :master_timeout,
73
+ :cluster_manager_timeout,
72
74
  :ignore_unavailable,
73
75
  :allow_no_indices,
74
76
  :expand_wildcards,
@@ -31,7 +31,8 @@ module OpenSearch
31
31
  # Updates the index settings.
32
32
  #
33
33
  # @option arguments [List] :index A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
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 [Time] :timeout Explicit operation timeout
36
37
  # @option arguments [Boolean] :preserve_existing Whether to update existing settings. If set to `true` existing settings on an index remain unchanged, the default is `false`
37
38
  # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed)
@@ -68,6 +69,7 @@ module OpenSearch
68
69
  # @since 6.2.0
69
70
  ParamsRegistry.register(:put_settings, [
70
71
  :master_timeout,
72
+ :cluster_manager_timeout,
71
73
  :timeout,
72
74
  :preserve_existing,
73
75
  :ignore_unavailable,
@@ -33,7 +33,8 @@ module OpenSearch
33
33
  # @option arguments [String] :name The name of the template
34
34
  # @option arguments [Number] :order The order for this template when merging multiple matching ones (higher numbers are merged later, overriding the lower numbers)
35
35
  # @option arguments [Boolean] :create Whether the index template should only be added if new or can also replace an existing one
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_template, [
63
64
  :order,
64
65
  :create,
65
- :master_timeout
66
+ :master_timeout,
67
+ :cluster_manager_timeout
66
68
  ].freeze)
67
69
  end
68
70
  end
@@ -35,7 +35,8 @@ module OpenSearch
35
35
  # @option arguments [String] :new_index The name of the rollover index
36
36
  # @option arguments [Time] :timeout Explicit operation timeout
37
37
  # @option arguments [Boolean] :dry_run If set to true the rollover action will only be validated but not actually performed even if a condition matches. The default is false
38
- # @option arguments [Time] :master_timeout Specify timeout for connection to master
38
+ # @option arguments [Time] :master_timeout (DEPRECATED: use cluster_manager_timeout instead) Specify timeout for connection to master
39
+ # @option arguments [Time] :cluster_manager_timeout Specify timeout for connection to cluster_manager
39
40
  # @option arguments [String] :wait_for_active_shards Set the number of active shards to wait for on the newly created rollover index before the operation returns.
40
41
  # @option arguments [Hash] :headers Custom HTTP headers
41
42
  # @option arguments [Hash] :body The conditions that needs to be met for executing rollover
@@ -71,6 +72,7 @@ module OpenSearch
71
72
  :timeout,
72
73
  :dry_run,
73
74
  :master_timeout,
75
+ :cluster_manager_timeout,
74
76
  :wait_for_active_shards
75
77
  ].freeze)
76
78
  end
@@ -34,7 +34,8 @@ module OpenSearch
34
34
  # @option arguments [String] :target The name of the target index to shrink into
35
35
  # @option arguments [Boolean] :copy_settings whether or not to copy settings from the source index (defaults to false)
36
36
  # @option arguments [Time] :timeout Explicit operation timeout
37
- # @option arguments [Time] :master_timeout Specify timeout for connection to master
37
+ # @option arguments [Time] :master_timeout (DEPRECATED: use cluster_manager_timeout instead) Specify timeout for connection to master
38
+ # @option arguments [Time] :cluster_manager_timeout Specify timeout for connection to cluster_manager
38
39
  # @option arguments [String] :wait_for_active_shards Set the number of active shards to wait for on the shrunken index before the operation returns.
39
40
  # @option arguments [Hash] :headers Custom HTTP headers
40
41
  # @option arguments [Hash] :body The configuration for the target index (`settings` and `aliases`)
@@ -67,6 +68,7 @@ module OpenSearch
67
68
  :copy_settings,
68
69
  :timeout,
69
70
  :master_timeout,
71
+ :cluster_manager_timeout,
70
72
  :wait_for_active_shards
71
73
  ].freeze)
72
74
  end
@@ -33,7 +33,8 @@ module OpenSearch
33
33
  # @option arguments [String] :name The name of the index (it must be a concrete index name)
34
34
  # @option arguments [Boolean] :create Whether the index template we optionally defined in the body should only be dry-run added if new or can also replace an existing one
35
35
  # @option arguments [String] :cause User defined reason for dry-run creating the new template for simulation purposes
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 New index template definition, which will be included in the simulation, as if it already exists in the system
39
40
  #
@@ -61,7 +62,8 @@ module OpenSearch
61
62
  ParamsRegistry.register(:simulate_index_template, [
62
63
  :create,
63
64
  :cause,
64
- :master_timeout
65
+ :master_timeout,
66
+ :cluster_manager_timeout
65
67
  ].freeze)
66
68
  end
67
69
  end
@@ -33,7 +33,8 @@ module OpenSearch
33
33
  # @option arguments [String] :name The name of the index template
34
34
  # @option arguments [Boolean] :create Whether the index template we optionally defined in the body should only be dry-run added if new or can also replace an existing one
35
35
  # @option arguments [String] :cause User defined reason for dry-run creating the new template for simulation purposes
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 New index template definition to be simulated, if no index template name is specified
39
40
  #
@@ -63,7 +64,8 @@ module OpenSearch
63
64
  ParamsRegistry.register(:simulate_template, [
64
65
  :create,
65
66
  :cause,
66
- :master_timeout
67
+ :master_timeout,
68
+ :cluster_manager_timeout
67
69
  ].freeze)
68
70
  end
69
71
  end
@@ -34,7 +34,8 @@ module OpenSearch
34
34
  # @option arguments [String] :target The name of the target index to split into
35
35
  # @option arguments [Boolean] :copy_settings whether or not to copy settings from the source index (defaults to false)
36
36
  # @option arguments [Time] :timeout Explicit operation timeout
37
- # @option arguments [Time] :master_timeout Specify timeout for connection to master
37
+ # @option arguments [Time] :master_timeout (DEPRECATED: use cluster_manager_timeout instead) Specify timeout for connection to master
38
+ # @option arguments [Time] :cluster_manager_timeout Specify timeout for connection to cluster_manager
38
39
  # @option arguments [String] :wait_for_active_shards Set the number of active shards to wait for on the shrunken index before the operation returns.
39
40
  # @option arguments [Hash] :headers Custom HTTP headers
40
41
  # @option arguments [Hash] :body The configuration for the target index (`settings` and `aliases`)
@@ -67,6 +68,7 @@ module OpenSearch
67
68
  :copy_settings,
68
69
  :timeout,
69
70
  :master_timeout,
71
+ :cluster_manager_timeout,
70
72
  :wait_for_active_shards
71
73
  ].freeze)
72
74
  end
@@ -31,7 +31,8 @@ module OpenSearch
31
31
  # Updates index aliases.
32
32
  #
33
33
  # @option arguments [Time] :timeout Request 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
  # @option arguments [Hash] :body The definition of `actions` to perform (*Required*)
37
38
  #
@@ -56,7 +57,8 @@ module OpenSearch
56
57
  # @since 6.2.0
57
58
  ParamsRegistry.register(:update_aliases, [
58
59
  :timeout,
59
- :master_timeout
60
+ :master_timeout,
61
+ :cluster_manager_timeout
60
62
  ].freeze)
61
63
  end
62
64
  end
@@ -31,7 +31,8 @@ module OpenSearch
31
31
  # Deletes a pipeline.
32
32
  #
33
33
  # @option arguments [String] :id Pipeline ID
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
  #
@@ -58,6 +59,7 @@ module OpenSearch
58
59
  # @since 6.2.0
59
60
  ParamsRegistry.register(:delete_pipeline, [
60
61
  :master_timeout,
62
+ :cluster_manager_timeout,
61
63
  :timeout
62
64
  ].freeze)
63
65
  end
@@ -32,7 +32,8 @@ module OpenSearch
32
32
  #
33
33
  # @option arguments [String] :id Comma separated list of pipeline ids. Wildcards supported
34
34
  # @option arguments [Boolean] :summary Return pipelines without their definitions (default: false)
35
- # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
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 [Hash] :headers Custom HTTP headers
37
38
  #
38
39
  #
@@ -60,7 +61,8 @@ module OpenSearch
60
61
  # @since 6.2.0
61
62
  ParamsRegistry.register(:get_pipeline, [
62
63
  :summary,
63
- :master_timeout
64
+ :master_timeout,
65
+ :cluster_manager_timeout
64
66
  ].freeze)
65
67
  end
66
68
  end
@@ -31,7 +31,8 @@ module OpenSearch
31
31
  # Creates or updates a pipeline.
32
32
  #
33
33
  # @option arguments [String] :id Pipeline ID
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 ingest definition (*Required*)
@@ -60,6 +61,7 @@ module OpenSearch
60
61
  # @since 6.2.0
61
62
  ParamsRegistry.register(:put_pipeline, [
62
63
  :master_timeout,
64
+ :cluster_manager_timeout,
63
65
  :timeout
64
66
  ].freeze)
65
67
  end