elasticsearch-xpack 7.7.0 → 7.9.0

data/lib/elasticsearch/xpack/api/actions/machine_learning/forecast.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
@@ -12,9 +25,10 @@ module Elasticsearch
           # @option arguments [String] :job_id The ID of the job to forecast for
           # @option arguments [Time] :duration The duration of the forecast
           # @option arguments [Time] :expires_in The time interval after which the forecast expires. Expired forecasts will be deleted at the first opportunity.
+          # @option arguments [String] :max_model_memory The max memory able to be used by the forecast. Default is 20mb.
           # @option arguments [Hash] :headers Custom HTTP headers
           #
-          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.7/ml-forecast.html
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.9/ml-forecast.html
           #
           def forecast(arguments = {})
             raise ArgumentError, "Required argument 'job_id' missing" unless arguments[:job_id]
@@ -38,10 +52,11 @@ module Elasticsearch
           # @since 6.2.0
           ParamsRegistry.register(:forecast, [
             :duration,
-            :expires_in
+            :expires_in,
+            :max_model_memory
           ].freeze)
+        end
       end
     end
-    end
   end
 end

data/lib/elasticsearch/xpack/api/actions/machine_learning/get_buckets.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
@@ -23,7 +36,7 @@ module Elasticsearch
           # @option arguments [Hash] :headers Custom HTTP headers
           # @option arguments [Hash] :body Bucket selection details if not provided in URI
           #
-          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.7/ml-get-bucket.html
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.9/ml-get-bucket.html
           #
           def get_buckets(arguments = {})
             raise ArgumentError, "Required argument 'job_id' missing" unless arguments[:job_id]
@@ -36,12 +49,17 @@ module Elasticsearch
 
             _timestamp = arguments.delete(:timestamp)
 
-            method = Elasticsearch::API::HTTP_GET
-            path   = if _job_id && _timestamp
-                       "_ml/anomaly_detectors/#{Elasticsearch::API::Utils.__listify(_job_id)}/results/buckets/#{Elasticsearch::API::Utils.__listify(_timestamp)}"
+            method = if arguments[:body]
+                       Elasticsearch::API::HTTP_POST
                      else
-                       "_ml/anomaly_detectors/#{Elasticsearch::API::Utils.__listify(_job_id)}/results/buckets"
-  end
+                       Elasticsearch::API::HTTP_GET
+                     end
+
+            path = if _job_id && _timestamp
+                     "_ml/anomaly_detectors/#{Elasticsearch::API::Utils.__listify(_job_id)}/results/buckets/#{Elasticsearch::API::Utils.__listify(_timestamp)}"
+                   else
+                     "_ml/anomaly_detectors/#{Elasticsearch::API::Utils.__listify(_job_id)}/results/buckets"
+                   end
             params = Elasticsearch::API::Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
 
             body = arguments[:body]
@@ -62,8 +80,8 @@ module Elasticsearch
             :sort,
             :desc
           ].freeze)
+        end
       end
     end
-    end
   end
 end

data/lib/elasticsearch/xpack/api/actions/machine_learning/get_calendar_events.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
@@ -17,7 +30,7 @@ module Elasticsearch
           # @option arguments [Int] :size Specifies a max number of events to get
           # @option arguments [Hash] :headers Custom HTTP headers
           #
-          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.7/ml-get-calendar-event.html
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.9/ml-get-calendar-event.html
           #
           def get_calendar_events(arguments = {})
             raise ArgumentError, "Required argument 'calendar_id' missing" unless arguments[:calendar_id]
@@ -46,8 +59,8 @@ module Elasticsearch
             :from,
             :size
           ].freeze)
+        end
       end
     end
-    end
   end
 end

data/lib/elasticsearch/xpack/api/actions/machine_learning/get_calendars.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
@@ -15,7 +28,7 @@ module Elasticsearch
           # @option arguments [Hash] :headers Custom HTTP headers
           # @option arguments [Hash] :body The from and size parameters optionally sent in the body
           #
-          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.7/ml-get-calendar.html
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.9/ml-get-calendar.html
           #
           def get_calendars(arguments = {})
             headers = arguments.delete(:headers) || {}
@@ -24,12 +37,17 @@ module Elasticsearch
 
             _calendar_id = arguments.delete(:calendar_id)
 
-            method = Elasticsearch::API::HTTP_GET
-            path   = if _calendar_id
-                       "_ml/calendars/#{Elasticsearch::API::Utils.__listify(_calendar_id)}"
+            method = if arguments[:body]
+                       Elasticsearch::API::HTTP_POST
                      else
-                       "_ml/calendars"
-            end
+                       Elasticsearch::API::HTTP_GET
+                     end
+
+            path = if _calendar_id
+                     "_ml/calendars/#{Elasticsearch::API::Utils.__listify(_calendar_id)}"
+                   else
+                     "_ml/calendars"
+                   end
             params = Elasticsearch::API::Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
 
             body = arguments[:body]
@@ -43,8 +61,8 @@ module Elasticsearch
             :from,
             :size
           ].freeze)
+        end
       end
     end
-    end
   end
 end

data/lib/elasticsearch/xpack/api/actions/machine_learning/get_categories.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
@@ -13,10 +26,11 @@ module Elasticsearch
           # @option arguments [Long] :category_id The identifier of the category definition of interest
           # @option arguments [Int] :from skips a number of categories
           # @option arguments [Int] :size specifies a max number of categories to get
+          # @option arguments [String] :partition_field_value Specifies the partition to retrieve categories for. This is optional, and should never be used for jobs where per-partition categorization is disabled.
           # @option arguments [Hash] :headers Custom HTTP headers
           # @option arguments [Hash] :body Category selection details if not provided in URI
           #
