honeymoose
/
OpenSearch
mirror of https://github.com/honeymoose/OpenSearch.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
OpenSearch/docs/java-rest/high-level/ml/get-job-stats.asciidoc

40 lines
1.5 KiB
Plaintext
Raw Normal View History

Feature/hlrc ml docs cleanup (#34316) * HLRC: ML Add preview datafeed api * Changing deprecation handling for parser * Removing some duplication in docs, will address other APIs in another PR * HLRC: ML Cleanup docs * updating get datafeed stats docs
2018-10-05 11:45:46 -04:00
--
:api: get-job-stats
:request: GetJobStatsRequest
:response: GetJobStatsResponse
--
[DOCS] Adds missing icons to ML HLRC APIs (#46515)
2019-09-10 11:26:56 -04:00
[role="xpack"]
Feature/hlrc ml docs cleanup (#34316) * HLRC: ML Add preview datafeed api * Changing deprecation handling for parser * Removing some duplication in docs, will address other APIs in another PR * HLRC: ML Cleanup docs * updating get datafeed stats docs
2018-10-05 11:45:46 -04:00
[id="{upid}-{api}"]
[DOCS] Updates terms in machine learning get APIs (#44986)
2019-07-30 13:52:23 -04:00
=== Get {anomaly-job} stats API
HLRC: Adding ML Job stats (#33183) * HLRC: Adding pojos for get job stats HLRC: Adding pojos for job stats request * HLRC: Adding job stats pojos * HLRC: ML job stats * Minor syntax changes and adding license headers * minor comment change * Moving to client package, minor changes * Addressing PR comments * removing bad sleep * addressing minor comment around test methods * adding toplevel random fields for tests * addressing minor review comments
2018-09-01 14:32:18 -04:00
[DOCS] Updates terms in machine learning get APIs (#44986)
2019-07-30 13:52:23 -04:00
Retrieves statistics for any number of {anomaly-jobs} in the cluster.
It accepts a +{request}+ object and responds with a +{response}+ object.
HLRC: Adding ML Job stats (#33183) * HLRC: Adding pojos for get job stats HLRC: Adding pojos for job stats request * HLRC: Adding job stats pojos * HLRC: ML job stats * Minor syntax changes and adding license headers * minor comment change * Moving to client package, minor changes * Addressing PR comments * removing bad sleep * addressing minor comment around test methods * adding toplevel random fields for tests * addressing minor review comments
2018-09-01 14:32:18 -04:00
Feature/hlrc ml docs cleanup (#34316) * HLRC: ML Add preview datafeed api * Changing deprecation handling for parser * Removing some duplication in docs, will address other APIs in another PR * HLRC: ML Cleanup docs * updating get datafeed stats docs
2018-10-05 11:45:46 -04:00
[id="{upid}-{api}-request"]
[DOCS] Fix titles for ML APIs (#63152) (#63207)
2020-10-02 17:01:01 -04:00
==== Get {anomaly-job} stats request
HLRC: Adding ML Job stats (#33183) * HLRC: Adding pojos for get job stats HLRC: Adding pojos for job stats request * HLRC: Adding job stats pojos * HLRC: ML job stats * Minor syntax changes and adding license headers * minor comment change * Moving to client package, minor changes * Addressing PR comments * removing bad sleep * addressing minor comment around test methods * adding toplevel random fields for tests * addressing minor review comments
2018-09-01 14:32:18 -04:00
A `GetJobsStatsRequest` object can have any number of `jobId`
entries. However, they all must be non-null. An empty list is the same as
[DOCS] Updates terms in machine learning get APIs (#44986)
2019-07-30 13:52:23 -04:00
requesting statistics for all {anomaly-jobs}.
HLRC: Adding ML Job stats (#33183) * HLRC: Adding pojos for get job stats HLRC: Adding pojos for job stats request * HLRC: Adding job stats pojos * HLRC: ML job stats * Minor syntax changes and adding license headers * minor comment change * Moving to client package, minor changes * Addressing PR comments * removing bad sleep * addressing minor comment around test methods * adding toplevel random fields for tests * addressing minor review comments
2018-09-01 14:32:18 -04:00
["source","java",subs="attributes,callouts,macros"]
--------------------------------------------------
Feature/hlrc ml docs cleanup (#34316) * HLRC: ML Add preview datafeed api * Changing deprecation handling for parser * Removing some duplication in docs, will address other APIs in another PR * HLRC: ML Cleanup docs * updating get datafeed stats docs
2018-10-05 11:45:46 -04:00
include-tagged::{doc-tests-file}[{api}-request]
HLRC: Adding ML Job stats (#33183) * HLRC: Adding pojos for get job stats HLRC: Adding pojos for job stats request * HLRC: Adding job stats pojos * HLRC: ML job stats * Minor syntax changes and adding license headers * minor comment change * Moving to client package, minor changes * Addressing PR comments * removing bad sleep * addressing minor comment around test methods * adding toplevel random fields for tests * addressing minor review comments
2018-09-01 14:32:18 -04:00
--------------------------------------------------
[DOCS] Updates terms in machine learning get APIs (#44986)
2019-07-30 13:52:23 -04:00
<1> Constructing a new request referencing existing `jobIds`. It can contain
wildcards.
<2> Whether to ignore if a wildcard expression matches no {anomaly-jobs}.
(This includes `_all` string or when no jobs have been specified).
HLRC: Adding ML Job stats (#33183) * HLRC: Adding pojos for get job stats HLRC: Adding pojos for job stats request * HLRC: Adding job stats pojos * HLRC: ML job stats * Minor syntax changes and adding license headers * minor comment change * Moving to client package, minor changes * Addressing PR comments * removing bad sleep * addressing minor comment around test methods * adding toplevel random fields for tests * addressing minor review comments
2018-09-01 14:32:18 -04:00
Feature/hlrc ml docs cleanup (#34316) * HLRC: ML Add preview datafeed api * Changing deprecation handling for parser * Removing some duplication in docs, will address other APIs in another PR * HLRC: ML Cleanup docs * updating get datafeed stats docs
2018-10-05 11:45:46 -04:00
include::../execution.asciidoc[]
HLRC: Adding ML Job stats (#33183) * HLRC: Adding pojos for get job stats HLRC: Adding pojos for job stats request * HLRC: Adding job stats pojos * HLRC: ML job stats * Minor syntax changes and adding license headers * minor comment change * Moving to client package, minor changes * Addressing PR comments * removing bad sleep * addressing minor comment around test methods * adding toplevel random fields for tests * addressing minor review comments
2018-09-01 14:32:18 -04:00
Feature/hlrc ml docs cleanup (#34316) * HLRC: ML Add preview datafeed api * Changing deprecation handling for parser * Removing some duplication in docs, will address other APIs in another PR * HLRC: ML Cleanup docs * updating get datafeed stats docs
2018-10-05 11:45:46 -04:00
[id="{upid}-{api}-response"]
[DOCS] Fix titles for ML APIs (#63152) (#63207)
2020-10-02 17:01:01 -04:00
==== Get {anomaly-job} stats response
Feature/hlrc ml docs cleanup (#34316) * HLRC: ML Add preview datafeed api * Changing deprecation handling for parser * Removing some duplication in docs, will address other APIs in another PR * HLRC: ML Cleanup docs * updating get datafeed stats docs
2018-10-05 11:45:46 -04:00
The returned +{response}+ contains the requested job statistics:
HLRC: Adding ML Job stats (#33183) * HLRC: Adding pojos for get job stats HLRC: Adding pojos for job stats request * HLRC: Adding job stats pojos * HLRC: ML job stats * Minor syntax changes and adding license headers * minor comment change * Moving to client package, minor changes * Addressing PR comments * removing bad sleep * addressing minor comment around test methods * adding toplevel random fields for tests * addressing minor review comments
2018-09-01 14:32:18 -04:00
["source","java",subs="attributes,callouts,macros"]
--------------------------------------------------
Feature/hlrc ml docs cleanup (#34316) * HLRC: ML Add preview datafeed api * Changing deprecation handling for parser * Removing some duplication in docs, will address other APIs in another PR * HLRC: ML Cleanup docs * updating get datafeed stats docs
2018-10-05 11:45:46 -04:00
include-tagged::{doc-tests-file}[{api}-response]
HLRC: Adding ML Job stats (#33183) * HLRC: Adding pojos for get job stats HLRC: Adding pojos for job stats request * HLRC: Adding job stats pojos * HLRC: ML job stats * Minor syntax changes and adding license headers * minor comment change * Moving to client package, minor changes * Addressing PR comments * removing bad sleep * addressing minor comment around test methods * adding toplevel random fields for tests * addressing minor review comments
2018-09-01 14:32:18 -04:00
--------------------------------------------------
[DOCS] Updates terms in machine learning get APIs (#44986)
2019-07-30 13:52:23 -04:00
<1> `getCount()` indicates the number of jobs statistics found.
<2> `getJobStats()` is the collection of {ml} `JobStats` objects found.