elasticsearch-api 7.17.7 → 8.0.0.pre1

data/lib/elasticsearch/api/actions/machine_learning/delete_calendar_event.rb

@@ -0,0 +1,55 @@
+# 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 API
+    module MachineLearning
+      module Actions
+        # Deletes scheduled events from a calendar.
+        #
+        # @option arguments [String] :calendar_id The ID of the calendar to modify
+        # @option arguments [String] :event_id The ID of the event to remove from the calendar
+        # @option arguments [Hash] :headers Custom HTTP headers
+        #
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-calendar-event.html
+        #
+        def delete_calendar_event(arguments = {})
+          raise ArgumentError, "Required argument 'calendar_id' missing" unless arguments[:calendar_id]
+          raise ArgumentError, "Required argument 'event_id' missing" unless arguments[:event_id]
+
+          headers = arguments.delete(:headers) || {}
+
+          body = nil
+
+          arguments = arguments.clone
+
+          _calendar_id = arguments.delete(:calendar_id)
+
+          _event_id = arguments.delete(:event_id)
+
+          method = Elasticsearch::API::HTTP_DELETE
+          path   = "_ml/calendars/#{Utils.__listify(_calendar_id)}/events/#{Utils.__listify(_event_id)}"
+          params = {}
+
+          Elasticsearch::API::Response.new(
+            perform_request(method, path, params, body, headers)
+          )
+        end
+      end
+    end
+  end
+end

data/lib/elasticsearch/api/actions/machine_learning/delete_calendar_job.rb

@@ -0,0 +1,55 @@
+# 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 API
+    module MachineLearning
+      module Actions
+        # Deletes anomaly detection jobs from a calendar.
+        #
+        # @option arguments [String] :calendar_id The ID of the calendar to modify
+        # @option arguments [String] :job_id The ID of the job to remove from the calendar
+        # @option arguments [Hash] :headers Custom HTTP headers
+        #
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-calendar-job.html
+        #
+        def delete_calendar_job(arguments = {})
+          raise ArgumentError, "Required argument 'calendar_id' missing" unless arguments[:calendar_id]
+          raise ArgumentError, "Required argument 'job_id' missing" unless arguments[:job_id]
+
+          headers = arguments.delete(:headers) || {}
+
+          body = nil
+
+          arguments = arguments.clone
+
+          _calendar_id = arguments.delete(:calendar_id)
+
+          _job_id = arguments.delete(:job_id)
+
+          method = Elasticsearch::API::HTTP_DELETE
+          path   = "_ml/calendars/#{Utils.__listify(_calendar_id)}/jobs/#{Utils.__listify(_job_id)}"
+          params = {}
+
+          Elasticsearch::API::Response.new(
+            perform_request(method, path, params, body, headers)
+          )
+        end
+      end
+    end
+  end
+end

data/lib/elasticsearch/api/actions/machine_learning/delete_data_frame_analytics.rb

@@ -0,0 +1,53 @@
+# 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 API
+    module MachineLearning
+      module Actions
+        # Deletes an existing data frame analytics job.
+        #
+        # @option arguments [String] :id The ID of the data frame analytics to delete
+        # @option arguments [Boolean] :force True if the job should be forcefully deleted
+        # @option arguments [Time] :timeout Controls the time to wait until a job is deleted. Defaults to 1 minute
+        # @option arguments [Hash] :headers Custom HTTP headers
+        #
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-dfanalytics.html
+        #
+        def delete_data_frame_analytics(arguments = {})
+          raise ArgumentError, "Required argument 'id' missing" unless arguments[:id]
+
+          headers = arguments.delete(:headers) || {}
+
+          body = nil
+
+          arguments = arguments.clone
+
+          _id = arguments.delete(:id)
+
+          method = Elasticsearch::API::HTTP_DELETE
+          path   = "_ml/data_frame/analytics/#{Utils.__listify(_id)}"
+          params = Utils.process_params(arguments)
+
+          Elasticsearch::API::Response.new(
+            perform_request(method, path, params, body, headers)
+          )
+        end
+      end
+    end
+  end
+end

data/lib/elasticsearch/api/actions/machine_learning/delete_datafeed.rb

@@ -0,0 +1,52 @@
+# 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 API
+    module MachineLearning
+      module Actions
+        # Deletes an existing datafeed.
+        #
+        # @option arguments [String] :datafeed_id The ID of the datafeed to delete
+        # @option arguments [Boolean] :force True if the datafeed should be forcefully deleted
+        # @option arguments [Hash] :headers Custom HTTP headers
+        #
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-datafeed.html
+        #
+        def delete_datafeed(arguments = {})
+          raise ArgumentError, "Required argument 'datafeed_id' missing" unless arguments[:datafeed_id]
+
+          headers = arguments.delete(:headers) || {}
+
+          body = nil
+
+          arguments = arguments.clone
+
+          _datafeed_id = arguments.delete(:datafeed_id)
+
+          method = Elasticsearch::API::HTTP_DELETE
+          path   = "_ml/datafeeds/#{Utils.__listify(_datafeed_id)}"
+          params = Utils.process_params(arguments)
+
+          Elasticsearch::API::Response.new(
+            perform_request(method, path, params, body, headers)
+          )
+        end
+      end
+    end
+  end
+end

