elasticsearch-xpack 7.12.0 → 7.13.0.pre

data/lib/elasticsearch/xpack/api/actions/enrich/execute_policy.rb

@@ -26,7 +26,7 @@ module Elasticsearch
           # @option arguments [Boolean] :wait_for_completion Should the request should block until the execution is complete.
           # @option arguments [Hash] :headers Custom HTTP headers
           #
-          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.12/execute-enrich-policy-api.html
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/execute-enrich-policy-api.html
           #
           def execute_policy(arguments = {})
             raise ArgumentError, "Required argument 'name' missing" unless arguments[:name]

data/lib/elasticsearch/xpack/api/actions/enrich/get_policy.rb

@@ -25,7 +25,7 @@ module Elasticsearch
           # @option arguments [List] :name A comma-separated list of enrich policy names
           # @option arguments [Hash] :headers Custom HTTP headers
           #
-          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.12/get-enrich-policy-api.html
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/get-enrich-policy-api.html
           #
           def get_policy(arguments = {})
             headers = arguments.delete(:headers) || {}

data/lib/elasticsearch/xpack/api/actions/enrich/put_policy.rb

@@ -26,7 +26,7 @@ module Elasticsearch
           # @option arguments [Hash] :headers Custom HTTP headers
           # @option arguments [Hash] :body The enrich policy to register (*Required*)
           #
-          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.12/put-enrich-policy-api.html
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/put-enrich-policy-api.html
           #
           def put_policy(arguments = {})
             raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]

data/lib/elasticsearch/xpack/api/actions/enrich/stats.rb

@@ -24,7 +24,7 @@ module Elasticsearch
           #
           # @option arguments [Hash] :headers Custom HTTP headers
           #
-          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.12/enrich-stats-api.html
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/enrich-stats-api.html
           #
           def stats(arguments = {})
             headers = arguments.delete(:headers) || {}

data/lib/elasticsearch/xpack/api/actions/eql/delete.rb

@@ -25,7 +25,7 @@ module Elasticsearch
           # @option arguments [String] :id The async search ID
           # @option arguments [Hash] :headers Custom HTTP headers
           #
-          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.12/eql-search-api.html
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/eql-search-api.html
           #
           def delete(arguments = {})
             raise ArgumentError, "Required argument 'id' missing" unless arguments[:id]

data/lib/elasticsearch/xpack/api/actions/eql/get.rb

@@ -27,7 +27,7 @@ module Elasticsearch
           # @option arguments [Time] :keep_alive Update the time interval in which the results (partial or final) for this search will be available
           # @option arguments [Hash] :headers Custom HTTP headers
           #
-          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.12/eql-search-api.html
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/eql-search-api.html
           #
           def get(arguments = {})
             raise ArgumentError, "Required argument 'id' missing" unless arguments[:id]

data/lib/elasticsearch/xpack/api/actions/eql/get_status.rb

@@ -25,7 +25,7 @@ module Elasticsearch
           # @option arguments [String] :id The async search ID
           # @option arguments [Hash] :headers Custom HTTP headers
           #
-          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.12/eql-search-api.html
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/eql-search-api.html
           #
           def get_status(arguments = {})
             raise ArgumentError, "Required argument 'id' missing" unless arguments[:id]

data/lib/elasticsearch/xpack/api/actions/eql/search.rb

@@ -29,7 +29,7 @@ module Elasticsearch
           # @option arguments [Hash] :headers Custom HTTP headers
           # @option arguments [Hash] :body Eql request body. Use the `query` to limit the query scope. (*Required*)
           #
-          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.12/eql-search-api.html
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/eql-search-api.html
           #
           def search(arguments = {})
             raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]

data/lib/elasticsearch/xpack/api/actions/fleet/global_checkpoints.rb

