elasticsearch-xpack 7.11.2 → 7.12.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (222) hide show
  1. checksums.yaml +4 -4
  2. data/lib/elasticsearch/xpack.rb +8 -0
  3. data/lib/elasticsearch/xpack/api/actions/async_search/delete.rb +1 -1
  4. data/lib/elasticsearch/xpack/api/actions/async_search/get.rb +1 -1
  5. data/lib/elasticsearch/xpack/api/actions/async_search/status.rb +1 -1
  6. data/lib/elasticsearch/xpack/api/actions/async_search/submit.rb +1 -1
  7. data/lib/elasticsearch/xpack/api/actions/autoscaling/delete_autoscaling_policy.rb +2 -6
  8. data/lib/elasticsearch/xpack/api/actions/autoscaling/get_autoscaling_capacity.rb +2 -6
  9. data/lib/elasticsearch/xpack/api/actions/autoscaling/get_autoscaling_policy.rb +2 -6
  10. data/lib/elasticsearch/xpack/api/actions/autoscaling/put_autoscaling_policy.rb +2 -6
  11. data/lib/elasticsearch/xpack/api/actions/cat/ml_data_frame_analytics.rb +1 -1
  12. data/lib/elasticsearch/xpack/api/actions/cat/ml_datafeeds.rb +1 -1
  13. data/lib/elasticsearch/xpack/api/actions/cat/ml_jobs.rb +1 -1
  14. data/lib/elasticsearch/xpack/api/actions/cat/ml_trained_models.rb +1 -1
  15. data/lib/elasticsearch/xpack/api/actions/cat/transforms.rb +1 -1
  16. data/lib/elasticsearch/xpack/api/actions/close_point_in_time.rb +1 -1
  17. data/lib/elasticsearch/xpack/api/actions/cross_cluster_replication/delete_auto_follow_pattern.rb +1 -1
  18. data/lib/elasticsearch/xpack/api/actions/cross_cluster_replication/follow.rb +1 -1
  19. data/lib/elasticsearch/xpack/api/actions/cross_cluster_replication/follow_info.rb +1 -1
  20. data/lib/elasticsearch/xpack/api/actions/cross_cluster_replication/follow_stats.rb +1 -1
  21. data/lib/elasticsearch/xpack/api/actions/cross_cluster_replication/forget_follower.rb +1 -1
  22. data/lib/elasticsearch/xpack/api/actions/cross_cluster_replication/get_auto_follow_pattern.rb +1 -1
  23. data/lib/elasticsearch/xpack/api/actions/cross_cluster_replication/pause_auto_follow_pattern.rb +1 -1
  24. data/lib/elasticsearch/xpack/api/actions/cross_cluster_replication/pause_follow.rb +1 -1
  25. data/lib/elasticsearch/xpack/api/actions/cross_cluster_replication/put_auto_follow_pattern.rb +1 -1
  26. data/lib/elasticsearch/xpack/api/actions/cross_cluster_replication/resume_auto_follow_pattern.rb +1 -1
  27. data/lib/elasticsearch/xpack/api/actions/cross_cluster_replication/resume_follow.rb +1 -1
  28. data/lib/elasticsearch/xpack/api/actions/cross_cluster_replication/stats.rb +1 -1
  29. data/lib/elasticsearch/xpack/api/actions/cross_cluster_replication/unfollow.rb +1 -1
  30. data/lib/elasticsearch/xpack/api/actions/data_frame_transform_deprecated/delete_transform.rb +1 -1
  31. data/lib/elasticsearch/xpack/api/actions/data_frame_transform_deprecated/get_transform.rb +1 -1
  32. data/lib/elasticsearch/xpack/api/actions/data_frame_transform_deprecated/get_transform_stats.rb +1 -1
  33. data/lib/elasticsearch/xpack/api/actions/data_frame_transform_deprecated/preview_transform.rb +1 -1
  34. data/lib/elasticsearch/xpack/api/actions/data_frame_transform_deprecated/put_transform.rb +1 -1
  35. data/lib/elasticsearch/xpack/api/actions/data_frame_transform_deprecated/start_transform.rb +1 -1
  36. data/lib/elasticsearch/xpack/api/actions/data_frame_transform_deprecated/stop_transform.rb +1 -1
  37. data/lib/elasticsearch/xpack/api/actions/data_frame_transform_deprecated/update_transform.rb +1 -1
  38. data/lib/elasticsearch/xpack/api/actions/enrich/delete_policy.rb +1 -1
  39. data/lib/elasticsearch/xpack/api/actions/enrich/execute_policy.rb +1 -1
  40. data/lib/elasticsearch/xpack/api/actions/enrich/get_policy.rb +1 -1
  41. data/lib/elasticsearch/xpack/api/actions/enrich/put_policy.rb +1 -1
  42. data/lib/elasticsearch/xpack/api/actions/enrich/stats.rb +1 -1
  43. data/lib/elasticsearch/xpack/api/actions/eql/delete.rb +1 -1
  44. data/lib/elasticsearch/xpack/api/actions/eql/get.rb +1 -1
  45. data/lib/elasticsearch/xpack/api/actions/eql/get_status.rb +50 -0
  46. data/lib/elasticsearch/xpack/api/actions/eql/search.rb +1 -1
  47. data/lib/elasticsearch/xpack/api/actions/graph/explore.rb +1 -1
  48. data/lib/elasticsearch/xpack/api/actions/index_lifecycle_management/delete_lifecycle.rb +1 -1
  49. data/lib/elasticsearch/xpack/api/actions/index_lifecycle_management/explain_lifecycle.rb +1 -1
  50. data/lib/elasticsearch/xpack/api/actions/index_lifecycle_management/get_lifecycle.rb +1 -1
  51. data/lib/elasticsearch/xpack/api/actions/index_lifecycle_management/get_status.rb +1 -1
  52. data/lib/elasticsearch/xpack/api/actions/index_lifecycle_management/move_to_step.rb +1 -1
  53. data/lib/elasticsearch/xpack/api/actions/index_lifecycle_management/put_lifecycle.rb +1 -1
  54. data/lib/elasticsearch/xpack/api/actions/index_lifecycle_management/remove_policy.rb +1 -1
  55. data/lib/elasticsearch/xpack/api/actions/index_lifecycle_management/retry.rb +1 -1
  56. data/lib/elasticsearch/xpack/api/actions/index_lifecycle_management/start.rb +1 -1
  57. data/lib/elasticsearch/xpack/api/actions/index_lifecycle_management/stop.rb +1 -1
  58. data/lib/elasticsearch/xpack/api/actions/indices/create_data_stream.rb +1 -1
  59. data/lib/elasticsearch/xpack/api/actions/indices/data_streams_stats.rb +1 -1
  60. data/lib/elasticsearch/xpack/api/actions/indices/delete_data_stream.rb +1 -1
  61. data/lib/elasticsearch/xpack/api/actions/indices/freeze.rb +1 -1
  62. data/lib/elasticsearch/xpack/api/actions/indices/get_data_stream.rb +1 -1
  63. data/lib/elasticsearch/xpack/api/actions/indices/migrate_to_data_stream.rb +1 -1
  64. data/lib/elasticsearch/xpack/api/actions/indices/promote_data_stream.rb +1 -1
  65. data/lib/elasticsearch/xpack/api/actions/indices/reload_search_analyzers.rb +1 -1
  66. data/lib/elasticsearch/xpack/api/actions/indices/unfreeze.rb +1 -1
  67. data/lib/elasticsearch/xpack/api/actions/info.rb +1 -1
  68. data/lib/elasticsearch/xpack/api/actions/license/delete.rb +1 -1
  69. data/lib/elasticsearch/xpack/api/actions/license/get.rb +1 -1
  70. data/lib/elasticsearch/xpack/api/actions/license/get_basic_status.rb +1 -1
  71. data/lib/elasticsearch/xpack/api/actions/license/get_trial_status.rb +1 -1
  72. data/lib/elasticsearch/xpack/api/actions/license/post.rb +1 -1
  73. data/lib/elasticsearch/xpack/api/actions/license/post_start_basic.rb +1 -1
  74. data/lib/elasticsearch/xpack/api/actions/license/post_start_trial.rb +1 -1
  75. data/lib/elasticsearch/xpack/api/actions/logstash/delete_pipeline.rb +50 -0
  76. data/lib/elasticsearch/xpack/api/actions/logstash/get_pipeline.rb +50 -0
  77. data/lib/elasticsearch/xpack/api/actions/logstash/put_pipeline.rb +52 -0
  78. data/lib/elasticsearch/xpack/api/actions/machine_learning/close_job.rb +1 -1
  79. data/lib/elasticsearch/xpack/api/actions/machine_learning/delete_calendar.rb +1 -1
  80. data/lib/elasticsearch/xpack/api/actions/machine_learning/delete_calendar_event.rb +1 -1
  81. data/lib/elasticsearch/xpack/api/actions/machine_learning/delete_calendar_job.rb +1 -1
  82. data/lib/elasticsearch/xpack/api/actions/machine_learning/delete_data_frame_analytics.rb +1 -1
  83. data/lib/elasticsearch/xpack/api/actions/machine_learning/delete_datafeed.rb +1 -1
  84. data/lib/elasticsearch/xpack/api/actions/machine_learning/delete_expired_data.rb +1 -1
  85. data/lib/elasticsearch/xpack/api/actions/machine_learning/delete_filter.rb +1 -1
  86. data/lib/elasticsearch/xpack/api/actions/machine_learning/delete_forecast.rb +1 -1
  87. data/lib/elasticsearch/xpack/api/actions/machine_learning/delete_job.rb +1 -1
  88. data/lib/elasticsearch/xpack/api/actions/machine_learning/delete_model_snapshot.rb +1 -1
  89. data/lib/elasticsearch/xpack/api/actions/machine_learning/delete_trained_model.rb +1 -1
  90. data/lib/elasticsearch/xpack/api/actions/machine_learning/estimate_model_memory.rb +1 -1
  91. data/lib/elasticsearch/xpack/api/actions/machine_learning/evaluate_data_frame.rb +1 -1
  92. data/lib/elasticsearch/xpack/api/actions/machine_learning/explain_data_frame_analytics.rb +1 -1
  93. data/lib/elasticsearch/xpack/api/actions/machine_learning/find_file_structure.rb +1 -1
  94. data/lib/elasticsearch/xpack/api/actions/machine_learning/flush_job.rb +1 -1
  95. data/lib/elasticsearch/xpack/api/actions/machine_learning/forecast.rb +1 -1
  96. data/lib/elasticsearch/xpack/api/actions/machine_learning/get_buckets.rb +1 -1
  97. data/lib/elasticsearch/xpack/api/actions/machine_learning/get_calendar_events.rb +1 -1
  98. data/lib/elasticsearch/xpack/api/actions/machine_learning/get_calendars.rb +1 -1
  99. data/lib/elasticsearch/xpack/api/actions/machine_learning/get_categories.rb +1 -1
  100. data/lib/elasticsearch/xpack/api/actions/machine_learning/get_data_frame_analytics.rb +1 -1
  101. data/lib/elasticsearch/xpack/api/actions/machine_learning/get_data_frame_analytics_stats.rb +1 -1
  102. data/lib/elasticsearch/xpack/api/actions/machine_learning/get_datafeed_stats.rb +1 -1
  103. data/lib/elasticsearch/xpack/api/actions/machine_learning/get_datafeeds.rb +1 -1
  104. data/lib/elasticsearch/xpack/api/actions/machine_learning/get_filters.rb +1 -1
  105. data/lib/elasticsearch/xpack/api/actions/machine_learning/get_influencers.rb +1 -1
  106. data/lib/elasticsearch/xpack/api/actions/machine_learning/get_job_stats.rb +1 -1
  107. data/lib/elasticsearch/xpack/api/actions/machine_learning/get_jobs.rb +1 -1
  108. data/lib/elasticsearch/xpack/api/actions/machine_learning/get_model_snapshots.rb +1 -1
  109. data/lib/elasticsearch/xpack/api/actions/machine_learning/get_overall_buckets.rb +1 -1
  110. data/lib/elasticsearch/xpack/api/actions/machine_learning/get_records.rb +1 -1
  111. data/lib/elasticsearch/xpack/api/actions/machine_learning/get_trained_models.rb +1 -1
  112. data/lib/elasticsearch/xpack/api/actions/machine_learning/get_trained_models_stats.rb +1 -1
  113. data/lib/elasticsearch/xpack/api/actions/machine_learning/info.rb +1 -1
  114. data/lib/elasticsearch/xpack/api/actions/machine_learning/open_job.rb +1 -1
  115. data/lib/elasticsearch/xpack/api/actions/machine_learning/post_calendar_events.rb +1 -1
  116. data/lib/elasticsearch/xpack/api/actions/machine_learning/post_data.rb +1 -1
  117. data/lib/elasticsearch/xpack/api/actions/machine_learning/preview_datafeed.rb +1 -1
  118. data/lib/elasticsearch/xpack/api/actions/machine_learning/put_calendar.rb +1 -1
  119. data/lib/elasticsearch/xpack/api/actions/machine_learning/put_calendar_job.rb +1 -1
  120. data/lib/elasticsearch/xpack/api/actions/machine_learning/put_data_frame_analytics.rb +1 -1
  121. data/lib/elasticsearch/xpack/api/actions/machine_learning/put_datafeed.rb +1 -1
  122. data/lib/elasticsearch/xpack/api/actions/machine_learning/put_filter.rb +1 -1
  123. data/lib/elasticsearch/xpack/api/actions/machine_learning/put_job.rb +1 -1
  124. data/lib/elasticsearch/xpack/api/actions/machine_learning/put_trained_model.rb +1 -1
  125. data/lib/elasticsearch/xpack/api/actions/machine_learning/revert_model_snapshot.rb +1 -1
  126. data/lib/elasticsearch/xpack/api/actions/machine_learning/set_upgrade_mode.rb +1 -1
  127. data/lib/elasticsearch/xpack/api/actions/machine_learning/start_data_frame_analytics.rb +1 -1
  128. data/lib/elasticsearch/xpack/api/actions/machine_learning/start_datafeed.rb +1 -1
  129. data/lib/elasticsearch/xpack/api/actions/machine_learning/stop_data_frame_analytics.rb +1 -1
  130. data/lib/elasticsearch/xpack/api/actions/machine_learning/stop_datafeed.rb +1 -1
  131. data/lib/elasticsearch/xpack/api/actions/machine_learning/update_data_frame_analytics.rb +1 -1
  132. data/lib/elasticsearch/xpack/api/actions/machine_learning/update_datafeed.rb +1 -1
  133. data/lib/elasticsearch/xpack/api/actions/machine_learning/update_filter.rb +1 -1
  134. data/lib/elasticsearch/xpack/api/actions/machine_learning/update_job.rb +1 -1
  135. data/lib/elasticsearch/xpack/api/actions/machine_learning/update_model_snapshot.rb +1 -1
  136. data/lib/elasticsearch/xpack/api/actions/machine_learning/upgrade_job_snapshot.rb +1 -1
  137. data/lib/elasticsearch/xpack/api/actions/machine_learning/validate.rb +1 -1
  138. data/lib/elasticsearch/xpack/api/actions/machine_learning/validate_detector.rb +1 -1
  139. data/lib/elasticsearch/xpack/api/actions/migration/deprecations.rb +1 -1
  140. data/lib/elasticsearch/xpack/api/actions/monitoring/bulk.rb +1 -1
  141. data/lib/elasticsearch/xpack/api/actions/open_point_in_time.rb +1 -1
  142. data/lib/elasticsearch/xpack/api/actions/rollup/delete_job.rb +1 -1
  143. data/lib/elasticsearch/xpack/api/actions/rollup/get_jobs.rb +1 -1
  144. data/lib/elasticsearch/xpack/api/actions/rollup/get_rollup_caps.rb +1 -1
  145. data/lib/elasticsearch/xpack/api/actions/rollup/get_rollup_index_caps.rb +1 -1
  146. data/lib/elasticsearch/xpack/api/actions/rollup/put_job.rb +1 -1
  147. data/lib/elasticsearch/xpack/api/actions/rollup/rollup.rb +1 -1
  148. data/lib/elasticsearch/xpack/api/actions/rollup/rollup_search.rb +1 -1
  149. data/lib/elasticsearch/xpack/api/actions/rollup/start_job.rb +1 -1
  150. data/lib/elasticsearch/xpack/api/actions/rollup/stop_job.rb +1 -1
  151. data/lib/elasticsearch/xpack/api/actions/searchable_snapshots/clear_cache.rb +1 -1
  152. data/lib/elasticsearch/xpack/api/actions/searchable_snapshots/mount.rb +4 -2
  153. data/lib/elasticsearch/xpack/api/actions/searchable_snapshots/repository_stats.rb +1 -1
  154. data/lib/elasticsearch/xpack/api/actions/searchable_snapshots/stats.rb +10 -2
  155. data/lib/elasticsearch/xpack/api/actions/security/authenticate.rb +1 -1
  156. data/lib/elasticsearch/xpack/api/actions/security/change_password.rb +1 -1
  157. data/lib/elasticsearch/xpack/api/actions/security/clear_api_key_cache.rb +1 -1
  158. data/lib/elasticsearch/xpack/api/actions/security/clear_cached_privileges.rb +1 -1
  159. data/lib/elasticsearch/xpack/api/actions/security/clear_cached_realms.rb +1 -1
  160. data/lib/elasticsearch/xpack/api/actions/security/clear_cached_roles.rb +1 -1
  161. data/lib/elasticsearch/xpack/api/actions/security/create_api_key.rb +1 -1
  162. data/lib/elasticsearch/xpack/api/actions/security/delete_privileges.rb +1 -1
  163. data/lib/elasticsearch/xpack/api/actions/security/delete_role.rb +1 -1
  164. data/lib/elasticsearch/xpack/api/actions/security/delete_role_mapping.rb +1 -1
  165. data/lib/elasticsearch/xpack/api/actions/security/delete_user.rb +1 -1
  166. data/lib/elasticsearch/xpack/api/actions/security/disable_user.rb +1 -1
  167. data/lib/elasticsearch/xpack/api/actions/security/enable_user.rb +1 -1
  168. data/lib/elasticsearch/xpack/api/actions/security/get_api_key.rb +1 -1
  169. data/lib/elasticsearch/xpack/api/actions/security/get_builtin_privileges.rb +1 -1
  170. data/lib/elasticsearch/xpack/api/actions/security/get_privileges.rb +1 -1
  171. data/lib/elasticsearch/xpack/api/actions/security/get_role.rb +1 -1
  172. data/lib/elasticsearch/xpack/api/actions/security/get_role_mapping.rb +1 -1
  173. data/lib/elasticsearch/xpack/api/actions/security/get_token.rb +1 -1
  174. data/lib/elasticsearch/xpack/api/actions/security/get_user.rb +1 -1
  175. data/lib/elasticsearch/xpack/api/actions/security/get_user_privileges.rb +1 -1
  176. data/lib/elasticsearch/xpack/api/actions/security/grant_api_key.rb +1 -1
  177. data/lib/elasticsearch/xpack/api/actions/security/has_privileges.rb +1 -1
  178. data/lib/elasticsearch/xpack/api/actions/security/invalidate_api_key.rb +1 -1
  179. data/lib/elasticsearch/xpack/api/actions/security/invalidate_token.rb +1 -1
  180. data/lib/elasticsearch/xpack/api/actions/security/put_privileges.rb +1 -1
  181. data/lib/elasticsearch/xpack/api/actions/security/put_role.rb +1 -1
  182. data/lib/elasticsearch/xpack/api/actions/security/put_role_mapping.rb +1 -1
  183. data/lib/elasticsearch/xpack/api/actions/security/put_user.rb +1 -1
  184. data/lib/elasticsearch/xpack/api/actions/snapshot_lifecycle_management/delete_lifecycle.rb +1 -1
  185. data/lib/elasticsearch/xpack/api/actions/snapshot_lifecycle_management/execute_lifecycle.rb +1 -1
  186. data/lib/elasticsearch/xpack/api/actions/snapshot_lifecycle_management/execute_retention.rb +1 -1
  187. data/lib/elasticsearch/xpack/api/actions/snapshot_lifecycle_management/get_lifecycle.rb +1 -1
  188. data/lib/elasticsearch/xpack/api/actions/snapshot_lifecycle_management/get_stats.rb +1 -1
  189. data/lib/elasticsearch/xpack/api/actions/snapshot_lifecycle_management/get_status.rb +1 -1
  190. data/lib/elasticsearch/xpack/api/actions/snapshot_lifecycle_management/put_lifecycle.rb +1 -1
  191. data/lib/elasticsearch/xpack/api/actions/snapshot_lifecycle_management/start.rb +1 -1
  192. data/lib/elasticsearch/xpack/api/actions/snapshot_lifecycle_management/stop.rb +1 -1
  193. data/lib/elasticsearch/xpack/api/actions/sql/clear_cursor.rb +1 -1
  194. data/lib/elasticsearch/xpack/api/actions/sql/query.rb +1 -1
  195. data/lib/elasticsearch/xpack/api/actions/sql/translate.rb +1 -1
  196. data/lib/elasticsearch/xpack/api/actions/ssl/certificates.rb +1 -1
  197. data/lib/elasticsearch/xpack/api/actions/text_structure/find_structure.rb +93 -0
  198. data/lib/elasticsearch/xpack/api/actions/text_structure/params_registry.rb +62 -0
  199. data/lib/elasticsearch/xpack/api/actions/transform/delete_transform.rb +1 -1
  200. data/lib/elasticsearch/xpack/api/actions/transform/get_transform.rb +1 -1
  201. data/lib/elasticsearch/xpack/api/actions/transform/get_transform_stats.rb +1 -1
  202. data/lib/elasticsearch/xpack/api/actions/transform/preview_transform.rb +1 -1
  203. data/lib/elasticsearch/xpack/api/actions/transform/put_transform.rb +1 -1
  204. data/lib/elasticsearch/xpack/api/actions/transform/start_transform.rb +1 -1
  205. data/lib/elasticsearch/xpack/api/actions/transform/stop_transform.rb +1 -1
  206. data/lib/elasticsearch/xpack/api/actions/transform/update_transform.rb +1 -1
  207. data/lib/elasticsearch/xpack/api/actions/usage.rb +1 -1
  208. data/lib/elasticsearch/xpack/api/actions/watcher/ack_watch.rb +1 -1
  209. data/lib/elasticsearch/xpack/api/actions/watcher/activate_watch.rb +1 -1
  210. data/lib/elasticsearch/xpack/api/actions/watcher/deactivate_watch.rb +1 -1
  211. data/lib/elasticsearch/xpack/api/actions/watcher/delete_watch.rb +1 -1
  212. data/lib/elasticsearch/xpack/api/actions/watcher/execute_watch.rb +1 -1
  213. data/lib/elasticsearch/xpack/api/actions/watcher/get_watch.rb +1 -1
  214. data/lib/elasticsearch/xpack/api/actions/watcher/put_watch.rb +1 -1
  215. data/lib/elasticsearch/xpack/api/actions/watcher/query_watches.rb +1 -1
  216. data/lib/elasticsearch/xpack/api/actions/watcher/start.rb +1 -1
  217. data/lib/elasticsearch/xpack/api/actions/watcher/stats.rb +1 -1
  218. data/lib/elasticsearch/xpack/api/actions/watcher/stop.rb +1 -1
  219. data/lib/elasticsearch/xpack/api/namespace/logstash.rb +34 -0
  220. data/lib/elasticsearch/xpack/api/namespace/text_structure.rb +34 -0
  221. data/lib/elasticsearch/xpack/version.rb +1 -1
  222. metadata +10 -2
