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: trueidle_shutdown_timeout: 180enable_health_monitoring: true
Protobuf type google.cloud.notebooks.v1.RuntimeSoftwareConfig
Static Fields
CUSTOM_GPU_DRIVER_PATH_FIELD_NUMBER
public static final int CUSTOM_GPU_DRIVER_PATH_FIELD_NUMBER
Field Value
DISABLE_TERMINAL_FIELD_NUMBER
public static final int DISABLE_TERMINAL_FIELD_NUMBER
Field Value
ENABLE_HEALTH_MONITORING_FIELD_NUMBER
public static final int ENABLE_HEALTH_MONITORING_FIELD_NUMBER
Field Value
IDLE_SHUTDOWN_FIELD_NUMBER
public static final int IDLE_SHUTDOWN_FIELD_NUMBER
Field Value
IDLE_SHUTDOWN_TIMEOUT_FIELD_NUMBER
public static final int IDLE_SHUTDOWN_TIMEOUT_FIELD_NUMBER
Field Value
INSTALL_GPU_DRIVER_FIELD_NUMBER
public static final int INSTALL_GPU_DRIVER_FIELD_NUMBER
Field Value
KERNELS_FIELD_NUMBER
public static final int KERNELS_FIELD_NUMBER
Field Value
NOTEBOOK_UPGRADE_SCHEDULE_FIELD_NUMBER
public static final int NOTEBOOK_UPGRADE_SCHEDULE_FIELD_NUMBER
Field Value
POST_STARTUP_SCRIPT_BEHAVIOR_FIELD_NUMBER
public static final int POST_STARTUP_SCRIPT_BEHAVIOR_FIELD_NUMBER
Field Value
POST_STARTUP_SCRIPT_FIELD_NUMBER
public static final int POST_STARTUP_SCRIPT_FIELD_NUMBER
Field Value
UPGRADEABLE_FIELD_NUMBER
public static final int UPGRADEABLE_FIELD_NUMBER
Field Value
VERSION_FIELD_NUMBER
public static final int VERSION_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static RuntimeSoftwareConfig getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static RuntimeSoftwareConfig.Builder newBuilder()
Returns
newBuilder(RuntimeSoftwareConfig prototype)
public static RuntimeSoftwareConfig.Builder newBuilder(RuntimeSoftwareConfig prototype)
Parameter
Returns
public static RuntimeSoftwareConfig parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static RuntimeSoftwareConfig parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static RuntimeSoftwareConfig parseFrom(byte[] data)
Parameter
| Name | Description |
data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static RuntimeSoftwareConfig parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static RuntimeSoftwareConfig parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static RuntimeSoftwareConfig parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static RuntimeSoftwareConfig parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static RuntimeSoftwareConfig parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static RuntimeSoftwareConfig parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static RuntimeSoftwareConfig parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static RuntimeSoftwareConfig parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static RuntimeSoftwareConfig parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<RuntimeSoftwareConfig> parser()
Returns
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
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;
| 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;
| Type | Description |
ByteString | The bytes for customGpuDriverPath.
|
getDefaultInstanceForType()
public RuntimeSoftwareConfig getDefaultInstanceForType()
Returns
getDisableTerminal()
public boolean getDisableTerminal()
Bool indicating whether JupyterLab terminal will be available or not.
Default: False
optional bool disable_terminal = 11;
| Type | Description |
boolean | The disableTerminal.
|
getEnableHealthMonitoring()
public boolean getEnableHealthMonitoring()
Verifies core internal services are running.
Default: True
optional bool enable_health_monitoring = 2;
| Type | Description |
boolean | The enableHealthMonitoring.
|
getIdleShutdown()
public boolean getIdleShutdown()
Runtime will automatically shutdown after idle_shutdown_time.
Default: True
optional bool idle_shutdown = 3;
| 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;
| Type | Description |
int | The idleShutdownTimeout.
|
getInstallGpuDriver()
public boolean getInstallGpuDriver()
Install Nvidia Driver automatically.
Default: True
bool install_gpu_driver = 5;
| 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];
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];
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];
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];
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];
| 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;
| 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;
| Type | Description |
ByteString | The bytes for notebookUpgradeSchedule.
|
getParserForType()
public Parser<RuntimeSoftwareConfig> getParserForType()
Returns
Overrides
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;
| 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;
getPostStartupScriptBehaviorValue()
public int getPostStartupScriptBehaviorValue()
Behavior for the post startup script.
.google.cloud.notebooks.v1.RuntimeSoftwareConfig.PostStartupScriptBehavior post_startup_script_behavior = 10;
| 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;
| Type | Description |
ByteString | The bytes for postStartupScript.
|
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
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];
| 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];
| 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];
hasDisableTerminal()
public boolean hasDisableTerminal()
Bool indicating whether JupyterLab terminal will be available or not.
Default: False
optional bool disable_terminal = 11;
| 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;
| 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;
| 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];
| 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];
| Type | Description |
boolean | Whether the version field is set.
|
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public RuntimeSoftwareConfig.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected RuntimeSoftwareConfig.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public RuntimeSoftwareConfig.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
