Package org.opends.server.tools.tasks

Record Class TaskScheduleInformation.TaskScheduleUserData

java.lang.Object
java.lang.Record
org.opends.server.tools.tasks.TaskScheduleInformation.TaskScheduleUserData
Record Components:
taskId - an arbitrary task id assigned to this task. Can be null
startNow - whether the task must be executed immediately
startDateTime - the date/time at which this task should be scheduled to start
recurringDateTime - the date/time pattern for recurring task schedule
dependencyIds - list of task IDs upon which this task is dependent
failedDependencyAction - the action to take should one of the dependent tasks fail
notifyUponCompletionEmailAddresses - list of email addresses to which an email will be sent when this task completes
notifyUponErrorEmailAddresses - list of email addresses to which an email will be sent if this task encounters an error during execution
description - the description of this task or null if there is none
Enclosing class:
TaskScheduleInformation
public static record TaskScheduleInformation.TaskScheduleUserData(String taskId, boolean startNow, Instant startDateTime, String recurringDateTime, Collection<String> dependencyIds, FailedDependencyAction failedDependencyAction, Collection<String> notifyUponCompletionEmailAddresses, Collection<String> notifyUponErrorEmailAddresses, String description) extends Record
A generic data structure that contains the data that the user provided to schedule a task.

  • Constructor Details

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

    • taskId

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

    • startNow

      public boolean startNow()
      Returns the value of the startNow record component.
      Returns:
      the value of the startNow record component

    • startDateTime

      public Instant startDateTime()
      Returns the value of the startDateTime record component.
      Returns:
      the value of the startDateTime record component

    • recurringDateTime

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

    • dependencyIds

      public Collection<String> dependencyIds()
      Returns the value of the dependencyIds record component.
      Returns:
      the value of the dependencyIds record component

    • failedDependencyAction

      public FailedDependencyAction failedDependencyAction()
      Returns the value of the failedDependencyAction record component.
      Returns:
      the value of the failedDependencyAction record component

    • notifyUponCompletionEmailAddresses

      public Collection<String> notifyUponCompletionEmailAddresses()
      Returns the value of the notifyUponCompletionEmailAddresses record component.
      Returns:
      the value of the notifyUponCompletionEmailAddresses record component

    • notifyUponErrorEmailAddresses

      public Collection<String> notifyUponErrorEmailAddresses()
      Returns the value of the notifyUponErrorEmailAddresses record component.
      Returns:
      the value of the notifyUponErrorEmailAddresses record component

    • description

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