elasticsearch-xpack 5.5.0 → 6.0.0

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

@@ -4,16 +4,20 @@ module Elasticsearch
       module MachineLearning
         module Actions
 
-          # TODO: Description
+          # Retrieve configuration information for datafeeds
           #
-          # @option arguments [String] :datafeed_id The ID of the datafeeds to fetch
+          # @option arguments [String] :datafeed_id The ID of the datafeeds stats to fetch
+          # @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)
           #
-          # @see http://www.elastic.co/guide/en/x-pack/current/ml-get-datafeed.html
+          # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-datafeed.html
           #
           def get_datafeeds(arguments={})
+            valid_params = [
+              :allow_no_datafeeds ]
+
             method = Elasticsearch::API::HTTP_GET
-            path   = "_xpack/ml/datafeeds/#{arguments[:datafeed_id]}"
-            params = {}
+            path   = Elasticsearch::API::Utils.__pathify "_xpack/ml/datafeeds", arguments[:datafeed_id]
+            params = Elasticsearch::API::Utils.__validate_and_extract_params arguments, valid_params
             body   = nil
 
             perform_request(method, path, params, body).body

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

@@ -4,20 +4,16 @@ module Elasticsearch
       module MachineLearning
         module Actions
 
-          # TODO: Description
-          #
           # @option arguments [String] :filter_id The ID of the filter to fetch
           # @option arguments [Int] :from skips a number of filters
           # @option arguments [Int] :size specifies a max number of filters to get
           #
-          # @see [TODO]
-          #
           def get_filters(arguments={})
             valid_params = [
               :from,
               :size ]
             method = Elasticsearch::API::HTTP_GET
-            path   = "_xpack/ml/filters/#{arguments[:filter_id]}"
+            path   = Elasticsearch::API::Utils.__pathify "_xpack/ml/filters", arguments[:filter_id]
             params = Elasticsearch::API::Utils.__validate_and_extract_params arguments, valid_params
             body   = nil
 

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

@@ -4,7 +4,7 @@ module Elasticsearch
       module MachineLearning
         module Actions
 
-          # TODO: Description
+          # Retrieve job results for one or more influencers
           #
           # @option arguments [String] :job_id [TODO] (*Required*)
           # @option arguments [Hash] :body Influencer selection criteria
@@ -17,7 +17,7 @@ module Elasticsearch
           # @option arguments [String] :sort sort field for the requested influencers
           # @option arguments [Boolean] :desc whether the results should be sorted in decending order
           #
-          # @see http://www.elastic.co/guide/en/x-pack/current/ml-get-influencer.html
+          # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-influencer.html
           #
           def get_influencers(arguments={})
             raise ArgumentError, "Required argument 'job_id' missing" unless arguments[:job_id]

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

@@ -7,13 +7,17 @@ module Elasticsearch
           # TODO: Description
           #
           # @option arguments [String] :job_id The ID of the jobs stats to fetch
+          # @option arguments [Boolean] :allow_no_jobs Whether to ignore if a wildcard expression matches no jobs. (This includes `_all` string or when no jobs have been specified)
           #
           # @see http://www.elastic.co/guide/en/x-pack/current/ml-get-job-stats.html
           #
           def get_job_stats(arguments={})
+            valid_params = [
+              :allow_no_jobs ]
+
             method = Elasticsearch::API::HTTP_GET
             path   = "_xpack/ml/anomaly_detectors/#{arguments[:job_id]}/_stats"
-            params = {}
+            params = Elasticsearch::API::Utils.__validate_and_extract_params arguments, valid_params
             body   = nil
 
             perform_request(method, path, params, body).body

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

@@ -4,16 +4,20 @@ module Elasticsearch
       module MachineLearning
         module Actions
 
-          # TODO: Description
+          # Retrieve configuration information for jobs
           #
           # @option arguments [String] :job_id The ID of the jobs to fetch
+          # @option arguments [Boolean] :allow_no_jobs Whether to ignore if a wildcard expression matches no jobs. (This includes `_all` string or when no jobs have been specified)
           #
-          # @see http://www.elastic.co/guide/en/x-pack/current/ml-get-job.html
+          # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-job.html
           #
           def get_jobs(arguments={})