@@ -24,7 +24,7 @@ module Elasticsearch
24
24
  #
25
25
  # @option arguments [Hash] :headers Custom HTTP headers
26
26
  #
27
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.11/security-api-authenticate.html
27
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.12/security-api-authenticate.html
28
28
  #
29
29
  def authenticate(arguments = {})
30
30
  headers = arguments.delete(:headers) || {}
@@ -27,7 +27,7 @@ module Elasticsearch
27
27
  # @option arguments [Hash] :headers Custom HTTP headers
28
28
  # @option arguments [Hash] :body the new password for the user (*Required*)
29
29
  #
30
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.11/security-api-change-password.html
30
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.12/security-api-change-password.html
31
31
  #
32
32
  def change_password(arguments = {})
33
33
  raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
@@ -25,7 +25,7 @@ module Elasticsearch
25
25
  # @option arguments [List] :ids A comma-separated list of IDs of API keys to clear from the cache
26
26
  # @option arguments [Hash] :headers Custom HTTP headers
27
27
  #
28
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.11/security-api-clear-api-key-cache.html
28
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.12/security-api-clear-api-key-cache.html
29
29
  #
30
30
  def clear_api_key_cache(arguments = {})
31
31
  raise ArgumentError, "Required argument 'ids' missing" unless arguments[:ids]
