elasticsearch-xpack 7.5.0 → 7.8.0.pre

data/lib/elasticsearch/xpack/api/actions/machine_learning/update_datafeed.rb

@@ -1,36 +1,66 @@
-# Licensed to Elasticsearch B.V under one or more agreements.
-# Elasticsearch B.V licenses this file to you under the Apache 2.0 License.
-# See the LICENSE file in the project root for more information
+# 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 MachineLearning
         module Actions
-          # TODO: Description
-
+          # Updates certain properties of a datafeed.
           #
           # @option arguments [String] :datafeed_id The ID of the datafeed to update
+          # @option arguments [Boolean] :ignore_unavailable Ignore unavailable indexes (default: false)
+          # @option arguments [Boolean] :allow_no_indices Ignore if the source indices expressions resolves to no concrete indices (default: true)
+          # @option arguments [Boolean] :ignore_throttled Ignore indices that are marked as throttled (default: true)
+          # @option arguments [String] :expand_wildcards Whether source index expressions should get expanded to open or closed indices (default: open)
+          #   (options: open,closed,hidden,none,all)
 
+          # @option arguments [Hash] :headers Custom HTTP headers
           # @option arguments [Hash] :body The datafeed update settings (*Required*)
           #
-          # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-update-datafeed.html
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.8/ml-update-datafeed.html
           #
           def update_datafeed(arguments = {})
             raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
             raise ArgumentError, "Required argument 'datafeed_id' missing" unless arguments[:datafeed_id]
 
+            headers = arguments.delete(:headers) || {}
+
             arguments = arguments.clone
 
             _datafeed_id = arguments.delete(:datafeed_id)
 
             method = Elasticsearch::API::HTTP_POST
             path   = "_ml/datafeeds/#{Elasticsearch::API::Utils.__listify(_datafeed_id)}/_update"
-            params = {}
+            params = Elasticsearch::API::Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
 
             body = arguments[:body]
-            perform_request(method, path, params, body).body
+            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(:update_datafeed, [
+            :ignore_unavailable,
+            :allow_no_indices,
+            :ignore_throttled,
+            :expand_wildcards
+          ].freeze)
       end
     end
     end

data/lib/elasticsearch/xpack/api/actions/machine_learning/update_filter.rb

@@ -1,25 +1,39 @@
-# Licensed to Elasticsearch B.V under one or more agreements.
-# Elasticsearch B.V licenses this file to you under the Apache 2.0 License.
-# See the LICENSE file in the project root for more information
+# 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 MachineLearning
         module Actions
-          # TODO: Description
-
+          # Updates the description of a filter, adds items, or removes items.
           #
           # @option arguments [String] :filter_id The ID of the filter to update
-
+          # @option arguments [Hash] :headers Custom HTTP headers
           # @option arguments [Hash] :body The filter update (*Required*)
           #
-          # @see [TODO]
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.8/ml-update-filter.html
           #
           def update_filter(arguments = {})
             raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
             raise ArgumentError, "Required argument 'filter_id' missing" unless arguments[:filter_id]
 
+            headers = arguments.delete(:headers) || {}
+
             arguments = arguments.clone
 
             _filter_id = arguments.delete(:filter_id)
@@ -29,7 +43,7 @@ module Elasticsearch
             params = {}
 
             body = arguments[:body]
-            perform_request(method, path, params, body).body
+            perform_request(method, path, params, body, headers).body
           end
       end
     end

data/lib/elasticsearch/xpack/api/actions/machine_learning/update_job.rb

@@ -1,25 +1,39 @@
-# Licensed to Elasticsearch B.V under one or more agreements.
-# Elasticsearch B.V licenses this file to you under the Apache 2.0 License.
-# See the LICENSE file in the project root for more information
+# 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 MachineLearning
         module Actions
-          # TODO: Description
-
+          # Updates certain properties of an anomaly detection job.
           #
           # @option arguments [String] :job_id The ID of the job to create
-
+          # @option arguments [Hash] :headers Custom HTTP headers
           # @option arguments [Hash] :body The job update settings (*Required*)
           #
-          # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-update-job.html
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.8/ml-update-job.html
           #
           def update_job(arguments = {})
             raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
             raise ArgumentError, "Required argument 'job_id' missing" unless arguments[:job_id]
 
