elasticsearch-xpack 5.0.0 → 5.5.0

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

@@ -0,0 +1,25 @@
+module Elasticsearch
+  module XPack
+    module API
+      module MachineLearning
+        module Actions
+
+          # TODO: Description
+          #
+          # @option arguments [String] :job_id The ID of the jobs stats to fetch
+          #
+          # @see http://www.elastic.co/guide/en/x-pack/current/ml-get-job-stats.html
+          #
+          def get_job_stats(arguments={})
+            method = Elasticsearch::API::HTTP_GET
+            path   = "_xpack/ml/anomaly_detectors/#{arguments[:job_id]}/_stats"
+            params = {}
+            body   = nil
+
+            perform_request(method, path, params, body).body
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,25 @@
+module Elasticsearch
+  module XPack
+    module API
+      module MachineLearning
+        module Actions
+
+          # TODO: Description
+          #
+          # @option arguments [String] :job_id The ID of the jobs to fetch
+          #
+          # @see http://www.elastic.co/guide/en/x-pack/current/ml-get-job.html
+          #
+          def get_jobs(arguments={})
+            method = Elasticsearch::API::HTTP_GET
+            path   = "_xpack/ml/anomaly_detectors/#{arguments[:job_id]}"
+            params = {}
+            body   = nil
+
+            perform_request(method, path, params, body).body
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,41 @@
+module Elasticsearch
+  module XPack
+    module API
+      module MachineLearning
+        module Actions
+
+          # TODO: Description
+          #
+          # @option arguments [String] :job_id The ID of the job to fetch (*Required*)
+          # @option arguments [String] :snapshot_id The ID of the snapshot to fetch
+          # @option arguments [Hash] :body Model snapshot selection criteria
+          # @option arguments [Integer] :from Skips a number of documents
+          # @option arguments [Integer] :size The default number of documents returned in queries as a string.
+          # @option arguments [Date] :start The filter 'start' query parameter
+          # @option arguments [Date] :end The filter 'end' query parameter
+          # @option arguments [String] :sort Name of the field to sort on
+          # @option arguments [Boolean] :desc True if the results should be sorted in descending order
+          #
+          # @see http://www.elastic.co/guide/en/x-pack/current/ml-get-snapshot.html
+          #
+          def get_model_snapshots(arguments={})
+            raise ArgumentError, "Required argument 'job_id' missing" unless arguments[:job_id]
+            valid_params = [
+              :from,
+              :size,
+              :start,
+              :end,
+              :sort,
+              :desc ]
+            method = Elasticsearch::API::HTTP_GET
+            path   = "_xpack/ml/anomaly_detectors/#{arguments[:job_id]}/model_snapshots/#{arguments[:snapshot_id]}"
+            params = Elasticsearch::API::Utils.__validate_and_extract_params arguments, valid_params
+            body   = arguments[:body]
+
+            perform_request(method, path, params, body).body
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,44 @@
+module Elasticsearch
+  module XPack
+    module API
+      module MachineLearning
+        module Actions
+
+          # TODO: Description
+          #
+          # @option arguments [String] :job_id [TODO] (*Required*)
+          # @option arguments [Hash] :body Record selection criteria
+          # @option arguments [Boolean] :exclude_interim Exclude interim results
+          # @option arguments [Int] :from skips a number of records
+          # @option arguments [Int] :size specifies a max number of records to get
+          # @option arguments [String] :start Start time filter for records
+          # @option arguments [String] :end End time filter for records
+          # @option arguments [Double] :record_score [TODO]
+          # @option arguments [String] :sort Sort records by a particular field
+          # @option arguments [Boolean] :desc Set the sort direction
+          #
+          # @see http://www.elastic.co/guide/en/x-pack/current/ml-get-record.html
+          #
+          def get_records(arguments={})
+            raise ArgumentError, "Required argument 'job_id' missing" unless arguments[:job_id]
+            valid_params = [
+              :exclude_interim,
+              :from,
+              :size,
+              :start,
+              :end,
+              :record_score,
+              :sort,
+              :desc ]
+            method = Elasticsearch::API::HTTP_GET
+            path   = "_xpack/ml/anomaly_detectors/#{arguments[:job_id]}/results/records"
+            params = Elasticsearch::API::Utils.__validate_and_extract_params arguments, valid_params
+            body   = arguments[:body]
+
+            perform_request(method, path, params, body).body
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,28 @@
+module Elasticsearch
+  module XPack
+    module API
+      module MachineLearning
+        module Actions
+
+          # TODO: Description
+          #
+          # @option arguments [String] :job_id The ID of the job to open (*Required*)
+          # @option arguments [Boolean] :ignore_downtime Controls if gaps in data are treated as anomalous or as a maintenance window after a job re-start
+          # @option arguments [Time] :timeout Controls the time to wait until a job has opened. Default to 30 minutes
+          #
+          # @see http://www.elastic.co/guide/en/x-pack/current/ml-open-job.html
+          #
+          def open_job(arguments={})
+            raise ArgumentError, "Required argument 'job_id' missing" unless arguments[:job_id]
+            method = Elasticsearch::API::HTTP_POST
+            path   = "_xpack/ml/anomaly_detectors/#{arguments[:job_id]}/_open"
+            params = {}
+            body   = nil
+
+            perform_request(method, path, params, body).body
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,33 @@
+module Elasticsearch
+  module XPack
+    module API
+      module MachineLearning
+        module Actions
+
+          # TODO: Description
+          #
+          # @option arguments [String] :job_id The name of the job receiving the data (*Required*)
+          # @option arguments [Hash] :body The data to process (*Required*)
+          # @option arguments [String] :reset_start Optional parameter to specify the start of the bucket resetting range
+          # @option arguments [String] :reset_end Optional parameter to specify the end of the bucket resetting range
+          #
+          # @see http://www.elastic.co/guide/en/x-pack/current/ml-post-data.html
+          #
+          def post_data(arguments={})
+            raise ArgumentError, "Required argument 'job_id' missing" unless arguments[:job_id]
+            raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
+            valid_params = [
+              :reset_start,
+              :reset_end ]
+            method = Elasticsearch::API::HTTP_POST
+            path   = "_xpack/ml/anomaly_detectors/#{arguments[:job_id]}/_data"
+            params = Elasticsearch::API::Utils.__validate_and_extract_params arguments, valid_params
+            body   = arguments[:body]
+
+            perform_request(method, path, params, body).body
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,26 @@
+module Elasticsearch
+  module XPack
+    module API
+      module MachineLearning
+        module Actions
+
+          # TODO: Description
+          #
+          # @option arguments [String] :datafeed_id The ID of the datafeed to preview (*Required*)
+          #
+          # @see http://www.elastic.co/guide/en/x-pack/current/ml-preview-datafeed.html
+          #
+          def preview_datafeed(arguments={})
+            raise ArgumentError, "Required argument 'datafeed_id' missing" unless arguments[:datafeed_id]
+            method = Elasticsearch::API::HTTP_GET
+            path   = "_xpack/ml/datafeeds/#{arguments[:datafeed_id]}/_preview"
+            params = {}
+            body   = nil
+
+            perform_request(method, path, params, body).body
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,28 @@
+module Elasticsearch
+  module XPack
+    module API
+      module MachineLearning
+        module Actions
+
+          # TODO: Description
+          #
+          # @option arguments [String] :datafeed_id The ID of the datafeed to create (*Required*)
+          # @option arguments [Hash] :body The datafeed config (*Required*)
+          #
+          # @see http://www.elastic.co/guide/en/x-pack/current/ml-put-datafeed.html
+          #
+          def put_datafeed(arguments={})
+            raise ArgumentError, "Required argument 'datafeed_id' missing" unless arguments[:datafeed_id]
+            raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
+            method = Elasticsearch::API::HTTP_PUT
+            path   = "_xpack/ml/datafeeds/#{arguments[:datafeed_id]}"
+            params = {}
+            body   = arguments[:body]
+
+            perform_request(method, path, params, body).body
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,28 @@
+module Elasticsearch
+  module XPack
+    module API
+      module MachineLearning
+        module Actions
+
+          # TODO: Description
+          #
+          # @option arguments [String] :filter_id The ID of the filter to create (*Required*)
+          # @option arguments [Hash] :body The filter details (*Required*)
+          #
+          # @see [TODO]
+          #
+          def put_filter(arguments={})
+            raise ArgumentError, "Required argument 'filter_id' missing" unless arguments[:filter_id]
+            raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
+            method = Elasticsearch::API::HTTP_PUT
+            path   = "_xpack/ml/filters/#{arguments[:filter_id]}"
+            params = {}
+            body   = arguments[:body]
+
+            perform_request(method, path, params, body).body
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,28 @@
+module Elasticsearch
+  module XPack
+    module API
+      module MachineLearning
+        module Actions
+
+          # TODO: Description
+          #
+          # @option arguments [String] :job_id The ID of the job to create (*Required*)
+          # @option arguments [Hash] :body The job (*Required*)
+          #
+          # @see http://www.elastic.co/guide/en/x-pack/current/ml-put-job.html
+          #
+          def put_job(arguments={})
+            raise ArgumentError, "Required argument 'job_id' missing" unless arguments[:job_id]
+            raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
+            method = Elasticsearch::API::HTTP_PUT
+            path   = "_xpack/ml/anomaly_detectors/#{arguments[:job_id]}"
+            params = {}
+            body   = arguments[:body]
+
+            perform_request(method, path, params, body).body
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,31 @@
+module Elasticsearch
+  module XPack
+    module API
+      module MachineLearning
+        module Actions
+
+          # TODO: Description
+          #
+          # @option arguments [String] :job_id The ID of the job to fetch (*Required*)
+          # @option arguments [String] :snapshot_id The ID of the snapshot to revert to
+          # @option arguments [Hash] :body Reversion options
+          # @option arguments [Boolean] :delete_intervening_results Should we reset the results back to the time of the snapshot?
+          #
+          # @see http://www.elastic.co/guide/en/x-pack/current/ml-revert-snapshot.html
+          #
+          def revert_model_snapshot(arguments={})
+            raise ArgumentError, "Required argument 'job_id' missing" unless arguments[:job_id]
+            valid_params = [
+              :delete_intervening_results ]
+            method = Elasticsearch::API::HTTP_POST
+            path   = Elasticsearch::API::Utils.__pathify "_xpack/ml/anomaly_detectors", arguments[:job_id], "model_snapshots", arguments[:snapshot_id], "_revert"
+            params = Elasticsearch::API::Utils.__validate_and_extract_params arguments, valid_params
+            body   = arguments[:body]
+
+            perform_request(method, path, params, body).body
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,34 @@
+module Elasticsearch
+  module XPack
+    module API
+      module MachineLearning
+        module Actions
+
+          # TODO: Description
+          #
+          # @option arguments [String] :datafeed_id The ID of the datafeed to start (*Required*)
+          # @option arguments [Hash] :body The start datafeed parameters
+          # @option arguments [String] :start The start time from where the datafeed should begin
+          # @option arguments [String] :end The end time when the datafeed should stop. When not set, the datafeed continues in real time
+          # @option arguments [Time] :timeout Controls the time to wait until a datafeed has started. Default to 20 seconds
+          #
+          # @see http://www.elastic.co/guide/en/x-pack/current/ml-start-datafeed.html
+          #
+          def start_datafeed(arguments={})
+            raise ArgumentError, "Required argument 'datafeed_id' missing" unless arguments[:datafeed_id]
+            valid_params = [
+              :start,
+              :end,
+              :timeout ]
+            method = Elasticsearch::API::HTTP_POST
+            path   = "_xpack/ml/datafeeds/#{arguments[:datafeed_id]}/_start"
+            params = Elasticsearch::API::Utils.__validate_and_extract_params arguments, valid_params
+            body   = arguments[:body]
+
+            perform_request(method, path, params, body).body
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,31 @@
+module Elasticsearch
+  module XPack
+    module API
+      module MachineLearning
+        module Actions
+
+          # TODO: Description
+          #
+          # @option arguments [String] :datafeed_id The ID of the datafeed to stop (*Required*)
+          # @option arguments [Boolean] :force True if the datafeed should be forcefully stopped.
+          # @option arguments [Time] :timeout Controls the time to wait until a datafeed has stopped. Default to 20 seconds
+          #
+          # @see http://www.elastic.co/guide/en/x-pack/current/ml-stop-datafeed.html
+          #
+          def stop_datafeed(arguments={})
+            raise ArgumentError, "Required argument 'datafeed_id' missing" unless arguments[:datafeed_id]
+            valid_params = [
+              :force,
+              :timeout ]
+            method = Elasticsearch::API::HTTP_POST
+            path   = "_xpack/ml/datafeeds/#{arguments[:datafeed_id]}/_stop"
+            params = Elasticsearch::API::Utils.__validate_and_extract_params arguments, valid_params
+            body   = nil
+
+            perform_request(method, path, params, body).body
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,28 @@
+module Elasticsearch
+  module XPack
+    module API
+      module MachineLearning
+        module Actions
+
+          # TODO: Description
+          #
+          # @option arguments [String] :datafeed_id The ID of the datafeed to update (*Required*)
+          # @option arguments [Hash] :body The datafeed update settings (*Required*)
+          #
+          # @see http://www.elastic.co/guide/en/x-pack/current/ml-update-datafeed.html
+          #
+          def update_datafeed(arguments={})
+            raise ArgumentError, "Required argument 'datafeed_id' missing" unless arguments[:datafeed_id]
+            raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
+            method = Elasticsearch::API::HTTP_POST
+            path   = "_xpack/ml/datafeeds/#{arguments[:datafeed_id]}/_update"
+            params = {}
+            body   = arguments[:body]
+
+            perform_request(method, path, params, body).body
+          end
+        end
+      end
+    end
+  end
+end