Add Get Snapshots High Level REST API #31537

Tim-Brooks · 2018-06-22T17:45:22Z

With this commit we add the get snapshots API to the Java high level
REST client.

elasticmachine · 2018-06-22T17:45:24Z

Pinging @elastic/es-core-infra

nik9000 · 2018-06-22T18:36:43Z

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

+
+    public void testGetAllSnapshots() {
+        Map<String, String> expectedParams = new HashMap<>();
+        String repository = randomIndicesNames(1, 1)[0];


Why not randomAlphaOfLength(5) or something?

That is just how all tests in the class does it? It labels it as an index in the name. Maybe for debugging?

Weird. When in Rome, I guess.

Its cuz when i did it, i had no idea that other thing existed. Would be a nice fixup PR after all these Snapshots related PRs got finished.

nik9000 · 2018-06-22T18:37:13Z

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

+            getSnapshotsRequest.ignoreUnavailable(true);
+            expectedParams.put("ignore_unavailable", Boolean.TRUE.toString());
+        }
+        if (randomBoolean() == false) {


I don't know that == false is worth it here.

nik9000 · 2018-06-22T18:38:27Z

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

+        if (randomBoolean()) {
+            request = new GetSnapshotsRequest(repository);
+        } else if (randomBoolean()) {
+            request = new GetSnapshotsRequest(repository, Collections.singletonList("_all").toArray(new String[0]));


Why not new String[] {"_all"}?

nik9000 · 2018-06-22T18:38:56Z

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

+            request = new GetSnapshotsRequest(repository, Collections.singletonList("_all").toArray(new String[0]));
+
+        } else {
+            request = new GetSnapshotsRequest(repository, Arrays.asList(snapshot1, snapshot2).toArray(new String[0]));


Why not new String[] {snapshot1, snapshot2}?

nik9000 · 2018-06-22T18:42:19Z

docs/java-rest/high-level/snapshot/get_snapshots.asciidoc

@@ -0,0 +1,103 @@
+[[java-rest-high-snapshot-get-snapshots]]
+=== Get Snapshots API


I believe you have to add this to supported-apis.asciidoc.

Twice, actually.

nik9000 · 2018-06-22T18:43:33Z

server/src/main/java/org/elasticsearch/snapshots/SnapshotInfo.java

+                String currentFieldName = parser.currentName();
+                token = parser.nextToken();
+                if (token.isValue()) {
+                    if (SNAPSHOT.equals(currentFieldName)) {


I think this one is a fine candidate for ObjectParser.

nik9000 · 2018-06-22T18:45:49Z

server/src/main/java/org/elasticsearch/snapshots/SnapshotInfo.java

-                                successfulShards,
-                                shardFailures,
-                                includeGlobalState);
+            indices,


Either format is fine with me. It looks like you aren't actually changing the list, though, right? In that case I'd probably not change the format.

nik9000 · 2018-06-22T18:47:19Z

...est/java/org/elasticsearch/action/admin/cluster/snapshots/get/GetSnapshotsResponseTests.java

+
+    @Override
+    protected boolean supportsUnknownFields() {
+        return false;


I think it ought to support unknown fields, right? I think that is what we want from the client.

Tim-Brooks · 2018-06-26T23:56:25Z

I've modified this based on @nik9000 comments. I had to modify the fromXcontent for SnapshotShardFailure as that was the class that did not support unknown fields .

Please verify that I used the object parsers properly. This is the first time I have used them.

nik9000

Left two minor things, otherwise LGTM.

nik9000 · 2018-06-27T14:57:56Z

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

+
+    public void testGetAllSnapshots() {
+        Map<String, String> expectedParams = new HashMap<>();
+        String repository = randomIndicesNames(1, 1)[0];


Weird. When in Rome, I guess.

nik9000 · 2018-06-27T15:00:37Z

server/src/main/java/org/elasticsearch/snapshots/SnapshotInfo.java

@@ -453,7 +518,7 @@ private XContentBuilder toXContentSnapshot(final XContentBuilder builder, final
     * handle x-content written with the external version as external x-content
     * is only for display purposes and does not need to be parsed.
     */
-    public static SnapshotInfo fromXContent(final XContentParser parser) throws IOException {
+    public static SnapshotInfo fromXContentSnapshot(final XContentParser parser) throws IOException {


Why not fromXContent?

it is fromXContent.

public static SnapshotInfo fromXContent(final XContentParser parser) throws IOException { return SNAPSHOT_INFO_PARSER.parse(parser, null); }

You're looking at the method that deserializes the internal SnapshotInfo x-content. I had to add a different method that deserializes the external x-content. And I renamed the existing method to match the name of the method that serializes the internal x-content. Based on your comment, I added a comment to ensure that is clear.

hub-cap

im only requesting changes to get a question answered. Ill gladly remove my -1 once the question about object parsers is answered.

hub-cap · 2018-06-27T19:25:27Z

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

+        if (randomBoolean()) {
+            getSnapshotsRequest.verbose(false);
+            expectedParams.put("verbose", Boolean.FALSE.toString());
+        }


maybe just simplify these by setting it to the value of the randomBoolean() and using Boolean.valueOf? Not super necessary, just a nit.

hub-cap · 2018-06-27T19:35:38Z

...src/main/java/org/elasticsearch/action/admin/cluster/snapshots/get/GetSnapshotsResponse.java

@@ -87,4 +91,40 @@ public XContentBuilder toXContent(XContentBuilder builder, ToXContent.Params par
        return builder;
    }

+    public static GetSnapshotsResponse fromXContent(XContentParser parser) throws IOException {


any reason that an object parser was not used here?

Tim-Brooks · 2018-06-27T20:38:40Z

@hub-cap I made those changes

hub-cap

u sir, are awesome.

This is related to #31537. It fixes a missing docs references in get_snapshots.asciidoc.

This is related to elastic#31537. It fixes two syntax errors that are breaking the docs build.

This is related to #31537. It fixes two syntax errors that are breaking the docs build.

* master: Docs: Remove duplicate test setup Print output when the name checker IT fails (#31660) Fix syntax errors in get-snapshots docs (#31656) Docs: Fix description of percentile ranks example example (#31652) Add MultiSearchTemplate support to High Level Rest client (#30836) Add test for low-level client round-robin behaviour (#31616) SQL: Refactor package names of sql-proto and sql-shared-proto projects (#31622) Remove deprecation warnings to prepare for Gradle 5 (sourceSets.main.output.classesDirs) (#30389) Correct integTest enable logic (#31646) Fix missing get-snapshots docs reference #31645 Do not check for Azure container existence (#31617) Merge AwsS3Service and InternalAwsS3Service in a S3Service class (#31580) Upgrade gradle wrapper to 4.8 (#31525) Only set vm.max_map_count if greater than default (#31512) Add Get Snapshots High Level REST API (#31537) QA: Merge query-builder-bwc to restart test (#30979) Update reindex.asciidoc (#31626) Docs: Skip xpack snippet tests if no xpack (#31619) mute CreateSnapshotRequestTests HLRest: Fix test for explain API [TEST] Fix RemoteClusterConnectionTests Add Create Snapshot to High-Level Rest Client (#31215) Remove legacy MetaDataStateFormat (#31603) Add explain API to high-level REST client (#31387) Preserve thread context when connecting to remote cluster (#31574) Unify headers for full text queries Remove redundant 'minimum_should_match' JDBC driver prepared statement set* methods (#31494) [TEST] call yaml client close method from test suite (#31591)

javanna · 2018-06-29T09:55:43Z

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

+
+        boolean verbose = randomBoolean();
+        getSnapshotsRequest.verbose(verbose);
+        expectedParams.put("verbose", Boolean.toString(verbose));


nit: it is slightly better to set a value only randomly, that way you also test that we do the right when the value is not set (this can be applied also to ignoreUnavailable above:

if (randomBoolean()) { boolean verbose = randomBoolean(); getSnapshotsRequest.verbose(verbose); expectedParams.put("verbose", Boolean.toString(verbose)); }

javanna · 2018-06-29T09:57:20Z

...evel/src/test/java/org/elasticsearch/client/documentation/SnapshotClientDocumentationIT.java

+        // end::get-snapshots-execute
+
+        // tag::get-snapshots-response
+        List<SnapshotInfo> snapshotsInfos = response.getSnapshots(); // <1>


can you expand on what can be retrieved from the SnapshotInfo?

javanna · 2018-06-29T10:01:21Z

server/src/main/java/org/elasticsearch/snapshots/SnapshotShardFailure.java

@@ -100,7 +114,7 @@ public String reason() {
    /**
     * Returns REST status corresponding to this failure
     *
-     * @return REST status
+     * @return REST STATUS


was this necessary maybe you rather want to link to RestStatus ?

No I think that was just an issue with a cherry-pick merge.

This is a followup to elastic#31537. It makes a number of changes requested by a review that came after the PR was merged. These are mostly cleanups and doc improvements.

This is a followup to #31537. It makes a number of changes requested by a review that came after the PR was merged. These are mostly cleanups and doc improvements.

With this commit we add the get snapshots API to the Java high level REST client. Relates elastic#27205

This is related to elastic#31537. It fixes a missing docs references in get_snapshots.asciidoc.

This is related to elastic#31537. It fixes two syntax errors that are breaking the docs build.

This is a followup to elastic#31537. It makes a number of changes requested by a review that came after the PR was merged. These are mostly cleanups and doc improvements.

Tim-Brooks added 8 commits June 18, 2018 16:20

Work on request convertor

0f8f9c4

Start on documentation

70f79da

Merge remote-tracking branch 'upstream/master' into rest_get_snapshot

95fde3d

Merge remote-tracking branch 'upstream/master' into rest_get_snapshot

093a684

Work on parsing

df63a24

Implement tests

2915a38

Add tests

50a26e1

Work on documentation

d385f5c

Tim-Brooks added >enhancement v7.0.0 :Core/Java High Level REST Client v6.4.0 labels Jun 22, 2018

nik9000 reviewed Jun 22, 2018

View reviewed changes

Tim-Brooks added 4 commits June 26, 2018 17:50

Changes from review

45f54e7

Merge remote-tracking branch 'upstream/master' into rest_get_snapshot

3d8c689

whitespace

9875290

Changes from review

2f16ff0

Tim-Brooks requested review from nik9000, hub-cap and javanna June 26, 2018 23:56

Tim-Brooks added 2 commits June 26, 2018 22:59

Fix checkstyle

1479487

Fix test

429f9ac

nik9000 approved these changes Jun 27, 2018

View reviewed changes

Tim-Brooks added 3 commits June 27, 2018 09:24

Adjust comments

5c61d10

Merge remote-tracking branch 'upstream/master' into rest_get_snapshot

8e20773

Fix naming

0058c83

hub-cap suggested changes Jun 27, 2018

View reviewed changes

Changes

8cb968b

More changes

4a63364

Tim-Brooks requested a review from hub-cap June 27, 2018 20:38

hub-cap approved these changes Jun 27, 2018

View reviewed changes

Merge remote-tracking branch 'upstream/master' into rest_get_snapshot

0edd796

Tim-Brooks merged commit 9ac81a1 into elastic:master Jun 28, 2018

Tim-Brooks added the backport pending label Jun 28, 2018

Tim-Brooks mentioned this pull request Jun 28, 2018

Fix missing get-snapshots docs reference #31645

Merged

javanna mentioned this pull request Jun 28, 2018

Java high-level REST client completeness #27205

Closed

80 tasks

Tim-Brooks added a commit that referenced this pull request Jun 28, 2018

Fix missing get-snapshots docs reference #31645

cff7be1

This is related to #31537. It fixes a missing docs references in get_snapshots.asciidoc.

Tim-Brooks added a commit to Tim-Brooks/elasticsearch that referenced this pull request Jun 28, 2018

Fix syntax errors in get-snapshots docs

22eba70

This is related to elastic#31537. It fixes two syntax errors that are breaking the docs build.

Tim-Brooks mentioned this pull request Jun 28, 2018

Fix syntax errors in get-snapshots docs #31656

Merged

hub-cap pushed a commit that referenced this pull request Jun 28, 2018

Fix syntax errors in get-snapshots docs (#31656)

3fce13f

This is related to #31537. It fixes two syntax errors that are breaking the docs build.

javanna reviewed Jun 29, 2018

View reviewed changes

Tim-Brooks mentioned this pull request Jul 2, 2018

Get snapshot rest client cleanups #31740

Merged

Tim-Brooks added a commit that referenced this pull request Jul 5, 2018

Get snapshot rest client cleanups (#31740)

a5f5ea8

This is a followup to #31537. It makes a number of changes requested by a review that came after the PR was merged. These are mostly cleanups and doc improvements.

Tim-Brooks added a commit to Tim-Brooks/elasticsearch that referenced this pull request Jul 11, 2018

Add Get Snapshots High Level REST API (elastic#31537)

cd1b120

With this commit we add the get snapshots API to the Java high level REST client. Relates elastic#27205

Tim-Brooks added a commit to Tim-Brooks/elasticsearch that referenced this pull request Jul 11, 2018

Fix missing get-snapshots docs reference elastic#31645

71b7e14

This is related to elastic#31537. It fixes a missing docs references in get_snapshots.asciidoc.

Tim-Brooks added a commit to Tim-Brooks/elasticsearch that referenced this pull request Jul 11, 2018

Fix syntax errors in get-snapshots docs (elastic#31656)

33c9152

This is related to elastic#31537. It fixes two syntax errors that are breaking the docs build.

Tim-Brooks removed the backport pending label Dec 8, 2018

Tim-Brooks deleted the rest_get_snapshot branch December 10, 2018 16:21

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

Add Get Snapshots High Level REST API #31537

Add Get Snapshots High Level REST API #31537

Tim-Brooks commented Jun 22, 2018

elasticmachine commented Jun 22, 2018

nik9000 Jun 22, 2018

Tim-Brooks Jun 26, 2018

nik9000 Jun 27, 2018

hub-cap Jun 27, 2018

nik9000 Jun 22, 2018

nik9000 Jun 22, 2018

nik9000 Jun 22, 2018

nik9000 Jun 22, 2018

nik9000 Jun 22, 2018

nik9000 Jun 22, 2018

nik9000 Jun 22, 2018

nik9000 Jun 22, 2018

Tim-Brooks commented Jun 26, 2018

nik9000 left a comment

nik9000 Jun 27, 2018

nik9000 Jun 27, 2018

Tim-Brooks Jun 27, 2018

nik9000 Jun 27, 2018

hub-cap left a comment

hub-cap Jun 27, 2018

hub-cap Jun 27, 2018

Tim-Brooks Jun 27, 2018

Tim-Brooks commented Jun 27, 2018 •

edited

Loading

hub-cap left a comment

javanna Jun 29, 2018

javanna Jun 29, 2018

javanna Jun 29, 2018

Tim-Brooks Jul 2, 2018

		@@ -0,0 +1,103 @@
		[[java-rest-high-snapshot-get-snapshots]]
		=== Get Snapshots API

Add Get Snapshots High Level REST API #31537

Add Get Snapshots High Level REST API #31537

Conversation

Tim-Brooks commented Jun 22, 2018

elasticmachine commented Jun 22, 2018

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

Tim-Brooks commented Jun 26, 2018

nik9000 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

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

Tim-Brooks commented Jun 27, 2018 • edited Loading

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

Tim-Brooks commented Jun 27, 2018 •

edited

Loading