org.elasticsearch.common.xcontent

Interface ToXContent

All Known Subinterfaces:

ClusterState.Custom, Filters.Bucket, GeoHashGrid.Bucket, Histogram.Bucket, IndexMetaData.Custom, Mapping.SourceTransform, MetaData.Custom, MovAvgModelBuilder, MultiBucketsAggregation.Bucket, Range.Bucket, SearchHit, SearchHits, ShardOperationFailedException, SignificanceHeuristicBuilder, StatusToXContent, Task.Status

All Known Implementing Classes:

AbstractAggregationBuilder, AbstractRangeBuilder, AbstractRangeBuilder.Range, ActionNotFoundTransportException, ActionTransportException, ActionWriteResponse.ShardInfo, ActionWriteResponse.ShardInfo.Failure, AggregationBuilder, AggregationExecutionException, AggregationInitializationException, AliasesNotFoundException, AliasFilterParsingException, AllCircuitBreakerStats, AllFieldMapper, AllocationId, AlreadyExpiredException, AnalyzeResponse, AnalyzeResponse.AnalyzeToken, AndQueryBuilder, AvgBucketBuilder, AvgBuilder, BaseGeoPointFieldMapper, BaseInnerHitBuilder, BaseLineStringBuilder, BasePolygonBuilder, BasePolygonBuilder.Ring, BinaryFieldMapper, BindHttpException, BindTransportException, BlobStoreException, BlobStoreIndexShardSnapshot, BlobStoreIndexShardSnapshots, BooleanFieldMapper, BoolQueryBuilder, BoostingQueryBuilder, BroadcastShardOperationFailedException, BucketMetricsBuilder, BucketScriptBuilder, BucketSelectorBuilder, BulkItemResponse.Failure, ByteFieldMapper, CancellableThreads.ExecutionCancelledException, CancelTasksResponse, CardinalityBuilder, CategoryContextMapping, ChildrenBuilder, ChiSquare.ChiSquareBuilder, CircleBuilder, CircuitBreakerStats, CircuitBreakingException, ClearScrollResponse, ClusterBlock, ClusterBlockException, ClusterHealthResponse, ClusterIndexHealth, ClusterSearchShardsGroup, ClusterSearchShardsResponse, ClusterState, ClusterStatsIndices, ClusterStatsIndices.ShardStats, ClusterStatsNodes, ClusterStatsNodes.Counts, ClusterStatsNodes.JvmStats, ClusterStatsNodes.OsStats, ClusterStatsNodes.ProcessStats, ClusterStatsResponse, CollectorResult, CommitStats, CommonStats, CommonTermsQueryBuilder, CompletionFieldMapper, CompletionStats, CompletionSuggestion, CompletionSuggestion.Entry, CompletionSuggestion.Entry.Option, CompletionSuggestionBuilder, CompletionSuggestionFuzzyBuilder, ConcurrentSnapshotExecutionException, ConnectTransportException, ConstantScoreQueryBuilder, ContextMapping, ContextMapping.ContextQuery, CreateFailedEngineException, CreateSnapshotResponse, CumulativeSumBuilder, DateFieldMapper, DateHistogramBuilder, DateRangeBuilder, DecayFunctionBuilder, Decision, Decision.Multi, Decision.Single, DefaultShardOperationFailedException, DelayRecoveryException, DeleteByQueryFailedEngineException, DeleteFailedEngineException, DerivativeBuilder, DetailAnalyzeResponse, DetailAnalyzeResponse.AnalyzeTokenList, DetailAnalyzeResponse.CharFilteredText, DfsPhaseExecutionException, DiscoveryNode, DisMaxQueryBuilder, DocsStats, DocumentAlreadyExistsException, DocumentMapper, DocumentMissingException, DocumentSourceMissingException, DoubleFieldMapper, DoubleTerms, DummyOsInfo, DummyPluginInfo, ElasticsearchException, ElasticsearchGenerationException, ElasticsearchParseException, ElasticsearchSecurityException, ElasticsearchTimeoutException, EngineClosedException, EngineCreationFailureException, EngineException, EnvelopeBuilder, EsRejectedExecutionException, EwmaModel.EWMAModelBuilder, ExistsQueryBuilder, ExponentialDecayFunctionBuilder, ExpressionScriptCompilationException, ExpressionScriptExecutionException, ExtendedStatsBucketBuilder, ExtendedStatsBuilder, FactorBuilder, FailedNodeException, FetchPhaseExecutionException, FieldDataStats, FieldMapper, FieldMaskingSpanQueryBuilder, FieldNamesFieldMapper, FieldSortBuilder, FieldStats, FieldStats.Date, FieldStats.Double, FieldStats.Float, FieldStats.Long, FieldStats.Text, FieldValueFactorFunctionBuilder, FilterAggregationBuilder, FilteredQueryBuilder, FiltersAggregationBuilder, FloatFieldMapper, FlushFailedEngineException, FlushNotAllowedEngineException, FlushStats, FsInfo, FsInfo.Path, FunctionScoreQueryBuilder, Fuzziness, FuzzyQueryBuilder, GatewayException, GaussDecayFunctionBuilder, GeoBoundingBoxQueryBuilder, GeoBoundsBuilder, GeoCentroidBuilder, GeoDistanceBuilder, GeoDistanceBuilder.Range, GeoDistanceQueryBuilder, GeoDistanceRangeQueryBuilder, GeoDistanceSortBuilder, GeohashCellQuery.Builder, GeoHashGridBuilder, GeolocationContextMapping, GeometryCollectionBuilder, GeoPointFieldMapper, GeoPointFieldMapperLegacy, GeoPolygonQueryBuilder, GeoShapeFieldMapper, GeoShapeQueryBuilder, GetFieldMappingsResponse, GetFieldMappingsResponse.FieldMappingMetaData, GetIndexedScriptResponse, GetResponse, GetResult, GetSnapshotsResponse, GetStats, GlobalBuilder, GND.GNDBuilder, GroovyScriptCompilationException, GroovyScriptExecutionException, HasChildQueryBuilder, HasParentQueryBuilder, HighlightBuilder, Histogram.Order, HistogramBuilder, HoltLinearModel.HoltLinearModelBuilder, HoltWintersModel.HoltWintersModelBuilder, HttpException, HttpInfo, HttpStats, IdFieldMapper, IdsQueryBuilder, IllegalIndexShardStateException, IllegalShardRoutingStateException, IncompatibleClusterStateVersionException, IndexAlreadyExistsException, IndexClosedException, IndexCreationException, IndexFailedEngineException, IndexFieldMapper, IndexingStats, IndexingStats.Stats, IndexMetaData, IndexNotFoundException, IndexPrimaryShardNotAllocatedException, IndexShardAlreadyExistsException, IndexShardClosedException, IndexShardNotRecoveringException, IndexShardNotStartedException, IndexShardRecoveringException, IndexShardRecoveryException, IndexShardRelocatedException, IndexShardRestoreException, IndexShardRestoreFailedException, IndexShardSnapshotException, IndexShardSnapshotFailedException, IndexShardStartedException, IndexTemplateAlreadyExistsException, IndexTemplateMissingException, IndexWarmerMissingException, IndexWarmersMetaData, IndicesQueryBuilder, IndicesSegmentResponse, IndicesShardStoresResponse, IndicesShardStoresResponse.Failure, IndicesShardStoresResponse.StoreStatus, IndicesStatsResponse, InnerHitsBuilder, InnerHitsBuilder.InnerHit, IntegerFieldMapper, InternalAggregation, InternalAggregations, InternalAvg, InternalBucketMetricValue, InternalCardinality, InternalChildren, InternalDateRange, InternalDateRange.Bucket, InternalDerivative, InternalExtendedStats, InternalExtendedStatsBucket, InternalFilter, InternalFilters, InternalFilters.Bucket, 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, InternalProfileShardResults, InternalRange, InternalRange.Bucket, InternalReverseNested, InternalSampler, InternalScriptedMetric, InternalSearchHit, InternalSearchHit.InternalNestedIdentity, InternalSearchHits, InternalSearchResponse, InternalSignificantTerms, InternalSignificantTerms.Bucket, InternalSimpleValue, InternalSingleBucketAggregation, InternalStats, InternalStatsBucket, InternalSum, InternalTDigestPercentileRanks, InternalTDigestPercentiles, InternalTerms, InternalTerms.Bucket, InternalTopHits, InternalValueCount, InvalidAggregationPathException, InvalidAliasNameException, InvalidIndexNameException, InvalidIndexTemplateException, InvalidSnapshotNameException, InvalidTypeNameException, IpFieldMapper, IPv4RangeBuilder, JLHScore.JLHScoreBuilder, JvmInfo, JvmStats, LimitQueryBuilder, LinearDecayFunctionBuilder, LinearModel.LinearModelBuilder, LineStringBuilder, ListTasksResponse, LongFieldMapper, LongTerms, Lucene.EarlyTerminationException, Mapper, MapperException, MapperParsingException, Mapping, MasterNotDiscoveredException, MatchAllQueryBuilder, MatchQueryBuilder, MaxBucketBuilder, MaxBuilder, MergeMappingException, MergeStats, MetaData, MetadataFieldMapper, MetricsAggregationBuilder, MinBucketBuilder, MinBuilder, MissingBuilder, MissingQueryBuilder, MoreLikeThisQueryBuilder, MoreLikeThisQueryBuilder.Item, MovAvgBuilder, MultiGetResponse, MultiLineStringBuilder, MultiLineStringBuilder.InternalLineStringBuilder, MultiMatchQueryBuilder, MultiPercolateResponse, MultiPointBuilder, MultiPolygonBuilder, MultiPolygonBuilder.InternalPolygonBuilder, MultiSearchResponse, MultiTermQueryBuilder, MultiTermVectorsResponse, MutualInformation.MutualInformationBuilder, NestedBuilder, NestedQueryBuilder, NoClassSettingsException, NodeClosedException, NodeDisconnectedException, NodeIndicesStats, NodeNotConnectedException, NodeShouldNotConnectException, NodesInfoResponse, NodesStatsResponse, NodeStats, NoNodeAvailableException, NoShardAvailableActionException, NoSuchNodeException, NotQueryBuilder, NotSerializableExceptionWrapper, NotSerializableTransportException, NumberFieldMapper, NXYSignificanceHeuristic.NXYBuilder, ObjectMapper, OrQueryBuilder, OsInfo, OsStats, ParentFieldMapper, PendingClusterTasksResponse, PercentageScore.PercentageScoreBuilder, PercentileRanksBuilder, PercentilesBucketBuilder, PercentilesBuilder, PercolateException, PercolateResponse, PercolateSourceBuilder, PercolateSourceBuilder.DocBuilder, PercolateStats, PercolatorException, PhraseSuggestion, PhraseSuggestion.Entry, PhraseSuggestionBuilder, PhraseSuggestionBuilder.CandidateGenerator, PhraseSuggestionBuilder.DirectCandidateGenerator, PhraseSuggestionBuilder.Laplace, PhraseSuggestionBuilder.LinearInterpolation, PhraseSuggestionBuilder.SmoothingModel, PhraseSuggestionBuilder.StupidBackoff, PipelineAggregatorBuilder, PluginInfo, PluginsAndModules, PointBuilder, PointCollection, PolygonBuilder, PrefixQueryBuilder, PrimaryMissingActionException, ProcessClusterEventTimeoutException, ProcessInfo, ProcessStats, ProfileShardResult, QueryBuilder, QueryCacheStats, QueryFilterBuilder, QueryInnerHitBuilder, QueryParsingException, QueryPhaseExecutionException, QuerySourceBuilder, QueryStringQueryBuilder, RandomScoreFunctionBuilder, RangeBuilder, RangeQueryBuilder, ReceiveTimeoutTransportException, RecoverFilesRecoveryException, RecoveryEngineException, RecoveryFailedException, RecoveryResponse, RecoveryState, RecoveryState.File, RecoveryState.Index, RecoveryState.Translog, RecoveryState.VerifyIndex, RecoveryStats, ReduceSearchPhaseException, RefreshFailedEngineException, RefreshStats, RegexpQueryBuilder, RemoteTransportException, RenderSearchTemplateResponse, ReplicationTask.Status, RepositoriesMetaData, RepositoryException, RepositoryMissingException, RepositoryVerificationException, RequestCacheStats, RerouteExplanation, RescoreBuilder, RescoreBuilder.QueryRescorer, RescoreBuilder.Rescorer, ResourceNotFoundException, ResponseHandlerFailureTransportException, RestoreInfo, RestoreInProgress, RestoreSnapshotResponse, RestoreSource, ReverseNestedBuilder, RootObjectMapper, RoutingException, RoutingExplanations, RoutingFieldMapper, RoutingMissingException, RoutingValidationException, SamplerAggregationBuilder, ScoreFunctionBuilder, ScoreSortBuilder, Script, Script.ScriptParseException, ScriptedMetricBuilder, ScriptException, ScriptHeuristic.ScriptHeuristicBuilder, ScriptQueryBuilder, ScriptScoreFunctionBuilder, ScriptSortBuilder, ScriptStats, SearchContextException, SearchContextMissingException, SearchException, SearchParseException, SearchPhaseExecutionException, SearchResponse, SearchSourceBuilder, SearchSourceBuilderException, SearchStats, SearchStats.Stats, SegmentsStats, SendRequestTransportException, SerialDiffBuilder, Settings, SettingsException, ShapeBuilder, ShapeBuilder.CoordinateNode, ShardNotFoundException, ShardRouting, ShardSearchFailure, ShardStats, ShortFieldMapper, SignificantLongTerms, SignificantStringTerms, SignificantStringTerms.Bucket, SignificantTerms.Bucket, SignificantTermsBuilder, SimpleModel.SimpleModelBuilder, SimpleQueryStringBuilder, SizeHeaderFrameDecoder.HttpOnTransportException, Snapshot, SnapshotCreationException, SnapshotException, SnapshotFailedEngineException, SnapshotIndexShardStatus, SnapshotIndexStatus, SnapshotInfo, SnapshotMissingException, SnapshotRestoreException, SnapshotShardFailure, SnapshotShardsStats, SnapshotsInProgress, SnapshotsStatusResponse, SnapshotStats, SnapshotStatus, SortBuilder, SourceFieldMapper, SpanContainingQueryBuilder, SpanFirstQueryBuilder, SpanMultiTermQueryBuilder, SpanNearQueryBuilder, SpanNotQueryBuilder, SpanOrQueryBuilder, SpanQueryBuilder, SpanTermQueryBuilder, SpanWithinQueryBuilder, StatsBucketBuilder, StatsBuilder, StoreStats, StrictDynamicMappingException, StringFieldMapper, StringTerms, StringTerms.Bucket, Suggest, Suggest.Suggestion, Suggest.Suggestion.Entry, Suggest.Suggestion.Entry.Option, SuggestBuilder, SuggestBuilder.SuggestionBuilder, SuggestStats, SumBucketBuilder, SumBuilder, SyncedFlushResponse, TaskInfo, TaskOperationFailure, Template, TemplateQueryBuilder, TermQueryBuilder, Terms.Bucket, Terms.Order, TermsBuilder, TermsLookupQueryBuilder, TermsQueryBuilder, TermSuggestion, TermSuggestion.Entry, TermSuggestion.Entry.Option, TermSuggestionBuilder, TermVectorsResponse, ThreadPool.Info, ThreadPoolInfo, ThreadPoolStats, ThreadPoolStats.Stats, TimestampFieldMapper, TimestampParsingException, TokenCountFieldMapper, TopHitsBuilder, ToXContentToBytes, TranslogCorruptedException, TranslogException, TranslogRecoveryPerformer.BatchOperationException, TranslogStats, TransportException, TransportInfo, TransportReplicationAction.RetryOnPrimaryException, TransportReplicationAction.RetryOnReplicaException, TransportSerializationException, TransportStats, TruncatedTranslogException, TTLFieldMapper, TypeFieldMapper, TypeMissingException, TypeQueryBuilder, UidFieldMapper, UnassignedInfo, UnavailableShardsException, UncategorizedExecutionException, UnmappedSampler, UnmappedSignificantTerms, UnmappedTerms, UpgradeStatusResponse, ValueCountBuilder, ValuesSourceAggregationBuilder, ValuesSourceMetricsAggregationBuilder, VerifyRepositoryResponse, VersionConflictEngineException, VersionFieldMapper, WarmerStats, WeightBuilder, WildcardQueryBuilder, WrapperQueryBuilder

public interface ToXContent

An interface allowing to transfer an object to "XContent" using an XContentBuilder.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ToXContent.DelegatingMapParams
static class	ToXContent.MapParams
static interface	ToXContent.Params

Field Summary

Fields

Modifier and Type	Field and Description
static ToXContent.Params	EMPTY_PARAMS

Method Summary

Methods

Modifier and Type	Method and Description
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)

Field Detail

EMPTY_PARAMS

static final ToXContent.Params EMPTY_PARAMS

Method Detail

toXContent

XContentBuilder toXContent(XContentBuilder builder,
                         ToXContent.Params params)
                           throws IOException

Throws:

IOException