Package org.opensearch.index.seqno

Class RetentionLeaseStats

java.lang.Object
org.opensearch.index.seqno.RetentionLeaseStats
All Implemented Interfaces:
org.opensearch.core.common.io.stream.Writeable, org.opensearch.core.xcontent.ToXContent, org.opensearch.core.xcontent.ToXContentFragment
@PublicApi(since="1.0.0") public final class RetentionLeaseStats extends Object implements org.opensearch.core.xcontent.ToXContentFragment, org.opensearch.core.common.io.stream.Writeable
Represents retention lease stats.
Opensearch.api:

  • Nested Class Summary

    Nested classes/interfaces inherited from interface org.opensearch.core.xcontent.ToXContent

    org.opensearch.core.xcontent.ToXContent.DelegatingMapParams, org.opensearch.core.xcontent.ToXContent.MapParams, org.opensearch.core.xcontent.ToXContent.Params

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

    org.opensearch.core.common.io.stream.Writeable.Reader<V>, org.opensearch.core.common.io.stream.Writeable.WriteableRegistry, org.opensearch.core.common.io.stream.Writeable.Writer<V>

  • Field Summary

    Fields inherited from interface org.opensearch.core.xcontent.ToXContent

    EMPTY_PARAMS

  • Constructor Summary

    Constructors
    Constructor
    Description
    RetentionLeaseStats(org.opensearch.core.common.io.stream.StreamInput in)
    Constructs a new retention lease stats object from a stream.
    RetentionLeaseStats(RetentionLeases retentionLeases)
    Constructs a new retention lease stats object from the specified retention lease collection.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object o)
     
    int
    hashCode()
     
    RetentionLeases
    retentionLeases()
    The underlying retention lease collection backing this stats object.
    org.opensearch.core.xcontent.XContentBuilder
    toXContent(org.opensearch.core.xcontent.XContentBuilder builder, org.opensearch.core.xcontent.ToXContent.Params params)
    Converts the retention lease stats to XContent using the specified builder and pararms.
    void
    writeTo(org.opensearch.core.common.io.stream.StreamOutput out)
    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.opensearch.core.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(org.opensearch.core.common.io.stream.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(org.opensearch.core.common.io.stream.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 org.opensearch.core.common.io.stream.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.opensearch.core.xcontent.XContentBuilder toXContent(org.opensearch.core.xcontent.XContentBuilder builder, org.opensearch.core.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.opensearch.core.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