Interface ClusterState.Custom

All Superinterfaces:
ClusterState.FeatureAware, Diffable<ClusterState.Custom>, NamedDiffable<ClusterState.Custom>, NamedWriteable, ToXContent, ToXContentFragment, VersionedNamedWriteable, Writeable
All Known Implementing Classes:
RepositoryCleanupInProgress, RestoreInProgress, SnapshotDeletionsInProgress, SnapshotsInProgress
Enclosing class:

public static interface ClusterState.Custom extends NamedDiffable<ClusterState.Custom>, ToXContentFragment, ClusterState.FeatureAware
  • 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