fews_py_wrapper.models#

Classes

PiBaseModel(**extra_data)

PiFilterBoundingBox(*[, crs, minx, maxx, ...])

Typed FEWS PI filter bounding box.

PiFilter(*, id[, name, description, ...])

Typed FEWS PI filter entry.

PiFiltersResponse(*[, version, filters])

Collection model for the FEWS PI filters response.

PiLocationAttribute(*[, id, name, ...])

Typed FEWS PI location attribute.

PiLocationRelation(*, relatedLocationId[, ...])

Typed FEWS PI location relation.

PiLocation(*, locationId[, description, ...])

Typed representation of a FEWS PI location entry.

PiLocationsResponse(*[, version, geoDatum, ...])

Collection model for the FEWS PI locations response.

PiParameter(*, id[, name, shortName, ...])

Typed FEWS PI time-series parameter entry.

PiParametersResponse(*[, version, parameters])

Collection model for the FEWS PI time-series parameters response.

PiTaskRun(*, id[, forecast, current, ...])

Typed FEWS task-run descriptor.

PiTaskRunStatusResponse(*[, version, code, ...])

Typed FEWS task-run status response.

PiTaskRunsResponse(*[, task_runs])

Collection model for the FEWS task-runs response.

PiWhatIfScenarioDescriptor(*, id[, name, ...])

Typed FEWS what-if scenario descriptor.

PiWhatIfScenariosResponse(*[, ...])

Collection model for the FEWS what-if scenarios response.

PiWhatIfTemplateCardinalTimeStep(*[, ...])

Typed FEWS what-if template cardinal-time-step metadata.

PiWhatIfTemplateProperty(*, id[, name, ...])

Typed FEWS what-if template property descriptor.

PiWhatIfTemplateRelativeViewPeriod(*[, ...])

Typed FEWS what-if template relative-view-period metadata.

PiWhatIfTemplate(*, id[, name, properties, ...])

Typed FEWS what-if template descriptor.

PiWhatIfTemplatesResponse(*[, templates])

Collection model for the FEWS what-if templates response.

PiWorkflow(*, id[, name, description, ...])

Typed FEWS workflow descriptor.

PiWorkflowsResponse(*[, workflows])

Collection model for the FEWS workflows response.
class fews_py_wrapper.models.PiBaseModel(**extra_data)[source]#
Parameters:

extra_data (Any)

model_config = {'extra': 'allow', 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}#

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class fews_py_wrapper.models.PiFilterBoundingBox(*, crs=None, minx=None, maxx=None, miny=None, maxy=None, **extra_data)[source]#

Typed FEWS PI filter bounding box.

Parameters:

  • crs (str | None)

  • minx (float | None)

  • maxx (float | None)

  • miny (float | None)

  • maxy (float | None)

  • extra_data (Any)

model_config = {'extra': 'allow', 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}#

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class fews_py_wrapper.models.PiFilter(*, id, name=None, description=None, boundingBox=None, children=<factory>, **extra_data)[source]#

Typed FEWS PI filter entry.

Parameters:

  • id (str)

  • name (str | None)

  • description (str | None)

  • boundingBox (PiFilterBoundingBox | None)

  • children (list[PiFilter])

  • extra_data (Any)

model_config = {'extra': 'allow', 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}#

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class fews_py_wrapper.models.PiFiltersResponse(*, version=None, filters=<factory>, **extra_data)[source]#

Collection model for the FEWS PI filters response.

Parameters:

  • version (str | None)

  • filters (list[PiFilter])

  • extra_data (Any)

model_config = {'extra': 'allow', 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}#

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class fews_py_wrapper.models.PiLocationAttribute(*, id=None, name=None, description=None, startDateTime=None, endDateTime=None, text=None, number=None, boolean=None, dateTime=None, **extra_data)[source]#

Typed FEWS PI location attribute.

Parameters:

  • id (str | None)

  • name (str | None)

  • description (str | None)

  • startDateTime (str | None)

  • endDateTime (str | None)

  • text (str | None)

  • number (float | None)

  • boolean (bool | None)

  • dateTime (str | None)

  • extra_data (Any)

model_config = {'extra': 'allow', 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}#

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class fews_py_wrapper.models.PiLocationRelation(*, relatedLocationId, startDateTime=None, endDateTime=None, id=None, **extra_data)[source]#

Typed FEWS PI location relation.

Parameters:

  • relatedLocationId (str)

  • startDateTime (str | None)

  • endDateTime (str | None)

  • id (str | None)

  • extra_data (Any)

model_config = {'extra': 'allow', 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}#

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class fews_py_wrapper.models.PiLocation(*, locationId, description=None, shortName=None, startDateTime=None, endDateTime=None, lat=None, lon=None, x=None, y=None, z=None, parentLocationId=None, relations=<factory>, attributes=<factory>, **extra_data)[source]#

Typed representation of a FEWS PI location entry.

Parameters:

  • locationId (str)

  • description (str | None)

  • shortName (str | None)

  • startDateTime (str | None)

  • endDateTime (str | None)

  • lat (float | None)

  • lon (float | None)

  • x (float | None)

  • y (float | None)

  • z (float | None)

  • parentLocationId (str | None)

  • relations (list[PiLocationRelation])

  • attributes (list[PiLocationAttribute])

  • extra_data (Any)

model_config = {'extra': 'allow', 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}#

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class fews_py_wrapper.models.PiLocationsResponse(*, version=None, geoDatum=None, locations=<factory>, **extra_data)[source]#

Collection model for the FEWS PI locations response.

Parameters:

  • version (str | None)

  • geoDatum (str | None)

  • locations (list[PiLocation])

  • extra_data (Any)

