Package org.elasticsearch.index.reindex

Class BulkByScrollTask.Status

java.lang.Object

org.elasticsearch.index.reindex.BulkByScrollTask.Status

All Implemented Interfaces:

NamedWriteable, Writeable, ToXContent, ToXContentObject, SuccessfullyProcessed, Task.Status

Enclosing class:

BulkByScrollTask

public static class BulkByScrollTask.Status
extends Object
implements Task.Status, SuccessfullyProcessed

Status of the reindex, update by query, or delete by query. While in general we allow Task.Status implementations to make backwards incompatible changes to their ToXContent.toXContent(org.elasticsearch.common.xcontent.XContentBuilder, org.elasticsearch.common.xcontent.ToXContent.Params) implementations, this one has become defacto standardized because Kibana parses it. As such, we should be very careful about removing things from this.

Nested Class Summary

Nested classes/interfaces inherited from interface org.elasticsearch.common.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 String	BATCHES_FIELD
static String	CANCELED_FIELD
static String	CREATED_FIELD
static String	DELETED_FIELD
static Set<String>	FIELDS_SET
static String	INCLUDE_CREATED	XContent param name to indicate if "created" count must be included in the response.
static String	INCLUDE_UPDATED	XContent param name to indicate if "updated" count must be included in the response.
static String	NAME
static String	NOOPS_FIELD
static String	REQUESTS_PER_SEC_FIELD
static String	RETRIES_BULK_FIELD
static String	RETRIES_FIELD
static String	RETRIES_SEARCH_FIELD
static String	SLICE_ID_FIELD
static String	SLICES_FIELD
static String	THROTTLED_HR_FIELD
static String	THROTTLED_RAW_FIELD
static String	THROTTLED_UNTIL_HR_FIELD
static String	THROTTLED_UNTIL_RAW_FIELD
static String	TOTAL_FIELD
static String	UPDATED_FIELD
static String	VERSION_CONFLICTS_FIELD

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

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
Status(Integer sliceId, long total, long updated, long created, long deleted, int batches, long versionConflicts, long noops, long bulkRetries, long searchRetries, TimeValue throttled, float requestsPerSecond, String reasonCancelled, TimeValue throttledUntil)
Status(List<BulkByScrollTask.StatusOrException> sliceStatuses, String reasonCancelled)	Constructor merging many statuses.
Status(StreamInput in)

Method Summary

