mirror of
https://github.com/elastic/elasticsearch.git
synced 2025-04-24 23:27:25 -04:00
HLRC: adding machine learning open job (#32860)
* HLRC: adding machine learning open job HLRC: adding ML open job API call * Addressing @droberts195 comments and fixing minor style issue
This commit is contained in:
parent
5ba04e23fc
commit
f90f06ede1
13 changed files with 495 additions and 4 deletions
|
@ -19,6 +19,8 @@
|
||||||
package org.elasticsearch.client;
|
package org.elasticsearch.client;
|
||||||
|
|
||||||
import org.elasticsearch.action.ActionListener;
|
import org.elasticsearch.action.ActionListener;
|
||||||
|
import org.elasticsearch.protocol.xpack.ml.OpenJobRequest;
|
||||||
|
import org.elasticsearch.protocol.xpack.ml.OpenJobResponse;
|
||||||
import org.elasticsearch.protocol.xpack.ml.PutJobRequest;
|
import org.elasticsearch.protocol.xpack.ml.PutJobRequest;
|
||||||
import org.elasticsearch.protocol.xpack.ml.PutJobResponse;
|
import org.elasticsearch.protocol.xpack.ml.PutJobResponse;
|
||||||
|
|
||||||
|
@ -77,4 +79,51 @@ public final class MachineLearningClient {
|
||||||
listener,
|
listener,
|
||||||
Collections.emptySet());
|
Collections.emptySet());
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Opens a Machine Learning Job.
|
||||||
|
* When you open a new job, it starts with an empty model.
|
||||||
|
*
|
||||||
|
* When you open an existing job, the most recent model state is automatically loaded.
|
||||||
|
* The job is ready to resume its analysis from where it left off, once new data is received.
|
||||||
|
*
|
||||||
|
* <p>
|
||||||
|
* For additional info
|
||||||
|
* see <a href="https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-open-job.html"></a>
|
||||||
|
* </p>
|
||||||
|
* @param request request containing job_id and additional optional options
|
||||||
|
* @param options Additional request options (e.g. headers), use {@link RequestOptions#DEFAULT} if nothing needs to be customized
|
||||||
|
* @return response containing if the job was successfully opened or not.
|
||||||
|
* @throws IOException when there is a serialization issue sending the request or receiving the response
|
||||||
|
*/
|
||||||
|
public OpenJobResponse openJob(OpenJobRequest request, RequestOptions options) throws IOException {
|
||||||
|
return restHighLevelClient.performRequestAndParseEntity(request,
|
||||||
|
RequestConverters::machineLearningOpenJob,
|
||||||
|
options,
|
||||||
|
OpenJobResponse::fromXContent,
|
||||||
|
Collections.emptySet());
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Opens a Machine Learning Job asynchronously, notifies listener on completion.
|
||||||
|
* When you open a new job, it starts with an empty model.
|
||||||
|
*
|
||||||
|
* When you open an existing job, the most recent model state is automatically loaded.
|
||||||
|
* The job is ready to resume its analysis from where it left off, once new data is received.
|
||||||
|
* <p>
|
||||||
|
* For additional info
|
||||||
|
* see <a href="https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-open-job.html"></a>
|
||||||
|
* </p>
|
||||||
|
* @param request request containing job_id and additional optional options
|
||||||
|
* @param options Additional request options (e.g. headers), use {@link RequestOptions#DEFAULT} if nothing needs to be customized
|
||||||
|
* @param listener Listener to be notified upon request completion
|
||||||
|
*/
|
||||||
|
public void openJobAsync(OpenJobRequest request, RequestOptions options, ActionListener<OpenJobResponse> listener) {
|
||||||
|
restHighLevelClient.performRequestAsyncAndParseEntity(request,
|
||||||
|
RequestConverters::machineLearningOpenJob,
|
||||||
|
options,
|
||||||
|
OpenJobResponse::fromXContent,
|
||||||
|
listener,
|
||||||
|
Collections.emptySet());
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
|
@ -112,6 +112,7 @@ import org.elasticsearch.protocol.xpack.license.DeleteLicenseRequest;
|
||||||
import org.elasticsearch.protocol.xpack.license.GetLicenseRequest;
|
import org.elasticsearch.protocol.xpack.license.GetLicenseRequest;
|
||||||
import org.elasticsearch.protocol.xpack.license.PutLicenseRequest;
|
import org.elasticsearch.protocol.xpack.license.PutLicenseRequest;
|
||||||
import org.elasticsearch.protocol.xpack.migration.IndexUpgradeInfoRequest;
|
import org.elasticsearch.protocol.xpack.migration.IndexUpgradeInfoRequest;
|
||||||
|
import org.elasticsearch.protocol.xpack.ml.OpenJobRequest;
|
||||||
import org.elasticsearch.protocol.xpack.ml.PutJobRequest;
|
import org.elasticsearch.protocol.xpack.ml.PutJobRequest;
|
||||||
import org.elasticsearch.protocol.xpack.watcher.DeleteWatchRequest;
|
import org.elasticsearch.protocol.xpack.watcher.DeleteWatchRequest;
|
||||||
import org.elasticsearch.protocol.xpack.watcher.PutWatchRequest;
|
import org.elasticsearch.protocol.xpack.watcher.PutWatchRequest;
|
||||||
|
@ -1210,6 +1211,19 @@ final class RequestConverters {
|
||||||
return request;
|
return request;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
static Request machineLearningOpenJob(OpenJobRequest openJobRequest) throws IOException {
|
||||||
|
String endpoint = new EndpointBuilder()
|
||||||
|
.addPathPartAsIs("_xpack")
|
||||||
|
.addPathPartAsIs("ml")
|
||||||
|
.addPathPartAsIs("anomaly_detectors")
|
||||||
|
.addPathPart(openJobRequest.getJobId())
|
||||||
|
.addPathPartAsIs("_open")
|
||||||
|
.build();
|
||||||
|
Request request = new Request(HttpPost.METHOD_NAME, endpoint);
|
||||||
|
request.setJsonEntity(openJobRequest.toString());
|
||||||
|
return request;
|
||||||
|
}
|
||||||
|
|
||||||
static Request getMigrationAssistance(IndexUpgradeInfoRequest indexUpgradeInfoRequest) {
|
static Request getMigrationAssistance(IndexUpgradeInfoRequest indexUpgradeInfoRequest) {
|
||||||
EndpointBuilder endpointBuilder = new EndpointBuilder()
|
EndpointBuilder endpointBuilder = new EndpointBuilder()
|
||||||
.addPathPartAsIs("_xpack/migration/assistance")
|
.addPathPartAsIs("_xpack/migration/assistance")
|
||||||
|
|
|
@ -20,6 +20,8 @@ package org.elasticsearch.client;
|
||||||
|
|
||||||
import com.carrotsearch.randomizedtesting.generators.CodepointSetGenerator;
|
import com.carrotsearch.randomizedtesting.generators.CodepointSetGenerator;
|
||||||
import org.elasticsearch.common.unit.TimeValue;
|
import org.elasticsearch.common.unit.TimeValue;
|
||||||
|
import org.elasticsearch.protocol.xpack.ml.OpenJobRequest;
|
||||||
|
import org.elasticsearch.protocol.xpack.ml.OpenJobResponse;
|
||||||
import org.elasticsearch.protocol.xpack.ml.PutJobRequest;
|
import org.elasticsearch.protocol.xpack.ml.PutJobRequest;
|
||||||
import org.elasticsearch.protocol.xpack.ml.PutJobResponse;
|
import org.elasticsearch.protocol.xpack.ml.PutJobResponse;
|
||||||
import org.elasticsearch.protocol.xpack.ml.job.config.AnalysisConfig;
|
import org.elasticsearch.protocol.xpack.ml.job.config.AnalysisConfig;
|
||||||
|
@ -46,12 +48,24 @@ public class MachineLearningIT extends ESRestHighLevelClientTestCase {
|
||||||
assertThat(createdJob.getJobType(), is(Job.ANOMALY_DETECTOR_JOB_TYPE));
|
assertThat(createdJob.getJobType(), is(Job.ANOMALY_DETECTOR_JOB_TYPE));
|
||||||
}
|
}
|
||||||
|
|
||||||
|
public void testOpenJob() throws Exception {
|
||||||
|
String jobId = randomValidJobId();
|
||||||
|
Job job = buildJob(jobId);
|
||||||
|
MachineLearningClient machineLearningClient = highLevelClient().machineLearning();
|
||||||
|
|
||||||
|
machineLearningClient.putJob(new PutJobRequest(job), RequestOptions.DEFAULT);
|
||||||
|
|
||||||
|
OpenJobResponse response = execute(new OpenJobRequest(jobId), machineLearningClient::openJob, machineLearningClient::openJobAsync);
|
||||||
|
|
||||||
|
assertTrue(response.isOpened());
|
||||||
|
}
|
||||||
|
|
||||||
public static String randomValidJobId() {
|
public static String randomValidJobId() {
|
||||||
CodepointSetGenerator generator = new CodepointSetGenerator("abcdefghijklmnopqrstuvwxyz0123456789".toCharArray());
|
CodepointSetGenerator generator = new CodepointSetGenerator("abcdefghijklmnopqrstuvwxyz0123456789".toCharArray());
|
||||||
return generator.ofCodePointsLength(random(), 10, 10);
|
return generator.ofCodePointsLength(random(), 10, 10);
|
||||||
}
|
}
|
||||||
|
|
||||||
private static Job buildJob(String jobId) {
|
public static Job buildJob(String jobId) {
|
||||||
Job.Builder builder = new Job.Builder(jobId);
|
Job.Builder builder = new Job.Builder(jobId);
|
||||||
builder.setDescription(randomAlphaOfLength(10));
|
builder.setDescription(randomAlphaOfLength(10));
|
||||||
|
|
||||||
|
|
|
@ -127,6 +127,7 @@ import org.elasticsearch.index.rankeval.RatedRequest;
|
||||||
import org.elasticsearch.index.rankeval.RestRankEvalAction;
|
import org.elasticsearch.index.rankeval.RestRankEvalAction;
|
||||||
import org.elasticsearch.protocol.xpack.XPackInfoRequest;
|
import org.elasticsearch.protocol.xpack.XPackInfoRequest;
|
||||||
import org.elasticsearch.protocol.xpack.migration.IndexUpgradeInfoRequest;
|
import org.elasticsearch.protocol.xpack.migration.IndexUpgradeInfoRequest;
|
||||||
|
import org.elasticsearch.protocol.xpack.ml.OpenJobRequest;
|
||||||
import org.elasticsearch.protocol.xpack.watcher.DeleteWatchRequest;
|
import org.elasticsearch.protocol.xpack.watcher.DeleteWatchRequest;
|
||||||
import org.elasticsearch.protocol.xpack.watcher.PutWatchRequest;
|
import org.elasticsearch.protocol.xpack.watcher.PutWatchRequest;
|
||||||
import org.elasticsearch.repositories.fs.FsRepository;
|
import org.elasticsearch.repositories.fs.FsRepository;
|
||||||
|
@ -2610,6 +2611,19 @@ public class RequestConvertersTests extends ESTestCase {
|
||||||
assertThat(request.getEntity(), nullValue());
|
assertThat(request.getEntity(), nullValue());
|
||||||
}
|
}
|
||||||
|
|
||||||
|
public void testPostMachineLearningOpenJob() throws Exception {
|
||||||
|
String jobId = "some-job-id";
|
||||||
|
OpenJobRequest openJobRequest = new OpenJobRequest(jobId);
|
||||||
|
openJobRequest.setTimeout(TimeValue.timeValueMinutes(10));
|
||||||
|
|
||||||
|
Request request = RequestConverters.machineLearningOpenJob(openJobRequest);
|
||||||
|
assertEquals(HttpPost.METHOD_NAME, request.getMethod());
|
||||||
|
assertEquals("/_xpack/ml/anomaly_detectors/" + jobId + "/_open", request.getEndpoint());
|
||||||
|
ByteArrayOutputStream bos = new ByteArrayOutputStream();
|
||||||
|
request.getEntity().writeTo(bos);
|
||||||
|
assertEquals(bos.toString("UTF-8"), "{\"job_id\":\""+ jobId +"\",\"timeout\":\"10m\"}");
|
||||||
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Randomize the {@link FetchSourceContext} request parameters.
|
* Randomize the {@link FetchSourceContext} request parameters.
|
||||||
*/
|
*/
|
||||||
|
|
|
@ -21,9 +21,12 @@ package org.elasticsearch.client.documentation;
|
||||||
import org.elasticsearch.action.ActionListener;
|
import org.elasticsearch.action.ActionListener;
|
||||||
import org.elasticsearch.action.LatchedActionListener;
|
import org.elasticsearch.action.LatchedActionListener;
|
||||||
import org.elasticsearch.client.ESRestHighLevelClientTestCase;
|
import org.elasticsearch.client.ESRestHighLevelClientTestCase;
|
||||||
|
import org.elasticsearch.client.MachineLearningIT;
|
||||||
import org.elasticsearch.client.RequestOptions;
|
import org.elasticsearch.client.RequestOptions;
|
||||||
import org.elasticsearch.client.RestHighLevelClient;
|
import org.elasticsearch.client.RestHighLevelClient;
|
||||||
import org.elasticsearch.common.unit.TimeValue;
|
import org.elasticsearch.common.unit.TimeValue;
|
||||||
|
import org.elasticsearch.protocol.xpack.ml.OpenJobRequest;
|
||||||
|
import org.elasticsearch.protocol.xpack.ml.OpenJobResponse;
|
||||||
import org.elasticsearch.protocol.xpack.ml.PutJobRequest;
|
import org.elasticsearch.protocol.xpack.ml.PutJobRequest;
|
||||||
import org.elasticsearch.protocol.xpack.ml.PutJobResponse;
|
import org.elasticsearch.protocol.xpack.ml.PutJobResponse;
|
||||||
import org.elasticsearch.protocol.xpack.ml.job.config.AnalysisConfig;
|
import org.elasticsearch.protocol.xpack.ml.job.config.AnalysisConfig;
|
||||||
|
@ -118,4 +121,54 @@ public class MlClientDocumentationIT extends ESRestHighLevelClientTestCase {
|
||||||
assertTrue(latch.await(30L, TimeUnit.SECONDS));
|
assertTrue(latch.await(30L, TimeUnit.SECONDS));
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
public void testOpenJob() throws Exception {
|
||||||
|
RestHighLevelClient client = highLevelClient();
|
||||||
|
|
||||||
|
Job job = MachineLearningIT.buildJob("opening-my-first-machine-learning-job");
|
||||||
|
client.machineLearning().putJob(new PutJobRequest(job), RequestOptions.DEFAULT);
|
||||||
|
|
||||||
|
Job secondJob = MachineLearningIT.buildJob("opening-my-second-machine-learning-job");
|
||||||
|
client.machineLearning().putJob(new PutJobRequest(secondJob), RequestOptions.DEFAULT);
|
||||||
|
|
||||||
|
{
|
||||||
|
//tag::x-pack-ml-open-job-request
|
||||||
|
OpenJobRequest openJobRequest = new OpenJobRequest("opening-my-first-machine-learning-job"); //<1>
|
||||||
|
openJobRequest.setTimeout(TimeValue.timeValueMinutes(10)); //<2>
|
||||||
|
//end::x-pack-ml-open-job-request
|
||||||
|
|
||||||
|
//tag::x-pack-ml-open-job-execute
|
||||||
|
OpenJobResponse openJobResponse = client.machineLearning().openJob(openJobRequest, RequestOptions.DEFAULT);
|
||||||
|
boolean isOpened = openJobResponse.isOpened(); //<1>
|
||||||
|
//end::x-pack-ml-open-job-execute
|
||||||
|
|
||||||
|
}
|
||||||
|
|
||||||
|
{
|
||||||
|
//tag::x-pack-ml-open-job-listener
|
||||||
|
ActionListener<OpenJobResponse> listener = new ActionListener<OpenJobResponse>() {
|
||||||
|
@Override
|
||||||
|
public void onResponse(OpenJobResponse openJobResponse) {
|
||||||
|
//<1>
|
||||||
|
}
|
||||||
|
|
||||||
|
@Override
|
||||||
|
public void onFailure(Exception e) {
|
||||||
|
//<2>
|
||||||
|
}
|
||||||
|
};
|
||||||
|
//end::x-pack-ml-open-job-listener
|
||||||
|
OpenJobRequest openJobRequest = new OpenJobRequest("opening-my-second-machine-learning-job");
|
||||||
|
// Replace the empty listener by a blocking listener in test
|
||||||
|
final CountDownLatch latch = new CountDownLatch(1);
|
||||||
|
listener = new LatchedActionListener<>(listener, latch);
|
||||||
|
|
||||||
|
// tag::x-pack-ml-open-job-execute-async
|
||||||
|
client.machineLearning().openJobAsync(openJobRequest, RequestOptions.DEFAULT, listener); //<1>
|
||||||
|
// end::x-pack-ml-open-job-execute-async
|
||||||
|
|
||||||
|
assertTrue(latch.await(30L, TimeUnit.SECONDS));
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
55
docs/java-rest/high-level/ml/open-job.asciidoc
Normal file
55
docs/java-rest/high-level/ml/open-job.asciidoc
Normal file
|
@ -0,0 +1,55 @@
|
||||||
|
[[java-rest-high-x-pack-ml-open-job]]
|
||||||
|
=== Open Job API
|
||||||
|
|
||||||
|
The Open Job API provides the ability to open {ml} jobs in the cluster.
|
||||||
|
It accepts a `OpenJobRequest` object and responds
|
||||||
|
with a `OpenJobResponse` object.
|
||||||
|
|
||||||
|
[[java-rest-high-x-pack-ml-open-job-request]]
|
||||||
|
==== Open Job Request
|
||||||
|
|
||||||
|
An `OpenJobRequest` object gets created with an existing non-null `jobId`.
|
||||||
|
|
||||||
|
["source","java",subs="attributes,callouts,macros"]
|
||||||
|
--------------------------------------------------
|
||||||
|
include-tagged::{doc-tests}/MlClientDocumentationIT.java[x-pack-ml-open-job-request]
|
||||||
|
--------------------------------------------------
|
||||||
|
<1> Constructing a new request referencing an existing `jobId`
|
||||||
|
<2> Optionally setting the `timeout` value for how long the
|
||||||
|
execution should wait for the job to be opened.
|
||||||
|
|
||||||
|
[[java-rest-high-x-pack-ml-open-job-execution]]
|
||||||
|
==== Execution
|
||||||
|
|
||||||
|
The request can be executed through the `MachineLearningClient` contained
|
||||||
|
in the `RestHighLevelClient` object, accessed via the `machineLearningClient()` method.
|
||||||
|
|
||||||
|
["source","java",subs="attributes,callouts,macros"]
|
||||||
|
--------------------------------------------------
|
||||||
|
include-tagged::{doc-tests}/MlClientDocumentationIT.java[x-pack-ml-open-job-execute]
|
||||||
|
--------------------------------------------------
|
||||||
|
<1> `isOpened()` from the `OpenJobResponse` indicates if the job was successfully
|
||||||
|
opened or not.
|
||||||
|
|
||||||
|
[[java-rest-high-x-pack-ml-open-job-execution-async]]
|
||||||
|
==== Asynchronous Execution
|
||||||
|
|
||||||
|
The request can also be executed asynchronously:
|
||||||
|
|
||||||
|
["source","java",subs="attributes,callouts,macros"]
|
||||||
|
--------------------------------------------------
|
||||||
|
include-tagged::{doc-tests}/MlClientDocumentationIT.java[x-pack-ml-open-job-execute-async]
|
||||||
|
--------------------------------------------------
|
||||||
|
<1> The `OpenJobRequest` to execute and the `ActionListener` to use when
|
||||||
|
the execution completes
|
||||||
|
|
||||||
|
The method does not block and returns immediately. The passed `ActionListener` is used
|
||||||
|
to notify the caller of completion. A typical `ActionListner` for `OpenJobResponse` may
|
||||||
|
look like
|
||||||
|
|
||||||
|
["source","java",subs="attributes,callouts,macros"]
|
||||||
|
--------------------------------------------------
|
||||||
|
include-tagged::{doc-tests}/MlClientDocumentationIT.java[x-pack-ml-open-job-listener]
|
||||||
|
--------------------------------------------------
|
||||||
|
<1> `onResponse` is called back when the action is completed successfully
|
||||||
|
<2> `onFailure` is called back when some unexpected error occurs
|
|
@ -205,8 +205,10 @@ include::licensing/delete-license.asciidoc[]
|
||||||
The Java High Level REST Client supports the following Machine Learning APIs:
|
The Java High Level REST Client supports the following Machine Learning APIs:
|
||||||
|
|
||||||
* <<java-rest-high-x-pack-ml-put-job>>
|
* <<java-rest-high-x-pack-ml-put-job>>
|
||||||
|
* <<java-rest-high-x-pack-ml-open-job>>
|
||||||
|
|
||||||
include::ml/put_job.asciidoc[]
|
include::ml/put-job.asciidoc[]
|
||||||
|
include::ml/open-job.asciidoc[]
|
||||||
|
|
||||||
== Migration APIs
|
== Migration APIs
|
||||||
|
|
||||||
|
|
|
@ -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.protocol.xpack.ml;
|
||||||
|
|
||||||
|
import org.elasticsearch.action.ActionRequest;
|
||||||
|
import org.elasticsearch.action.ActionRequestValidationException;
|
||||||
|
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.ToXContent;
|
||||||
|
import org.elasticsearch.common.xcontent.ToXContentObject;
|
||||||
|
import org.elasticsearch.common.xcontent.XContentBuilder;
|
||||||
|
import org.elasticsearch.common.xcontent.XContentParser;
|
||||||
|
import org.elasticsearch.protocol.xpack.ml.job.config.Job;
|
||||||
|
|
||||||
|
import java.io.IOException;
|
||||||
|
import java.util.Objects;
|
||||||
|
|
||||||
|
public class OpenJobRequest extends ActionRequest implements ToXContentObject {
|
||||||
|
|
||||||
|
public static final ParseField TIMEOUT = new ParseField("timeout");
|
||||||
|
public static final ConstructingObjectParser<OpenJobRequest, Void> PARSER = new ConstructingObjectParser<>(
|
||||||
|
"open_job_request", true, a -> new OpenJobRequest((String) a[0]));
|
||||||
|
|
||||||
|
static {
|
||||||
|
PARSER.declareString(ConstructingObjectParser.constructorArg(), Job.ID);
|
||||||
|
PARSER.declareString((request, val) -> request.setTimeout(TimeValue.parseTimeValue(val, TIMEOUT.getPreferredName())), TIMEOUT);
|
||||||
|
}
|
||||||
|
|
||||||
|
public static OpenJobRequest fromXContent(XContentParser parser) throws IOException {
|
||||||
|
return PARSER.parse(parser, null);
|
||||||
|
}
|
||||||
|
|
||||||
|
private String jobId;
|
||||||
|
private TimeValue timeout;
|
||||||
|
|
||||||
|
public OpenJobRequest(String jobId) {
|
||||||
|
this.jobId = Objects.requireNonNull(jobId, "[job_id] must not be null");
|
||||||
|
}
|
||||||
|
|
||||||
|
public String getJobId() {
|
||||||
|
return jobId;
|
||||||
|
}
|
||||||
|
|
||||||
|
public void setJobId(String jobId) {
|
||||||
|
this.jobId = Objects.requireNonNull(jobId, "[job_id] must not be null");
|
||||||
|
}
|
||||||
|
|
||||||
|
public TimeValue getTimeout() {
|
||||||
|
return timeout;
|
||||||
|
}
|
||||||
|
|
||||||
|
public void setTimeout(TimeValue timeout) {
|
||||||
|
this.timeout = timeout;
|
||||||
|
}
|
||||||
|
|
||||||
|
@Override
|
||||||
|
public ActionRequestValidationException validate() {
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
|
||||||
|
@Override
|
||||||
|
public XContentBuilder toXContent(XContentBuilder builder, ToXContent.Params params) throws IOException {
|
||||||
|
builder.startObject();
|
||||||
|
builder.field(Job.ID.getPreferredName(), jobId);
|
||||||
|
if (timeout != null) {
|
||||||
|
builder.field(TIMEOUT.getPreferredName(), timeout.getStringRep());
|
||||||
|
}
|
||||||
|
builder.endObject();
|
||||||
|
return builder;
|
||||||
|
}
|
||||||
|
|
||||||
|
@Override
|
||||||
|
public String toString() {
|
||||||
|
return Strings.toString(this);
|
||||||
|
}
|
||||||
|
|
||||||
|
@Override
|
||||||
|
public int hashCode() {
|
||||||
|
return Objects.hash(jobId, timeout);
|
||||||
|
}
|
||||||
|
|
||||||
|
@Override
|
||||||
|
public boolean equals(Object other) {
|
||||||
|
if (this == other) {
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (other == null || getClass() != other.getClass()) {
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
|
||||||
|
OpenJobRequest that = (OpenJobRequest) other;
|
||||||
|
return Objects.equals(jobId, that.jobId) && Objects.equals(timeout, that.timeout);
|
||||||
|
}
|
||||||
|
}
|
|
@ -0,0 +1,88 @@
|
||||||
|
/*
|
||||||
|
* 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.protocol.xpack.ml;
|
||||||
|
|
||||||
|
import org.elasticsearch.action.ActionResponse;
|
||||||
|
import org.elasticsearch.common.ParseField;
|
||||||
|
import org.elasticsearch.common.xcontent.ObjectParser;
|
||||||
|
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;
|
||||||
|
|
||||||
|
public class OpenJobResponse extends ActionResponse implements ToXContentObject {
|
||||||
|
|
||||||
|
private static final ParseField OPENED = new ParseField("opened");
|
||||||
|
|
||||||
|
public static final ObjectParser<OpenJobResponse, Void> PARSER = new ObjectParser<>("open_job_response", true, OpenJobResponse::new);
|
||||||
|
|
||||||
|
static {
|
||||||
|
PARSER.declareBoolean(OpenJobResponse::setOpened, OPENED);
|
||||||
|
}
|
||||||
|
|
||||||
|
private boolean opened;
|
||||||
|
|
||||||
|
OpenJobResponse() {
|
||||||
|
}
|
||||||
|
|
||||||
|
public OpenJobResponse(boolean opened) {
|
||||||
|
this.opened = opened;
|
||||||
|
}
|
||||||
|
|
||||||
|
public static OpenJobResponse fromXContent(XContentParser parser) throws IOException {
|
||||||
|
return PARSER.parse(parser, null);
|
||||||
|
}
|
||||||
|
|
||||||
|
public boolean isOpened() {
|
||||||
|
return opened;
|
||||||
|
}
|
||||||
|
|
||||||
|
public void setOpened(boolean opened) {
|
||||||
|
this.opened = opened;
|
||||||
|
}
|
||||||
|
|
||||||
|
@Override
|
||||||
|
public boolean equals(Object other) {
|
||||||
|
if (this == other) {
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (other == null || getClass() != other.getClass()) {
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
|
||||||
|
OpenJobResponse that = (OpenJobResponse) other;
|
||||||
|
return isOpened() == that.isOpened();
|
||||||
|
}
|
||||||
|
|
||||||
|
@Override
|
||||||
|
public int hashCode() {
|
||||||
|
return Objects.hash(isOpened());
|
||||||
|
}
|
||||||
|
|
||||||
|
@Override
|
||||||
|
public XContentBuilder toXContent(XContentBuilder builder, Params params) throws IOException {
|
||||||
|
builder.startObject();
|
||||||
|
builder.field(OPENED.getPreferredName(), opened);
|
||||||
|
builder.endObject();
|
||||||
|
return builder;
|
||||||
|
}
|
||||||
|
}
|
|
@ -0,0 +1,48 @@
|
||||||
|
/*
|
||||||
|
* 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.protocol.xpack.ml;
|
||||||
|
|
||||||
|
import org.elasticsearch.common.unit.TimeValue;
|
||||||
|
import org.elasticsearch.common.xcontent.XContentParser;
|
||||||
|
import org.elasticsearch.protocol.xpack.ml.job.config.JobTests;
|
||||||
|
import org.elasticsearch.test.AbstractXContentTestCase;
|
||||||
|
|
||||||
|
import java.io.IOException;
|
||||||
|
|
||||||
|
public class OpenJobRequestTests extends AbstractXContentTestCase<OpenJobRequest> {
|
||||||
|
|
||||||
|
@Override
|
||||||
|
protected OpenJobRequest createTestInstance() {
|
||||||
|
OpenJobRequest openJobRequest = new OpenJobRequest(JobTests.randomValidJobId());
|
||||||
|
if (randomBoolean()) {
|
||||||
|
openJobRequest.setTimeout(TimeValue.timeValueSeconds(randomIntBetween(1, Integer.MAX_VALUE)));
|
||||||
|
}
|
||||||
|
return openJobRequest;
|
||||||
|
}
|
||||||
|
|
||||||
|
@Override
|
||||||
|
protected OpenJobRequest doParseInstance(XContentParser parser) throws IOException {
|
||||||
|
return OpenJobRequest.fromXContent(parser);
|
||||||
|
}
|
||||||
|
|
||||||
|
@Override
|
||||||
|
protected boolean supportsUnknownFields() {
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
}
|
|
@ -0,0 +1,42 @@
|
||||||
|
/*
|
||||||
|
* 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.protocol.xpack.ml;
|
||||||
|
|
||||||
|
import org.elasticsearch.common.xcontent.XContentParser;
|
||||||
|
import org.elasticsearch.test.AbstractXContentTestCase;
|
||||||
|
|
||||||
|
import java.io.IOException;
|
||||||
|
|
||||||
|
public class OpenJobResponseTests extends AbstractXContentTestCase<OpenJobResponse> {
|
||||||
|
|
||||||
|
@Override
|
||||||
|
protected OpenJobResponse createTestInstance() {
|
||||||
|
return new OpenJobResponse(randomBoolean());
|
||||||
|
}
|
||||||
|
|
||||||
|
@Override
|
||||||
|
protected OpenJobResponse doParseInstance(XContentParser parser) throws IOException {
|
||||||
|
return OpenJobResponse.fromXContent(parser);
|
||||||
|
}
|
||||||
|
|
||||||
|
@Override
|
||||||
|
protected boolean supportsUnknownFields() {
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
}
|
|
@ -23,7 +23,6 @@ import org.elasticsearch.protocol.xpack.ml.job.config.Job;
|
||||||
import org.elasticsearch.protocol.xpack.ml.job.config.JobTests;
|
import org.elasticsearch.protocol.xpack.ml.job.config.JobTests;
|
||||||
import org.elasticsearch.test.AbstractXContentTestCase;
|
import org.elasticsearch.test.AbstractXContentTestCase;
|
||||||
|
|
||||||
import java.io.IOException;
|
|
||||||
|
|
||||||
public class PutJobRequestTests extends AbstractXContentTestCase<PutJobRequest> {
|
public class PutJobRequestTests extends AbstractXContentTestCase<PutJobRequest> {
|
||||||
|
|
||||||
|
@ -33,7 +32,7 @@ public class PutJobRequestTests extends AbstractXContentTestCase<PutJobRequest>
|
||||||
}
|
}
|
||||||
|
|
||||||
@Override
|
@Override
|
||||||
protected PutJobRequest doParseInstance(XContentParser parser) throws IOException {
|
protected PutJobRequest doParseInstance(XContentParser parser) {
|
||||||
return new PutJobRequest(Job.PARSER.apply(parser, null).build());
|
return new PutJobRequest(Job.PARSER.apply(parser, null).build());
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue