Package org.elasticsearch.common.io.stream

Interface Streamable

All Known Subinterfaces:

ShardOperationFailedException, WriteRequest<R>

All Known Implementing Classes:

AbstractBulkByScrollRequest, AbstractBulkIndexByScrollRequest, AcknowledgedRequest, AcknowledgedResponse, ActionRequest, ActionResponse, AggregatedDfs, Alias, AliasesExistResponse, AnalyzeRequest, AnalyzeResponse, AnalyzeResponse.AnalyzeToken, BaseNodeRequest, BaseNodeResponse, BaseNodesRequest, BaseNodesResponse, BaseTasksRequest, BaseTasksResponse, BasicReplicationRequest, BoundTransportAddress, BroadcastRequest, BroadcastResponse, BroadcastShardRequest, BroadcastShardResponse, BulkByScrollResponse, BulkItemRequest, BulkItemResponse, BulkRequest, BulkResponse, BulkShardRequest, BulkShardResponse, BytesTransportRequest, CancelTasksRequest, CancelTasksResponse, ClearIndicesCacheRequest, ClearIndicesCacheResponse, ClearScrollRequest, ClearScrollResponse, CloseIndexRequest, CloseIndexResponse, ClusterAllocationExplainRequest, ClusterAllocationExplainResponse, ClusterBlock, ClusterHealthRequest, ClusterHealthResponse, ClusterInfoRequest, ClusterRerouteRequest, ClusterRerouteResponse, ClusterSearchShardsGroup, ClusterSearchShardsRequest, ClusterSearchShardsResponse, ClusterStateRequest, ClusterStateResponse, ClusterStatsNodeResponse, ClusterStatsRequest, ClusterStatsResponse, ClusterUpdateSettingsRequest, ClusterUpdateSettingsResponse, CommitStats, CompletionStats, CompletionSuggestion, CompletionSuggestion.Entry, CompletionSuggestion.Entry.Option, CreateIndexRequest, CreateIndexResponse, CreateSnapshotRequest, CreateSnapshotResponse, DefaultShardOperationFailedException, DeleteByQueryRequest, DeleteIndexRequest, DeleteIndexResponse, DeleteIndexTemplateRequest, DeleteIndexTemplateResponse, DeletePipelineRequest, DeleteRepositoryRequest, DeleteRepositoryResponse, DeleteRequest, DeleteResponse, DeleteSnapshotRequest, DeleteSnapshotResponse, DeleteStoredScriptRequest, DeleteStoredScriptResponse, DetailAnalyzeResponse, DetailAnalyzeResponse.AnalyzeTokenList, DetailAnalyzeResponse.CharFilteredText, DfsSearchResult, DocsStats, DocumentField, DocWriteResponse, ExplainRequest, ExplainResponse, FetchSearchResult, FieldCapabilitiesIndexRequest, FieldCapabilitiesIndexResponse, FieldCapabilitiesRequest, FieldCapabilitiesResponse, FieldDataStats, FlushRequest, FlushResponse, FlushStats, ForceMergeRequest, ForceMergeResponse, GetAliasesRequest, GetAliasesResponse, GetFieldMappingsIndexRequest, GetFieldMappingsRequest, GetFieldMappingsResponse, GetIndexRequest, GetIndexResponse, GetIndexTemplatesRequest, GetIndexTemplatesResponse, GetMappingsRequest, GetMappingsResponse, GetPipelineRequest, GetPipelineResponse, GetRepositoriesRequest, GetRepositoriesResponse, GetRequest, GetResponse, GetResult, GetSettingsRequest, GetSettingsResponse, GetSnapshotsRequest, GetSnapshotsResponse, GetStats, GetStoredScriptRequest, GetStoredScriptResponse, GetTaskRequest, GetTaskResponse, GlobalCheckpointSyncAction.Request, HighlightField, IndexingStats, IndexingStats.Stats, IndexRequest, IndexResponse, IndexShardStats, IndicesAliasesRequest, IndicesAliasesResponse, IndicesExistsRequest, IndicesExistsResponse, IndicesSegmentResponse, IndicesSegmentsRequest, IndicesShardStoresRequest, IndicesShardStoresResponse, IndicesShardStoresResponse.Failure, IndicesShardStoresResponse.StoreStatus, IndicesStatsRequest, IndicesStatsResponse, InstanceShardOperationRequest, InternalAggregations, InternalScrollSearchRequest, ListTasksRequest, ListTasksResponse, LivenessRequest, LivenessResponse, LocalAllocateDangledIndices.AllocateDangledRequest, LocalAllocateDangledIndices.AllocateDangledResponse, MainRequest, MainResponse, MasterFaultDetection.MasterPingRequest, MasterNodeReadRequest, MasterNodeRequest, MembershipAction.JoinRequest, MembershipAction.LeaveRequest, MergeStats, MultiGetItemResponse, MultiGetRequest, MultiGetRequest.Item, MultiGetResponse, MultiGetResponse.Failure, MultiGetShardRequest, MultiGetShardResponse, MultiSearchRequest, MultiSearchResponse, MultiSearchResponse.Item, MultiTermVectorsItemResponse, MultiTermVectorsRequest, MultiTermVectorsResponse, MultiTermVectorsResponse.Failure, MultiTermVectorsShardRequest, MultiTermVectorsShardResponse, NodeHotThreads, NodeIndicesStats, NodeInfo, NodeMappingRefreshAction.NodeMappingRefreshRequest, NodesFaultDetection.PingRequest, NodesHotThreadsRequest, NodesHotThreadsResponse, NodesInfoRequest, NodesInfoResponse, NodesStatsRequest, NodesStatsResponse, NodeStats, NodesUsageRequest, NodesUsageResponse, NodeUsage, OpenIndexRequest, OpenIndexResponse, PendingClusterTask, PendingClusterTasksRequest, PendingClusterTasksResponse, PhraseSuggestion, PhraseSuggestion.Entry, PrimaryReplicaSyncer.ResyncRequest, PublishClusterStateAction.CommitClusterStateRequest, PutIndexTemplateRequest, PutIndexTemplateResponse, PutMappingRequest, PutMappingResponse, PutPipelineRequest, PutRepositoryRequest, PutRepositoryResponse, PutStoredScriptRequest, PutStoredScriptResponse, QueryCacheStats, QueryExplanation, QueryFetchSearchResult, QuerySearchRequest, QuerySearchResult, RecoveryCleanFilesRequest, RecoveryFileChunkRequest, RecoveryFilesInfoRequest, RecoveryFinalizeRecoveryRequest, RecoveryPrepareForTranslogOperationsRequest, RecoveryRequest, RecoveryResponse, RecoveryState, RecoveryState.File, RecoveryState.Index, RecoveryState.Timer, RecoveryState.Translog, RecoveryState.VerifyIndex, RecoveryStats, RecoveryTranslogOperationsRequest, RecoveryTranslogOperationsResponse, RecoveryWaitForClusterStateRequest, RefreshRequest, RefreshResponse, RefreshStats, ReindexRequest, RemoteInfoRequest, RemoteInfoResponse, ReplicatedWriteRequest, ReplicationRequest, ReplicationResponse, ReplicationResponse.ShardInfo, ReplicationResponse.ShardInfo.Failure, RequestCacheStats, ResizeRequest, ResizeResponse, RestoreInfo, RestoreSnapshotRequest, RestoreSnapshotResponse, ResyncReplicationRequest, ResyncReplicationResponse, RolloverRequest, RolloverResponse, Rounding, ScrollQueryFetchSearchResult, ScrollQuerySearchResult, SearchHit, SearchHits, SearchPhaseResult, SearchRequest, SearchResponse, SearchScrollRequest, SearchStats, SearchStats.Stats, SearchTransportService.CanMatchResponse, SearchTransportService.SearchFreeContextResponse, Segment, SegmentsStats, ShardFetchRequest, ShardFetchSearchRequest, ShardFlushRequest, ShardId, ShardSearchFailure, ShardSearchTransportRequest, ShardSegments, ShardsSyncedFlushResult, ShardStateAction.ShardEntry, ShardStats, ShardUpgradeRequest, ShardUpgradeStatus, ShardValidateQueryRequest, SimulatePipelineRequest, SimulatePipelineResponse, SingleShardRequest, SnapshotIndexShardStatus, SnapshotShardFailure, SnapshotShardsService.UpdateIndexShardSnapshotStatusRequest, SnapshotsStatusRequest, SnapshotsStatusResponse, SnapshotStats, SnapshotStatus, StartRecoveryRequest, StoreStats, Suggest, Suggest.Suggestion, Suggest.Suggestion.Entry, Suggest.Suggestion.Entry.Option, SyncedFlushRequest, SyncedFlushResponse, SyncedFlushService.InFlightOpsRequest, SyncedFlushService.PreShardSyncedFlushRequest, SyncedFlushService.ShardSyncedFlushRequest, SyncedFlushService.ShardSyncedFlushResponse, TermSuggestion, TermSuggestion.Entry, TermSuggestion.Entry.Option, TermVectorsRequest, TermVectorsResponse, TranslogStats, TransportBroadcastByNodeAction.EmptyResult, TransportBroadcastByNodeAction.NodeRequest, TransportClusterStatsAction.ClusterStatsNodeRequest, TransportMessage, TransportNodesHotThreadsAction.NodeRequest, TransportNodesInfoAction.NodeInfoRequest, TransportNodesListGatewayMetaState.NodeGatewayMetaState, TransportNodesListGatewayMetaState.NodeRequest, TransportNodesListGatewayMetaState.NodesGatewayMetaState, TransportNodesListGatewayMetaState.Request, TransportNodesListGatewayStartedShards.NodeGatewayStartedShards, TransportNodesListGatewayStartedShards.NodeRequest, TransportNodesListGatewayStartedShards.NodesGatewayStartedShards, TransportNodesListGatewayStartedShards.Request, TransportNodesListShardStoreMetaData.NodeRequest, TransportNodesListShardStoreMetaData.NodesStoreFilesMetaData, TransportNodesListShardStoreMetaData.NodeStoreFilesMetaData, TransportNodesListShardStoreMetaData.Request, TransportNodesListShardStoreMetaData.StoreFilesMetaData, TransportNodesSnapshotsStatus.NodeRequest, TransportNodesSnapshotsStatus.NodeSnapshotStatus, TransportNodesSnapshotsStatus.NodesSnapshotStatus, TransportNodesSnapshotsStatus.Request, TransportNodesStatsAction.NodeStatsRequest, TransportNodesUsageAction.NodeUsageRequest, TransportReplicationAction.ConcreteReplicaRequest, TransportReplicationAction.ConcreteShardRequest, TransportReplicationAction.ReplicaResponse, TransportRequest, TransportRequest.Empty, TransportResponse, TransportResponse.Empty, TransportService.HandshakeResponse, TypesExistsRequest, TypesExistsResponse, UpdateByQueryRequest, UpdateRequest, UpdateResponse, UpdateSettingsRequest, UpdateSettingsResponse, UpgradeRequest, UpgradeResponse, UpgradeSettingsRequest, UpgradeSettingsResponse, UpgradeStatusRequest, UpgradeStatusResponse, ValidateQueryRequest, ValidateQueryResponse, VerificationFailure, VerifyNodeRepositoryAction.VerifyNodeRepositoryRequest, VerifyRepositoryRequest, VerifyRepositoryResponse, WarmerStats, WritePipelineResponse, ZenDiscovery.RejoinClusterRequest

