Rest HL client: Add put watch action #32026

spinscale · 2018-07-13T08:22:38Z

To discuss: This implementation behaves like the current transport client, that you basically cannot configure a Watch POJO representation as an argument to the put watch API, but only a bytes reference. You can use the the WatchSourceBuilder from the org.elasticsearch.plugin:x-pack-core dependency to build watches.

This commit also changes the license type to trial, so that watcher is available in high level rest client tests.

/cc @hub-cap

Relates elastic#29827

elasticmachine · 2018-07-13T08:22:40Z

Pinging @elastic/es-core-infra

hub-cap · 2018-07-13T15:20:31Z

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

+
+        Request request = new Request(HttpPut.METHOD_NAME, endpoint);
+        Params params = new Params(request).withVersion(putWatchRequest.getVersion());
+        if (putWatchRequest.isActive() == false) {


since every one of the other xpack APIs will have this, maybe creating a method is worth it?

Disregard this comment. this is a feature of the watch being active, not the xpack plugin

hub-cap

Great progress on this! Its close to being done. A few comments inline.

hub-cap · 2018-07-13T17:56:31Z

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

+        }
+
+        {
+            BytesReference watch = new BytesArray("{ \n" +


why not pull this out of the {} so its reusable?

this way the BytesReference class is seen in the documentation to make the user aware what needs to be used, thus inside of the static block at the top

hub-cap · 2018-07-13T18:14:53Z

docs/java-rest/high-level/miscellaneous/x-pack-watcher-put-watch.asciidoc

@@ -0,0 +1,55 @@
+[[java-rest-high-x-pack-watcher-put-watch]]


Im not sure i like this being in the misc folder. Ill get clarification on where it should go.

cc @debadair @Sue-Gallagher

after a chat w @debadair , lets go ahead and create a watcher/ folder and put all the watcher docs into that.

I created an x-pack folder and inside of that a watcher folder as I assume both of them will grow soonish?

yup, or you will end up with conflicts as someone else will also be doing this :)

Actually as per the chat w/ @debadair , it was to not create an xpack/ folder, just a watcher/ folder

hub-cap · 2018-07-13T18:15:40Z

.../test/java/org/elasticsearch/xpack/watcher/transport/action/WatchRequestValidationTests.java

@@ -69,7 +69,8 @@ public void testDeleteWatchNullId() {
    }

    public void testPutWatchInvalidWatchId() {
-        ActionRequestValidationException e = new PutWatchRequest("id with whitespaces", BytesArray.EMPTY, XContentType.JSON).validate();
+        ActionRequestValidationException e =


unneeded change

hub-cap · 2018-07-13T18:17:22Z

x-pack/protocol/src/main/java/org/elasticsearch/protocol/xpack/watcher/PutWatchRequest.java

@@ -129,7 +140,7 @@ public ActionRequestValidationException validate() {
        ActionRequestValidationException validationException = null;
        if (id == null) {
            validationException = ValidateActions.addValidationError("watch id is missing", validationException);
-        } else if (WatcherUtils.isValidId(id) == false) {
+        } else if (isValidId(id) == false) {


does "isValidId" do more than just check whitespace? if not should we rename it? it seems odd that you can check for a valid id and know that the case for failure was whitespace here, given that its a blackbox checking for whatever we define as "validity"

see below, this also checks for != null and non-emptiness...

can we clean up the validation string to say "or is empty" so that passing "" in does not validate to "sorry your watch ID contains whitespace"

I'd do that in a follow up PR

hub-cap · 2018-07-13T18:19:18Z

x-pack/protocol/src/main/java/org/elasticsearch/protocol/xpack/watcher/PutWatchResponse.java

+
+import java.io.IOException;
+
+public class PutWatchResponse extends ActionResponse implements ToXContentObject {


pls add a AbstractXContentTestCase test case for this class.

done. I implemented equals and hashCode in the PutWatchResponse other classes are overriding the test method. I am not sure what the correct way here is, but I think we should make it consistent. Happy to get any advice.

It looks like this test case comes from cd3d9c9, which in the commit message states that if its hard to write the eq/hashcode methods, then you can override the equality tests. I think if its easy (as it is in this case), then the right thing to do is to add them in the class itself, which is what you did. So 👍

…ction

…in the x-pack directory

spinscale

took care of all comments, left a question regarding the AbstractXContentTestCase test

spinscale · 2018-07-16T08:46:29Z

.../test/java/org/elasticsearch/xpack/watcher/transport/action/WatchRequestValidationTests.java

@@ -69,7 +69,8 @@ public void testDeleteWatchNullId() {
    }

    public void testPutWatchInvalidWatchId() {
-        ActionRequestValidationException e = new PutWatchRequest("id with whitespaces", BytesArray.EMPTY, XContentType.JSON).validate();
+        ActionRequestValidationException e =


spinscale · 2018-07-16T08:47:29Z

x-pack/protocol/src/main/java/org/elasticsearch/protocol/xpack/watcher/PutWatchResponse.java

+
+import java.io.IOException;
+
+public class PutWatchResponse extends ActionResponse implements ToXContentObject {


done. I implemented equals and hashCode in the PutWatchResponse other classes are overriding the test method. I am not sure what the correct way here is, but I think we should make it consistent. Happy to get any advice.

hub-cap

LGTM

…ction

Relates elastic#29827 This implementation behaves like the current transport client, that you basically cannot configure a Watch POJO representation as an argument to the put watch API, but only a bytes reference. You can use the the `WatchSourceBuilder` from the `org.elasticsearch.plugin:x-pack-core` dependency to build watches. This commit also changes the license type to trial, so that watcher is available in high level rest client tests.

@return

* master: Painless: Simplify Naming in Lookup Package (#32177) Handle missing values in painless (#32207) add support for write index resolution when creating/updating documents (#31520) ECS Task IAM profile credentials ignored in repository-s3 plugin (#31864) Remove indication of future multi-homing support (#32187) Rest test - allow for snapshots to take 0 milliseconds Make x-pack-core generate a pom file Rest HL client: Add put watch action (#32026) Build: Remove pom generation for plugin zip files (#32180) Fix comments causing errors with Java 11 Fix rollup on date fields that don't support epoch_millis (#31890) Detect and prevent configuration that triggers a Gradle bug (#31912) [test] port linux package packaging tests (#31943) Revert "Introduce a Hashing Processor (#31087)" (#32178) Remove empty @return from JavaDoc Adjust SSLDriver behavior for JDK11 changes (#32145) [test] use randomized runner in packaging tests (#32109) Add support for field aliases. (#32172) Painless: Fix caching bug and clean up addPainlessClass. (#32142) Call setReferences() on custom referring tokenfilters in _analyze (#32157) Fix BwC Tests looking for UUID Pre 6.4 (#32158) Improve docs for search preferences (#32159) use before instead of onOrBefore Add more contexts to painless execute api (#30511) Add EC2 credential test for repository-s3 (#31918) A replica can be promoted and started in one cluster state update (#32042) Fix Java 11 javadoc compile problem Fix CP for namingConventions when gradle home has spaces (#31914) Fix `range` queries on `_type` field for singe type indices (#31756) [DOCS] Update TLS on Docker for 6.3 (#32114) ESIndexLevelReplicationTestCase doesn't support replicated failures but it's good to know what they are Remove versionType from translog (#31945) Switch distribution to new style Requests (#30595) Build: Skip jar tests if jar disabled Painless: Add PainlessClassBuilder (#32141) Build: Make additional test deps of check (#32015) Disable C2 from using AVX-512 on JDK 10 (#32138) Build: Move shadow customizations into common code (#32014) Painless: Fix Bug with Duplicate PainlessClasses (#32110) Remove empty @param from Javadoc Re-disable packaging tests on suse boxes Docs: Fix missing example script quote (#32010) [ML] Wait for aliases in multi-node tests (#32086) [ML] Move analyzer dependencies out of categorization config (#32123) Ensure to release translog snapshot in primary-replica resync (#32045) Handle TokenizerFactory TODOs (#32063) Relax TermVectors API to work with textual fields other than TextFieldType (#31915) Updates the build to gradle 4.9 (#32087) Mute :qa:mixed-cluster indices.stats/10_index/Index - all’ Check that client methods match API defined in the REST spec (#31825) Enable testing in FIPS140 JVM (#31666) Fix put mappings java API documentation (#31955) Add exclusion option to `keep_types` token filter (#32012) [Test] Modify assert statement for ssl handshake (#32072)

Relates #29827 This implementation behaves like the current transport client, that you basically cannot configure a Watch POJO representation as an argument to the put watch API, but only a bytes reference. You can use the the `WatchSourceBuilder` from the `org.elasticsearch.plugin:x-pack-core` dependency to build watches. This commit also changes the license type to trial, so that watcher is available in high level rest client tests.

* 6.x: Security: revert to old way of merging automata (#32254) Fix a test bug in RangeQueryBuilderTests introduced in the field aliases backport. Introduce Application Privileges with support for Kibana RBAC (#32309) Undo a debugging change that snuck in during the field aliases merge. [test] port linux package packaging tests (#31943) Painless: Update More Methods to New Naming Scheme (#32305) Tribe: Add error with secure settings copied to tribe (#32298) Add V_6_3_3 version constant Add ERR to ranking evaluation documentation (#32314) [DOCS] Added link to 6.3.2 RNs [DOCS] Updates 6.3.2 release notes with PRs from ml-cpp repo (#32334) [Kerberos] Add Kerberos authentication support (#32263) [ML] Extract persistent task methods from MlMetadata (#32319) Backport - Add Snapshots Status API to High Level Rest Client (#32295) Make release notes ignore the `>test-failure` label. (#31309) [DOCS] Adds release highlights for search for 6.4 (#32095) Allow Integ Tests to run in a FIPS-140 JVM (#32316) Add support for field aliases to 6.x. (#32184) Register ERR metric with NamedXContentRegistry (#32320) fixes broken build for third-party-tests (#32315) Relates #31918 / Closes infra/issues/6085 [DOCS] Rollup Caps API incorrectly mentions GET Jobs API (#32280) Rest HL client: Add put watch action (#32026) (#32191) Add WeightedAvg metric aggregation (#31037) Consistent encoder names (#29492) Switch monitoring to new style Requests (#32255) specify subdirs of lib, bin, modules in package (#32253) Rename ranking evaluation `quality_level` to `metric_score` (#32168) Add new permission for JDK11 to load JAAS libraries (#32132) Switch x-pack:core to new style Requests (#32252) Watcher: Store username on watch execution (#31873) Silence SSL reload test that fails on JDK 11 Painless: Clean up add methods in PainlessLookup (#32258) CCE when re-throwing "shard not available" exception in TransportShardMultiGetAction (#32185) Fail shard if IndexShard#storeStats runs into an IOException (#32241) Fix `range` queries on `_type` field for singe type indices (#31756) (#32161) AwaitsFix RecoveryIT#testHistoryUUIDIsGenerated Add new fields to monitoring template for Beats state (#32085) (#32273) [TEST] improve REST high-level client naming conventions check (#32244) Check that client methods match API defined in the REST spec (#31825)

Rest HL client: Add put watch action

b23d5eb

Relates elastic#29827

spinscale added review labels Jul 13, 2018

remove annotation

0897230

hub-cap reviewed Jul 13, 2018

View reviewed changes

hub-cap suggested changes Jul 13, 2018

View reviewed changes

spinscale added 4 commits July 16, 2018 10:02

Merge branch 'master' into 1807-highlevel-rest-client-add-put-watch-a…

ecbb75f

…ction

review comment: create x-pack/watcher docs dir, move usage/info APIs …

152c01e

…in the x-pack directory

review comment: remove unneeded change

7dc5088

add "PutWatchResponseTests" test case

b3f622e

spinscale commented Jul 16, 2018

View reviewed changes

specify correct dependency in documentation

b5391a6

hub-cap approved these changes Jul 16, 2018

View reviewed changes

spinscale added 3 commits July 17, 2018 08:42

Merge branch 'master' into 1807-highlevel-rest-client-add-put-watch-a…

f5e99bf

…ction

Merge branch 'master' into 1807-highlevel-rest-client-add-put-watch-a…

42d6189

…ction

Merge branch 'master' into 1807-highlevel-rest-client-add-put-watch-a…

88f173f

…ction

spinscale merged commit 202894b into elastic:master Jul 19, 2018

tomcallahan added v7.0.0 backport pending v6.4.0 labels Jul 20, 2018

elasticmachine mentioned this pull request Jul 24, 2018

Java high-level REST client completeness for xpack APIs #29827

Closed

98 tasks

spinscale added >enhancement and removed backport pending labels Aug 20, 2018

colings86 added v7.0.0-beta1 and removed v7.0.0 labels Feb 7, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Rest HL client: Add put watch action #32026

Rest HL client: Add put watch action #32026

spinscale commented Jul 13, 2018

elasticmachine commented Jul 13, 2018

hub-cap Jul 13, 2018 •

edited

Loading

hub-cap Jul 13, 2018

hub-cap left a comment

hub-cap Jul 13, 2018

spinscale Jul 16, 2018

hub-cap Jul 13, 2018

hub-cap Jul 13, 2018

hub-cap Jul 13, 2018

spinscale Jul 16, 2018

hub-cap Jul 16, 2018

hub-cap Jul 16, 2018

hub-cap Jul 13, 2018

spinscale Jul 16, 2018

hub-cap Jul 13, 2018

spinscale Jul 16, 2018

hub-cap Jul 16, 2018

spinscale Jul 17, 2018

hub-cap Jul 13, 2018

spinscale Jul 16, 2018

hub-cap Jul 16, 2018

spinscale left a comment

spinscale Jul 16, 2018

spinscale Jul 16, 2018

hub-cap left a comment


		import java.io.IOException;

		public class PutWatchResponse extends ActionResponse implements ToXContentObject {

Rest HL client: Add put watch action #32026

Rest HL client: Add put watch action #32026

Conversation

spinscale commented Jul 13, 2018

elasticmachine commented Jul 13, 2018

hub-cap Jul 13, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

hub-cap left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

spinscale left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

hub-cap left a comment

Choose a reason for hiding this comment

hub-cap Jul 13, 2018 •

edited

Loading