Module org.elasticsearch.server
Package org.elasticsearch.cluster.metadata

Record Class DataStreamLifecycle.Retention

java.lang.Object
java.lang.Record
org.elasticsearch.cluster.metadata.DataStreamLifecycle.Retention
Record Components:
value - is a time period or null. Null represents an explicitly set infinite retention period
All Implemented Interfaces:
Writeable
Enclosing class:
DataStreamLifecycle
public static record DataStreamLifecycle.Retention(TimeValue value) extends Record implements Writeable
Retention is the least amount of time that the data will be kept by elasticsearch. Public for testing.

  • Field Details

  • Constructor Details

    • Retention

      public Retention(@Nullable TimeValue value)
      Creates an instance of a Retention record class.
      Parameters:
      value - the value for the value record component

  • Method Details

    • read

      public static DataStreamLifecycle.Retention read(StreamInput in) throws IOException
      Throws:
      IOException

    • 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

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

    • value

      @Nullable public TimeValue value()
      Returns the value of the value record component.
      Returns:
      the value of the value record component