Interface RuntimeSoftwareConfigOrBuilder (0.16.0) 

public interface RuntimeSoftwareConfigOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

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.events.cloud.notebooks.v1.ContainerImage kernels = 8;

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.events.cloud.notebooks.v1.ContainerImage kernels = 8;

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.events.cloud.notebooks.v1.ContainerImage kernels = 8;

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.events.cloud.notebooks.v1.ContainerImage kernels = 8;

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.events.cloud.notebooks.v1.ContainerImage kernels = 8;

Returns
Type Description
List<? extends com.google.events.cloud.notebooks.v1.ContainerImageOrBuilder>

getMixerDisabled()

public abstract boolean getMixerDisabled()

Bool indicating whether mixer client should be disabled. Default: False

optional bool mixer_disabled = 13;

Returns
Type Description
boolean

The mixerDisabled.

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.events.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.events.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;

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;

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;

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.

hasMixerDisabled()

public abstract boolean hasMixerDisabled()

Bool indicating whether mixer client should be disabled. Default: False

optional bool mixer_disabled = 13;

Returns
Type Description
boolean

Whether the mixerDisabled 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;

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;

Returns
Type Description
boolean

Whether the version field is set.