Add Create Snapshot to High-Level Rest Client #31215
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -29,6 +29,10 @@ | |
| import org.elasticsearch.action.admin.cluster.repositories.put.PutRepositoryResponse; | ||
| import org.elasticsearch.action.admin.cluster.repositories.verify.VerifyRepositoryRequest; | ||
| import org.elasticsearch.action.admin.cluster.repositories.verify.VerifyRepositoryResponse; | ||
| import org.elasticsearch.action.admin.cluster.snapshots.create.CreateSnapshotRequest; | ||
| import org.elasticsearch.action.admin.cluster.snapshots.create.CreateSnapshotResponse; | ||
| import org.elasticsearch.action.admin.indices.create.CreateIndexRequest; | ||
| import org.elasticsearch.action.support.IndicesOptions; | ||
| import org.elasticsearch.action.admin.cluster.snapshots.delete.DeleteSnapshotRequest; | ||
| import org.elasticsearch.action.admin.cluster.snapshots.delete.DeleteSnapshotResponse; | ||
| import org.elasticsearch.client.ESRestHighLevelClientTestCase; | ||
|
|
@@ -41,6 +45,7 @@ | |
| import org.elasticsearch.common.unit.TimeValue; | ||
| import org.elasticsearch.common.xcontent.XContentType; | ||
| import org.elasticsearch.repositories.fs.FsRepository; | ||
| import org.elasticsearch.rest.RestStatus; | ||
|
|
||
| import java.io.IOException; | ||
| import java.util.HashMap; | ||
|
|
@@ -367,6 +372,90 @@ public void onFailure(Exception e) { | |
| } | ||
| } | ||
|
|
||
| public void testSnapshotCreate() throws IOException { | ||
| RestHighLevelClient client = highLevelClient(); | ||
|
|
||
| CreateIndexRequest createIndexRequest = new CreateIndexRequest("test-index0"); | ||
| client.indices().create(createIndexRequest, RequestOptions.DEFAULT); | ||
| createIndexRequest = new CreateIndexRequest("test-index1"); | ||
| client.indices().create(createIndexRequest, RequestOptions.DEFAULT); | ||
|
|
||
| createTestRepositories(); | ||
|
|
||
| // tag::create-snapshot-request | ||
| CreateSnapshotRequest request = new CreateSnapshotRequest(); | ||
| // end::create-snapshot-request | ||
|
|
||
| // tag::create-snapshot-request-repositoryName | ||
| request.repository(repositoryName); // <1> | ||
| // end::create-snapshot-request-repositoryName | ||
| // tag::create-snapshot-request-snapshotName | ||
| request.snapshot(snapshotName); // <1> | ||
| // end::create-snapshot-request-snapshotName | ||
| // tag::create-snapshot-request-indices | ||
| request.indices("test-index0", "test-index1"); // <1> | ||
| // end::create-snapshot-request-indices | ||
| // tag::create-snapshot-request-indicesOptions | ||
| request.indicesOptions(IndicesOptions.fromOptions(false, false, true, true)); // <1> | ||
| // end::create-snapshot-request-indicesOptions | ||
| // tag::create-snapshot-request-partial | ||
| request.partial(false); // <1> | ||
| // end::create-snapshot-request-partial | ||
| // tag::create-snapshot-request-includeGlobalState | ||
| request.includeGlobalState(true); // <1> | ||
| // end::create-snapshot-request-includeGlobalState | ||
|
|
||
| // tag::create-snapshot-request-masterTimeout | ||
| request.masterNodeTimeout(TimeValue.timeValueMinutes(1)); // <1> | ||
| request.masterNodeTimeout("1m"); // <2> | ||
| // end::create-snapshot-request-masterTimeout | ||
| // tag::create-snapshot-request-waitForCompletion | ||
| request.waitForCompletion(true); // <1> | ||
| // end::create-snapshot-request-waitForCompletion | ||
|
|
||
| // tag::create-snapshot-execute | ||
| CreateSnapshotResponse response = client.snapshot().createSnapshot(request, RequestOptions.DEFAULT); | ||
| // end::create-snapshot-execute | ||
|
|
||
| // tag::create-snapshot-response | ||
| RestStatus status = response.status(); // <1> | ||
|
There was a problem hiding this comment. @jdconrad can you please expand on what can be done with the response other than looking at the status? We also return the SnapshotInfo right? That seems like an interesting thing to document for users. |
||
| // end::create-snapshot-response | ||
|
|
||
| assertEquals(RestStatus.OK, status); | ||
| } | ||
|
|
||
| public void testSnapshotCreateAsync() throws InterruptedException { | ||
| RestHighLevelClient client = highLevelClient(); | ||
| { | ||
| CreateSnapshotRequest request = new CreateSnapshotRequest(repositoryName, snapshotName); | ||
|
|
||
| // tag::create-snapshot-execute-listener | ||
| ActionListener<CreateSnapshotResponse> listener = | ||
| new ActionListener<CreateSnapshotResponse>() { | ||
| @Override | ||
| public void onResponse(CreateSnapshotResponse createSnapshotResponse) { | ||
| // <1> | ||
| } | ||
|
|
||
| @Override | ||
| public void onFailure(Exception exception) { | ||
| // <2> | ||
| } | ||
| }; | ||
| // end::create-snapshot-execute-listener | ||
|
|
||
| // Replace the empty listener by a blocking listener in test | ||
| final CountDownLatch latch = new CountDownLatch(1); | ||
| listener = new LatchedActionListener<>(listener, latch); | ||
|
|
||
| // tag::create-snapshot-execute-async | ||
| client.snapshot().createSnapshotAsync(request, RequestOptions.DEFAULT, listener); // <1> | ||
| // end::create-snapshot-execute-async | ||
|
|
||
| assertTrue(latch.await(30L, TimeUnit.SECONDS)); | ||
| } | ||
| } | ||
|
|
||
| public void testSnapshotDeleteSnapshot() throws IOException { | ||
| RestHighLevelClient client = highLevelClient(); | ||
|
|
||
|
|
||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There are a few extra options i see in the transport layer. Lets make sure we account for all these params / optional things.
https://github.com/elastic/elasticsearch/blob/master/server/src/main/java/org/elasticsearch/action/admin/cluster/snapshots/create/TransportCreateSnapshotAction.java#L76-L82
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
All of these should be covered as they end up as part of the content body including partial, indices, global_state, and settings.