Package org.tailormap.api.admin.model

Class TaskProgressEvent

java.lang.Object
org.tailormap.api.admin.model.TaskProgressEvent
All Implemented Interfaces:
Serializable
@Generated(value="org.openapitools.codegen.languages.SpringCodegen", comments="Generator version: 7.17.0") public class TaskProgressEvent extends Object implements Serializable
Task progress event. This event is sent when a _running_ task makes progress, including start/stop. The fraction of the task that is done can be computed using `progress` and `total` (if not null).
See Also:

  • Constructor Details

    • TaskProgressEvent

      public TaskProgressEvent()

  • Method Details

    • type

      public TaskProgressEvent type(String type)

    • getType

      @NotNull public @NotNull String getType()
      Type of the task.
      Returns:
      type

    • setType

      public void setType(String type)

    • uuid

      public TaskProgressEvent uuid(UUID uuid)

    • getUuid

      @NotNull @Valid public @NotNull @Valid UUID getUuid()
      UUID of the task; this, combined with type, is used to uniquely identify the task.
      Returns:
      uuid

    • setUuid

      public void setUuid(UUID uuid)

    • total

      public TaskProgressEvent total(Integer total)

    • getTotal

      public Integer getTotal()
      Total number of items to process. May be `null` or empty if unknown.
      Returns:
      total

    • setTotal

      public void setTotal(Integer total)

    • progress

      public TaskProgressEvent progress(Integer progress)

    • getProgress

      @NotNull public @NotNull Integer getProgress()
      Number of items processed so far.
      Returns:
      progress

    • setProgress

      public void setProgress(Integer progress)

    • startedAt

      public TaskProgressEvent startedAt(OffsetDateTime startedAt)

    • getStartedAt

      @Valid public @Valid OffsetDateTime getStartedAt()
      Zoned date-time when the task started.
      Returns:
      startedAt

    • setStartedAt

      public void setStartedAt(OffsetDateTime startedAt)

    • taskData

      public TaskProgressEvent taskData(Map<String,Object> taskData)

    • putTaskDataItem

      public TaskProgressEvent putTaskDataItem(String key, Object taskDataItem)

    • getTaskData

      public Map<String,Object> getTaskData()
      Additional data for the task.
      Returns:
      taskData

    • setTaskData

      public void setTaskData(Map<String,Object> taskData)

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object