Module org.elasticsearch.server

Package org.elasticsearch.ingest

Record Class IngestStats

java.lang.Object

java.lang.Record

org.elasticsearch.ingest.IngestStats

All Implemented Interfaces:

Writeable, ChunkedToXContent

public record IngestStats(IngestStats.Stats totalStats, List<IngestStats.PipelineStat> pipelineStats, Map<String,List<IngestStats.ProcessorStat>> processorStats)
extends Record
implements Writeable, ChunkedToXContent

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	IngestStats.PipelineStat	Container for pipeline stats.
static final record	IngestStats.ProcessorStat	Container for processor stats.
static final record	IngestStats.Stats

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

Writeable.Reader<V>, Writeable.Writer<V>

Field Summary

Fields

Modifier and Type	Field	Description
static final IngestStats	IDENTITY

Fields inherited from interface org.elasticsearch.common.xcontent.ChunkedToXContent

EMPTY

Constructor Summary

Constructors

Constructor	Description
IngestStats(IngestStats.Stats totalStats, List<IngestStats.PipelineStat> pipelineStats, Map<String,List<IngestStats.ProcessorStat>> processorStats)	Creates an instance of a IngestStats record class.

Method Summary

Modifier and Type	Method	Description
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
static IngestStats	merge(IngestStats first, IngestStats second)
List<IngestStats.PipelineStat>	pipelineStats()	Returns the value of the pipelineStats record component.
Map<String,List<IngestStats.ProcessorStat>>	processorStats()	Returns the value of the processorStats record component.
static IngestStats	read(StreamInput in)	Read from a stream.
final String	toString()	Returns a string representation of this record class.
IngestStats.Stats	totalStats()	Returns the value of the totalStats record component.
Iterator<? extends ToXContent>	toXContentChunked(ToXContent.Params outerParams)	Create an iterator of ToXContent chunks for a REST response.
void	writeTo(StreamOutput out)	Write this into the StreamOutput.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.common.xcontent.ChunkedToXContent

isFragment, toXContentChunkedV7

Field Details

IDENTITY

public static final IngestStats IDENTITY

Constructor Details

IngestStats

public IngestStats(IngestStats.Stats totalStats,
 List<IngestStats.PipelineStat> pipelineStats,
 Map<String,List<IngestStats.ProcessorStat>> processorStats)

Creates an instance of a IngestStats record class.

Parameters:

totalStats - the value for the totalStats record component

pipelineStats - the value for the pipelineStats record component

processorStats - the value for the processorStats record component

Method Details

read

public static IngestStats read(StreamInput in)
                        throws IOException

Read from a stream.

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

toXContentChunked

public Iterator<? extends ToXContent> toXContentChunked(ToXContent.Params outerParams)

Description copied from interface: ChunkedToXContent

Create an iterator of ToXContent chunks for a REST response. Each chunk is serialized with the same XContentBuilder and ToXContent.Params, which is also the same as the ToXContent.Params passed as the params argument. For best results, all chunks should be O(1) size. The last chunk in the iterator must always yield at least one byte of output. See also ChunkedToXContentHelper for some handy utilities.

Note that chunked response bodies cannot send deprecation warning headers once transmission has started, so implementations must check for deprecated feature use before returning.

Specified by:

toXContentChunked in interface ChunkedToXContent

Returns:

iterator over chunks of ToXContent

merge

public static IngestStats merge(IngestStats first,
 IngestStats second)

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.

totalStats

public IngestStats.Stats totalStats()

Returns the value of the totalStats record component.

Returns:

the value of the totalStats record component

pipelineStats

public List<IngestStats.PipelineStat> pipelineStats()

Returns the value of the pipelineStats record component.

Returns:

the value of the pipelineStats record component

processorStats

public Map<String,List<IngestStats.ProcessorStat>> processorStats()

Returns the value of the processorStats record component.

Returns:

the value of the processorStats record component