public interface Streamable

Implementers can be written to a StreamOutput and read from a StreamInput. This allows them to be "thrown across the wire" using Elasticsearch'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. Prefer implementing Writeable over implementing this interface where possible. Lots of code depends on this interface so this isn't always possible. Implementers of this interface almost always declare a no arg constructor that is exclusively used for creating "empty" objects on which you then call readFrom(StreamInput). Because readFrom(StreamInput) isn't part of the constructor the fields on implementers cannot be final. It is these reasons that this interface has fallen out of favor compared to Writeable.

Method Summary

Modifier and Type	Method	Description
static <T extends Streamable> Writeable.Reader<T>	newWriteableReader(java.util.function.Supplier<T> supplier)
void	readFrom(StreamInput in)	Set this object's fields from a StreamInput.
void	writeTo(StreamOutput out)	Write this object's fields to a StreamOutput.

Method Detail

readFrom

void readFrom(StreamInput in)
       throws java.io.IOException

Set this object's fields from a StreamInput.

Throws:

java.io.IOException

writeTo

void writeTo(StreamOutput out)
      throws java.io.IOException

Write this object's fields to a StreamOutput.

Throws:

java.io.IOException

newWriteableReader

static <T extends Streamable> Writeable.Reader<T> newWriteableReader(java.util.function.Supplier<T> supplier)