Module org.elasticsearch.server

Package org.elasticsearch.health

Record Class UserAction

java.lang.Object

java.lang.Record

org.elasticsearch.health.UserAction

Record Components:

definition - The definition of the user action (e.g. message, helpURL)

affectedResources - Optional list of "things" that this action should be taken on (e.g. shards, indices, or policies).

All Implemented Interfaces:

ToXContent, ToXContentObject

public record UserAction(UserAction.Definition definition, List<String> affectedResources)
extends Record
implements ToXContentObject

Details a potential action that a user could take to clear an issue identified by a HealthService.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	UserAction.Definition	Details a potential action that a user could take to clear an issue identified by a HealthService.

Nested classes/interfaces inherited from interface org.elasticsearch.xcontent.ToXContent

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Field Summary

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
UserAction(UserAction.Definition definition, List<String> affectedResources)	Creates an instance of a UserAction record class.

Method Summary

Modifier and Type	Method	Description
List<String>	affectedResources()	Returns the value of the affectedResources record component.
UserAction.Definition	definition()	Returns the value of the definition 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.
final String	toString()	Returns a string representation of this record class.
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)

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

UserAction

public UserAction(UserAction.Definition definition,
 @Nullable
 List<String> affectedResources)

Creates an instance of a UserAction record class.

Parameters:

definition - the value for the definition record component

affectedResources - the value for the affectedResources record component

Method Details

toXContent

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

Specified by:

toXContent in interface ToXContent

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.

definition

public UserAction.Definition definition()

Returns the value of the definition record component.

Returns:

the value of the definition record component

affectedResources

@Nullable
public List<String> affectedResources()

Returns the value of the affectedResources record component.

Returns:

the value of the affectedResources record component