data/lib/elasticsearch/api/actions/machine_learning/delete_expired_data.rb

@@ -0,0 +1,56 @@
+# 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 API
+    module MachineLearning
+      module Actions
+        # Deletes expired and unused machine learning data.
+        #
+        # @option arguments [String] :job_id The ID of the job(s) to perform expired data hygiene for
+        # @option arguments [Number] :requests_per_second The desired requests per second for the deletion processes.
+        # @option arguments [Time] :timeout How long can the underlying delete processes run until they are canceled
+        # @option arguments [Hash] :headers Custom HTTP headers
+        # @option arguments [Hash] :body deleting expired data parameters
+        #
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-expired-data.html
+        #
+        def delete_expired_data(arguments = {})
+          headers = arguments.delete(:headers) || {}
+
+          body = arguments.delete(:body)
+
+          arguments = arguments.clone
+
+          _job_id = arguments.delete(:job_id)
+
+          method = Elasticsearch::API::HTTP_DELETE
+          path   = if _job_id
+                     "_ml/_delete_expired_data/#{Utils.__listify(_job_id)}"
+                   else
+                     "_ml/_delete_expired_data"
+                   end
+          params = Utils.process_params(arguments)
+
+          Elasticsearch::API::Response.new(
+            perform_request(method, path, params, body, headers)
+          )
+        end
+      end
+    end
+  end
+end

data/lib/elasticsearch/api/actions/machine_learning/delete_filter.rb

@@ -0,0 +1,51 @@
+# 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 API
+    module MachineLearning
+      module Actions
+        # Deletes a filter.
+        #
+        # @option arguments [String] :filter_id The ID of the filter to delete
+        # @option arguments [Hash] :headers Custom HTTP headers
+        #
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-filter.html
+        #
+        def delete_filter(arguments = {})
+          raise ArgumentError, "Required argument 'filter_id' missing" unless arguments[:filter_id]
+
+          headers = arguments.delete(:headers) || {}
+
+          body = nil
+
+          arguments = arguments.clone
+
+          _filter_id = arguments.delete(:filter_id)
+
+          method = Elasticsearch::API::HTTP_DELETE
+          path   = "_ml/filters/#{Utils.__listify(_filter_id)}"
+          params = {}
+
+          Elasticsearch::API::Response.new(
+            perform_request(method, path, params, body, headers)
+          )
+        end
+      end
+    end
+  end
+end

data/lib/elasticsearch/api/actions/machine_learning/delete_forecast.rb

@@ -0,0 +1,60 @@
+# 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 API
+    module MachineLearning
+      module Actions
+        # Deletes forecasts from a machine learning job.
+        #
+        # @option arguments [String] :job_id The ID of the job from which to delete forecasts
+        # @option arguments [String] :forecast_id The ID of the forecast to delete, can be comma delimited list. Leaving blank implies `_all`
+        # @option arguments [Boolean] :allow_no_forecasts Whether to ignore if `_all` matches no forecasts
+        # @option arguments [Time] :timeout Controls the time to wait until the forecast(s) are deleted. Default to 30 seconds
+        # @option arguments [Hash] :headers Custom HTTP headers
+        #
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-forecast.html
+        #
+        def delete_forecast(arguments = {})
+          raise ArgumentError, "Required argument 'job_id' missing" unless arguments[:job_id]
+
+          headers = arguments.delete(:headers) || {}
+
+          body = nil
+
+          arguments = arguments.clone
+
+          _job_id = arguments.delete(:job_id)
+
+          _forecast_id = arguments.delete(:forecast_id)
+
+          method = Elasticsearch::API::HTTP_DELETE
+          path   = if _job_id && _forecast_id
+                     "_ml/anomaly_detectors/#{Utils.__listify(_job_id)}/_forecast/#{Utils.__listify(_forecast_id)}"
+                   else
+                     "_ml/anomaly_detectors/#{Utils.__listify(_job_id)}/_forecast"
+                   end
+          params = Utils.process_params(arguments)
+
+          Elasticsearch::API::Response.new(
+            perform_request(method, path, params, body, headers)
+          )
+        end
+      end
+    end
+  end
+end

data/lib/elasticsearch/api/actions/machine_learning/delete_job.rb

@@ -0,0 +1,53 @@
+# 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 API
+    module MachineLearning
+      module Actions
+        # Deletes an existing anomaly detection job.
+        #
+        # @option arguments [String] :job_id The ID of the job to delete
+        # @option arguments [Boolean] :force True if the job should be forcefully deleted
+        # @option arguments [Boolean] :wait_for_completion Should this request wait until the operation has completed before returning
+        # @option arguments [Hash] :headers Custom HTTP headers
+        #
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-job.html
+        #
+        def delete_job(arguments = {})
+          raise ArgumentError, "Required argument 'job_id' missing" unless arguments[:job_id]
+
+          headers = arguments.delete(:headers) || {}
+
+          body = nil
+
+          arguments = arguments.clone
+
+          _job_id = arguments.delete(:job_id)
+
+          method = Elasticsearch::API::HTTP_DELETE
+          path   = "_ml/anomaly_detectors/#{Utils.__listify(_job_id)}"
+          params = Utils.process_params(arguments)
+
+          Elasticsearch::API::Response.new(
+            perform_request(method, path, params, body, headers)
+          )
+        end
+      end
+    end
+  end
+end

