Package gov.nasa.jpl.aerie.scheduler.server.services

Record Class GenerateSchedulingLibAction

java.lang.Object

java.lang.Record

gov.nasa.jpl.aerie.scheduler.server.services.GenerateSchedulingLibAction

public record GenerateSchedulingLibAction(MerlinDatabaseService.ReaderRole merlinDatabaseService)
extends Record

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	GenerateSchedulingLibAction.Response	common interface for different possible results of the query

Constructor Summary

Constructors

Constructor	Description
GenerateSchedulingLibAction(MerlinDatabaseService.ReaderRole merlinDatabaseService)	Creates an instance of a GenerateSchedulingLibAction record class.

Method Summary

Modifier and Type	Method	Description
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
MerlinDatabaseService.ReaderRole	merlinDatabaseService()	Returns the value of the merlinDatabaseService record component.
GenerateSchedulingLibAction.Response	run(gov.nasa.jpl.aerie.types.MissionModelId missionModelId, Optional<PlanId> planId)	generates the scheduling typescript files
final String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

GenerateSchedulingLibAction

public GenerateSchedulingLibAction(MerlinDatabaseService.ReaderRole merlinDatabaseService)

Creates an instance of a GenerateSchedulingLibAction record class.

Parameters:

merlinDatabaseService - the value for the merlinDatabaseService record component

Method Details

run

public GenerateSchedulingLibAction.Response run(gov.nasa.jpl.aerie.types.MissionModelId missionModelId,
 Optional<PlanId> planId)

generates the scheduling typescript files

Parameters:

missionModelId - the id of the mission model for which to generate a scheduling library

planId - the optional id of the plan concerned by this code generation, if plan id is provided, code will be generated for external resources associated with the plan

Returns:

a response object wrapping the results of generating the code (either successful or not)

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. All components in this record class are compared with Objects::equals(Object,Object).

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.

merlinDatabaseService

public MerlinDatabaseService.ReaderRole merlinDatabaseService()

Returns the value of the merlinDatabaseService record component.

Returns:

the value of the merlinDatabaseService record component