Modifier and Type	Method	Description
static void	declareFields(ObjectParser<? extends BulkByScrollTask.StatusBuilder,Void> parser)
boolean	equals(Object o)
boolean	equalsWithoutSliceStatus(Object o, boolean includeUpdated, boolean includeCreated)
static BulkByScrollTask.Status	fromXContent(XContentParser parser)
int	getBatches()	Number of scan responses this request has processed.
long	getBulkRetries()	Number of retries that had to be attempted due to bulk actions being rejected.
long	getCreated()	Count of documents created.
long	getDeleted()	Count of successful delete operations.
long	getNoops()	Number of noops (skipped bulk items) as part of this request.
String	getReasonCancelled()	The reason that the request was canceled or null if it hasn't been.
float	getRequestsPerSecond()	The number of requests per second to which to throttle the request.
long	getSearchRetries()	Number of retries that had to be attempted due to search actions being rejected.
List<BulkByScrollTask.StatusOrException>	getSliceStatuses()	Statuses of the sub requests into which this sub-request was sliced.
TimeValue	getThrottled()	The total time this request has throttled itself not including the current throttle time if it is currently sleeping.
TimeValue	getThrottledUntil()	Remaining delay of any current throttle sleep or 0 if not sleeping.
long	getTotal()	The total number of documents this request will process.
long	getUpdated()	Count of documents updated.
long	getVersionConflicts()	Number of version conflicts this request has hit.
String	getWriteableName()	Returns the name of the writeable object
int	hashCode()
static BulkByScrollTask.Status	innerFromXContent(XContentParser parser)
void	innerToString(StringBuilder builder)
XContentBuilder	innerXContent(XContentBuilder builder, ToXContent.Params params)	We need to write a manual parser for this because of BulkByScrollTask.StatusOrException.
String	toString()
XContentBuilder	toXContent(XContentBuilder builder, 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.index.reindex.SuccessfullyProcessed

getSuccessfullyProcessed

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

isFragment

Field Detail

NAME

public static final String NAME

See Also:

Constant Field Values

INCLUDE_CREATED

public static final String INCLUDE_CREATED

XContent param name to indicate if "created" count must be included in the response.

See Also:

Constant Field Values

INCLUDE_UPDATED

public static final String INCLUDE_UPDATED

XContent param name to indicate if "updated" count must be included in the response.

See Also:

Constant Field Values

SLICE_ID_FIELD

public static final String SLICE_ID_FIELD

See Also:

Constant Field Values

TOTAL_FIELD

public static final String TOTAL_FIELD

See Also:

Constant Field Values

UPDATED_FIELD

public static final String UPDATED_FIELD

See Also:

Constant Field Values

CREATED_FIELD

public static final String CREATED_FIELD

See Also:

Constant Field Values

DELETED_FIELD

public static final String DELETED_FIELD

See Also:

Constant Field Values

BATCHES_FIELD

public static final String BATCHES_FIELD

See Also:

Constant Field Values

VERSION_CONFLICTS_FIELD

public static final String VERSION_CONFLICTS_FIELD

See Also:

Constant Field Values

NOOPS_FIELD

public static final String NOOPS_FIELD

See Also:

Constant Field Values

RETRIES_FIELD

public static final String RETRIES_FIELD

See Also:

Constant Field Values

RETRIES_BULK_FIELD

public static final String RETRIES_BULK_FIELD

See Also:

Constant Field Values

RETRIES_SEARCH_FIELD

public static final String RETRIES_SEARCH_FIELD

See Also:

Constant Field Values

THROTTLED_RAW_FIELD

public static final String THROTTLED_RAW_FIELD

See Also:

Constant Field Values

THROTTLED_HR_FIELD

public static final String THROTTLED_HR_FIELD

See Also:

Constant Field Values

REQUESTS_PER_SEC_FIELD

public static final String REQUESTS_PER_SEC_FIELD

See Also:

Constant Field Values

CANCELED_FIELD

public static final String CANCELED_FIELD

See Also:

Constant Field Values

THROTTLED_UNTIL_RAW_FIELD

public static final String THROTTLED_UNTIL_RAW_FIELD

See Also:

Constant Field Values

THROTTLED_UNTIL_HR_FIELD

public static final String THROTTLED_UNTIL_HR_FIELD

See Also:

Constant Field Values

SLICES_FIELD

public static final String SLICES_FIELD

See Also:

Constant Field Values

FIELDS_SET

public static Set<String> FIELDS_SET

Constructor Detail

Status

public Status(Integer sliceId,
              long total,
              long updated,
              long created,
              long deleted,
              int batches,
              long versionConflicts,
              long noops,
              long bulkRetries,
              long searchRetries,
              TimeValue throttled,
              float requestsPerSecond,
              @Nullable
              String reasonCancelled,
              TimeValue throttledUntil)

Status

public Status(List<BulkByScrollTask.StatusOrException> sliceStatuses,
              @Nullable
              String reasonCancelled)

Constructor merging many statuses.

Parameters:

sliceStatuses - Statuses of sub requests that this task was sliced into.

reasonCancelled - Reason that this *this* task was cancelled. Note that each entry in sliceStatuses can be cancelled independently of this task but if this task is cancelled then the workers *should* be cancelled.

Status

public Status(StreamInput in)
       throws IOException

Throws:

IOException

Method Detail

declareFields

public static void declareFields(ObjectParser<? extends BulkByScrollTask.StatusBuilder,Void> parser)

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

getWriteableName

public String getWriteableName()

Description copied from interface: NamedWriteable

Returns the name of the writeable object

Specified by:

getWriteableName in interface NamedWriteable

toXContent

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

Specified by:

toXContent in interface ToXContent

Throws:

IOException

innerXContent

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

We need to write a manual parser for this because of BulkByScrollTask.StatusOrException. Since BulkByScrollTask.StatusOrException.fromXContent(XContentParser) tries to peek at a field first before deciding what needs to be it cannot use an ObjectParser.

Throws:

IOException

fromXContent

public static BulkByScrollTask.Status fromXContent(XContentParser parser)
                                            throws IOException

Throws:

IOException

innerFromXContent

public static BulkByScrollTask.Status innerFromXContent(XContentParser parser)
                                                 throws IOException

Throws:

IOException

toString

public String toString()

Overrides:

toString in class Object

innerToString

public void innerToString(StringBuilder builder)

getTotal

public long getTotal()

The total number of documents this request will process. 0 means we don't yet know or, possibly, there are actually 0 documents to process. Its ok that these have the same meaning because any request with 0 actual documents should be quite short lived.

getUpdated

public long getUpdated()

Description copied from interface: SuccessfullyProcessed

Count of documents updated.

Specified by:

getUpdated in interface SuccessfullyProcessed

getCreated

public long getCreated()

Description copied from interface: SuccessfullyProcessed

Count of documents created.

Specified by:

getCreated in interface SuccessfullyProcessed

getDeleted

public long getDeleted()

Description copied from interface: SuccessfullyProcessed

Count of successful delete operations.

Specified by:

getDeleted in interface SuccessfullyProcessed

getBatches

public int getBatches()

Number of scan responses this request has processed.

getVersionConflicts

public long getVersionConflicts()

Number of version conflicts this request has hit.

getNoops

public long getNoops()

Number of noops (skipped bulk items) as part of this request.

getBulkRetries

public long getBulkRetries()

Number of retries that had to be attempted due to bulk actions being rejected.

getSearchRetries

public long getSearchRetries()

Number of retries that had to be attempted due to search actions being rejected.

getThrottled

public TimeValue getThrottled()

The total time this request has throttled itself not including the current throttle time if it is currently sleeping.

getRequestsPerSecond

public float getRequestsPerSecond()

The number of requests per second to which to throttle the request. Float.POSITIVE_INFINITY means unlimited.

getReasonCancelled

public String getReasonCancelled()

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

getThrottledUntil

public TimeValue getThrottledUntil()

Remaining delay of any current throttle sleep or 0 if not sleeping.

getSliceStatuses

public List<BulkByScrollTask.StatusOrException> getSliceStatuses()

Statuses of the sub requests into which this sub-request was sliced. Empty if this request wasn't sliced into sub-requests.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equalsWithoutSliceStatus

public boolean equalsWithoutSliceStatus(Object o,
                                        boolean includeUpdated,
                                        boolean includeCreated)

equals

public boolean equals(Object o)

Overrides:

equals in class Object