Package org.elasticsearch.common.xcontent

Interface ToXContent

All Known Subinterfaces:

AdjacencyMatrix, AdjacencyMatrix.Bucket, Aggregation, AllocationCommand, Avg, BucketMetricValue, Cardinality, ClusterState.Custom, CompositeAggregation, CompositeAggregation.Bucket, Derivative, ExtendedStats, ExtendedStatsBucket, Filter, Filters, Filters.Bucket, GeoBounds, GeoCentroid, GeoHashGrid, GeoHashGrid.Bucket, Global, Histogram, Histogram.Bucket, IndexMetaData.Custom, Max, MetaData.Custom, Min, Missing, MovAvgModelBuilder, MultiBucketsAggregation, MultiBucketsAggregation.Bucket, MultiTermQueryBuilder, Nested, NumericMetricsAggregation, NumericMetricsAggregation.MultiValue, NumericMetricsAggregation.SingleValue, PercentileRanks, Percentiles, PercentilesBucket, PhraseSuggestionBuilder.CandidateGenerator, QueryBuilder, Range, Range.Bucket, ReverseNested, Sampler, ScriptedMetric, ShardOperationFailedException, SignificanceHeuristicBuilder, SignificantTerms, SignificantTerms.Bucket, SimpleValue, SimulateDocumentResult, SingleBucketAggregation, SpanQueryBuilder, Stats, StatsBucket, StatusToXContentObject, Sum, Task.Status, Terms, Terms.Bucket, TopHits, ToXContentFragment, ToXContentObject, ValueCount

All Known Implementing Classes:

