Class RuntimeSoftwareConfig.Builder (0.16.0)

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
enable_health_monitoring: true

Protobuf type google.events.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.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.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

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)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

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

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

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

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)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
`Descriptor`

Methods

addAllKernels(Iterable<? extends ContainerImage> values)

public RuntimeSoftwareConfig.Builder addAllKernels(Iterable<? extends ContainerImage> values)

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
`values`	`Iterable<? extends com.google.events.cloud.notebooks.v1.ContainerImage>`

Returns
Type	Description
`RuntimeSoftwareConfig.Builder`

addKernels(ContainerImage value)

public RuntimeSoftwareConfig.Builder addKernels(ContainerImage value)

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
`value`	`ContainerImage`

Returns
Type	Description
`RuntimeSoftwareConfig.Builder`

addKernels(ContainerImage.Builder builderForValue)

public RuntimeSoftwareConfig.Builder addKernels(ContainerImage.Builder builderForValue)

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
`builderForValue`	`ContainerImage.Builder`

Returns
Type	Description
`RuntimeSoftwareConfig.Builder`

addKernels(int index, ContainerImage value)

public RuntimeSoftwareConfig.Builder addKernels(int index, ContainerImage value)

Optional. Use a list of container images to use as Kernels in the notebook instance.

repeated .google.events.cloud.notebooks.v1.ContainerImage kernels = 8;

Parameters
Name	Description
`index`	`int`
`value`	`ContainerImage`

Returns
Type	Description
`RuntimeSoftwareConfig.Builder`

addKernels(int index, ContainerImage.Builder builderForValue)

public RuntimeSoftwareConfig.Builder addKernels(int index, ContainerImage.Builder builderForValue)

Optional. Use a list of container images to use as Kernels in the notebook instance.

repeated .google.events.cloud.notebooks.v1.ContainerImage kernels = 8;

Parameters
Name	Description
`index`	`int`
`builderForValue`	`ContainerImage.Builder`

Returns
Type	Description
`RuntimeSoftwareConfig.Builder`

addKernelsBuilder()

public ContainerImage.Builder addKernelsBuilder()

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
`ContainerImage.Builder`

addKernelsBuilder(int index)

