Module org.elasticsearch.server
Interface VersionedNamedWriteable
- All Superinterfaces:
NamedWriteable
,Writeable
- All Known Subinterfaces:
ChunkingSettings
,ClusterState.Custom
,GenericNamedWriteable
,Metadata.ClusterCustom
,Metadata.MetadataCustom<T>
,Metadata.ProjectCustom
,MultiTermQueryBuilder
,NamedDiffable<T>
,PersistentTaskParams
,QueryBuilder
,QueryVectorBuilder
,RankShardResult
,SecretSettings
,ServiceSettings
,SpanQueryBuilder
,TaskSettings
- All Known Implementing Classes:
AbstractAggregationBuilder
,AbstractGeometryQueryBuilder
,AbstractPercentilesAggregationBuilder
,AbstractPipelineAggregationBuilder
,AbstractQueryBuilder
,AbstractRangeBuilder
,AggregationBuilder
,AvgAggregationBuilder
,AvgBucketPipelineAggregationBuilder
,BaseTermQueryBuilder
,BoolQueryBuilder
,BoostingQueryBuilder
,BoundingBox
,BucketMetricsPipelineAggregationBuilder
,BucketScriptPipelineAggregationBuilder
,CardinalityAggregationBuilder
,ClusterPersistentTasksCustomMetadata
,ClusterSecrets
,CombinedFieldsQueryBuilder
,CompletionSuggestionBuilder
,ComponentTemplateMetadata
,ComposableIndexTemplateMetadata
,CompositeAggregationBuilder
,ConstantScoreQueryBuilder
,CountedTermsAggregationBuilder
,CumulativeSumPipelineAggregationBuilder
,DataStreamMetadata
,DateHistogramAggregationBuilder
,DateRangeAggregationBuilder
,DecayFunctionBuilder
,DesiredNodesMetadata
,DisMaxQueryBuilder
,DistanceFeatureQueryBuilder
,DiversifiedAggregationBuilder
,ElasticsearchNodeCommand.AbstractUnknownCustom
,ElasticsearchNodeCommand.UnknownClusterCustom
,ElasticsearchNodeCommand.UnknownProjectCustom
,EmptySecretSettings
,EmptyTaskSettings
,EnterpriseGeoIpTask.EnterpriseGeoIpTaskParams
,ExactKnnQueryBuilder
,ExistsQueryBuilder
,ExponentialDecayFunctionBuilder
,ExtendedStatsAggregationBuilder
,ExtendedStatsBucketPipelineAggregationBuilder
,FieldMaskingSpanQueryBuilder
,FieldSortBuilder
,FieldValueFactorFunctionBuilder
,FilterAggregationBuilder
,FiltersAggregationBuilder
,FunctionScoreQueryBuilder
,FuzzyQueryBuilder
,GaussDecayFunctionBuilder
,GeoBoundingBox
,GeoBoundingBoxQueryBuilder
,GeoBoundsAggregationBuilder
,GeoCentroidAggregationBuilder
,GeoDistanceAggregationBuilder
,GeoDistanceQueryBuilder
,GeoDistanceSortBuilder
,GeoGridAggregationBuilder
,GeoHashGridAggregationBuilder
,GeoPolygonQueryBuilder
,GeoShapeQueryBuilder
,GeoTileGridAggregationBuilder
,GlobalAggregationBuilder
,HealthMetadata
,HealthNodeTaskParams
,HistogramAggregationBuilder
,IdsQueryBuilder
,IndexGraveyard
,IngestMetadata
,IntervalQueryBuilder
,IntervalsSourceProvider.Range
,IntervalsSourceProvider.Regexp
,IPAddress
,IpPrefixAggregationBuilder
,IpRangeAggregationBuilder
,KnnScoreDocQueryBuilder
,KnnVectorQueryBuilder
,Laplace
,LinearDecayFunctionBuilder
,LinearInterpolation
,MatchAllQueryBuilder
,MatchBoolPrefixQueryBuilder
,MatchNoneQueryBuilder
,MatchPhrasePrefixQueryBuilder
,MatchPhraseQueryBuilder
,MatchQueryBuilder
,MaxAggregationBuilder
,MaxBucketPipelineAggregationBuilder
,MedianAbsoluteDeviationAggregationBuilder
,MinAggregationBuilder
,MinBucketPipelineAggregationBuilder
,MinimalServiceSettings
,MissingAggregationBuilder
,ModelConfigurations
,ModelSecrets
,MoreLikeThisQueryBuilder
,MultiMatchQueryBuilder
,MultiValuesSourceAggregationBuilder
,MultiValuesSourceAggregationBuilder.LeafOnly
,NestedAggregationBuilder
,NestedQueryBuilder
,NodesShutdownMetadata
,PercentileRanksAggregationBuilder
,PercentilesAggregationBuilder
,PercentilesBucketPipelineAggregationBuilder
,PersistentTasksCustomMetadata
,PhraseSuggestionBuilder
,PipelineAggregationBuilder
,PrefixQueryBuilder
,ProjectSecrets
,ProjectStateRegistry
,QueryRescorerBuilder
,QueryStringQueryBuilder
,RandomSamplerAggregationBuilder
,RandomSamplingQueryBuilder
,RandomScoreFunctionBuilder
,RangeAggregationBuilder
,RangeQueryBuilder
,RankBuilder
,RankDoc
,RankDocsQueryBuilder
,RankFeatureDoc
,RankFeatureShardResult
,RareTermsAggregationBuilder
,RegexpQueryBuilder
,RegisteredPolicySnapshots
,RepositoriesMetadata
,RepositoryCleanupInProgress
,RescorerBuilder
,RestoreInProgress
,ReverseNestedAggregationBuilder
,SamplerAggregationBuilder
,ScoreFunctionBuilder
,ScoreSortBuilder
,ScriptedMetricAggregationBuilder
,ScriptMetadata
,ScriptQueryBuilder
,ScriptScoreFunctionBuilder
,ScriptScoreQueryBuilder
,ScriptSortBuilder
,SearchExtBuilder
,SerialDiffPipelineAggregationBuilder
,SignificantTermsAggregationBuilder
,SignificantTextAggregationBuilder
,SimpleQueryStringBuilder
,SmoothingModel
,SnapshotDeletionsInProgress
,SnapshotsInProgress
,SortBuilder
,SpanContainingQueryBuilder
,SpanFirstQueryBuilder
,SpanMultiTermQueryBuilder
,SpanNearQueryBuilder
,SpanNearQueryBuilder.SpanGapQueryBuilder
,SpanNotQueryBuilder
,SpanOrQueryBuilder
,SpanTermQueryBuilder
,SpanWithinQueryBuilder
,StatsAggregationBuilder
,StatsBucketPipelineAggregationBuilder
,StreamsMetadata
,StupidBackoff
,SuggestionBuilder
,SumAggregationBuilder
,SumBucketPipelineAggregationBuilder
,TermQueryBuilder
,TermsAggregationBuilder
,TermsQueryBuilder
,TermsSetQueryBuilder
,TermSuggestionBuilder
,TopHitsAggregationBuilder
,ValueCountAggregationBuilder
,ValuesSourceAggregationBuilder
,ValuesSourceAggregationBuilder.LeafOnly
,ValuesSourceAggregationBuilder.MetricsAggregationBuilder
,ValuesSourceAggregationBuilder.SingleMetricAggregationBuilder
,VariableWidthHistogramAggregationBuilder
,WeightBuilder
,WeightedAvgAggregationBuilder
,WildcardQueryBuilder
,WrapperQueryBuilder
A
NamedWriteable
that has a minimum version associated with it.-
Nested Class Summary
Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable
Writeable.Reader<V>, Writeable.Writer<V>
-
Method Summary
Modifier and TypeMethodDescriptionThe minimal version of the recipient this object can be sent to.Returns the name of the writeable objectdefault boolean
supportsVersion
(TransportVersion version) Determines whether this instance should be serialized based on the provided transport version.static <T extends VersionedNamedWriteable>
voidwriteVersionedWritables
(StreamOutput out, Map<String, T> customs) Writes all those values in the given map toout
that pass the version check insupportsVersion(org.elasticsearch.TransportVersion)
as a list.static void
writeVersionedWriteables
(StreamOutput out, Iterable<? extends VersionedNamedWriteable> writeables)
-
Method Details
-
getWriteableName
String getWriteableName()Returns the name of the writeable object- Specified by:
getWriteableName
in interfaceNamedWriteable
-
getMinimalSupportedVersion
TransportVersion getMinimalSupportedVersion()The minimal version of the recipient this object can be sent to. SeesupportsVersion(TransportVersion)
for the default serialization check. -
supportsVersion
Determines whether this instance should be serialized based on the provided transport version. The default implementation returnstrue
if the given transport version is equal to or newer thangetMinimalSupportedVersion()
. Subclasses may override this method to define custom serialization logic.- Parameters:
version
- the transport version of the receiving node- Returns:
true
if the instance should be serialized,false
otherwise
-
writeVersionedWritables
static <T extends VersionedNamedWriteable> void writeVersionedWritables(StreamOutput out, Map<String, T> customs) throws IOExceptionWrites all those values in the given map toout
that pass the version check insupportsVersion(org.elasticsearch.TransportVersion)
as a list.- Type Parameters:
T
- type of customs in map- Parameters:
out
- stream to write tocustoms
- map of customs- Throws:
IOException
-
writeVersionedWriteables
static void writeVersionedWriteables(StreamOutput out, Iterable<? extends VersionedNamedWriteable> writeables) throws IOException - Throws:
IOException
-