Record Class JobScheduleOptions

java.lang.Object
java.lang.Record
com.bluebell.greenhouse.platform.models.core.nonentities.job.JobScheduleOptions
Record Components:
idempotencyKey - caller-defined duplicate-prevention key
concurrencyKey - caller-defined ownership key
notBefore - earliest execution time
priority - queue priority
correlationId - cross-job correlation identifier
parentJobId - explicit parent public job identifier
triggerType - what caused this submission
actor - initiating actor
reason - human-readable scheduling reason
public record JobScheduleOptions(String idempotencyKey, String concurrencyKey, LocalDateTime notBefore, int priority, String correlationId, String parentJobId, JobTriggerType triggerType, String actor, String reason) extends Record
Optional scheduling metadata supplied by an application producer.
Version:
3.0.6
Author:
Stephen Prizio

  • Constructor Details

    • JobScheduleOptions

      public JobScheduleOptions(String idempotencyKey, String concurrencyKey, LocalDateTime notBefore, int priority, String correlationId, String parentJobId, JobTriggerType triggerType, String actor, String reason)
      Creates an instance of a JobScheduleOptions record class.
      Parameters:
      idempotencyKey - the value for the idempotencyKey record component
      concurrencyKey - the value for the concurrencyKey record component
      notBefore - the value for the notBefore record component
      priority - the value for the priority record component
      correlationId - the value for the correlationId record component
      parentJobId - the value for the parentJobId record component
      triggerType - the value for the triggerType record component
      actor - the value for the actor record component
      reason - the value for the reason record component

  • Method Details

    • defaults

      public static JobScheduleOptions defaults()
      Creates default options.
      Returns:
      empty scheduling options

    • manual

      public static JobScheduleOptions manual(String actor, String reason)
      Creates options for an operator-initiated submission.
      Parameters:
      actor - initiating actor
      reason - human-readable submission reason
      Returns:
      manual scheduling options

    • 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.

    • idempotencyKey

      public String idempotencyKey()
      Returns the value of the idempotencyKey record component.
      Returns:
      the value of the idempotencyKey record component

    • concurrencyKey

      public String concurrencyKey()
      Returns the value of the concurrencyKey record component.
      Returns:
      the value of the concurrencyKey record component

    • notBefore

      public LocalDateTime notBefore()
      Returns the value of the notBefore record component.
      Returns:
      the value of the notBefore record component

    • priority

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

    • correlationId

      public String correlationId()
      Returns the value of the correlationId record component.
      Returns:
      the value of the correlationId record component

    • parentJobId

      public String parentJobId()
      Returns the value of the parentJobId record component.
      Returns:
      the value of the parentJobId record component

    • triggerType

      public JobTriggerType triggerType()
      Returns the value of the triggerType record component.
      Returns:
      the value of the triggerType record component

    • actor

      public String actor()
      Returns the value of the actor record component.
      Returns:
      the value of the actor record component

    • reason

      public String reason()
      Returns the value of the reason record component.
      Returns:
      the value of the reason record component