Skip to content

Commit ba3de35

Browse files
benwtrentbenwtrent
committed
HLRC: Adding ML Update Filter API (#35522)
* HLRC: Adding ml get filters api * HLRC: Adding ML Update Filter API
1 parent d92c9a0 commit ba3de35

File tree

9 files changed

+440
-0
lines changed

9 files changed

+440
-0
lines changed

‎client/rest-high-level/src/main/java/org/elasticsearch/client/MLRequestConverters.java‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,7 @@
5656
import org.elasticsearch.client.ml.StartDatafeedRequest;
5757
import org.elasticsearch.client.ml.StopDatafeedRequest;
5858
import org.elasticsearch.client.ml.UpdateDatafeedRequest;
59+
import org.elasticsearch.client.ml.UpdateFilterRequest;
5960
import org.elasticsearch.client.ml.UpdateJobRequest;
6061
import org.elasticsearch.client.ml.job.util.PageParams;
6162
import org.elasticsearch.common.Strings;
@@ -510,4 +511,17 @@ static Request getFilter(GetFiltersRequest getFiltersRequest) {
510511
}
511512
return request;
512513
}
514+
515+
static Request updateFilter(UpdateFilterRequest updateFilterRequest) throws IOException {
516+
String endpoint = new EndpointBuilder()
517+
.addPathPartAsIs("_xpack")
518+
.addPathPartAsIs("ml")
519+
.addPathPartAsIs("filters")
520+
.addPathPart(updateFilterRequest.getFilterId())
521+
.addPathPartAsIs("_update")
522+
.build();
523+
Request request = new Request(HttpPost.METHOD_NAME, endpoint);
524+
request.setEntity(createEntity(updateFilterRequest, REQUEST_BODY_CONTENT_TYPE));
525+
return request;
526+
}
513527
}

‎client/rest-high-level/src/main/java/org/elasticsearch/client/MachineLearningClient.java‎

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -74,6 +74,7 @@
7474
import org.elasticsearch.client.ml.StopDatafeedRequest;
7575
import org.elasticsearch.client.ml.StopDatafeedResponse;
7676
import org.elasticsearch.client.ml.UpdateDatafeedRequest;
77+
import org.elasticsearch.client.ml.UpdateFilterRequest;
7778
import org.elasticsearch.client.ml.UpdateJobRequest;
7879
import org.elasticsearch.client.ml.job.stats.JobStats;
7980

@@ -1288,4 +1289,44 @@ public void getFilterAsync(GetFiltersRequest request, RequestOptions options, Ac
12881289
listener,
12891290
Collections.emptySet());
12901291
}
1292+
1293+
/**
1294+
* Updates a Machine Learning Filter
1295+
* <p>
1296+
* For additional info
1297+
* see <a href="https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-update-filter.html">
1298+
* ML Update Filter documentation</a>
1299+
*
1300+
* @param request The request
1301+
* @param options Additional request options (e.g. headers), use {@link RequestOptions#DEFAULT} if nothing needs to be customized
1302+
* @return PutFilterResponse with the updated {@link org.elasticsearch.client.ml.job.config.MlFilter} object
1303+
* @throws IOException when there is a serialization issue sending the request or receiving the response
1304+
*/
1305+
public PutFilterResponse updateFilter(UpdateFilterRequest request, RequestOptions options) throws IOException {
1306+
return restHighLevelClient.performRequestAndParseEntity(request,
1307+
MLRequestConverters::updateFilter,
1308+
options,
1309+
PutFilterResponse::fromXContent,
1310+
Collections.emptySet());
1311+
}
1312+
1313+
/**
1314+
* Updates a Machine Learning Filter asynchronously and notifies listener on completion
1315+
* <p>
1316+
* For additional info
1317+
* see <a href="https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-update-filter.html">
1318+
* ML Update Filter documentation</a>
1319+
*
1320+
* @param request The request
1321+
* @param options Additional request options (e.g. headers), use {@link RequestOptions#DEFAULT} if nothing needs to be customized
1322+
* @param listener Listener to be notified upon request completion
1323+
*/
1324+
public void updateFilterAsync(UpdateFilterRequest request, RequestOptions options, ActionListener<PutFilterResponse> listener) {
1325+
restHighLevelClient.performRequestAsyncAndParseEntity(request,
1326+
MLRequestConverters::updateFilter,
1327+
options,
1328+
PutFilterResponse::fromXContent,
1329+
listener,
1330+
Collections.emptySet());
1331+
}
12911332
}