data/lib/elasticsearch/api/actions/machine_learning/delete_model_snapshot.rb

@@ -0,0 +1,55 @@
+# 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 API
+    module MachineLearning
+      module Actions
+        # Deletes an existing model snapshot.
+        #
+        # @option arguments [String] :job_id The ID of the job to fetch
+        # @option arguments [String] :snapshot_id The ID of the snapshot to delete
+        # @option arguments [Hash] :headers Custom HTTP headers
+        #
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-snapshot.html
+        #
+        def delete_model_snapshot(arguments = {})
+          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) || {}
+
+          body = nil
+
+          arguments = arguments.clone
+
+          _job_id = arguments.delete(:job_id)
+
+          _snapshot_id = arguments.delete(:snapshot_id)
+
+          method = Elasticsearch::API::HTTP_DELETE
+          path   = "_ml/anomaly_detectors/#{Utils.__listify(_job_id)}/model_snapshots/#{Utils.__listify(_snapshot_id)}"
+          params = {}
+
+          Elasticsearch::API::Response.new(
+            perform_request(method, path, params, body, headers)
+          )
+        end
+      end
+    end
+  end
+end

data/lib/elasticsearch/api/actions/machine_learning/delete_trained_model.rb

@@ -0,0 +1,51 @@
+# 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 API
+    module MachineLearning
+      module Actions
+        # Deletes an existing trained inference model that is currently not referenced by an ingest pipeline.
+        #
+        # @option arguments [String] :model_id The ID of the trained model to delete
+        # @option arguments [Hash] :headers Custom HTTP headers
+        #
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-trained-models.html
+        #
+        def delete_trained_model(arguments = {})
+          raise ArgumentError, "Required argument 'model_id' missing" unless arguments[:model_id]
+
+          headers = arguments.delete(:headers) || {}
+
+          body = nil
+
+          arguments = arguments.clone
+
+          _model_id = arguments.delete(:model_id)
+
+          method = Elasticsearch::API::HTTP_DELETE
+          path   = "_ml/trained_models/#{Utils.__listify(_model_id)}"
+          params = {}
+
+          Elasticsearch::API::Response.new(
+            perform_request(method, path, params, body, headers)
+          )
+        end
+      end
+    end
+  end
+end

data/lib/elasticsearch/api/actions/machine_learning/delete_trained_model_alias.rb

@@ -0,0 +1,55 @@
+# 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 API
+    module MachineLearning
+      module Actions
+        # Deletes a model alias that refers to the trained model
+        #
+        # @option arguments [String] :model_alias The trained model alias to delete
+        # @option arguments [String] :model_id The trained model where the model alias is assigned
+        # @option arguments [Hash] :headers Custom HTTP headers
+        #
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-trained-models-aliases.html
+        #
+        def delete_trained_model_alias(arguments = {})
+          raise ArgumentError, "Required argument 'model_id' missing" unless arguments[:model_id]
+          raise ArgumentError, "Required argument 'model_alias' missing" unless arguments[:model_alias]
+
+          headers = arguments.delete(:headers) || {}
+
+          body = nil
+
+          arguments = arguments.clone
+
+          _model_alias = arguments.delete(:model_alias)
+
+          _model_id = arguments.delete(:model_id)
+
+          method = Elasticsearch::API::HTTP_DELETE
+          path   = "_ml/trained_models/#{Utils.__listify(_model_id)}/model_aliases/#{Utils.__listify(_model_alias)}"
+          params = {}
+
+          Elasticsearch::API::Response.new(
+            perform_request(method, path, params, body, headers)
+          )
+        end
+      end
+    end
+  end
+end

data/lib/elasticsearch/api/actions/machine_learning/estimate_model_memory.rb

@@ -0,0 +1,49 @@
+# 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 API
+    module MachineLearning
+      module Actions
+        # Estimates the model memory
+        #
+        # @option arguments [Hash] :headers Custom HTTP headers
+        # @option arguments [Hash] :body The analysis config, plus cardinality estimates for fields it references (*Required*)
+        #
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-apis.html
+        #
+        def estimate_model_memory(arguments = {})
+          raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
+
+          headers = arguments.delete(:headers) || {}
+
+          body = arguments.delete(:body)
+
+          arguments = arguments.clone
+
+          method = Elasticsearch::API::HTTP_POST
+          path   = "_ml/anomaly_detectors/_estimate_model_memory"
+          params = {}
+
+          Elasticsearch::API::Response.new(
+            perform_request(method, path, params, body, headers)
+          )
+        end
+      end
+    end
+  end
+end