+            valid_params = [
+              :allow_no_jobs ]
+
             method = Elasticsearch::API::HTTP_GET
             path   = "_xpack/ml/anomaly_detectors/#{arguments[:job_id]}"
-            params = {}
+            params = Elasticsearch::API::Utils.__validate_and_extract_params arguments, valid_params
             body   = nil
 
             perform_request(method, path, params, body).body

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

@@ -4,7 +4,7 @@ module Elasticsearch
       module MachineLearning
         module Actions
 
-          # TODO: Description
+          # Retrieve information about model snapshots
           #
           # @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
@@ -16,7 +16,7 @@ module Elasticsearch
           # @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
+          # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-snapshot.html
           #
           def get_model_snapshots(arguments={})
             raise ArgumentError, "Required argument 'job_id' missing" unless arguments[:job_id]

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

@@ -0,0 +1,44 @@
+module Elasticsearch
+  module XPack
+    module API
+      module MachineLearning
+        module Actions
+
+          # Retrieve overall bucket results that summarize the bucket results of multiple jobs
+          #
+          # @option arguments [String] :job_id The job IDs for which to calculate overall bucket results (*Required*)
+          # @option arguments [Hash] :body Overall bucket selection details if not provided in URI
+          # @option arguments [Int] :top_n The number of top job bucket scores to be used in the overall_score calculation
+          # @option arguments [String] :bucket_span The span of the overall buckets. Defaults to the longest job bucket_span
+          # @option arguments [Double] :overall_score Returns overall buckets with overall scores higher than this value
+          # @option arguments [Boolean] :exclude_interim If true overall buckets that include interim buckets will be excluded
+          # @option arguments [String] :start Returns overall buckets with timestamps after this time
+          # @option arguments [String] :end Returns overall buckets with timestamps earlier than this time
+          # @option arguments [Boolean] :allow_no_jobs Whether to ignore if a wildcard expression matches no jobs. (This includes `_all` string or when no jobs have been specified)
+          #
+          # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-overall-buckets.html
+          #
+          def get_overall_buckets(arguments={})
+            raise ArgumentError, "Required argument 'job_id' missing" unless arguments[:job_id]
+
+            valid_params = [
+              :top_n,
+              :bucket_span,
+              :overall_score,
+              :exclude_interim,
+              :start,
+              :end,
+              :allow_no_jobs ]
+
+            method = Elasticsearch::API::HTTP_GET
+            path   = "_xpack/ml/anomaly_detectors/#{arguments[:job_id]}/results/overall_buckets"
+            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

@@ -4,7 +4,7 @@ module Elasticsearch
       module MachineLearning
         module Actions
 
-          # TODO: Description
+          # Retrieve anomaly records for a job
           #
           # @option arguments [String] :job_id [TODO] (*Required*)
           # @option arguments [Hash] :body Record selection criteria
@@ -17,10 +17,11 @@ module Elasticsearch
           # @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
+          # @see http://www.elastic.co/guide/en/elasticsearch/reference/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,
@@ -30,6 +31,7 @@ module Elasticsearch
               :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

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

@@ -4,13 +4,13 @@ module Elasticsearch
       module MachineLearning
         module Actions
 
-          # TODO: Description
+          # Open a job to receive and analyze data
           #
           # @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
+          # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-open-job.html
           #
           def open_job(arguments={})
             raise ArgumentError, "Required argument 'job_id' missing" unless arguments[:job_id]

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

@@ -4,14 +4,14 @@ module Elasticsearch
       module MachineLearning
         module Actions
 
-          # TODO: Description
+          # Send data to an anomaly detection job for analysis
           #
           # @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
+          # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-post-data.html
           #
           def post_data(arguments={})
             raise ArgumentError, "Required argument 'job_id' missing" unless arguments[:job_id]

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

@@ -4,11 +4,11 @@ module Elasticsearch
       module MachineLearning
         module Actions
 
-          # TODO: Description
+          # Preview a datafeed
           #
           # @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
+          # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-preview-datafeed.html
           #
           def preview_datafeed(arguments={})
             raise ArgumentError, "Required argument 'datafeed_id' missing" unless arguments[:datafeed_id]

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

@@ -4,12 +4,12 @@ module Elasticsearch
       module MachineLearning
         module Actions
 