@@ -0,0 +1,68 @@
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+module Elasticsearch
+  module XPack
+    module API
+      module Fleet
+        module Actions
+          # Returns the current global checkpoints for an index. This API is design for internal use by the fleet server project.
+          # This functionality is Experimental and may be changed or removed
+          # completely in a future release. Elastic will take a best effort approach
+          # to fix any issues, but experimental features are not subject to the
+          # support SLA of official GA features.
+          #
+          # @option arguments [String] :index The name of the index.
+          # @option arguments [Boolean] :wait_for_advance Whether to wait for the global checkpoint to advance past the specified current checkpoints
+          # @option arguments [Boolean] :wait_for_index Whether to wait for the target index to exist and all primary shards be active
+          # @option arguments [List] :checkpoints Comma separated list of checkpoints
+          # @option arguments [Time] :timeout Timeout to wait for global checkpoint to advance
+          # @option arguments [Hash] :headers Custom HTTP headers
+          #
+          # @see [TODO]
+          #
+          def global_checkpoints(arguments = {})
+            raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
+
+            headers = arguments.delete(:headers) || {}
+
+            arguments = arguments.clone
+
+            _index = arguments.delete(:index)
+
+            method = Elasticsearch::API::HTTP_GET
+            path   = "#{Elasticsearch::API::Utils.__listify(_index)}/_fleet/global_checkpoints"
+            params = Elasticsearch::API::Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
+
+            body = nil
+            perform_request(method, path, params, body, headers).body
+          end
+
+          # Register this action with its valid params when the module is loaded.
+          #
+          # @since 6.2.0
+          ParamsRegistry.register(:global_checkpoints, [
+            :wait_for_advance,
+            :wait_for_index,
+            :checkpoints,
+            :timeout
+          ].freeze)
+        end
+      end
+    end
+  end
+end

data/lib/elasticsearch/xpack/api/actions/fleet/params_registry.rb

@@ -0,0 +1,62 @@
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+module Elasticsearch
+  module XPack
+    module API
+      module Fleet
+        module Actions
+          module ParamsRegistry
+            extend self
+
+            # A Mapping of all the actions to their list of valid params.
+            #
+            # @since 7.4.0
+            PARAMS = {}
+
+            # Register an action with its list of valid params.
+            #
+            # @example Register the action.
+            #   ParamsRegistry.register(:benchmark, [ :verbose ])
+            #
+            # @param [ Symbol ] action The action to register.
+            # @param [ Array[Symbol] ] valid_params The list of valid params.
+            #
+            # @since 7.4.0
+            def register(action, valid_params)
+              PARAMS[action.to_sym] = valid_params
+            end
+
+            # Get the list of valid params for a given action.
+            #
+            # @example Get the list of valid params.
+            #   ParamsRegistry.get(:benchmark)
+            #
+            # @param [ Symbol ] action The action.
+            #
+            # @return [ Array<Symbol> ] The list of valid params for the action.
+            #
+            # @since 7.4.0
+            def get(action)
+              PARAMS.fetch(action, [])
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/elasticsearch/xpack/api/actions/graph/explore.rb

@@ -34,7 +34,7 @@ module Elasticsearch
           # Deprecated since version 7.0.0
           #
           #
-          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.12/graph-explore-api.html
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/graph-explore-api.html
           #
           def explore(arguments = {})
             raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]

data/lib/elasticsearch/xpack/api/actions/index_lifecycle_management/delete_lifecycle.rb

@@ -25,7 +25,7 @@ module Elasticsearch
           # @option arguments [String] :policy The name of the index lifecycle policy
           # @option arguments [Hash] :headers Custom HTTP headers
           #
-          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.12/ilm-delete-lifecycle.html
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/ilm-delete-lifecycle.html
           #
           def delete_lifecycle(arguments = {})
             raise ArgumentError, "Required argument 'policy' missing" unless arguments[:policy]

data/lib/elasticsearch/xpack/api/actions/index_lifecycle_management/explain_lifecycle.rb

@@ -27,7 +27,7 @@ module Elasticsearch
           # @option arguments [Boolean] :only_errors filters the indices included in the response to ones in an ILM error state, implies only_managed
           # @option arguments [Hash] :headers Custom HTTP headers
           #
-          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.12/ilm-explain-lifecycle.html
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/ilm-explain-lifecycle.html
           #
           def explain_lifecycle(arguments = {})
             raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]

data/lib/elasticsearch/xpack/api/actions/index_lifecycle_management/get_lifecycle.rb

@@ -25,7 +25,7 @@ module Elasticsearch
           # @option arguments [String] :policy The name of the index lifecycle policy
           # @option arguments [Hash] :headers Custom HTTP headers
           #
-          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.12/ilm-get-lifecycle.html
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/ilm-get-lifecycle.html
           #
           def get_lifecycle(arguments = {})
             headers = arguments.delete(:headers) || {}

