Package org.elasticsearch.client

Class SearchableSnapshotsClient

java.lang.Object
org.elasticsearch.client.SearchableSnapshotsClient
public class SearchableSnapshotsClient
extends java.lang.Object
A wrapper for the RestHighLevelClient that provides methods for accessing searchable snapshots APIs. See the Searchable Snapshots APIs on elastic.co for more information.

  • Constructor Summary

    Constructors
    Constructor Description
    SearchableSnapshotsClient​(RestHighLevelClient restHighLevelClient)  

  • Method Summary

    Modifier and Type Method Description
    org.elasticsearch.action.admin.cluster.snapshots.restore.RestoreSnapshotResponse mountSnapshot​(MountSnapshotRequest request, org.elasticsearch.client.RequestOptions options)
    Executes the mount snapshot API, which mounts a snapshot as a searchable snapshot.
    org.elasticsearch.client.Cancellable mountSnapshotAsync​(MountSnapshotRequest request, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<org.elasticsearch.action.admin.cluster.snapshots.restore.RestoreSnapshotResponse> listener)
    Asynchronously executes the mount snapshot API, which mounts a snapshot as a searchable snapshot.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • SearchableSnapshotsClient

      public SearchableSnapshotsClient​(RestHighLevelClient restHighLevelClient)

  • Method Details

    • mountSnapshot

      public org.elasticsearch.action.admin.cluster.snapshots.restore.RestoreSnapshotResponse mountSnapshot​(MountSnapshotRequest request, org.elasticsearch.client.RequestOptions options) throws java.io.IOException
      Executes the mount snapshot API, which mounts a snapshot as a searchable snapshot. See the docs for more information.
      Parameters:
      request - the request
      options - the request options
      Returns:
      the response
      Throws:
      java.io.IOException - if an I/O exception occurred sending the request, or receiving or parsing the response

    • mountSnapshotAsync

      public org.elasticsearch.client.Cancellable mountSnapshotAsync​(MountSnapshotRequest request, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<org.elasticsearch.action.admin.cluster.snapshots.restore.RestoreSnapshotResponse> listener)
      Asynchronously executes the mount snapshot API, which mounts a snapshot as a searchable snapshot.
      Parameters:
      request - the request
      options - the request options
      listener - the listener to be notified upon request completion
      Returns:
      cancellable that may be used to cancel the request