Package org.elasticsearch.cluster.metadata

Interface Metadata.Custom

All Superinterfaces:
Diffable<Metadata.Custom>, NamedDiffable<Metadata.Custom>, NamedWriteable, org.elasticsearch.xcontent.ToXContent, org.elasticsearch.xcontent.ToXContentFragment, VersionedNamedWriteable, Writeable
All Known Implementing Classes:
ComponentTemplateMetadata, ComposableIndexTemplateMetadata, DataStreamMetadata, DesiredNodesMetadata, ElasticsearchNodeCommand.UnknownMetadataCustom, FeatureMigrationResults, IndexGraveyard, IngestMetadata, NodesShutdownMetadata, PersistentTasksCustomMetadata, RepositoriesMetadata, ScriptMetadata
Enclosing class:
Metadata
public static interface Metadata.Custom extends NamedDiffable<Metadata.Custom>, org.elasticsearch.xcontent.ToXContentFragment
Custom metadata that persists (via XContent) across restarts. The deserialization method for each implementation must be registered with the NamedXContentRegistry.

  • Nested Class Summary

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

    org.elasticsearch.xcontent.ToXContent.DelegatingMapParams, org.elasticsearch.xcontent.ToXContent.MapParams, org.elasticsearch.xcontent.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
    EnumSet<Metadata.XContentContext>
    context()
     
    default boolean
    isRestorable()
     

    Methods inherited from interface org.elasticsearch.cluster.Diffable

    diff

    Methods inherited from interface org.elasticsearch.xcontent.ToXContent

    toXContent

    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

    • context

      EnumSet<Metadata.XContentContext> context()

    • isRestorable

      default boolean isRestorable()
      Returns:
      true if this custom could be restored from snapshot