data/lib/elasticsearch/xpack/api/actions/index_lifecycle_management/get_status.rb

@@ -24,7 +24,7 @@ module Elasticsearch
           #
           # @option arguments [Hash] :headers Custom HTTP headers
           #
-          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.12/ilm-get-status.html
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/ilm-get-status.html
           #
           def get_status(arguments = {})
             headers = arguments.delete(:headers) || {}

data/lib/elasticsearch/xpack/api/actions/index_lifecycle_management/move_to_step.rb

@@ -26,7 +26,7 @@ module Elasticsearch
           # @option arguments [Hash] :headers Custom HTTP headers
           # @option arguments [Hash] :body The new lifecycle step to move to
           #
-          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.12/ilm-move-to-step.html
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/ilm-move-to-step.html
           #
           def move_to_step(arguments = {})
             raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]

data/lib/elasticsearch/xpack/api/actions/index_lifecycle_management/put_lifecycle.rb

@@ -26,7 +26,7 @@ module Elasticsearch
           # @option arguments [Hash] :headers Custom HTTP headers
           # @option arguments [Hash] :body The lifecycle policy definition to register
           #
-          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.12/ilm-put-lifecycle.html
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/ilm-put-lifecycle.html
           #
           def put_lifecycle(arguments = {})
             raise ArgumentError, "Required argument 'policy' missing" unless arguments[:policy]

data/lib/elasticsearch/xpack/api/actions/index_lifecycle_management/remove_policy.rb

@@ -25,7 +25,7 @@ module Elasticsearch
           # @option arguments [String] :index The name of the index to remove policy on
           # @option arguments [Hash] :headers Custom HTTP headers
           #
-          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.12/ilm-remove-policy.html
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/ilm-remove-policy.html
           #
           def remove_policy(arguments = {})
             raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]

data/lib/elasticsearch/xpack/api/actions/index_lifecycle_management/retry.rb

@@ -25,7 +25,7 @@ module Elasticsearch
           # @option arguments [String] :index The name of the indices (comma-separated) whose failed lifecycle step is to be retry
           # @option arguments [Hash] :headers Custom HTTP headers
           #
-          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.12/ilm-retry-policy.html
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/ilm-retry-policy.html
           #
           def retry(arguments = {})
             raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]

data/lib/elasticsearch/xpack/api/actions/index_lifecycle_management/start.rb

@@ -24,7 +24,7 @@ module Elasticsearch
           #
           # @option arguments [Hash] :headers Custom HTTP headers
           #
-          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.12/ilm-start.html
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/ilm-start.html
           #
           def start(arguments = {})
             headers = arguments.delete(:headers) || {}

data/lib/elasticsearch/xpack/api/actions/index_lifecycle_management/stop.rb

@@ -24,7 +24,7 @@ module Elasticsearch
           #
           # @option arguments [Hash] :headers Custom HTTP headers
           #
-          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.12/ilm-stop.html
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/ilm-stop.html
           #
           def stop(arguments = {})
             headers = arguments.delete(:headers) || {}

data/lib/elasticsearch/xpack/api/actions/indices/create_data_stream.rb

@@ -25,7 +25,7 @@ module Elasticsearch
           # @option arguments [String] :name The name of the data stream
           # @option arguments [Hash] :headers Custom HTTP headers
           #
-          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.12/data-streams.html
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/data-streams.html
           #
           def create_data_stream(arguments = {})
             raise ArgumentError, "Required argument 'name' missing" unless arguments[:name]

data/lib/elasticsearch/xpack/api/actions/indices/data_streams_stats.rb

@@ -25,7 +25,7 @@ module Elasticsearch
           # @option arguments [List] :name A comma-separated list of data stream names; use `_all` or empty string to perform the operation on all data streams
           # @option arguments [Hash] :headers Custom HTTP headers
           #
-          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.12/data-streams.html
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/data-streams.html
           #
           def data_streams_stats(arguments = {})
             headers = arguments.delete(:headers) || {}

data/lib/elasticsearch/xpack/api/actions/indices/delete_data_stream.rb

@@ -26,7 +26,7 @@ module Elasticsearch
           # @option arguments [String] :expand_wildcards Whether wildcard expressions should get expanded to open or closed indices (default: open) (options: open, closed, hidden, none, all)
           # @option arguments [Hash] :headers Custom HTTP headers
           #
