- 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 TypeMethodDescriptiondefault booleanReturnstrueiff thisClusterState.Customis private to the cluster and should never be sent to a client.Iterator<? extends ToXContent> toXContentChunked(ToXContent.Params params) Serialize thisClusterState.Customfor diagnostic purposes, exposed by theMethods inherited from interface org.elasticsearch.common.xcontent.ChunkedToXContent
isFragment, toXContentChunked, toXContentChunkedV8Methods inherited from interface org.elasticsearch.common.io.stream.VersionedNamedWriteable
getMinimalSupportedVersion, getWriteableName
-
Method Details
-
isPrivate
default boolean isPrivate()Returnstrueiff thisClusterState.Customis private to the cluster and should never be sent to a client. The default isfalse; -
toXContentChunked
Serialize thisClusterState.Customfor diagnostic purposes, exposed by theGET _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:
toXContentChunkedin interfaceChunkedToXContent- Returns:
- iterator over chunks of
ToXContent
-