Module org.elasticsearch.server

Package org.elasticsearch.action.datastreams

Record Class GetDataStreamSettingsAction.DataStreamSettingsResponse

java.lang.Object

java.lang.Record

org.elasticsearch.action.datastreams.GetDataStreamSettingsAction.DataStreamSettingsResponse

All Implemented Interfaces:

ToXContent

Enclosing class:

GetDataStreamSettingsAction

public static record GetDataStreamSettingsAction.DataStreamSettingsResponse(String dataStreamName, Settings settings, Settings effectiveSettings)
extends Record
implements ToXContent

Nested Class Summary

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, EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
DataStreamSettingsResponse(String dataStreamName, Settings settings, Settings effectiveSettings)	Creates an instance of a DataStreamSettingsResponse record class.

Method Summary

Modifier and Type	Method	Description
String	dataStreamName()	Returns the value of the dataStreamName record component.
Settings	effectiveSettings()	Returns the value of the effectiveSettings 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.
Settings	settings()	Returns the value of the settings record component.
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.ToXContent

isFragment

Constructor Details

DataStreamSettingsResponse

public DataStreamSettingsResponse(String dataStreamName,
 Settings settings,
 Settings effectiveSettings)

Creates an instance of a DataStreamSettingsResponse record class.

Parameters:

dataStreamName - the value for the dataStreamName record component

settings - the value for the settings record component

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

dataStreamName

public String dataStreamName()

Returns the value of the dataStreamName record component.

Returns:

the value of the dataStreamName record component

settings

public Settings settings()

Returns the value of the settings record component.

Returns:

the value of the settings record component

effectiveSettings

public Settings effectiveSettings()

Returns the value of the effectiveSettings record component.

Returns:

the value of the effectiveSettings record component