Package org.elasticsearch.action.ingest

Class SimulateDocumentBaseResult

java.lang.Object

org.elasticsearch.action.ingest.SimulateDocumentBaseResult

All Implemented Interfaces:

SimulateDocumentResult, Writeable, ToXContent, ToXContentObject

public final class SimulateDocumentBaseResult
extends Object
implements SimulateDocumentResult

Holds the end result of what a pipeline did to sample document provided via the simulate api.

Nested Class Summary

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

Modifier and Type	Field	Description
static final ConstructingObjectParser<SimulateDocumentBaseResult,Void>	PARSER

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
SimulateDocumentBaseResult(Exception failure)
SimulateDocumentBaseResult(StreamInput in)	Read from a stream.
SimulateDocumentBaseResult(IngestDocument ingestDocument)

Method Summary

Modifier and Type	Method	Description
static SimulateDocumentBaseResult	fromXContent(XContentParser parser)
Exception	getFailure()
IngestDocument	getIngestDocument()
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
void	writeTo(StreamOutput out)	Write this into the StreamOutput.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.xcontent.ToXContentObject

isFragment

Field Details

PARSER

public static final ConstructingObjectParser<SimulateDocumentBaseResult,Void> PARSER

Constructor Details

SimulateDocumentBaseResult

public SimulateDocumentBaseResult(IngestDocument ingestDocument)

SimulateDocumentBaseResult

public SimulateDocumentBaseResult(Exception failure)

SimulateDocumentBaseResult

public SimulateDocumentBaseResult(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

getIngestDocument

public IngestDocument getIngestDocument()

getFailure

public Exception getFailure()

toXContent

public XContentBuilder toXContent(XContentBuilder builder,
 ToXContent.Params params)
                           throws IOException

Specified by:

toXContent in interface ToXContent

Throws:

IOException

fromXContent

public static SimulateDocumentBaseResult fromXContent(XContentParser parser)