HLRC: Move ML protocol classes into client ml package (#33203)

* HLRC: Move ML protocol classes into client ml package * Do not use log4j deprecation handler * JavaDoc should refer to correct Job path
elastic · Aug 28, 2018 · faa8f29 · faa8f29
1 parent 788ae74
commit faa8f29
Show file tree

Hide file tree

Showing 94 changed files with 213 additions and 228 deletions.
diff --git a/client/rest-high-level/src/main/java/org/elasticsearch/client/MLRequestConverters.java b/client/rest-high-level/src/main/java/org/elasticsearch/client/MLRequestConverters.java
@@ -24,13 +24,13 @@
 import org.apache.http.client.methods.HttpPost;
 import org.apache.http.client.methods.HttpPut;
 import org.elasticsearch.client.RequestConverters.EndpointBuilder;
+import org.elasticsearch.client.ml.CloseJobRequest;
+import org.elasticsearch.client.ml.DeleteJobRequest;
+import org.elasticsearch.client.ml.GetBucketsRequest;
+import org.elasticsearch.client.ml.GetJobRequest;
+import org.elasticsearch.client.ml.OpenJobRequest;
+import org.elasticsearch.client.ml.PutJobRequest;
 import org.elasticsearch.common.Strings;
-import org.elasticsearch.protocol.xpack.ml.CloseJobRequest;
-import org.elasticsearch.protocol.xpack.ml.DeleteJobRequest;
-import org.elasticsearch.protocol.xpack.ml.GetJobRequest;
-import org.elasticsearch.protocol.xpack.ml.GetBucketsRequest;
-import org.elasticsearch.protocol.xpack.ml.OpenJobRequest;
-import org.elasticsearch.protocol.xpack.ml.PutJobRequest;
 
 import java.io.IOException;
 

diff --git a/client/rest-high-level/src/main/java/org/elasticsearch/client/MachineLearningClient.java b/client/rest-high-level/src/main/java/org/elasticsearch/client/MachineLearningClient.java
@@ -19,18 +19,18 @@
 package org.elasticsearch.client;
 
 import org.elasticsearch.action.ActionListener;
-import org.elasticsearch.protocol.xpack.ml.CloseJobRequest;
-import org.elasticsearch.protocol.xpack.ml.CloseJobResponse;
-import org.elasticsearch.protocol.xpack.ml.DeleteJobRequest;
-import org.elasticsearch.protocol.xpack.ml.DeleteJobResponse;
-import org.elasticsearch.protocol.xpack.ml.GetBucketsRequest;
-import org.elasticsearch.protocol.xpack.ml.GetBucketsResponse;
-import org.elasticsearch.protocol.xpack.ml.GetJobRequest;
-import org.elasticsearch.protocol.xpack.ml.GetJobResponse;
-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.PutJobResponse;
+import org.elasticsearch.client.ml.CloseJobRequest;
+import org.elasticsearch.client.ml.CloseJobResponse;
+import org.elasticsearch.client.ml.DeleteJobRequest;
+import org.elasticsearch.client.ml.DeleteJobResponse;
+import org.elasticsearch.client.ml.GetBucketsRequest;
+import org.elasticsearch.client.ml.GetBucketsResponse;
+import org.elasticsearch.client.ml.GetJobRequest;
+import org.elasticsearch.client.ml.GetJobResponse;
+import org.elasticsearch.client.ml.OpenJobRequest;
+import org.elasticsearch.client.ml.OpenJobResponse;
+import org.elasticsearch.client.ml.PutJobRequest;
+import org.elasticsearch.client.ml.PutJobResponse;
 
 import java.io.IOException;
 import java.util.Collections;
@@ -56,9 +56,9 @@ public final class MachineLearningClient {
      * For additional info
      * see <a href="https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-put-job.html">ML PUT job documentation</a>
      *
-     * @param request The PutJobRequest containing the {@link org.elasticsearch.protocol.xpack.ml.job.config.Job} settings
+     * @param request The PutJobRequest containing the {@link org.elasticsearch.client.ml.job.config.Job} settings
      * @param options Additional request options (e.g. headers), use {@link RequestOptions#DEFAULT} if nothing needs to be customized
-     * @return PutJobResponse with enclosed {@link org.elasticsearch.protocol.xpack.ml.job.config.Job} object
+     * @return PutJobResponse with enclosed {@link org.elasticsearch.client.ml.job.config.Job} object
      * @throws IOException when there is a serialization issue sending the request or receiving the response
      */
     public PutJobResponse putJob(PutJobRequest request, RequestOptions options) throws IOException {
@@ -75,7 +75,7 @@ public PutJobResponse putJob(PutJobRequest request, RequestOptions options) thro
      * For additional info
      * see <a href="https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-put-job.html">ML PUT job documentation</a>
      *
-     * @param request  The request containing the {@link org.elasticsearch.protocol.xpack.ml.job.config.Job} settings
+     * @param request  The request containing the {@link org.elasticsearch.client.ml.job.config.Job} settings
      * @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
      */
@@ -98,7 +98,7 @@ public void putJobAsync(PutJobRequest request, RequestOptions options, ActionLis
      * @param request {@link GetJobRequest} Request containing a list of jobId(s) and additional options
      * @param options  Additional request options (e.g. headers), use {@link RequestOptions#DEFAULT} if nothing needs to be customized
      * @return {@link GetJobResponse} response object containing
-     * the {@link org.elasticsearch.protocol.xpack.ml.job.config.Job} objects and the number of jobs found
+     * the {@link org.elasticsearch.client.ml.job.config.Job} objects and the number of jobs found
      * @throws IOException when there is a serialization issue sending the request or receiving the response
      */
     public GetJobResponse getJob(GetJobRequest request, RequestOptions options) throws IOException {

diff --git a/...ocol/xpack/ml/AbstractResultResponse.java → ...rch/client/ml/AbstractResultResponse.java b/...ocol/xpack/ml/AbstractResultResponse.java → ...rch/client/ml/AbstractResultResponse.java
@@ -16,7 +16,7 @@
  * specific language governing permissions and limitations
  * under the License.
  */
-package org.elasticsearch.protocol.xpack.ml;
+package org.elasticsearch.client.ml;
 
 import org.elasticsearch.action.ActionResponse;
 import org.elasticsearch.common.ParseField;

diff --git a/...ch/protocol/xpack/ml/CloseJobRequest.java → ...sticsearch/client/ml/CloseJobRequest.java b/...ch/protocol/xpack/ml/CloseJobRequest.java → ...sticsearch/client/ml/CloseJobRequest.java
@@ -16,7 +16,7 @@
  * specific language governing permissions and limitations
  * under the License.
  */
-package org.elasticsearch.protocol.xpack.ml;
+package org.elasticsearch.client.ml;
 
 import org.elasticsearch.action.ActionRequest;
 import org.elasticsearch.action.ActionRequestValidationException;

diff --git a/...h/protocol/xpack/ml/CloseJobResponse.java → ...ticsearch/client/ml/CloseJobResponse.java b/...h/protocol/xpack/ml/CloseJobResponse.java → ...ticsearch/client/ml/CloseJobResponse.java
@@ -16,7 +16,7 @@
  * specific language governing permissions and limitations
  * under the License.
  */
-package org.elasticsearch.protocol.xpack.ml;
+package org.elasticsearch.client.ml;
 
 import org.elasticsearch.action.ActionResponse;
 import org.elasticsearch.common.ParseField;

diff --git a/...h/protocol/xpack/ml/DeleteJobRequest.java → ...ticsearch/client/ml/DeleteJobRequest.java b/...h/protocol/xpack/ml/DeleteJobRequest.java → ...ticsearch/client/ml/DeleteJobRequest.java
@@ -16,7 +16,7 @@
  * specific language governing permissions and limitations
  * under the License.
  */
-package org.elasticsearch.protocol.xpack.ml;
+package org.elasticsearch.client.ml;
 
 import org.elasticsearch.action.ActionRequest;
 import org.elasticsearch.action.ActionRequestValidationException;

diff --git a/.../protocol/xpack/ml/DeleteJobResponse.java → ...icsearch/client/ml/DeleteJobResponse.java b/.../protocol/xpack/ml/DeleteJobResponse.java → ...icsearch/client/ml/DeleteJobResponse.java
@@ -16,7 +16,7 @@
  * specific language governing permissions and limitations
  * under the License.
  */
-package org.elasticsearch.protocol.xpack.ml;
+package org.elasticsearch.client.ml;
 
 import org.elasticsearch.action.support.master.AcknowledgedResponse;
 import org.elasticsearch.common.xcontent.XContentParser;

diff --git a/.../protocol/xpack/ml/GetBucketsRequest.java → ...icsearch/client/ml/GetBucketsRequest.java b/.../protocol/xpack/ml/GetBucketsRequest.java → ...icsearch/client/ml/GetBucketsRequest.java
@@ -16,17 +16,17 @@
  * specific language governing permissions and limitations
  * under the License.
  */
-package org.elasticsearch.protocol.xpack.ml;
+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.results.Result;
+import org.elasticsearch.client.ml.job.util.PageParams;
 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.protocol.xpack.ml.job.config.Job;
-import org.elasticsearch.protocol.xpack.ml.job.results.Result;
-import org.elasticsearch.protocol.xpack.ml.job.util.PageParams;
 
 import java.io.IOException;
 import java.util.Objects;

diff --git a/...protocol/xpack/ml/GetBucketsResponse.java → ...csearch/client/ml/GetBucketsResponse.java b/...protocol/xpack/ml/GetBucketsResponse.java → ...csearch/client/ml/GetBucketsResponse.java
@@ -16,12 +16,12 @@
  * specific language governing permissions and limitations
  * under the License.
  */
-package org.elasticsearch.protocol.xpack.ml;
+package org.elasticsearch.client.ml;
 
+import org.elasticsearch.client.ml.job.results.Bucket;
 import org.elasticsearch.common.ParseField;
 import org.elasticsearch.common.xcontent.ConstructingObjectParser;
 import org.elasticsearch.common.xcontent.XContentParser;
-import org.elasticsearch.protocol.xpack.ml.job.results.Bucket;
 
 import java.io.IOException;
 import java.util.List;

diff --git a/...arch/protocol/xpack/ml/GetJobRequest.java → ...lasticsearch/client/ml/GetJobRequest.java b/...arch/protocol/xpack/ml/GetJobRequest.java → ...lasticsearch/client/ml/GetJobRequest.java
@@ -16,10 +16,11 @@
  * specific language governing permissions and limitations
  * under the License.
  */
-package org.elasticsearch.protocol.xpack.ml;
+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.xcontent.ConstructingObjectParser;
 import org.elasticsearch.common.xcontent.ToXContentObject;
@@ -32,7 +33,7 @@
 import java.util.Objects;
 
 /**
- * Request object to get {@link org.elasticsearch.protocol.xpack.ml.job.config.Job} objects with the matching `jobId`s or
+ * Request object to get {@link Job} objects with the matching `jobId`s or
  * `groupName`s.
  *
  * `_all` explicitly gets all the jobs in the cluster
@@ -66,7 +67,7 @@ public static GetJobRequest getAllJobsRequest() {
     }
 
     /**
-     * Get the specified {@link org.elasticsearch.protocol.xpack.ml.job.config.Job} configurations via their unique jobIds
+     * Get the specified {@link Job} configurations via their unique jobIds
      * @param jobIds must not contain any null values
      */
     public GetJobRequest(String... jobIds) {

diff --git a/...rch/protocol/xpack/ml/GetJobResponse.java → ...asticsearch/client/ml/GetJobResponse.java b/...rch/protocol/xpack/ml/GetJobResponse.java → ...asticsearch/client/ml/GetJobResponse.java
@@ -16,13 +16,13 @@
  * specific language governing permissions and limitations
  * under the License.
  */
-package org.elasticsearch.protocol.xpack.ml;
+package org.elasticsearch.client.ml;
 
+import org.elasticsearch.client.ml.job.config.Job;
 import org.elasticsearch.common.ParseField;
 import org.elasticsearch.common.Strings;
 import org.elasticsearch.common.xcontent.ConstructingObjectParser;
 import org.elasticsearch.common.xcontent.XContentParser;
-import org.elasticsearch.protocol.xpack.ml.job.config.Job;
 
 import java.io.IOException;
 import java.util.List;

diff --git a/...rch/protocol/xpack/ml/OpenJobRequest.java → ...asticsearch/client/ml/OpenJobRequest.java b/...rch/protocol/xpack/ml/OpenJobRequest.java → ...asticsearch/client/ml/OpenJobRequest.java
@@ -16,19 +16,18 @@
  * specific language governing permissions and limitations
  * under the License.
  */
-package org.elasticsearch.protocol.xpack.ml;
+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.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;
@@ -95,7 +94,7 @@ public ActionRequestValidationException validate() {
     }
 
     @Override
-    public XContentBuilder toXContent(XContentBuilder builder, ToXContent.Params params) throws IOException {
+    public XContentBuilder toXContent(XContentBuilder builder, Params params) throws IOException {
         builder.startObject();
         builder.field(Job.ID.getPreferredName(), jobId);
         if (timeout != null) {

diff --git a/...ch/protocol/xpack/ml/OpenJobResponse.java → ...sticsearch/client/ml/OpenJobResponse.java b/...ch/protocol/xpack/ml/OpenJobResponse.java → ...sticsearch/client/ml/OpenJobResponse.java
@@ -16,7 +16,7 @@
  * specific language governing permissions and limitations
  * under the License.
  */
-package org.elasticsearch.protocol.xpack.ml;
+package org.elasticsearch.client.ml;
 
 import org.elasticsearch.action.ActionResponse;
 import org.elasticsearch.common.ParseField;

diff --git a/...arch/protocol/xpack/ml/PutJobRequest.java → ...lasticsearch/client/ml/PutJobRequest.java b/...arch/protocol/xpack/ml/PutJobRequest.java → ...lasticsearch/client/ml/PutJobRequest.java
@@ -16,14 +16,14 @@
  * specific language governing permissions and limitations
  * under the License.
  */
-package org.elasticsearch.protocol.xpack.ml;
+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.Strings;
 import org.elasticsearch.common.xcontent.ToXContentObject;
 import org.elasticsearch.common.xcontent.XContentBuilder;
-import org.elasticsearch.protocol.xpack.ml.job.config.Job;
 
 import java.io.IOException;
 import java.util.Objects;

diff --git a/...rch/protocol/xpack/ml/PutJobResponse.java → ...asticsearch/client/ml/PutJobResponse.java b/...rch/protocol/xpack/ml/PutJobResponse.java → ...asticsearch/client/ml/PutJobResponse.java
@@ -16,13 +16,12 @@
  * specific language governing permissions and limitations
  * under the License.
  */
-package org.elasticsearch.protocol.xpack.ml;
+package org.elasticsearch.client.ml;
 
-import org.elasticsearch.common.xcontent.ToXContent;
+import org.elasticsearch.client.ml.job.config.Job;
 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;
@@ -47,7 +46,7 @@ public Job getResponse() {
     }
 
     @Override
-    public XContentBuilder toXContent(XContentBuilder builder, ToXContent.Params params) throws IOException {
+    public XContentBuilder toXContent(XContentBuilder builder, Params params) throws IOException {
         job.toXContent(builder, params);
         return builder;
     }

diff --git a/...col/xpack/ml/datafeed/ChunkingConfig.java → ...ch/client/ml/datafeed/ChunkingConfig.java b/...col/xpack/ml/datafeed/ChunkingConfig.java → ...ch/client/ml/datafeed/ChunkingConfig.java
@@ -16,7 +16,7 @@
  * specific language governing permissions and limitations
  * under the License.
  */
-package org.elasticsearch.protocol.xpack.ml.datafeed;
+package org.elasticsearch.client.ml.datafeed;
 
 import org.elasticsearch.common.Nullable;
 import org.elasticsearch.common.ParseField;

diff --git a/...col/xpack/ml/datafeed/DatafeedConfig.java → ...ch/client/ml/datafeed/DatafeedConfig.java b/...col/xpack/ml/datafeed/DatafeedConfig.java → ...ch/client/ml/datafeed/DatafeedConfig.java
@@ -16,8 +16,9 @@
  * specific language governing permissions and limitations
  * under the License.
  */
-package org.elasticsearch.protocol.xpack.ml.datafeed;
+package org.elasticsearch.client.ml.datafeed;
 
+import org.elasticsearch.client.ml.job.config.Job;
 import org.elasticsearch.common.ParseField;
 import org.elasticsearch.common.unit.TimeValue;
 import org.elasticsearch.common.xcontent.ConstructingObjectParser;
@@ -27,7 +28,6 @@
 import org.elasticsearch.index.query.AbstractQueryBuilder;
 import org.elasticsearch.index.query.QueryBuilder;
 import org.elasticsearch.index.query.QueryBuilders;
-import org.elasticsearch.protocol.xpack.ml.job.config.Job;
 import org.elasticsearch.search.aggregations.AggregatorFactories;
 import org.elasticsearch.search.builder.SearchSourceBuilder;
 

diff --git a/...col/xpack/ml/datafeed/DatafeedUpdate.java → ...ch/client/ml/datafeed/DatafeedUpdate.java b/...col/xpack/ml/datafeed/DatafeedUpdate.java → ...ch/client/ml/datafeed/DatafeedUpdate.java
@@ -16,8 +16,9 @@
  * specific language governing permissions and limitations
  * under the License.
  */
-package org.elasticsearch.protocol.xpack.ml.datafeed;
+package org.elasticsearch.client.ml.datafeed;
 
+import org.elasticsearch.client.ml.job.config.Job;
 import org.elasticsearch.common.ParseField;
 import org.elasticsearch.common.unit.TimeValue;
 import org.elasticsearch.common.xcontent.ConstructingObjectParser;
@@ -26,7 +27,6 @@
 import org.elasticsearch.common.xcontent.XContentParser;
 import org.elasticsearch.index.query.AbstractQueryBuilder;
 import org.elasticsearch.index.query.QueryBuilder;
-import org.elasticsearch.protocol.xpack.ml.job.config.Job;
 import org.elasticsearch.search.aggregations.AggregatorFactories;
 import org.elasticsearch.search.builder.SearchSourceBuilder;
 

diff --git a/...l/xpack/ml/job/config/AnalysisConfig.java → .../client/ml/job/config/AnalysisConfig.java b/...l/xpack/ml/job/config/AnalysisConfig.java → .../client/ml/job/config/AnalysisConfig.java
@@ -16,7 +16,7 @@
  * specific language governing permissions and limitations
  * under the License.
  */
-package org.elasticsearch.protocol.xpack.ml.job.config;
+package org.elasticsearch.client.ml.job.config;
 
 import org.elasticsearch.common.ParseField;
 import org.elasticsearch.common.unit.TimeValue;

diff --git a/...l/xpack/ml/job/config/AnalysisLimits.java → .../client/ml/job/config/AnalysisLimits.java b/...l/xpack/ml/job/config/AnalysisLimits.java → .../client/ml/job/config/AnalysisLimits.java
@@ -16,7 +16,7 @@
  * specific language governing permissions and limitations
  * under the License.
  */
-package org.elasticsearch.protocol.xpack.ml.job.config;
+package org.elasticsearch.client.ml.job.config;
 
 import org.elasticsearch.common.Nullable;
 import org.elasticsearch.common.ParseField;

diff --git a/.../config/CategorizationAnalyzerConfig.java → .../config/CategorizationAnalyzerConfig.java b/.../config/CategorizationAnalyzerConfig.java → .../config/CategorizationAnalyzerConfig.java
@@ -16,7 +16,7 @@
  * specific language governing permissions and limitations
  * under the License.
  */
-package org.elasticsearch.protocol.xpack.ml.job.config;
+package org.elasticsearch.client.ml.job.config;
 
 import org.elasticsearch.common.ParseField;
 import org.elasticsearch.common.Strings;

diff --git a/.../xpack/ml/job/config/DataDescription.java → ...client/ml/job/config/DataDescription.java b/.../xpack/ml/job/config/DataDescription.java → ...client/ml/job/config/DataDescription.java
@@ -16,7 +16,7 @@
  * specific language governing permissions and limitations
  * under the License.
  */
-package org.elasticsearch.protocol.xpack.ml.job.config;
+package org.elasticsearch.client.ml.job.config;
 
 import org.elasticsearch.common.ParseField;
 import org.elasticsearch.common.xcontent.ObjectParser;

diff --git a/...ob/config/DefaultDetectorDescription.java → ...ob/config/DefaultDetectorDescription.java b/...ob/config/DefaultDetectorDescription.java → ...ob/config/DefaultDetectorDescription.java
@@ -16,7 +16,7 @@
  * specific language governing permissions and limitations
  * under the License.
  */
-package org.elasticsearch.protocol.xpack.ml.job.config;
+package org.elasticsearch.client.ml.job.config;
 
 import org.elasticsearch.common.Strings;
 

diff --git a/...ol/xpack/ml/job/config/DetectionRule.java → ...h/client/ml/job/config/DetectionRule.java b/...ol/xpack/ml/job/config/DetectionRule.java → ...h/client/ml/job/config/DetectionRule.java
@@ -16,7 +16,7 @@
  * specific language governing permissions and limitations
  * under the License.
  */
-package org.elasticsearch.protocol.xpack.ml.job.config;
+package org.elasticsearch.client.ml.job.config;
 
 import org.elasticsearch.common.ParseField;
 import org.elasticsearch.common.xcontent.ObjectParser;