Class LongTaskStatus

java.lang.Object
io.github.primelib.confluence4j.rest.v1.models.LongTaskStatus
@Generated("io.github.primelib.primecodegen") public class LongTaskStatus extends Object
LongTaskStatus

Current status of a long running task Status keys: - `ERROR_UNKNOWN` - Generic error - `ERROR_LOCK_FAILED` - Could not get the lock on destination space - `ERROR_RELINK` - Error when relink pages/attachments - `ERROR_COPY_PAGE` - Error while copying 1 page - `WARN_RENAME_PAGE` - Warning page is rename during copy - `WARN_IGNORE_COPY_PERMISSION` - Warning could not copy permission - `WARN_IGNORE_COPY_ATTACHMENT` - Warning could not copy attachment - `WARN_IGNORE_DELETE_PAGE` - Warning ignoring delete of a non agreed on page - `STATUS_COPIED_PAGES` - Message total pages are copied - `STATUS_COPYING_PAGES` - Message copy pages - `STATUS_RELINK_PAGES` - Message relink pages/attachments - `STATUS_DELETING_PAGES` - Message delete pages - `STATUS_DELETED_PAGES` - Message total pages are deleted - `STATUS_MOVING_PAGES` - Message move pages - `WARN_IGNORE_VIEW_RESTRICTED` - Permission changed - view restricted - `WARN_IGNORE_EDIT_RESTRICTED` - Permission changed - edit restricted - `INITIALIZING_TASK` - Message when initializing task - `UNKNOWN_STATUS` - Message when status is unknown

  • Field Details

  • Constructor Details

    • LongTaskStatus

      public LongTaskStatus(Consumer<LongTaskStatus> spec)
      Constructs a validated instance of LongTaskStatus.
      Parameters:
      spec - the specification to process

    • LongTaskStatus

      @Internal protected LongTaskStatus()
      Protected no-args constructor for use by serialization frameworks.

    • LongTaskStatus

      @Internal public LongTaskStatus(String ari, String id, Name name, Long elapsedTime, Integer percentageComplete, Boolean successful, Boolean finished, List<Map<String,Object>> messages, String status, List<Map<String,Object>> errors, AdditionalDetails additionalDetails)
      Constructs a validated instance of LongTaskStatus.

      NOTE: This constructor is not considered stable and may change if the model is updated. Consider using LongTaskStatus(Consumer) instead.

      Parameters:
      ari - the ARI for the long task, based on its ID
      id - id
      name - name
      elapsedTime - elapsedTime
      percentageComplete - percentageComplete
      successful - successful
      finished - finished
      messages - messages
      status - status
      errors - errors
      additionalDetails - additionalDetails

  • Method Details

    • ari

      public String ari()
      Fluent getter for ari.

      the ARI for the long task, based on its ID

      Returns:
      ari

    • ari

      public LongTaskStatus ari(String ari)
      Fluent setter for ari.

      the ARI for the long task, based on its ID

      Parameters:
      ari - ari
      Returns:
      this

    • getAri

      public String getAri()
      Gets the value of ari.

      the ARI for the long task, based on its ID

      Returns:
      ari

    • setAri

      public void setAri(String ari)
      Sets the value of ari.

      the ARI for the long task, based on its ID

      Parameters:
      ari - ari

    • id

      public String id()
      Fluent getter for id.
      Returns:
      id

    • id

      public LongTaskStatus id(String id)
      Fluent setter for id.
      Parameters:
      id - id
      Returns:
      this

    • getId

      public String getId()
      Gets the value of id.
      Returns:
      id

    • setId

      public void setId(String id)
      Sets the value of id.
      Parameters:
      id - id

    • name

      public Name name()
      Fluent getter for name.
      Returns:
      name

    • name

      public LongTaskStatus name(Name name)
      Fluent setter for name.
      Parameters:
      name - name
      Returns:
      this

    • getName

      public Name getName()
      Gets the value of name.
      Returns:
      name

    • setName

      public void setName(Name name)
      Sets the value of name.
      Parameters:
      name - name

    • elapsedTime

      public Long elapsedTime()
      Fluent getter for elapsedTime.
      Returns:
      elapsedTime

    • elapsedTime

      public LongTaskStatus elapsedTime(Long elapsedTime)
      Fluent setter for elapsedTime.
      Parameters:
      elapsedTime - elapsedTime
      Returns:
      this

    • getElapsedTime

      public Long getElapsedTime()
      Gets the value of elapsedTime.
      Returns:
      elapsedTime

    • setElapsedTime

      public void setElapsedTime(Long elapsedTime)
      Sets the value of elapsedTime.
      Parameters:
      elapsedTime - elapsedTime

    • percentageComplete

      public Integer percentageComplete()
      Fluent getter for percentageComplete.
      Returns:
      percentageComplete

    • percentageComplete

      public LongTaskStatus percentageComplete(Integer percentageComplete)
      Fluent setter for percentageComplete.
      Parameters:
      percentageComplete - percentageComplete
      Returns:
      this

    • getPercentageComplete

      public Integer getPercentageComplete()
      Gets the value of percentageComplete.
      Returns:
      percentageComplete

    • setPercentageComplete

      public void setPercentageComplete(Integer percentageComplete)
      Sets the value of percentageComplete.
      Parameters:
      percentageComplete - percentageComplete

    • successful

      public Boolean successful()
      Fluent getter for successful.
      Returns:
      successful

    • successful

      public LongTaskStatus successful(Boolean successful)
      Fluent setter for successful.
      Parameters:
      successful - successful
      Returns:
      this

    • getSuccessful

      public Boolean getSuccessful()
      Gets the value of successful.
      Returns:
      successful

    • setSuccessful

      public void setSuccessful(Boolean successful)
      Sets the value of successful.
      Parameters:
      successful - successful

    • finished

      public Boolean finished()
      Fluent getter for finished.
      Returns:
      finished

    • finished

      public LongTaskStatus finished(Boolean finished)
      Fluent setter for finished.
      Parameters:
      finished - finished
      Returns:
      this

    • getFinished

      public Boolean getFinished()
      Gets the value of finished.
      Returns:
      finished

    • setFinished

      public void setFinished(Boolean finished)
      Sets the value of finished.
      Parameters:
      finished - finished

    • messages

      public List<Map<String,Object>> messages()
      Fluent getter for messages.
      Returns:
      messages

    • messages

      public LongTaskStatus messages(List<Map<String,Object>> messages)
      Fluent setter for messages.
      Parameters:
      messages - messages
      Returns:
      this

    • getMessages

      public List<Map<String,Object>> getMessages()
      Gets the value of messages.
      Returns:
      messages

    • setMessages

      public void setMessages(List<Map<String,Object>> messages)
      Sets the value of messages.
      Parameters:
      messages - messages

    • status

      public String status()
      Fluent getter for status.
      Returns:
      status

    • status

      public LongTaskStatus status(String status)
      Fluent setter for status.
      Parameters:
      status - status
      Returns:
      this

    • getStatus

      public String getStatus()
      Gets the value of status.
      Returns:
      status

    • setStatus

      public void setStatus(String status)
      Sets the value of status.
      Parameters:
      status - status

    • errors

      public List<Map<String,Object>> errors()
      Fluent getter for errors.
      Returns:
      errors

    • errors

      public LongTaskStatus errors(List<Map<String,Object>> errors)
      Fluent setter for errors.
      Parameters:
      errors - errors
      Returns:
      this

    • getErrors

      public List<Map<String,Object>> getErrors()
      Gets the value of errors.
      Returns:
      errors

    • setErrors

      public void setErrors(List<Map<String,Object>> errors)
      Sets the value of errors.
      Parameters:
      errors - errors

    • additionalDetails

      public AdditionalDetails additionalDetails()
      Fluent getter for additionalDetails.
      Returns:
      additionalDetails

    • additionalDetails

      public LongTaskStatus additionalDetails(AdditionalDetails additionalDetails)
      Fluent setter for additionalDetails.
      Parameters:
      additionalDetails - additionalDetails
      Returns:
      this

    • getAdditionalDetails

      public AdditionalDetails getAdditionalDetails()
      Gets the value of additionalDetails.
      Returns:
      additionalDetails

    • setAdditionalDetails

      public void setAdditionalDetails(AdditionalDetails additionalDetails)
      Sets the value of additionalDetails.
      Parameters:
      additionalDetails - additionalDetails

    • 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