‎client/rest-high-level/src/main/java/org/elasticsearch/client/ml/UpdateFilterRequest.java‎

Lines changed: 156 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,156 @@
1+
/*
2+
* Licensed to Elasticsearch under one or more contributor
3+
* license agreements. See the NOTICE file distributed with
4+
* this work for additional information regarding copyright
5+
* ownership. Elasticsearch licenses this file to you under
6+
* the Apache License, Version 2.0 (the "License"); you may
7+
* not use this file except in compliance with the License.
8+
* You may obtain a copy of the License at
9+
*
10+
* http://www.apache.org/licenses/LICENSE-2.0
11+
*
12+
* Unless required by applicable law or agreed to in writing,
13+
* software distributed under the License is distributed on an
14+
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15+
* KIND, either express or implied. See the License for the
16+
* specific language governing permissions and limitations
17+
* under the License.
18+
*/
19+
package org.elasticsearch.client.ml;
20+
21+
import org.elasticsearch.action.ActionRequest;
22+
import org.elasticsearch.action.ActionRequestValidationException;
23+
import org.elasticsearch.client.ml.job.config.MlFilter;
24+
import org.elasticsearch.common.ParseField;
25+
import org.elasticsearch.common.Strings;
26+
import org.elasticsearch.common.xcontent.ConstructingObjectParser;
27+
import org.elasticsearch.common.xcontent.ToXContentObject;
28+
import org.elasticsearch.common.xcontent.XContentBuilder;
29+
30+
import java.io.IOException;
31+
import java.util.Collection;
32+
import java.util.Objects;
33+
import java.util.SortedSet;
34+
import java.util.TreeSet;
35+
36+
/**
37+
* Updates an existing {@link MlFilter} configuration
38+
*/
39+
public class UpdateFilterRequest extends ActionRequest implements ToXContentObject {
40+
41+
public static final ParseField ADD_ITEMS = new ParseField("add_items");
42+
public static final ParseField REMOVE_ITEMS = new ParseField("remove_items");
43+
44+
public static final ConstructingObjectParser<UpdateFilterRequest, Void> PARSER =
45+
new ConstructingObjectParser<>("update_filter_request", (a) -> new UpdateFilterRequest((String)a[0]));
46+
47+
static {
48+
PARSER.declareString(ConstructingObjectParser.constructorArg(), MlFilter.ID);
49+
PARSER.declareStringOrNull(UpdateFilterRequest::setDescription, MlFilter.DESCRIPTION);
50+
PARSER.declareStringArray(UpdateFilterRequest::setAddItems, ADD_ITEMS);
51+
PARSER.declareStringArray(UpdateFilterRequest::setRemoveItems, REMOVE_ITEMS);
52+
}
53+
54+
private String filterId;
55+
private String description;
56+
private SortedSet<String> addItems;
57+
private SortedSet<String> removeItems;
58+
59+
/**
60+
* Construct a new request referencing a non-null, existing filter_id
61+
* @param filterId Id referencing the filter to update
62+
*/
63+
public UpdateFilterRequest(String filterId) {
64+
this.filterId = Objects.requireNonNull(filterId, "[" + MlFilter.ID.getPreferredName() + "] must not be null");
65+
}
66+
67+
public String getFilterId() {
68+
return filterId;
69+
}
70+
71+
public String getDescription() {
72+
return description;
73+
}
74+
75+
/**
76+
* The new description of the filter
77+
* @param description the updated filter description
78+
*/
79+
public void setDescription(String description) {
80+
this.description = description;
81+
}
82+
83+
public SortedSet<String> getAddItems() {
84+
return addItems;
85+
}
86+
87+
/**
88+
* The collection of items to add to the filter
89+
* @param addItems non-null items to add to the filter, defaults to empty array
90+
*/
91+
public void setAddItems(Collection<String> addItems) {
92+
this.addItems = new TreeSet<>(Objects.requireNonNull(addItems,
93+
"[" + ADD_ITEMS.getPreferredName()+"] must not be null"));
94+
}
95+
96+
public SortedSet<String> getRemoveItems() {
97+
return removeItems;
98+
}
99+
100+
/**
101+
* The collection of items to remove from the filter
102+
* @param removeItems non-null items to remove from the filter, defaults to empty array
103+
*/
104+
public void setRemoveItems(Collection<String> removeItems) {
105+
this.removeItems = new TreeSet<>(Objects.requireNonNull(removeItems,
106+
"[" + REMOVE_ITEMS.getPreferredName()+"] must not be null"));
107+
}
108+
109+
@Override
110+
public XContentBuilder toXContent(XContentBuilder builder, Params params) throws IOException {
111+
builder.startObject();
112+
builder.field(MlFilter.ID.getPreferredName(), filterId);
113+
if (description != null) {
114+
builder.field(MlFilter.DESCRIPTION.getPreferredName(), description);
115+
}
116+
if (addItems != null) {
117+
builder.field(ADD_ITEMS.getPreferredName(), addItems);
118+
}
119+
if (removeItems != null) {
120+
builder.field(REMOVE_ITEMS.getPreferredName(), removeItems);
121+
}
122+
builder.endObject();
123+
return builder;
124+
}
125+
126+
@Override
127+
public int hashCode() {
128+
return Objects.hash(filterId, description, addItems, removeItems);
129+
}
130+
131+
@Override
132+
public boolean equals(Object obj) {
133+
if (obj == this) {
134+
return true;
135+
}
136+
if (obj == null || getClass() != obj.getClass()) {
137+
return false;
138+
}
139+
140+
UpdateFilterRequest other = (UpdateFilterRequest) obj;
141+
return Objects.equals(filterId, other.filterId)
142+
&& Objects.equals(description, other.description)
143+
&& Objects.equals(addItems, other.addItems)
144+
&& Objects.equals(removeItems, other.removeItems);
145+
}
146+
147+
@Override
148+
public final String toString() {
149+
return Strings.toString(this);
150+
}
151+
152+
@Override
153+
public ActionRequestValidationException validate() {
154+
return null;
155+
}
156+
}

