Interface Task.Status

All Superinterfaces:
NamedWriteable, org.elasticsearch.common.xcontent.ToXContent, org.elasticsearch.common.xcontent.ToXContentObject, Writeable
All Known Implementing Classes:
BulkByScrollTask.Status, PersistentTasksNodeService.Status, PrimaryReplicaSyncer.ResyncTask.Status, RawTaskStatus, ReplicationTask.Status
Enclosing class:
Task

public static interface Task.Status extends org.elasticsearch.common.xcontent.ToXContentObject, NamedWriteable
Report of the internal status of a task. These can vary wildly from task to task because each task is implemented differently but we should try to keep each task consistent from version to version where possible. That means each implementation of ToXContent.toXContent(org.elasticsearch.common.xcontent.XContentBuilder, org.elasticsearch.common.xcontent.ToXContent.Params) should avoid making backwards incompatible changes to the rendered result. But if we change the way a request is implemented it might not be possible to preserve backwards compatibility. In that case, we can change this on version upgrade but we should be careful because some statuses (reindex) have become defacto standardized because they are used by systems like Kibana.
  • 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 inherited from interface org.elasticsearch.common.xcontent.ToXContent

    EMPTY_PARAMS
  • Method Summary

    Methods inherited from interface org.elasticsearch.common.io.stream.NamedWriteable

    getWriteableName

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

    toXContent

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

    isFragment

    Methods inherited from interface org.elasticsearch.common.io.stream.Writeable

    writeTo