Package org.opensearch.ingest

Class IngestStats

java.lang.Object

org.opensearch.ingest.IngestStats

All Implemented Interfaces:

Writeable, org.opensearch.common.xcontent.ToXContent, org.opensearch.common.xcontent.ToXContentFragment

public class IngestStats
extends Object
implements Writeable, org.opensearch.common.xcontent.ToXContentFragment

Stats for an ingest processor pipeline

Opensearch.internal:

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	IngestStats.PipelineStat	Container for pipeline stats.
static class	IngestStats.ProcessorStat	Container for processor stats.
static class	IngestStats.Stats	The ingest statistics.

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

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

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

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

Field Summary

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

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
IngestStats(StreamInput in)	Read from a stream.
IngestStats(IngestStats.Stats totalStats, List<IngestStats.PipelineStat> pipelineStats, Map<String,List<IngestStats.ProcessorStat>> processorStats)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
List<IngestStats.PipelineStat>	getPipelineStats()
Map<String,List<IngestStats.ProcessorStat>>	getProcessorStats()
IngestStats.Stats	getTotalStats()
int	hashCode()
org.opensearch.common.xcontent.XContentBuilder	toXContent(org.opensearch.common.xcontent.XContentBuilder builder, org.opensearch.common.xcontent.ToXContent.Params params)
void	writeTo(StreamOutput out)	Write this into the StreamOutput.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensearch.common.xcontent.ToXContentFragment

isFragment

Constructor Details

IngestStats

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

Parameters:

totalStats - - The total stats for Ingest. This is the logically the sum of all pipeline stats, and pipeline stats are logically the sum of the processor stats.

pipelineStats - - The stats for a given ingest pipeline.

processorStats - - The per-processor stats for a given pipeline. A map keyed by the pipeline identifier.

IngestStats

public IngestStats(StreamInput in)
            throws IOException

Read from a stream.

Throws:

IOException

Method Details

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

toXContent

public org.opensearch.common.xcontent.XContentBuilder toXContent(org.opensearch.common.xcontent.XContentBuilder builder,
 org.opensearch.common.xcontent.ToXContent.Params params)
                                                          throws IOException

Specified by:

toXContent in interface org.opensearch.common.xcontent.ToXContent

Throws:

IOException

getTotalStats

public IngestStats.Stats getTotalStats()

getPipelineStats

public List<IngestStats.PipelineStat> getPipelineStats()

getProcessorStats

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

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object