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: trueidle_shutdown_timeout: 180enable_health_monitoring: true
Protobuf type google.cloud.notebooks.v1.RuntimeSoftwareConfig
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > RuntimeSoftwareConfig.BuilderImplements
RuntimeSoftwareConfigOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| 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.cloud.notebooks.v1.ContainerImage kernels = 8 [(.google.api.field_behavior) = OPTIONAL];
| Name | Description |
| values | Iterable<? extends com.google.cloud.notebooks.v1.ContainerImage> |
| 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.cloud.notebooks.v1.ContainerImage kernels = 8 [(.google.api.field_behavior) = OPTIONAL];
| Name | Description |
| value | ContainerImage |
| 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.cloud.notebooks.v1.ContainerImage kernels = 8 [(.google.api.field_behavior) = OPTIONAL];
| Name | Description |
| builderForValue | ContainerImage.Builder |
| 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.cloud.notebooks.v1.ContainerImage kernels = 8 [(.google.api.field_behavior) = OPTIONAL];
| Name | Description |
| index | int |
| value | ContainerImage |
| 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.cloud.notebooks.v1.ContainerImage kernels = 8 [(.google.api.field_behavior) = OPTIONAL];
| Name | Description |
| index | int |
| builderForValue | ContainerImage.Builder |
| 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.cloud.notebooks.v1.ContainerImage kernels = 8 [(.google.api.field_behavior) = OPTIONAL];
| 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.cloud.notebooks.v1.ContainerImage kernels = 8 [(.google.api.field_behavior) = OPTIONAL];
| Name | Description |
| index | int |
| Type | Description |
| ContainerImage.Builder |
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public RuntimeSoftwareConfig.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Name | Description |
| field | FieldDescriptor |
| value | Object |
| Type | Description |
| RuntimeSoftwareConfig.Builder |
build()
public RuntimeSoftwareConfig build()| Type | Description |
| RuntimeSoftwareConfig |
buildPartial()
public RuntimeSoftwareConfig buildPartial()| Type | Description |
| RuntimeSoftwareConfig |
clear()
public RuntimeSoftwareConfig.Builder clear()| Type | Description |
| RuntimeSoftwareConfig.Builder |
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;
| 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;
| Type | Description |
| RuntimeSoftwareConfig.Builder | This builder for chaining. |
clearField(Descriptors.FieldDescriptor field)
public RuntimeSoftwareConfig.Builder clearField(Descriptors.FieldDescriptor field)| Name | Description |
| field | FieldDescriptor |
| Type | Description |
| RuntimeSoftwareConfig.Builder |
clearIdleShutdown()
public RuntimeSoftwareConfig.Builder clearIdleShutdown()Runtime will automatically shutdown after idle_shutdown_time. Default: True
optional bool idle_shutdown = 3;
| 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;
| Type | Description |
| RuntimeSoftwareConfig.Builder | This builder for chaining. |
clearInstallGpuDriver()
public RuntimeSoftwareConfig.Builder clearInstallGpuDriver()Install Nvidia Driver automatically. Default: True
bool install_gpu_driver = 5;
| 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.cloud.notebooks.v1.ContainerImage kernels = 8 [(.google.api.field_behavior) = OPTIONAL];
| Type | Description |
| RuntimeSoftwareConfig.Builder |
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;
| Type | Description |
| RuntimeSoftwareConfig.Builder | This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public RuntimeSoftwareConfig.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Name | Description |
| oneof | OneofDescriptor |
| Type | Description |
| RuntimeSoftwareConfig.Builder |
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;
| 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 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
| RuntimeSoftwareConfig.Builder | This builder for chaining. |
clone()
public RuntimeSoftwareConfig.Builder clone()| Type | Description |
| RuntimeSoftwareConfig.Builder |
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()| Type | Description |
| RuntimeSoftwareConfig |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Type | Description |
| Descriptor |
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];
| Name | Description |
| index | int |
| 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.cloud.notebooks.v1.ContainerImage kernels = 8 [(.google.api.field_behavior) = OPTIONAL];
| Name | Description |
| index | int |
| 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.cloud.notebooks.v1.ContainerImage kernels = 8 [(.google.api.field_behavior) = OPTIONAL];
| 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.cloud.notebooks.v1.ContainerImage kernels = 8 [(.google.api.field_behavior) = OPTIONAL];
| 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];
| 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];
| Name | Description |
| index | int |
| 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];
| 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. |
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. |
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. |
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. |
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. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Type | Description |
| FieldAccessorTable |
isInitialized()
public final boolean isInitialized()| Type | Description |
| boolean |
mergeFrom(RuntimeSoftwareConfig other)
public RuntimeSoftwareConfig.Builder mergeFrom(RuntimeSoftwareConfig other)| Name | Description |
| other | RuntimeSoftwareConfig |
| Type | Description |
| RuntimeSoftwareConfig.Builder |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public RuntimeSoftwareConfig.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Name | Description |
| input | CodedInputStream |
| extensionRegistry | ExtensionRegistryLite |
| Type | Description |
| RuntimeSoftwareConfig.Builder |
| Type | Description |
| IOException |
mergeFrom(Message other)
public RuntimeSoftwareConfig.Builder mergeFrom(Message other)| Name | Description |
| other | Message |
| Type | Description |
| RuntimeSoftwareConfig.Builder |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final RuntimeSoftwareConfig.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Name | Description |
| unknownFields | UnknownFieldSet |
| Type | Description |
| RuntimeSoftwareConfig.Builder |
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.cloud.notebooks.v1.ContainerImage kernels = 8 [(.google.api.field_behavior) = OPTIONAL];
| Name | Description |
| index | int |
| 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;
| Name | Description |
| value | StringThe customGpuDriverPath to set. |
| 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;
| Name | Description |
| value | ByteStringThe bytes for customGpuDriverPath to set. |
| 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;
| Name | Description |
| value | booleanThe enableHealthMonitoring to set. |
| Type | Description |
| RuntimeSoftwareConfig.Builder | This builder for chaining. |
setField(Descriptors.FieldDescriptor field, Object value)
public RuntimeSoftwareConfig.Builder setField(Descriptors.FieldDescriptor field, Object value)| Name | Description |
| field | FieldDescriptor |
| value | Object |
| Type | Description |
| RuntimeSoftwareConfig.Builder |
setIdleShutdown(boolean value)
public RuntimeSoftwareConfig.Builder setIdleShutdown(boolean value)Runtime will automatically shutdown after idle_shutdown_time. Default: True
optional bool idle_shutdown = 3;
| Name | Description |
| value | booleanThe idleShutdown to set. |
| 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;
| Name | Description |
| value | intThe idleShutdownTimeout to set. |
| 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;
| Name | Description |
| value | booleanThe installGpuDriver to set. |
| 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.cloud.notebooks.v1.ContainerImage kernels = 8 [(.google.api.field_behavior) = OPTIONAL];
| Name | Description |
| index | int |
| value | ContainerImage |
| 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.cloud.notebooks.v1.ContainerImage kernels = 8 [(.google.api.field_behavior) = OPTIONAL];
| Name | Description |
| index | int |
| builderForValue | ContainerImage.Builder |
| Type | Description |
| RuntimeSoftwareConfig.Builder |
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;
| Name | Description |
| value | StringThe notebookUpgradeSchedule to set. |
| 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;
| Name | Description |
| value | ByteStringThe bytes for notebookUpgradeSchedule to set. |
| 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;
| Name | Description |
| value | StringThe postStartupScript to set. |
| 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;
| Name | Description |
| value | ByteStringThe bytes for postStartupScript to set. |
| 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)| Name | Description |
| field | FieldDescriptor |
| index | int |
| value | Object |
| Type | Description |
| RuntimeSoftwareConfig.Builder |
setUnknownFields(UnknownFieldSet unknownFields)
public final RuntimeSoftwareConfig.Builder setUnknownFields(UnknownFieldSet unknownFields)| Name | Description |
| unknownFields | UnknownFieldSet |
| Type | Description |
| RuntimeSoftwareConfig.Builder |
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 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Name | Description |
| value | booleanThe upgradeable to set. |
| Type | Description |
| RuntimeSoftwareConfig.Builder | This builder for chaining. |