Record Class ProjectScriptDiagnostic.Details.Schedule

java.lang.Object
java.lang.Record
com.inductiveautomation.ignition.common.script.ProjectScriptDiagnostic.Details.Schedule
Record Components:
cronExpression - the project-authored cron expression the script runs on.
running - false when the execution queue is idle.
queueDepth - the jobs waiting behind the current run.
All Implemented Interfaces:
ProjectScriptDiagnostic.Details
Enclosing interface:
ProjectScriptDiagnostic.Details

public static record ProjectScriptDiagnostic.Details.Schedule(String cronExpression, boolean running, int queueDepth) extends Record implements ProjectScriptDiagnostic.Details
A scheduled script's cron schedule and the state of the queue its jobs run through.
  • Constructor Details

    • Schedule

      public Schedule(String cronExpression, boolean running, int queueDepth)
      Creates an instance of a Schedule record class.
      Parameters:
      cronExpression - the value for the cronExpression record component
      running - the value for the running record component
      queueDepth - the value for the queueDepth record component
  • Method Details

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object
    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object
    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with the compare method from their corresponding wrapper classes.
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.
    • cronExpression

      public String cronExpression()
      Returns the value of the cronExpression record component.
      Returns:
      the value of the cronExpression record component
    • running

      public boolean running()
      Returns the value of the running record component.
      Returns:
      the value of the running record component
    • queueDepth

      public int queueDepth()
      Returns the value of the queueDepth record component.
      Returns:
      the value of the queueDepth record component