Module org.elasticsearch.server

Package org.elasticsearch.cluster.metadata

Record Class ReservedStateMetadata

java.lang.Object

java.lang.Record

org.elasticsearch.cluster.metadata.ReservedStateMetadata

All Implemented Interfaces:

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

public record ReservedStateMetadata(String namespace, Long version, Map<String,ReservedStateHandlerMetadata> handlers, ReservedStateErrorMetadata errorMetadata)
extends Record
implements SimpleDiffable<ReservedStateMetadata>, ToXContentFragment

Metadata class that contains information about reserved cluster state set through file based settings or by modules/plugins.

These types of cluster settings/entities can be read through the REST API, but can only be modified through a versioned 'operator mode' update, e.g. file based settings or module/plugin upgrade.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ReservedStateMetadata.Builder	Builder class for ReservedStateMetadata

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
ReservedStateMetadata(String namespace, Long version, Map<String,ReservedStateHandlerMetadata> handlers, ReservedStateErrorMetadata errorMetadata)	ReservedStateMetadata contains information about reserved cluster settings.

Method Summary

Modifier and Type	Method	Description
static ReservedStateMetadata.Builder	builder(String namespace)	Convenience method for creating a ReservedStateMetadata.Builder for ReservedStateMetadata
static ReservedStateMetadata.Builder	builder(String namespace, ReservedStateMetadata metadata)	Convenience method for creating a ReservedStateMetadata.Builder for ReservedStateMetadata
Set<String>	conflicts(String handlerName, Set<String> modified)	Creates a set intersection between cluster state keys set by a given ReservedClusterStateHandler and the input set.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
ReservedStateErrorMetadata	errorMetadata()	Returns the value of the errorMetadata record component.
static ReservedStateMetadata	fromXContent(XContentParser parser)	Reads ReservedStateMetadata from XContentParser
Map<String,ReservedStateHandlerMetadata>	handlers()	Returns the value of the handlers record component.
final int	hashCode()	Returns a hash code value for this object.
String	namespace()	Returns the value of the namespace record component.
static Diff<ReservedStateMetadata>	readDiffFrom(StreamInput in)	Reads an ReservedStateMetadata Diff from StreamInput
static ReservedStateMetadata	readFrom(StreamInput in)	Reads an ReservedStateMetadata from a StreamInput
final String	toString()	Returns a string representation of this record class.
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
Long	version()	Returns the value of the version record component.
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

ReservedStateMetadata

public ReservedStateMetadata(String namespace,
 Long version,
 Map<String,ReservedStateHandlerMetadata> handlers,
 ReservedStateErrorMetadata errorMetadata)

ReservedStateMetadata contains information about reserved cluster settings.

These settings cannot be updated by the end user and are set outside of the REST layer, e.g. through file based settings or by plugin/modules.

Parameters:

namespace - The namespace of the setting creator, e.g. file_settings, security plugin, etc.

version - The update version, must increase with each update

handlers - Per state update handler information on key set in by this update. These keys are validated at REST time.

errorMetadata - If the update failed for some reason, this is where we store the error information metadata.

Method Details

conflicts

public Set<String> conflicts(String handlerName,
 Set<String> modified)

Creates a set intersection between cluster state keys set by a given ReservedClusterStateHandler and the input set.

This method is to be used to check if a REST action handler is allowed to modify certain cluster state.

Parameters:

handlerName - the name of the reserved state handler we need to check for keys

modified - a set of keys we want to see if we can modify.

Returns:

readFrom

public static ReservedStateMetadata readFrom(StreamInput in)
                                      throws IOException

Reads an ReservedStateMetadata from a StreamInput

Parameters:

in - the StreamInput to read from

Returns:

ReservedStateMetadata

Throws:

IOException

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

readDiffFrom

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

Reads an ReservedStateMetadata Diff from StreamInput

Parameters:

in - the StreamInput to read the diff from

Returns:

a Diff of ReservedStateMetadata

Throws:

IOException

builder

public static ReservedStateMetadata.Builder builder(String namespace)

Convenience method for creating a ReservedStateMetadata.Builder for ReservedStateMetadata

Parameters:

namespace - the namespace under which we'll store the ReservedStateMetadata

Returns:

ReservedStateMetadata.Builder

builder

public static ReservedStateMetadata.Builder builder(String namespace,
 ReservedStateMetadata metadata)

Convenience method for creating a ReservedStateMetadata.Builder for ReservedStateMetadata

Parameters:

namespace - the namespace under which we'll store the ReservedStateMetadata

metadata - an existing ReservedStateMetadata

Returns:

ReservedStateMetadata.Builder

toXContent

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

Specified by:

toXContent in interface ToXContent

Throws:

IOException

fromXContent

public static ReservedStateMetadata fromXContent(XContentParser parser)
                                          throws IOException

Reads ReservedStateMetadata from XContentParser

Parameters:

parser - XContentParser

Returns:

ReservedStateMetadata

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.

namespace

public String namespace()

Returns the value of the namespace record component.

Returns:

the value of the namespace record component

version

public Long version()

Returns the value of the version record component.

Returns:

the value of the version record component

handlers

public Map<String,ReservedStateHandlerMetadata> handlers()

Returns the value of the handlers record component.

Returns:

the value of the handlers record component

errorMetadata

public ReservedStateErrorMetadata errorMetadata()

Returns the value of the errorMetadata record component.

Returns:

the value of the errorMetadata record component