HLRC: ML Add preview datafeed api#34284
Conversation
|
Pinging @elastic/ml-core |
|
Pinging @elastic/es-core-infra |
droberts195
left a comment
There was a problem hiding this comment.
I left a couple of nits on the docs and also something worth investigating for whether we can reduce the duplication in the docs. If it is possible to reduce the duplication and you'd rather leave that for a followup PR that applies to change to all our docs then that's fine.
| -------------------------------------------------- | ||
| include-tagged::{doc-tests}/MlClientDocumentationIT.java[x-pack-ml-preview-datafeed-execute] | ||
| -------------------------------------------------- | ||
| <1> The raw BytesReference of the data preview |
There was a problem hiding this comment.
BytesReference would look better in backticks: BytesReference
| include-tagged::{doc-tests}/MlClientDocumentationIT.java[x-pack-ml-preview-datafeed-execute] | ||
| -------------------------------------------------- | ||
| <1> The raw BytesReference of the data preview | ||
| <2> A List of Map<String,Object> that represents the previewed data |
There was a problem hiding this comment.
Similarly List and Map<String, Object> would look better in backticks.
Also, I think we usually put a space after the comma in Map<String, Object>. It's not so important for private code but it's nice to make the public docs completely consistent.
| include-tagged::{doc-tests}/MlClientDocumentationIT.java[x-pack-ml-preview-datafeed-listener] | ||
| -------------------------------------------------- | ||
| <1> `onResponse` is called back when the action is completed successfully | ||
| <2> `onFailure` is called back when some unexpected error occurs |
There was a problem hiding this comment.
Is it possible that we can reuse the stuff that was added in #34125 to cut out the duplication in this async section?
There was a problem hiding this comment.
I did not know that was a thing! will update this PR and my other HLRC one pronto
* HLRC: ML Add preview datafeed api * Changing deprecation handling for parser * Removing some duplication in docs, will address other APIs in another PR
* master: (25 commits) HLRC: ML Adding get datafeed stats API (elastic#34271) Small fixes to the HLRC watcher documentation. (elastic#34306) Tasks: Document that status is not semvered (elastic#34270) HLRC: ML Add preview datafeed api (elastic#34284) [CI] Fix bogus ScheduleWithFixedDelayTests.testRunnableRunsAtMostOnceAfterCancellation Fix error in documentation for activete watch SCRIPTING: Terms set query expression (elastic#33856) Logging: Drop remaining Settings log ctor (elastic#34149) [ML] Remove unused last_data_time member from Job (elastic#34262) Docs: Allow skipping response assertions (elastic#34240) HLRC: Add activate watch action (elastic#33988) [Security] Multi Index Expression alias wildcard exclusion (elastic#34144) [ML] Label anomalies with multi_bucket_impact (elastic#34233) Document smtp.ssl.trust configuration option (elastic#34275) Support PKCS#11 tokens as keystores and truststores (elastic#34063) Fix sporadic failure in NestedObjectMapperTests [Authz] Allow update settings action for system user (elastic#34030) Replace version with reader cache key in IndicesRequestCache (elastic#34189) [TESTS] Set SO_LINGER and SO_REUSEADDR on the mock socket (elastic#34211) Security: upgrade unboundid ldapsdk to 4.0.8 (elastic#34247) ...
* rename-ccr-stats: (25 commits) HLRC: ML Adding get datafeed stats API (elastic#34271) Small fixes to the HLRC watcher documentation. (elastic#34306) Tasks: Document that status is not semvered (elastic#34270) HLRC: ML Add preview datafeed api (elastic#34284) [CI] Fix bogus ScheduleWithFixedDelayTests.testRunnableRunsAtMostOnceAfterCancellation Fix error in documentation for activete watch SCRIPTING: Terms set query expression (elastic#33856) Logging: Drop remaining Settings log ctor (elastic#34149) [ML] Remove unused last_data_time member from Job (elastic#34262) Docs: Allow skipping response assertions (elastic#34240) HLRC: Add activate watch action (elastic#33988) [Security] Multi Index Expression alias wildcard exclusion (elastic#34144) [ML] Label anomalies with multi_bucket_impact (elastic#34233) Document smtp.ssl.trust configuration option (elastic#34275) Support PKCS#11 tokens as keystores and truststores (elastic#34063) Fix sporadic failure in NestedObjectMapperTests [Authz] Allow update settings action for system user (elastic#34030) Replace version with reader cache key in IndicesRequestCache (elastic#34189) [TESTS] Set SO_LINGER and SO_REUSEADDR on the mock socket (elastic#34211) Security: upgrade unboundid ldapsdk to 4.0.8 (elastic#34247) ...
* HLRC: ML Add preview datafeed api * Changing deprecation handling for parser * Removing some duplication in docs, will address other APIs in another PR
This adds the ML preview datafeed API to the HLRC
Relates to #29827