Interface ResultsProtocol.WriterRole
- All Known Subinterfaces:
ResultsProtocol.OwnerRole
- All Known Implementing Classes:
PostgresResultsCellRepository.PostgresResultsCell
- Enclosing class:
ResultsProtocol
public static interface ResultsProtocol.WriterRole
producer for a scheduling result
-
Method Summary
Modifier and TypeMethodDescriptionvoidfailWith(ScheduleFailure reason) mark the scheduling run as having failed with the given reasondefault voidfailWith(Consumer<ScheduleFailure.Builder> builderConsumer) voidreportCanceled(gov.nasa.jpl.aerie.scheduler.SchedulingInterruptedException e) Mark that the scheduler has acknowledged the cancellationvoidsucceedWith(ScheduleResults results, Optional<DatasetId> datasetId) mark the scheduling run as fully complete and attach the given results
-
Method Details
-
succeedWith
mark the scheduling run as fully complete and attach the given results- Parameters:
results- the summary results of the scheduling run, including satisfaction metrics etc
-
reportCanceled
void reportCanceled(gov.nasa.jpl.aerie.scheduler.SchedulingInterruptedException e) Mark that the scheduler has acknowledged the cancellation -
failWith
mark the scheduling run as having failed with the given reason- Parameters:
reason- the reason that the scheduling run failed
-
failWith
-