Package ai.reveng.model

Class WorkflowProgress

java.lang.Object
ai.reveng.model.WorkflowProgress
@Generated("org.openapitools.codegen.languages.JavaClientCodegen") public class WorkflowProgress extends Object
WorkflowProgress

  • Field Details

  • Constructor Details

    • WorkflowProgress

      public WorkflowProgress()

  • Method Details

    • messages

      public WorkflowProgress messages(@Nullable List<ProgressMessage> messages)

    • addMessagesItem

      public WorkflowProgress addMessagesItem(ProgressMessage messagesItem)

    • getMessages

      @Nullable public List<ProgressMessage> getMessages()
      Log messages emitted during execution
      Returns:
      messages

    • setMessages

      public void setMessages(@Nullable List<ProgressMessage> messages)

    • status

      public WorkflowProgress status(@Nonnull WorkflowProgress.StatusEnum status)

    • getStatus

      @Nonnull public WorkflowProgress.StatusEnum getStatus()
      Current workflow status
      Returns:
      status

    • setStatus

      public void setStatus(@Nonnull WorkflowProgress.StatusEnum status)

    • step

      public WorkflowProgress step(@Nonnull String step)

    • getStep

      @Nonnull public String getStep()
      Name of the current step
      Returns:
      step

    • setStep

      public void setStep(@Nonnull String step)

    • stepIndex

      public WorkflowProgress stepIndex(@Nonnull Long stepIndex)

    • getStepIndex

      @Nonnull public Long getStepIndex()
      Zero-based index of the current step
      Returns:
      stepIndex

    • setStepIndex

      public void setStepIndex(@Nonnull Long stepIndex)

    • stepsTotal

      public WorkflowProgress stepsTotal(@Nonnull Long stepsTotal)

    • getStepsTotal

      @Nonnull public Long getStepsTotal()
      Total number of steps in the workflow
      Returns:
      stepsTotal

    • setStepsTotal

      public void setStepsTotal(@Nonnull Long stepsTotal)

    • putAdditionalProperty

      public WorkflowProgress putAdditionalProperty(String key, Object value)
      Set the additional (undeclared) property with the specified name and value. If the property does not already exist, create it otherwise replace it.
      Parameters:
      key - name of the property
      value - value of the property
      Returns:
      the WorkflowProgress instance itself

    • getAdditionalProperties

      public Map<String,Object> getAdditionalProperties()
      Return the additional (undeclared) property.
      Returns:
      a map of objects

    • getAdditionalProperty

      public Object getAdditionalProperty(String key)
      Return the additional (undeclared) property with the specified name.
      Parameters:
      key - name of the property
      Returns:
      an object

    • 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

    • validateJsonElement

      public static void validateJsonElement(com.google.gson.JsonElement jsonElement) throws IOException
      Validates the JSON Element and throws an exception if issues found
      Parameters:
      jsonElement - JSON Element
      Throws:
      IOException - if the JSON Element is invalid with respect to WorkflowProgress

    • fromJson

      public static WorkflowProgress fromJson(String jsonString) throws IOException
      Create an instance of WorkflowProgress given an JSON string
      Parameters:
      jsonString - JSON string
      Returns:
      An instance of WorkflowProgress
      Throws:
      IOException - if the JSON string is invalid with respect to WorkflowProgress

    • toJson

      public String toJson()
      Convert an instance of WorkflowProgress to an JSON string
      Returns:
      JSON string