Module org.elasticsearch.server

Package org.elasticsearch.common.xcontent

Interface ChunkedToXContentObject

All Superinterfaces:

ChunkedToXContent

All Known Implementing Classes:

ChunkedBroadcastResponse, ClusterRerouteResponse, DesiredBalanceResponse, DesiredBalanceResponse.DesiredShards, FieldCapabilitiesResponse, FieldUsageStatsResponse, GetIndexResponse, GetMappingsResponse, GetSettingsResponse, GetSnapshotsResponse, HealthIndicatorResult, IndicesSegmentResponse, IndicesShardStoresResponse, IndicesStatsResponse, MultiSearchResponse, PendingClusterTasksResponse, RecoveryResponse, SearchResponse, SnapshotsStatusResponse, SnapshotStatus

public interface ChunkedToXContentObject
extends ChunkedToXContent

Chunked equivalent of ToXContentObject that serializes as a full object.

Field Summary

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

EMPTY

Method Summary

Modifier and Type	Method	Description
default boolean	isFragment()
static ToXContentObject	wrapAsToXContentObject(ChunkedToXContentObject chunkedToXContent)	Wraps the given instance in a ToXContentObject that will fully serialize the instance when serialized.

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

toXContentChunked, toXContentChunkedV7

Method Details

isFragment

default boolean isFragment()

Specified by:

isFragment in interface ChunkedToXContent

Returns:

true iff this instance serializes as a fragment. See ToXContentObject for additional details.

wrapAsToXContentObject

static ToXContentObject wrapAsToXContentObject(ChunkedToXContentObject chunkedToXContent)

Wraps the given instance in a ToXContentObject that will fully serialize the instance when serialized.

Parameters:

chunkedToXContent - instance to wrap

Returns:

x-content instance