AI Platform Notebooks v1 API - Class RuntimeSoftwareConfig (2.3.0)

public sealed class RuntimeSoftwareConfig : IMessage<RuntimeSoftwareConfig>, IEquatable<RuntimeSoftwareConfig>, IDeepCloneable<RuntimeSoftwareConfig>, IBufferMessage, IMessage

Reference documentation and code samples for the AI Platform Notebooks v1 API 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

Inheritance

object > RuntimeSoftwareConfig

Namespace

Google.Cloud.Notebooks.V1

Assembly

Google.Cloud.Notebooks.V1.dll

Constructors

RuntimeSoftwareConfig()

public RuntimeSoftwareConfig()

RuntimeSoftwareConfig(RuntimeSoftwareConfig)

public RuntimeSoftwareConfig(RuntimeSoftwareConfig other)
Parameter
NameDescription
otherRuntimeSoftwareConfig

Properties

CustomGpuDriverPath

public string CustomGpuDriverPath { get; set; }

Specify a custom Cloud Storage path where the GPU driver is stored. If not specified, we'll automatically choose from official GPU drivers.

Property Value
TypeDescription
string

DisableTerminal

public bool DisableTerminal { get; set; }

Bool indicating whether JupyterLab terminal will be available or not. Default: False

Property Value
TypeDescription
bool

EnableHealthMonitoring

public bool EnableHealthMonitoring { get; set; }

Verifies core internal services are running. Default: True

Property Value
TypeDescription
bool

HasDisableTerminal

public bool HasDisableTerminal { get; }

Gets whether the "disable_terminal" field is set

Property Value
TypeDescription
bool

HasEnableHealthMonitoring

public bool HasEnableHealthMonitoring { get; }

Gets whether the "enable_health_monitoring" field is set

Property Value
TypeDescription
bool

HasIdleShutdown

public bool HasIdleShutdown { get; }

Gets whether the "idle_shutdown" field is set

Property Value
TypeDescription
bool

HasUpgradeable

public bool HasUpgradeable { get; }

Gets whether the "upgradeable" field is set

Property Value
TypeDescription
bool

HasVersion

public bool HasVersion { get; }

Gets whether the "version" field is set

Property Value
TypeDescription
bool

IdleShutdown

public bool IdleShutdown { get; set; }

Runtime will automatically shutdown after idle_shutdown_time. Default: True

Property Value
TypeDescription
bool

IdleShutdownTimeout

public int IdleShutdownTimeout { get; set; }

Time in minutes to wait before shutting down runtime. Default: 180 minutes

Property Value
TypeDescription
int

InstallGpuDriver

public bool InstallGpuDriver { get; set; }

Install Nvidia Driver automatically. Default: True

Property Value
TypeDescription
bool

Kernels

public RepeatedField<ContainerImage> Kernels { get; }

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

Property Value
TypeDescription
RepeatedFieldContainerImage

NotebookUpgradeSchedule

public string NotebookUpgradeSchedule { get; set; }

Cron expression in UTC timezone, used to schedule instance auto upgrade. Please follow the cron format.

Property Value
TypeDescription
string

PostStartupScript

public string PostStartupScript { get; set; }

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

Property Value
TypeDescription
string

PostStartupScriptBehavior

public RuntimeSoftwareConfig.Types.PostStartupScriptBehavior PostStartupScriptBehavior { get; set; }

Behavior for the post startup script.

Property Value
TypeDescription
RuntimeSoftwareConfigTypesPostStartupScriptBehavior

Upgradeable

public bool Upgradeable { get; set; }

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

Property Value
TypeDescription
bool

Version

public string Version { get; set; }

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

Property Value
TypeDescription
string