‎client/rest-high-level/src/test/java/org/elasticsearch/client/MLRequestConvertersTests.java‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,7 @@
5252
import org.elasticsearch.client.ml.StartDatafeedRequest;
5353
import org.elasticsearch.client.ml.StartDatafeedRequestTests;
5454
import org.elasticsearch.client.ml.StopDatafeedRequest;
55+
import org.elasticsearch.client.ml.UpdateFilterRequest;
5556
import org.elasticsearch.client.ml.UpdateJobRequest;
5657
import org.elasticsearch.client.ml.calendars.Calendar;
5758
import org.elasticsearch.client.ml.calendars.CalendarTests;
@@ -74,6 +75,7 @@
7475

7576
import java.io.ByteArrayOutputStream;
7677
import java.io.IOException;
78+
import java.util.Arrays;
7779
import java.util.Collections;
7880
import java.util.HashMap;
7981
import java.util.Map;
@@ -566,6 +568,23 @@ public void testGetFilter() throws IOException {
566568
assertThat(request.getParameters().get(PageParams.SIZE.getPreferredName()), equalTo("10"));
567569
}
568570

571+
public void testUpdateFilter() throws IOException {
572+
String filterId = randomAlphaOfLength(10);
573+
UpdateFilterRequest updateFilterRequest = new UpdateFilterRequest(filterId);
574+
updateFilterRequest.setDescription(randomAlphaOfLength(10));
575+
updateFilterRequest.setRemoveItems(Arrays.asList("item1", "item2"));
576+
updateFilterRequest.setAddItems(Arrays.asList("item3", "item5"));
577+
578+
Request request = MLRequestConverters.updateFilter(updateFilterRequest);
579+
580+
assertEquals(HttpPost.METHOD_NAME, request.getMethod());
581+
assertThat(request.getEndpoint(), equalTo("/_xpack/ml/filters/"+filterId+"/_update"));
582+
try (XContentParser parser = createParser(JsonXContent.jsonXContent, request.getEntity().getContent())) {
583+
UpdateFilterRequest parsedFilterRequest = UpdateFilterRequest.PARSER.apply(parser, null);
584+
assertThat(parsedFilterRequest, equalTo(updateFilterRequest));
585+
}
586+
}
587+
569588
private static Job createValidJob(String jobId) {
570589
AnalysisConfig.Builder analysisConfig = AnalysisConfig.builder(Collections.singletonList(
571590
Detector.builder().setFunction("count").build()));

‎client/rest-high-level/src/test/java/org/elasticsearch/client/MachineLearningIT.java‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,7 @@
6969
import org.elasticsearch.client.ml.StopDatafeedRequest;
7070
import org.elasticsearch.client.ml.StopDatafeedResponse;
7171
import org.elasticsearch.client.ml.UpdateDatafeedRequest;
72+
import org.elasticsearch.client.ml.UpdateFilterRequest;
7273
import org.elasticsearch.client.ml.UpdateJobRequest;
7374
import org.elasticsearch.client.ml.calendars.Calendar;
7475
import org.elasticsearch.client.ml.calendars.CalendarTests;
@@ -101,6 +102,7 @@
101102

102103
import static org.hamcrest.CoreMatchers.equalTo;
103104
import static org.hamcrest.CoreMatchers.hasItems;
105+
import static org.hamcrest.Matchers.contains;
104106
import static org.hamcrest.Matchers.containsInAnyOrder;
105107
import static org.hamcrest.Matchers.hasSize;
106108
import static org.hamcrest.Matchers.is;
@@ -927,6 +929,28 @@ public void testGetFilters() throws Exception {
927929
}
928930
}
929931

