-
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 Delete Forecast API (#33526)
* HLRC: ML Delete Forecast API
- Loading branch information
Showing
9 changed files
with
582 additions
and
0 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
183 changes: 183 additions & 0 deletions
183
client/rest-high-level/src/main/java/org/elasticsearch/client/ml/DeleteForecastRequest.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,183 @@ | ||
| /* | ||
| * 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.common.ParseField; | ||
| import org.elasticsearch.common.Strings; | ||
| import org.elasticsearch.common.unit.TimeValue; | ||
| 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.ArrayList; | ||
| import java.util.Arrays; | ||
| import java.util.List; | ||
| import java.util.Objects; | ||
|
|
||
| /** | ||
| * POJO for a delete forecast request | ||
| */ | ||
| public class DeleteForecastRequest extends ActionRequest implements ToXContentObject { | ||
|
|
||
| public static final ParseField FORECAST_ID = new ParseField("forecast_id"); | ||
| public static final ParseField ALLOW_NO_FORECASTS = new ParseField("allow_no_forecasts"); | ||
| public static final ParseField TIMEOUT = new ParseField("timeout"); | ||
| public static final String ALL = "_all"; | ||
|
|
||
| public static final ConstructingObjectParser<DeleteForecastRequest, Void> PARSER = | ||
| new ConstructingObjectParser<>("delete_forecast_request", (a) -> new DeleteForecastRequest((String) a[0])); | ||
|
|
||
| static { | ||
| PARSER.declareString(ConstructingObjectParser.constructorArg(), Job.ID); | ||
| PARSER.declareStringOrNull( | ||
| (c, p) -> c.setForecastIds(Strings.commaDelimitedListToStringArray(p)), FORECAST_ID); | ||
| PARSER.declareBoolean(DeleteForecastRequest::setAllowNoForecasts, ALLOW_NO_FORECASTS); | ||
| PARSER.declareString(DeleteForecastRequest::timeout, TIMEOUT); | ||
| } | ||
|
|
||
| /** | ||
| * Create a new {@link DeleteForecastRequest} that explicitly deletes all forecasts | ||
| * | ||
| * @param jobId the jobId of the Job whose forecasts to delete | ||
| */ | ||
| public static DeleteForecastRequest deleteAllForecasts(String jobId) { | ||
| DeleteForecastRequest request = new DeleteForecastRequest(jobId); | ||
| request.setForecastIds(ALL); | ||
| return request; | ||
| } | ||
|
|
||
| private final String jobId; | ||
| private List<String> forecastIds = new ArrayList<>(); | ||
| private Boolean allowNoForecasts; | ||
| private TimeValue timeout; | ||
|
|
||
| /** | ||
| * Create a new DeleteForecastRequest for the given Job ID | ||
| * | ||
| * @param jobId the jobId of the Job whose forecast(s) to delete | ||
| */ | ||
| public DeleteForecastRequest(String jobId) { | ||
| this.jobId = Objects.requireNonNull(jobId, Job.ID.getPreferredName()); | ||
| } | ||
|
|
||
| public String getJobId() { | ||
| return jobId; | ||
| } | ||
|
|
||
| public List<String> getForecastIds() { | ||
| return forecastIds; | ||
| } | ||
|
|
||
| /** | ||
| * The forecast IDs to delete. Can be also be {@link DeleteForecastRequest#ALL} to explicitly delete ALL forecasts | ||
| * | ||
| * @param forecastIds forecast IDs to delete | ||
| */ | ||
| public void setForecastIds(String... forecastIds) { | ||
| setForecastIds(Arrays.asList(forecastIds)); | ||
| } | ||
|
|
||
| void setForecastIds(List<String> forecastIds) { | ||
| if (forecastIds.stream().anyMatch(Objects::isNull)) { | ||
| throw new NullPointerException("forecastIds must not contain null values"); | ||
| } | ||
| this.forecastIds = new ArrayList<>(forecastIds); | ||
| } | ||
|
|
||
| public Boolean isAllowNoForecasts() { | ||
| return allowNoForecasts; | ||
| } | ||
|
|
||
| /** | ||
| * Sets the `allow_no_forecasts` field. | ||
| * | ||
| * @param allowNoForecasts when {@code true} no error is thrown when {@link DeleteForecastRequest#ALL} does not find any forecasts | ||
| */ | ||
| public void setAllowNoForecasts(boolean allowNoForecasts) { | ||
| this.allowNoForecasts = allowNoForecasts; | ||
| } | ||
|
|
||
| /** | ||
| * Allows to set the timeout | ||
| * @param timeout timeout as a string (e.g. 1s) | ||
| */ | ||
| public void timeout(String timeout) { | ||
| this.timeout = TimeValue.parseTimeValue(timeout, this.timeout, getClass().getSimpleName() + ".timeout"); | ||
| } | ||
|
|
||
| /** | ||
| * Allows to set the timeout | ||
| * @param timeout timeout as a {@link TimeValue} | ||
| */ | ||
| public void timeout(TimeValue timeout) { | ||
| this.timeout = timeout; | ||
| } | ||
|
|
||
| public TimeValue timeout() { | ||
| return timeout; | ||
| } | ||
|
|
||
| @Override | ||
| public boolean equals(Object other) { | ||
| if (this == other) { | ||
| return true; | ||
| } | ||
|
|
||
| if (other == null || getClass() != other.getClass()) { | ||
| return false; | ||
| } | ||
|
|
||
| DeleteForecastRequest that = (DeleteForecastRequest) other; | ||
| return Objects.equals(jobId, that.jobId) && | ||
| Objects.equals(forecastIds, that.forecastIds) && | ||
| Objects.equals(allowNoForecasts, that.allowNoForecasts) && | ||
| Objects.equals(timeout, that.timeout); | ||
| } | ||
|
|
||
| @Override | ||
| public int hashCode() { | ||
| return Objects.hash(jobId, forecastIds, allowNoForecasts, timeout); | ||
| } | ||
|
|
||
| @Override | ||
| public ActionRequestValidationException validate() { | ||
| return null; | ||
| } | ||
|
|
||
| @Override | ||
| public XContentBuilder toXContent(XContentBuilder builder, Params params) throws IOException { | ||
| builder.startObject(); | ||
| builder.field(Job.ID.getPreferredName(), jobId); | ||
| if (forecastIds != null) { | ||
| builder.field(FORECAST_ID.getPreferredName(), Strings.collectionToCommaDelimitedString(forecastIds)); | ||
| } | ||
| if (allowNoForecasts != null) { | ||
| builder.field(ALLOW_NO_FORECASTS.getPreferredName(), allowNoForecasts); | ||
| } | ||
| if (timeout != null) { | ||
| builder.field(TIMEOUT.getPreferredName(), timeout.getStringRep()); | ||
| } | ||
| 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.