Reference documentation and code samples for the Google Cloud Notebooks V1 Client class RuntimeSoftwareConfig.
Specifies the selection and configuration of software inside the runtime.
The properties to set on runtime.
Properties keys are specified in key:value
format, for example:
-
idle_shutdown: true -
idle_shutdown_timeout: 180 -
enable_health_monitoring: true
Generated from protobuf message google.cloud.notebooks.v1.RuntimeSoftwareConfig
Namespace
Google \ Cloud \ Notebooks \ V1Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ notebook_upgrade_schedule
string
Cron expression in UTC timezone, used to schedule instance auto upgrade. Please follow the cron format .
↳ enable_health_monitoring
bool
Verifies core internal services are running. Default: True
↳ idle_shutdown
bool
Runtime will automatically shutdown after idle_shutdown_time. Default: True
↳ idle_shutdown_timeout
int
Time in minutes to wait before shutting down runtime. Default: 180 minutes
↳ install_gpu_driver
bool
Install Nvidia Driver automatically. Default: True
↳ custom_gpu_driver_path
string
Specify a custom Cloud Storage path where the GPU driver is stored. If not specified, we'll automatically choose from official GPU drivers.
↳ post_startup_script
string
Path to a Bash script that automatically runs after a notebook instance fully boots up. The path must be a URL or Cloud Storage path ( gs://path-to-file/file-name
).
↳ kernels
array< ContainerImage
>
Optional. Use a list of container images to use as Kernels in the notebook instance.
↳ upgradeable
bool
Output only. Bool indicating whether an newer image is available in an image family.
↳ post_startup_script_behavior
int
Behavior for the post startup script.
↳ disable_terminal
bool
Bool indicating whether JupyterLab terminal will be available or not. Default: False
↳ version
string
Output only. version of boot image such as M100, from release label of the image.
getNotebookUpgradeSchedule
Cron expression in UTC timezone, used to schedule instance auto upgrade.
Please follow the cron format .
string
setNotebookUpgradeSchedule
Cron expression in UTC timezone, used to schedule instance auto upgrade.
Please follow the cron format .
var
string
$this
getEnableHealthMonitoring
Verifies core internal services are running.
Default: True
bool
hasEnableHealthMonitoring
clearEnableHealthMonitoring
setEnableHealthMonitoring
Verifies core internal services are running.
Default: True
var
bool
$this
getIdleShutdown
Runtime will automatically shutdown after idle_shutdown_time.
Default: True
bool
hasIdleShutdown
clearIdleShutdown
setIdleShutdown
Runtime will automatically shutdown after idle_shutdown_time.
Default: True
var
bool
$this
getIdleShutdownTimeout
Time in minutes to wait before shutting down runtime. Default: 180 minutes
int
setIdleShutdownTimeout
Time in minutes to wait before shutting down runtime. Default: 180 minutes
var
int
$this
getInstallGpuDriver
Install Nvidia Driver automatically.
Default: True
bool
setInstallGpuDriver
Install Nvidia Driver automatically.
Default: True
var
bool
$this
getCustomGpuDriverPath
Specify a custom Cloud Storage path where the GPU driver is stored.
If not specified, we'll automatically choose from official GPU drivers.
string
setCustomGpuDriverPath
Specify a custom Cloud Storage path where the GPU driver is stored.
If not specified, we'll automatically choose from official GPU drivers.
var
string
$this
getPostStartupScript
Path to a Bash script that automatically runs after a notebook instance
fully boots up. The path must be a URL or
Cloud Storage path ( gs://path-to-file/file-name
).
string
setPostStartupScript
Path to a Bash script that automatically runs after a notebook instance
fully boots up. The path must be a URL or
Cloud Storage path ( gs://path-to-file/file-name
).
var
string
$this
getKernels
Optional. Use a list of container images to use as Kernels in the notebook instance.
setKernels
Optional. Use a list of container images to use as Kernels in the notebook instance.
$this
getUpgradeable
Output only. Bool indicating whether an newer image is available in an image family.
bool
hasUpgradeable
clearUpgradeable
setUpgradeable
Output only. Bool indicating whether an newer image is available in an image family.
var
bool
$this
getPostStartupScriptBehavior
Behavior for the post startup script.
int
setPostStartupScriptBehavior
Behavior for the post startup script.
var
int
$this
getDisableTerminal
Bool indicating whether JupyterLab terminal will be available or not.
Default: False
bool
hasDisableTerminal
clearDisableTerminal
setDisableTerminal
Bool indicating whether JupyterLab terminal will be available or not.
Default: False
var
bool
$this
getVersion
Output only. version of boot image such as M100, from release label of the image.
string
hasVersion
clearVersion
setVersion
Output only. version of boot image such as M100, from release label of the image.
var
string
$this