932+
public void testUpdateFilter() throws Exception {
933+
String filterId = "update-filter-test";
934+
MlFilter mlFilter = MlFilter.builder(filterId)
935+
.setDescription("old description")
936+
.setItems(Arrays.asList("olditem1", "olditem2"))
937+
.build();
938+
MachineLearningClient machineLearningClient = highLevelClient().machineLearning();
939+
machineLearningClient.putFilter(new PutFilterRequest(mlFilter), RequestOptions.DEFAULT);
940+
941+
UpdateFilterRequest updateFilterRequest = new UpdateFilterRequest(filterId);
942+
943+
updateFilterRequest.setAddItems(Arrays.asList("newItem1", "newItem2"));
944+
updateFilterRequest.setRemoveItems(Collections.singletonList("olditem1"));
945+
updateFilterRequest.setDescription("new description");
946+
MlFilter filter = execute(updateFilterRequest,
947+
machineLearningClient::updateFilter,
948+
machineLearningClient::updateFilterAsync).getResponse();
949+
950+
assertThat(filter.getDescription(), equalTo(updateFilterRequest.getDescription()));
951+
assertThat(filter.getItems(), contains("newItem1", "newItem2", "olditem2"));
952+
}
953+
930954
public static String randomValidJobId() {
931955
CodepointSetGenerator generator = new CodepointSetGenerator("abcdefghijklmnopqrstuvwxyz0123456789".toCharArray());
932956
return generator.ofCodePointsLength(random(), 10, 10);

‎client/rest-high-level/src/test/java/org/elasticsearch/client/documentation/MlClientDocumentationIT.java‎

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -87,6 +87,7 @@
8787
import org.elasticsearch.client.ml.StopDatafeedRequest;
8888
import org.elasticsearch.client.ml.StopDatafeedResponse;
8989
import org.elasticsearch.client.ml.UpdateDatafeedRequest;
90+
import org.elasticsearch.client.ml.UpdateFilterRequest;
9091
import org.elasticsearch.client.ml.UpdateJobRequest;
9192
import org.elasticsearch.client.ml.calendars.Calendar;
9293
import org.elasticsearch.client.ml.datafeed.ChunkingConfig;
@@ -2229,4 +2230,66 @@ public void onFailure(Exception e) {
22292230
assertTrue(latch.await(30L, TimeUnit.SECONDS));
22302231
}
22312232
}
2233+
2234+
public void testUpdateFilter() throws IOException, InterruptedException {
2235+
RestHighLevelClient client = highLevelClient();
2236+
String filterId = "update-filter-doc-test";
2237+
MlFilter.Builder filterBuilder = MlFilter.builder(filterId).setDescription("test").setItems("*.google.com", "wikipedia.org");
2238+
2239+
client.machineLearning().putFilter(new PutFilterRequest(filterBuilder.build()), RequestOptions.DEFAULT);
2240+
2241+
{
2242+
// tag::update-filter-request
2243+
UpdateFilterRequest request = new UpdateFilterRequest(filterId); // <1>
2244+
// end::update-filter-request
2245+
2246+
// tag::update-filter-description
2247+
request.setDescription("my new description"); // <1>
2248+
// end::update-filter-description
2249+
2250+
// tag::update-filter-add-items
2251+
request.setAddItems(Arrays.asList("*.bing.com", "*.elastic.co")); // <1>
2252+
// end::update-filter-add-items
2253+
2254+
// tag::update-filter-remove-items
2255+
request.setRemoveItems(Arrays.asList("*.google.com")); // <1>
2256+
// end::update-filter-remove-items
2257+
2258+
// tag::update-filter-execute
2259+
PutFilterResponse response = client.machineLearning().updateFilter(request, RequestOptions.DEFAULT);
2260+
// end::update-filter-execute
2261+
2262+
// tag::update-filter-response
2263+
MlFilter updatedFilter = response.getResponse(); // <1>
2264+
// end::update-filter-response
2265+
assertEquals(request.getDescription(), updatedFilter.getDescription());
2266+
}
2267+
{
2268+
UpdateFilterRequest request = new UpdateFilterRequest(filterId);
2269+
2270+
// tag::update-filter-execute-listener
2271+
ActionListener<PutFilterResponse> listener = new ActionListener<PutFilterResponse>() {
2272+
@Override
2273+
public void onResponse(PutFilterResponse putFilterResponse) {
2274+
// <1>
2275+
}
2276+
2277+
@Override
2278+
public void onFailure(Exception e) {
2279+
// <2>
2280+
}
2281+
};
2282+
// end::update-filter-execute-listener
2283+
2284+
// Replace the empty listener by a blocking listener in test
2285+
final CountDownLatch latch = new CountDownLatch(1);
2286+
listener = new LatchedActionListener<>(listener, latch);
2287+
2288+
// tag::update-filter-execute-async
2289+
client.machineLearning().updateFilterAsync(request, RequestOptions.DEFAULT, listener); // <1>
2290+
// end::update-filter-execute-async
2291+
2292+
assertTrue(latch.await(30L, TimeUnit.SECONDS));
2293+
}
2294+
}
22322295
}

0 commit comments

Comments
 (0)