HLRC: Adding ML Job stats

client/rest-high-level/src/main/java/org/elasticsearch/client/MachineLearningClient.java

@@ -292,7 +292,7 @@ public void getBucketsAsync(GetBucketsRequest request, RequestOptions options, A
      }
 
     /**
-     * Gets one or more Machine Learning job statistics.
+     * Gets usage statistics for one or more Machine Learning jobs
      *
      * <p>
      *     For additional info

client/rest-high-level/src/main/java/org/elasticsearch/client/ml/GetJobsStatsRequest.java

@@ -20,6 +20,7 @@
 
 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.xcontent.ConstructingObjectParser;
@@ -35,25 +36,23 @@
 
 
 /**
- * Request object to get {@link org.elasticsearch.client.ml.job.stats.JobStats} objects with the matching `jobId`s
+ * Request object to get {@link org.elasticsearch.client.ml.job.stats.JobStats} by their respective jobIds
  *
  * `_all` explicitly gets all the jobs' statistics in the cluster
  * An empty request (no `jobId`s) implicitly gets all the jobs' statistics in the cluster
  */
 public class GetJobsStatsRequest extends ActionRequest implements ToXContentObject {
 
-    public static final ParseField JOB_ID = new ParseField("job_id");
     public static final ParseField ALLOW_NO_JOBS = new ParseField("allow_no_jobs");
 
     @SuppressWarnings("unchecked")
     public static final ConstructingObjectParser<GetJobsStatsRequest, Void> PARSER = new ConstructingObjectParser<>(
-        "get_jobs_stats_request",
-        true, a -> new GetJobsStatsRequest((List<String>) a[0]));
+        "get_jobs_stats_request", a -> new GetJobsStatsRequest((List<String>) a[0]));
 
     static {
         PARSER.declareField(ConstructingObjectParser.constructorArg(),
             p -> Arrays.asList(Strings.commaDelimitedListToStringArray(p.text())),
-            JOB_ID, ObjectParser.ValueType.STRING_ARRAY);
+            Job.ID, ObjectParser.ValueType.STRING_ARRAY);
         PARSER.declareBoolean(GetJobsStatsRequest::setAllowNoJobs, ALLOW_NO_JOBS);
     }
 
@@ -67,7 +66,7 @@ public class GetJobsStatsRequest extends ActionRequest implements ToXContentObje
      *
      * @return a {@link GetJobsStatsRequest} for all existing jobs
      */
