Module org.elasticsearch.server

Package org.elasticsearch.action.datastreams

Record Class UpdateDataStreamSettingsAction.DataStreamSettingsResponse

java.lang.Object

java.lang.Record

org.elasticsearch.action.datastreams.UpdateDataStreamSettingsAction.DataStreamSettingsResponse

All Implemented Interfaces:

Writeable, ToXContent

Enclosing class:

UpdateDataStreamSettingsAction

public static record UpdateDataStreamSettingsAction.DataStreamSettingsResponse(String dataStreamName, boolean dataStreamSucceeded, String dataStreamErrorMessage, Settings settings, Settings effectiveSettings, UpdateDataStreamSettingsAction.DataStreamSettingsResponse.IndicesSettingsResult indicesSettingsResult)
extends Record
implements ToXContent, Writeable

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	UpdateDataStreamSettingsAction.DataStreamSettingsResponse.IndexSettingError
static final record	UpdateDataStreamSettingsAction.DataStreamSettingsResponse.IndicesSettingsResult

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
DataStreamSettingsResponse(String dataStreamName, boolean dataStreamSucceeded, String dataStreamErrorMessage, Settings settings, Settings effectiveSettings, UpdateDataStreamSettingsAction.DataStreamSettingsResponse.IndicesSettingsResult indicesSettingsResult)	Creates an instance of a DataStreamSettingsResponse record class.
DataStreamSettingsResponse(StreamInput in)

Method Summary

Modifier and Type	Method	Description
String	dataStreamErrorMessage()	Returns the value of the dataStreamErrorMessage record component.
String	dataStreamName()	Returns the value of the dataStreamName record component.
boolean	dataStreamSucceeded()	Returns the value of the dataStreamSucceeded 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.
UpdateDataStreamSettingsAction.DataStreamSettingsResponse.IndicesSettingsResult	indicesSettingsResult()	Returns the value of the indicesSettingsResult record component.
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)
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.ToXContent

isFragment

Constructor Details

DataStreamSettingsResponse

public DataStreamSettingsResponse(StreamInput in)
                           throws IOException

Throws:

IOException

DataStreamSettingsResponse

public DataStreamSettingsResponse(String dataStreamName,
 boolean dataStreamSucceeded,
 String dataStreamErrorMessage,
 Settings settings,
 Settings effectiveSettings,
 UpdateDataStreamSettingsAction.DataStreamSettingsResponse.IndicesSettingsResult indicesSettingsResult)

Creates an instance of a DataStreamSettingsResponse record class.

Parameters:

dataStreamName - the value for the dataStreamName record component

dataStreamSucceeded - the value for the dataStreamSucceeded record component

dataStreamErrorMessage - the value for the dataStreamErrorMessage record component

settings - the value for the settings record component

effectiveSettings - the value for the effectiveSettings record component

indicesSettingsResult - the value for the indicesSettingsResult 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

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. 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.

dataStreamName

public String dataStreamName()

Returns the value of the dataStreamName record component.

Returns:

the value of the dataStreamName record component

dataStreamSucceeded

public boolean dataStreamSucceeded()

Returns the value of the dataStreamSucceeded record component.

Returns:

the value of the dataStreamSucceeded record component

dataStreamErrorMessage

public String dataStreamErrorMessage()

Returns the value of the dataStreamErrorMessage record component.

Returns:

the value of the dataStreamErrorMessage 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

indicesSettingsResult

public UpdateDataStreamSettingsAction.DataStreamSettingsResponse.IndicesSettingsResult indicesSettingsResult()

Returns the value of the indicesSettingsResult record component.

Returns:

the value of the indicesSettingsResult record component