Class RetentionLeaseStats

java.lang.Object
org.elasticsearch.index.seqno.RetentionLeaseStats
All Implemented Interfaces:
Writeable, org.elasticsearch.xcontent.ToXContent, org.elasticsearch.xcontent.ToXContentFragment

public final class RetentionLeaseStats extends Object implements org.elasticsearch.xcontent.ToXContentFragment, Writeable
Represents retention lease stats.
  • Nested Class Summary

    Nested classes/interfaces inherited from interface org.elasticsearch.xcontent.ToXContent

    org.elasticsearch.xcontent.ToXContent.DelegatingMapParams, org.elasticsearch.xcontent.ToXContent.MapParams, org.elasticsearch.xcontent.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_PARAMS
  • Constructor Summary

    Constructors
    Constructor
    Description
    Constructs a new retention lease stats object from a stream.
    Constructs a new retention lease stats object from the specified retention lease collection.
  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
     
    int
     
    The underlying retention lease collection backing this stats object.
    org.elasticsearch.xcontent.XContentBuilder
    toXContent(org.elasticsearch.xcontent.XContentBuilder builder, org.elasticsearch.xcontent.ToXContent.Params params)
    Converts the retention lease stats to XContent using the specified builder and pararms.
    void
    Writes a retention lease stats object to a stream in a manner suitable for later reconstruction via RetentionLeaseStats(StreamInput) (StreamInput)}.

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

    Methods inherited from interface org.elasticsearch.xcontent.ToXContentFragment

    isFragment
  • Constructor Details

    • RetentionLeaseStats

      public RetentionLeaseStats(RetentionLeases retentionLeases)
      Constructs a new retention lease stats object from the specified retention lease collection.
      Parameters:
      retentionLeases - the retention lease collection
    • RetentionLeaseStats

      public RetentionLeaseStats(StreamInput in) throws IOException
      Constructs a new retention lease stats object from a stream. The retention lease stats should have been written via writeTo(StreamOutput).
      Parameters:
      in - the stream to construct the retention lease stats from
      Throws:
      IOException - if an I/O exception occurs reading from the stream
  • Method Details

    • retentionLeases

      public RetentionLeases retentionLeases()
      The underlying retention lease collection backing this stats object.
      Returns:
      the retention lease collection
    • writeTo

      public void writeTo(StreamOutput out) throws IOException
      Writes a retention lease stats object to a stream in a manner suitable for later reconstruction via RetentionLeaseStats(StreamInput) (StreamInput)}.
      Specified by:
      writeTo in interface Writeable
      Parameters:
      out - the stream to write the retention lease stats to
      Throws:
      IOException - if an I/O exception occurs writing to the stream
    • toXContent

      public org.elasticsearch.xcontent.XContentBuilder toXContent(org.elasticsearch.xcontent.XContentBuilder builder, org.elasticsearch.xcontent.ToXContent.Params params) throws IOException
      Converts the retention lease stats to XContent using the specified builder and pararms.
      Specified by:
      toXContent in interface org.elasticsearch.xcontent.ToXContent
      Parameters:
      builder - the builder
      params - the params
      Returns:
      the builder that this retention lease collection was converted to XContent into
      Throws:
      IOException - if an I/O exception occurs writing to the builder
    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object
    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object