Module org.elasticsearch.server

Package org.elasticsearch.cluster

Interface ClusterState.Custom

All Superinterfaces:

Diffable<ClusterState.Custom>, NamedDiffable<ClusterState.Custom>, NamedWriteable, ToXContent, ToXContentFragment, VersionedNamedWriteable, Writeable

All Known Implementing Classes:

RepositoryCleanupInProgress, RestoreInProgress, SnapshotDeletionsInProgress, SnapshotsInProgress

Enclosing class:

ClusterState

public static interface ClusterState.Custom
extends NamedDiffable<ClusterState.Custom>, ToXContentFragment

Nested Class Summary

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

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable

Writeable.Reader<V>, Writeable.Writer<V>

Field Summary

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY_PARAMS

Method Summary

Modifier and Type	Method	Description
default boolean	isPrivate()	Returns true iff this ClusterState.Custom is private to the cluster and should never be send to a client.
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)	Serialize this ClusterState.Custom for diagnostic purposes, exposed by the

Methods inherited from interface org.elasticsearch.cluster.Diffable

diff

Methods inherited from interface org.elasticsearch.xcontent.ToXContentFragment

isFragment

Methods inherited from interface org.elasticsearch.common.io.stream.VersionedNamedWriteable

getMinimalSupportedVersion, getWriteableName

Methods inherited from interface org.elasticsearch.common.io.stream.Writeable

writeTo

Method Details

isPrivate

default boolean isPrivate()

Returns true iff this ClusterState.Custom is private to the cluster and should never be send to a client. The default is false;

toXContent

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

Serialize this ClusterState.Custom for diagnostic purposes, exposed by the

GET _cluster/state

API etc. The XContent representation does not need to be 100% faithful since we never reconstruct a cluster state from its XContent representation, but the more faithful it is the more useful it is for diagnostics.

Specified by:

toXContent in interface ToXContent

Throws:

IOException