Class WorkRequirementSummary

java.lang.Object
co.yellowdog.platform.interaction.scheduler.WorkRequirementSummary
All Implemented Interfaces:
Identified, Tagged, Serializable
public class WorkRequirementSummary extends Object implements Identified, Tagged, Serializable
Provides a summary of a WorkRequirement including the ID that can be used to retrieve the full object.
See Also:

  • Method Details

    • builder

      public static WorkRequirementSummary.Builder builder()

    • getId

      public String getId()
      Description copied from interface: Identified
      Returns the ID
      Specified by:
      getId in interface Identified
      Returns:
      the ID

    • getNamespace

      public String getNamespace()
      The user allocated namespace used to group work requirements and other objects together.
      Returns:
      the work requirement namespace

    • getName

      public String getName()
      The user allocated name used to uniquely identify the work requirement within its namespace.
      Returns:
      the work requirement name

    • getTag

      public String getTag()
      Description copied from interface: Tagged
      Gets the user defined tag
      Specified by:
      getTag in interface Tagged
      Returns:
      the user defined tag

    • getCreatedTime

      public Instant getCreatedTime()
      The date and time when the work requirement was first submitted to YellowDog Scheduler.
      Returns:
      the date and time when the work requirement was first submitted

    • getPriority

      public double getPriority()
      The priority of the work requirement.
      Returns:
      the priority of the work requirement

    • getCompletedTaskCount

      public int getCompletedTaskCount()
      The count of successfully completed tasks in the work requirement.
      Returns:
      the count of successfully completed tasks in the work requirement.

    • getTotalTaskCount

      public int getTotalTaskCount()
      The total count of tasks in the work requirement.
      Returns:
      the total count of tasks in the work requirement.

    • getStatus

      public WorkRequirementStatus getStatus()
      The status of the work requirement.
      Returns:
      the status of the work requirement

    • isHealthy

      public boolean isHealthy()
      Indicates if the work requirement is healthy. If false then tasks may have failed or task groups may be starved.
      Returns:
      true, if the work requirement is health; otherwise, false

    • setId

      public void setId(String id)

    • setNamespace

      public void setNamespace(String namespace)
      The user allocated namespace used to group work requirements and other objects together.
      Parameters:
      namespace - This is a summary type, setting the property has no effect.

    • setName

      public void setName(String name)
      The user allocated name used to uniquely identify the work requirement within its namespace.
      Parameters:
      name - This is a summary type, setting the property has no effect.

    • setTag

      public void setTag(String tag)
      Description copied from interface: Tagged
      Sets the user defined tag
      Specified by:
      setTag in interface Tagged
      Parameters:
      tag - the user defined tag

    • setCreatedTime

      public void setCreatedTime(Instant createdTime)
      The date and time when the work requirement was first submitted to YellowDog Scheduler.
      Parameters:
      createdTime - This is a summary type, setting the property has no effect.

    • setPriority

      public void setPriority(double priority)
      The priority of the work requirement.
      Parameters:
      priority - the priority of the work requirement

    • setCompletedTaskCount

      public void setCompletedTaskCount(int completedTaskCount)
      The count of successfully completed tasks in the work requirement.
      Parameters:
      completedTaskCount - This is a summary type, setting the property has no effect.

    • setTotalTaskCount

      public void setTotalTaskCount(int totalTaskCount)
      The total count of tasks in the work requirement.
      Parameters:
      totalTaskCount - This is a summary type, setting the property has no effect.

    • setStatus

      public void setStatus(WorkRequirementStatus status)
      The status of the work requirement.
      Parameters:
      status - This is a summary type, setting the property has no effect.

    • setHealthy

      public void setHealthy(boolean healthy)
      Indicates if the work requirement is healthy. If false then tasks may have failed or task groups may be starved.
      Parameters:
      healthy - This is a summary type, setting the property has no effect.

    • equals

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

    • canEqual

      protected boolean canEqual(Object other)

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object