Class: Google::Cloud::Notebooks::V1::RuntimeSoftwareConfig

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/notebooks/v1/runtime.rb

Overview

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

Defined Under Namespace

Modules: PostStartupScriptBehavior

Instance Attribute Summary collapse

Instance Attribute Details

#custom_gpu_driver_path ⇒ ::String

Returns 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.



436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
 
# File 'proto_docs/google/cloud/notebooks/v1/runtime.rb', line 436

class RuntimeSoftwareConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Behavior for the post startup script.
  module PostStartupScriptBehavior
    # Unspecified post startup script behavior. Will run only once at creation.
    POST_STARTUP_SCRIPT_BEHAVIOR_UNSPECIFIED = 0

    # Runs the post startup script provided during creation at every start.
    RUN_EVERY_START = 1

    # Downloads and runs the provided post startup script at every start.
    DOWNLOAD_AND_RUN_EVERY_START = 2
  end
end

#disable_terminal ⇒ ::Boolean

Returns 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



436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
 
# File 'proto_docs/google/cloud/notebooks/v1/runtime.rb', line 436

class RuntimeSoftwareConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Behavior for the post startup script.
  module PostStartupScriptBehavior
    # Unspecified post startup script behavior. Will run only once at creation.
    POST_STARTUP_SCRIPT_BEHAVIOR_UNSPECIFIED = 0

    # Runs the post startup script provided during creation at every start.
    RUN_EVERY_START = 1

    # Downloads and runs the provided post startup script at every start.
    DOWNLOAD_AND_RUN_EVERY_START = 2
  end
end

#enable_health_monitoring ⇒ ::Boolean

Returns Verifies core internal services are running. Default: True.

Returns:

  • (::Boolean) —

    Verifies core internal services are running. Default: True



436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
 
# File 'proto_docs/google/cloud/notebooks/v1/runtime.rb', line 436

class RuntimeSoftwareConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Behavior for the post startup script.
  module PostStartupScriptBehavior
    # Unspecified post startup script behavior. Will run only once at creation.
    POST_STARTUP_SCRIPT_BEHAVIOR_UNSPECIFIED = 0

    # Runs the post startup script provided during creation at every start.
    RUN_EVERY_START = 1

    # Downloads and runs the provided post startup script at every start.
    DOWNLOAD_AND_RUN_EVERY_START = 2
  end
end

#idle_shutdown ⇒ ::Boolean

Returns Runtime will automatically shutdown after idle_shutdown_time. Default: True.

Returns:

  • (::Boolean) —

    Runtime will automatically shutdown after idle_shutdown_time. Default: True



436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
 
# File 'proto_docs/google/cloud/notebooks/v1/runtime.rb', line 436

class RuntimeSoftwareConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Behavior for the post startup script.
  module PostStartupScriptBehavior
    # Unspecified post startup script behavior. Will run only once at creation.
    POST_STARTUP_SCRIPT_BEHAVIOR_UNSPECIFIED = 0

    # Runs the post startup script provided during creation at every start.
    RUN_EVERY_START = 1

    # Downloads and runs the provided post startup script at every start.
    DOWNLOAD_AND_RUN_EVERY_START = 2
  end
end

#idle_shutdown_timeout ⇒ ::Integer

Returns 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



436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
 
# File 'proto_docs/google/cloud/notebooks/v1/runtime.rb', line 436

class RuntimeSoftwareConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Behavior for the post startup script.
  module PostStartupScriptBehavior
    # Unspecified post startup script behavior. Will run only once at creation.
    POST_STARTUP_SCRIPT_BEHAVIOR_UNSPECIFIED = 0

    # Runs the post startup script provided during creation at every start.
    RUN_EVERY_START = 1

    # Downloads and runs the provided post startup script at every start.
    DOWNLOAD_AND_RUN_EVERY_START = 2
  end
end

#install_gpu_driver ⇒ ::Boolean

Returns Install Nvidia Driver automatically. Default: True.

Returns:

  • (::Boolean) —

    Install Nvidia Driver automatically. Default: True



436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
 
# File 'proto_docs/google/cloud/notebooks/v1/runtime.rb', line 436

class RuntimeSoftwareConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Behavior for the post startup script.
  module PostStartupScriptBehavior
    # Unspecified post startup script behavior. Will run only once at creation.
    POST_STARTUP_SCRIPT_BEHAVIOR_UNSPECIFIED = 0

    # Runs the post startup script provided during creation at every start.
    RUN_EVERY_START = 1

    # Downloads and runs the provided post startup script at every start.
    DOWNLOAD_AND_RUN_EVERY_START = 2
  end
