Module org.elasticsearch.server
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 ClassesModifier and TypeClassDescriptionstatic final recordstatic final recordNested 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
ConstructorsConstructorDescriptionDataStreamSettingsResponse(String dataStreamName, boolean dataStreamSucceeded, String dataStreamErrorMessage, Settings settings, Settings effectiveSettings, UpdateDataStreamSettingsAction.DataStreamSettingsResponse.IndicesSettingsResult indicesSettingsResult) Creates an instance of aDataStreamSettingsResponserecord class. -
Method Summary
Modifier and TypeMethodDescriptionReturns the value of thedataStreamErrorMessagerecord component.Returns the value of thedataStreamNamerecord component.booleanReturns the value of thedataStreamSucceededrecord component.Returns the value of theeffectiveSettingsrecord 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 theindicesSettingsResultrecord component.settings()Returns the value of thesettingsrecord 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.ToXContent
isFragment
-
Constructor Details
-
DataStreamSettingsResponse
- Throws:
IOException
-
DataStreamSettingsResponse
public DataStreamSettingsResponse(String dataStreamName, boolean dataStreamSucceeded, String dataStreamErrorMessage, Settings settings, Settings effectiveSettings, UpdateDataStreamSettingsAction.DataStreamSettingsResponse.IndicesSettingsResult indicesSettingsResult) Creates an instance of aDataStreamSettingsResponserecord class.- Parameters:
dataStreamName- the value for thedataStreamNamerecord componentdataStreamSucceeded- the value for thedataStreamSucceededrecord componentdataStreamErrorMessage- the value for thedataStreamErrorMessagerecord componentsettings- the value for thesettingsrecord componenteffectiveSettings- the value for theeffectiveSettingsrecord componentindicesSettingsResult- the value for theindicesSettingsResultrecord component
-
-
Method Details
-
writeTo
Description copied from interface:WriteableWrite this into the StreamOutput.- Specified by:
writeToin interfaceWriteable- Throws:
IOException
-
toXContent
public XContentBuilder toXContent(XContentBuilder builder, ToXContent.Params params) throws IOException - Specified by:
toXContentin interfaceToXContent- 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. Reference components are compared withObjects::equals(Object,Object); primitive components are compared with '=='. -
dataStreamName
Returns the value of thedataStreamNamerecord component.- Returns:
- the value of the
dataStreamNamerecord component
-
dataStreamSucceeded
public boolean dataStreamSucceeded()Returns the value of thedataStreamSucceededrecord component.- Returns:
- the value of the
dataStreamSucceededrecord component
-
dataStreamErrorMessage
Returns the value of thedataStreamErrorMessagerecord component.- Returns:
- the value of the
dataStreamErrorMessagerecord component
-
settings
Returns the value of thesettingsrecord component.- Returns:
- the value of the
settingsrecord component
-
effectiveSettings
Returns the value of theeffectiveSettingsrecord component.- Returns:
- the value of the
effectiveSettingsrecord component
-
indicesSettingsResult
public UpdateDataStreamSettingsAction.DataStreamSettingsResponse.IndicesSettingsResult indicesSettingsResult()Returns the value of theindicesSettingsResultrecord component.- Returns:
- the value of the
indicesSettingsResultrecord component
-