Module org.elasticsearch.server

Package org.elasticsearch.cluster.metadata

Interface Metadata.Custom

All Superinterfaces:

ChunkedToXContent, Diffable<Metadata.Custom>, NamedDiffable<Metadata.Custom>, NamedWriteable, 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>, ChunkedToXContent

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.common.io.stream.Writeable

Writeable.Reader<V>, Writeable.Writer<V>

Method Summary

Modifier and Type	Method	Description
EnumSet<Metadata.XContentContext>	context()
default boolean	isRestorable()

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

isFragment, toXContentChunked, 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

context

EnumSet<Metadata.XContentContext> context()

isRestorable

default boolean isRestorable()

Returns:

true if this custom could be restored from snapshot