end

#kernels ⇒ ::Array<::Google::Cloud::Notebooks::V1::ContainerImage>

Returns Optional. Use a list of container images to use as Kernels in the notebook instance.

Returns:



436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
 
# File 'proto_docs/google/cloud/notebooks/v1/runtime.rb', line 436

class RuntimeSoftwareConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Behavior for the post startup script.
  module PostStartupScriptBehavior
    # Unspecified post startup script behavior. Will run only once at creation.
    POST_STARTUP_SCRIPT_BEHAVIOR_UNSPECIFIED = 0

    # Runs the post startup script provided during creation at every start.
    RUN_EVERY_START = 1

    # Downloads and runs the provided post startup script at every start.
    DOWNLOAD_AND_RUN_EVERY_START = 2
  end
end

#notebook_upgrade_schedule ⇒ ::String

Returns 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.



436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
 
# File 'proto_docs/google/cloud/notebooks/v1/runtime.rb', line 436

class RuntimeSoftwareConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Behavior for the post startup script.
  module PostStartupScriptBehavior
    # Unspecified post startup script behavior. Will run only once at creation.
    POST_STARTUP_SCRIPT_BEHAVIOR_UNSPECIFIED = 0

    # Runs the post startup script provided during creation at every start.
    RUN_EVERY_START = 1

    # Downloads and runs the provided post startup script at every start.
    DOWNLOAD_AND_RUN_EVERY_START = 2
  end
end

#post_startup_script ⇒ ::String

Returns 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).



436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
 
# File 'proto_docs/google/cloud/notebooks/v1/runtime.rb', line 436

class RuntimeSoftwareConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Behavior for the post startup script.
  module PostStartupScriptBehavior
    # Unspecified post startup script behavior. Will run only once at creation.
    POST_STARTUP_SCRIPT_BEHAVIOR_UNSPECIFIED = 0

    # Runs the post startup script provided during creation at every start.
    RUN_EVERY_START = 1

    # Downloads and runs the provided post startup script at every start.
    DOWNLOAD_AND_RUN_EVERY_START = 2
  end
end

#post_startup_script_behavior ⇒ ::Google::Cloud::Notebooks::V1::RuntimeSoftwareConfig::PostStartupScriptBehavior

Returns Behavior for the post startup script.

Returns:



436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
 
# File 'proto_docs/google/cloud/notebooks/v1/runtime.rb', line 436

class RuntimeSoftwareConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Behavior for the post startup script.
  module PostStartupScriptBehavior
    # Unspecified post startup script behavior. Will run only once at creation.
    POST_STARTUP_SCRIPT_BEHAVIOR_UNSPECIFIED = 0

    # Runs the post startup script provided during creation at every start.
    RUN_EVERY_START = 1

    # Downloads and runs the provided post startup script at every start.
    DOWNLOAD_AND_RUN_EVERY_START = 2
  end
end

#upgradeable ⇒ ::Boolean (readonly)

Returns Output only. Bool indicating whether an newer image is available in an image family.

Returns:

  • (::Boolean) —

    Output only. Bool indicating whether an newer image is available in an image family.



436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
 
# File 'proto_docs/google/cloud/notebooks/v1/runtime.rb', line 436

class RuntimeSoftwareConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Behavior for the post startup script.
  module PostStartupScriptBehavior
    # Unspecified post startup script behavior. Will run only once at creation.
    POST_STARTUP_SCRIPT_BEHAVIOR_UNSPECIFIED = 0

    # Runs the post startup script provided during creation at every start.
    RUN_EVERY_START = 1

    # Downloads and runs the provided post startup script at every start.
    DOWNLOAD_AND_RUN_EVERY_START = 2
  end
end

#version ⇒ ::String (readonly)

Returns Output only. version of boot image such as M100, from release label of the image.

Returns:

  • (::String) —

    Output only. version of boot image such as M100, from release label of the image.



436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
 
# File 'proto_docs/google/cloud/notebooks/v1/runtime.rb', line 436

class RuntimeSoftwareConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Behavior for the post startup script.
  module PostStartupScriptBehavior
    # Unspecified post startup script behavior. Will run only once at creation.
    POST_STARTUP_SCRIPT_BEHAVIOR_UNSPECIFIED = 0

    # Runs the post startup script provided during creation at every start.
    RUN_EVERY_START = 1

    # Downloads and runs the provided post startup script at every start.
    DOWNLOAD_AND_RUN_EVERY_START = 2
  end
end