AbstractAggregationBuilder, AbstractAllocateAllocationCommand, AbstractAllocationDecision, AbstractHighlighterBuilder, AbstractPipelineAggregationBuilder, AbstractQueryBuilder, AbstractRangeBuilder, ActionNotFoundTransportException, ActionTransportException, AdaptiveSelectionStats, AdjacencyMatrixAggregationBuilder, AdjacencyMatrixAggregator.KeyedFilter, AggregationBuilder, AggregationExecutionException, AggregationInitializationException, AggregationProfileShardResult, Aggregations, AggregatorFactories.Builder, Alias, AliasesNotFoundException, AliasFilterParsingException, AllCircuitBreakerStats, AllFieldMapper, AllocateEmptyPrimaryAllocationCommand, AllocateReplicaAllocationCommand, AllocateStalePrimaryAllocationCommand, AllocateUnassignedDecision, AllocationCommands, AllocationId, AnalyzeResponse, AnalyzeResponse.AnalyzeToken, AvgAggregationBuilder, AvgBucketPipelineAggregationBuilder, BasePrimaryAllocationCommand, BaseTermQueryBuilder, BinaryFieldMapper, BindHttpException, BindTransportException, BlobStoreException, BlobStoreIndexShardSnapshot, BlobStoreIndexShardSnapshots, BooleanFieldMapper, BoolQueryBuilder, BoostingQueryBuilder, BroadcastShardOperationFailedException, BucketMetricsPipelineAggregationBuilder, BucketOrder, BucketScriptPipelineAggregationBuilder, BucketSelectorPipelineAggregationBuilder, BucketSortPipelineAggregationBuilder, BulkByScrollResponse, BulkByScrollTask.Status, BulkByScrollTask.StatusOrException, BulkItemResponse, BulkItemResponse.Failure, BulkResponse, CancelAllocationCommand, CancellableThreads.ExecutionCancelledException, CancelTasksResponse, CardinalityAggregationBuilder, CategoryContextMapping, CategoryQueryContext, ChiSquare, ChiSquare.ChiSquareBuilder, CircleBuilder, CircuitBreakerStats, CircuitBreakingException, ClearScrollRequest, ClearScrollResponse, CloseIndexResponse, ClusterAllocationExplanation, ClusterBlock, ClusterBlockException, ClusterHealthResponse, ClusterIndexHealth, ClusterInfo, ClusterSearchShardsGroup, ClusterSearchShardsResponse, ClusterState, ClusterStatsIndices, ClusterStatsIndices.ShardStats, ClusterStatsNodes, ClusterStatsNodes.Counts, ClusterStatsNodes.JvmStats, ClusterStatsNodes.OsStats, ClusterStatsNodes.ProcessStats, ClusterStatsResponse, CollapseBuilder, CollectorResult, CommitStats, CommonStats, CommonTermsQueryBuilder, CompletionFieldMapper, CompletionStats, CompletionSuggestion, CompletionSuggestion.Entry, CompletionSuggestion.Entry.Option, CompletionSuggestionBuilder, CompositeAggregationBuilder, CompositeValuesSourceBuilder, ConcurrentSnapshotExecutionException, ConnectTransportException, ConstantScoreQueryBuilder, ContextMapping, ContextMappings, CoordinateNode, CreateIndexRequest, CreateIndexResponse, CreateSnapshotResponse, CumulativeSumPipelineAggregationBuilder, DateFieldMapper, DateHistogramAggregationBuilder, DateHistogramValuesSourceBuilder, DateRangeAggregationBuilder, DecayFunctionBuilder, Decision, Decision.Multi, Decision.Single, DefaultShardOperationFailedException, DelayRecoveryException, DeleteFailedEngineException, DeleteIndexResponse, DeleteResponse, DerivativePipelineAggregationBuilder, DetailAnalyzeResponse, DetailAnalyzeResponse.AnalyzeTokenList, DetailAnalyzeResponse.CharFilteredText, DfsPhaseExecutionException, DirectCandidateGeneratorBuilder, Discovery.FailedToCommitClusterStateException, DiscoveryNode, DiscoveryStats, DiskUsage, DisMaxQueryBuilder, DiversifiedAggregationBuilder, DocsStats, DocumentField, DocumentMapper, DocumentMissingException, DocumentSourceMissingException, DocWriteResponse, DoubleTerms, DummyOsInfo, DynamicTemplate, ElasticsearchException, ElasticsearchGenerationException, ElasticsearchParseException, ElasticsearchSecurityException, ElasticsearchStatusException, ElasticsearchTimeoutException, EngineCreationFailureException, EngineException, EnvelopeBuilder, EsRejectedExecutionException, EwmaModel, EwmaModel.EWMAModelBuilder, ExistsQueryBuilder, ExponentialDecayFunctionBuilder, ExtendedBounds, ExtendedStatsAggregationBuilder, ExtendedStatsBucketPipelineAggregationBuilder, FailedNodeException, FetchPhaseExecutionException, FetchSourceContext, FieldCapabilities, FieldCapabilitiesResponse, FieldDataStats, FieldMapper, FieldMaskingSpanQueryBuilder, FieldNamesFieldMapper, FieldSortBuilder, FieldValueFactorFunctionBuilder, FilterAggregationBuilder, FiltersAggregationBuilder, FiltersAggregator.KeyedFilter, FlushFailedEngineException, FlushStats, FsInfo, FsInfo.DeviceStats, FsInfo.IoStats, FsInfo.Path, FunctionScoreQueryBuilder, FunctionScoreQueryBuilder.FilterFunctionBuilder, Fuzziness, FuzzyOptions, FuzzyQueryBuilder, GatewayException, GaussDecayFunctionBuilder, GeneralScriptException, GeoBoundingBoxQueryBuilder, GeoBoundsAggregationBuilder, GeoCentroidAggregationBuilder, GeoContextMapping, GeoDistanceAggregationBuilder, GeoDistanceAggregationBuilder.Range, GeoDistanceQueryBuilder, GeoDistanceSortBuilder, GeoGridAggregationBuilder, GeometryCollectionBuilder, GeoPointFieldMapper, GeoPolygonQueryBuilder, GeoQueryContext, GeoShapeFieldMapper, GeoShapeQueryBuilder, GetFieldMappingsResponse, GetFieldMappingsResponse.FieldMappingMetaData, GetIndexTemplatesResponse, GetPipelineResponse, GetResponse, GetResult, GetSnapshotsResponse, GetStats, GetStoredScriptResponse, GetTaskResponse, GlobalAggregationBuilder, GND, GND.GNDBuilder, HighlightBuilder, HighlightBuilder.Field, HighlightField, HistogramAggregationBuilder, HistogramValuesSourceBuilder, HoltLinearModel, HoltLinearModel.HoltLinearModelBuilder, HoltWintersModel, HoltWintersModel.HoltWintersModelBuilder, HttpException, HttpInfo, HttpStats, IdFieldMapper, IdsQueryBuilder, IllegalIndexShardStateException, IllegalShardRoutingStateException, IncludeExclude, IncompatibleClusterStateVersionException, Index, IndexClosedException, IndexCreationException, IndexFailedEngineException, IndexFieldMapper, IndexGraveyard, IndexGraveyard.Tombstone, IndexId, IndexingStats, IndexingStats.Stats, IndexMetaData, IndexNotFoundException, IndexPrimaryShardNotAllocatedException, IndexResponse, IndexShardClosedException, IndexShardNotRecoveringException, IndexShardNotStartedException, IndexShardRecoveringException, IndexShardRecoveryException, IndexShardRelocatedException, IndexShardRestoreException, IndexShardRestoreFailedException, IndexShardSnapshotException, IndexShardSnapshotFailedException, IndexShardStartedException, IndexTemplateMissingException, IndicesSegmentResponse, IndicesShardStoresResponse, IndicesShardStoresResponse.Failure, IndicesShardStoresResponse.StoreStatus, IndicesStatsResponse, IngestInfo, IngestMetadata, IngestStats, IngestStats.Stats, InnerHitBuilder, InternalAdjacencyMatrix, InternalAdjacencyMatrix.InternalBucket, InternalAggregation, InternalAggregations, InternalAvg, InternalBinaryRange, InternalBinaryRange.Bucket, InternalBucketMetricValue, InternalCardinality, InternalComposite, 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, InternalOrder, InternalOrder.Aggregation, InternalOrder.CompoundOrder, 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, IpFieldMapper, IpRangeAggregationBuilder, IpRangeAggregationBuilder.Range, JLHScore, JLHScore.JLHScoreBuilder, JvmInfo, JvmStats, KeywordFieldMapper, Laplace, LinearDecayFunctionBuilder, LinearInterpolation, LinearModel, LinearModel.LinearModelBuilder, LineStringBuilder, ListTasksResponse, LongTerms, LongTerms.Bucket, MainResponse, Mapper, MapperException, MapperParsingException, Mapping, MasterNotDiscoveredException, MatchAllQueryBuilder, MatchNoneQueryBuilder, MatchPhrasePrefixQueryBuilder, MatchPhraseQueryBuilder, MatchQueryBuilder, MaxAggregationBuilder, MaxBucketPipelineAggregationBuilder, MergeStats, MetaData, MetadataFieldMapper, MinAggregationBuilder, MinBucketPipelineAggregationBuilder, MissingAggregationBuilder, MoreLikeThisQueryBuilder, MoreLikeThisQueryBuilder.Item, MovAvgModel, MovAvgPipelineAggregationBuilder, MoveAllocationCommand, MoveDecision, MultiBucketConsumerService.TooManyBucketsException, MultiGetRequest, MultiGetRequest.Item, MultiGetResponse, MultiGetResponse.Failure, MultiLineStringBuilder, MultiMatchQueryBuilder, MultiPointBuilder, MultiPolygonBuilder, MultiSearchResponse, MultiTermVectorsResponse, MutualInformation, MutualInformation.MutualInformationBuilder, NamedXContentRegistry.UnknownNamedObjectException, NestedAggregationBuilder, NestedQueryBuilder, NestedSortBuilder, NoClassSettingsException, NodeAllocationResult, NodeAllocationResult.ShardStoreInfo, NodeClosedException, NodeDisconnectedException, NodeIndicesStats, NodeNotConnectedException, NodeShouldNotConnectException, NodesInfoResponse, NodesStatsResponse, NodeStats, NodesUsageResponse, NodeUsage, NoNodeAvailableException, NoShardAvailableActionException, NoSuchNodeException, NotMasterException, NotSerializableExceptionWrapper, NotSerializableTransportException, NumberFieldMapper, NXYSignificanceHeuristic, NXYSignificanceHeuristic.NXYBuilder, ObjectMapper, OpenIndexResponse, OsInfo, OsStats, OsStats.Cgroup, OsStats.Cgroup.CpuStat, OsStats.Cpu, OsStats.Mem, OsStats.Swap, ParentFieldMapper, ParsedAdjacencyMatrix, ParsedAdjacencyMatrix.ParsedBucket, ParsedAggregation, ParsedAvg, ParsedBinaryRange, ParsedBinaryRange.ParsedBucket, ParsedBucketMetricValue, ParsedCardinality, ParsedComposite, ParsedComposite.ParsedBucket, ParsedDateHistogram, ParsedDateHistogram.ParsedBucket, ParsedDateRange, ParsedDateRange.ParsedBucket, ParsedDerivative, ParsedDoubleTerms, ParsedDoubleTerms.ParsedBucket, ParsedExtendedStats, ParsedExtendedStatsBucket, ParsedFilter, ParsedFilters, ParsedFilters.ParsedBucket, ParsedGeoBounds, ParsedGeoCentroid, ParsedGeoDistance, ParsedGeoDistance.ParsedBucket, ParsedGeoHashGrid, ParsedGeoHashGrid.ParsedBucket, ParsedGlobal, ParsedHDRPercentileRanks, ParsedHDRPercentiles, ParsedHistogram, ParsedLongTerms, ParsedLongTerms.ParsedBucket, ParsedMax, ParsedMin, ParsedMissing, ParsedMultiBucketAggregation, ParsedMultiBucketAggregation.ParsedBucket, ParsedNested, ParsedPercentileRanks, ParsedPercentiles, ParsedPercentilesBucket, ParsedRange, ParsedRange.ParsedBucket, ParsedReverseNested, ParsedSampler, ParsedScriptedMetric, ParsedSignificantLongTerms, ParsedSignificantLongTerms.ParsedBucket, ParsedSignificantStringTerms, ParsedSignificantStringTerms.ParsedBucket, ParsedSignificantTerms, ParsedSignificantTerms.ParsedBucket, ParsedSimpleValue, ParsedSingleBucketAggregation, ParsedSingleValueNumericMetricsAggregation, ParsedStats, ParsedStatsBucket, ParsedStringTerms, ParsedStringTerms.ParsedBucket, ParsedSum, ParsedTDigestPercentileRanks, ParsedTDigestPercentiles, ParsedTerms, ParsedTerms.ParsedBucket, ParsedTopHits, ParsedValueCount, ParsingException, PendingClusterStateStats, PendingClusterTasksResponse, PercentageScore, PercentageScore.PercentageScoreBuilder, PercentileRanksAggregationBuilder, PercentilesAggregationBuilder, PercentilesBucketPipelineAggregationBuilder, PhraseSuggestion, PhraseSuggestion.Entry, PhraseSuggestionBuilder, PipelineAggregationBuilder, PipelineConfiguration, PluginInfo, PluginsAndModules, PointBuilder, PolygonBuilder, PrefixQueryBuilder, PrimaryMissingActionException, PrimaryReplicaSyncer.ResyncTask.Status, ProcessClusterEventTimeoutException, ProcessInfo, ProcessorInfo, ProcessStats, ProfileResult, PublishClusterStateStats, QueryCacheStats, QueryPhaseExecutionException, QueryProfileShardResult, QueryRescorerBuilder, QueryShardException, QueryStringQueryBuilder, RandomScoreFunctionBuilder, RangeAggregationBuilder, RangeAggregator.Range, RangeFieldMapper, RangeQueryBuilder, RawTaskStatus, ReceiveTimeoutTransportException, RecoverFilesRecoveryException, RecoveryEngineException, RecoveryFailedException, RecoveryResponse, RecoverySource, RecoverySource.LocalShardsRecoverySource, RecoverySource.PeerRecoverySource, RecoverySource.SnapshotRecoverySource, RecoverySource.StoreRecoverySource, RecoveryState, RecoveryState.File, RecoveryState.Index, RecoveryState.Translog, RecoveryState.VerifyIndex, RecoveryStats, ReduceSearchPhaseException, RefreshFailedEngineException, RefreshStats, RegexOptions, RegexpQueryBuilder, RemoteConnectionInfo, RemoteInfoResponse, RemoteTransportException, ReplicationOperation.RetryOnPrimaryException, ReplicationResponse.ShardInfo, ReplicationResponse.ShardInfo.Failure, ReplicationTask.Status, RepositoriesMetaData, RepositoryException, RepositoryMissingException, RepositoryVerificationException, RequestCacheStats, RerouteExplanation, RescorerBuilder, ResizeResponse, ResourceAlreadyExistsException, ResourceNotFoundException, ResponseHandlerFailureTransportException, RestoreInfo, RestoreInProgress, RestoreSnapshotResponse, ReverseNestedAggregationBuilder, RolloverResponse, RootObjectMapper, RoutingException, RoutingExplanations, RoutingFieldMapper, RoutingMissingException, SamplerAggregationBuilder, ScoreFunctionBuilder, ScoreSortBuilder, Script, ScriptedMetricAggregationBuilder, ScriptException, ScriptHeuristic, ScriptMetaData, ScriptQueryBuilder, ScriptScoreFunctionBuilder, ScriptSortBuilder, ScriptStats, ScrollableHitSource.SearchFailure, SearchAfterBuilder, SearchContextException, SearchContextMissingException, SearchException, SearchExtBuilder, SearchHit, SearchHit.NestedIdentity, SearchHits, SearchParseException, SearchPhaseExecutionException, SearchProfileShardResults, SearchResponse, SearchResponse.Clusters, SearchResponseSections, SearchScrollRequest, SearchSortValues, SearchSourceBuilder, SearchSourceBuilder.IndexBoost, SearchSourceBuilder.ScriptField, SearchSourceBuilderException, SearchStats, SearchStats.Stats, SecureSetting, SegmentsStats, SendRequestTransportException, SeqNoFieldMapper, SeqNoStats, SerialDiffPipelineAggregationBuilder, Setting, Setting.AffixSetting, Settings, SettingsException, ShapeBuilder, ShardAllocationDecision, ShardLockObtainFailedException, ShardNotFoundException, ShardRouting, ShardSearchFailure, ShardStateAction.NoLongerPrimaryShardException, ShardStats, SignificanceHeuristic, SignificantLongTerms, SignificantStringTerms, SignificantStringTerms.Bucket, SignificantTermsAggregationBuilder, SignificantTextAggregationBuilder, SimpleModel, SimpleModel.SimpleModelBuilder, SimpleQueryStringBuilder, SimulateDocumentBaseResult, SimulateDocumentVerboseResult, SimulatePipelineResponse, SliceBuilder, SmoothingModel, SnapshotCreationException, SnapshotDeletionsInProgress, SnapshotException, SnapshotFailedEngineException, SnapshotId, SnapshotIndexShardStatus, SnapshotIndexStatus, SnapshotInfo, SnapshotMissingException, SnapshotRestoreException, SnapshotShardFailure, SnapshotShardsStats, SnapshotsInProgress, SnapshotsStatusResponse, SnapshotStats, SnapshotStatus, SortBuilder, SourceFieldMapper, SpanContainingQueryBuilder, SpanFirstQueryBuilder, SpanMultiTermQueryBuilder, SpanNearQueryBuilder, SpanNotQueryBuilder, SpanOrQueryBuilder, SpanTermQueryBuilder, SpanWithinQueryBuilder, StatsAggregationBuilder, StatsBucketPipelineAggregationBuilder, StoredScriptSource, StoreStats, StrictDynamicMappingException, StringTerms, StringTerms.Bucket, StupidBackoff, Suggest, Suggest.Suggestion, Suggest.Suggestion.Entry, Suggest.Suggestion.Entry.Option, SuggestBuilder, SuggestionBuilder, SumAggregationBuilder, SumBucketPipelineAggregationBuilder, SyncedFlushResponse, TaskCancelledException, TaskGroup, TaskInfo, TaskOperationFailure, TaskResult, TcpTransport.HttpOnTransportException, TermQueryBuilder, TermsAggregationBuilder, TermsAggregator.BucketCountThresholds, TermsLookup, TermsQueryBuilder, TermsSetQueryBuilder, TermSuggestion, TermSuggestion.Entry, TermSuggestion.Entry.Option, TermSuggestionBuilder, TermsValuesSourceBuilder, TermVectorsResponse, TextFieldMapper, ThreadPool.Info, ThreadPoolInfo, ThreadPoolStats, ThreadPoolStats.Stats, TimestampParsingException, TopHitsAggregationBuilder, TranslogCorruptedException, TranslogException, TranslogStats, TransportException, TransportInfo, TransportReplicationAction.RetryOnReplicaException, TransportSerializationException, TransportStats, TruncatedTranslogException, TypeFieldMapper, TypeMissingException, TypeQueryBuilder, UidFieldMapper, UnassignedInfo, UnavailableShardsException, UncategorizedExecutionException, UnmappedSampler, UnmappedSignificantTerms, UnmappedSignificantTerms.Bucket, UnmappedTerms, UnmappedTerms.Bucket, UpdateRequest, UpdateResponse, UpgradeStatusResponse, ValueCountAggregationBuilder, ValuesSourceAggregationBuilder, ValuesSourceAggregationBuilder.LeafOnly, VerifyRepositoryResponse, VersionConflictEngineException, VersionFieldMapper, WarmerStats, WeightBuilder, WildcardQueryBuilder, WrapperQueryBuilder

public interface ToXContent

An interface allowing to transfer an object to "XContent" using an XContentBuilder. The output may or may not be a value object. Objects implementing ToXContentObject output a valid value but those that don't may or may not require emitting a startObject and an endObject.

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field	Description
static ToXContent.Params	EMPTY_PARAMS

Method Summary

Modifier and Type	Method	Description
default boolean	isFragment()
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 java.io.IOException

Throws:

java.io.IOException

isFragment

default boolean isFragment()