Module org.elasticsearch.server

Package org.elasticsearch.cluster.metadata

Record Class ReservedStateErrorMetadata

java.lang.Object

java.lang.Record

org.elasticsearch.cluster.metadata.ReservedStateErrorMetadata

All Implemented Interfaces:

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

public record ReservedStateErrorMetadata(Long version, ReservedStateErrorMetadata.ErrorKind errorKind, List<String> errors)
extends Record
implements SimpleDiffable<ReservedStateErrorMetadata>, ToXContentFragment

A metadata class to hold error information about errors encountered while applying a cluster state update for a given namespace.

This information is held by the ReservedStateMetadata class.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	ReservedStateErrorMetadata.ErrorKind	Enum for kinds of errors we might encounter while processing reserved cluster state updates.

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
ReservedStateErrorMetadata(Long version, ReservedStateErrorMetadata.ErrorKind errorKind, List<String> errors)	Constructs a reserved state error metadata

Method Summary

Modifier and Type	Method	Description
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
ReservedStateErrorMetadata.ErrorKind	errorKind()	Returns the value of the errorKind record component.
List<String>	errors()	Returns the value of the errors record component.
static ReservedStateErrorMetadata	fromXContent(XContentParser parser)	Reads an ReservedStateErrorMetadata from xContent
final int	hashCode()	Returns a hash code value for this object.
static Diff<ReservedStateErrorMetadata>	readDiffFrom(StreamInput in)	Reads an ReservedStateErrorMetadata Diff from StreamInput
static ReservedStateErrorMetadata	readFrom(StreamInput in)	Reads an ReservedStateErrorMetadata 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

ReservedStateErrorMetadata

public ReservedStateErrorMetadata(Long version,
 ReservedStateErrorMetadata.ErrorKind errorKind,
 List<String> errors)

Constructs a reserved state error metadata

Parameters:

version - the metadata version of the content which failed to apply

errorKind - the kind of error we encountered while processing

errors - the list of errors encountered during parsing and validation of the reserved state content

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 ReservedStateErrorMetadata readFrom(StreamInput in)
                                           throws IOException

Reads an ReservedStateErrorMetadata from a StreamInput

Parameters:

in - the StreamInput to read from

Returns:

ReservedStateErrorMetadata

Throws:

IOException

toXContent

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

Specified by:

toXContent in interface ToXContent

Throws:

IOException

fromXContent

public static ReservedStateErrorMetadata fromXContent(XContentParser parser)

Reads an ReservedStateErrorMetadata from xContent

Parameters:

parser - XContentParser

Returns:

ReservedStateErrorMetadata

readDiffFrom

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

Reads an ReservedStateErrorMetadata Diff from StreamInput

Parameters:

in - the StreamInput to read the diff from

Returns:

a Diff of ReservedStateErrorMetadata

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.

version

public Long version()

Returns the value of the version record component.

Returns:

the value of the version record component

errorKind

public ReservedStateErrorMetadata.ErrorKind errorKind()

Returns the value of the errorKind record component.

Returns:

the value of the errorKind record component

errors

public List<String> errors()

Returns the value of the errors record component.

Returns:

the value of the errors record component