org.elasticsearch.common.xcontent

Interface StatusToXContentObject

All Superinterfaces:

ToXContent, ToXContentObject

All Known Implementing Classes:

BulkItemResponse, BulkResponse, ClearScrollResponse, ClusterHealthResponse, DeleteResponse, DocWriteResponse, GetPipelineResponse, IndexResponse, SearchResponse, 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.

Nested Class Summary

Nested classes/interfaces inherited from interface org.elasticsearch.common.xcontent.ToXContent

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Field Summary

Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent

EMPTY_PARAMS

Method Summary

Modifier and Type	Method and Description
RestStatus	status() Returns the REST status to make sure it is returned correctly

Methods inherited from interface org.elasticsearch.common.xcontent.ToXContentObject

isFragment

Methods inherited from interface org.elasticsearch.common.xcontent.ToXContent

toXContent

Method Detail

status

RestStatus status()

Returns the REST status to make sure it is returned correctly