Module org.elasticsearch.server
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
Modifier and TypeClassDescriptionstatic enum
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_PARAMS
-
Constructor Summary
ConstructorDescriptionReservedStateErrorMetadata
(Long version, ReservedStateErrorMetadata.ErrorKind errorKind, List<String> errors) Constructs a reserved state error metadata -
Method Summary
Modifier and TypeMethodDescriptionfinal boolean
Indicates whether some other object is "equal to" this one.Returns the value of theerrorKind
record component.errors()
Returns the value of theerrors
record component.static ReservedStateErrorMetadata
fromXContent
(XContentParser parser) Reads anReservedStateErrorMetadata
from xContentfinal int
hashCode()
Returns a hash code value for this object.static Diff<ReservedStateErrorMetadata>
static ReservedStateErrorMetadata
readFrom
(StreamInput in) Reads anReservedStateErrorMetadata
from aStreamInput
final String
toString()
Returns a string representation of this record class.toXContent
(XContentBuilder builder, ToXContent.Params params) version()
Returns the value of theversion
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 applyerrorKind
- the kind of error we encountered while processingerrors
- the list of errors encountered during parsing and validation of the reserved state content
-
-
Method Details
-
writeTo
Description copied from interface:Writeable
Write this into the StreamOutput.- Specified by:
writeTo
in interfaceWriteable
- Throws:
IOException
-
readFrom
Reads anReservedStateErrorMetadata
from aStreamInput
- Parameters:
in
- theStreamInput
to read from- Returns:
ReservedStateErrorMetadata
- Throws:
IOException
-
toXContent
public XContentBuilder toXContent(XContentBuilder builder, ToXContent.Params params) throws IOException - Specified by:
toXContent
in interfaceToXContent
- Throws:
IOException
-
fromXContent
Reads anReservedStateErrorMetadata
from xContent- Parameters:
parser
-XContentParser
- Returns:
ReservedStateErrorMetadata
-
readDiffFrom
- Parameters:
in
- theStreamInput
to read the diff from- Returns:
- a
Diff
ofReservedStateErrorMetadata
- 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)
. -
version
Returns the value of theversion
record component.- Returns:
- the value of the
version
record component
-
errorKind
Returns the value of theerrorKind
record component.- Returns:
- the value of the
errorKind
record component
-
errors
Returns the value of theerrors
record component.- Returns:
- the value of the
errors
record component
-