+            headers = arguments.delete(:headers) || {}
+
             arguments = arguments.clone
 
             _job_id = arguments.delete(:job_id)
@@ -29,7 +43,7 @@ module Elasticsearch
             params = {}
 
             body = arguments[:body]
-            perform_request(method, path, params, body).body
+            perform_request(method, path, params, body, headers).body
           end
       end
     end

data/lib/elasticsearch/xpack/api/actions/machine_learning/update_model_snapshot.rb

@@ -1,27 +1,41 @@
-# Licensed to Elasticsearch B.V under one or more agreements.
-# Elasticsearch B.V licenses this file to you under the Apache 2.0 License.
-# See the LICENSE file in the project root for more information
+# 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 MachineLearning
         module Actions
-          # TODO: Description
-
+          # Updates certain properties of a snapshot.
           #
           # @option arguments [String] :job_id The ID of the job to fetch
           # @option arguments [String] :snapshot_id The ID of the snapshot to update
-
+          # @option arguments [Hash] :headers Custom HTTP headers
           # @option arguments [Hash] :body The model snapshot properties to update (*Required*)
           #
-          # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-update-snapshot.html
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.8/ml-update-snapshot.html
           #
           def update_model_snapshot(arguments = {})
             raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
             raise ArgumentError, "Required argument 'job_id' missing" unless arguments[:job_id]
             raise ArgumentError, "Required argument 'snapshot_id' missing" unless arguments[:snapshot_id]
 
+            headers = arguments.delete(:headers) || {}
+
             arguments = arguments.clone
 
             _job_id = arguments.delete(:job_id)
@@ -33,7 +47,7 @@ module Elasticsearch
             params = {}
 
             body = arguments[:body]
-            perform_request(method, path, params, body).body
+            perform_request(method, path, params, body, headers).body
           end
       end
     end

data/lib/elasticsearch/xpack/api/actions/machine_learning/validate.rb

@@ -1,21 +1,37 @@
-# Licensed to Elasticsearch B.V under one or more agreements.
-# Elasticsearch B.V licenses this file to you under the Apache 2.0 License.
-# See the LICENSE file in the project root for more information
+# 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 MachineLearning
         module Actions
-          # TODO: Description
-
+          # Validates an anomaly detection job.
+          #
+          # @option arguments [Hash] :headers Custom HTTP headers
           # @option arguments [Hash] :body The job config (*Required*)
           #
-          # @see [TODO]
+          # @see https://www.elastic.co/guide/en/machine-learning/7.8/ml-jobs.html
           #
           def validate(arguments = {})
             raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
 
+            headers = arguments.delete(:headers) || {}
+
             arguments = arguments.clone
 
             method = Elasticsearch::API::HTTP_POST
@@ -23,7 +39,7 @@ module Elasticsearch
             params = {}
 
             body = arguments[:body]
-            perform_request(method, path, params, body).body
+            perform_request(method, path, params, body, headers).body
           end
       end
     end

data/lib/elasticsearch/xpack/api/actions/machine_learning/validate_detector.rb

@@ -1,21 +1,37 @@
-# Licensed to Elasticsearch B.V under one or more agreements.
-# Elasticsearch B.V licenses this file to you under the Apache 2.0 License.
-# See the LICENSE file in the project root for more information
+# 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 MachineLearning
         module Actions
-          # TODO: Description
-
+          # Validates an anomaly detection detector.
+          #
+          # @option arguments [Hash] :headers Custom HTTP headers
           # @option arguments [Hash] :body The detector (*Required*)
           #
-          # @see [TODO]
+          # @see https://www.elastic.co/guide/en/machine-learning/7.8/ml-jobs.html
           #
           def validate_detector(arguments = {})
             raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
 
+            headers = arguments.delete(:headers) || {}
+
             arguments = arguments.clone
 
             method = Elasticsearch::API::HTTP_POST
@@ -23,7 +39,7 @@ module Elasticsearch
             params = {}
 
             body = arguments[:body]
-            perform_request(method, path, params, body).body
+            perform_request(method, path, params, body, headers).body
           end
       end
     end

data/lib/elasticsearch/xpack/api/actions/migration/deprecations.rb

@@ -1,21 +1,35 @@
-# Licensed to Elasticsearch B.V under one or more agreements.
-# Elasticsearch B.V licenses this file to you under the Apache 2.0 License.
-# See the LICENSE file in the project root for more information
+# 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 Migration
         module Actions
