NotebookSoftwareConfig

Notebook Software Config. This is passed to the backend when user makes software configurations in UI.

Fields
env[]object (EnvVar)

Optional. Environment variables to be passed to the container. Maximum limit is 100.

postStartupScriptConfigobject (PostStartupScriptConfig)

Optional. Post startup script config.

runtime_imageUnion type
The image to be used by the notebook runtime. Can be one of release name, or custom container image.runtime_image can be only one of the following:
colabImageobject (ColabImage)

Optional. Google-managed NotebookRuntime colab image.

JSON representation
{"env":[{object (EnvVar)}],"postStartupScriptConfig":{object (PostStartupScriptConfig)},// runtime_image"colabImage":{object (ColabImage)}// Union type}

ColabImage

Colab image of the runtime.

Fields
releaseNamestring

Optional. The release name of the NotebookRuntime Colab image, e.g. "py310". If not specified, detault to the latest release.

descriptionstring

Output only. A human-readable description of the specified colab image release, populated by the system. Example: "Python 3.10", "Latest - current Python 3.11"

JSON representation
{"releaseName":string,"description":string}

PostStartupScriptConfig

Post startup script config.

Fields
postStartupScriptstring

Optional. Post startup script to run after runtime is started.

postStartupScriptUrlstring

Optional. Post startup script url to download. Example:gs://bucket/script.sh

postStartupScriptBehaviorenum (PostStartupScriptBehavior)

Optional. Post startup script behavior that defines download and execution behavior.

JSON representation
{"postStartupScript":string,"postStartupScriptUrl":string,"postStartupScriptBehavior":enum (PostStartupScriptBehavior)}

PostStartupScriptBehavior

Represents a notebook runtime post startup script behavior.

Enums
POST_STARTUP_SCRIPT_BEHAVIOR_UNSPECIFIEDUnspecified post startup script behavior.
RUN_ONCERun post startup script after runtime is started.
RUN_EVERY_STARTRun post startup script after runtime is stopped.
DOWNLOAD_AND_RUN_EVERY_STARTDownload and run post startup script every time runtime is started.

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2026-02-11 UTC.