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

Record Class PlanMetadata

java.lang.Object
java.lang.Record
gov.nasa.jpl.aerie.scheduler.server.models.PlanMetadata
Record Components:
planId - unique identifier of the plan container
planRev - the revision number of the plan currently stored in aerie
horizon - declared time span of the plan, in both scheduler/merlin notations
modelId - identifier of the mission model the plan relies on
modelPath - relative file path within merlin filesystem to the mission model jar
modelName - the registered name of the mission model to use from the model jar
modelVersion - the version identifier of the mission model to use from the model jar
modelConfiguration - plan-specific arguments to tune the behavior of the mission model
public record PlanMetadata(PlanId planId, long planRev, gov.nasa.jpl.aerie.scheduler.model.PlanningHorizon horizon, long modelId, Path modelPath, String modelName, String modelVersion, Map<String,gov.nasa.jpl.aerie.merlin.protocol.types.SerializedValue> modelConfiguration) extends Record
plan details read from merlin services that are used by the scheduler

  • Constructor Details

    • PlanMetadata

      public PlanMetadata(PlanId planId, long planRev, gov.nasa.jpl.aerie.scheduler.model.PlanningHorizon horizon, long modelId, Path modelPath, String modelName, String modelVersion, Map<String,gov.nasa.jpl.aerie.merlin.protocol.types.SerializedValue> modelConfiguration)
      Creates an instance of a PlanMetadata record class.
      Parameters:
      planId - the value for the planId record component
      planRev - the value for the planRev record component
      horizon - the value for the horizon record component
      modelId - the value for the modelId record component
      modelPath - the value for the modelPath record component
      modelName - the value for the modelName record component
      modelVersion - the value for the modelVersion record component
      modelConfiguration - the value for the modelConfiguration record component

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

    • planId

      public PlanId planId()
      Returns the value of the planId record component.
      Returns:
      the value of the planId record component

    • planRev

      public long planRev()
      Returns the value of the planRev record component.
      Returns:
      the value of the planRev record component

    • horizon

      public gov.nasa.jpl.aerie.scheduler.model.PlanningHorizon horizon()
      Returns the value of the horizon record component.
      Returns:
      the value of the horizon record component

    • modelId

      public long modelId()
      Returns the value of the modelId record component.
      Returns:
      the value of the modelId record component

    • modelPath

      public Path modelPath()
      Returns the value of the modelPath record component.
      Returns:
      the value of the modelPath record component

    • modelName

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

    • modelVersion

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

    • modelConfiguration

      public Map<String,gov.nasa.jpl.aerie.merlin.protocol.types.SerializedValue> modelConfiguration()
      Returns the value of the modelConfiguration record component.
      Returns:
      the value of the modelConfiguration record component