-          # TODO: Description
-
+          # Retrieves information about different cluster, node, and index level settings that use deprecated features that will be removed or changed in the next major version.
           #
           # @option arguments [String] :index Index pattern
-
+          # @option arguments [Hash] :headers Custom HTTP headers
           #
-          # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/migration-api-deprecation.html
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.8/migration-api-deprecation.html
           #
           def deprecations(arguments = {})
+            headers = arguments.delete(:headers) || {}
+
             arguments = arguments.clone
 
             _index = arguments.delete(:index)
@@ -25,11 +39,11 @@ module Elasticsearch
                        "#{Elasticsearch::API::Utils.__listify(_index)}/_migration/deprecations"
                      else
                        "_migration/deprecations"
-  end
+            end
             params = {}
 
             body = nil
-            perform_request(method, path, params, body).body
+            perform_request(method, path, params, body, headers).body
           end
       end
     end

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

@@ -1,6 +1,19 @@
-# Licensed to Elasticsearch B.V under one or more agreements.
-# Elasticsearch B.V licenses this file to you under the Apache 2.0 License.
-# See the LICENSE file in the project root for more information
+# 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

data/lib/elasticsearch/xpack/api/actions/monitoring/bulk.rb

@@ -1,51 +1,79 @@
-# Licensed to Elasticsearch B.V under one or more agreements.
-# Elasticsearch B.V licenses this file to you under the Apache 2.0 License.
-# See the LICENSE file in the project root for more information
+# 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 Monitoring
         module Actions
-
-          # Insert monitoring data in bulk
+          # Used by the monitoring features to send monitoring data.
           #
-          # @option arguments [String] :type Default document type for items which don't provide one
-          # @option arguments [Hash] :body The operation definition and data (action-data pairs), separated by newlines (*Required*)
+          # @option arguments [String] :type Default document type for items which don't provide one   *Deprecated*
           # @option arguments [String] :system_id Identifier of the monitored system
-          # @option arguments [String] :system_api_version API version of the monitored system
-          # @option arguments [String] :system_version Version of the monitored system
+          # @option arguments [String] :system_api_version API Version of the monitored system
+          # @option arguments [String] :interval Collection interval (e.g., '10s' or '10000ms') of the payload
+          # @option arguments [Hash] :headers Custom HTTP headers
+          # @option arguments [Hash] :body The operation definition and data (action-data pairs), separated by newlines (*Required*)
           #
-          # @see http://www.elastic.co/guide/en/monitoring/current/appendix-api-bulk.html
+          # *Deprecation notice*:
+          # Specifying types in urls has been deprecated
+          # Deprecated since version 7.0.0
           #
-          def bulk(arguments={})
+          #
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.8/monitor-elasticsearch-cluster.html
+          #
+          def bulk(arguments = {})
             raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
+
+            headers = arguments.delete(:headers) || {}
+
             arguments = arguments.clone
-            type = arguments.delete(:type)
-            body = arguments.delete(:body)
+
+            _type = arguments.delete(:type)
 
             method = Elasticsearch::API::HTTP_POST
-            path   = Elasticsearch::API::Utils.__pathify '_xpack/monitoring', type, '_bulk'
+            path   = if _type
+                       "_monitoring/#{Elasticsearch::API::Utils.__listify(_type)}/bulk"
+                     else
+                       "_monitoring/bulk"
+  end
             params = Elasticsearch::API::Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
 
+            body = arguments[:body]
             if body.is_a? Array
               payload = Elasticsearch::API::Utils.__bulkify(body)
             else
               payload = body
-            end
+          end
 
-            perform_request(method, path, params, payload).body
+            headers.merge!("Content-Type" => "application/x-ndjson")
+            perform_request(method, path, params, payload, headers).body
           end
 
           # Register this action with its valid params when the module is loaded.
           #
-          # @since 7.4.0
-          ParamsRegistry.register(:bulk, [ :system_id,
-                                           :system_api_version,
-                                           :system_version,
-                                           :interval ].freeze)
-        end
+          # @since 6.2.0
+          ParamsRegistry.register(:bulk, [
+            :system_id,
+            :system_api_version,
+            :interval
+          ].freeze)
       end
     end
+    end
   end
 end