Record Class ScheduleAction
java.lang.Object
java.lang.Record
gov.nasa.jpl.aerie.scheduler.server.services.ScheduleAction
- Record Components:
specificationService- interface to specification service for any necessary specification detailsschedulerService- scheduling service that handles activity scheduling requests
public record ScheduleAction(SpecificationService specificationService, SchedulerService schedulerService)
extends Record
represents the query for the results of a scheduling run
the query can be run using the scheduling service configured at construction, possibly resulting in the activation of
a scheduling agent to produce the results (depending on caching etc)
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic interfacecommon interface for different possible results of the query -
Constructor Summary
ConstructorsConstructorDescriptionScheduleAction(SpecificationService specificationService, SchedulerService schedulerService) Creates an instance of aScheduleActionrecord class. -
Method Summary
Modifier and TypeMethodDescriptionfinal booleanIndicates whether some other object is "equal to" this one.final inthashCode()Returns a hash code value for this object.run(SpecificationId specificationId, HasuraAction.Session session) execute the scheduling operation on the target plan (or retrieve existing scheduling results)Returns the value of theschedulerServicerecord component.Returns the value of thespecificationServicerecord component.final StringtoString()Returns a string representation of this record class.
-
Constructor Details
-
ScheduleAction
Creates an instance of aScheduleActionrecord class.- Parameters:
specificationService- the value for thespecificationServicerecord componentschedulerService- the value for theschedulerServicerecord component
-
-
Method Details
-
run
public ScheduleAction.Response run(SpecificationId specificationId, HasuraAction.Session session) throws NoSuchSpecificationException, IOException execute the scheduling operation on the target plan (or retrieve existing scheduling results)- Parameters:
specificationId- identifier of the plan to start scheduling from and to store scheduled output into- Returns:
- a response object wrapping summary results of the run (either successful or not)
- Throws:
NoSuchSpecificationException- if the target specification could not be foundIOException
-
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. -
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. -
equals
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. All components in this record class are compared withObjects::equals(Object,Object). -
specificationService
Returns the value of thespecificationServicerecord component.- Returns:
- the value of the
specificationServicerecord component
-
schedulerService
Returns the value of theschedulerServicerecord component.- Returns:
- the value of the
schedulerServicerecord component
-