Package org.elasticsearch.common.xcontent

Interface ToXContentObject

All Superinterfaces:

ToXContent

All Known Subinterfaces:

AllocationCommand, DataFrameAnalysis, Evaluation, EvaluationMetric, EvaluationMetric, EvaluationMetric.Result, MetricDetail, MultiTermQueryBuilder, PersistentTaskParams, PersistentTaskState, PhraseSuggestionBuilder.CandidateGenerator, QueryBuilder, RoleMapperExpression, SimulateDocumentResult, SpanQueryBuilder, StatusToXContentObject, SyncConfig, Task.Status

All Known Implementing Classes:

AbstractAllocateAllocationCommand, AbstractGeometryQueryBuilder, AbstractHighlighterBuilder, AbstractIndicesPrivileges.FieldSecurity, AbstractQueryBuilder, AbstractResultResponse, AcknowledgedResponse, AddVotingConfigExclusionsResponse, AggregationConfig, AggregatorFactories.Builder, AllocateAction, AllocateEmptyPrimaryAllocationCommand, AllocateReplicaAllocationCommand, AllocateStalePrimaryAllocationCommand, AllocationId, AllRoleMapperExpression, AnalysisConfig, AnalysisLimits, AnalyzeAction.AnalyzeToken, AnalyzeAction.AnalyzeTokenList, AnalyzeAction.CharFilteredText, AnalyzeAction.Response, AnalyzeRequest, AnomalyCause, AnomalyRecord, AnyRoleMapperExpression, ApplicationPrivilege, ApplicationResourcePrivileges, BasePrimaryAllocationCommand, BaseTermQueryBuilder, BoolQueryBuilder, BoostingQueryBuilder, BroadcastResponse, Bucket, BucketInfluencer, BucketOrder, BulkByScrollTask.Status, BulkByScrollTask.StatusOrException, BulkItemResponse, BulkResponse, Calendar, CancelAllocationCommand, CancelTasksResponse, CategoryDefinition, CategoryQueryContext, ChangePasswordRequest, ChunkingConfig, CircleBuilder, CircuitBreakerStats, CleanupRepositoryResponse, ClearIndicesCacheResponse, ClearScrollRequest, ClearScrollResponse, ClearVotingConfigExclusionsResponse, CloseIndexResponse, CloseIndexResponse, CloseIndexResponse.ShardResult.Failure, CloseIndexResponse.ShardResult.Failure, CloseJobRequest, CloseJobResponse, ClusterAllocationExplanation, ClusterGetSettingsResponse, ClusterHealthResponse, ClusterRerouteResponse, ClusterSearchShardsGroup, ClusterSearchShardsResponse, ClusterUpdateSettingsRequest, ClusterUpdateSettingsResponse, CollapseBuilder, CollectorResult, CommonTermsQueryBuilder, CompositeRoleMapperExpression, ConstantScoreQueryBuilder, CoordinateNode, CountRequest, CreateApiKeyRequest, CreateIndexRequest, CreateIndexRequest, CreateIndexResponse, CreateIndexResponse, CreateSnapshotRequest, CreateSnapshotResponse, CreateTokenRequest, DataCounts, DataDescription, DatafeedConfig, DatafeedStats, DatafeedTimingStats, DatafeedUpdate, DataFrameAnalyticsConfig, DataFrameAnalyticsDest, DataFrameAnalyticsSource, DateHistogramGroupConfig, DateHistogramGroupConfig.CalendarInterval, DateHistogramGroupConfig.FixedInterval, DateHistogramGroupSource, Decision.Single, DefaultShardOperationFailedException, DelayedDataCheckConfig, DelegatePkiAuthenticationRequest, DeleteAction, DeleteByQueryRequest, DeleteExpiredDataResponse, DeleteForecastRequest, DeleteJobResponse, DeleteResponse, DeleteRollupJobRequest, DestConfig, DetectionRule, Detector, DirectCandidateGeneratorBuilder, DisMaxQueryBuilder, DistanceFeatureQueryBuilder, DocWriteResponse, DynamicTemplate, EnvelopeBuilder, EstimateMemoryUsageResponse, EvaluateDataFrameRequest, EvaluateDataFrameResponse, ExceptRoleMapperExpression, ExecuteSnapshotLifecyclePolicyResponse, ExecuteWatchRequest, ExistsQueryBuilder, ExplainLifecycleResponse, ExplainRequest, ExplainResponse, FetchSourceContext, FieldCapabilities, FieldCapabilitiesResponse, FieldMaskingSpanQueryBuilder, FieldRoleMapperExpression, FieldSortBuilder, FieldStats, FileStructure, FilterRef, FindFileStructureResponse, FlushJobRequest, FlushJobResponse, FlushResponse, ForceMergeAction, ForceMergeResponse, ForecastJobRequest, ForecastJobResponse, ForecastStats, ForgetFollowerRequest, FreezeAction, FsInfo.Path, FunctionScoreQueryBuilder, FunctionScoreQueryBuilder.FilterFunctionBuilder, FuzzyQueryBuilder, GeoBoundingBoxQueryBuilder, GeoDistanceAggregationBuilder.Range, GeoDistanceQueryBuilder, GeoDistanceSortBuilder, GeometryCollectionBuilder, GeoPolygonQueryBuilder, GeoQueryContext, GeoShapeQueryBuilder, GetAliasesResponse, GetApiKeyRequest, GetBucketsRequest, GetBucketsResponse, GetCalendarEventsRequest, GetCalendarEventsResponse, GetCalendarsRequest, GetCalendarsResponse, GetCategoriesRequest, GetCategoriesResponse, GetDatafeedRequest, GetDatafeedResponse, GetDatafeedStatsRequest, GetDatafeedStatsResponse, GetFieldMappingsResponse, GetFiltersRequest, GetFiltersResponse, GetIndexResponse, GetIndexTemplatesResponse, GetInfluencersRequest, GetInfluencersResponse, GetJobRequest, GetJobResponse, GetJobStatsRequest, GetJobStatsResponse, GetLifecyclePolicyResponse, GetModelSnapshotsRequest, GetModelSnapshotsResponse, GetOverallBucketsRequest, GetOverallBucketsResponse, GetPipelineResponse, GetRecordsRequest, GetRecordsResponse, GetRepositoriesResponse, GetResponse, GetResult, GetRollupCapsRequest, GetRollupIndexCapsRequest, GetSettingsResponse, GetSnapshotLifecyclePolicyResponse, GetSnapshotLifecycleStatsResponse, GetSnapshotsResponse, GetStoredScriptResponse, GetTaskResponse, GlobalPrivileges, GraphExploreRequest, GraphExploreResponse, GroupConfig, GroupConfig, HasPrivilegesRequest, HighlightBuilder, HighlightBuilder.Field, HistogramGroupConfig, HistogramGroupSource, IdsQueryBuilder, Index, IndexGraveyard.Tombstone, IndexId, IndexLifecycleExplainResponse, IndexResponse, IndicesAliasesRequest, IndicesAliasesRequest.AliasActions, IndicesPrivileges, IndicesSegmentResponse, IndicesShardStoresResponse.Failure, IndicesStatsResponse, Influence, Influencer, InnerHitBuilder, InternalOrder, InternalOrder.Aggregation, InternalOrder.CompoundOrder, IntervalQueryBuilder, IntervalsSourceProvider.IntervalFilter, InvalidateApiKeyRequest, InvalidateTokenRequest, IpRangeAggregationBuilder.Range, Job, JobStats, JobUpdate, JobUpdate.DetectorUpdate, LifecyclePolicy, LifecyclePolicyMetadata, LineStringBuilder, ListTasksResponse, MainResponse, MatchAllQueryBuilder, MatchBoolPrefixQueryBuilder, MatchNoneQueryBuilder, MatchPhrasePrefixQueryBuilder, MatchPhraseQueryBuilder, MatchQueryBuilder, MetricConfig, MlFilter, ModelPlotConfig, ModelSizeStats, ModelSnapshot, MoreLikeThisQueryBuilder, MoreLikeThisQueryBuilder.Item, MoveAllocationCommand, MultiGetRequest, MultiGetRequest.Item, MultiGetResponse, MultiGetResponse.Failure, MultiLineStringBuilder, MultiMatchQueryBuilder, MultiPointBuilder, MultiPolygonBuilder, MultiSearchResponse, MultiSearchTemplateResponse, MultiTermVectorsRequest, MultiTermVectorsResponse, MultiValuesSourceFieldConfig, NestedQueryBuilder, NestedSortBuilder, NodeAllocationResult, NodeAttributes, NodeAttributes, OpenIndexResponse, OpenJobRequest, OpenJobResponse, OverallBucket, OverallBucket.JobInfo, PageParams, PendingClusterTasksResponse, PersistentTasksCustomMetaData.PersistentTask, PersistentTasksNodeService.Status, Phase, PhaseExecutionInfo, PhaseProgress, PipelineConfiguration, PivotConfig, PluginInfo, PointBuilder, PolygonBuilder, PostCalendarEventRequest, PostCalendarEventResponse, PostDataRequest, PostDataResponse, PrefixQueryBuilder, PreviewDatafeedRequest, PreviewDatafeedResponse, PreviewTransformRequest, PrimaryReplicaSyncer.ResyncTask.Status, ProcessorInfo, ProfileResult, PublishClusterStateStats, PutAutoFollowPatternRequest, PutCalendarRequest, PutCalendarResponse, PutDatafeedRequest, PutDatafeedResponse, PutDataFrameAnalyticsRequest, PutFilterRequest, PutFilterResponse, PutFollowRequest, PutIndexTemplateRequest, PutJobRequest, PutJobResponse, PutLifecyclePolicyRequest, PutMappingRequest, PutMappingRequest, PutPipelineRequest, PutPolicyRequest, PutPrivilegesRequest, PutRepositoryRequest, PutRoleMappingRequest, PutRoleRequest, PutRollupJobRequest, PutSnapshotLifecyclePolicyRequest, PutTransformRequest, PutUserRequest, Quantiles, QueryConfig, QueryConfig, QueryProfileShardResult, QueryRescorerBuilder, QueryStringQueryBuilder, RangeAggregator.Range, RangeQueryBuilder, RankEvalResponse, RankEvalSpec, RatedDocument, RatedRequest, RatedSearchHit, RawTaskStatus, ReadOnlyAction, RecoveryResponse, RecoverySource, RecoverySource.EmptyStoreRecoverySource, RecoverySource.ExistingStoreRecoverySource, RecoverySource.LocalShardsRecoverySource, RecoverySource.PeerRecoverySource, RecoverySource.SnapshotRecoverySource, RecoveryState.File, RefreshResponse, RegexpQueryBuilder, ReindexRequest, RemoteInfo, RemoteInfoResponse, ReplicationResponse.ShardInfo, ReplicationResponse.ShardInfo.Failure, ReplicationTask.Status, RepositoryCleanupResult, RerouteExplanation, RescorerBuilder, ResizeRequest, ResizeResponse, RestoreInfo, RestoreSnapshotRequest, RestoreSnapshotResponse, ResumeFollowRequest, RetentionLease, RevertModelSnapshotRequest, RevertModelSnapshotResponse, RolloverAction, RolloverRequest, RolloverRequest, RolloverResponse, RolloverResponse, RollupJobCaps, RollupJobConfig, RuleCondition, RuleScope, ScheduledEvent, ScoreSortBuilder, Script, ScriptQueryBuilder, ScriptScoreQueryBuilder, ScriptSortBuilder, ScrollableHitSource.SearchFailure, SearchAfterBuilder, SearchHit, SearchResponse, SearchScrollRequest, SearchSourceBuilder, SearchSourceBuilder.IndexBoost, SearchTemplateRequest, SearchTemplateResponse, SecureSetting, SetPriorityAction, Setting, Setting.AffixSetting, ShapeBuilder, ShardOperationFailedException, ShardRouting, ShardsAcknowledgedResponse, ShardSearchFailure, ShrinkAction, SimpleQueryStringBuilder, SimpleStats, SimulateDocumentBaseResult, SimulateDocumentVerboseResult, SimulatePipelineRequest, SimulatePipelineResponse, SimulateProcessorResult, SingleGroupSource, SliceBuilder, SnapshotId, SnapshotInvocationRecord, SnapshotLifecyclePolicy, SnapshotLifecyclePolicyMetadata, SnapshotLifecyclePolicyMetadata.SnapshotInProgress, SnapshotLifecycleStats, SnapshotRetentionConfiguration, SnapshotShardFailure, SnapshotShardsStats, SnapshotsStatusResponse, SnapshotStats, SnapshotStatus, SortBuilder, SourceConfig, SpanContainingQueryBuilder, SpanFirstQueryBuilder, SpanMultiTermQueryBuilder, SpanNearQueryBuilder, SpanNearQueryBuilder.SpanGapQueryBuilder, SpanNotQueryBuilder, SpanOrQueryBuilder, SpanTermQueryBuilder, SpanWithinQueryBuilder, StartDatafeedRequest, StartDatafeedResponse, StopDatafeedRequest, StopDatafeedResponse, StopDataFrameAnalyticsResponse, StoredScriptSource, SuggestBuilder, SyncedFlushResponse, TaskGroup, TaskResult, TemplateRoleName, TermQueryBuilder, TermsGroupConfig, TermsGroupSource, TermsQueryBuilder, TermsSetQueryBuilder, TermVectorsRequest, TermVectorsResponse, TimingStats, TransformConfig, TransformConfigUpdate, TypeQueryBuilder, UnfollowAction, UpdateByQueryRequest, UpdateDatafeedRequest, UpdateFilterRequest, UpdateJobRequest, UpdateModelSnapshotRequest, UpdateModelSnapshotResponse, UpdateRequest, UpdateResponse, UpdateSettingsRequest, UpdateTransformRequest, UpgradeResponse, UpgradeStatusResponse, ValidateQueryRequest, ValidateQueryResponse, VerifyRepositoryResponse, VerifyRepositoryResponse.NodeView, VertexRequest, WildcardQueryBuilder, WrapperQueryBuilder

public interface ToXContentObject
extends ToXContent

An interface allowing to transfer an object to "XContent" using an XContentBuilder. The difference between ToXContentFragment and ToXContentObject is that the former outputs a fragment that requires to start and end a new anonymous object externally, while the latter guarantees that what gets printed out is fully valid syntax without any external addition.

Nested Class Summary

Nested classes/interfaces inherited from interface org.elasticsearch.common.xcontent.ToXContent

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Field Summary

Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent

EMPTY_PARAMS

Method Summary

Modifier and Type	Method	Description
default boolean	isFragment()

Methods inherited from interface org.elasticsearch.common.xcontent.ToXContent

toXContent

Method Detail

isFragment

default boolean isFragment()

Specified by:

isFragment in interface ToXContent