- 1.76.0 (latest)
 - 1.74.0
 - 1.73.0
 - 1.72.0
 - 1.71.0
 - 1.70.0
 - 1.68.0
 - 1.66.0
 - 1.65.0
 - 1.62.0
 - 1.61.0
 - 1.60.0
 - 1.58.0
 - 1.57.0
 - 1.56.0
 - 1.55.0
 - 1.54.0
 - 1.53.0
 - 1.52.0
 - 1.51.0
 - 1.50.0
 - 1.49.0
 - 1.47.0
 - 1.46.0
 - 1.45.0
 - 1.44.0
 - 1.43.0
 - 1.42.0
 - 1.41.0
 - 1.40.0
 - 1.39.0
 - 1.38.0
 - 1.37.0
 - 1.35.0
 - 1.34.0
 - 1.33.0
 - 1.32.0
 - 1.31.0
 - 1.30.0
 - 1.29.0
 - 1.28.0
 - 1.27.0
 - 1.26.0
 - 1.25.0
 - 1.22.0
 - 1.21.0
 - 1.20.0
 - 1.19.0
 - 1.18.0
 - 1.17.0
 - 1.16.0
 - 1.15.0
 - 1.14.0
 - 1.13.0
 - 1.12.0
 - 1.11.0
 - 1.10.0
 - 1.9.0
 - 1.7.0
 - 1.6.0
 - 1.5.0
 - 1.4.0
 - 1.3.0
 - 1.2.0
 - 1.1.3
 - 1.0.6
 - 0.6.2
 
public interface RuntimeSoftwareConfigOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
getCustomGpuDriverPath()
public abstract String 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 custom_gpu_driver_path = 6;
| Returns | |
|---|---|
| Type | Description | 
String | 
        The customGpuDriverPath.  | 
      
getCustomGpuDriverPathBytes()
public abstract ByteString getCustomGpuDriverPathBytes()Specify a custom Cloud Storage path where the GPU driver is stored. If not specified, we'll automatically choose from official GPU drivers.
 string custom_gpu_driver_path = 6;
| Returns | |
|---|---|
| Type | Description | 
ByteString | 
        The bytes for customGpuDriverPath.  | 
      
getDisableTerminal()
public abstract boolean getDisableTerminal()Bool indicating whether JupyterLab terminal will be available or not. Default: False
 optional bool disable_terminal = 11;
| Returns | |
|---|---|
| Type | Description | 
boolean | 
        The disableTerminal.  | 
      
getEnableHealthMonitoring()
public abstract boolean getEnableHealthMonitoring()Verifies core internal services are running. Default: True
 optional bool enable_health_monitoring = 2;
| Returns | |
|---|---|
| Type | Description | 
boolean | 
        The enableHealthMonitoring.  | 
      
getIdleShutdown()
public abstract boolean getIdleShutdown()Runtime will automatically shutdown after idle_shutdown_time. Default: True
 optional bool idle_shutdown = 3;
| Returns | |
|---|---|
| Type | Description | 
boolean | 
        The idleShutdown.  | 
      
getIdleShutdownTimeout()
public abstract int getIdleShutdownTimeout()Time in minutes to wait before shutting down runtime. Default: 180 minutes
 int32 idle_shutdown_timeout = 4;
| Returns | |
|---|---|
| Type | Description | 
int | 
        The idleShutdownTimeout.  | 
      
getInstallGpuDriver()
public abstract boolean getInstallGpuDriver()Install Nvidia Driver automatically. Default: True
 bool install_gpu_driver = 5;
| Returns | |
|---|---|
| Type | Description | 
boolean | 
        The installGpuDriver.  | 
      
getKernels(int index)
public abstract ContainerImage getKernels(int index)Optional. Use a list of container images to use as Kernels in the notebook instance.
 
 repeated .google.cloud.notebooks.v1.ContainerImage kernels = 8 [(.google.api.field_behavior) = OPTIONAL];
 
| Parameter | |
|---|---|
| Name | Description | 
index | 
        int | 
      
| Returns | |
|---|---|
| Type | Description | 
ContainerImage | 
        |
getKernelsCount()
public abstract int getKernelsCount()Optional. Use a list of container images to use as Kernels in the notebook instance.
 
 repeated .google.cloud.notebooks.v1.ContainerImage kernels = 8 [(.google.api.field_behavior) = OPTIONAL];
 
| Returns | |
|---|---|
| Type | Description | 
int | 
        |
getKernelsList()
public abstract List<ContainerImage> getKernelsList()Optional. Use a list of container images to use as Kernels in the notebook instance.
 
 repeated .google.cloud.notebooks.v1.ContainerImage kernels = 8 [(.google.api.field_behavior) = OPTIONAL];
 
| Returns | |
|---|---|
| Type | Description | 
List<ContainerImage> | 
        |
