Serialisierte Form

  • Package de.dlr.proseo.procmgr.rest.model

    • Klasse de.dlr.proseo.procmgr.rest.model.RestClassOutputParameter

      class RestClassOutputParameter extends Object implements Serializable
      serialVersionUID:
      1837829057273247975L

      • Serialisierte Felder

        • outputParameters
          List<RestParameter> outputParameters
          Set of parameters to apply to the generated products (may be empty)
        • productClass
          String productClass
          The product class to generate as output

    • Klasse de.dlr.proseo.procmgr.rest.model.RestConfiguration

      class RestConfiguration extends Object implements Serializable
      serialVersionUID:
      2027864713091268620L

      • Serialisierte Felder

        • configurationFiles
          List<RestConfigurationFile> configurationFiles
          The configuration files for this configuration
        • configurationVersion
          String configurationVersion
          Version identification of the configuration environment
        • configuredProcessors
          List<String> configuredProcessors
          The names for the processor configurations this processor version is valid for
        • dockerRunParameters
          List<RestStringParameter> dockerRunParameters
          Specific parameter for "docker run" valid for this configuration
        • dynProcParameters
          List<RestParameter> dynProcParameters
          Dynamic processing parameters, the values denoting default values, which may be changed by the Job Order File generator
        • id
          Long id
          The persistent id of this object
        • missionCode
          String missionCode
          The mission code (e. g. S5P)
        • mode
          String mode
          The processing mode, for which this configuration is valid; optional, if set, must match mission processing modes
        • processorName
          String processorName
          The processor class this configuration version belongs to
        • productQuality
          String productQuality
          Indicates the suitability for general use of products generated with this configuration (NOMINAL, EXPERIMENTAL, TEST; default NOMINAL)
        • staticInputFiles
          List<RestConfigurationInputFile> staticInputFiles
          Static input files for inclusion in generated Job Order Files
        • version
          Long version
          A version identifier to track updates to the object (especially to detect concurrent update attempts)

    • Klasse de.dlr.proseo.procmgr.rest.model.RestConfigurationFile

      class RestConfigurationFile extends Object implements Serializable
      serialVersionUID:
      1951850446469093066L

      • Serialisierte Felder

        • fileName
          String fileName
          Path name for the configuration file
        • fileVersion
          String fileVersion
          Version string for the configuration file

    • Klasse de.dlr.proseo.procmgr.rest.model.RestConfigurationInputFile

      class RestConfigurationInputFile extends Object implements Serializable
      serialVersionUID:
      1953502933980744490L

      • Serialisierte Felder

        • fileNames
          List<String> fileNames
          A list of legal and valid filenames
        • fileNameType
          String fileNameType
          Type of the file names (one of { "Physical", "Logical", "Stem", "Regexp", "Directory" })
        • fileType
          String fileType
          File type according to processor-specific ICD or "LOG"
        • id
          Long id
          The persistent id of this object
        • version
          Long version
          A version identifier to track updates to the object (especially to detect concurrent update attempts)

    • Klasse de.dlr.proseo.procmgr.rest.model.RestConfiguredProcessor

      class RestConfiguredProcessor extends Object implements Serializable
      serialVersionUID:
      1910538353167087977L

      • Serialisierte Felder

        • configurationVersion
          String configurationVersion
          Version identification of the configuration environment
        • enabled
          Boolean enabled
          Indicator whether the configured processor is enabled and may be run
        • id
          Long id
          The persistent id of this object
        • identifier
          String identifier
          User-defined identifier for this processor configuration
        • missionCode
          String missionCode
          The mission code (e. g. S5P)
        • processorName
          String processorName
          User-defined unique processor class name
        • processorVersion
          String processorVersion
          Version identification of the processor executable (Docker image)
        • uuid
          String uuid
          Universally unique identifier for this processor configuration ("workflow" in ESA terminology)
        • version
          Long version
          A version identifier to track updates to the object (especially to detect concurrent update attempts)

    • Klasse de.dlr.proseo.procmgr.rest.model.RestInputFilter

      class RestInputFilter extends Object implements Serializable
      serialVersionUID:
      1862616318408411784L

      • Serialisierte Felder

        • filterConditions
          List<RestParameter> filterConditions
          Filter conditions to apply to input products of the given product class
        • productClass
          String productClass
          The product class the input filters apply to

    • Klasse de.dlr.proseo.procmgr.rest.model.RestParameter

      class RestParameter extends Object implements Serializable
      serialVersionUID:
      1958460383630796874L

      • Serialisierte Felder

        • key
          String key
          The parameter name
        • parameterType
          String parameterType
          The type of the parameter for deserialization (one of { "STRING", "INTEGER", "BOOLEAN", "DOUBLE", "INSTANT" } )
        • parameterValue
          String parameterValue
          All parameter values are serialized to their string representations. For deserialization refer to the parameterType.

    • Klasse de.dlr.proseo.procmgr.rest.model.RestProcessor

      class RestProcessor extends Object implements Serializable
      serialVersionUID:
      1670928175078739715L

      • Serialisierte Felder

        • configuredProcessors
          List<String> configuredProcessors
          The names for the processor configurations this processor version is valid for
        • dockerImage
          String dockerImage
          The name of the docker image (without registry address)
        • dockerRunParameters
          List<RestStringParameter> dockerRunParameters
          Parameters to add to the "docker run" command
        • id
          Long id
          The persistent id of this object
        • isTest
          Boolean isTest
          Indicates a test version of the processor (default false)
        • jobOrderVersion
          String jobOrderVersion
          Version identification of the Job Order file specification (allowed values MMFI_1_8 [default], GMES_1_1)
        • maxTime
          Long maxTime
          Execution time limit in seconds (default 0 means unlimited)
        • minDiskSpace
          Long minDiskSpace
          Minimum disk space in MB, worst case estimate plus safety margin (default 1024)
        • missionCode
          String missionCode
          The mission code (e. g. S5P)
        • processorName
          String processorName
          The name of the processor class this processor (version) belongs to
        • processorVersion
          String processorVersion
          Version identification of the processor executable (Docker image)
        • sensingTimeFlag
          Boolean sensingTimeFlag
          Indicates whether the processor uses a sensing time interval as main processing parameter (default true)
        • tasks
          List<RestTask> tasks
          List of tasks for this processor
        • useInputFileTimeIntervals
          Boolean useInputFileTimeIntervals
          Indicates whether time intervals shall be used for input files in the Job Order file (default false)
        • version
          Long version
          A version identifier to track updates to the object (especially to detect concurrent update attempts)

    • Klasse de.dlr.proseo.procmgr.rest.model.RestProcessorClass

      class RestProcessorClass extends Object implements Serializable
      serialVersionUID:
      1646140918238543202L

      • Serialisierte Felder

        • id
          Long id
          The persistent id of this object
        • missionCode
          String missionCode
          The mission code (e. g. S5P)
        • processorName
          String processorName
          User-defined unique processor class name
        • productClasses
          List<String> productClasses
          The product types of the product classes a processor of this class can generate
        • version
          Long version
          A version identifier to track updates to the object (especially to detect concurrent update attempts)

    • Klasse de.dlr.proseo.procmgr.rest.model.RestStringParameter

      class RestStringParameter extends Object implements Serializable
      serialVersionUID:
      1998119998011085131L

      • Serialisierte Felder

        • key
          String key
          The parameter key
        • value
          String value
          The parameter value

    • Klasse de.dlr.proseo.procmgr.rest.model.RestTask

      class RestTask extends Object implements Serializable
      serialVersionUID:
      2017949805201229259L

      • Serialisierte Felder

        • breakpointFileNames
          List<String> breakpointFileNames
          Intermediate output files for testing/evaluation purposes
        • criticalityLevel
          Long criticalityLevel
          Task priority, in case of failure all running tasks with a lower priority number will be aborted (mandatory for processors with more than one task)
        • id
          Long id
          The persistent id of this object
        • isCritical
          Boolean isCritical
          Indicates whether a failure of the task results in a failure of the whole processor (default true)
        • minMemory
          Long minMemory
          Minimum memory (RAM) requirement for this task in GiB
        • missionCode
          String missionCode
          The mission code (e. g. S5P) (not required if embedded in processor object)
        • numberOfCpus
          Long numberOfCpus
          The number of CPUs used by the task
        • processorName
          String processorName
          User-defined unique processor class name of the owning processor (not required if embedded in processor object)
        • processorVersion
          String processorVersion
          Version identification of the processor executable (Docker image) (not required if embedded in processor object)
        • taskName
          String taskName
          The task name (unique for the Processor)
        • taskVersion
          String taskVersion
          A version identifier for the task
        • version
          Long version
          A version identifier to track updates to the object (especially to detect concurrent update attempts)

    • Klasse de.dlr.proseo.procmgr.rest.model.RestWorkflow

      class RestWorkflow extends Object implements Serializable
      serialVersionUID:
      1925410706412212425L

      • Serialisierte Felder

        • classOutputParameters
          List<RestClassOutputParameter> classOutputParameters
          Set of parameters to apply to a generated product of the referenced product class replacing the general output parameters
        • configuredProcessor
          String configuredProcessor
          The identifier of the configured processor implementing this workflow
        • description
          String description
          Textual description of the workflow, including details of the processor version and configuration applicable
        • enabled
          Boolean enabled
          Flag indicating whether this workflow is available for use (disabled workflows are not visible on the ODIP)
        • id
          Long id
          The persistent id of this object
        • inputFilters
          List<RestInputFilter> inputFilters
          Filter conditions to apply to input products
        • inputProductClass
          String inputProductClass
          The (primary) ProductClass used as input for the workflow
        • missionCode
          String missionCode
          The mission code (e. g. S5P)
        • name
          String name
          Short name of the workflow
        • outputFileClass
          String outputFileClass
          The file class for the generated output products
        • outputParameters
          List<RestParameter> outputParameters
          Parameters to set for the generated products (may be empty)
        • outputProductClass
          String outputProductClass
          The ProductClass of the (main) output product
        • processingMode
          String processingMode
          The processing mode to run the processor(s) in
        • sliceDuration
          Long sliceDuration
          Duration of a slice in seconds (only for slicingType TIME_SLICE)
        • sliceOverlap
          Long sliceOverlap
          Overlap between adjacent slices in seconds (applicable for all slicingTypes except NONE, default 0)
        • slicingType
          String slicingType
          One of { "ORBIT", "CALENDAR_DAY", "CALENDAR_MONTH", "CALENDAR_YEAR", "TIME_SLICE", "NONE" }
        • uuid
          String uuid
          Universally unique workflow identifier
        • version
          Long version
          A version identifier to track updates to the object (especially to detect concurrent update attempts)
        • workflowOptions
          List<RestWorkflowOption> workflowOptions
          Options, which can be set as "Dynamic Processing Parameters" in Job Orders generated from this workflow
        • workflowVersion
          String workflowVersion
          Version number applicable to the workflow

    • Klasse de.dlr.proseo.procmgr.rest.model.RestWorkflowOption

      class RestWorkflowOption extends Object implements Serializable
      serialVersionUID:
      1856006381246707976L

      • Serialisierte Felder

        • defaultValue
          String defaultValue
          The default value of the option (from the value range, if applicable)
        • description
          String description
          Textual description of the workflow option
        • id
          Long id
          The persistent id of this object
        • missionCode
          String missionCode
          The mission code (e. g. S5P)
        • name
          String name
          Short name of the option
        • optionType
          String optionType
          Data type of the option, one of { string, number, datenumber }
        • valueRange
          List<String> valueRange
          List of all possible values of the option
        • version
          Long version
          A version identifier to track updates to the object (especially to detect concurrent update attempts)
        • workflowName
          String workflowName
          Unique short name of the owning workflow