AI Platform Notebooks V1 API - Class Google::Cloud::Notebooks::V1::RuntimeSoftwareConfig (v0.8.2)

Reference documentation and code samples for the AI Platform Notebooks V1 API class Google::Cloud::Notebooks::V1::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

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#custom_gpu_driver_path

def custom_gpu_driver_path() -> ::String
Returns
  • (::String) — Specify a custom Cloud Storage path where the GPU driver is stored. If not specified, we'll automatically choose from official GPU drivers.

#custom_gpu_driver_path=

def custom_gpu_driver_path=(value) -> ::String
Parameter
  • value (::String) — Specify a custom Cloud Storage path where the GPU driver is stored. If not specified, we'll automatically choose from official GPU drivers.
Returns
  • (::String) — Specify a custom Cloud Storage path where the GPU driver is stored. If not specified, we'll automatically choose from official GPU drivers.

#disable_terminal

def disable_terminal() -> ::Boolean
Returns
  • (::Boolean) — Bool indicating whether JupyterLab terminal will be available or not. Default: False

#disable_terminal=

def disable_terminal=(value) -> ::Boolean
Parameter
  • value (::Boolean) — Bool indicating whether JupyterLab terminal will be available or not. Default: False
Returns
  • (::Boolean) — Bool indicating whether JupyterLab terminal will be available or not. Default: False

#enable_health_monitoring

def enable_health_monitoring() -> ::Boolean
Returns
  • (::Boolean) — Verifies core internal services are running. Default: True

#enable_health_monitoring=

def enable_health_monitoring=(value) -> ::Boolean
Parameter
  • value (::Boolean) — Verifies core internal services are running. Default: True
Returns
  • (::Boolean) — Verifies core internal services are running. Default: True

#idle_shutdown

def idle_shutdown() -> ::Boolean
Returns
  • (::Boolean) — Runtime will automatically shutdown after idle_shutdown_time. Default: True

#idle_shutdown=

def idle_shutdown=(value) -> ::Boolean
Parameter
  • value (::Boolean) — Runtime will automatically shutdown after idle_shutdown_time. Default: True
Returns
  • (::Boolean) — Runtime will automatically shutdown after idle_shutdown_time. Default: True

#idle_shutdown_timeout

def idle_shutdown_timeout() -> ::Integer
Returns
  • (::Integer) — Time in minutes to wait before shutting down runtime. Default: 180 minutes

#idle_shutdown_timeout=

def idle_shutdown_timeout=(value) -> ::Integer
Parameter
  • value (::Integer) — Time in minutes to wait before shutting down runtime. Default: 180 minutes
Returns
  • (::Integer) — Time in minutes to wait before shutting down runtime. Default: 180 minutes

#install_gpu_driver

def install_gpu_driver() -> ::Boolean
Returns
  • (::Boolean) — Install Nvidia Driver automatically. Default: True

#install_gpu_driver=

def install_gpu_driver=(value) -> ::Boolean
Parameter
  • value (::Boolean) — Install Nvidia Driver automatically. Default: True
Returns
  • (::Boolean) — Install Nvidia Driver automatically. Default: True

#kernels

def kernels() -> ::Array<::Google::Cloud::Notebooks::V1::ContainerImage>
Returns

#kernels=

def kernels=(value) -> ::Array<::Google::Cloud::Notebooks::V1::ContainerImage>
Parameter
Returns

#notebook_upgrade_schedule

def notebook_upgrade_schedule() -> ::String
Returns
  • (::String) — Cron expression in UTC timezone, used to schedule instance auto upgrade. Please follow the cron format.

#notebook_upgrade_schedule=

def notebook_upgrade_schedule=(value) -> ::String
Parameter
  • value (::String) — Cron expression in UTC timezone, used to schedule instance auto upgrade. Please follow the cron format.
Returns
  • (::String) — Cron expression in UTC timezone, used to schedule instance auto upgrade. Please follow the cron format.

#post_startup_script

def post_startup_script() -> ::String
Returns
  • (::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).

#post_startup_script=

def post_startup_script=(value) -> ::String
Parameter
  • value (::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).
Returns
  • (::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).

#post_startup_script_behavior

def post_startup_script_behavior() -> ::Google::Cloud::Notebooks::V1::RuntimeSoftwareConfig::PostStartupScriptBehavior
Returns

#post_startup_script_behavior=

def post_startup_script_behavior=(value) -> ::Google::Cloud::Notebooks::V1::RuntimeSoftwareConfig::PostStartupScriptBehavior
Parameter
Returns

#upgradeable

def upgradeable() -> ::Boolean
Returns
  • (::Boolean) — Output only. Bool indicating whether an newer image is available in an image family.

#version

def version() -> ::String
Returns
  • (::String) — Output only. version of boot image such as M100, from release label of the image.