elasticsearch-xpack 5.0.0 → 5.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0afd2c0eab78339bb2f6450ba069722868ad7798
-  data.tar.gz: 6658e1652f08645cd154f7fbfd27f24bc1f3e8d3
+  metadata.gz: 07db460f6169c230788a8065924cf9bfabf75ded
+  data.tar.gz: 99035150cc2c228c4456e23273dbf5a55b5c24ba
 SHA512:
-  metadata.gz: fab2369f74f72cdb096a40533b4522e4f6b30391d6a03d0f10750bbc47c16a78c2858d944e25725dfaadaf68e3bd7e713a81fbeeb6144f4af6b5b7098d493d8c
-  data.tar.gz: 681fad54b21fb163f4db599d765cf973a12b2482d106ae9617a3e87c4324af33827cf4ea41bab6fcd5743711c6db520af5a5791efdeb33421bcbbacd47f330b6
+  metadata.gz: 2b352de12499a84034a704a66a78ca5022a604bc231eb5c5a1b113d41ec9accc1234c0b492722e428628955d6a34b3a89e487b010cee6cd1c44f9eeeb116a6a9
+  data.tar.gz: 976c0a21635d66387285944afca22dfd3f062e1cfc835ed3fdc78e6be2aee46138fc1771d84bea99c8d30a2a8c13ab01b782dabe917ecf4a92fda3a04b0410ab

data/elasticsearch-xpack.gemspec

@@ -23,8 +23,8 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency "elasticsearch-api"
 
-  spec.add_development_dependency "elasticsearch"
-  spec.add_development_dependency "elasticsearch-transport"
+  spec.add_development_dependency "elasticsearch", '~> 5'
+  spec.add_development_dependency "elasticsearch-transport", '~> 5'
   spec.add_development_dependency "elasticsearch-extensions"
 
   spec.add_development_dependency "activesupport"

data/lib/elasticsearch/xpack.rb

@@ -21,6 +21,8 @@ module Elasticsearch
   end
 end
 
+Elasticsearch::API::COMMON_PARAMS.push :job_id, :datafeed_id, :filter_id, :snapshot_id, :category_id
+
 module Elasticsearch
   module Transport
     class Client

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

@@ -0,0 +1,31 @@
+module Elasticsearch
+  module XPack
+    module API
+      module MachineLearning
+        module Actions
+
+          # TODO: Description
+          #
+          # @option arguments [String] :job_id The name of the job to close (*Required*)
+          # @option arguments [Boolean] :force True if the job should be forcefully closed
+          # @option arguments [Time] :timeout Controls the time to wait until a job has closed. Default to 30 minutes
+          #
+          # @see http://www.elastic.co/guide/en/x-pack/current/ml-close-job.html
+          #
+          def close_job(arguments={})
+            raise ArgumentError, "Required argument 'job_id' missing" unless arguments[:job_id]
+            valid_params = [
+              :force,
+              :timeout ]
+            method = Elasticsearch::API::HTTP_POST
+            path   = "_xpack/ml/anomaly_detectors/#{arguments[:job_id]}/_close"
+            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/delete_datafeed.rb

@@ -0,0 +1,29 @@
+module Elasticsearch
+  module XPack
+    module API
+      module MachineLearning
+        module Actions
+
+          # TODO: Description
+          #
+          # @option arguments [String] :datafeed_id The ID of the datafeed to delete (*Required*)
+          # @option arguments [Boolean] :force True if the datafeed should be forcefully deleted
+          #
+          # @see http://www.elastic.co/guide/en/x-pack/current/ml-delete-datafeed.html
+          #
+          def delete_datafeed(arguments={})
+            raise ArgumentError, "Required argument 'datafeed_id' missing" unless arguments[:datafeed_id]
+            valid_params = [
+              :force ]
+            method = Elasticsearch::API::HTTP_DELETE
+            path   = "_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
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,24 @@
+module Elasticsearch
+  module XPack
+    module API
+      module MachineLearning
+        module Actions
+
+          # TODO: Description
+          #
+          #
+          # @see [TODO]
+          #
+          def delete_expired_data(arguments={})
+            method = Elasticsearch::API::HTTP_DELETE
+            path   = "_xpack/ml/_delete_expired_data"
+            params = {}
+            body   = nil
+
+            perform_request(method, path, params, body).body
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,26 @@
+module Elasticsearch
+  module XPack
+    module API
+      module MachineLearning
+        module Actions
+
+          # TODO: Description
+          #
+          # @option arguments [String] :filter_id The ID of the filter to delete (*Required*)
+          #
+          # @see [TODO]
+          #
+          def delete_filter(arguments={})
+            raise ArgumentError, "Required argument 'filter_id' missing" unless arguments[:filter_id]
+            method = Elasticsearch::API::HTTP_DELETE
+            path   = "_xpack/ml/filters/#{arguments[:filter_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/delete_job.rb

