supervisor_pydantic.GroupConfiguration

pydantic model supervisor_pydantic.GroupConfiguration[source]

Bases: _BaseCfgModel

Show JSON schema
{
   "title": "GroupConfiguration",
   "type": "object",
   "properties": {
      "programs": {
         "description": "A comma-separated list of program names. The programs which are listed become members of the group.",
         "items": {
            "type": "string"
         },
         "title": "Programs",
         "type": "array"
      },
      "priority": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "A priority number analogous to a [program:x] priority value assigned to the group.",
         "title": "Priority"
      }
   },
   "required": [
      "programs"
   ]
}

Fields:
  • priority (int | None)

  • programs (List[str])

to_cfg(key: str) str[source]
field programs: List[str] [Required]

A comma-separated list of program names. The programs which are listed become members of the group.

field priority: int | None = None

A priority number analogous to a [program:x] priority value assigned to the group.