-          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.7/ml-get-category.html
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.9/ml-get-category.html
           #
           def get_categories(arguments = {})
             raise ArgumentError, "Required argument 'job_id' missing" unless arguments[:job_id]
@@ -29,12 +43,17 @@ module Elasticsearch
 
             _category_id = arguments.delete(:category_id)
 
-            method = Elasticsearch::API::HTTP_GET
-            path   = if _job_id && _category_id
-                       "_ml/anomaly_detectors/#{Elasticsearch::API::Utils.__listify(_job_id)}/results/categories/#{Elasticsearch::API::Utils.__listify(_category_id)}"
+            method = if arguments[:body]
+                       Elasticsearch::API::HTTP_POST
                      else
-                       "_ml/anomaly_detectors/#{Elasticsearch::API::Utils.__listify(_job_id)}/results/categories"
-  end
+                       Elasticsearch::API::HTTP_GET
+                     end
+
+            path = if _job_id && _category_id
+                     "_ml/anomaly_detectors/#{Elasticsearch::API::Utils.__listify(_job_id)}/results/categories/#{Elasticsearch::API::Utils.__listify(_category_id)}"
+                   else
+                     "_ml/anomaly_detectors/#{Elasticsearch::API::Utils.__listify(_job_id)}/results/categories"
+                   end
             params = Elasticsearch::API::Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
 
             body = arguments[:body]
@@ -46,10 +65,11 @@ module Elasticsearch
           # @since 6.2.0
           ParamsRegistry.register(:get_categories, [
             :from,
-            :size
+            :size,
+            :partition_field_value
           ].freeze)
+        end
       end
     end
-    end
   end
 end

data/lib/elasticsearch/xpack/api/actions/machine_learning/get_data_frame_analytics.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
@@ -8,6 +21,10 @@ module Elasticsearch
       module MachineLearning
         module Actions
           # Retrieves configuration information for data frame analytics jobs.
+          # 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] :id The ID of the data frame analytics to fetch
           # @option arguments [Boolean] :allow_no_match Whether to ignore if a wildcard expression matches no data frame analytics. (This includes `_all` string or when no data frame analytics have been specified)
@@ -15,7 +32,7 @@ module Elasticsearch
           # @option arguments [Int] :size specifies a max number of analytics to get
           # @option arguments [Hash] :headers Custom HTTP headers
           #
-          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.7/get-dfanalytics.html
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.9/get-dfanalytics.html
           #
           def get_data_frame_analytics(arguments = {})
             headers = arguments.delete(:headers) || {}
@@ -29,7 +46,7 @@ module Elasticsearch
                        "_ml/data_frame/analytics/#{Elasticsearch::API::Utils.__listify(_id)}"
                      else
                        "_ml/data_frame/analytics"
-            end
+                     end
             params = Elasticsearch::API::Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
 
             body = nil
@@ -44,8 +61,8 @@ module Elasticsearch
             :from,
             :size
           ].freeze)
+        end
       end
     end
-    end
   end
 end

data/lib/elasticsearch/xpack/api/actions/machine_learning/get_data_frame_analytics_stats.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
@@ -8,6 +21,10 @@ module Elasticsearch
       module MachineLearning
         module Actions
           # Retrieves usage information for data frame analytics jobs.
+          # 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] :id The ID of the data frame analytics stats to fetch
           # @option arguments [Boolean] :allow_no_match Whether to ignore if a wildcard expression matches no data frame analytics. (This includes `_all` string or when no data frame analytics have been specified)
@@ -15,7 +32,7 @@ module Elasticsearch
           # @option arguments [Int] :size specifies a max number of analytics to get
           # @option arguments [Hash] :headers Custom HTTP headers
           #
-          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.7/get-dfanalytics-stats.html
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.9/get-dfanalytics-stats.html
           #
           def get_data_frame_analytics_stats(arguments = {})
             headers = arguments.delete(:headers) || {}
@@ -29,7 +46,7 @@ module Elasticsearch
                        "_ml/data_frame/analytics/#{Elasticsearch::API::Utils.__listify(_id)}/_stats"
                      else
                        "_ml/data_frame/analytics/_stats"
-            end
+                     end
             params = Elasticsearch::API::Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
 
             body = nil
@@ -44,8 +61,8 @@ module Elasticsearch
             :from,
             :size
           ].freeze)
+        end
       end
     end
-    end
   end
 end

data/lib/elasticsearch/xpack/api/actions/machine_learning/get_datafeed_stats.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
@@ -13,7 +26,7 @@ module Elasticsearch
           # @option arguments [Boolean] :allow_no_datafeeds Whether to ignore if a wildcard expression matches no datafeeds. (This includes `_all` string or when no datafeeds have been specified)
           # @option arguments [Hash] :headers Custom HTTP headers
           #
-          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.7/ml-get-datafeed-stats.html
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.9/ml-get-datafeed-stats.html
           #
           def get_datafeed_stats(arguments = {})
             headers = arguments.delete(:headers) || {}
@@ -27,7 +40,7 @@ module Elasticsearch
                        "_ml/datafeeds/#{Elasticsearch::API::Utils.__listify(_datafeed_id)}/_stats"
                      else
                        "_ml/datafeeds/_stats"
-            end
+                     end
             params = Elasticsearch::API::Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
 
             body = nil
@@ -40,8 +53,8 @@ module Elasticsearch
           ParamsRegistry.register(:get_datafeed_stats, [
             :allow_no_datafeeds
           ].freeze)
+        end
       end
     end
-    end
   end
 end