Class RuntimeSoftwareConfig (1.12.0)

Version 1.12.0

• 1.53.0 (latest)
• 1.52.0
• 1.51.0
• 1.50.0
• 1.49.0
• 1.47.0
• 1.46.0
• 1.45.0
• 1.44.0
• 1.43.0
• 1.42.0
• 1.41.0
• 1.40.0
• 1.39.0
• 1.38.0
• 1.37.0
• 1.35.0
• 1.34.0
• 1.33.0
• 1.32.0
• 1.31.0
• 1.30.0
• 1.29.0
• 1.28.0
• 1.27.0
• 1.26.0
• 1.25.0
• 1.22.0
• 1.21.0
• 1.20.0
• 1.19.0
• 1.18.0
• 1.17.0
• 1.16.0
• 1.15.0
• 1.14.0
• 1.13.0
• 1.12.0
• 1.11.0
• 1.10.0
• 1.9.0
• 1.7.0
• 1.6.0
• 1.5.0
• 1.4.0
• 1.3.0
• 1.2.0
• 1.1.3
• 1.0.6
• 0.6.2

public final class RuntimeSoftwareConfig extends GeneratedMessageV3 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.cloud.notebooks.v1.RuntimeSoftwareConfig

Inheritance

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

Implements

RuntimeSoftwareConfigOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.hashLong(long)

AbstractMessage.toString()

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

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

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<V>serializeBooleanMapTo(CodedOutputStream,MapField<Boolean,V>,MapEntry<Boolean,V>,int)

GeneratedMessageV3.<V>serializeIntegerMapTo(CodedOutputStream,MapField<Integer,V>,MapEntry<Integer,V>,int)

GeneratedMessageV3.<V>serializeLongMapTo(CodedOutputStream,MapField<Long,V>,MapEntry<Long,V>,int)

GeneratedMessageV3.<V>serializeStringMapTo(CodedOutputStream,MapField<String,V>,MapEntry<String,V>,int)

GeneratedMessageV3.canUseUnsafe()

GeneratedMessageV3.computeStringSize(int,Object)

GeneratedMessageV3.computeStringSizeNoTag(Object)

GeneratedMessageV3.emptyBooleanList()

GeneratedMessageV3.emptyDoubleList()

GeneratedMessageV3.emptyFloatList()

GeneratedMessageV3.emptyIntList()

GeneratedMessageV3.emptyLongList()

GeneratedMessageV3.getAllFields()

GeneratedMessageV3.getDescriptorForType()

GeneratedMessageV3.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.getParserForType()

GeneratedMessageV3.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.getSerializedSize()

GeneratedMessageV3.getUnknownFields()

GeneratedMessageV3.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.internalGetFieldAccessorTable()

GeneratedMessageV3.internalGetMapField(int)

GeneratedMessageV3.isInitialized()

GeneratedMessageV3.isStringEmpty(Object)

GeneratedMessageV3.makeExtensionsImmutable()

GeneratedMessageV3.mergeFromAndMakeImmutableInternal(CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.mutableCopy(Internal.BooleanList)

GeneratedMessageV3.mutableCopy(Internal.DoubleList)

GeneratedMessageV3.mutableCopy(Internal.FloatList)

GeneratedMessageV3.mutableCopy(Internal.IntList)

GeneratedMessageV3.mutableCopy(Internal.LongList)

GeneratedMessageV3.newBooleanList()

GeneratedMessageV3.newBuilderForType(AbstractMessage.BuilderParent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent)

GeneratedMessageV3.newDoubleList()

GeneratedMessageV3.newFloatList()

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter)

GeneratedMessageV3.newIntList()

GeneratedMessageV3.newLongList()

