-
Notifications
You must be signed in to change notification settings - Fork 24.7k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
HLRC: ML Add preview datafeed api (#34284)
* HLRC: ML Add preview datafeed api * Changing deprecation handling for parser * Removing some duplication in docs, will address other APIs in another PR
- Loading branch information
Showing
11 changed files
with
600 additions
and
24 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
100 changes: 100 additions & 0 deletions
100
client/rest-high-level/src/main/java/org/elasticsearch/client/ml/PreviewDatafeedRequest.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,100 @@ | ||
| /* | ||
| * Licensed to Elasticsearch under one or more contributor | ||
| * license agreements. See the NOTICE file distributed with | ||
| * this work for additional information regarding copyright | ||
| * ownership. Elasticsearch licenses this file to you under | ||
| * the Apache License, Version 2.0 (the "License"); you may | ||
| * not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, | ||
| * software distributed under the License is distributed on an | ||
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
| * KIND, either express or implied. See the License for the | ||
| * specific language governing permissions and limitations | ||
| * under the License. | ||
| */ | ||
| package org.elasticsearch.client.ml; | ||
|
|
||
| import org.elasticsearch.action.ActionRequest; | ||
| import org.elasticsearch.action.ActionRequestValidationException; | ||
| import org.elasticsearch.client.ml.datafeed.DatafeedConfig; | ||
| import org.elasticsearch.common.Strings; | ||
| import org.elasticsearch.common.xcontent.ConstructingObjectParser; | ||
| import org.elasticsearch.common.xcontent.ToXContentObject; | ||
| import org.elasticsearch.common.xcontent.XContentBuilder; | ||
| import org.elasticsearch.common.xcontent.XContentParser; | ||
|
|
||
| import java.io.IOException; | ||
| import java.util.Objects; | ||
|
|
||
| /** | ||
| * Request to preview a MachineLearning Datafeed | ||
| */ | ||
| public class PreviewDatafeedRequest extends ActionRequest implements ToXContentObject { | ||
|
|
||
| public static final ConstructingObjectParser<PreviewDatafeedRequest, Void> PARSER = new ConstructingObjectParser<>( | ||
| "open_datafeed_request", true, a -> new PreviewDatafeedRequest((String) a[0])); | ||
|
|
||
| static { | ||
| PARSER.declareString(ConstructingObjectParser.constructorArg(), DatafeedConfig.ID); | ||
| } | ||
|
|
||
| public static PreviewDatafeedRequest fromXContent(XContentParser parser) throws IOException { | ||
| return PARSER.parse(parser, null); | ||
| } | ||
|
|
||
| private final String datafeedId; | ||
|
|
||
| /** | ||
| * Create a new request with the desired datafeedId | ||
| * | ||
| * @param datafeedId unique datafeedId, must not be null | ||
| */ | ||
| public PreviewDatafeedRequest(String datafeedId) { | ||
| this.datafeedId = Objects.requireNonNull(datafeedId, "[datafeed_id] must not be null"); | ||
| } | ||
|
|
||
| public String getDatafeedId() { | ||
| return datafeedId; | ||
| } | ||
|
|
||
| @Override | ||
| public ActionRequestValidationException validate() { | ||
| return null; | ||
| } | ||
|
|
||
| @Override | ||
| public XContentBuilder toXContent(XContentBuilder builder, Params params) throws IOException { | ||
| builder.startObject(); | ||
| builder.field(DatafeedConfig.ID.getPreferredName(), datafeedId); | ||
| builder.endObject(); | ||
| return builder; | ||
| } | ||
|
|
||
| @Override | ||
| public String toString() { | ||
| return Strings.toString(this); | ||
| } | ||
|
|
||
| @Override | ||
| public int hashCode() { | ||
| return Objects.hash(datafeedId); | ||
| } | ||
|
|
||
| @Override | ||
| public boolean equals(Object other) { | ||
| if (this == other) { | ||
| return true; | ||
| } | ||
|
|
||
| if (other == null || getClass() != other.getClass()) { | ||
| return false; | ||
| } | ||
|
|
||
| PreviewDatafeedRequest that = (PreviewDatafeedRequest) other; | ||
| return Objects.equals(datafeedId, that.datafeedId); | ||
| } | ||
| } |
113 changes: 113 additions & 0 deletions
113
...nt/rest-high-level/src/main/java/org/elasticsearch/client/ml/PreviewDatafeedResponse.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,113 @@ | ||
| /* | ||
| * Licensed to Elasticsearch under one or more contributor | ||
| * license agreements. See the NOTICE file distributed with | ||
| * this work for additional information regarding copyright | ||
| * ownership. Elasticsearch licenses this file to you under | ||
| * the Apache License, Version 2.0 (the "License"); you may | ||
| * not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, | ||
| * software distributed under the License is distributed on an | ||
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
| * KIND, either express or implied. See the License for the | ||
| * specific language governing permissions and limitations | ||
| * under the License. | ||
| */ | ||
| package org.elasticsearch.client.ml; | ||
|
|
||
| import org.elasticsearch.action.ActionResponse; | ||
| import org.elasticsearch.common.Strings; | ||
| import org.elasticsearch.common.bytes.BytesReference; | ||
| import org.elasticsearch.common.io.stream.StreamInput; | ||
| import org.elasticsearch.common.xcontent.DeprecationHandler; | ||
| import org.elasticsearch.common.xcontent.NamedXContentRegistry; | ||
| import org.elasticsearch.common.xcontent.ToXContentObject; | ||
| import org.elasticsearch.common.xcontent.XContentBuilder; | ||
| import org.elasticsearch.common.xcontent.XContentFactory; | ||
| import org.elasticsearch.common.xcontent.XContentParser; | ||
| import org.elasticsearch.common.xcontent.XContentType; | ||
|
|
||
| import java.io.IOException; | ||
| import java.io.InputStream; | ||
| import java.util.Collections; | ||
| import java.util.List; | ||
| import java.util.Map; | ||
| import java.util.Objects; | ||
| import java.util.stream.Collectors; | ||
|
|
||
| /** | ||
| * Response containing a datafeed preview in JSON format | ||
| */ | ||
| public class PreviewDatafeedResponse extends ActionResponse implements ToXContentObject { | ||
|
|
||
| private BytesReference preview; | ||
|
|
||
| public static PreviewDatafeedResponse fromXContent(XContentParser parser) throws IOException { | ||
| try (XContentBuilder builder = XContentFactory.jsonBuilder()) { | ||
| parser.nextToken(); | ||
| builder.copyCurrentStructure(parser); | ||
| return new PreviewDatafeedResponse(BytesReference.bytes(builder)); | ||
| } | ||
| } | ||
|
|
||
| public PreviewDatafeedResponse(BytesReference preview) { | ||
| this.preview = preview; | ||
| } | ||
|
|
||
| public BytesReference getPreview() { | ||
| return preview; | ||
| } | ||
|
|
||
| /** | ||
| * Parses the preview to a list of {@link Map} objects | ||
| * @return List of previewed data | ||
| * @throws IOException If there is a parsing issue with the {@link BytesReference} | ||
| * @throws java.lang.ClassCastException If casting the raw {@link Object} entries to a {@link Map} fails | ||
| */ | ||
| @SuppressWarnings("unchecked") | ||
| public List<Map<String, Object>> getDataList() throws IOException { | ||
| try(StreamInput streamInput = preview.streamInput(); | ||
| XContentParser parser = XContentType.JSON.xContent() | ||
| .createParser(NamedXContentRegistry.EMPTY, DeprecationHandler.THROW_UNSUPPORTED_OPERATION, streamInput)) { | ||
| XContentParser.Token token = parser.nextToken(); | ||
| if (token == XContentParser.Token.START_ARRAY) { | ||
| return parser.listOrderedMap().stream().map(obj -> (Map<String, Object>)obj).collect(Collectors.toList()); | ||
| } else { | ||
| return Collections.singletonList(parser.mapOrdered()); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| @Override | ||
| public XContentBuilder toXContent(XContentBuilder builder, Params params) throws IOException { | ||
| try (InputStream stream = preview.streamInput()) { | ||
| builder.rawValue(stream, XContentType.JSON); | ||
| } | ||
| return builder; | ||
| } | ||
|
|
||
| @Override | ||
| public int hashCode() { | ||
| return Objects.hash(preview); | ||
| } | ||
|
|
||
| @Override | ||
| public boolean equals(Object obj) { | ||
| if (obj == null) { | ||
| return false; | ||
| } | ||
| if (getClass() != obj.getClass()) { | ||
| return false; | ||
| } | ||
| PreviewDatafeedResponse other = (PreviewDatafeedResponse) obj; | ||
| return Objects.equals(preview, other.preview); | ||
| } | ||
|
|
||
| @Override | ||
| public final String toString() { | ||
| return Strings.toString(this); | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.