ParametersModel

pydantic model safir.uws.ParametersModel

Defines the interface for a model suitable for job parameters.

Parameters:

data (Any)

Show JSON schema

{
   "title": "ParametersModel",
   "description": "Defines the interface for a model suitable for job parameters.",
   "type": "object",
   "properties": {}
}

abstract classmethod from_job_parameters(params)

Validate generic UWS parameters and convert to the internal model.

Parameters:

params (list[UWSJobParameter]) – Generic input job parameters.

Returns:

Parsed cutout parameters specific to service.

Return type:

ParametersModel

Raises:

• safir.uws.MultiValuedParameterError – Raised if multiple parameters are provided but not supported.

• safir.uws.ParameterError – Raised if one of the parameters could not be parsed.

• pydantic.ValidationError – Raised if the parameters do not validate.

abstract to_worker_parameters()

Convert to the domain model used by the backend worker.

Return type:

TypeVar(W, bound= BaseModel)

abstract to_xml_model()

Convert to the XML model used in XML API responses.

Return type:

TypeVar(X, bound= Parameters)