NubladoImage

pydantic model rubin.nublado.client.NubladoImage

Base class for different ways of specifying the lab image to spawn.

Parameters:

data (Any)

Show JSON schema

{
   "title": "NubladoImage",
   "description": "Base class for different ways of specifying the lab image to spawn.",
   "type": "object",
   "properties": {
      "image_class": {
         "$ref": "#/$defs/NubladoImageClass",
         "title": "Class of image to spawn"
      },
      "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": {
      "NubladoImageClass": {
         "description": "Possible ways of selecting an image.",
         "enum": [
            "recommended",
            "latest-release",
            "latest-weekly",
            "latest-daily",
            "by-reference",
            "by-tag"
         ],
         "title": "NubladoImageClass",
         "type": "string"
      },
      "NubladoImageSize": {
         "description": "Acceptable sizes of images to spawn.",
         "enum": [
            "Fine",
            "Diminutive",
            "Tiny",
            "Small",
            "Medium",
            "Large",
            "Huge",
            "Gargantuan",
            "Colossal"
         ],
         "title": "NubladoImageSize",
         "type": "string"
      }
   },
   "required": [
      "image_class"
   ]
}

Fields:

• debug (bool)

• description (str)

• image_class (rubin.nublado.client._models.NubladoImageClass)

• size (rubin.nublado.client._models.NubladoImageSize)

field debug: bool = False

field description: str = ''

field image_class: NubladoImageClass [Required]

field size: NubladoImageSize = NubladoImageSize.Large

Must be one of the sizes understood by Nublado.

abstract 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