-          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.12/data-streams.html
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/data-streams.html
           #
           def delete_data_stream(arguments = {})
             raise ArgumentError, "Required argument 'name' missing" unless arguments[:name]

data/lib/elasticsearch/xpack/api/actions/indices/freeze.rb

@@ -31,7 +31,7 @@ module Elasticsearch
           # @option arguments [String] :wait_for_active_shards Sets the number of active shards to wait for before the operation returns.
           # @option arguments [Hash] :headers Custom HTTP headers
           #
-          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.12/freeze-index-api.html
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/freeze-index-api.html
           #
           def freeze(arguments = {})
             raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]

data/lib/elasticsearch/xpack/api/actions/indices/get_data_stream.rb

@@ -26,7 +26,7 @@ module Elasticsearch
           # @option arguments [String] :expand_wildcards Whether wildcard expressions should get expanded to open or closed indices (default: open) (options: open, closed, hidden, none, all)
           # @option arguments [Hash] :headers Custom HTTP headers
           #
-          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.12/data-streams.html
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/data-streams.html
           #
           def get_data_stream(arguments = {})
             headers = arguments.delete(:headers) || {}

data/lib/elasticsearch/xpack/api/actions/indices/migrate_to_data_stream.rb

@@ -25,7 +25,7 @@ module Elasticsearch
           # @option arguments [String] :name The name of the alias to migrate
           # @option arguments [Hash] :headers Custom HTTP headers
           #
-          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.12/data-streams.html
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/data-streams.html
           #
           def migrate_to_data_stream(arguments = {})
             raise ArgumentError, "Required argument 'name' missing" unless arguments[:name]

data/lib/elasticsearch/xpack/api/actions/indices/promote_data_stream.rb

@@ -25,7 +25,7 @@ module Elasticsearch
           # @option arguments [String] :name The name of the data stream
           # @option arguments [Hash] :headers Custom HTTP headers
           #
-          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.12/data-streams.html
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/data-streams.html
           #
           def promote_data_stream(arguments = {})
             raise ArgumentError, "Required argument 'name' missing" unless arguments[:name]

data/lib/elasticsearch/xpack/api/actions/indices/reload_search_analyzers.rb

@@ -28,7 +28,7 @@ module Elasticsearch
           # @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)
           # @option arguments [Hash] :headers Custom HTTP headers
           #
-          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.12/indices-reload-analyzers.html
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/indices-reload-analyzers.html
           #
           def reload_search_analyzers(arguments = {})
             raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]

data/lib/elasticsearch/xpack/api/actions/indices/unfreeze.rb

@@ -31,7 +31,7 @@ module Elasticsearch
           # @option arguments [String] :wait_for_active_shards Sets the number of active shards to wait for before the operation returns.
           # @option arguments [Hash] :headers Custom HTTP headers
           #
-          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.12/unfreeze-index-api.html
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/unfreeze-index-api.html
           #
           def unfreeze(arguments = {})
             raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]

data/lib/elasticsearch/xpack/api/actions/info.rb

@@ -25,7 +25,7 @@ module Elasticsearch
         # @option arguments [Boolean] :accept_enterprise If an enterprise license is installed, return the type and mode as 'enterprise' (default: false)
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.12/info-api.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/info-api.html
         #
         def info(arguments = {})
           headers = arguments.delete(:headers) || {}

data/lib/elasticsearch/xpack/api/actions/license/delete.rb

@@ -24,7 +24,7 @@ module Elasticsearch
           #
           # @option arguments [Hash] :headers Custom HTTP headers
           #
-          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.12/delete-license.html
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/delete-license.html
           #
           def delete(arguments = {})
             headers = arguments.delete(:headers) || {}

data/lib/elasticsearch/xpack/api/actions/license/get.rb

@@ -26,7 +26,7 @@ module Elasticsearch
           # @option arguments [Boolean] :accept_enterprise If the active license is an enterprise license, return type as 'enterprise' (default: false)
           # @option arguments [Hash] :headers Custom HTTP headers
           #
-          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.12/get-license.html
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/get-license.html
           #
           def get(arguments = {})
             headers = arguments.delete(:headers) || {}