model_config = {'extra': 'allow', 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}#

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class fews_py_wrapper.models.PiParameter(*, id, name=None, shortName=None, parameterType, unit, displayUnit=None, usesDatum=False, parameterGroup=None, parameterGroupName=None, attributes=<factory>, **extra_data)[source]#

Typed FEWS PI time-series parameter entry.

Parameters:

  • id (str)

  • name (str | None)

  • shortName (str | None)

  • parameterType (str)

  • unit (str)

  • displayUnit (str | None)

  • usesDatum (bool)

  • parameterGroup (str | None)

  • parameterGroupName (str | None)

  • attributes (list[PiLocationAttribute])

  • extra_data (Any)

model_config = {'extra': 'allow', 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}#

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class fews_py_wrapper.models.PiParametersResponse(*, version=None, parameters=<factory>, **extra_data)[source]#

Collection model for the FEWS PI time-series parameters response.

Parameters:

  • version (str | None)

  • parameters (list[PiParameter])

  • extra_data (Any)

model_config = {'extra': 'allow', 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}#

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class fews_py_wrapper.models.PiTaskRun(*, id, forecast=None, current=None, status=None, workflowId=None, topologyNodeId=None, scenarioId=None, mcId=None, dispatchTime=None, time0=None, coldStateId=None, user=None, description=None, **extra_data)[source]#

Typed FEWS task-run descriptor.

Parameters:

  • id (str)

  • forecast (bool | None)

  • current (bool | None)

  • status (str | None)

  • workflowId (str | None)

  • topologyNodeId (str | None)

  • scenarioId (str | None)

  • mcId (str | None)

  • dispatchTime (str | None)

  • time0 (str | None)

  • coldStateId (str | None)

  • user (str | None)

  • description (str | None)

  • extra_data (Any)

model_config = {'extra': 'allow', 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}#

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class fews_py_wrapper.models.PiTaskRunStatusResponse(*, version=None, code=None, description=None, taskRunId=None, **extra_data)[source]#

Typed FEWS task-run status response.

Parameters:

  • version (str | None)

  • code (str | None)

  • description (str | None)

  • taskRunId (str | None)

  • extra_data (Any)

model_config = {'extra': 'allow', 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}#

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class fews_py_wrapper.models.PiTaskRunsResponse(*, task_runs=<factory>, **extra_data)[source]#

Collection model for the FEWS task-runs response.

Parameters:

  • task_runs (list[PiTaskRun])

  • extra_data (Any)

model_config = {'extra': 'allow', 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}#

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class fews_py_wrapper.models.PiWhatIfScenarioDescriptor(*, id, name=None, whatIfTemplateId=None, singleRunWhatIf=None, properties=<factory>, **extra_data)[source]#

Typed FEWS what-if scenario descriptor.

Parameters:

  • id (str)

  • name (str | None)

  • whatIfTemplateId (str | None)

  • singleRunWhatIf (bool | None)

  • properties (list[dict[str, Any]])

  • extra_data (Any)

model_config = {'extra': 'allow', 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}#

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class fews_py_wrapper.models.PiWhatIfScenariosResponse(*, scenario_descriptors=<factory>, **extra_data)[source]#

Collection model for the FEWS what-if scenarios response.

Parameters:
model_config = {'extra': 'allow', 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}#

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class fews_py_wrapper.models.PiWhatIfTemplateCardinalTimeStep(*, timeZone=None, unit=None, multiplier=None, **extra_data)[source]#

Typed FEWS what-if template cardinal-time-step metadata.

Parameters:

  • timeZone (str | None)

  • unit (str | None)

  • multiplier (int | None)

  • extra_data (Any)

model_config = {'extra': 'allow', 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}#

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class fews_py_wrapper.models.PiWhatIfTemplateProperty(*, id, name=None, type=None, description=None, defaultValue=None, maxValue=None, minValue=None, enumValues=<factory>, relativeViewPeriod=None, cardinalTimeStep=None, **extra_data)[source]#

Typed FEWS what-if template property descriptor.

Parameters:
model_config = {'extra': 'allow', 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}#

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class fews_py_wrapper.models.PiWhatIfTemplateRelativeViewPeriod(*, unit=None, start=None, end=None, **extra_data)[source]#

Typed FEWS what-if template relative-view-period metadata.

Parameters:

  • unit (str | None)

  • start (str | None)

  • end (str | None)

  • extra_data (Any)

model_config = {'extra': 'allow', 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}#

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class fews_py_wrapper.models.PiWhatIfTemplate(*, id, name=None, properties=<factory>, defaultSingleRunWhatIfSetting=None, overrulableSingleRunWhatIf=None, **extra_data)[source]#

Typed FEWS what-if template descriptor.

Parameters:

  • id (str)

  • name (str | None)

  • properties (list[PiWhatIfTemplateProperty])

  • defaultSingleRunWhatIfSetting (bool | None)

  • overrulableSingleRunWhatIf (bool | None)

  • extra_data (Any)

model_config = {'extra': 'allow', 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}#

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class fews_py_wrapper.models.PiWhatIfTemplatesResponse(*, templates=<factory>, **extra_data)[source]#

Collection model for the FEWS what-if templates response.

Parameters:
model_config = {'extra': 'allow', 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}#

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class fews_py_wrapper.models.PiWorkflow(*, id, name=None, description=None, whatIfTemplateId=None, **extra_data)[source]#

Typed FEWS workflow descriptor.

Parameters:

  • id (str)

  • name (str | None)

  • description (str | None)

  • whatIfTemplateId (str | None)

  • extra_data (Any)

model_config = {'extra': 'allow', 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}#

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class fews_py_wrapper.models.PiWorkflowsResponse(*, workflows=<factory>, **extra_data)[source]#

Collection model for the FEWS workflows response.

Parameters:
model_config = {'extra': 'allow', 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}#

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].