-    public static GetJobsStatsRequest allJobsStats(){
+    public static GetJobsStatsRequest getAllJobsStatsRequest(){
         return new GetJobsStatsRequest(ALL_JOBS);
     }
 
@@ -137,7 +136,7 @@ public ActionRequestValidationException validate() {
     @Override
     public XContentBuilder toXContent(XContentBuilder builder, Params params) throws IOException {
         builder.startObject();
-        builder.field(JOB_ID.getPreferredName(), Strings.collectionToCommaDelimitedString(jobIds));
+        builder.field(Job.ID.getPreferredName(), Strings.collectionToCommaDelimitedString(jobIds));
         if (allowNoJobs != null) {
             builder.field(ALLOW_NO_JOBS.getPreferredName(), allowNoJobs);
         }

client/rest-high-level/src/main/java/org/elasticsearch/client/ml/GetJobsStatsResponse.java

@@ -54,7 +54,7 @@ public class GetJobsStatsResponse extends AbstractResultResponse<JobStats>  {
     /**
      * The collection of {@link JobStats} objects found in the query
      */
-    public List<JobStats> jobs() {
+    public List<JobStats> jobStats() {
         return results;
     }
 

client/rest-high-level/src/main/java/org/elasticsearch/client/ml/job/stats/ForecastStats.java

@@ -37,10 +37,10 @@ public class ForecastStats implements ToXContentObject {
 
     public static final ParseField TOTAL = new ParseField("total");
     public static final ParseField FORECASTED_JOBS = new ParseField("forecasted_jobs");
-    public static final ParseField MEMORY = new ParseField("memory_bytes");
-    public static final ParseField RUNTIME = new ParseField("processing_time_ms");
+    public static final ParseField MEMORY_BYTES = new ParseField("memory_bytes");
+    public static final ParseField PROCESSING_TIME_MS = new ParseField("processing_time_ms");
     public static final ParseField RECORDS = new ParseField("records");
-    public static final ParseField STATUSES = new ParseField("status");
+    public static final ParseField STATUS = new ParseField("status");
 
     @SuppressWarnings("unchecked")
     public static final ConstructingObjectParser<ForecastStats, Void> PARSER =
@@ -58,19 +58,19 @@ public class ForecastStats implements ToXContentObject {
 
     static {
         PARSER.declareLong(ConstructingObjectParser.constructorArg(), TOTAL);
-        PARSER.declareObject(ConstructingObjectParser.optionalConstructorArg(), SimpleStats.PARSER, MEMORY);
+        PARSER.declareObject(ConstructingObjectParser.optionalConstructorArg(), SimpleStats.PARSER, MEMORY_BYTES);
         PARSER.declareObject(ConstructingObjectParser.optionalConstructorArg(), SimpleStats.PARSER, RECORDS);
-        PARSER.declareObject(ConstructingObjectParser.optionalConstructorArg(), SimpleStats.PARSER, RUNTIME);
+        PARSER.declareObject(ConstructingObjectParser.optionalConstructorArg(), SimpleStats.PARSER, PROCESSING_TIME_MS);
         PARSER.declareField(ConstructingObjectParser.optionalConstructorArg(),
             p -> {
                 Map<String, Long> counts = new HashMap<>();
                 p.map().forEach((key, value) -> counts.put(key, ((Number)value).longValue()));
                 return counts;
-            }, STATUSES, ObjectParser.ValueType.OBJECT);
+            }, STATUS, ObjectParser.ValueType.OBJECT);
     }
 
-    private long total;
-    private long forecastedJobs;
+    private final long total;
+    private final long forecastedJobs;
     private SimpleStats memoryStats;
     private SimpleStats recordStats;
     private SimpleStats runtimeStats;
@@ -140,10 +140,10 @@ public XContentBuilder toXContent(XContentBuilder builder, Params params) throws
         builder.field(FORECASTED_JOBS.getPreferredName(), forecastedJobs);
 
         if (total > 0) {
-            builder.field(MEMORY.getPreferredName(), memoryStats);
+            builder.field(MEMORY_BYTES.getPreferredName(), memoryStats);
             builder.field(RECORDS.getPreferredName(), recordStats);
-            builder.field(RUNTIME.getPreferredName(), runtimeStats);
-            builder.field(STATUSES.getPreferredName(), statusCounts);
+            builder.field(PROCESSING_TIME_MS.getPreferredName(), runtimeStats);
+            builder.field(STATUS.getPreferredName(), statusCounts);
         }
         return builder.endObject();
     }

client/rest-high-level/src/main/java/org/elasticsearch/client/ml/job/stats/JobStats.java

@@ -91,13 +91,13 @@ public class JobStats implements ToXContentObject {
 
 
     private final String jobId;
-    private DataCounts dataCounts;
-    private JobState state;
-    private ModelSizeStats modelSizeStats;
-    private ForecastStats forecastStats;
-    private NodeAttributes node;
-    private String assignmentExplanation;
-    private TimeValue openTime;
+    private final DataCounts dataCounts;
+    private final JobState state;
+    private final ModelSizeStats modelSizeStats;
+    private final ForecastStats forecastStats;
+    private final NodeAttributes node;
+    private final String assignmentExplanation;
+    private final TimeValue openTime;
 
     JobStats(String jobId, DataCounts dataCounts, JobState state, @Nullable ModelSizeStats modelSizeStats,
                     @Nullable ForecastStats forecastStats, @Nullable NodeAttributes node,

client/rest-high-level/src/main/java/org/elasticsearch/client/ml/job/stats/SimpleStats.java

@@ -53,10 +53,10 @@ public class SimpleStats implements ToXContentObject {
         PARSER.declareDouble(ConstructingObjectParser.constructorArg(), AVG);
     }
 
-    private double total;
-    private double min;
-    private double max;
-    private double avg;
+    private final double total;
+    private final double min;
+    private final double max;
+    private final double avg;
 
     SimpleStats(double total, double min, double max, double avg) {
         this.total = total;

client/rest-high-level/src/test/java/org/elasticsearch/client/MachineLearningIT.java

@@ -163,9 +163,9 @@ public void testGetJobsStats() throws Exception {
         GetJobsStatsResponse response = execute(request, machineLearningClient::getJobStats, machineLearningClient::getJobStatsAsync);
 
         assertEquals(2, response.count());
-        assertThat(response.jobs(), hasSize(2));
-        assertThat(response.jobs().stream().map(JobStats::getJobId).collect(Collectors.toList()), containsInAnyOrder(jobId1, jobId2));
-        for (JobStats stats : response.jobs()) {
+        assertThat(response.jobStats(), hasSize(2));
+        assertThat(response.jobStats().stream().map(JobStats::getJobId).collect(Collectors.toList()), containsInAnyOrder(jobId1, jobId2));
+        for (JobStats stats : response.jobStats()) {
             if (stats.getJobId().equals(jobId1)) {
                 assertEquals(JobState.OPENED, stats.getState());
             } else {
@@ -174,26 +174,26 @@ public void testGetJobsStats() throws Exception {
         }
 
         // Test getting all explicitly
-        request = GetJobsStatsRequest.allJobsStats();
+        request = GetJobsStatsRequest.getAllJobsStatsRequest();
         response = execute(request, machineLearningClient::getJobStats, machineLearningClient::getJobStatsAsync);
 
         assertTrue(response.count() >= 2L);
-        assertTrue(response.jobs().size() >= 2L);
-        assertThat(response.jobs().stream().map(JobStats::getJobId).collect(Collectors.toList()), hasItems(jobId1, jobId2));
+        assertTrue(response.jobStats().size() >= 2L);
+        assertThat(response.jobStats().stream().map(JobStats::getJobId).collect(Collectors.toList()), hasItems(jobId1, jobId2));
 
         // Test getting all implicitly
         response = execute(new GetJobsStatsRequest(), machineLearningClient::getJobStats, machineLearningClient::getJobStatsAsync);
 
         assertTrue(response.count() >= 2L);
-        assertTrue(response.jobs().size() >= 2L);
-        assertThat(response.jobs().stream().map(JobStats::getJobId).collect(Collectors.toList()), hasItems(jobId1, jobId2));
+        assertTrue(response.jobStats().size() >= 2L);
+        assertThat(response.jobStats().stream().map(JobStats::getJobId).collect(Collectors.toList()), hasItems(jobId1, jobId2));
 
         // Test getting all with wildcard
         request = new GetJobsStatsRequest("ml-get-job-stats-test-id-*");
         response = execute(request, machineLearningClient::getJobStats, machineLearningClient::getJobStatsAsync);
         assertTrue(response.count() >= 2L);
-        assertTrue(response.jobs().size() >= 2L);
-        assertThat(response.jobs().stream().map(JobStats::getJobId).collect(Collectors.toList()), hasItems(jobId1, jobId2));
+        assertTrue(response.jobStats().size() >= 2L);
+        assertThat(response.jobStats().stream().map(JobStats::getJobId).collect(Collectors.toList()), hasItems(jobId1, jobId2));
 
         // Test when allow_no_jobs is false
         final GetJobsStatsRequest erroredRequest = new GetJobsStatsRequest("jobs-that-do-not-exist*");

client/rest-high-level/src/test/java/org/elasticsearch/client/documentation/MlClientDocumentationIT.java

@@ -479,12 +479,12 @@ public void testGetJobStats() throws Exception {
             //tag::x-pack-ml-get-job-stats-execute
             GetJobsStatsResponse response = client.machineLearning().getJobStats(request, RequestOptions.DEFAULT);
             long numberOfJobsStats = response.count(); //<1>
-            List<JobStats> jobsStats = response.jobs(); //<2>
+            List<JobStats> jobsStats = response.jobStats(); //<2>
             //end::x-pack-ml-get-job-stats-execute
 
             assertEquals(2, response.count());
-            assertThat(response.jobs(), hasSize(2));
-            assertThat(response.jobs().stream().map(JobStats::getJobId).collect(Collectors.toList()),
+            assertThat(response.jobStats(), hasSize(2));
+            assertThat(response.jobStats().stream().map(JobStats::getJobId).collect(Collectors.toList()),
                 containsInAnyOrder(job.getId(), secondJob.getId()));
         }
         {

client/rest-high-level/src/test/java/org/elasticsearch/client/ml/GetJobsStatsRequestTests.java

@@ -28,7 +28,7 @@
 public class GetJobsStatsRequestTests extends AbstractXContentTestCase<GetJobsStatsRequest> {
 
     public void testAllJobsRequest() {
-        GetJobsStatsRequest request = GetJobsStatsRequest.allJobsStats();
+        GetJobsStatsRequest request = GetJobsStatsRequest.getAllJobsStatsRequest();
 
         assertEquals(request.getJobIds().size(), 1);
         assertEquals(request.getJobIds().get(0), "_all");
@@ -64,6 +64,6 @@ protected GetJobsStatsRequest doParseInstance(XContentParser parser) throws IOEx
 
     @Override
     protected boolean supportsUnknownFields() {
-        return true;
+        return false;
     }
 }

docs/java-rest/high-level/ml/get-job-stats.asciidoc

@@ -32,7 +32,7 @@ in the `RestHighLevelClient` object, accessed via the `machineLearningClient()`
 include-tagged::{doc-tests}/MlClientDocumentationIT.java[x-pack-ml-get-job-stats-execute]
 --------------------------------------------------
 <1> `getCount()` from the `GetJobsStatsResponse` indicates the number of jobs statistics found
-<2> `getJobs()` is the collection of {ml} `JobStats` objects found
+<2> `getJobStats()` is the collection of {ml} `JobStats` objects found
 
 [[java-rest-high-x-pack-ml-get-job-stats-execution-async]]
 ==== Asynchronous Execution