Class RuntimeSoftwareConfig.Builder (0.6.2)

public static final class RuntimeSoftwareConfig.Builder extends GeneratedMessageV3.Builder<RuntimeSoftwareConfig.Builder> implements RuntimeSoftwareConfigOrBuilder

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
  • report-system-health: true

Protobuf type google.cloud.notebooks.v1.RuntimeSoftwareConfig

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public RuntimeSoftwareConfig.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
RuntimeSoftwareConfig.Builder
Overrides

build()

public RuntimeSoftwareConfig build()
Returns
Type Description
RuntimeSoftwareConfig

buildPartial()

public RuntimeSoftwareConfig buildPartial()
Returns
Type Description
RuntimeSoftwareConfig

clear()

public RuntimeSoftwareConfig.Builder clear()
Returns
Type Description
RuntimeSoftwareConfig.Builder
Overrides

clearCustomGpuDriverPath()

public RuntimeSoftwareConfig.Builder clearCustomGpuDriverPath()

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
RuntimeSoftwareConfig.Builder

This builder for chaining.

clearEnableHealthMonitoring()

public RuntimeSoftwareConfig.Builder clearEnableHealthMonitoring()

Verifies core internal services are running. Default: True

optional bool enable_health_monitoring = 2;

Returns
Type Description
RuntimeSoftwareConfig.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public RuntimeSoftwareConfig.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
RuntimeSoftwareConfig.Builder
Overrides

clearIdleShutdown()

public RuntimeSoftwareConfig.Builder clearIdleShutdown()

Runtime will automatically shutdown after idle_shutdown_time. Default: True

optional bool idle_shutdown = 3;

Returns
Type Description
RuntimeSoftwareConfig.Builder

This builder for chaining.

clearIdleShutdownTimeout()

public RuntimeSoftwareConfig.Builder clearIdleShutdownTimeout()

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

int32 idle_shutdown_timeout = 4;

Returns
Type Description
RuntimeSoftwareConfig.Builder

This builder for chaining.

clearInstallGpuDriver()

public RuntimeSoftwareConfig.Builder clearInstallGpuDriver()

Install Nvidia Driver automatically.

bool install_gpu_driver = 5;

Returns
Type Description
RuntimeSoftwareConfig.Builder

This builder for chaining.

clearNotebookUpgradeSchedule()

public RuntimeSoftwareConfig.Builder clearNotebookUpgradeSchedule()

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

string notebook_upgrade_schedule = 1;

Returns
Type Description
RuntimeSoftwareConfig.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public RuntimeSoftwareConfig.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
RuntimeSoftwareConfig.Builder
Overrides

clearPostStartupScript()

public RuntimeSoftwareConfig.Builder clearPostStartupScript()

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
RuntimeSoftwareConfig.Builder

This builder for chaining.

clone()

public RuntimeSoftwareConfig.Builder clone()
Returns
Type Description
RuntimeSoftwareConfig.Builder
Overrides

getCustomGpuDriverPath()

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

getDefaultInstanceForType()

public RuntimeSoftwareConfig getDefaultInstanceForType()
Returns
Type Description
RuntimeSoftwareConfig

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getEnableHealthMonitoring()

public boolean getEnableHealthMonitoring()

Verifies core internal services are running. Default: True

optional bool enable_health_monitoring = 2;

Returns
Type Description
boolean

The enableHealthMonitoring.

getIdleShutdown()

public 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 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 boolean getInstallGpuDriver()

Install Nvidia Driver automatically.

bool install_gpu_driver = 5;

Returns
Type Description
boolean

The installGpuDriver.

getNotebookUpgradeSchedule()

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

getPostStartupScriptBytes()

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

hasEnableHealthMonitoring()

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

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(RuntimeSoftwareConfig other)

public RuntimeSoftwareConfig.Builder mergeFrom(RuntimeSoftwareConfig other)
Parameter
Name Description
other RuntimeSoftwareConfig
Returns
Type Description
RuntimeSoftwareConfig.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public RuntimeSoftwareConfig.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RuntimeSoftwareConfig.Builder
Overrides Exceptions
Type Description
IOException

