Module org.elasticsearch.server

Package org.elasticsearch.common.xcontent

Interface ChunkedToXContent

All Known Subinterfaces:

ChunkedToXContentObject, ClusterState.Custom, Metadata.Custom

All Known Implementing Classes:

BaseNodesXContentResponse, ChunkedBroadcastResponse, ClusterRerouteResponse, ClusterState, ComponentTemplateMetadata, ComposableIndexTemplateMetadata, DataStreamMetadata, DesiredBalanceResponse, DesiredNodesMetadata, Diagnosis, Diagnosis.Resource, ElasticsearchNodeCommand.UnknownMetadataCustom, FeatureMigrationResults, FieldCapabilitiesResponse, FieldUsageStatsResponse, GetHealthAction.Response, GetIndexResponse, GetMappingsResponse, GetSettingsResponse, GetSnapshotsResponse, HealthIndicatorResult, HealthMetadata, HttpStats, IndexGraveyard, IndicesSegmentResponse, IndicesShardStoresResponse, IndicesStatsResponse, IngestMetadata, IngestStats, Metadata, NodeIndicesStats, NodesShutdownMetadata, NodesStatsResponse, NodeStats, PendingClusterTasksResponse, PersistentTasksCustomMetadata, RecoveryResponse, RepositoriesMetadata, RepositoryCleanupInProgress, RestoreInProgress, ScriptMetadata, SnapshotDeletionsInProgress, SnapshotsInProgress, SnapshotsStatusResponse, SnapshotStatus, TransportStats

public interface ChunkedToXContent

An alternative to ToXContent allowing for progressive serialization by creating an Iterator of ToXContent chunks.

The REST layer only serializes enough chunks at once to keep an outbound buffer full, rather than consuming all the time and memory needed to serialize the entire response as must be done with the regular ToXContent responses.

Field Summary

Fields

Modifier and Type	Field	Description
static final ChunkedToXContent	EMPTY	A ChunkedToXContent that yields no chunks

Method Summary

Modifier and Type	Method	Description
default boolean	isFragment()
Iterator<? extends ToXContent>	toXContentChunked(ToXContent.Params params)	Create an iterator of ToXContent chunks for a REST response.
default Iterator<? extends ToXContent>	toXContentChunkedV7(ToXContent.Params params)	Create an iterator of ToXContent chunks for a response to the RestApiVersion.V_7 API.
static ToXContent	wrapAsToXContent(ChunkedToXContent chunkedToXContent)	Wraps the given instance in a ToXContent that will fully serialize the instance when serialized.

Field Details

EMPTY

static final ChunkedToXContent EMPTY

A ChunkedToXContent that yields no chunks

Method Details

toXContentChunked

Iterator<? extends ToXContent> toXContentChunked(ToXContent.Params params)

Create an iterator of ToXContent chunks for a REST response. Each chunk is serialized with the same XContentBuilder and ToXContent.Params, which is also the same as the ToXContent.Params passed as the params argument. For best results, all chunks should be O(1) size. See also ChunkedToXContentHelper for some handy utilities.

Note that chunked response bodies cannot send deprecation warning headers once transmission has started, so implementations must check for deprecated feature use before returning.

Returns:

iterator over chunks of ToXContent

toXContentChunkedV7

default Iterator<? extends ToXContent> toXContentChunkedV7(ToXContent.Params params)

Create an iterator of ToXContent chunks for a response to the RestApiVersion.V_7 API. Each chunk is serialized with the same XContentBuilder and ToXContent.Params, which is also the same as the ToXContent.Params passed as the params argument. For best results, all chunks should be O(1) size. See also ChunkedToXContentHelper for some handy utilities.

Similar to toXContentChunked(org.elasticsearch.xcontent.ToXContent.Params) but for the RestApiVersion.V_7 API. By default this method delegates to toXContentChunked(org.elasticsearch.xcontent.ToXContent.Params).

Note that chunked response bodies cannot send deprecation warning headers once transmission has started, so implementations must check for deprecated feature use before returning.

Returns:

iterator over chunks of ToXContent

wrapAsToXContent

static ToXContent wrapAsToXContent(ChunkedToXContent chunkedToXContent)

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

Parameters:

chunkedToXContent - instance to wrap

Returns:

x-content instance

isFragment

default boolean isFragment()

Returns:

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