NubladoImageByReference

pydantic model rubin.nublado.client.NubladoImageByReference

Spawn an image by full Docker reference.

Parameters:

data (Any)

Show JSON schema

{
   "title": "NubladoImageByReference",
   "description": "Spawn an image by full Docker reference.",
   "type": "object",
   "properties": {
      "image_class": {
         "const": "by-reference",
         "default": "by-reference",
         "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"
      },
      "reference": {
         "title": "Docker reference of lab image to spawn",
         "type": "string"
      }
   },
   "$defs": {
      "NubladoImageSize": {
         "description": "Acceptable sizes of images to spawn.",
         "enum": [
            "Fine",
            "Diminutive",
            "Tiny",
            "Small",
            "Medium",
            "Large",
            "Huge",
            "Gargantuan",
            "Colossal"
         ],
         "title": "NubladoImageSize",
         "type": "string"
      }
   },
   "required": [
      "reference"
   ]
}

Fields:

• debug ()

• description ()

• image_class (Literal[NubladoImageClass.BY_REFERENCE])

• reference (str)

• size ()

field debug: bool = False

field description: str = ''

field image_class: Literal[NubladoImageClass.BY_REFERENCE] = NubladoImageClass.BY_REFERENCE

field reference: str [Required]

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