Package org.opensearch.index.reindex

Class BulkByScrollResponse

java.lang.Object

org.opensearch.core.transport.TransportMessage

org.opensearch.core.transport.TransportResponse

org.opensearch.core.action.ActionResponse

org.opensearch.index.reindex.BulkByScrollResponse

All Implemented Interfaces:

org.opensearch.core.common.io.stream.Writeable, org.opensearch.core.xcontent.ToXContent, org.opensearch.core.xcontent.ToXContentFragment

public class BulkByScrollResponse
extends org.opensearch.core.action.ActionResponse
implements org.opensearch.core.xcontent.ToXContentFragment

Response used for actions that index many documents using a scroll request.

Opensearch.internal:

Nested Class Summary

Nested classes/interfaces inherited from class org.opensearch.core.transport.TransportResponse

org.opensearch.core.transport.TransportResponse.Empty

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

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

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

org.opensearch.core.common.io.stream.Writeable.Reader<V>, org.opensearch.core.common.io.stream.Writeable.WriteableRegistry, org.opensearch.core.common.io.stream.Writeable.Writer<V>

Field Summary

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

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
BulkByScrollResponse(Iterable<BulkByScrollResponse> toMerge, String reasonCancelled)
BulkByScrollResponse(org.opensearch.common.unit.TimeValue took, BulkByScrollTask.Status status, List<BulkItemResponse.Failure> bulkFailures, List<ScrollableHitSource.SearchFailure> searchFailures, boolean timedOut)
BulkByScrollResponse(org.opensearch.core.common.io.stream.StreamInput in)

Method Summary

Modifier and Type	Method	Description
static BulkByScrollResponse	fromXContent(org.opensearch.core.xcontent.XContentParser parser)
int	getBatches()
List<BulkItemResponse.Failure>	getBulkFailures()	All of the bulk failures.
long	getBulkRetries()	The number of times that the request had retry bulk actions.
long	getCreated()
long	getDeleted()
long	getNoops()
String	getReasonCancelled()	The reason that the request was canceled or null if it hasn't been.
List<ScrollableHitSource.SearchFailure>	getSearchFailures()	All search failures.
long	getSearchRetries()	The number of times that the request had retry search actions.
BulkByScrollTask.Status	getStatus()
org.opensearch.common.unit.TimeValue	getTook()
long	getTotal()
long	getUpdated()
long	getVersionConflicts()
boolean	isTimedOut()	Did any of the sub-requests that were part of this request timeout?
String	toString()
org.opensearch.core.xcontent.XContentBuilder	toXContent(org.opensearch.core.xcontent.XContentBuilder builder, org.opensearch.core.xcontent.ToXContent.Params params)
void	writeTo(org.opensearch.core.common.io.stream.StreamOutput out)

Methods inherited from class org.opensearch.core.transport.TransportMessage

remoteAddress, remoteAddress

Methods inherited from class java.lang.Object

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

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

isFragment

Constructor Details

BulkByScrollResponse

public BulkByScrollResponse(org.opensearch.core.common.io.stream.StreamInput in)
                     throws IOException

Throws:

IOException

BulkByScrollResponse

public BulkByScrollResponse(org.opensearch.common.unit.TimeValue took,
 BulkByScrollTask.Status status,
 List<BulkItemResponse.Failure> bulkFailures,
 List<ScrollableHitSource.SearchFailure> searchFailures,
 boolean timedOut)

BulkByScrollResponse

public BulkByScrollResponse(Iterable<BulkByScrollResponse> toMerge,
 @Nullable
 String reasonCancelled)

Method Details

getTook

public org.opensearch.common.unit.TimeValue getTook()

getStatus

public BulkByScrollTask.Status getStatus()

getCreated

public long getCreated()

getTotal

public long getTotal()

getDeleted

public long getDeleted()

getUpdated

public long getUpdated()

getBatches

public int getBatches()

getVersionConflicts

public long getVersionConflicts()

getNoops

public long getNoops()

getReasonCancelled

public String getReasonCancelled()

The reason that the request was canceled or null if it hasn't been.

getBulkRetries

public long getBulkRetries()

The number of times that the request had retry bulk actions.

getSearchRetries

public long getSearchRetries()

The number of times that the request had retry search actions.

getBulkFailures

public List<BulkItemResponse.Failure> getBulkFailures()

All of the bulk failures. Version conflicts are only included if the request sets abortOnVersionConflict to true (the default).

getSearchFailures

public List<ScrollableHitSource.SearchFailure> getSearchFailures()

All search failures.

isTimedOut

public boolean isTimedOut()

Did any of the sub-requests that were part of this request timeout?

writeTo

public void writeTo(org.opensearch.core.common.io.stream.StreamOutput out)
             throws IOException

Specified by:

writeTo in interface org.opensearch.core.common.io.stream.Writeable

Throws:

IOException

toXContent

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

Specified by:

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

Throws:

IOException

fromXContent

public static BulkByScrollResponse fromXContent(org.opensearch.core.xcontent.XContentParser parser)

toString

public String toString()

Overrides:

toString in class Object