Module org.elasticsearch.server

Package org.elasticsearch.cluster

Interface ClusterState.Custom

All Superinterfaces:

ChunkedToXContent, Diffable<ClusterState.Custom>, NamedDiffable<ClusterState.Custom>, NamedWriteable, VersionedNamedWriteable, Writeable

All Known Implementing Classes:

HealthMetadata, RepositoryCleanupInProgress, RestoreInProgress, SnapshotDeletionsInProgress, SnapshotsInProgress

Enclosing class:

ClusterState

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

Nested Class Summary

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.common.xcontent.ChunkedToXContent

EMPTY

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 sent to a client.
Iterator<? extends ToXContent>	toXContentChunked(ToXContent.Params params)	Serialize this ClusterState.Custom for diagnostic purposes, exposed by the

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

isFragment, toXContentChunkedV7

Methods inherited from interface org.elasticsearch.cluster.Diffable

diff

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 sent to a client. The default is false;

toXContentChunked

Iterator<? extends ToXContent> toXContentChunked(ToXContent.Params params)

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:

toXContentChunked in interface ChunkedToXContent

Returns:

iterator over chunks of ToXContent