Module org.elasticsearch.server

Package org.elasticsearch.cluster.version

Record Class CompatibilityVersions

java.lang.Object

java.lang.Record

org.elasticsearch.cluster.version.CompatibilityVersions

Record Components:

transportVersion - A transport version, usually a minimum compatible one for a node.

systemIndexMappingsVersion - A map of system index names to versions for their mappings.

All Implemented Interfaces:

Writeable, ToXContent, ToXContentFragment

public record CompatibilityVersions(TransportVersion transportVersion, Map<String,SystemIndexDescriptor.MappingsVersion> systemIndexMappingsVersion)
extends Record
implements Writeable, ToXContentFragment

Wraps component version numbers for cluster state

Cluster state will need to carry version information for different independently versioned components. This wrapper lets us wrap these versions one level below ClusterState. It's similar to VersionInformation, but this class is meant to be constructed during node startup and hold values from plugins as well.

Nested Class Summary

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.xcontent.ToXContent

EMPTY, EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
CompatibilityVersions(TransportVersion transportVersion, Map<String,SystemIndexDescriptor.MappingsVersion> systemIndexMappingsVersion)	Creates an instance of a CompatibilityVersions record class.

Method Summary

Modifier and Type	Method	Description
static void	ensureVersionsCompatibility(CompatibilityVersions candidate, Collection<CompatibilityVersions> existing)
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
static CompatibilityVersions	minimumVersions(Collection<CompatibilityVersions> compatibilityVersions)	Constructs a VersionWrapper collecting all the minimum versions from the values of the map.
static CompatibilityVersions	readVersion(StreamInput in)
Map<String,SystemIndexDescriptor.MappingsVersion>	systemIndexMappingsVersion()	Returns the value of the systemIndexMappingsVersion record component.
final String	toString()	Returns a string representation of this record class.
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)	Adds fields to the builder without starting an object.
TransportVersion	transportVersion()	Returns the value of the transportVersion 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.xcontent.ToXContentFragment

isFragment

Constructor Details

CompatibilityVersions

public CompatibilityVersions(TransportVersion transportVersion,
 Map<String,SystemIndexDescriptor.MappingsVersion> systemIndexMappingsVersion)

Creates an instance of a CompatibilityVersions record class.

Parameters:

transportVersion - the value for the transportVersion record component

systemIndexMappingsVersion - the value for the systemIndexMappingsVersion record component

Method Details

minimumVersions

public static CompatibilityVersions minimumVersions(Collection<CompatibilityVersions> compatibilityVersions)

Constructs a VersionWrapper collecting all the minimum versions from the values of the map.

Parameters:

compatibilityVersions - A map of strings (typically node identifiers) and versions wrappers

Returns:

Minimum versions for the cluster

ensureVersionsCompatibility

public static void ensureVersionsCompatibility(CompatibilityVersions candidate,
 Collection<CompatibilityVersions> existing)

readVersion

public static CompatibilityVersions readVersion(StreamInput in)
                                         throws IOException

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

toXContent

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

Adds fields to the builder without starting an object. We expect this method to be called within an object that may already have a nodeId field.

Specified by:

toXContent in interface ToXContent

Parameters:

builder - The builder for the XContent

params - Ignored here.

Returns:

The builder with fields for versions added

Throws:

IOException - if the builder can't accept what we try to add

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.

transportVersion

public TransportVersion transportVersion()

Returns the value of the transportVersion record component.

Returns:

the value of the transportVersion record component

systemIndexMappingsVersion

public Map<String,SystemIndexDescriptor.MappingsVersion> systemIndexMappingsVersion()

Returns the value of the systemIndexMappingsVersion record component.

Returns:

the value of the systemIndexMappingsVersion record component