Package org.elasticsearch.rest

Interface RestChannel

All Known Implementing Classes:
AbstractRestChannel, DefaultRestChannel
public interface RestChannel
A channel used to construct bytes / builder based outputs, and send responses.

  • Method Summary

    Modifier and Type
    Method
    Description
    BytesStreamOutput
    bytesOutput()
     
    boolean
    detailedErrorsEnabled()
     
    org.elasticsearch.xcontent.XContentBuilder
    newBuilder()
     
    org.elasticsearch.xcontent.XContentBuilder
    newBuilder(org.elasticsearch.xcontent.XContentType xContentType, boolean useFiltering)
     
    org.elasticsearch.xcontent.XContentBuilder
    newBuilder(org.elasticsearch.xcontent.XContentType xContentType, org.elasticsearch.xcontent.XContentType responseContentType, boolean useFiltering)
     
    org.elasticsearch.xcontent.XContentBuilder
    newErrorBuilder()
     
    RestRequest
    request()
     
    void
    sendResponse(RestResponse response)
     

  • Method Details

    • newBuilder

      org.elasticsearch.xcontent.XContentBuilder newBuilder() throws IOException
      Throws:
      IOException

    • newErrorBuilder

      org.elasticsearch.xcontent.XContentBuilder newErrorBuilder() throws IOException
      Throws:
      IOException

    • newBuilder

      org.elasticsearch.xcontent.XContentBuilder newBuilder(@Nullable org.elasticsearch.xcontent.XContentType xContentType, boolean useFiltering) throws IOException
      Throws:
      IOException

    • newBuilder

      org.elasticsearch.xcontent.XContentBuilder newBuilder(@Nullable org.elasticsearch.xcontent.XContentType xContentType, @Nullable org.elasticsearch.xcontent.XContentType responseContentType, boolean useFiltering) throws IOException
      Throws:
      IOException

    • bytesOutput

      BytesStreamOutput bytesOutput()

    • request

      RestRequest request()

    • detailedErrorsEnabled

      boolean detailedErrorsEnabled()
      Returns:
      true iff an error response should contain additional details like exception traces.

    • sendResponse

      void sendResponse(RestResponse response)