bayesline.api.SettingsIdentifiers

bayesline.api.SettingsIdentifiers#

pydantic model bayesline.api.SettingsIdentifiers#

Holds mappings of globally unique settings identifiers to other properties.

Show JSON schema
{
   "title": "SettingsIdentifiers",
   "description": "Holds mappings of globally unique settings identifiers to other properties.",
   "type": "object",
   "properties": {
      "id_to_name": {
         "additionalProperties": {
            "type": "string"
         },
         "description": "Mapping of globally unique identifiers to their names.",
         "title": "Id To Name",
         "type": "object"
      },
      "name_to_id": {
         "additionalProperties": {
            "type": "integer"
         },
         "description": "Mapping of names to their globally unique identifiers.",
         "title": "Name To Id",
         "type": "object"
      },
      "id_to_type": {
         "additionalProperties": true,
         "description": "Mapping of globally unique identifiers to the settings type.",
         "title": "Id To Type",
         "type": "object"
      },
      "id_to_user_email": {
         "additionalProperties": {
            "type": "string"
         },
         "description": "Mapping of globally unique identifiers to the user emails who own them.",
         "title": "Id To User Email",
         "type": "object"
      },
      "id_to_created_on": {
         "additionalProperties": {
            "format": "date-time",
            "type": "string"
         },
         "description": "Mapping of globally unique identifiers to their creation timestamps.",
         "title": "Id To Created On",
         "type": "object"
      },
      "id_to_last_updated_on": {
         "additionalProperties": {
            "format": "date-time",
            "type": "string"
         },
         "description": "Mapping of globally unique identifiers to their last update timestamps.",
         "title": "Id To Last Updated On",
         "type": "object"
      }
   },
   "required": [
      "id_to_name",
      "name_to_id",
      "id_to_type",
      "id_to_user_email"
   ]
}

Fields:

  • id_to_created_on (collections.abc.Mapping[int, datetime.datetime])

  • id_to_last_updated_on (collections.abc.Mapping[int, datetime.datetime])

  • id_to_name (collections.abc.Mapping[int, str])

  • id_to_type (collections.abc.Mapping[int, type[bayesline.api._src.settings_base.Settings]])

  • id_to_user_email (collections.abc.Mapping[int, str])

  • name_to_id (collections.abc.Mapping[str, int])

Validators:

  • filter_unknown_types » all fields

  • parse_type » id_to_type

field id_to_name: Mapping[int, str] [Required]#

Mapping of globally unique identifiers to their names.

Validated by:

  • filter_unknown_types

field name_to_id: Mapping[str, int] [Required]#

Mapping of names to their globally unique identifiers.

Validated by:

  • filter_unknown_types

field id_to_type: Mapping[int, type[Settings]] [Required]#

Mapping of globally unique identifiers to the settings type.

Validated by:

  • filter_unknown_types

  • parse_type

field id_to_user_email: Mapping[int, str] [Required]#

Mapping of globally unique identifiers to the user emails who own them.

Validated by:

  • filter_unknown_types

field id_to_created_on: Mapping[int, dt.datetime] [Optional]#

Mapping of globally unique identifiers to their creation timestamps.

Validated by:

  • filter_unknown_types

field id_to_last_updated_on: Mapping[int, dt.datetime] [Optional]#

Mapping of globally unique identifiers to their last update timestamps.

Validated by:

  • filter_unknown_types

property id_to_qualified_name: Mapping[int, str]#

Mapping of globally unique identifiers to their qualified names.

A qualified name is the name of the settings prefixed with the user email. This makes the name unique across all users.

validator filter_unknown_types → Any  »  all fields#
validator parse_type → dict[int, type[Settings]]  »  id_to_type#
serialize_type(v: dict[int, type[Settings]]) → dict[int, str]#