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

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > RuntimeSoftwareConfig.Builder

Implements

RuntimeSoftwareConfigOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeDelimitedFrom(InputStream)

AbstractMessage.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

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

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

GeneratedMessageV3.Builder<BuilderType>.clear()

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

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

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

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

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

GeneratedMessageV3.Builder<BuilderType>.clone()

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

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

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

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns

Type	Description
boolean

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

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

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions

Type	Description
IOException

mergeFrom(Message other)

public RuntimeSoftwareConfig.Builder mergeFrom(Message other)

Parameter

Name	Description
other	`Message`

Returns

Type	Description
RuntimeSoftwareConfig.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeUnknownFields(UnknownFieldSet unknownFields)

public final RuntimeSoftwareConfig.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter

Name	Description
unknownFields	`UnknownFieldSet`

Returns

Type	Description
RuntimeSoftwareConfig.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

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

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

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

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setUnknownFields(UnknownFieldSet unknownFields)

public final RuntimeSoftwareConfig.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter

Name	Description
unknownFields	`UnknownFieldSet`

Returns

Type	Description
RuntimeSoftwareConfig.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)