public ContainerImage.Builder addKernelsBuilder(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.Builder`

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.

clearDisableTerminal()

public RuntimeSoftwareConfig.Builder clearDisableTerminal()

Bool indicating whether JupyterLab terminal will be available or not. Default: False

optional bool disable_terminal = 11;

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. Default: True

bool install_gpu_driver = 5;

Returns
Type	Description
`RuntimeSoftwareConfig.Builder`	This builder for chaining.

clearKernels()

public RuntimeSoftwareConfig.Builder clearKernels()

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

clearMixerDisabled()

public RuntimeSoftwareConfig.Builder clearMixerDisabled()

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

optional bool mixer_disabled = 13;

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.

clearPostStartupScriptBehavior()

public RuntimeSoftwareConfig.Builder clearPostStartupScriptBehavior()

Behavior for the post startup script.

.google.events.cloud.notebooks.v1.RuntimeSoftwareConfig.PostStartupScriptBehavior post_startup_script_behavior = 10;

Returns
Type	Description
`RuntimeSoftwareConfig.Builder`	This builder for chaining.

clearUpgradeable()

public RuntimeSoftwareConfig.Builder clearUpgradeable()

Output only. Bool indicating whether an newer image is available in an image family.

optional bool upgradeable = 9;

Returns
Type	Description
`RuntimeSoftwareConfig.Builder`	This builder for chaining.

clearVersion()

public RuntimeSoftwareConfig.Builder clearVersion()

Output only. version of boot image such as M100, from release label of the image.

optional string version = 12;

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`

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
`Descriptor`

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getDisableTerminal()

public 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 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. Default: True

bool install_gpu_driver = 5;

Returns
Type	Description
`boolean`	The installGpuDriver.

getKernels(int index)

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

getKernelsBuilder(int index)

public ContainerImage.Builder getKernelsBuilder(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.Builder`

getKernelsBuilderList()

public List<ContainerImage.Builder> getKernelsBuilderList()

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<Builder>`

getKernelsCount()

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

getPostStartupScriptBehavior()

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

hasMixerDisabled()

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

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)

removeKernels(int index)

public RuntimeSoftwareConfig.Builder removeKernels(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
`RuntimeSoftwareConfig.Builder`

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.

setDisableTerminal(boolean value)

public RuntimeSoftwareConfig.Builder setDisableTerminal(boolean value)

Bool indicating whether JupyterLab terminal will be available or not. Default: False

optional bool disable_terminal = 11;

Parameter
Name	Description
`value`	`boolean` The disableTerminal 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. Default: True

bool install_gpu_driver = 5;

Parameter
Name	Description
`value`	`boolean` The installGpuDriver to set.

Returns
Type	Description
`RuntimeSoftwareConfig.Builder`	This builder for chaining.

setKernels(int index, ContainerImage value)

public RuntimeSoftwareConfig.Builder setKernels(int index, ContainerImage value)

Optional. Use a list of container images to use as Kernels in the notebook instance.

repeated .google.events.cloud.notebooks.v1.ContainerImage kernels = 8;

Parameters
Name	Description
`index`	`int`
`value`	`ContainerImage`

Returns
Type	Description
`RuntimeSoftwareConfig.Builder`

setKernels(int index, ContainerImage.Builder builderForValue)

public RuntimeSoftwareConfig.Builder setKernels(int index, ContainerImage.Builder builderForValue)

Optional. Use a list of container images to use as Kernels in the notebook instance.

repeated .google.events.cloud.notebooks.v1.ContainerImage kernels = 8;

Parameters
Name	Description
`index`	`int`
`builderForValue`	`ContainerImage.Builder`

Returns
Type	Description
`RuntimeSoftwareConfig.Builder`

setMixerDisabled(boolean value)

public RuntimeSoftwareConfig.Builder setMixerDisabled(boolean value)

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

optional bool mixer_disabled = 13;

Parameter
Name	Description
`value`	`boolean` The mixerDisabled 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.

setPostStartupScriptBehavior(RuntimeSoftwareConfig.PostStartupScriptBehavior value)

public RuntimeSoftwareConfig.Builder setPostStartupScriptBehavior(RuntimeSoftwareConfig.PostStartupScriptBehavior value)

Behavior for the post startup script.

.google.events.cloud.notebooks.v1.RuntimeSoftwareConfig.PostStartupScriptBehavior post_startup_script_behavior = 10;

Parameter
Name	Description
`value`	`RuntimeSoftwareConfig.PostStartupScriptBehavior` The postStartupScriptBehavior to set.

Returns
Type	Description
`RuntimeSoftwareConfig.Builder`	This builder for chaining.

setPostStartupScriptBehaviorValue(int value)

public RuntimeSoftwareConfig.Builder setPostStartupScriptBehaviorValue(int value)

Behavior for the post startup script.

.google.events.cloud.notebooks.v1.RuntimeSoftwareConfig.PostStartupScriptBehavior post_startup_script_behavior = 10;

Parameter
Name	Description
`value`	`int` The enum numeric value on the wire for postStartupScriptBehavior 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)

setUpgradeable(boolean value)

public RuntimeSoftwareConfig.Builder setUpgradeable(boolean value)

Output only. Bool indicating whether an newer image is available in an image family.

optional bool upgradeable = 9;

Parameter
Name	Description
`value`	`boolean` The upgradeable to set.

Returns
Type	Description
`RuntimeSoftwareConfig.Builder`	This builder for chaining.

setVersion(String value)

public RuntimeSoftwareConfig.Builder setVersion(String value)

Output only. version of boot image such as M100, from release label of the image.

optional string version = 12;

Parameter
Name	Description
`value`	`String` The version to set.

Returns
Type	Description
`RuntimeSoftwareConfig.Builder`	This builder for chaining.

setVersionBytes(ByteString value)

public RuntimeSoftwareConfig.Builder setVersionBytes(ByteString value)

Output only. version of boot image such as M100, from release label of the image.

optional string version = 12;

Parameter
Name	Description
`value`	`ByteString` The bytes for version to set.

Returns
Type	Description
`RuntimeSoftwareConfig.Builder`	This builder for chaining.