@@ -25,7 +25,7 @@ module Elasticsearch
25
25
  # @option arguments [List] :application A comma-separated list of application names
26
26
  # @option arguments [Hash] :headers Custom HTTP headers
27
27
  #
28
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.11/security-api-clear-privilege-cache.html
28
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.12/security-api-clear-privilege-cache.html
29
29
  #
30
30
  def clear_cached_privileges(arguments = {})
31
31
  raise ArgumentError, "Required argument 'application' missing" unless arguments[:application]
@@ -26,7 +26,7 @@ module Elasticsearch
26
26
  # @option arguments [List] :usernames Comma-separated list of usernames to clear from the cache
27
27
  # @option arguments [Hash] :headers Custom HTTP headers
28
28
  #
29
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.11/security-api-clear-cache.html
29
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.12/security-api-clear-cache.html
30
30
  #
31
31
  def clear_cached_realms(arguments = {})
32
32
  raise ArgumentError, "Required argument 'realms' missing" unless arguments[:realms]
@@ -25,7 +25,7 @@ module Elasticsearch
25
25
  # @option arguments [List] :name Role name
26
26
  # @option arguments [Hash] :headers Custom HTTP headers
27
27
  #
28
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.11/security-api-clear-role-cache.html
28
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.12/security-api-clear-role-cache.html
29
29
  #
