Skip to content

Commit 82d2ea1

Browse files
committed
[XPACK] Adds ml.update_data_frame_analytics endpoint
1 parent c623cac commit 82d2ea1

File tree

2 files changed

+94
-0
lines changed

2 files changed

+94
-0
lines changed
Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
# Licensed to Elasticsearch B.V. under one or more contributor
2+
# license agreements. See the NOTICE file distributed with
3+
# this work for additional information regarding copyright
4+
# ownership. Elasticsearch B.V. licenses this file to you under
5+
# the Apache License, Version 2.0 (the "License"); you may
6+
# not use this file except in compliance with the License.
7+
# You may obtain a copy of the License at
8+
#
9+
# http://www.apache.org/licenses/LICENSE-2.0
10+
#
11+
# Unless required by applicable law or agreed to in writing,
12+
# software distributed under the License is distributed on an
13+
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
14+
# KIND, either express or implied. See the License for the
15+
# specific language governing permissions and limitations
16+
# under the License.
17+
18+
module Elasticsearch
19+
module XPack
20+
module API
21+
module MachineLearning
22+
module Actions
23+
# Updates certain properties of a data frame analytics job.
24+
#
25+
# @option arguments [String] :id The ID of the data frame analytics to update
26+
# @option arguments [Hash] :headers Custom HTTP headers
27+
# @option arguments [Hash] :body The data frame analytics settings to update (*Required*)
28+
#
29+
# @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/update-dfanalytics.html
30+
#
31+
def update_data_frame_analytics(arguments = {})
32+
raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
33+
raise ArgumentError, "Required argument 'id' missing" unless arguments[:id]
34+
35+
headers = arguments.delete(:headers) || {}
36+
37+
arguments = arguments.clone
38+
39+
_id = arguments.delete(:id)
40+
41+
method = Elasticsearch::API::HTTP_POST
42+
path = "_ml/data_frame/analytics/#{Elasticsearch::API::Utils.__listify(_id)}/_update"
43+
params = {}
44+
45+
body = arguments[:body]
46+
perform_request(method, path, params, body, headers).body
47+
end
48+
end
49+
end
50+
end
51+
end
52+
end
Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
# Licensed to Elasticsearch B.V. under one or more contributor
2+
# license agreements. See the NOTICE file distributed with
3+
# this work for additional information regarding copyright
4+
# ownership. Elasticsearch B.V. licenses this file to you under
5+
# the Apache License, Version 2.0 (the "License"); you may
6+
# not use this file except in compliance with the License.
7+
# You may obtain a copy of the License at
8+
#
9+
# http://www.apache.org/licenses/LICENSE-2.0
10+
#
11+
# Unless required by applicable law or agreed to in writing,
12+
# software distributed under the License is distributed on an
13+
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
14+
# KIND, either express or implied. See the License for the
15+
# specific language governing permissions and limitations
16+
# under the License.
17+
18+
require 'test_helper'
19+
20+
module Elasticsearch
21+
module Test
22+
class XPackMlUpdateDataFrameAnalyticsTest < Minitest::Test
23+
context "XPack MachineLearning: Update data frame analytics" do
24+
subject { FakeClient.new }
25+
26+
should "perform correct request" do
27+
subject.expects(:perform_request).with do |method, url, params, body|
28+
assert_equal 'POST', method
29+
assert_equal "_ml/data_frame/analytics/foo/_update", url
30+
assert_equal Hash.new, params
31+
assert_equal Hash.new, body
32+
true
33+
end.returns(FakeResponse.new)
34+
35+
subject.xpack.ml.update_data_frame_analytics id: 'foo', body: {}
36+
end
37+
38+
end
39+
40+
end
41+
end
42+
end

0 commit comments

Comments
 (0)