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, 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.xcontent.ToXContent

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Field Summary

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY_PARAMS

Method Summary

Modifier and Type	Method	Description
RestStatus	status()	Returns the REST status to make sure it is returned correctly
static StatusToXContentObject	withStatus(RestStatus status, ToXContentObject xContent)

Methods inherited from interface org.elasticsearch.xcontent.ToXContent

toXContent

Methods inherited from interface org.elasticsearch.xcontent.ToXContentObject

isFragment

Method Details

status

RestStatus status()

Returns the REST status to make sure it is returned correctly

withStatus

static StatusToXContentObject withStatus(RestStatus status,
 ToXContentObject xContent)