Module org.elasticsearch.server

Package org.elasticsearch.action.datastreams

Record Class GetDataStreamAction.Response.IndexProperties

java.lang.Object

java.lang.Record

org.elasticsearch.action.datastreams.GetDataStreamAction.Response.IndexProperties

All Implemented Interfaces:

Writeable

Enclosing class:

GetDataStreamAction.Response

public static record GetDataStreamAction.Response.IndexProperties(boolean preferIlm, String ilmPolicyName, GetDataStreamAction.Response.ManagedBy managedBy)
extends Record
implements Writeable

Encapsulates the configured properties we want to display for each backing index. They'll usually be settings values, but could also be additional properties derived from settings.

Nested Class Summary

Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable

Writeable.Reader<V>, Writeable.Writer<V>

Constructor Summary

Constructors

Constructor	Description
IndexProperties(boolean preferIlm, String ilmPolicyName, GetDataStreamAction.Response.ManagedBy managedBy)	Creates an instance of a IndexProperties record class.
IndexProperties(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.
String	ilmPolicyName()	Returns the value of the ilmPolicyName record component.
GetDataStreamAction.Response.ManagedBy	managedBy()	Returns the value of the managedBy record component.
boolean	preferIlm()	Returns the value of the preferIlm record component.
final String	toString()	Returns a string representation of this record class.
void	writeTo(StreamOutput out)	Write this into the StreamOutput.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

IndexProperties

public IndexProperties(StreamInput in)
                throws IOException

Throws:

IOException

IndexProperties

public IndexProperties(boolean preferIlm,
 @Nullable
 String ilmPolicyName,
 GetDataStreamAction.Response.ManagedBy managedBy)

Creates an instance of a IndexProperties record class.

Parameters:

preferIlm - the value for the preferIlm record component

ilmPolicyName - the value for the ilmPolicyName record component

managedBy - the value for the managedBy record component

Method Details

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. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.

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.

preferIlm

public boolean preferIlm()

Returns the value of the preferIlm record component.

Returns:

the value of the preferIlm record component

ilmPolicyName

@Nullable
public String ilmPolicyName()

Returns the value of the ilmPolicyName record component.

Returns:

the value of the ilmPolicyName record component

managedBy

public GetDataStreamAction.Response.ManagedBy managedBy()

Returns the value of the managedBy record component.

Returns:

the value of the managedBy record component