Package org.opensearch.cluster

Interface ClusterState.Custom

All Superinterfaces:
ClusterState.FeatureAware, Diffable<ClusterState.Custom>, NamedDiffable<ClusterState.Custom>, org.opensearch.core.common.io.stream.NamedWriteable, org.opensearch.core.xcontent.ToXContent, org.opensearch.core.xcontent.ToXContentFragment, org.opensearch.core.common.io.stream.VersionedNamedWriteable, org.opensearch.core.common.io.stream.Writeable
All Known Implementing Classes:
RepositoryCleanupInProgress, RestoreInProgress, SnapshotDeletionsInProgress, SnapshotsInProgress
Enclosing class:
ClusterState
@PublicApi(since="1.0.0") public static interface ClusterState.Custom extends NamedDiffable<ClusterState.Custom>, org.opensearch.core.xcontent.ToXContentFragment, ClusterState.FeatureAware
Custom cluster state.
Opensearch.api:

  • Nested Class Summary

    Nested classes/interfaces inherited from interface org.opensearch.core.xcontent.ToXContent

    org.opensearch.core.xcontent.ToXContent.DelegatingMapParams, org.opensearch.core.xcontent.ToXContent.MapParams, org.opensearch.core.xcontent.ToXContent.Params

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

    org.opensearch.core.common.io.stream.Writeable.Reader<V>, org.opensearch.core.common.io.stream.Writeable.WriteableRegistry, org.opensearch.core.common.io.stream.Writeable.Writer<V>

  • Field Summary

    Fields inherited from interface org.opensearch.core.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.

    Methods inherited from interface org.opensearch.cluster.ClusterState.FeatureAware

    getRequiredFeature

    Methods inherited from interface org.opensearch.cluster.Diffable

    diff

    Methods inherited from interface org.opensearch.core.xcontent.ToXContent

    toXContent

    Methods inherited from interface org.opensearch.core.xcontent.ToXContentFragment

    isFragment

    Methods inherited from interface org.opensearch.core.common.io.stream.VersionedNamedWriteable

    getMinimalSupportedVersion, getWriteableName

    Methods inherited from interface org.opensearch.core.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;