Package org.elasticsearch.action.bulk

Class BulkResponse

java.lang.Object
org.elasticsearch.transport.TransportMessage
org.elasticsearch.transport.TransportResponse
org.elasticsearch.action.ActionResponse
org.elasticsearch.action.bulk.BulkResponse
All Implemented Interfaces:
java.lang.Iterable<BulkItemResponse>, Writeable, StatusToXContentObject, org.elasticsearch.common.xcontent.ToXContent, org.elasticsearch.common.xcontent.ToXContentObject
public class BulkResponse
extends ActionResponse
implements java.lang.Iterable<BulkItemResponse>, StatusToXContentObject
A response of a bulk execution. Holding a response for each item responding (in order) of the bulk requests. Each item holds the index/type/id is operated on, and if it failed or not (with the failure message).

  • Nested Class Summary

    Nested classes/interfaces inherited from class org.elasticsearch.transport.TransportResponse

    TransportResponse.Empty

    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 long NO_INGEST_TOOK  

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

    EMPTY_PARAMS

  • Constructor Summary

    Constructors 
    Constructor Description
    BulkResponse​(BulkItemResponse[] responses, long tookInMillis)  
    BulkResponse​(BulkItemResponse[] responses, long tookInMillis, long ingestTookInMillis)  
    BulkResponse​(StreamInput in)  

  • Method Summary

    Modifier and Type Method Description
    java.lang.String buildFailureMessage()  
    static BulkResponse fromXContent​(org.elasticsearch.common.xcontent.XContentParser parser)  
    org.elasticsearch.common.unit.TimeValue getIngestTook()
    If ingest is enabled returns the bulk ingest preprocessing time, otherwise 0 is returned.
    long getIngestTookInMillis()
    If ingest is enabled returns the bulk ingest preprocessing time.
    BulkItemResponse[] getItems()
    The items representing each action performed in the bulk operation (in the same order!).
    org.elasticsearch.common.unit.TimeValue getTook()
    How long the bulk execution took.
    boolean hasFailures()
    Has anything failed with the execution.
    java.util.Iterator<BulkItemResponse> iterator()  
    RestStatus status()
    Returns the REST status to make sure it is returned correctly
    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 org.elasticsearch.transport.TransportMessage

    remoteAddress, remoteAddress

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface java.lang.Iterable

    forEach, spliterator

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

    isFragment

  • Field Details

  • Constructor Details

  • Method Details

    • getTook

      public org.elasticsearch.common.unit.TimeValue getTook()
      How long the bulk execution took. Excluding ingest preprocessing.

    • getIngestTook

      public org.elasticsearch.common.unit.TimeValue getIngestTook()
      If ingest is enabled returns the bulk ingest preprocessing time, otherwise 0 is returned.

    • getIngestTookInMillis

      public long getIngestTookInMillis()
      If ingest is enabled returns the bulk ingest preprocessing time. in milliseconds, otherwise -1 is returned.

    • hasFailures

      public boolean hasFailures()
      Has anything failed with the execution.

    • buildFailureMessage

      public java.lang.String buildFailureMessage()

    • getItems

      public BulkItemResponse[] getItems()
      The items representing each action performed in the bulk operation (in the same order!).

    • iterator

      public java.util.Iterator<BulkItemResponse> iterator()
      Specified by:
      iterator in interface java.lang.Iterable<BulkItemResponse>

    • 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

    • status

      public RestStatus status()
      Description copied from interface: StatusToXContentObject
      Returns the REST status to make sure it is returned correctly
      Specified by:
      status in interface StatusToXContentObject

    • 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 BulkResponse fromXContent​(org.elasticsearch.common.xcontent.XContentParser parser) throws java.io.IOException
      Throws:
      java.io.IOException