org.elasticsearch.common.io.stream

Interface Writeable

All Known Subinterfaces:

AllocationCommand, ClusterState.Custom, Diffable<T>, DocValueFormat, IndexMetaData.Custom, MetaData.Custom, MultiTermQueryBuilder, NamedDiff<T>, NamedDiffable<T>, NamedWriteable, PhraseSuggestionBuilder.CandidateGenerator, QueryBuilder, SimulateDocumentResult, SpanQueryBuilder, Task.Status, Translog.Operation, TransportAddress

All Known Implementing Classes:

AbstractAggregationBuilder, AbstractAllocateAllocationCommand, AbstractAllocationDecision, AbstractDiffable, AbstractHighlighterBuilder, AbstractNamedDiffable, AbstractPipelineAggregationBuilder, AbstractQueryBuilder, AbstractRangeBuilder, ActionNotFoundTransportException, ActionTransportException, ActiveShardCount, AdjacencyMatrixAggregationBuilder, AdjacencyMatrixAggregator.KeyedFilter, AggregationBuilder, AggregationExecutionException, AggregationInitializationException, AggregationProfileShardResult, Aggregator.SubAggCollectionMode, AggregatorFactories.Builder, AliasesNotFoundException, AliasFilter, AliasFilterParsingException, AliasMetaData, AllCircuitBreakerStats, AllocateEmptyPrimaryAllocationCommand, AllocateReplicaAllocationCommand, AllocateStalePrimaryAllocationCommand, AllocateUnassignedDecision, AllocationDecision, AllocationId, AlreadyExpiredException, AnalyzeRequest.NameOrDefinition, AvgAggregationBuilder, AvgBucketPipelineAggregationBuilder, AvgBucketPipelineAggregator, BasePrimaryAllocationCommand, BaseTermQueryBuilder, BindHttpException, BindTransportException, BlobStoreException, BoolQueryBuilder, BoostingQueryBuilder, BroadcastShardOperationFailedException, BucketMetricsPipelineAggregationBuilder, BucketMetricsPipelineAggregator, BucketScriptPipelineAggregationBuilder, BucketScriptPipelineAggregator, BucketSelectorPipelineAggregationBuilder, BucketSelectorPipelineAggregator, BulkByScrollTask.Status, BulkByScrollTask.StatusOrException, BulkItemResponse.Failure, ByteSizeUnit, ByteSizeValue, CancelAllocationCommand, CancellableThreads.ExecutionCancelledException, CardinalityAggregationBuilder, ChiSquare, CircleBuilder, CircuitBreakerStats, CircuitBreakingException, ClusterAllocationExplanation, ClusterBlockException, ClusterBlocks, ClusterHealthStatus, ClusterIndexHealth, ClusterInfo, ClusterName, ClusterShardHealth, ClusterState, ClusterStateHealth, CollapseBuilder, CollectorResult, CombineFunction, CommonStats, CommonStatsFlags, CommonTermsQueryBuilder, CompletionSuggestionBuilder, ConcurrentSnapshotExecutionException, Condition, ConnectTransportException, ConstantScoreQueryBuilder, CoordinateCollection, CumulativeSumPipelineAggregationBuilder, CumulativeSumPipelineAggregator, DateHistogramAggregationBuilder, DateHistogramInterval, DateRangeAggregationBuilder, DecayFunctionBuilder, Decision, Decision.Multi, Decision.Single, Decision.Type, DelayRecoveryException, DeleteFailedEngineException, DerivativePipelineAggregationBuilder, DerivativePipelineAggregator, DfsPhaseExecutionException, DirectCandidateGeneratorBuilder, Discovery.FailedToCommitClusterStateException, DiscoveryNode, DiscoveryNodes, DiscoveryStats, DiskUsage, DisMaxQueryBuilder, DistanceUnit, DiversifiedAggregationBuilder, DocumentMissingException, DocumentSourceMissingException, DocValueFormat.DateTime, DocValueFormat.Decimal, DocWriteResponse.Result, DoubleTerms, DummyOsInfo, DummyPluginInfo, ElasticsearchException, ElasticsearchGenerationException, ElasticsearchParseException, ElasticsearchSecurityException, ElasticsearchStatusException, ElasticsearchTimeoutException, Engine.CommitId, EngineClosedException, EngineCreationFailureException, EngineException, EnvelopeBuilder, EsRejectedExecutionException, EwmaModel, ExistsQueryBuilder, ExponentialDecayFunctionBuilder, ExtendedBounds, ExtendedStatsAggregationBuilder, ExtendedStatsBucketPipelineAggregationBuilder, ExtendedStatsBucketPipelineAggregator, FailedNodeException, FetchPhaseExecutionException, FetchSourceContext, FieldCapabilities, FieldCapabilitiesIndexResponse, FieldMaskingSpanQueryBuilder, FieldMemoryStats, FieldSortBuilder, FieldStats, FieldStats.Date, FieldStats.Double, FieldStats.GeoPoint, FieldStats.Ip, FieldStats.Long, FieldStats.Text, FieldValueFactorFunction.Modifier, FieldValueFactorFunctionBuilder, FilterAggregationBuilder, FiltersAggregationBuilder, FiltersAggregator.KeyedFilter, FiltersFunctionScoreQuery.ScoreMode, FlushFailedEngineException, FsInfo, FsInfo.DeviceStats, FsInfo.IoStats, FsInfo.Path, FunctionScoreQueryBuilder, FunctionScoreQueryBuilder.FilterFunctionBuilder, Fuzziness, FuzzyOptions, FuzzyQueryBuilder, GatewayException, GaussDecayFunctionBuilder, GeneralScriptException, GeoBoundingBoxQueryBuilder, GeoBoundsAggregationBuilder, GeoCentroidAggregationBuilder, GeoDistance, GeoDistanceAggregationBuilder, GeoDistanceAggregationBuilder.Range, GeoDistanceQueryBuilder, GeoDistanceRangeQueryBuilder, GeoDistanceSortBuilder, GeoExecType, GeoGridAggregationBuilder, GeohashCellQuery.Builder, GeometryCollectionBuilder, GeoPolygonQueryBuilder, GeoShapeQueryBuilder, GeoValidationMethod, GlobalAggregationBuilder, GND, HighlightBuilder, HighlightBuilder.BoundaryScannerType, HighlightBuilder.Field, HighlightBuilder.Order, HistogramAggregationBuilder, HoltLinearModel, HoltWintersModel, HttpException, HttpInfo, HttpStats, IdsQueryBuilder, IllegalIndexShardStateException, IllegalShardRoutingStateException, IncludeExclude, IncompatibleClusterStateVersionException, Index, IndexClosedException, IndexCreationException, IndexFailedEngineException, IndexGraveyard, IndexGraveyard.IndexGraveyardDiff, IndexGraveyard.Tombstone, IndexId, IndexMetaData, IndexNotFoundException, IndexPrimaryShardNotAllocatedException, IndexRoutingTable, IndexShardAlreadyExistsException, IndexShardClosedException, IndexShardNotRecoveringException, IndexShardNotStartedException, IndexShardRecoveringException, IndexShardRecoveryException, IndexShardRelocatedException, IndexShardRestoreException, IndexShardRestoreFailedException, IndexShardSnapshotException, IndexShardSnapshotFailedException, IndexShardStartedException, IndexTemplateAlreadyExistsException, IndexTemplateMetaData, IndexTemplateMissingException, IndicesAliasesRequest.AliasActions, IndicesQueryBuilder, InetSocketTransportAddress, IngestInfo, IngestMetadata, IngestStats, IngestStats.Stats, InnerHitBuilder, InternalAdjacencyMatrix, InternalAdjacencyMatrix.InternalBucket, InternalAggregation, InternalAvg, InternalBinaryRange, InternalBinaryRange.Bucket, InternalBucketMetricValue, InternalCardinality, InternalDateHistogram, InternalDateHistogram.Bucket, InternalDateRange, InternalDateRange.Bucket, InternalDerivative, InternalExtendedStats, InternalExtendedStatsBucket, InternalFilter, InternalFilters, InternalFilters.InternalBucket, InternalGeoBounds, InternalGeoCentroid, InternalGeoDistance, InternalGeoHashGrid, InternalGlobal, InternalHDRPercentileRanks, InternalHDRPercentiles, InternalHistogram, InternalHistogram.Bucket, InternalMappedSignificantTerms, InternalMappedTerms, InternalMax, InternalMin, InternalMissing, InternalMultiBucketAggregation, InternalMultiBucketAggregation.InternalBucket, InternalNested, InternalNumericMetricsAggregation, InternalNumericMetricsAggregation.MultiValue, InternalNumericMetricsAggregation.SingleValue, InternalPercentilesBucket, InternalRange, InternalRange.Bucket, InternalReverseNested, InternalSampler, InternalScriptedMetric, InternalSearchResponse, InternalSignificantTerms, InternalSignificantTerms.Bucket, InternalSimpleValue, InternalSingleBucketAggregation, InternalStats, InternalStatsBucket, InternalSum, InternalTDigestPercentileRanks, InternalTDigestPercentiles, InternalTerms, InternalTerms.Bucket, InternalTopHits, InternalValueCount, InvalidAggregationPathException, InvalidAliasNameException, InvalidIndexNameException, InvalidIndexTemplateException, InvalidSnapshotNameException, InvalidTypeNameException, IpRangeAggregationBuilder, JLHScore, JvmInfo, JvmInfo.Mem, JvmStats, JvmStats.BufferPool, JvmStats.Classes, JvmStats.GarbageCollector, JvmStats.GarbageCollectors, JvmStats.Mem, JvmStats.MemoryPool, JvmStats.Threads, Laplace, LinearDecayFunctionBuilder, LinearInterpolation, LinearModel, LineStringBuilder, LocalTransportAddress, LongTerms, LongTerms.Bucket, Lucene.EarlyTerminationException, MapperException, MapperParsingException, MappingMetaData, MasterNotDiscoveredException, MatchAllQueryBuilder, MatchNoneQueryBuilder, MatchPhrasePrefixQueryBuilder, MatchPhraseQueryBuilder, MatchQuery.Type, MatchQuery.ZeroTermsQuery, MatchQueryBuilder, MaxAgeCondition, MaxAggregationBuilder, MaxBucketPipelineAggregationBuilder, MaxBucketPipelineAggregator, MaxDocsCondition, MetaData, MinAggregationBuilder, MinBucketPipelineAggregationBuilder, MinBucketPipelineAggregator, MissingAggregationBuilder, MoreLikeThisQueryBuilder, MoreLikeThisQueryBuilder.Item, MovAvgModel, MovAvgPipelineAggregationBuilder, MovAvgPipelineAggregator, MoveAllocationCommand, MoveDecision, MultiLineStringBuilder, MultiMatchQueryBuilder, MultiMatchQueryBuilder.Type, MultiPointBuilder, MultiPolygonBuilder, MultiValueMode, MutualInformation, NamedXContentRegistry.UnknownNamedObjectException, NestedAggregationBuilder, NestedQueryBuilder, NoClassSettingsException, NodeAllocationResult, NodeAllocationResult.ShardStoreInfo, NodeClosedException, NodeDisconnectedException, NodeNotConnectedException, NodeShouldNotConnectException, NoNodeAvailableException, NoShardAvailableActionException, NoSuchNodeException, NotMasterException, NotSerializableExceptionWrapper, NotSerializableTransportException, NXYSignificanceHeuristic, Operator, OsInfo, OsStats, OsStats.Cgroup, OsStats.Cgroup.CpuStat, OsStats.Cpu, OsStats.Mem, OsStats.Swap, ParsingException, PendingClusterStateStats, PercentageScore, PercentileRanksAggregationBuilder, PercentilesAggregationBuilder, PercentilesBucketPipelineAggregationBuilder, PercentilesBucketPipelineAggregator, PercentilesMethod, PhraseSuggestionBuilder, PipelineAggregationBuilder, PipelineAggregator, PipelineConfiguration, PluginInfo, PluginsAndModules, PointBuilder, PolygonBuilder, PrefixQueryBuilder, PrimaryMissingActionException, ProcessClusterEventTimeoutException, ProcessInfo, ProcessorInfo, ProcessStats, ProcessStats.Cpu, ProcessStats.Mem, ProfileResult, ProfileShardResult, QueryPhaseExecutionException, QueryProfileShardResult, QueryRescoreMode, QueryRescorerBuilder, QueryShardException, QueryStringQueryBuilder, RandomScoreFunctionBuilder, RangeAggregationBuilder, RangeAggregator.Range, RangeQueryBuilder, RawTaskStatus, ReceiveTimeoutTransportException, RecoverFilesRecoveryException, RecoveryEngineException, RecoveryFailedException, RecoverySource, RecoverySource.LocalShardsRecoverySource, RecoverySource.PeerRecoverySource, RecoverySource.SnapshotRecoverySource, RecoverySource.StoreRecoverySource, ReduceSearchPhaseException, RefreshFailedEngineException, RegexOptions, RegexpQueryBuilder, RemoteConnectionInfo, RemoteInfo, RemoteTransportException, ReplicationOperation.RetryOnPrimaryException, ReplicationTask.Status, RepositoriesMetaData, RepositoryException, RepositoryMissingException, RepositoryVerificationException, RescoreBuilder, ResourceAlreadyExistsException, ResourceNotFoundException, ResponseHandlerFailureTransportException, RestoreInProgress, ReverseNestedAggregationBuilder, RoutingException, RoutingMissingException, RoutingTable, SamplerAggregationBuilder, ScoreFunctionBuilder, ScoreSortBuilder, Script, ScriptedMetricAggregationBuilder, ScriptException, ScriptHeuristic, ScriptMetaData, ScriptQueryBuilder, ScriptScoreFunctionBuilder, ScriptSortBuilder, ScriptSortBuilder.ScriptSortType, ScriptStats, ScriptType, Scroll, ScrollableHitSource.SearchFailure, SearchAfterBuilder, SearchContextException, SearchContextMissingException, SearchException, SearchExtBuilder, SearchHit.NestedIdentity, SearchParseException, SearchPhaseExecutionException, SearchProfileShardResults, SearchShardTarget, SearchSortValues, SearchSourceBuilder, SearchSourceBuilder.IndexBoost, SearchSourceBuilder.ScriptField, SearchSourceBuilderException, SendRequestTransportException, SerialDiffPipelineAggregationBuilder, SerialDiffPipelineAggregator, SettingsException, ShapeBuilder, ShapeRelation, ShardAllocationDecision, ShardLockObtainFailedException, ShardNotFoundException, ShardRouting, ShardStateAction.NoLongerPrimaryShardException, ShardStats, SiblingPipelineAggregator, SignificanceHeuristic, SignificantLongTerms, SignificantStringTerms, SignificantStringTerms.Bucket, SignificantTermsAggregationBuilder, SimpleModel, SimpleQueryStringBuilder, SimulateDocumentBaseResult, SimulateDocumentVerboseResult, SizeValue, SliceBuilder, SmoothingModel, Snapshot, SnapshotCreationException, SnapshotDeletionsInProgress, SnapshotDeletionsInProgress.Entry, SnapshotException, SnapshotFailedEngineException, SnapshotId, SnapshotInfo, SnapshotMissingException, SnapshotRestoreException, SnapshotsInProgress, SortBuilder, SortBy, SortMode, SortOrder, SpanContainingQueryBuilder, SpanFirstQueryBuilder, SpanMultiTermQueryBuilder, SpanNearQueryBuilder, SpanNotQueryBuilder, SpanOrQueryBuilder, SpanTermQueryBuilder, SpanWithinQueryBuilder, SpatialStrategy, StatsAggregationBuilder, StatsBucketPipelineAggregationBuilder, StatsBucketPipelineAggregator, Store.MetadataSnapshot, StoredFieldsContext, StoredScriptSource, StoreFileMetaData, StrictDynamicMappingException, StringTerms, StringTerms.Bucket, StupidBackoff, SuggestBuilder, SuggestionBuilder, SumAggregationBuilder, SumBucketPipelineAggregationBuilder, SumBucketPipelineAggregator, TaskCancelledException, TaskId, TaskInfo, TaskOperationFailure, TaskResult, TcpTransport.HttpOnTransportException, TermQueryBuilder, TermsAggregationBuilder, TermsAggregator.BucketCountThresholds, TermsLookup, TermsQueryBuilder, TermSuggestionBuilder, TermSuggestionBuilder.StringDistanceImpl, TermSuggestionBuilder.SuggestMode, ThreadContext, ThreadPool.Info, ThreadPoolInfo, ThreadPoolStats, ThreadPoolStats.Stats, TimestampParsingException, TimeValue, TopHitsAggregationBuilder, Translog.Delete, Translog.Index, TranslogCorruptedException, TranslogException, TranslogRecoveryPerformer.BatchOperationException, TransportException, TransportInfo, TransportReplicationAction.RetryOnReplicaException, TransportSerializationException, TransportStats, TruncatedTranslogException, TypeMissingException, TypeQueryBuilder, UnassignedInfo, UnassignedInfo.AllocationStatus, UnavailableShardsException, UncategorizedExecutionException, UnmappedSampler, UnmappedSignificantTerms, UnmappedSignificantTerms.Bucket, UnmappedTerms, UnmappedTerms.Bucket, ValueCountAggregationBuilder, ValuesSourceAggregationBuilder, ValuesSourceAggregationBuilder.LeafOnly, ValueType, VersionConflictEngineException, VersionType, WeightBuilder, WildcardQueryBuilder, WrapperQueryBuilder, WriteRequest.RefreshPolicy, XContentType

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 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 this interface over implementing Streamable where possible. Lots of code depends on Streamable so this isn't always possible.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	Writeable.Reader<V> Reference to a method that can read some object from a stream.
static interface	Writeable.Writer<V> Reference to a method that can write some object to a StreamOutput.

Method Summary

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

Method Detail

writeTo

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

Write this into the StreamOutput.

Throws:

java.io.IOException