Package org.opensearch.core.xcontent

Interface ToXContent

All Known Subinterfaces:

BytesReference, ReportingService.Info, ToXContentFragment, ToXContentObject

All Known Implementing Classes:

AbstractBytesReference, AllCircuitBreakerStats, BytesArray, ByteSizeValue, CircuitBreakerStats, CircuitBreakingException, CompositeBytesReference, DefaultShardOperationFailedException, Index, IndexShardSnapshotException, IndexShardSnapshotFailedException, LegacyESVersion, NotSerializableExceptionWrapper, OpenSearchException, OpenSearchParseException, PagedBytesReference, ParsingException, SemverRange, ShardId, ShardOperationFailedException, TaskCancelledException, TaskResourceInfo, TaskResourceStats, TaskResourceUsage, TaskThreadUsage, Text, TransportAddress, Version

@PublicApi(since="1.0.0")
public interface ToXContent

An interface allowing to transfer an object to "XContent" using an XContentBuilder. The output may or may not be a value object. Objects implementing ToXContentObject output a valid value but those that don't may or may not require emitting a startObject and an endObject.

Opensearch.api:

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	ToXContent.DelegatingMapParams	Delegates mapped parameters to base Params class
static class	ToXContent.MapParams	Mapped parameter base class
static interface	ToXContent.Params	Base parameters class

Field Summary

Fields

Modifier and Type	Field	Description
static final ToXContent.Params	EMPTY_PARAMS

Method Summary

Modifier and Type	Method	Description
default boolean	isFragment()
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)

Field Details

EMPTY_PARAMS

static final ToXContent.Params EMPTY_PARAMS

Method Details

toXContent

XContentBuilder toXContent(XContentBuilder builder,
 ToXContent.Params params)
                    throws IOException

Throws:

IOException

isFragment

default boolean isFragment()