30
30
  def clear_cached_roles(arguments = {})
31
31
  raise ArgumentError, "Required argument 'name' missing" unless arguments[:name]
@@ -26,7 +26,7 @@ module Elasticsearch
26
26
  # @option arguments [Hash] :headers Custom HTTP headers
27
27
  # @option arguments [Hash] :body The api key request to create an API key (*Required*)
28
28
  #
29
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.11/security-api-create-api-key.html
29
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.12/security-api-create-api-key.html
30
30
  #
31
31
  def create_api_key(arguments = {})
32
32
  raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
@@ -27,7 +27,7 @@ module Elasticsearch
27
27
  # @option arguments [String] :refresh If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes. (options: true, false, wait_for)
28
28
  # @option arguments [Hash] :headers Custom HTTP headers
29
29
  #
30
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.11/security-api-delete-privilege.html
30
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.12/security-api-delete-privilege.html
31
31
  #
32
32
  def delete_privileges(arguments = {})
33
33
  raise ArgumentError, "Required argument 'application' missing" unless arguments[:application]
@@ -26,7 +26,7 @@ module Elasticsearch
26
26
  # @option arguments [String] :refresh If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes. (options: true, false, wait_for)
27
27
  # @option arguments [Hash] :headers Custom HTTP headers
28
28
  #
