Class RetentionLeaseStats

All Implemented Interfaces:
Writeable, ToXContent, ToXContentFragment

public final class RetentionLeaseStats
extends java.lang.Object
implements ToXContentFragment, Writeable
Represents retention lease stats.
  • Constructor Details

    • RetentionLeaseStats

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

      public RetentionLeaseStats​(StreamInput in) throws
      Constructs a new retention lease stats object from a stream. The retention lease stats should have been written via writeTo(StreamOutput).
      in - the stream to construct the retention lease stats from
      Throws: - 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.
      the retention lease collection
    • writeTo

      public void writeTo​(StreamOutput out) throws
      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
      out - the stream to write the retention lease stats to
      Throws: - if an I/O exception occurs writing to the stream
    • toXContent

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

      public boolean equals​(java.lang.Object o)
      equals in class java.lang.Object
    • hashCode

      public int hashCode()
      hashCode in class java.lang.Object