getKernelsOrBuilder(int index)
public abstract ContainerImageOrBuilder getKernelsOrBuilder(int index)Optional. Use a list of container images to use as Kernels in the notebook instance.
 
 repeated .google.cloud.notebooks.v1.ContainerImage kernels = 8 [(.google.api.field_behavior) = OPTIONAL];
 
| Parameter | |
|---|---|
| Name | Description | 
index | 
        int | 
      
| Returns | |
|---|---|
| Type | Description | 
ContainerImageOrBuilder | 
        |
getKernelsOrBuilderList()
public abstract List<? extends ContainerImageOrBuilder> getKernelsOrBuilderList()Optional. Use a list of container images to use as Kernels in the notebook instance.
 
 repeated .google.cloud.notebooks.v1.ContainerImage kernels = 8 [(.google.api.field_behavior) = OPTIONAL];
 
| Returns | |
|---|---|
| Type | Description | 
List<? extends com.google.cloud.notebooks.v1.ContainerImageOrBuilder> | 
        |
getNotebookUpgradeSchedule()
public abstract String getNotebookUpgradeSchedule()Cron expression in UTC timezone, used to schedule instance auto upgrade. Please follow the cron format.
 string notebook_upgrade_schedule = 1;
| Returns | |
|---|---|
| Type | Description | 
String | 
        The notebookUpgradeSchedule.  | 
      
getNotebookUpgradeScheduleBytes()
public abstract ByteString getNotebookUpgradeScheduleBytes()Cron expression in UTC timezone, used to schedule instance auto upgrade. Please follow the cron format.
 string notebook_upgrade_schedule = 1;
| Returns | |
|---|---|
| Type | Description | 
ByteString | 
        The bytes for notebookUpgradeSchedule.  | 
      
getPostStartupScript()
public abstract String 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 post_startup_script = 7;
| Returns | |
|---|---|
| Type | Description | 
String | 
        The postStartupScript.  | 
      
getPostStartupScriptBehavior()
public abstract RuntimeSoftwareConfig.PostStartupScriptBehavior getPostStartupScriptBehavior()Behavior for the post startup script.
 
 .google.cloud.notebooks.v1.RuntimeSoftwareConfig.PostStartupScriptBehavior post_startup_script_behavior = 10;
 
| Returns | |
|---|---|
| Type | Description | 
RuntimeSoftwareConfig.PostStartupScriptBehavior | 
        The postStartupScriptBehavior.  | 
      
getPostStartupScriptBehaviorValue()
public abstract int getPostStartupScriptBehaviorValue()Behavior for the post startup script.
 
 .google.cloud.notebooks.v1.RuntimeSoftwareConfig.PostStartupScriptBehavior post_startup_script_behavior = 10;
 
| Returns | |
|---|---|
| Type | Description | 
int | 
        The enum numeric value on the wire for postStartupScriptBehavior.  | 
      
getPostStartupScriptBytes()
public abstract ByteString getPostStartupScriptBytes() 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 post_startup_script = 7;
| Returns | |
|---|---|
| Type | Description | 
ByteString | 
        The bytes for postStartupScript.  | 
      
getUpgradeable()
public abstract boolean getUpgradeable()Output only. Bool indicating whether an newer image is available in an image family.
 optional bool upgradeable = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description | 
boolean | 
        The upgradeable.  | 
      
getVersion()
public abstract String getVersion()Output only. version of boot image such as M100, from release label of the image.
 optional string version = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description | 
String | 
        The version.  | 
      
getVersionBytes()
public abstract ByteString getVersionBytes()Output only. version of boot image such as M100, from release label of the image.
 optional string version = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description | 
ByteString | 
        The bytes for version.  | 
      
hasDisableTerminal()
public abstract boolean hasDisableTerminal()Bool indicating whether JupyterLab terminal will be available or not. Default: False
 optional bool disable_terminal = 11;
| Returns | |
|---|---|
| Type | Description | 
boolean | 
        Whether the disableTerminal field is set.  | 
      
hasEnableHealthMonitoring()
public abstract boolean hasEnableHealthMonitoring()Verifies core internal services are running. Default: True
 optional bool enable_health_monitoring = 2;
| Returns | |
|---|---|
| Type | Description | 
boolean | 
        Whether the enableHealthMonitoring field is set.  | 
      
hasIdleShutdown()
public abstract boolean hasIdleShutdown()Runtime will automatically shutdown after idle_shutdown_time. Default: True
 optional bool idle_shutdown = 3;
| Returns | |
|---|---|
| Type | Description | 
boolean | 
        Whether the idleShutdown field is set.  | 
      
hasUpgradeable()
public abstract boolean hasUpgradeable()Output only. Bool indicating whether an newer image is available in an image family.
 optional bool upgradeable = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description | 
boolean | 
        Whether the upgradeable field is set.  | 
      
hasVersion()
public abstract boolean hasVersion()Output only. version of boot image such as M100, from release label of the image.
 optional string version = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description | 
boolean | 
        Whether the version field is set.  |