bayesline.api.SettingsTransferObject

pydantic model bayesline.api.SettingsTransferObject

A settings transfer object.

Show JSON schema

{
   "title": "SettingsTransferObject",
   "description": "A settings transfer object.",
   "type": "object",
   "properties": {
      "kind": {
         "title": "Kind",
         "type": "string"
      },
      "name": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "title": "Name"
      },
      "identifier": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "title": "Identifier"
      },
      "value": {
         "additionalProperties": true,
         "default": {},
         "title": "Value",
         "type": "object"
      },
      "settings_type": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Settings Type"
      },
      "owner": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Owner"
      },
      "issues": {
         "default": [],
         "items": {
            "type": "string"
         },
         "title": "Issues",
         "type": "array"
      },
      "missing_refs": {
         "default": [],
         "items": {
            "anyOf": [
               {
                  "type": "string"
               },
               {
                  "type": "integer"
               }
            ]
         },
         "title": "Missing Refs",
         "type": "array"
      },
      "created_on": {
         "anyOf": [
            {
               "format": "date-time",
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Created On"
      },
      "last_updated_on": {
         "anyOf": [
            {
               "format": "date-time",
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Last Updated On"
      },
      "dataset": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Dataset"
      }
   },
   "required": [
      "kind",
      "name",
      "identifier"
   ]
}

Fields:

• created_on (datetime.datetime | None)

• dataset (str | None)

• identifier (int | None)

• issues (collections.abc.Sequence[str])

• kind (str)

• last_updated_on (datetime.datetime | None)

• missing_refs (collections.abc.Sequence[str | int])

• name (str | None)

• owner (str | None)

• settings_type (str | None)

• value (dict[str, Any])

field kind: str [Required]

field name: str | None [Required]

field identifier: int | None [Required]

field value: dict[str, Any] = {}

field settings_type: str | None = None

field owner: str | None = None

field issues: Sequence[str] = []

field missing_refs: Sequence[str | int] = []

field created_on: dt.datetime | None = None

field last_updated_on: dt.datetime | None = None

field dataset: str | None = None

to_settings(settings_types: list[type[Settings]]) → SettingValid[T] | SettingInvalid | SettingNotFound | SettingNotPermissioned

Convert the settings transfer object to a settings object.

Parameters

settings_typeslist[type[Settings]]

The available types to use to convert the settings transfer object to.

Raises

ValueError

If the settings type is not found.

AssertionError

If the settings transfer object is not of a known kind.

Returns

SettingResult

The settings object.

classmethod from_settings(s: SettingValid[T] | SettingInvalid | SettingNotFound | SettingNotPermissioned) → SettingsTransferObject

Convert the settings object to a settings transfer object.

Parameters

sSettingResult

The settings object to convert.

Raises

AssertionError

If the settings object is not of a known kind.

Returns

SettingsTransferObject

The settings transfer object.