.. java:import:: com.fasterxml.jackson.annotation JsonIgnoreProperties

.. java:import:: com.fasterxml.jackson.annotation JsonProperty

.. java:import:: java.util Date

BatchStatus
===========

.. java:package:: io.taskmonk.entities
   :noindex:

.. java:type:: @JsonIgnoreProperties public class BatchStatus

   Status of a batch

Fields
------
completed
^^^^^^^^^

.. java:field::  Integer completed
   :outertype: BatchStatus

   Number of tasks in the batch that have been completed

eta
^^^

.. java:field::  Date eta
   :outertype: BatchStatus

   Specifies an estimate of when the batch is expected to be completed by the Annotation Partner. This is optional and depends on the capacity of the annotation partner being set. This can also be updated manually by the Annotation Partner The format is "YYYY-MM-DD"

etaType
^^^^^^^

.. java:field::  String etaType
   :outertype: BatchStatus

   Can be one of "Calculated" - If the eta is an approximate value that is calculated based on partner capacity "Manual" - If the eta has been set by the partner

newCount
^^^^^^^^

.. java:field::  Integer newCount
   :outertype: BatchStatus

   Number of tasks that are not started

rejected
^^^^^^^^

.. java:field::  Integer rejected
   :outertype: BatchStatus

   Number of tasks in the batch that were rejected due to missing mandatory fields

state
^^^^^

.. java:field::  BatchState state
   :outertype: BatchStatus

   \ :java:ref:`BatchState`\

total
^^^^^

.. java:field::  Integer total
   :outertype: BatchStatus

   The total number of valid tasks in the batch

Constructors
------------
BatchStatus
^^^^^^^^^^^

.. java:constructor:: public BatchStatus()
   :outertype: BatchStatus

BatchStatus
^^^^^^^^^^^

.. java:constructor:: public BatchStatus(Integer newCount, Integer inProgress, Integer completed, Integer total)
   :outertype: BatchStatus

Methods
-------
getCompleted
^^^^^^^^^^^^

.. java:method:: public Integer getCompleted()
   :outertype: BatchStatus

getEta
^^^^^^

.. java:method:: public Date getEta()
   :outertype: BatchStatus

getEtaType
^^^^^^^^^^

.. java:method:: @JsonProperty public String getEtaType()
   :outertype: BatchStatus

getNewCount
^^^^^^^^^^^

.. java:method:: @JsonProperty public Integer getNewCount()
   :outertype: BatchStatus

getState
^^^^^^^^

.. java:method:: public BatchState getState()
   :outertype: BatchStatus

getTotal
^^^^^^^^

.. java:method:: public Integer getTotal()
   :outertype: BatchStatus

setCompleted
^^^^^^^^^^^^

.. java:method:: public void setCompleted(Integer completed)
   :outertype: BatchStatus

setEta
^^^^^^

.. java:method:: public void setEta(Date eta)
   :outertype: BatchStatus

setEtaType
^^^^^^^^^^

.. java:method:: @JsonProperty public void setEtaType(String etaType)
   :outertype: BatchStatus

setNewCount
^^^^^^^^^^^

.. java:method:: @JsonProperty public void setNewCount(Integer newCount)
   :outertype: BatchStatus

setState
^^^^^^^^

.. java:method:: public void setState(BatchState state)
   :outertype: BatchStatus

setTotal
^^^^^^^^

.. java:method:: public void setTotal(Integer total)
   :outertype: BatchStatus

toString
^^^^^^^^

.. java:method:: @Override public String toString()
   :outertype: BatchStatus