Package org.elasticsearch.client

Class TextStructureClient

java.lang.Object
org.elasticsearch.client.TextStructureClient
public final class TextStructureClient
extends java.lang.Object
Text Structure API client wrapper for the RestHighLevelClient

See the X-Pack Text Structure APIs for additional information.

  • Method Summary

    Modifier and Type Method Description
    FindStructureResponse findStructure​(FindStructureRequest request, org.elasticsearch.client.RequestOptions options)
    Finds the structure of a file
    org.elasticsearch.client.Cancellable findStructureAsync​(FindStructureRequest request, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<FindStructureResponse> listener)
    Finds the structure of a file asynchronously and notifies the listener on completion

    Methods inherited from class java.lang.Object

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

  • Method Details

    • findStructure

      public FindStructureResponse findStructure​(FindStructureRequest request, org.elasticsearch.client.RequestOptions options) throws java.io.IOException
      Finds the structure of a file

      For additional info see Text Structure Find Structure documentation

      Parameters:
      request - The find file structure request
      options - Additional request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized
      Returns:
      the response containing details of the file structure
      Throws:
      java.io.IOException - when there is a serialization issue sending the request or receiving the response

    • findStructureAsync

      public org.elasticsearch.client.Cancellable findStructureAsync​(FindStructureRequest request, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<FindStructureResponse> listener)
      Finds the structure of a file asynchronously and notifies the listener on completion

      For additional info see Text Structure Find Structure documentation

      Parameters:
      request - The find file structure request
      options - Additional request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized
      listener - Listener to be notified upon request completion
      Returns:
      cancellable that may be used to cancel the request