Module org.elasticsearch.server
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
ConstructorDescriptionReservedStateHandlerMetadata
(String name, Set<String> keys) Creates an instance of aReservedStateHandlerMetadata
record class. -
Method Summary
Modifier and TypeMethodDescriptionfinal boolean
Indicates whether some other object is "equal to" this one.static ReservedStateHandlerMetadata
fromXContent
(XContentParser parser, String name) Reads anReservedStateHandlerMetadata
from xContentfinal int
hashCode()
Returns a hash code value for this object.keys()
Returns the value of thekeys
record component.name()
Returns the value of thename
record component.static Diff<ReservedStateHandlerMetadata>
static ReservedStateHandlerMetadata
readFrom
(StreamInput in) Reads anReservedStateHandlerMetadata
from aStreamInput
final String
toString()
Returns a string representation of this record class.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
Creates an instance of aReservedStateHandlerMetadata
record class.- Parameters:
name
- the value for thename
record componentkeys
- the value for thekeys
record component
-
-
Method Details
-
writeTo
Description copied from interface:Writeable
Write this into the StreamOutput.- Specified by:
writeTo
in interfaceWriteable
- Throws:
IOException
-
readFrom
Reads anReservedStateHandlerMetadata
from aStreamInput
- Parameters:
in
- theStreamInput
to read from- Returns:
ReservedStateHandlerMetadata
- Throws:
IOException
-
toXContent
public XContentBuilder toXContent(XContentBuilder builder, ToXContent.Params params) throws IOException - Specified by:
toXContent
in interfaceToXContent
- Throws:
IOException
-
fromXContent
public static ReservedStateHandlerMetadata fromXContent(XContentParser parser, String name) throws IOException Reads anReservedStateHandlerMetadata
from xContent- Parameters:
parser
-XContentParser
- Returns:
ReservedStateHandlerMetadata
- Throws:
IOException
-
readDiffFrom
- Parameters:
in
- theStreamInput
to read the diff from- Returns:
- a
Diff
ofReservedStateHandlerMetadata
- Throws:
IOException
-
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. -
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. -
equals
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 withObjects::equals(Object,Object)
. -
name
Returns the value of thename
record component.- Returns:
- the value of the
name
record component
-
keys
Returns the value of thekeys
record component.- Returns:
- the value of the
keys
record component
-