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: trueidle_shutdown_timeout: 180enable_health_monitoring: true
Generated from protobuf message google.cloud.notebooks.v1.RuntimeSoftwareConfig
Namespace
Google \ Cloud \ Notebooks \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
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 ( |
↳ kernels |
array<Google\Cloud\Notebooks\V1\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.
| Returns | |
|---|---|
| Type | Description |
string |
|
setNotebookUpgradeSchedule
Cron expression in UTC timezone, used to schedule instance auto upgrade.
Please follow the cron format.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getEnableHealthMonitoring
Verifies core internal services are running.
Default: True
| Returns | |
|---|---|
| Type | Description |
bool |
|
hasEnableHealthMonitoring
clearEnableHealthMonitoring
setEnableHealthMonitoring
Verifies core internal services are running.
Default: True
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getIdleShutdown
Runtime will automatically shutdown after idle_shutdown_time.
Default: True
| Returns | |
|---|---|
| Type | Description |
bool |
|
hasIdleShutdown
clearIdleShutdown
setIdleShutdown
Runtime will automatically shutdown after idle_shutdown_time.
Default: True
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getIdleShutdownTimeout
Time in minutes to wait before shutting down runtime. Default: 180 minutes
| Returns | |
|---|---|
| Type | Description |
int |
|
setIdleShutdownTimeout
Time in minutes to wait before shutting down runtime. Default: 180 minutes
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getInstallGpuDriver
Install Nvidia Driver automatically.
Default: True
| Returns | |
|---|---|
| Type | Description |
bool |
|
setInstallGpuDriver
Install Nvidia Driver automatically.
Default: True
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$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.
| Returns | |
|---|---|
| Type | Description |
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.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$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).
| Returns | |
|---|---|
| Type | Description |
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).
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getKernels
Optional. Use a list of container images to use as Kernels in the notebook instance.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setKernels
Optional. Use a list of container images to use as Kernels in the notebook instance.
| Parameter | |
|---|---|
| Name | Description |
var |
array<Google\Cloud\Notebooks\V1\ContainerImage>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getUpgradeable
Output only. Bool indicating whether an newer image is available in an image family.
| Returns | |
|---|---|
| Type | Description |
bool |
|
hasUpgradeable
clearUpgradeable
setUpgradeable
Output only. Bool indicating whether an newer image is available in an image family.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPostStartupScriptBehavior
Behavior for the post startup script.
| Returns | |
|---|---|
| Type | Description |
int |
|
setPostStartupScriptBehavior
Behavior for the post startup script.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDisableTerminal
Bool indicating whether JupyterLab terminal will be available or not.
Default: False
| Returns | |
|---|---|
| Type | Description |
bool |
|
hasDisableTerminal
clearDisableTerminal
setDisableTerminal
Bool indicating whether JupyterLab terminal will be available or not.
Default: False
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getVersion
Output only. version of boot image such as M100, from release label of the image.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasVersion
clearVersion
setVersion
Output only. version of boot image such as M100, from release label of the image.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|