Class BulkByScrollTask.StatusOrException

java.lang.Object
org.elasticsearch.index.reindex.BulkByScrollTask.StatusOrException
All Implemented Interfaces:
Writeable, org.elasticsearch.common.xcontent.ToXContent, org.elasticsearch.common.xcontent.ToXContentObject
Enclosing class:
BulkByScrollTask

public static class BulkByScrollTask.StatusOrException
extends java.lang.Object
implements Writeable, org.elasticsearch.common.xcontent.ToXContentObject
The status of a slice of the request. Successful requests store the status while failing requests store a exception.
  • 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 java.util.Set<java.lang.String> EXPECTED_EXCEPTION_FIELDS  

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

    EMPTY_PARAMS
  • Constructor Summary

    Constructors
    Constructor Description
    StatusOrException​(java.lang.Exception exception)  
    StatusOrException​(StreamInput in)
    Read from a stream.
    StatusOrException​(BulkByScrollTask.Status status)  
  • Method Summary

    Modifier and Type Method Description
    boolean equals​(java.lang.Object obj)  
    static BulkByScrollTask.StatusOrException fromXContent​(org.elasticsearch.common.xcontent.XContentParser parser)
    Since BulkByScrollTask.StatusOrException can contain either an Exception or a BulkByScrollTask.Status we need to peek at a field first before deciding what needs to be parsed since the same object could contains either.
    java.lang.Exception getException()  
    BulkByScrollTask.Status getStatus()  
    int hashCode()  
    java.lang.String toString()  
    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, finalize, getClass, notify, notifyAll, wait, wait, wait

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

    isFragment
  • Field Details

    • EXPECTED_EXCEPTION_FIELDS

      public static java.util.Set<java.lang.String> EXPECTED_EXCEPTION_FIELDS
  • Constructor Details

    • StatusOrException

      public StatusOrException​(BulkByScrollTask.Status status)
    • StatusOrException

      public StatusOrException​(java.lang.Exception exception)
    • StatusOrException

      public StatusOrException​(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
    • getStatus

      public BulkByScrollTask.Status getStatus()
    • getException

      public java.lang.Exception getException()
    • 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 BulkByScrollTask.StatusOrException fromXContent​(org.elasticsearch.common.xcontent.XContentParser parser) throws java.io.IOException
      Since BulkByScrollTask.StatusOrException can contain either an Exception or a BulkByScrollTask.Status we need to peek at a field first before deciding what needs to be parsed since the same object could contains either. The EXPECTED_EXCEPTION_FIELDS contains the fields that are expected when the serialised object was an instance of exception and the BulkByScrollTask.Status.FIELDS_SET is the set of fields expected when the serialized object was an instance of Status.
      Throws:
      java.io.IOException
    • toString

      public java.lang.String toString()
      Overrides:
      toString in class java.lang.Object
    • equals

      public boolean equals​(java.lang.Object obj)
      Overrides:
      equals in class java.lang.Object
    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class java.lang.Object