@@ -0,0 +1,29 @@
+module Elasticsearch
+  module XPack
+    module API
+      module MachineLearning
+        module Actions
+
+          # TODO: Description
+          #
+          # @option arguments [String] :job_id The ID of the job to delete (*Required*)
+          # @option arguments [Boolean] :force True if the job should be forcefully deleted
+          #
+          # @see http://www.elastic.co/guide/en/x-pack/current/ml-delete-job.html
+          #
+          def delete_job(arguments={})
+            raise ArgumentError, "Required argument 'job_id' missing" unless arguments[:job_id]
+            valid_params = [
+              :force ]
+            method = Elasticsearch::API::HTTP_DELETE
+            path   = "_xpack/ml/anomaly_detectors/#{arguments[:job_id]}"
+            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/delete_model_snapshot.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 fetch (*Required*)
+          # @option arguments [String] :snapshot_id The ID of the snapshot to delete (*Required*)
+          #
+          # @see http://www.elastic.co/guide/en/x-pack/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]
+            method = Elasticsearch::API::HTTP_DELETE
+            path   = "_xpack/ml/anomaly_detectors/#{arguments[:job_id]}/model_snapshots/#{arguments[:snapshot_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/flush_job.rb

@@ -0,0 +1,36 @@
+module Elasticsearch
+  module XPack
+    module API
+      module MachineLearning
+        module Actions
+
+          # TODO: Description
+          #
+          # @option arguments [String] :job_id The name of the job to flush (*Required*)
+          # @option arguments [Hash] :body Flush parameters
+          # @option arguments [Boolean] :calc_interim Calculates interim results for the most recent bucket or all buckets within the latency period
+          # @option arguments [String] :start When used in conjunction with calc_interim, specifies the range of buckets on which to calculate interim results
+          # @option arguments [String] :end When used in conjunction with calc_interim, specifies the range of buckets on which to calculate interim results
+          # @option arguments [String] :advance_time Setting this tells the Engine API that no data prior to advance_time is expected
+          #
+          # @see http://www.elastic.co/guide/en/x-pack/current/ml-flush-job.html
+          #
+          def flush_job(arguments={})
+            raise ArgumentError, "Required argument 'job_id' missing" unless arguments[:job_id]
+            valid_params = [
+              :calc_interim,
+              :start,
+              :end,
+              :advance_time ]
+            method = Elasticsearch::API::HTTP_POST
+            path   = "_xpack/ml/anomaly_detectors/#{arguments[:job_id]}/_flush"
+            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_buckets.rb

