Module org.elasticsearch.server

Package org.elasticsearch.plugins

Record Class PluginApiInfo

java.lang.Object

java.lang.Record

org.elasticsearch.plugins.PluginApiInfo

Record Components:

legacyInterfaces - Plugin API interfaces that the plugin implemented, introspected at runtime.

legacyMethods - Method names overriden from the Plugin class and Plugin API interfaces

All Implemented Interfaces:

Writeable, ToXContent, ToXContentFragment

public record PluginApiInfo(List<String> legacyInterfaces, List<String> legacyMethods)
extends Record
implements Writeable, ToXContentFragment

Information about APIs extended by a custom plugin.

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
PluginApiInfo(List<String> legacyInterfaces, List<String> legacyMethods)	Creates an instance of a PluginApiInfo record class.
PluginApiInfo(StreamInput in)

Method Summary

Modifier and Type	Method	Description
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.
List<String>	legacyInterfaces()	Returns the value of the legacyInterfaces record component.
List<String>	legacyMethods()	Returns the value of the legacyMethods 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.ToXContentFragment

isFragment

Constructor Details

PluginApiInfo

public PluginApiInfo(StreamInput in)
              throws IOException

Throws:

IOException

PluginApiInfo

public PluginApiInfo(List<String> legacyInterfaces,
 List<String> legacyMethods)

Creates an instance of a PluginApiInfo record class.

Parameters:

legacyInterfaces - the value for the legacyInterfaces record component

legacyMethods - the value for the legacyMethods 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.

legacyInterfaces

public List<String> legacyInterfaces()

Returns the value of the legacyInterfaces record component.

Returns:

the value of the legacyInterfaces record component

legacyMethods

public List<String> legacyMethods()

Returns the value of the legacyMethods record component.

Returns:

the value of the legacyMethods record component