Package org.opensearch.core.common.io.stream

Interface Writeable

All Known Subinterfaces:

MediaType, NamedWriteable, ReportingService.Info, VersionedNamedWriteable

All Known Implementing Classes:

ActionResponse, AllCircuitBreakerStats, BoundTransportAddress, ByteSizeUnit, ByteSizeValue, CircuitBreakerStats, CircuitBreakingException, DefaultShardOperationFailedException, Index, IndexShardSnapshotException, IndexShardSnapshotFailedException, NotSerializableExceptionWrapper, OpenSearchException, OpenSearchParseException, ParsingException, ShardId, ShardOperationFailedException, TaskCancelledException, TaskId, TaskResourceInfo, TaskResourceStats, TaskResourceUsage, TaskThreadUsage, TransportAddress, TransportMessage, TransportResponse, TransportResponse.Empty

@PublicApi(since="2.8.0")
public interface Writeable

Implementers can be written to a StreamOutput and read from a StreamInput. This allows them to be "thrown across the wire" using OpenSearch's internal protocol. If the implementer also implements equals and hashCode then a copy made by serializing and deserializing must be equal and have the same hashCode. It isn't required that such a copy be entirely unchanged.

Opensearch.api:

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	Writeable.Reader<V>	Reference to a method that can read some object from a stream.
static class	Writeable.WriteableRegistry	A WriteableRegistry registers Writeable.Writer methods for writing data types over a StreamOutput channel and Writeable.Reader methods for reading data from a StreamInput channel.
static interface	Writeable.Writer<V>	Reference to a method that can write some object to a StreamOutput.

Method Summary

Modifier and Type	Method	Description
void	writeTo(StreamOutput out)	Write this into the StreamOutput.

Method Details

writeTo

void writeTo(StreamOutput out)
      throws IOException

Write this into the StreamOutput.

Throws:

IOException