29
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.11/security-api-delete-role.html
29
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.12/security-api-delete-role.html
30
30
  #
31
31
  def delete_role(arguments = {})
32
32
  raise ArgumentError, "Required argument 'name' missing" unless arguments[:name]
@@ -26,7 +26,7 @@ module Elasticsearch
26
26
  # @option arguments [String] :refresh If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes. (options: true, false, wait_for)
27
27
  # @option arguments [Hash] :headers Custom HTTP headers
28
28
  #
29
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.11/security-api-delete-role-mapping.html
29
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.12/security-api-delete-role-mapping.html
30
30
  #
31
31
  def delete_role_mapping(arguments = {})
32
32
  raise ArgumentError, "Required argument 'name' missing" unless arguments[:name]
@@ -26,7 +26,7 @@ module Elasticsearch
26
26
  # @option arguments [String] :refresh If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes. (options: true, false, wait_for)
27
27
  # @option arguments [Hash] :headers Custom HTTP headers
28
28
  #
29
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.11/security-api-delete-user.html
29
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.12/security-api-delete-user.html
30
30
  #
31
31
  def delete_user(arguments = {})
32
32
  raise ArgumentError, "Required argument 'username' missing" unless arguments[:username]
@@ -26,7 +26,7 @@ module Elasticsearch
26
26
  # @option arguments [String] :refresh If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes. (options: true, false, wait_for)
