-
Notifications
You must be signed in to change notification settings - Fork 24.3k
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 ML revert model snapshot API (#35750)
Relates to #29827
- Loading branch information
Showing
11 changed files
with
572 additions
and
3 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
120 changes: 120 additions & 0 deletions
120
...rest-high-level/src/main/java/org/elasticsearch/client/ml/RevertModelSnapshotRequest.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,120 @@ | ||
| /* | ||
| * 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.job.config.Job; | ||
| import org.elasticsearch.client.ml.job.process.ModelSnapshot; | ||
| import org.elasticsearch.common.ParseField; | ||
| import org.elasticsearch.common.xcontent.ConstructingObjectParser; | ||
| import org.elasticsearch.common.xcontent.ToXContentObject; | ||
| import org.elasticsearch.common.xcontent.XContentBuilder; | ||
|
|
||
| import java.io.IOException; | ||
| import java.util.Objects; | ||
|
|
||
| /** | ||
| * A request to revert to a specific model snapshot for a given job | ||
| */ | ||
| public class RevertModelSnapshotRequest extends ActionRequest implements ToXContentObject { | ||
|
|
||
|
|
||
| public static final ParseField DELETE_INTERVENING = new ParseField("delete_intervening_results"); | ||
|
|
||
| public static final ConstructingObjectParser<RevertModelSnapshotRequest, Void> PARSER = new ConstructingObjectParser<>( | ||
| "revert_model_snapshots_request", a -> new RevertModelSnapshotRequest((String) a[0], (String) a[1])); | ||
|
|
||
|
|
||
| static { | ||
| PARSER.declareString(ConstructingObjectParser.constructorArg(), Job.ID); | ||
| PARSER.declareString(ConstructingObjectParser.constructorArg(), ModelSnapshot.SNAPSHOT_ID); | ||
| PARSER.declareBoolean(RevertModelSnapshotRequest::setDeleteInterveningResults, DELETE_INTERVENING); | ||
| } | ||
|
|
||
| private final String jobId; | ||
| private final String snapshotId; | ||
| private Boolean deleteInterveningResults; | ||
|
|
||
| /** | ||
| * Constructs a request to revert to a given model snapshot | ||
| * @param jobId id of the job for which to revert the model snapshot | ||
| * @param snapshotId id of the snapshot to which to revert | ||
| */ | ||
| public RevertModelSnapshotRequest(String jobId, String snapshotId) { | ||
| this.jobId = Objects.requireNonNull(jobId, "[" + Job.ID + "] must not be null"); | ||
| this.snapshotId = Objects.requireNonNull(snapshotId, "[" + ModelSnapshot.SNAPSHOT_ID + "] must not be null"); | ||
| } | ||
|
|
||
| public String getJobId() { | ||
| return jobId; | ||
| } | ||
|
|
||
| public String getSnapshotId() { | ||
| return snapshotId; | ||
| } | ||
|
|
||
| public Boolean getDeleteInterveningResults() { | ||
| return deleteInterveningResults; | ||
| } | ||
|
|
||
| /** | ||
| * Sets the request flag that indicates whether or not intervening results should be deleted. | ||
| * @param deleteInterveningResults Flag that indicates whether or not intervening results should be deleted. | ||
| */ | ||
| public void setDeleteInterveningResults(Boolean deleteInterveningResults) { | ||
| this.deleteInterveningResults = deleteInterveningResults; | ||
| } | ||
|
|
||
| @Override | ||
| public ActionRequestValidationException validate() { | ||
| return null; | ||
| } | ||
|
|
||
| @Override | ||
| public XContentBuilder toXContent(XContentBuilder builder, Params params) throws IOException { | ||
| builder.startObject(); | ||
| builder.field(Job.ID.getPreferredName(), jobId); | ||
| builder.field(ModelSnapshot.SNAPSHOT_ID.getPreferredName(), snapshotId); | ||
| if (deleteInterveningResults != null) { | ||
| builder.field(DELETE_INTERVENING.getPreferredName(), deleteInterveningResults); | ||
| } | ||
| builder.endObject(); | ||
| return builder; | ||
| } | ||
|
|
||
| @Override | ||
| public boolean equals(Object obj) { | ||
| if (obj == null) { | ||
| return false; | ||
| } | ||
| if (getClass() != obj.getClass()) { | ||
| return false; | ||
| } | ||
| RevertModelSnapshotRequest request = (RevertModelSnapshotRequest) obj; | ||
| return Objects.equals(jobId, request.jobId) | ||
| && Objects.equals(snapshotId, request.snapshotId) | ||
| && Objects.equals(deleteInterveningResults, request.deleteInterveningResults); | ||
| } | ||
|
|
||
| @Override | ||
| public int hashCode() { | ||
| return Objects.hash(jobId, snapshotId, deleteInterveningResults); | ||
| } | ||
| } |
92 changes: 92 additions & 0 deletions
92
...est-high-level/src/main/java/org/elasticsearch/client/ml/RevertModelSnapshotResponse.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,92 @@ | ||
| /* | ||
| * 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.client.ml.job.process.ModelSnapshot; | ||
| import org.elasticsearch.common.ParseField; | ||
| 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; | ||
|
|
||
| /** | ||
| * A response containing the reverted model snapshot | ||
| */ | ||
| public class RevertModelSnapshotResponse extends ActionResponse implements ToXContentObject { | ||
|
|
||
| private static final ParseField MODEL = new ParseField("model"); | ||
|
|
||
| public static final ConstructingObjectParser<RevertModelSnapshotResponse, Void> PARSER = | ||
| new ConstructingObjectParser<>("revert_model_snapshot_response", true, | ||
| a -> new RevertModelSnapshotResponse((ModelSnapshot.Builder) a[0])); | ||
|
|
||
| static { | ||
| PARSER.declareObject(ConstructingObjectParser.constructorArg(), ModelSnapshot.PARSER, MODEL); | ||
| } | ||
|
|
||
| public static RevertModelSnapshotResponse fromXContent(XContentParser parser) throws IOException { | ||
| return PARSER.parse(parser, null); | ||
| } | ||
|
|
||
| public RevertModelSnapshotResponse(ModelSnapshot.Builder modelSnapshot) { | ||
| this.model = modelSnapshot.build(); | ||
| } | ||
|
|
||
| private final ModelSnapshot model; | ||
|
|
||
| /** | ||
| * Get full information about the reverted model snapshot | ||
| * @return the reverted model snapshot. | ||
| */ | ||
| public ModelSnapshot getModel() { | ||
| return model; | ||
| } | ||
|
|
||
| @Override | ||
| public int hashCode() { | ||
| return Objects.hash(model); | ||
| } | ||
|
|
||
| @Override | ||
| public boolean equals(Object obj) { | ||
| if (obj == null) { | ||
| return false; | ||
| } | ||
| if (getClass() != obj.getClass()) { | ||
| return false; | ||
| } | ||
| RevertModelSnapshotResponse other = (RevertModelSnapshotResponse) obj; | ||
| return Objects.equals(model, other.model); | ||
| } | ||
|
|
||
| @Override | ||
| public XContentBuilder toXContent(XContentBuilder builder, Params params) throws IOException { | ||
| builder.startObject(); | ||
| if (model != null) { | ||
| builder.field(MODEL.getPreferredName(), model); | ||
| } | ||
| builder.endObject(); | ||
| return builder; | ||
| } | ||
| } |
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.