Module org.elasticsearch.server
Record Class GetDataStreamLifecycleAction.Response.DataStreamLifecycle
java.lang.Object
java.lang.Record
org.elasticsearch.action.datastreams.lifecycle.GetDataStreamLifecycleAction.Response.DataStreamLifecycle
- All Implemented Interfaces:
Writeable,ToXContent,ToXContentObject
- Enclosing class:
GetDataStreamLifecycleAction.Response
public static record GetDataStreamLifecycleAction.Response.DataStreamLifecycle(String dataStreamName, DataStreamLifecycle lifecycle, boolean isInternalDataStream)
extends Record
implements Writeable, ToXContentObject
-
Nested Class Summary
Nested 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
FieldsFields inherited from interface org.elasticsearch.xcontent.ToXContent
EMPTY, EMPTY_PARAMS -
Constructor Summary
ConstructorsConstructorDescriptionDataStreamLifecycle(String dataStreamName, DataStreamLifecycle lifecycle, boolean isInternalDataStream) Creates an instance of aDataStreamLifecyclerecord class. -
Method Summary
Modifier and TypeMethodDescriptionReturns the value of thedataStreamNamerecord component.final booleanIndicates whether some other object is "equal to" this one.final inthashCode()Returns a hash code value for this object.booleanReturns the value of theisInternalDataStreamrecord component.Returns the value of thelifecyclerecord component.final StringtoString()Returns a string representation of this record class.toXContent(XContentBuilder builder, ToXContent.Params params) toXContent(XContentBuilder builder, ToXContent.Params params, RolloverConfiguration rolloverConfiguration, DataStreamGlobalRetention globalRetention) Converts the response to XContent and passes the RolloverConditions and the global retention, when provided, to the data stream lifecycle.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.ToXContentObject
isFragment
-
Field Details
-
NAME_FIELD
-
LIFECYCLE_FIELD
-
-
Constructor Details
-
DataStreamLifecycle
public DataStreamLifecycle(String dataStreamName, @Nullable DataStreamLifecycle lifecycle, boolean isInternalDataStream) Creates an instance of aDataStreamLifecyclerecord class.- Parameters:
dataStreamName- the value for thedataStreamNamerecord componentlifecycle- the value for thelifecyclerecord componentisInternalDataStream- the value for theisInternalDataStreamrecord 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
-
toXContent
public XContentBuilder toXContent(XContentBuilder builder, ToXContent.Params params, @Nullable RolloverConfiguration rolloverConfiguration, @Nullable DataStreamGlobalRetention globalRetention) throws IOException Converts the response to XContent and passes the RolloverConditions and the global retention, when provided, to the data stream lifecycle.- 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
-
lifecycle
Returns the value of thelifecyclerecord component.- Returns:
- the value of the
lifecyclerecord component
-
isInternalDataStream
public boolean isInternalDataStream()Returns the value of theisInternalDataStreamrecord component.- Returns:
- the value of the
isInternalDataStreamrecord component
-