mergeFrom(Message other)

public RuntimeSoftwareConfig.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
RuntimeSoftwareConfig.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final RuntimeSoftwareConfig.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
RuntimeSoftwareConfig.Builder
Overrides

setCustomGpuDriverPath(String value)

public RuntimeSoftwareConfig.Builder setCustomGpuDriverPath(String value)

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;

Parameter
Name Description
value String

The customGpuDriverPath to set.

Returns
Type Description
RuntimeSoftwareConfig.Builder

This builder for chaining.

setCustomGpuDriverPathBytes(ByteString value)

public RuntimeSoftwareConfig.Builder setCustomGpuDriverPathBytes(ByteString value)

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;

Parameter
Name Description
value ByteString

The bytes for customGpuDriverPath to set.

Returns
Type Description
RuntimeSoftwareConfig.Builder

This builder for chaining.

setEnableHealthMonitoring(boolean value)

public RuntimeSoftwareConfig.Builder setEnableHealthMonitoring(boolean value)

Verifies core internal services are running. Default: True

optional bool enable_health_monitoring = 2;

Parameter
Name Description
value boolean

The enableHealthMonitoring to set.

Returns
Type Description
RuntimeSoftwareConfig.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public RuntimeSoftwareConfig.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
RuntimeSoftwareConfig.Builder
Overrides

setIdleShutdown(boolean value)

public RuntimeSoftwareConfig.Builder setIdleShutdown(boolean value)

Runtime will automatically shutdown after idle_shutdown_time. Default: True

optional bool idle_shutdown = 3;

Parameter
Name Description
value boolean

The idleShutdown to set.

Returns
Type Description
RuntimeSoftwareConfig.Builder

This builder for chaining.

setIdleShutdownTimeout(int value)

public RuntimeSoftwareConfig.Builder setIdleShutdownTimeout(int value)

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

int32 idle_shutdown_timeout = 4;

Parameter
Name Description
value int

The idleShutdownTimeout to set.

Returns
Type Description
RuntimeSoftwareConfig.Builder

This builder for chaining.

setInstallGpuDriver(boolean value)

public RuntimeSoftwareConfig.Builder setInstallGpuDriver(boolean value)

Install Nvidia Driver automatically.

bool install_gpu_driver = 5;

Parameter
Name Description
value boolean

The installGpuDriver to set.

Returns
Type Description
RuntimeSoftwareConfig.Builder

This builder for chaining.

setNotebookUpgradeSchedule(String value)

public RuntimeSoftwareConfig.Builder setNotebookUpgradeSchedule(String value)

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

string notebook_upgrade_schedule = 1;

Parameter
Name Description
value String

The notebookUpgradeSchedule to set.

Returns
Type Description
RuntimeSoftwareConfig.Builder

This builder for chaining.

setNotebookUpgradeScheduleBytes(ByteString value)

public RuntimeSoftwareConfig.Builder setNotebookUpgradeScheduleBytes(ByteString value)

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

string notebook_upgrade_schedule = 1;

Parameter
Name Description
value ByteString

The bytes for notebookUpgradeSchedule to set.

Returns
Type Description
RuntimeSoftwareConfig.Builder

This builder for chaining.

setPostStartupScript(String value)

public RuntimeSoftwareConfig.Builder setPostStartupScript(String value)

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;

Parameter
Name Description
value String

The postStartupScript to set.

Returns
Type Description
RuntimeSoftwareConfig.Builder

This builder for chaining.

setPostStartupScriptBytes(ByteString value)

public RuntimeSoftwareConfig.Builder setPostStartupScriptBytes(ByteString value)

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;

Parameter
Name Description
value ByteString

The bytes for postStartupScript to set.

Returns
Type Description
RuntimeSoftwareConfig.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public RuntimeSoftwareConfig.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
RuntimeSoftwareConfig.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final RuntimeSoftwareConfig.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
RuntimeSoftwareConfig.Builder
Overrides