Package org.elasticsearch.index.seqno

Class RetentionLeaseStats

java.lang.Object

org.elasticsearch.index.seqno.RetentionLeaseStats

All Implemented Interfaces:

Writeable, ToXContent, ToXContentFragment

public final class RetentionLeaseStats
extends Object
implements ToXContentFragment, Writeable

Represents retention lease stats.

Nested Class Summary

Nested classes/interfaces inherited from interface org.elasticsearch.common.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 inherited from interface org.elasticsearch.common.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
RetentionLeaseStats(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.
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)	Converts the retention lease stats to XContent using the specified builder and pararms.
void	writeTo(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.elasticsearch.common.xcontent.ToXContentFragment

isFragment

Constructor Detail

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 Detail

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 XContentBuilder toXContent(XContentBuilder builder,
                                  ToXContent.Params params)
                           throws IOException

Converts the retention lease stats to XContent using the specified builder and pararms.

Specified by:

toXContent in interface 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