NubladoImageByClass#

pydantic model rubin.nublado.client.NubladoImageByClass#

Spawn the recommended image.

Parameters:

data (Any)

Show JSON schema
{
   "title": "NubladoImageByClass",
   "description": "Spawn the recommended image.",
   "type": "object",
   "properties": {
      "image_class": {
         "default": "recommended",
         "enum": [
            "recommended",
            "latest-release",
            "latest-weekly",
            "latest-daily"
         ],
         "title": "Class of image to spawn",
         "type": "string"
      },
      "size": {
         "$ref": "#/$defs/NubladoImageSize",
         "default": "Large",
         "description": "Must be one of the sizes understood by Nublado.",
         "title": "Size of image to spawn"
      },
      "description": {
         "default": "",
         "title": "Human-readable image description",
         "type": "string"
      },
      "debug": {
         "default": false,
         "title": "Whether to enable lab debugging",
         "type": "boolean"
      }
   },
   "$defs": {
      "NubladoImageSize": {
         "description": "Acceptable sizes of images to spawn.",
         "enum": [
            "Fine",
            "Diminutive",
            "Tiny",
            "Small",
            "Medium",
            "Large",
            "Huge",
            "Gargantuan",
            "Colossal"
         ],
         "title": "NubladoImageSize",
         "type": "string"
      }
   }
}

Fields:
field debug: bool = False#
field description: str = ''#
field image_class: Literal[NubladoImageClass.RECOMMENDED, NubladoImageClass.LATEST_RELEASE, NubladoImageClass.LATEST_WEEKLY, NubladoImageClass.LATEST_DAILY] = NubladoImageClass.RECOMMENDED#
field size: NubladoImageSize = NubladoImageSize.Large#

Must be one of the sizes understood by Nublado.

to_spawn_form()#

Convert to data suitable for posting to Nublado’s spawn form.

Returns:

Post data to send to the JupyterHub spawn page.

Return type:

dict of str