27
27
  # @option arguments [Hash] :headers Custom HTTP headers
28
28
  #
29
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.11/security-api-disable-user.html
29
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.12/security-api-disable-user.html
30
30
  #
31
31
  def disable_user(arguments = {})
32
32
  raise ArgumentError, "Required argument 'username' missing" unless arguments[:username]
@@ -26,7 +26,7 @@ module Elasticsearch
26
26
  # @option arguments [String] :refresh If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes. (options: true, false, wait_for)
27
27
  # @option arguments [Hash] :headers Custom HTTP headers
28
28
  #
29
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.11/security-api-enable-user.html
29
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.12/security-api-enable-user.html
30
30
  #
31
31
  def enable_user(arguments = {})
32
32
  raise ArgumentError, "Required argument 'username' missing" unless arguments[:username]
@@ -29,7 +29,7 @@ module Elasticsearch
29
29
  # @option arguments [Boolean] :owner flag to query API keys owned by the currently authenticated user
30
30
  # @option arguments [Hash] :headers Custom HTTP headers
31
31
  #
32
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.11/security-api-get-api-key.html
32
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.12/security-api-get-api-key.html
33
33
  #
34
34
  def get_api_key(arguments = {})
35
35
  headers = arguments.delete(:headers) || {}
@@ -24,7 +24,7 @@ module Elasticsearch
24
24
  #
25
25
  # @option arguments [Hash] :headers Custom HTTP headers
26
26
  #
27
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.11/security-api-get-builtin-privileges.html
27
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.12/security-api-get-builtin-privileges.html
28
28
  #
29
29
  def get_builtin_privileges(arguments = {})
30
30
  headers = arguments.delete(:headers) || {}
@@ -26,7 +26,7 @@ module Elasticsearch
26
26
  # @option arguments [String] :name Privilege name
27
27
  # @option arguments [Hash] :headers Custom HTTP headers
28
28
  #
29
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.11/security-api-get-privileges.html
29
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.12/security-api-get-privileges.html
30
30
  #
31
31
  def get_privileges(arguments = {})
32
32
  headers = arguments.delete(:headers) || {}
@@ -25,7 +25,7 @@ module Elasticsearch
25
25
  # @option arguments [List] :name A comma-separated list of role names
26
26
  # @option arguments [Hash] :headers Custom HTTP headers
27
27
  #
28
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.11/security-api-get-role.html
28
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.12/security-api-get-role.html
29
29
  #
30
30
  def get_role(arguments = {})
31
31
  headers = arguments.delete(:headers) || {}
@@ -25,7 +25,7 @@ module Elasticsearch
25
25
  # @option arguments [List] :name A comma-separated list of role-mapping names
26
26
  # @option arguments [Hash] :headers Custom HTTP headers
27
27
  #
28
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.11/security-api-get-role-mapping.html
28
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.12/security-api-get-role-mapping.html
29
29
  #
30
30
  def get_role_mapping(arguments = {})
31
31
  headers = arguments.delete(:headers) || {}
@@ -25,7 +25,7 @@ module Elasticsearch
25
25
  # @option arguments [Hash] :headers Custom HTTP headers
26
26
  # @option arguments [Hash] :body The token request to get (*Required*)
27
27
  #
28
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.11/security-api-get-token.html
28
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.12/security-api-get-token.html
29
29
  #
30
30
  def get_token(arguments = {})
31
31
  raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
@@ -25,7 +25,7 @@ module Elasticsearch
25
25
  # @option arguments [List] :username A comma-separated list of usernames
26
26
  # @option arguments [Hash] :headers Custom HTTP headers
27
27
  #
28
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.11/security-api-get-user.html
28
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.12/security-api-get-user.html
29
29
  #
30
30
  def get_user(arguments = {})
31
31
  headers = arguments.delete(:headers) || {}
@@ -24,7 +24,7 @@ module Elasticsearch
24
24
  #
25
25
  # @option arguments [Hash] :headers Custom HTTP headers
26
26
  #
27
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.11/security-api-get-privileges.html
27
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.12/security-api-get-privileges.html
28
28
  #
29
29
  def get_user_privileges(arguments = {})
30
30
  headers = arguments.delete(:headers) || {}
@@ -26,7 +26,7 @@ module Elasticsearch
26
26
  # @option arguments [Hash] :headers Custom HTTP headers
27
27
  # @option arguments [Hash] :body The api key request to create an API key (*Required*)
28
28
  #
29
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.11/security-api-grant-api-key.html
29
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.12/security-api-grant-api-key.html
30
30
  #
31
31
  def grant_api_key(arguments = {})
32
32
  raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
@@ -26,7 +26,7 @@ module Elasticsearch
26
26
  # @option arguments [Hash] :headers Custom HTTP headers
27
27
  # @option arguments [Hash] :body The privileges to test (*Required*)
28
28
  #
29
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.11/security-api-has-privileges.html
29
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.12/security-api-has-privileges.html
30
30
  #
31
31
  def has_privileges(arguments = {})
32
32
  raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
@@ -25,7 +25,7 @@ module Elasticsearch
25
25
  # @option arguments [Hash] :headers Custom HTTP headers
26
26
  # @option arguments [Hash] :body The api key request to invalidate API key(s) (*Required*)
27
27
  #
28
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.11/security-api-invalidate-api-key.html
28
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.12/security-api-invalidate-api-key.html
29
29
  #
30
30
  def invalidate_api_key(arguments = {})
31
31
  raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
@@ -25,7 +25,7 @@ module Elasticsearch
25
25
  # @option arguments [Hash] :headers Custom HTTP headers
26
26
  # @option arguments [Hash] :body The token to invalidate (*Required*)
