ska_oso_pdm.schemas.sdp

The schemas.sdp.sdp_configuration module defines Marshmallow schemas .

class SDPConfigurationSchema(*args, **kwargs)[source]

Marshmallow class for the SDPConfiguration class

create_sdp_config(data, **_)[source]

Convert parsed JSON back into a SDPConfiguration object.

Parameters:
  • data – Marshmallow-provided dict containing parsed JSON values
  • _ – kwargs passed by Marshmallow
Returns:

SDPConfiguration object populated from data

The schemas.sdp.scan_type module defines Marshmallow schemas .

class ChannelSchema(*args, **kwargs)[source]

Marshmallow schema for the Channel class.

create_channel(data, **_)[source]

Convert parsed JSON back into a Channel object.

Parameters:
  • data – Marshmallow-provided dict containing parsed JSON values
  • _ – kwargs passed by Marshmallow
Returns:

SubBand object populated from data

class ScanTypeSchema(*args, **kwargs)[source]

Marshmallow schema for the ScanType class.

create_scan_type(data, **_)[source]

Convert parsed JSON back into a ScanType object.

Parameters:
  • data – Marshmallow-provided dict containing parsed JSON values
  • _ – kwargs passed by Marshmallow
Returns:

ScanType object populated from data

The schemas.sdp.processing_block module defines Marshmallow schemas .

class WorkflowSchema(*args, **kwargs)[source]

Represents the type of workflow being configured on the SDP

create_sdp_wf(data, **_)[source]

Convert parsed JSON back into a Workflow object.

Parameters:
  • data – Marshmallow-provided dict containing parsed JSON values
  • _ – kwargs passed by Marshmallow
Returns:

SDP Workflow object populated from data

class PbDependencySchema(*args, **kwargs)[source]

Marshmallow schema for the PbDepedency class.

create_pb_dependency(data, **_)[source]

Convert parsed JSON back into a PbDependency object.

Parameters:
  • data – Marshmallow-provided dict containing parsed JSON values
  • _ – kwargs passed by Marshmallow
Returns:

PbDependency object populated from data

class ProcessingBlockSchema(*args, **kwargs)[source]

Marshmallow schema for the ProcessingBlock class.

create_processing_block(data, **_)[source]

Convert parsed JSON back into a PB object.

Parameters:
  • data – Marshmallow-provided dict containing parsed JSON values
  • _ – kwargs passed by Marshmallow
Returns:

PB object populated from data

filter_nulls(data, **_)[source]

Filter out null values from JSON.

Parameters:
  • data – Marshmallow-provided dict containing parsed object values
  • _ – kwargs passed by Marshmallow
Returns:

dict suitable for PB configuration