java.lang.Object
java.lang.Record
org.elasticsearch.plugins.PluginRuntimeInfo
- Record Components:
descriptor- Static information about the pluginisOfficial-trueif the plugin is an official plugin, orfalseotherwise. For nodes before 8.3.0 this isnull.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.ParamsNested 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
ConstructorsConstructorDescriptionPluginRuntimeInfo(PluginDescriptor descriptor) PluginRuntimeInfo(PluginDescriptor descriptor, Boolean isOfficial, PluginApiInfo pluginApiInfo) Creates an instance of aPluginRuntimeInforecord class. -
Method Summary
Modifier and TypeMethodDescriptionReturns the value of thedescriptorrecord component.final booleanIndicates whether some other object is "equal to" this one.final inthashCode()Returns a hash code value for this object.Returns the value of theisOfficialrecord component.Returns the value of thepluginApiInforecord component.final StringtoString()Returns a string representation of this record class.toXContent(XContentBuilder builder, ToXContent.Params params) voidwriteTo(StreamOutput out) Write this into the StreamOutput.Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface org.elasticsearch.xcontent.ToXContentObject
isFragment
-
Constructor Details
-
PluginRuntimeInfo
-
PluginRuntimeInfo
- Throws:
IOException
-
PluginRuntimeInfo
public PluginRuntimeInfo(PluginDescriptor descriptor, @Nullable Boolean isOfficial, @Nullable PluginApiInfo pluginApiInfo) Creates an instance of aPluginRuntimeInforecord class.- Parameters:
descriptor- the value for thedescriptorrecord componentisOfficial- the value for theisOfficialrecord componentpluginApiInfo- the value for thepluginApiInforecord component
-
-
Method Details
-
toXContent
public XContentBuilder toXContent(XContentBuilder builder, ToXContent.Params params) throws IOException - Specified by:
toXContentin interfaceToXContent- Throws:
IOException
-
writeTo
Description copied from interface:WriteableWrite this into the StreamOutput.- Specified by:
writeToin interfaceWriteable- 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). -
descriptor
Returns the value of thedescriptorrecord component.- Returns:
- the value of the
descriptorrecord component
-
isOfficial
Returns the value of theisOfficialrecord component.- Returns:
- the value of the
isOfficialrecord component
-
pluginApiInfo
Returns the value of thepluginApiInforecord component.- Returns:
- the value of the
pluginApiInforecord component
-