27
27
  #
28
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.11/security-api-invalidate-token.html
28
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.12/security-api-invalidate-token.html
29
29
  #
30
30
  def invalidate_token(arguments = {})
31
31
  raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
@@ -26,7 +26,7 @@ module Elasticsearch
26
26
  # @option arguments [Hash] :headers Custom HTTP headers
27
27
  # @option arguments [Hash] :body The privilege(s) to add (*Required*)
28
28
  #
29
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.11/security-api-put-privileges.html
29
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.12/security-api-put-privileges.html
30
30
  #
31
31
  def put_privileges(arguments = {})
32
32
  raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
@@ -27,7 +27,7 @@ module Elasticsearch
27
27
  # @option arguments [Hash] :headers Custom HTTP headers
28
28
  # @option arguments [Hash] :body The role to add (*Required*)
29
29
  #
30
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.11/security-api-put-role.html
30
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.12/security-api-put-role.html
31
31
  #
32
32
  def put_role(arguments = {})
33
33
  raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
@@ -27,7 +27,7 @@ module Elasticsearch
27
27
  # @option arguments [Hash] :headers Custom HTTP headers
28
28
  # @option arguments [Hash] :body The role mapping to add (*Required*)
29
29
  #
30
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.11/security-api-put-role-mapping.html
30
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.12/security-api-put-role-mapping.html
31
31
  #
32
32
  def put_role_mapping(arguments = {})
33
33
  raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
@@ -27,7 +27,7 @@ module Elasticsearch
27
27
  # @option arguments [Hash] :headers Custom HTTP headers
28
28
  # @option arguments [Hash] :body The user to add (*Required*)
29
29
  #
30
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.11/security-api-put-user.html
30
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.12/security-api-put-user.html
31
31
  #
32
32
  def put_user(arguments = {})
33
33
  raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
@@ -25,7 +25,7 @@ module Elasticsearch
25
25
  # @option arguments [String] :policy_id The id of the snapshot lifecycle policy to remove
26
26
  # @option arguments [Hash] :headers Custom HTTP headers
27
27
  #
28
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.11/slm-api-delete-policy.html
28
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.12/slm-api-delete-policy.html
29
29
  #
30
30
  def delete_lifecycle(arguments = {})
31
31
  raise ArgumentError, "Required argument 'policy_id' missing" unless arguments[:policy_id]
@@ -25,7 +25,7 @@ module Elasticsearch
25
25
  # @option arguments [String] :policy_id The id of the snapshot lifecycle policy to be executed
26
26
  # @option arguments [Hash] :headers Custom HTTP headers
27
27
  #
28
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.11/slm-api-execute-lifecycle.html
28
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.12/slm-api-execute-lifecycle.html
29
29
  #
30
30
  def execute_lifecycle(arguments = {})
31
31
  raise ArgumentError, "Required argument 'policy_id' missing" unless arguments[:policy_id]
@@ -24,7 +24,7 @@ module Elasticsearch
24
24
  #
25
25
  # @option arguments [Hash] :headers Custom HTTP headers
26
26
  #
27
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.11/slm-api-execute-retention.html
27
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.12/slm-api-execute-retention.html
28
28
  #
29
29
  def execute_retention(arguments = {})
30
30
  headers = arguments.delete(:headers) || {}
@@ -25,7 +25,7 @@ module Elasticsearch
25
25
  # @option arguments [List] :policy_id Comma-separated list of snapshot lifecycle policies to retrieve
26
26
  # @option arguments [Hash] :headers Custom HTTP headers
27
27
  #
28
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.11/slm-api-get-policy.html
28
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.12/slm-api-get-policy.html
29
29
  #
30
30
  def get_lifecycle(arguments = {})
31
31
  headers = arguments.delete(:headers) || {}
@@ -24,7 +24,7 @@ module Elasticsearch
24
24
  #
25
25
  # @option arguments [Hash] :headers Custom HTTP headers
26
26
  #
27
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.11/slm-api-get-stats.html
27
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.12/slm-api-get-stats.html
28
28
  #
29
29
  def get_stats(arguments = {})
30
30
  headers = arguments.delete(:headers) || {}
@@ -24,7 +24,7 @@ module Elasticsearch
24
24
  #
25
25
  # @option arguments [Hash] :headers Custom HTTP headers
26
26
  #
27
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.11/slm-api-get-status.html
27
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.12/slm-api-get-status.html
28
28
  #
29
29
  def get_status(arguments = {})
30
30
  headers = arguments.delete(:headers) || {}
@@ -26,7 +26,7 @@ module Elasticsearch
26
26
  # @option arguments [Hash] :headers Custom HTTP headers
27
27
  # @option arguments [Hash] :body The snapshot lifecycle policy definition to register
28
28
  #
29
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.11/slm-api-put-policy.html
29
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.12/slm-api-put-policy.html
30
30
  #
31
31
  def put_lifecycle(arguments = {})
32
32
  raise ArgumentError, "Required argument 'policy_id' missing" unless arguments[:policy_id]
@@ -24,7 +24,7 @@ module Elasticsearch
24
24
  #
25
25
  # @option arguments [Hash] :headers Custom HTTP headers
26
26
  #
27
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.11/slm-api-start.html
27
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.12/slm-api-start.html
28
28
  #
29
29
  def start(arguments = {})
30
30
  headers = arguments.delete(:headers) || {}
@@ -24,7 +24,7 @@ module Elasticsearch
24
24
  #
25
25
  # @option arguments [Hash] :headers Custom HTTP headers
26
26
  #
27
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.11/slm-api-stop.html
27
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.12/slm-api-stop.html
28
28
  #
29
29
  def stop(arguments = {})
30
30
  headers = arguments.delete(:headers) || {}
@@ -25,7 +25,7 @@ module Elasticsearch
25
25
  # @option arguments [Hash] :headers Custom HTTP headers
