org.elasticsearch.common.io.stream

Interface Streamable

All Known Subinterfaces:

FetchSearchResultProvider, Filters.Bucket, GeoHashGrid.Bucket, Histogram.Bucket, MultiBucketsAggregation.Bucket, Range.Bucket, SearchHit, SearchHitField, SearchHits, SearchPhaseResult, ShardOperationFailedException, Translog.Operation, ValueFormatter

All Known Implementing Classes:

AcknowledgedRequest, AcknowledgedResponse, ActionRequest, ActionResponse, AggregatedDfs, Alias, AliasAction, AliasesExistResponse, AllCircuitBreakerStats, AllocationExplanation, AnalyzeRequest, AnalyzeResponse, AnalyzeResponse.AnalyzeToken, AvgBucketPipelineAggregator, BaseNodeRequest, BaseNodeResponse, BaseNodesRequest, BaseNodesResponse, BaseTasksRequest, BaseTasksResponse, BasicReplicationRequest, BoundTransportAddress, BroadcastRequest, BroadcastResponse, BroadcastShardRequest, BroadcastShardResponse, BucketMetricsPipelineAggregator, BucketScriptPipelineAggregator, BucketSelectorPipelineAggregator, BucketStreamContext, BulkItemRequest, BulkItemResponse, BulkRequest, BulkResponse, BulkShardRequest, BulkShardResponse, ByteSizeValue, BytesTransportRequest, CancelTasksRequest, CancelTasksResponse, ChildTaskActionRequest, ChildTaskRequest, CircuitBreakerStats, ClearIndicesCacheRequest, ClearIndicesCacheResponse, ClearScrollRequest, ClearScrollResponse, CloseIndexRequest, CloseIndexResponse, ClusterAllocationExplainRequest, ClusterAllocationExplainResponse, ClusterBlock, ClusterHealthRequest, ClusterHealthResponse, ClusterIndexHealth, ClusterInfoRequest, ClusterName, ClusterRerouteRequest, ClusterRerouteResponse, ClusterSearchShardsGroup, ClusterSearchShardsRequest, ClusterSearchShardsResponse, ClusterShardHealth, ClusterStateHealth, ClusterStateRequest, ClusterStateResponse, ClusterStatsIndices, ClusterStatsIndices.ShardStats, ClusterStatsNodeResponse, ClusterStatsNodes.JvmVersion, ClusterStatsRequest, ClusterStatsResponse, ClusterUpdateSettingsRequest, ClusterUpdateSettingsResponse, CommitStats, CommonStats, CommonStatsFlags, CompletionStats, CompletionSuggestion, CompletionSuggestion.Entry, CompletionSuggestion.Entry.Option, CreateIndexRequest, CreateIndexResponse, CreateSnapshotRequest, CreateSnapshotResponse, CumulativeSumPipelineAggregator, DefaultShardOperationFailedException, DeleteIndexedScriptRequest, DeleteIndexedScriptResponse, DeleteIndexRequest, DeleteIndexResponse, DeleteIndexTemplateRequest, DeleteIndexTemplateResponse, DeletePipelineRequest, DeleteRepositoryRequest, DeleteRepositoryResponse, DeleteRequest, DeleteResponse, DeleteSnapshotRequest, DeleteSnapshotResponse, DerivativePipelineAggregator, DetailAnalyzeResponse, DetailAnalyzeResponse.AnalyzeTokenList, DetailAnalyzeResponse.CharFilteredText, DfsSearchResult, DiscoveryStats, DocsStats, DocWriteResponse, DoubleTerms, DummyOsInfo, DummyPluginInfo, ExplainRequest, ExplainResponse, ExtendedStatsBucketPipelineAggregator, FetchSearchResult, FetchSourceContext, FieldDataStats, FieldStats, FieldStats.Date, FieldStats.Double, FieldStats.Float, FieldStats.Ip, FieldStats.Long, FieldStats.Text, FieldStatsRequest, FieldStatsResponse, FieldStatsShardRequest, FieldStatsShardResponse, FlushRequest, FlushResponse, FlushStats, ForceMergeRequest, ForceMergeResponse, FsInfo, FsInfo.Path, GetAliasesRequest, GetAliasesResponse, GetField, GetFieldMappingsIndexRequest, GetFieldMappingsRequest, GetFieldMappingsResponse, GetIndexedScriptRequest, GetIndexedScriptResponse, GetIndexRequest, GetIndexResponse, GetIndexTemplatesRequest, GetIndexTemplatesResponse, GetMappingsRequest, GetMappingsResponse, GetPipelineRequest, GetPipelineResponse, GetRepositoriesRequest, GetRepositoriesResponse, GetRequest, GetResponse, GetResult, GetSettingsRequest, GetSettingsResponse, GetSnapshotsRequest, GetSnapshotsResponse, GetStats, HighlightField, HttpInfo, HttpStats, IndexingStats, IndexingStats.Stats, IndexRequest, IndexResponse, IndexShardStats, IndicesAliasesRequest, IndicesAliasesResponse, IndicesExistsRequest, IndicesExistsResponse, IndicesSegmentResponse, IndicesSegmentsRequest, IndicesShardStoresRequest, IndicesShardStoresResponse, IndicesShardStoresResponse.Failure, IndicesShardStoresResponse.StoreStatus, IndicesStatsRequest, IndicesStatsResponse, InstanceShardOperationRequest, InternalAggregation, InternalAggregations, InternalAvg, InternalBucketMetricValue, InternalCardinality, InternalChildren, InternalDateRange, InternalDateRange.Bucket, InternalDerivative, InternalExtendedStats, InternalExtendedStatsBucket, InternalFilter, InternalFilters, InternalFilters.InternalBucket, InternalGeoBounds, InternalGeoCentroid, InternalGeoDistance, InternalGeoHashGrid, InternalGlobal, InternalHDRPercentileRanks, InternalHDRPercentiles, InternalHistogram, InternalHistogram.Bucket, InternalIPv4Range, InternalIPv4Range.Bucket, InternalMax, InternalMetricsAggregation, InternalMin, InternalMissing, InternalMultiBucketAggregation, InternalMultiBucketAggregation.InternalBucket, InternalNested, InternalNumericMetricsAggregation, InternalNumericMetricsAggregation.MultiValue, InternalNumericMetricsAggregation.SingleValue, InternalPercentilesBucket, InternalRange, InternalRange.Bucket, InternalReverseNested, InternalSampler, InternalScriptedMetric, InternalScrollSearchRequest, InternalSearchHit, InternalSearchHit.InternalNestedIdentity, InternalSearchHitField, InternalSearchHits, InternalSearchResponse, InternalSignificantTerms, InternalSignificantTerms.Bucket, InternalSimpleValue, InternalSingleBucketAggregation, InternalStats, InternalStatsBucket, InternalSum, InternalTDigestPercentileRanks, InternalTDigestPercentiles, InternalTerms, InternalTerms.Bucket, InternalTopHits, InternalValueCount, JvmInfo, JvmInfo.Mem, JvmStats, JvmStats.BufferPool, JvmStats.Classes, JvmStats.GarbageCollector, JvmStats.GarbageCollectors, JvmStats.Mem, JvmStats.MemoryPool, JvmStats.Threads, ListTasksRequest, ListTasksResponse, LivenessRequest, LivenessResponse, LocalAllocateDangledIndices.AllocateDangledRequest, LocalAllocateDangledIndices.AllocateDangledResponse, LongTerms, MasterFaultDetection.MasterPingRequest, MasterNodeReadRequest, MasterNodeRequest, MaxBucketPipelineAggregator, MembershipAction.JoinRequest, MembershipAction.LeaveRequest, MergeStats, MinBucketPipelineAggregator, MovAvgPipelineAggregator, MultiGetItemResponse, MultiGetRequest, MultiGetRequest.Item, MultiGetResponse, MultiGetResponse.Failure, MultiGetShardRequest, MultiGetShardResponse, MultiPercolateRequest, MultiPercolateResponse, MultiPercolateResponse.Item, MultiSearchRequest, MultiSearchResponse, MultiSearchResponse.Item, MultiTermVectorsItemResponse, MultiTermVectorsRequest, MultiTermVectorsResponse, MultiTermVectorsResponse.Failure, MultiTermVectorsShardRequest, MultiTermVectorsShardResponse, NodeHotThreads, NodeIndexDeletedAction.NodeIndexDeletedMessage, NodeIndexDeletedAction.NodeIndexStoreDeletedMessage, NodeIndicesStats, NodeInfo, NodeMappingRefreshAction.NodeMappingRefreshRequest, NodesFaultDetection.PingRequest, NodesHotThreadsRequest, NodesHotThreadsResponse, NodesInfoRequest, NodesInfoResponse, NodesStatsRequest, NodesStatsResponse, NodeStats, OpenIndexRequest, OpenIndexResponse, OsInfo, OsStats, OsStats.Cpu, OsStats.Mem, OsStats.Swap, PendingClusterStateStats, PendingClusterTask, PendingClusterTasksRequest, PendingClusterTasksResponse, PercentilesBucketPipelineAggregator, PercolateRequest, PercolateResponse, PercolateResponse.Match, PercolatorQueryCacheStats, PhraseSuggestion, PhraseSuggestion.Entry, PipelineAggregator, PluginInfo, PluginsAndModules, ProcessInfo, ProcessStats, ProcessStats.Cpu, ProcessStats.Mem, PublishClusterStateAction.CommitClusterStateRequest, PutIndexedScriptRequest, PutIndexedScriptResponse, PutIndexTemplateRequest, PutIndexTemplateResponse, PutMappingRequest, PutMappingResponse, PutPipelineRequest, PutRepositoryRequest, PutRepositoryResponse, QueryCacheStats, QueryExplanation, QueryFetchSearchResult, QuerySearchRequest, QuerySearchResult, QuerySearchResultProvider, RecoveryCleanFilesRequest, RecoveryFileChunkRequest, RecoveryFilesInfoRequest, RecoveryFinalizeRecoveryRequest, RecoveryPrepareForTranslogOperationsRequest, RecoveryRequest, RecoveryResponse, RecoveryState, RecoveryState.File, RecoveryState.Index, RecoveryState.Timer, RecoveryState.Translog, RecoveryState.VerifyIndex, RecoveryStats, RecoveryTranslogOperationsRequest, RefreshRequest, RefreshResponse, RefreshStats, RenderSearchTemplateRequest, RenderSearchTemplateResponse, ReplicationRequest, ReplicationResponse, ReplicationResponse.ShardInfo, ReplicationResponse.ShardInfo.Failure, RequestCacheStats, RestoreInfo, RestoreService.UpdateIndexShardRestoreStatusRequest, RestoreSnapshotRequest, RestoreSnapshotResponse, RestoreSource, Rounding, Rounding.FactorRounding, Rounding.Interval, Rounding.OffsetRounding, RoutingTableValidation, Script, ScriptStats, Scroll, ScrollQueryFetchSearchResult, ScrollQuerySearchResult, SearchRequest, SearchResponse, SearchScrollRequest, SearchStats, SearchStats.Stats, SearchTransportService.SearchFreeContextResponse, Segment, SegmentsStats, SerialDiffPipelineAggregator, ShardFetchRequest, ShardFetchSearchRequest, ShardFlushRequest, ShardId, ShardRouting, ShardSearchFailure, ShardSearchTransportRequest, ShardSegments, ShardsSyncedFlushResult, ShardStateAction.ShardRoutingEntry, ShardStats, ShardUpgradeRequest, ShardUpgradeStatus, ShardValidateQueryRequest, SiblingPipelineAggregator, SignificantLongTerms, SignificantStringTerms, SignificantStringTerms.Bucket, SignificantTerms.Bucket, SimulatePipelineRequest, SimulatePipelineResponse, SingleShardRequest, SizeValue, SnapshotId, SnapshotIndexShardStatus, SnapshotInfo, SnapshotShardFailure, SnapshotShardsService.UpdateIndexShardSnapshotStatusRequest, SnapshotsStatusRequest, SnapshotsStatusResponse, SnapshotStats, SnapshotStatus, StartRecoveryRequest, StatsBucketPipelineAggregator, StoreStats, StringTerms, StringTerms.Bucket, Suggest, Suggest.Suggestion, Suggest.Suggestion.Entry, Suggest.Suggestion.Entry.Option, SumBucketPipelineAggregator, SyncedFlushRequest, SyncedFlushResponse, SyncedFlushService.InFlightOpsRequest, SyncedFlushService.PreShardSyncedFlushRequest, SyncedFlushService.ShardSyncedFlushRequest, SyncedFlushService.ShardSyncedFlushResponse, Template, Terms.Bucket, TermSuggestion, TermSuggestion.Entry, TermSuggestion.Entry.Option, TermVectorsRequest, TermVectorsResponse, ThreadPool.Info, ThreadPoolInfo, ThreadPoolStats, ThreadPoolStats.Stats, TimeValue, TimeZoneRounding, Translog.Delete, Translog.Index, TranslogStats, TransportBroadcastByNodeAction.EmptyResult, TransportBroadcastByNodeAction.NodeRequest, TransportClusterStatsAction.ClusterStatsNodeRequest, TransportInfo, 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, TransportRequest, TransportRequest.Empty, TransportResponse, TransportResponse.Empty, TransportStats, TypesExistsRequest, TypesExistsResponse, UnicastZenPing.UnicastPingRequest, UnmappedSampler, UnmappedSignificantTerms, UnmappedTerms, UpdateRequest, UpdateResponse, UpdateSettingsRequest, UpdateSettingsResponse, UpgradeRequest, UpgradeResponse, UpgradeSettingsRequest, UpgradeSettingsResponse, UpgradeStatusRequest, UpgradeStatusResponse, ValidateQueryRequest, ValidateQueryResponse, ValueFormatter.BooleanFormatter, ValueFormatter.DateTime, ValueFormatter.GeoHash, ValueFormatter.IPv4Formatter, ValueFormatter.Number, ValueFormatter.Number.Pattern, ValueFormatter.Raw, VerificationFailure, VerifyNodeRepositoryAction.VerifyNodeRepositoryRequest, VerifyRepositoryRequest, VerifyRepositoryResponse, WarmerStats, WritePipelineResponse, ZenDiscovery.RejoinClusterRequest, ZenPing.PingResponse

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. For example, TimeValue converts the time to nanoseconds for serialization. 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 and Description
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