Package org.elasticsearch.rest
Interface RestChannel
-
- All Known Implementing Classes:
AbstractRestChannel
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()
XContentBuilder
newBuilder()
XContentBuilder
newBuilder(XContentType xContentType, boolean useFiltering)
XContentBuilder
newErrorBuilder()
RestRequest
request()
void
sendResponse(RestResponse response)
-
-
-
Method Detail
-
newBuilder
XContentBuilder newBuilder() throws java.io.IOException
- Throws:
java.io.IOException
-
newErrorBuilder
XContentBuilder newErrorBuilder() throws java.io.IOException
- Throws:
java.io.IOException
-
newBuilder
XContentBuilder newBuilder(@Nullable XContentType xContentType, boolean useFiltering) throws java.io.IOException
- Throws:
java.io.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)
-
-