Module org.elasticsearch.server

Package org.elasticsearch.action.datastreams.lifecycle

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

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

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

Field Summary

Fields

Modifier and Type	Field	Description
static final ParseField	LIFECYCLE_FIELD
static final ParseField	NAME_FIELD

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY, EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
DataStreamLifecycle(String dataStreamName, DataStreamLifecycle lifecycle, boolean isInternalDataStream)	Creates an instance of a DataStreamLifecycle record class.

Method Summary

Modifier and Type	Method	Description
String	dataStreamName()	Returns the value of the dataStreamName 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.
boolean	isInternalDataStream()	Returns the value of the isInternalDataStream record component.
DataStreamLifecycle	lifecycle()	Returns the value of the lifecycle record component.
final String	toString()	Returns a string representation of this record class.
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
XContentBuilder	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.
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.ToXContentObject

isFragment

Field Details

NAME_FIELD

public static final ParseField NAME_FIELD

LIFECYCLE_FIELD

public static final ParseField LIFECYCLE_FIELD

Constructor Details

DataStreamLifecycle

public DataStreamLifecycle(String dataStreamName,
 @Nullable
 DataStreamLifecycle lifecycle,
 boolean isInternalDataStream)

Creates an instance of a DataStreamLifecycle record class.

Parameters:

dataStreamName - the value for the dataStreamName record component

lifecycle - the value for the lifecycle record component

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

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

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

lifecycle

@Nullable
public DataStreamLifecycle lifecycle()

Returns the value of the lifecycle record component.

Returns:

the value of the lifecycle record component

isInternalDataStream

public boolean isInternalDataStream()

Returns the value of the isInternalDataStream record component.

Returns:

the value of the isInternalDataStream record component