RuntimeSoftwareConfig class

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
Inheritance
  • Object
  • GeneratedMessage
  • RuntimeSoftwareConfig

Constructors

RuntimeSoftwareConfig({String? notebookUpgradeSchedule, bool? enableHealthMonitoring, bool? idleShutdown, int? idleShutdownTimeout, bool? installGpuDriver, String? customGpuDriverPath, String? postStartupScript, Iterable<ContainerImage>? kernels, bool? upgradeable, RuntimeSoftwareConfig_PostStartupScriptBehavior? postStartupScriptBehavior, bool? disableTerminal, String? version, bool? mixerDisabled})
factory
RuntimeSoftwareConfig.fromBuffer(List<int> i, [ExtensionRegistry r = $pb.ExtensionRegistry.EMPTY])
factory
RuntimeSoftwareConfig.fromJson(String i, [ExtensionRegistry r = $pb.ExtensionRegistry.EMPTY])
factory

Properties

customGpuDriverPath ↔ String
Specify a custom Cloud Storage path where the GPU driver is stored. If not specified, we'll automatically choose from official GPU drivers.
getter/setter pair
disableTerminal ↔ bool
Bool indicating whether JupyterLab terminal will be available or not. Default: False
getter/setter pair
enableHealthMonitoring ↔ bool
Verifies core internal services are running. Default: True
getter/setter pair
eventPlugin → EventPlugin?
Subclasses can override this getter to be notified of changes to protobuf fields.
no setterinherited
hashCode → int
Calculates a hash code based on the contents of the protobuf.
no setterinherited
idleShutdown ↔ bool
Runtime will automatically shutdown after idle_shutdown_time. Default: True
getter/setter pair
idleShutdownTimeout ↔ int
Time in minutes to wait before shutting down runtime. Default: 180 minutes
getter/setter pair
info_ → BuilderInfo
no setteroverride
installGpuDriver ↔ bool
Install Nvidia Driver automatically. Default: True
getter/setter pair
isFrozen → bool
Returns true if this message is marked read-only. Otherwise false.
no setterinherited
kernels → List<ContainerImage>
Optional. Use a list of container images to use as Kernels in the notebook instance.
no setter
mixerDisabled ↔ bool
Bool indicating whether mixer client should be disabled. Default: False
getter/setter pair
notebookUpgradeSchedule ↔ String
Cron expression in UTC timezone, used to schedule instance auto upgrade. Please follow the cron format.
getter/setter pair
postStartupScript ↔ String
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).
getter/setter pair
postStartupScriptBehavior ↔ RuntimeSoftwareConfig_PostStartupScriptBehavior
Behavior for the post startup script.
getter/setter pair
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
unknownFields → UnknownFieldSet
no setterinherited
upgradeable ↔ bool
Output only. Bool indicating whether an newer image is available in an image family.
getter/setter pair
version ↔ String
Output only. version of boot image such as M100, from release label of the image.
getter/setter pair

Methods

addExtension(Extension extension, Object? value) → void
Adds an extension field value to a repeated field.
inherited
check() → void
inherited
clear() → void
Clears all data that was set in this message.
inherited
clearCustomGpuDriverPath() → void
clearDisableTerminal() → void
clearEnableHealthMonitoring() → void
clearExtension(Extension extension) → void
Clears an extension field and also removes the extension.
inherited
clearField(int tagNumber) → void
Clears the contents of a given field.
inherited
clearIdleShutdown() → void
clearIdleShutdownTimeout() → void
clearInstallGpuDriver() → void
clearMixerDisabled() → void
clearNotebookUpgradeSchedule() → void
clearPostStartupScript() → void
clearPostStartupScriptBehavior() → void
clearUpgradeable() → void
clearVersion() → void
clone() → RuntimeSoftwareConfig
Creates a deep copy of the fields in this message. (The generated code uses mergeFromMessage.)
override
copyWith(void updates(RuntimeSoftwareConfig)) → RuntimeSoftwareConfig
Apply updates to a copy of this message.
override
createEmptyInstance() → RuntimeSoftwareConfig
Creates an empty instance of the same message type as this.
override
createMapField<K, V>(int tagNumber, MapFieldInfo<K, V> fi) → Map<K, V>
Creates a Map representing a map field.
inherited
createRepeatedField<T>(int tagNumber, FieldInfo<T> fi) → List<T>
Creates List implementing a mutable repeated field.
inherited
extensionsAreInitialized() → bool
inherited
freeze() → GeneratedMessage
Make this message read-only.
inherited
getDefaultForField(int tagNumber) → dynamic
Returns the default value for the given field.
inherited
getExtension(Extension extension) → dynamic
Returns the value of extension.
inherited
getField(int tagNumber) → dynamic
Returns the value of the field associated with tagNumber, or the default value if it is not set.
inherited
getFieldOrNull(int tagNumber) → dynamic
Returns the value of a field, ignoring any defaults.
inherited
getTagNumber(String fieldName) → int?
inherited
hasCustomGpuDriverPath() → bool
hasDisableTerminal() → bool
hasEnableHealthMonitoring() → bool
hasExtension(Extension extension) → bool
Returns true if a value of extension is present.
inherited
hasField(int tagNumber) → bool
Whether this message has a field associated with tagNumber.
inherited
hasIdleShutdown() → bool
hasIdleShutdownTimeout() → bool
hasInstallGpuDriver() → bool
hasMixerDisabled() → bool
hasNotebookUpgradeSchedule() → bool
hasPostStartupScript() → bool
hasPostStartupScriptBehavior() → bool
hasRequiredFields() → bool
Whether the message has required fields.
inherited
hasUpgradeable() → bool
hasVersion() → bool
isInitialized() → bool
Whether all required fields in the message and embedded messages are set.
inherited
mergeFromBuffer(List<int> input, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void
Merges serialized protocol buffer data into this message.
inherited
mergeFromCodedBufferReader(CodedBufferReader input, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void
inherited
mergeFromJson(String data, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void
Merges field values from data, a JSON object, encoded as described by GeneratedMessage.writeToJson.
inherited
mergeFromJsonMap(Map<String, dynamic> json, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void
Merges field values from a JSON object represented as a Dart map.
inherited
mergeFromMessage(GeneratedMessage other) → void
Merges the contents of the other into this message.
inherited
mergeFromProto3Json(Object? json, {TypeRegistry typeRegistry = const TypeRegistry.empty(), bool ignoreUnknownFields = false, bool supportNamesWithUnderscores = true, bool permissiveEnums = false}) → void
Merges field values from json, a JSON object using proto3 encoding.
inherited
mergeUnknownFields(UnknownFieldSet unknownFieldSet) → void
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
setExtension(Extension extension, Object value) → void
Sets the value of a non-repeated extension field to value.
inherited
setField(int tagNumber, Object value) → void
Sets the value of a field by its tagNumber.
inherited
toBuilder() → GeneratedMessage
Creates a writable, shallow copy of this message.
inherited
toDebugString() → String
Returns a String representation of this message.
inherited
toProto3Json({TypeRegistry typeRegistry = const TypeRegistry.empty()}) → Object?
Returns an Object representing Proto3 JSON serialization of this.
inherited
toString() → String
Returns a String representation of this message.
inherited
writeToBuffer() → Uint8List
inherited
writeToCodedBufferWriter(CodedBufferWriter output) → void
inherited
writeToJson() → String
Returns a JSON string that encodes this message.
inherited
writeToJsonMap() → Map<String, dynamic>
Returns the JSON encoding of this message as a Dart Map.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited