Serialisierte Form

Package de.dlr.proseo.interfaces.rest.model

Klasse de.dlr.proseo.interfaces.rest.model.IngestorProduct

class IngestorProduct extends RestProduct implements Serializable

serialVersionUID:

-7318518653791486400L

Serialisierte Felder

auxFileNames

List<String> auxFileNames

Names of auxiliary files being part of the product

checksum

String checksum

Checksum value for the primary product file (computed by MD5 algorithm)

checksumTime

String checksumTime

Checksum generation time in orbit format (YYYY-MM-DDThh:mm:ss.SSSSSS)

filePath

String filePath

The S3/POSIX/ALLUXIO path to the product files (relative to mountPoint)

fileSize

Long fileSize

The size of the primary product file in bytes

mountPoint

String mountPoint

The S3/POSIX/ALLUXIO mount point of the storage system to ingest from

productFileName

String productFileName

File name of the main product file

sourceStorageType

String sourceStorageType

The type of the storage to ingest the data from

Klasse de.dlr.proseo.interfaces.rest.model.Joborder

class Joborder extends Object implements Serializable

serialVersionUID:

-7262334202949389567L

Serialisierte Felder

bucket

String bucket

prefix

String prefix

Klasse de.dlr.proseo.interfaces.rest.model.Orbit

class Orbit extends Object implements Serializable

serialVersionUID:

-7288773943006270207L

Serialisierte Felder

orbitNumber

Long orbitNumber

spacecraftCode

String spacecraftCode

Klasse de.dlr.proseo.interfaces.rest.model.Posix

class Posix extends Object implements Serializable

serialVersionUID:

-7265639169382757823L

Serialisierte Felder

backendPath

String backendPath

cachePath

String cachePath

Klasse de.dlr.proseo.interfaces.rest.model.RestClassOutputParameter

class RestClassOutputParameter extends Object implements Serializable

serialVersionUID:

-8731392426826673795L

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.interfaces.rest.model.RestConfiguredProcessor

class RestConfiguredProcessor extends Object implements Serializable

serialVersionUID:

-7369745659278498145L

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.interfaces.rest.model.RestDownloadHistory

class RestDownloadHistory extends Object implements Serializable

serialVersionUID:

-7285468976572901951L

Serialisierte Felder

dateTime

String dateTime

The time of the download in orbit format (YYYY-MM-DDThh:mm:ss.SSSSSS)

productFileName

String productFileName

The file name of the downloaded ProductFile

productFileSize

Long productFileSize

The product file size in bytes

username

String username

The user who initiated the download

Klasse de.dlr.proseo.interfaces.rest.model.RestFileInfo

class RestFileInfo extends Object implements Serializable

serialVersionUID:

-7245809362192613694L

Serialisierte Felder

fileName

String fileName

The file name

filePath

String filePath

The S3/POSIX/ALLUXIO path to the file

fileSize

Long fileSize

The size of the primary product file in bytes

storageType

String storageType

The type of the storage to ingest the data from

Klasse de.dlr.proseo.interfaces.rest.model.RestHealth

class RestHealth extends Object implements Serializable

serialVersionUID:

-8711562619636529666L

Serialisierte Felder

status

String status

The spring actuator simple health state

Klasse de.dlr.proseo.interfaces.rest.model.RestInfo

class RestInfo extends Object implements Serializable

serialVersionUID:

-7249114328625981950L

Serialisierte Felder

joborder

Joborder joborder

posix

Posix posix

s3

S3 s3

Klasse de.dlr.proseo.interfaces.rest.model.RestInputFilter

class RestInputFilter extends Object implements Serializable

serialVersionUID:

-8724782489664969987L

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.interfaces.rest.model.RestInputReference

class RestInputReference extends Object implements Serializable

serialVersionUID:

-7396185399335378786L

Serialisierte Felder

inputFileName

String inputFileName

The file name of the input product to retrieve

sensingStartTime

String sensingStartTime

Sensing start time of the input product

sensingStopTime

String sensingStopTime

Sensing stop time of the input product

Klasse de.dlr.proseo.interfaces.rest.model.RestInterfaceStatus

class RestInterfaceStatus extends Object implements Serializable

serialVersionUID:

-7224327071785785438L

Serialisierte Felder

available

Boolean available

Flag indicating whether the interface endpoint is reachable

id

String id

Interface identifier

performance

Double performance

Latest download performance in MiB/s

Klasse de.dlr.proseo.interfaces.rest.model.RestJoborder

class RestJoborder extends Object implements Serializable

serialVersionUID:

-7227632038219153694L

Serialisierte Felder

fsType

String fsType

The type of the storage

jobOrderStringBase64

String jobOrderStringBase64

message

String message

pathInfo

String pathInfo

uploaded

Boolean uploaded

Klasse de.dlr.proseo.interfaces.rest.model.RestMessage

class RestMessage extends Object implements Serializable

serialVersionUID:

-8718172552503266179L

Serialisierte Felder

contentType

String contentType

The HTML content type

endpoint

String endpoint

The notification endpoint (HTTP(S) or mail)

message

String message

The message data

messageCode

String messageCode

The message code

password

String password

Password to authenticate

raw

Boolean raw

Flag to identify raw message data

sender

String sender

The sender of the message

subject

String subject

The subject

user

String user

User to authenticate

Klasse de.dlr.proseo.interfaces.rest.model.RestNotificationEndpoint

class RestNotificationEndpoint extends Object implements Serializable

serialVersionUID:

-8741307330421745859L

Serialisierte Felder

password

String password

The password to authenticate with, mandatory if username is given; may be set to replacement value (e. g. asterisks) on data retrieval requests

uri

String uri

The URI used to notify the ProcessingOrder originator of the order completion

username

String username

The username to authenticate with (using Basic Authentication)

Klasse de.dlr.proseo.interfaces.rest.model.RestOrbitQuery

class RestOrbitQuery extends Object implements Serializable

serialVersionUID:

-8739654847205061731L

Serialisierte Felder

orbitNumberFrom

Long orbitNumberFrom

orbitNumberTo

Long orbitNumberTo

spacecraftCode

String spacecraftCode

Klasse de.dlr.proseo.interfaces.rest.model.RestOrder

class RestOrder extends Object implements Serializable

serialVersionUID:

-7376355596440201954L

Serialisierte Felder

actualCompletionTime

Date actualCompletionTime

Date and time when the output product(s) was/were available for download from the (OD)PRIP (mandatory for ProcessingOrders created via the ODIP, once they are in state "COMPLETED")

classOutputParameters

List<RestClassOutputParameter> classOutputParameters

Set of parameters to apply to a generated product of the referenced product class replacing the general output parameters

configuredProcessors

List<String> configuredProcessors

List of identifiers of the configured processors (may be empty)

createdJobs

Long createdJobs

Fully created/released jobs for planning and releasing

dynamicProcessingParameters

List<RestParameter> dynamicProcessingParameters

Processing option settings (for on-demand processing called "WorkflowOptions" in the ICD); these options will be passed to the data processors in the "Dynamic Processing Parameter" section of the Job Order file

estimatedCompletionTime

Date estimatedCompletionTime

Estimated date and time when the output product(s) will be available for download from the (OD)PRIP (mandatory for ProcessingOrders created via the ODIP)

evictionTime

Date evictionTime

Eviction time (optional, used for automatic order deletion)

executionTime

Date executionTime

Expected execution time (optional, used for scheduling)

expectedJobs

Long expectedJobs

Expected jobs for planning and releasing

hasFailedJobSteps

Boolean hasFailedJobSteps

Indicates whether at least one of the job steps for this order is in state FAILED

id

Long id

The persistent id of this object

identifier

String identifier

User-defined order identifier

inputFilters

List<RestInputFilter> inputFilters

Filter conditions to apply to input products

inputProductClasses

List<String> inputProductClasses

List of internal product types provided as input to the order (may be empty)

inputProductReference

RestInputReference inputProductReference

Identification of the input product to use for On-Demand Production

jobStepStates

List<String> jobStepStates

The different existing job step states of order

missionCode

String missionCode

The mission code (e. g. S5P)

notificationEndpoint

RestNotificationEndpoint notificationEndpoint

The endpoint to send order completion notifications to

orbits

List<RestOrbitQuery> orbits

List of orbit ranges, identified by spacecraft code and orbit number from/to (may be empty)

orderSource

String orderSource

Source application for the processing order; one of { CLI, GUI, ODIP, OTHER }

orderState

String orderState

State of the processing order; one of { INITIAL, APPROVED, RELEASING, RELEASED, PLANNING, PLANNING_FAILED, PLANNED, RUNNING, SUSPENDING, COMPLETED, FAILED, CLOSED }

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)

percentCompleted

Long percentCompleted

Percentage of completed job steps

percentFailed

Long percentFailed

Percentage of failed job steps

percentRunning

Long percentRunning

Percentage of running job steps

priority

Integer priority

Priority of the ProcessingOrder (lower number means lower priority; value range 1..100 is defined for the ODIP, but other values are allowed outside On-Demand Production, including negative numbers). Default value is 50.

processingMode

String processingMode

The processing mode to run the processor(s) in

productionType

String productionType

Production type context, in which the order is running (SYSTEMATIC, ON_DEMAND_DEFAULT, ON_DEMAND_NON_DEFAULT)

productRetentionPeriod

Long productRetentionPeriod

Retention period for products generated by this processing order in seconds

releaseTime

Date releaseTime

Date and time at which the ProcessingOrder was received (mandatory for ProcessingOrders created via the ODIP)

requestedProductClasses

List<String> requestedProductClasses

List of internal product types requested as output from the order (at least one is required)

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" }

startTime

String startTime

The start time of the time interval to process in orbit format (YYYY-MM-DDThh:mm:ss[.SSSSSS]). If a range of orbit numbers is given, this time is set to the earliest start time of the selected orbits.

stateMessage

String stateMessage

Explanatory message describing the reason for the latest state change (mandatory for ProcessingOrders created via the ODIP)

stopTime

String stopTime

The end time of the time interval to process in orbit format (YYYY-MM-DDThh:mm:ss[.SSSSSS]). If a range of orbit numbers is given, this time is set to the latest stop time of the selected orbits.

submissionTime

Date submissionTime

Date and time at which the ProcessingOrder was received (mandatory for ProcessingOrders created via the ODIP)

uuid

String uuid

Universally unique order identifier

version

Long version

A version identifier to track updates to the object (especially to detect concurrent update attempts)

workflowName

String workflowName

Short name of the applicable workflow (not suitable for identification; only for orders generated through ODIP)

workflowUuid

String workflowUuid

Universally unique workflow identifier (only for orders generated through ODIP, mandatory for these)

Klasse de.dlr.proseo.interfaces.rest.model.RestParameter

class RestParameter extends Object implements Serializable

serialVersionUID:

-7321823624519821952L

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.interfaces.rest.model.RestProduct

class RestProduct extends Object implements Serializable

serialVersionUID:

-7315213687358118144L

Serialisierte Felder

componentProductIds

List<Long> componentProductIds

Id values of the component products

configuredProcessor

RestConfiguredProcessor configuredProcessor

The generating processor and its configuration

downloadHistory

List<RestDownloadHistory> downloadHistory

The download history for this product

enclosingProductId

Long enclosingProductId

Id value of the enclosing product

evictionTime

String evictionTime

Product eviction time in orbit format (YYYY-MM-DDThh:mm:ss.SSSSSS)

fileClass

String fileClass

File class as defined for the enclosing mission (optional)

generationTime

String generationTime

Product generation time in orbit format (YYYY-MM-DDThh:mm:ss.SSSSSS)

id

Long id

The persistent id of this object

missionCode

String missionCode

The mission code of the Product class this products instantiates

mode

String mode

Processing modes as defined for the enclosing mission (only if generated by this mission)

orbit

Orbit orbit

Orbit relationship of this product, if any

parameters

List<RestParameter> parameters

A collection of mission-specific parameters for this object

processingLevel

String processingLevel

The level of processing required for this product's product class (L0, L1, L1A, L1B, L2, L2A etc.; output only)

productClass

String productClass

Product type of the Product class this products instantiates

productFile

List<RestProductFile> productFile

Product files for this product

productionType

String productionType

Type of production process generating this product (SYSTEMATIC, ON_DEMAND_DEFAULT, ON_DEMAND_NON_DEFAULT)

productQuality

String productQuality

Indicator for the suitability of this product for general use (NOMINAL, EXPERIMENTAL, TEST; default NOMINAL)

publicationTime

String publicationTime

Product ingestion time in orbit format (YYYY-MM-DDThh:mm:ss.SSSSSS)

rawDataAvailabilityTime

String rawDataAvailabilityTime

Satellite raw data availability time in orbit format (YYYY-MM-DDThh:mm:ss.SSSSSS)

requestedStartTime

String requestedStartTime

Planned start time in orbit format (YYYY-MM-DDThh:mm:ss.SSSSSS), default same as sensingStartTime

requestedStopTime

String requestedStopTime

Planned stop time in orbit format (YYYY-MM-DDThh:mm:ss.SSSSSS), default same as sensingStopTime

sensingStartTime

String sensingStartTime

Sensing start time in orbit format (YYYY-MM-DDThh:mm:ss.SSSSSS)

sensingStopTime

String sensingStopTime

Sensing stop time in orbit format (YYYY-MM-DDThh:mm:ss.SSSSSS)

uuid

String uuid

Universally unique product identifier

version

Long version

A version identifier to track updates to the object (especially to detect concurrent update attempts)

Klasse de.dlr.proseo.interfaces.rest.model.RestProductFile

class RestProductFile extends Object implements Serializable

serialVersionUID:

-7348263364576702593L

Serialisierte Felder

auxFileNames

List<String> auxFileNames

The auxiliary files for this product file

checksum

String checksum

Checksum value for the primary product file (computed by MD5 algorithm)

checksumTime

String checksumTime

Checksum generation time in orbit format (YYYY-MM-DDThh:mm:ss.SSSSSS)

filePath

String filePath

The path to the product files (POSIX file path, S3 bucket etc.)

fileSize

Long fileSize

The size of the primary product file in bytes

id

Long id

The persistent id of this object

processingFacilityName

String processingFacilityName

The name of the processing facility, in which this product file is stored

productFileName

String productFileName

The name of the product data file

productId

Long productId

Id value of the product this product file belongs to

storageType

String storageType

The string representation of the type of the storage location (e. g. "S3", "POSIX")

version

Long version

A version identifier to track updates to the object (especially to detect concurrent update attempts)

zipChecksum

String zipChecksum

The MD5 checksum for the ZIP archive

zipChecksumTime

String zipChecksumTime

ZIP archive checksum generation time in orbit format (YYYY-MM-DDThh:mm:ss.SSSSSS)

zipFileName

String zipFileName

The file name of the ZIP archive containing all product and auxiliary files intended for distribution

zipFileSize

Long zipFileSize

The file size of the ZIP archive in bytes

Klasse de.dlr.proseo.interfaces.rest.model.RestProductFS

class RestProductFS extends Object implements Serializable

serialVersionUID:

-7297036363384658144L

Serialisierte Felder

deleted

Boolean deleted

message

String message

productId

String productId

registered

Boolean registered

registeredFilePath

String registeredFilePath

registeredFilesCount

Long registeredFilesCount

registeredFilesList

List<String> registeredFilesList

sourceFilePaths

List<String> sourceFilePaths

sourceStorageType

String sourceStorageType

The type of the storage

targetStorageId

String targetStorageId

targetStorageType

String targetStorageType

The type of the storage

Klasse de.dlr.proseo.interfaces.rest.model.RestStorage

class RestStorage extends Object implements Serializable

serialVersionUID:

-7311908720924749888L

Serialisierte Felder

description

String description

id

String id

storageType

String storageType

The type of the storage

Klasse de.dlr.proseo.interfaces.rest.model.S3

class S3 extends Object implements Serializable

serialVersionUID:

-7259029236516021311L

Serialisierte Felder

s3DefaultBucket

String s3DefaultBucket

s3EndPoint

String s3EndPoint

s3MaxNumberOfBuckets

Long s3MaxNumberOfBuckets

s3Region

String s3Region

Klasse de.dlr.proseo.interfaces.rest.model.SelectionRuleString

class SelectionRuleString extends Object implements Serializable

serialVersionUID:

-7412710240092154659L

Serialisierte Felder

configuredProcessors

List<String> configuredProcessors

A list of identifiers for processor configurations, for which this rule is applicable

id

Long id

The persistent id of this object

mode

String mode

Processing modes as defined for the enclosing mission

selectionRule

String selectionRule

A selection rule in Rule Language

version

Long version

A version identifier to track updates to the object (especially to detect concurrent update attempts)