Class RuntimeSoftwareConfig.Builder (1.0.6)

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

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public RuntimeSoftwareConfig.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
RuntimeSoftwareConfig.Builder
Overrides

build()

public RuntimeSoftwareConfig build()
Returns
TypeDescription
RuntimeSoftwareConfig

buildPartial()

public RuntimeSoftwareConfig buildPartial()
Returns
TypeDescription
RuntimeSoftwareConfig

clear()

public RuntimeSoftwareConfig.Builder clear()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
RuntimeSoftwareConfig.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public RuntimeSoftwareConfig.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
RuntimeSoftwareConfig.Builder
Overrides

clearIdleShutdown()

public RuntimeSoftwareConfig.Builder clearIdleShutdown()

Runtime will automatically shutdown after idle_shutdown_time. Default: True

optional bool idle_shutdown = 3;

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

This builder for chaining.

clearInstallGpuDriver()

public RuntimeSoftwareConfig.Builder clearInstallGpuDriver()

Install Nvidia Driver automatically.

bool install_gpu_driver = 5;

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

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public RuntimeSoftwareConfig.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
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
TypeDescription
RuntimeSoftwareConfig.Builder

This builder for chaining.

clone()

public RuntimeSoftwareConfig.Builder clone()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for customGpuDriverPath.

getDefaultInstanceForType()

public RuntimeSoftwareConfig getDefaultInstanceForType()
Returns
TypeDescription
RuntimeSoftwareConfig

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getEnableHealthMonitoring()

public boolean getEnableHealthMonitoring()

Verifies core internal services are running. Default: True

optional bool enable_health_monitoring = 2;

Returns
TypeDescription
boolean

The enableHealthMonitoring.

getIdleShutdown()

public boolean getIdleShutdown()

Runtime will automatically shutdown after idle_shutdown_time. Default: True

optional bool idle_shutdown = 3;

Returns
TypeDescription
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
TypeDescription
int

The idleShutdownTimeout.

getInstallGpuDriver()

public boolean getInstallGpuDriver()

Install Nvidia Driver automatically.

bool install_gpu_driver = 5;

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for postStartupScript.

hasEnableHealthMonitoring()

public boolean hasEnableHealthMonitoring()

Verifies core internal services are running. Default: True

optional bool enable_health_monitoring = 2;

Returns
TypeDescription
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
TypeDescription
boolean

Whether the idleShutdown field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(RuntimeSoftwareConfig other)

public RuntimeSoftwareConfig.Builder mergeFrom(RuntimeSoftwareConfig other)
Parameter
NameDescription
otherRuntimeSoftwareConfig
Returns
TypeDescription
RuntimeSoftwareConfig.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public RuntimeSoftwareConfig.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
RuntimeSoftwareConfig.Builder
Overrides Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public RuntimeSoftwareConfig.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
RuntimeSoftwareConfig.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final RuntimeSoftwareConfig.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
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
NameDescription
valueString

The customGpuDriverPath to set.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes for customGpuDriverPath to set.

Returns
TypeDescription
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
NameDescription
valueboolean

The enableHealthMonitoring to set.

Returns
TypeDescription
RuntimeSoftwareConfig.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public RuntimeSoftwareConfig.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
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
NameDescription
valueboolean

The idleShutdown to set.

Returns
TypeDescription
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
NameDescription
valueint

The idleShutdownTimeout to set.

Returns
TypeDescription
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
NameDescription
valueboolean

The installGpuDriver to set.

Returns
TypeDescription
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
NameDescription
valueString

The notebookUpgradeSchedule to set.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes for notebookUpgradeSchedule to set.

Returns
TypeDescription
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
NameDescription
valueString

The postStartupScript to set.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes for postStartupScript to set.

Returns
TypeDescription
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
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
RuntimeSoftwareConfig.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final RuntimeSoftwareConfig.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
RuntimeSoftwareConfig.Builder
Overrides