GeneratedMessageV3.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.parseUnknownFieldProto3(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.writeReplace()

GeneratedMessageV3.writeString(CodedOutputStream,int,Object)

GeneratedMessageV3.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessageV3.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

CUSTOM_GPU_DRIVER_PATH_FIELD_NUMBER

public static final int CUSTOM_GPU_DRIVER_PATH_FIELD_NUMBER

Field Value
Type	Description
int

DISABLE_TERMINAL_FIELD_NUMBER

public static final int DISABLE_TERMINAL_FIELD_NUMBER

Field Value
Type	Description
int

ENABLE_HEALTH_MONITORING_FIELD_NUMBER

public static final int ENABLE_HEALTH_MONITORING_FIELD_NUMBER

Field Value
Type	Description
int

IDLE_SHUTDOWN_FIELD_NUMBER

public static final int IDLE_SHUTDOWN_FIELD_NUMBER

Field Value
Type	Description
int

IDLE_SHUTDOWN_TIMEOUT_FIELD_NUMBER

public static final int IDLE_SHUTDOWN_TIMEOUT_FIELD_NUMBER

Field Value
Type	Description
int

INSTALL_GPU_DRIVER_FIELD_NUMBER

public static final int INSTALL_GPU_DRIVER_FIELD_NUMBER

Field Value
Type	Description
int

KERNELS_FIELD_NUMBER

public static final int KERNELS_FIELD_NUMBER

Field Value
Type	Description
int

NOTEBOOK_UPGRADE_SCHEDULE_FIELD_NUMBER

public static final int NOTEBOOK_UPGRADE_SCHEDULE_FIELD_NUMBER

Field Value
Type	Description
int

POST_STARTUP_SCRIPT_BEHAVIOR_FIELD_NUMBER

public static final int POST_STARTUP_SCRIPT_BEHAVIOR_FIELD_NUMBER

Field Value
Type	Description
int

POST_STARTUP_SCRIPT_FIELD_NUMBER

public static final int POST_STARTUP_SCRIPT_FIELD_NUMBER

Field Value
Type	Description
int

UPGRADEABLE_FIELD_NUMBER

public static final int UPGRADEABLE_FIELD_NUMBER

Field Value
Type	Description
int

VERSION_FIELD_NUMBER

public static final int VERSION_FIELD_NUMBER

Field Value
Type	Description
int

Static Methods

getDefaultInstance()

public static RuntimeSoftwareConfig getDefaultInstance()

Returns
Type	Description
RuntimeSoftwareConfig

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

newBuilder()

public static RuntimeSoftwareConfig.Builder newBuilder()

Returns
Type	Description
RuntimeSoftwareConfig.Builder

newBuilder(RuntimeSoftwareConfig prototype)

public static RuntimeSoftwareConfig.Builder newBuilder(RuntimeSoftwareConfig prototype)

Parameter
Name	Description
prototype	RuntimeSoftwareConfig

Returns
Type	Description
RuntimeSoftwareConfig.Builder

parseDelimitedFrom(InputStream input)

public static RuntimeSoftwareConfig parseDelimitedFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
RuntimeSoftwareConfig

Exceptions
Type	Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static RuntimeSoftwareConfig parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
RuntimeSoftwareConfig

Exceptions
Type	Description
IOException

parseFrom(byte[] data)

public static RuntimeSoftwareConfig parseFrom(byte[] data)

Parameter
Name	Description
data	byte[]

Returns
Type	Description
RuntimeSoftwareConfig

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static RuntimeSoftwareConfig parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	byte[]
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
RuntimeSoftwareConfig

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static RuntimeSoftwareConfig parseFrom(ByteString data)

Parameter
Name	Description
data	ByteString

Returns
Type	Description
RuntimeSoftwareConfig

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static RuntimeSoftwareConfig parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteString
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
RuntimeSoftwareConfig

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static RuntimeSoftwareConfig parseFrom(CodedInputStream input)

Parameter
Name	Description
input	CodedInputStream

Returns
Type	Description
RuntimeSoftwareConfig

Exceptions
Type	Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static RuntimeSoftwareConfig parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
RuntimeSoftwareConfig

Exceptions
Type	Description
IOException

parseFrom(InputStream input)

public static RuntimeSoftwareConfig parseFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
RuntimeSoftwareConfig

Exceptions
Type	Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static RuntimeSoftwareConfig parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
RuntimeSoftwareConfig

Exceptions
Type	Description
IOException

parseFrom(ByteBuffer data)

public static RuntimeSoftwareConfig parseFrom(ByteBuffer data)

Parameter
Name	Description
data	ByteBuffer

Returns
Type	Description
RuntimeSoftwareConfig

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static RuntimeSoftwareConfig parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteBuffer
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
RuntimeSoftwareConfig

Exceptions
Type	Description
InvalidProtocolBufferException

parser()

public static Parser<RuntimeSoftwareConfig> parser()

Returns
Type	Description
Parser<RuntimeSoftwareConfig>

Methods

equals(Object obj)

public boolean equals(Object obj)

Parameter
Name	Description
obj	Object

Returns
Type	Description
boolean

Overrides

AbstractMessage.equals(Object other)

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

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.cloud.notebooks.v1.ContainerImage kernels = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
index	int

Returns
Type	Description
ContainerImage

getKernelsCount()

public int getKernelsCount()

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

repeated .google.cloud.notebooks.v1.ContainerImage kernels = 8 [(.google.api.field_behavior) = OPTIONAL];

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.cloud.notebooks.v1.ContainerImage kernels = 8 [(.google.api.field_behavior) = OPTIONAL];

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.cloud.notebooks.v1.ContainerImage kernels = 8 [(.google.api.field_behavior) = OPTIONAL];

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.cloud.notebooks.v1.ContainerImage kernels = 8 [(.google.api.field_behavior) = OPTIONAL];

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

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.

getParserForType()

public Parser<RuntimeSoftwareConfig> getParserForType()

Returns
Type	Description
Parser<RuntimeSoftwareConfig>

Overrides

GeneratedMessageV3.getParserForType()

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

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
int

Overrides

GeneratedMessageV3.getSerializedSize()

getUnknownFields()

public final UnknownFieldSet getUnknownFields()

Returns
Type	Description
UnknownFieldSet

Overrides

GeneratedMessageV3.getUnknownFields()

getUpgradeable()

public boolean getUpgradeable()

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

optional bool upgradeable = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

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 [(.google.api.field_behavior) = OUTPUT_ONLY];

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 [(.google.api.field_behavior) = OUTPUT_ONLY];

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.

hasUpgradeable()

public boolean hasUpgradeable()

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

optional bool upgradeable = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

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 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
boolean	Whether the version field is set.

hashCode()

public int hashCode()

Returns
Type	Description
int

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.isInitialized()

newBuilderForType()

public RuntimeSoftwareConfig.Builder newBuilderForType()

Returns
Type	Description
RuntimeSoftwareConfig.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected RuntimeSoftwareConfig.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Parameter
Name	Description
parent	BuilderParent

Returns
Type	Description
RuntimeSoftwareConfig.Builder

Overrides

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Parameter
Name	Description
unused	UnusedPrivateParameter

Returns
Type	Description
Object

Overrides

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

toBuilder()

public RuntimeSoftwareConfig.Builder toBuilder()

Returns
Type	Description
RuntimeSoftwareConfig.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
output	CodedOutputStream

Overrides

GeneratedMessageV3.writeTo(CodedOutputStream output)

Exceptions
Type	Description
IOException