@@ -0,0 +1,48 @@
+module Elasticsearch
+  module XPack
+    module API
+      module MachineLearning
+        module Actions
+
+          # TODO: Description
+          #
+          # @option arguments [String] :job_id ID of the job to get bucket results from (*Required*)
+          # @option arguments [String] :timestamp The timestamp of the desired single bucket result
+          # @option arguments [Hash] :body Bucket selection details if not provided in URI
+          # @option arguments [Boolean] :expand Include anomaly records
+          # @option arguments [Boolean] :exclude_interim Exclude interim results
+          # @option arguments [Int] :from skips a number of buckets
+          # @option arguments [Int] :size specifies a max number of buckets to get
+          # @option arguments [String] :start Start time filter for buckets
+          # @option arguments [String] :end End time filter for buckets
+          # @option arguments [Double] :anomaly_score Filter for the most anomalous buckets
+          # @option arguments [String] :sort Sort buckets by a particular field
+          # @option arguments [Boolean] :desc Set the sort direction
+          #
+          # @see http://www.elastic.co/guide/en/x-pack/current/ml-get-bucket.html
+          #
+          def get_buckets(arguments={})
+            raise ArgumentError, "Required argument 'job_id' missing" unless arguments[:job_id]
+            valid_params = [
+              :timestamp,
+              :expand,
+              :exclude_interim,
+              :from,
+              :size,
+              :start,
+              :end,
+              :anomaly_score,
+              :sort,
+              :desc ]
+            method = Elasticsearch::API::HTTP_GET
+            path   = Elasticsearch::API::Utils.__pathify "_xpack/ml/anomaly_detectors", arguments[:job_id], "results/buckets", arguments[:timestamp]
+            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_categories.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 (*Required*)
+          # @option arguments [Long] :category_id The identifier of the category definition of interest
+          # @option arguments [Hash] :body Category selection details if not provided in URI
+          # @option arguments [Int] :from skips a number of categories
+          # @option arguments [Int] :size specifies a max number of categories to get
+          #
+          # @see http://www.elastic.co/guide/en/x-pack/current/ml-get-category.html
+          #
+          def get_categories(arguments={})
+            raise ArgumentError, "Required argument 'job_id' missing" unless arguments[:job_id]
+            valid_params = [
+              :from,
+              :size ]
+            method = Elasticsearch::API::HTTP_GET
+            path   = Elasticsearch::API::Utils.__pathify "_xpack/ml/anomaly_detectors", arguments[:job_id], "results/categories", arguments[:category_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_datafeed_stats.rb

@@ -0,0 +1,25 @@
+module Elasticsearch
+  module XPack
+    module API
+      module MachineLearning
+        module Actions
+
+          # TODO: Description
+          #
+          # @option arguments [String] :datafeed_id The ID of the datafeeds stats to fetch
+          #
+          # @see http://www.elastic.co/guide/en/x-pack/current/ml-get-datafeed-stats.html
+          #
+          def get_datafeed_stats(arguments={})
+            method = Elasticsearch::API::HTTP_GET
+            path   = Elasticsearch::API::Utils.__pathify "_xpack/ml/datafeeds", arguments[:datafeed_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_datafeeds.rb

@@ -0,0 +1,25 @@
+module Elasticsearch
+  module XPack
+    module API
+      module MachineLearning
+        module Actions
+
+          # TODO: Description
+          #
+          # @option arguments [String] :datafeed_id The ID of the datafeeds to fetch
+          #
+          # @see http://www.elastic.co/guide/en/x-pack/current/ml-get-datafeed.html
+          #
+          def get_datafeeds(arguments={})
+            method = Elasticsearch::API::HTTP_GET
+            path   = "_xpack/ml/datafeeds/#{arguments[:datafeed_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_filters.rb

@@ -0,0 +1,30 @@
+module Elasticsearch
+  module XPack
+    module API
+      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]}"
+            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/get_influencers.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 Influencer selection criteria
+          # @option arguments [Boolean] :exclude_interim Exclude interim results
+          # @option arguments [Int] :from skips a number of influencers
+          # @option arguments [Int] :size specifies a max number of influencers to get
+          # @option arguments [String] :start start timestamp for the requested influencers
+          # @option arguments [String] :end end timestamp for the requested influencers
+          # @option arguments [Double] :influencer_score influencer score threshold for the requested influencers
+          # @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
+          #
+          def get_influencers(arguments={})
+            raise ArgumentError, "Required argument 'job_id' missing" unless arguments[:job_id]
+            valid_params = [
+              :exclude_interim,
+              :from,
+              :size,
+              :start,
+              :end,
+              :influencer_score,
+              :sort,
+              :desc ]
+            method = Elasticsearch::API::HTTP_GET
+            path   = "_xpack/ml/anomaly_detectors/#{arguments[:job_id]}/results/influencers"
+            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