Module org.elasticsearch.server
Package org.elasticsearch.common.xcontent

Interface StatusToXContentObject

All Superinterfaces:
ToXContent, ToXContentObject
All Known Implementing Classes:
BulkItemResponse, BulkResponse, ClearScrollResponse, ClosePointInTimeResponse, ClusterHealthResponse, DeleteResponse, DocWriteResponse, ExplainResponse, GetPipelineResponse, GetScriptContextResponse, GetScriptLanguageResponse, GetStoredScriptResponse, IndexResponse, ListDanglingIndicesResponse, SynonymUpdateResponse, UpdateResponse
public interface StatusToXContentObject extends ToXContentObject
Objects that can both render themselves in as json/yaml/etc and can provide a RestStatus for their response. Usually should be implemented by top level responses sent back to users from REST endpoints.

  • Method Details

    • status

      RestStatus status()
      Returns the REST status to make sure it is returned correctly