-          # TODO: Description
+          # Create a new datafeed
           #
           # @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
+          # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-put-datafeed.html
           #
           def put_datafeed(arguments={})
             raise ArgumentError, "Required argument 'datafeed_id' missing" unless arguments[:datafeed_id]

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

@@ -4,13 +4,9 @@ module Elasticsearch
       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]

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

@@ -4,12 +4,12 @@ module Elasticsearch
       module MachineLearning
         module Actions
 
-          # TODO: Description
+          # Create a new job
           #
           # @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
+          # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-put-job.html
           #
           def put_job(arguments={})
             raise ArgumentError, "Required argument 'job_id' missing" unless arguments[:job_id]

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

@@ -4,19 +4,21 @@ module Elasticsearch
       module MachineLearning
         module Actions
 
-          # TODO: Description
+          # Revert to a specific snapshot (eg. before a highly-anomalous, but insignificant event)
           #
           # @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
+          # @see http://www.elastic.co/guide/en/elasticsearch/reference/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

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

@@ -4,7 +4,7 @@ module Elasticsearch
       module MachineLearning
         module Actions
 
-          # TODO: Description
+          # Start a datafeed
           #
           # @option arguments [String] :datafeed_id The ID of the datafeed to start (*Required*)
           # @option arguments [Hash] :body The start datafeed parameters
@@ -12,14 +12,16 @@ module Elasticsearch
           # @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
+          # @see http://www.elastic.co/guide/en/elasticsearch/reference/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

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

@@ -4,17 +4,19 @@ module Elasticsearch
       module MachineLearning
         module Actions
 
-          # TODO: Description
+          # Stop a datafeed
           #
           # @option arguments [String] :datafeed_id The ID of the datafeed to stop (*Required*)
+          # @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 [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
+          # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-stop-datafeed.html
           #
           def stop_datafeed(arguments={})
             raise ArgumentError, "Required argument 'datafeed_id' missing" unless arguments[:datafeed_id]
             valid_params = [
+              :allow_no_datafeeds,
               :force,
               :timeout ]
             method = Elasticsearch::API::HTTP_POST

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

@@ -4,16 +4,17 @@ module Elasticsearch
       module MachineLearning
         module Actions
 
-          # TODO: Description
+          # Update certain properties of a datafeed
           #
           # @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
+          # @see http://www.elastic.co/guide/en/elasticsearch/reference/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 = {}

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

@@ -4,12 +4,12 @@ module Elasticsearch
       module MachineLearning
         module Actions
 
-          # TODO: Description
+          # Update certain properties of a job
           #
           # @option arguments [String] :job_id The ID of the job to create (*Required*)
           # @option arguments [Hash] :body The job update settings (*Required*)
           #
-          # @see http://www.elastic.co/guide/en/x-pack/current/ml-update-job.html
+          # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-update-job.html
           #
           def update_job(arguments={})
             raise ArgumentError, "Required argument 'job_id' missing" unless arguments[:job_id]

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

@@ -4,18 +4,19 @@ module Elasticsearch
       module MachineLearning
         module Actions
 
-          # TODO: Description
+          # Update certain properties of a snapshot
           #
           # @option arguments [String] :job_id The ID of the job to fetch (*Required*)
           # @option arguments [String] :snapshot_id The ID of the snapshot to update (*Required*)
           # @option arguments [Hash] :body The model snapshot properties to update (*Required*)
           #
-          # @see http://www.elastic.co/guide/en/x-pack/current/ml-update-snapshot.html
+          # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-update-snapshot.html
           #
           def update_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]
             raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
+
             method = Elasticsearch::API::HTTP_POST
             path   = "_xpack/ml/anomaly_detectors/#{arguments[:job_id]}/model_snapshots/#{arguments[:snapshot_id]}/_update"
             params = {}

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

@@ -4,14 +4,11 @@ module Elasticsearch
       module MachineLearning
         module Actions
 
-          # TODO: Description
-          #
           # @option arguments [Hash] :body The job config (*Required*)
           #
-          # @see http://www.elastic.co/guide/en/x-pack/current/ml-valid-job.html
-          #
           def validate(arguments={})
             raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
+
             method = Elasticsearch::API::HTTP_POST
             path   = "_xpack/ml/anomaly_detectors/_validate"
             params = {}