Class SimulateDocumentBaseResult

java.lang.Object
org.elasticsearch.action.ingest.SimulateDocumentBaseResult
All Implemented Interfaces:
SimulateDocumentResult, Writeable, org.elasticsearch.common.xcontent.ToXContent, org.elasticsearch.common.xcontent.ToXContentObject

public final class SimulateDocumentBaseResult
extends java.lang.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.common.xcontent.ToXContent

    org.elasticsearch.common.xcontent.ToXContent.DelegatingMapParams, org.elasticsearch.common.xcontent.ToXContent.MapParams, org.elasticsearch.common.xcontent.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 org.elasticsearch.common.xcontent.ConstructingObjectParser<SimulateDocumentBaseResult,​java.lang.Void> PARSER  

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

    EMPTY_PARAMS
  • Constructor Summary

    Constructors
    Constructor Description
    SimulateDocumentBaseResult​(java.lang.Exception failure)  
    SimulateDocumentBaseResult​(StreamInput in)
    Read from a stream.
    SimulateDocumentBaseResult​(IngestDocument ingestDocument)  
  • Method Summary

    Modifier and Type Method Description
    static SimulateDocumentBaseResult fromXContent​(org.elasticsearch.common.xcontent.XContentParser parser)  
    java.lang.Exception getFailure()  
    IngestDocument getIngestDocument()  
    org.elasticsearch.common.xcontent.XContentBuilder toXContent​(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.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.common.xcontent.ToXContentObject

    isFragment
  • Field Details

    • PARSER

      public static final org.elasticsearch.common.xcontent.ConstructingObjectParser<SimulateDocumentBaseResult,​java.lang.Void> PARSER
  • Constructor Details

    • SimulateDocumentBaseResult

      public SimulateDocumentBaseResult​(IngestDocument ingestDocument)
    • SimulateDocumentBaseResult

      public SimulateDocumentBaseResult​(java.lang.Exception failure)
    • SimulateDocumentBaseResult

      public SimulateDocumentBaseResult​(StreamInput in) throws java.io.IOException
      Read from a stream.
      Throws:
      java.io.IOException
  • Method Details

    • writeTo

      public void writeTo​(StreamOutput out) throws java.io.IOException
      Description copied from interface: Writeable
      Write this into the StreamOutput.
      Specified by:
      writeTo in interface Writeable
      Throws:
      java.io.IOException
    • getIngestDocument

      public IngestDocument getIngestDocument()
    • getFailure

      public java.lang.Exception getFailure()
    • toXContent

      public org.elasticsearch.common.xcontent.XContentBuilder toXContent​(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params) throws java.io.IOException
      Specified by:
      toXContent in interface org.elasticsearch.common.xcontent.ToXContent
      Throws:
      java.io.IOException
    • fromXContent

      public static SimulateDocumentBaseResult fromXContent​(org.elasticsearch.common.xcontent.XContentParser parser)