fews_py_wrapper.models#

Classes

PiBaseModel()

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.
class fews_py_wrapper.models.PiBaseModel[source]#
model_config = {'extra': 'forbid', '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)[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)

model_config = {'extra': 'forbid', '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)[source]#

Typed FEWS PI location relation.

Parameters:

  • relatedLocationId (str)

  • startDateTime (str | None)

  • endDateTime (str | None)

  • id (str | None)

model_config = {'extra': 'forbid', '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>)[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])

model_config = {'extra': 'forbid', '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>)[source]#

Collection model for the FEWS PI locations response.

Parameters:

  • version (str | None)

  • geoDatum (str | None)

  • locations (list[PiLocation])

model_config = {'extra': 'forbid', '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>)[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])

model_config = {'extra': 'forbid', '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>)[source]#

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

Parameters:
model_config = {'extra': 'forbid', '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].