Module org.elasticsearch.server

Package org.elasticsearch.plugins

Record Class PluginRuntimeInfo

java.lang.Object

java.lang.Record

org.elasticsearch.plugins.PluginRuntimeInfo

Record Components:

descriptor - Static information about the plugin

isOfficial - true if the plugin is an official plugin, or false otherwise. For nodes before 8.3.0 this is null.

pluginApiInfo - Runtime information about a custom plugin

All Implemented Interfaces:

Writeable, ToXContent, ToXContentObject

public record PluginRuntimeInfo(PluginDescriptor descriptor, Boolean isOfficial, PluginApiInfo pluginApiInfo)
extends Record
implements Writeable, ToXContentObject

Runtime information about a plugin that was loaded.

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
PluginRuntimeInfo(StreamInput in)
PluginRuntimeInfo(PluginDescriptor descriptor)
PluginRuntimeInfo(PluginDescriptor descriptor, Boolean isOfficial, PluginApiInfo pluginApiInfo)	Creates an instance of a PluginRuntimeInfo record class.

Method Summary

Modifier and Type	Method	Description
PluginDescriptor	descriptor()	Returns the value of the descriptor record component.
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.
Boolean	isOfficial()	Returns the value of the isOfficial record component.
PluginApiInfo	pluginApiInfo()	Returns the value of the pluginApiInfo record component.
final String	toString()	Returns a string representation of this record class.
XContentBuilder	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.xcontent.ToXContentObject

isFragment

Constructor Details

PluginRuntimeInfo

public PluginRuntimeInfo(PluginDescriptor descriptor)

PluginRuntimeInfo

public PluginRuntimeInfo(StreamInput in)
                  throws IOException

Throws:

IOException

PluginRuntimeInfo

public PluginRuntimeInfo(PluginDescriptor descriptor,
 @Nullable
 Boolean isOfficial,
 @Nullable
 PluginApiInfo pluginApiInfo)

Creates an instance of a PluginRuntimeInfo record class.

Parameters:

descriptor - the value for the descriptor record component

isOfficial - the value for the isOfficial record component

pluginApiInfo - the value for the pluginApiInfo record component

Method Details

toXContent

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

Specified by:

toXContent in interface ToXContent

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

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.

descriptor

public PluginDescriptor descriptor()

Returns the value of the descriptor record component.

Returns:

the value of the descriptor record component

isOfficial

@Nullable
public Boolean isOfficial()

Returns the value of the isOfficial record component.

Returns:

the value of the isOfficial record component

pluginApiInfo

@Nullable
public PluginApiInfo pluginApiInfo()

Returns the value of the pluginApiInfo record component.

Returns:

the value of the pluginApiInfo record component