Module org.elasticsearch.server

Package org.elasticsearch.cluster.metadata

Record Class ReservedStateHandlerMetadata

java.lang.Object

java.lang.Record

org.elasticsearch.cluster.metadata.ReservedStateHandlerMetadata

All Implemented Interfaces:

Diffable<ReservedStateHandlerMetadata>, SimpleDiffable<ReservedStateHandlerMetadata>, Writeable, ToXContent, ToXContentFragment

public record ReservedStateHandlerMetadata(String name, Set<String> keys)
extends Record
implements SimpleDiffable<ReservedStateHandlerMetadata>, ToXContentFragment

Metadata class to hold a set of reserved keys in the cluster state, set by each ReservedClusterStateHandler.

Since we hold reserved metadata state for multiple namespaces, the same handler can appear in multiple namespaces. See ReservedStateMetadata and Metadata.

Nested Class Summary

Nested classes/interfaces inherited from interface org.elasticsearch.cluster.SimpleDiffable

SimpleDiffable.CompleteDiff<T extends Diffable<T>>

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

ToXContent.DelegatingMapParams, ToXContent.MapParams, 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.cluster.SimpleDiffable

EMPTY

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY, EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
ReservedStateHandlerMetadata(String name, Set<String> keys)	Creates an instance of a ReservedStateHandlerMetadata record class.

Method Summary

Modifier and Type	Method	Description
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
static ReservedStateHandlerMetadata	fromXContent(XContentParser parser, String name)	Reads an ReservedStateHandlerMetadata from xContent
final int	hashCode()	Returns a hash code value for this object.
Set<String>	keys()	Returns the value of the keys record component.
String	name()	Returns the value of the name record component.
static Diff<ReservedStateHandlerMetadata>	readDiffFrom(StreamInput in)	Reads an ReservedStateHandlerMetadata Diff from StreamInput
static ReservedStateHandlerMetadata	readFrom(StreamInput in)	Reads an ReservedStateHandlerMetadata from a StreamInput
final String	toString()	Returns a string representation of this record class.
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
void	writeTo(StreamOutput out)	Write this into the StreamOutput.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.elasticsearch.cluster.SimpleDiffable

diff

Methods inherited from interface org.elasticsearch.xcontent.ToXContentFragment

isFragment

Constructor Details

ReservedStateHandlerMetadata

public ReservedStateHandlerMetadata(String name,
 Set<String> keys)

Creates an instance of a ReservedStateHandlerMetadata record class.

Parameters:

name - the value for the name record component

keys - the value for the keys record component

Method Details

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Description copied from interface: Writeable

Write this into the StreamOutput.

Specified by:

writeTo in interface Writeable

Throws:

IOException

readFrom

public static ReservedStateHandlerMetadata readFrom(StreamInput in)
                                             throws IOException

Reads an ReservedStateHandlerMetadata from a StreamInput

Parameters:

in - the StreamInput to read from

Returns:

ReservedStateHandlerMetadata

Throws:

IOException

toXContent

public XContentBuilder toXContent(XContentBuilder builder,
 ToXContent.Params params)
                           throws IOException

Specified by:

toXContent in interface ToXContent

Throws:

IOException

fromXContent

public static ReservedStateHandlerMetadata fromXContent(XContentParser parser,
 String name)
                                                 throws IOException

Reads an ReservedStateHandlerMetadata from xContent

Parameters:

parser - XContentParser

Returns:

ReservedStateHandlerMetadata

Throws:

IOException

readDiffFrom

public static Diff<ReservedStateHandlerMetadata> readDiffFrom(StreamInput in)
                                                       throws IOException

Reads an ReservedStateHandlerMetadata Diff from StreamInput

Parameters:

in - the StreamInput to read the diff from

Returns:

a Diff of ReservedStateHandlerMetadata

Throws:

IOException

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

name

public String name()

Returns the value of the name record component.

Returns:

the value of the name record component

keys

public Set<String> keys()

Returns the value of the keys record component.

Returns:

the value of the keys record component