26
26
  # @option arguments [Hash] :body Specify the cursor value in the `cursor` element to clean the cursor. (*Required*)
27
27
  #
28
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.11/sql-pagination.html
28
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.12/sql-pagination.html
29
29
  #
30
30
  def clear_cursor(arguments = {})
31
31
  raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
@@ -26,7 +26,7 @@ module Elasticsearch
26
26
  # @option arguments [Hash] :headers Custom HTTP headers
27
27
  # @option arguments [Hash] :body Use the `query` element to start a query. Use the `cursor` element to continue a query. (*Required*)
28
28
  #
29
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.11/sql-rest-overview.html
29
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.12/sql-rest-overview.html
30
30
  #
31
31
  def query(arguments = {})
32
32
  raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
@@ -25,7 +25,7 @@ module Elasticsearch
25
25
  # @option arguments [Hash] :headers Custom HTTP headers
26
26
  # @option arguments [Hash] :body Specify the query in the `query` element. (*Required*)
27
27
  #
28
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.11/sql-translate.html
28
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.12/sql-translate.html
29
29
  #
30
30
  def translate(arguments = {})
31
31
  raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
@@ -24,7 +24,7 @@ module Elasticsearch
24
24
  #
25
25
  # @option arguments [Hash] :headers Custom HTTP headers
26
26
  #
27
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.11/security-api-ssl.html
27
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.12/security-api-ssl.html
28
28
  #
29
29
  def certificates(arguments = {})
30
30
  headers = arguments.delete(:headers) || {}
@@ -0,0 +1,93 @@
1
+ # Licensed to Elasticsearch B.V. under one or more contributor
2
+ # license agreements. See the NOTICE file distributed with
3
+ # this work for additional information regarding copyright
4
+ # ownership. Elasticsearch B.V. licenses this file to you under
5
+ # the Apache License, Version 2.0 (the "License"); you may
6
+ # not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # http://www.apache.org/licenses/LICENSE-2.0
10
+ #
11
+ # Unless required by applicable law or agreed to in writing,
12
+ # software distributed under the License is distributed on an
13
+ # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
14
+ # KIND, either express or implied. See the License for the
15
+ # specific language governing permissions and limitations
16
+ # under the License.
17
+
18
+ module Elasticsearch
19
+ module XPack
20
+ module API
21
+ module TextStructure
22
+ module Actions
23
+ # Finds the structure of a text file. The text file must contain data that is suitable to be ingested into Elasticsearch.
24
+ # This functionality is Experimental and may be changed or removed
25
+ # completely in a future release. Elastic will take a best effort approach
26
+ # to fix any issues, but experimental features are not subject to the
27
+ # support SLA of official GA features.
28
+ #
29
+ # @option arguments [Int] :lines_to_sample How many lines of the file should be included in the analysis
30
+ # @option arguments [Int] :line_merge_size_limit Maximum number of characters permitted in a single message when lines are merged to create messages.
31
+ # @option arguments [Time] :timeout Timeout after which the analysis will be aborted
32
+ # @option arguments [String] :charset Optional parameter to specify the character set of the file
33
+ # @option arguments [String] :format Optional parameter to specify the high level file format (options: ndjson, xml, delimited, semi_structured_text)
34
+ # @option arguments [Boolean] :has_header_row Optional parameter to specify whether a delimited file includes the column names in its first row
35
+ # @option arguments [List] :column_names Optional parameter containing a comma separated list of the column names for a delimited file
36
+ # @option arguments [String] :delimiter Optional parameter to specify the delimiter character for a delimited file - must be a single character
37
+ # @option arguments [String] :quote Optional parameter to specify the quote character for a delimited file - must be a single character
38
+ # @option arguments [Boolean] :should_trim_fields Optional parameter to specify whether the values between delimiters in a delimited file should have whitespace trimmed from them
39
+ # @option arguments [String] :grok_pattern Optional parameter to specify the Grok pattern that should be used to extract fields from messages in a semi-structured text file
40
+ # @option arguments [String] :timestamp_field Optional parameter to specify the timestamp field in the file
41
+ # @option arguments [String] :timestamp_format Optional parameter to specify the timestamp format in the file - may be either a Joda or Java time format
42
+ # @option arguments [Boolean] :explain Whether to include a commentary on how the structure was derived
43
+ # @option arguments [Hash] :headers Custom HTTP headers
44
+ # @option arguments [Hash] :body The contents of the file to be analyzed (*Required*)
45
+ #
46
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.12/find-structure.html
47
+ #
48
+ def find_structure(arguments = {})
49
+ raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
50
+
51
+ headers = arguments.delete(:headers) || {}
52
+
53
+ arguments = arguments.clone
54
+
55
+ method = Elasticsearch::API::HTTP_POST
56
+ path = "_text_structure/find_structure"
57
+ params = Elasticsearch::API::Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
58
+
59
+ body = arguments[:body]
60
+ if body.is_a? Array
61
+ payload = Elasticsearch::API::Utils.__bulkify(body)
62
+ else
63
+ payload = body
64
+ end
65
+
66
+ headers.merge!("Content-Type" => "application/x-ndjson")
67
+ perform_request(method, path, params, payload, headers).body
68
+ end
69
+
70
+ # Register this action with its valid params when the module is loaded.
71
+ #
72
+ # @since 6.2.0
73
+ ParamsRegistry.register(:find_structure, [
74
+ :lines_to_sample,
75
+ :line_merge_size_limit,
76
+ :timeout,
77
+ :charset,
78
+ :format,
79
+ :has_header_row,
80
+ :column_names,
81
+ :delimiter,
82
+ :quote,
83
+ :should_trim_fields,
84
+ :grok_pattern,
85
+ :timestamp_field,
86
+ :timestamp_format,
87
+ :explain
88
+ ].freeze)
89
+ end
90
+ end
91
+ end
92
+ end
93
+ end