VirtualMachineConfig class

The config settings for virtual machine.

Inheritance
  • Object
  • GeneratedMessage
  • VirtualMachineConfig

Constructors

VirtualMachineConfig({String? zone, String? machineType, Iterable<ContainerImage>? containerImages, LocalDisk? dataDisk, EncryptionConfig? encryptionConfig, RuntimeShieldedInstanceConfig? shieldedInstanceConfig, RuntimeAcceleratorConfig? acceleratorConfig, String? network, String? subnet, bool? internalIpOnly, Iterable<String>? tags, Map<String, String>? guestAttributes, Map<String, String>? metadata, Map<String, String>? labels, VirtualMachineConfig_NicType? nicType, String? reservedIpRange, VirtualMachineConfig_BootImage? bootImage})
factory
VirtualMachineConfig.fromBuffer(List<int> i, [ExtensionRegistry r = $pb.ExtensionRegistry.EMPTY])
factory
VirtualMachineConfig.fromJson(String i, [ExtensionRegistry r = $pb.ExtensionRegistry.EMPTY])
factory

Properties

acceleratorConfig ↔ RuntimeAcceleratorConfig
Optional. The Compute Engine accelerator configuration for this runtime.
getter/setter pair
bootImage ↔ VirtualMachineConfig_BootImage
Optional. Boot image metadata used for runtime upgradeability.
getter/setter pair
containerImages → List<ContainerImage>
Optional. Use a list of container images to use as Kernels in the notebook instance.
no setter
dataDisk ↔ LocalDisk
Required. Data disk option configuration settings.
getter/setter pair
encryptionConfig ↔ EncryptionConfig
Optional. Encryption settings for virtual machine data disk.
getter/setter pair
eventPlugin → EventPlugin?
Subclasses can override this getter to be notified of changes to protobuf fields.
no setterinherited
guestAttributes → Map<String, String>
Output only. The Compute Engine guest attributes. (see Project and instance guest attributes).
no setter
hashCode → int
Calculates a hash code based on the contents of the protobuf.
no setterinherited
info_ → BuilderInfo
no setteroverride
internalIpOnly ↔ bool
Optional. If true, runtime will only have internal IP addresses. By default, runtimes are not restricted to internal IP addresses, and will have ephemeral external IP addresses assigned to each vm. This internal_ip_only restriction can only be enabled for subnetwork enabled networks, and all dependencies must be configured to be accessible without external IP addresses.
getter/setter pair
isFrozen → bool
Returns true if this message is marked read-only. Otherwise false.
no setterinherited
labels → Map<String, String>
Optional. The labels to associate with this runtime. Label keys must contain 1 to 63 characters, and must conform to RFC 1035. Label values may be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035. No more than 32 labels can be associated with a cluster.
no setter
machineType ↔ String
Required. The Compute Engine machine type used for runtimes. Short name is valid. Examples:
getter/setter pair
metadata → Map<String, String>
Optional. The Compute Engine metadata entries to add to virtual machine. (see Project and instance metadata).
no setter
network ↔ String
Optional. The Compute Engine network to be used for machine communications. Cannot be specified with subnetwork. If neither network nor subnet is specified, the "default" network of the project is used, if it exists.
getter/setter pair
nicType ↔ VirtualMachineConfig_NicType
Optional. The type of vNIC to be used on this interface. This may be gVNIC or VirtioNet.
getter/setter pair
reservedIpRange ↔ String
Optional. Reserved IP Range name is used for VPC Peering. The subnetwork allocation will use the range name if it's assigned.
getter/setter pair
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
shieldedInstanceConfig ↔ RuntimeShieldedInstanceConfig
Optional. Shielded VM Instance configuration settings.
getter/setter pair
subnet ↔ String
Optional. The Compute Engine subnetwork to be used for machine communications. Cannot be specified with network.
getter/setter pair
tags → List<String>
Optional. The Compute Engine tags to add to runtime (see Tagging instances).
no setter
unknownFields → UnknownFieldSet
no setterinherited
zone ↔ String
Output only. The zone where the virtual machine is located. If using regional request, the notebooks service will pick a location in the corresponding runtime region. On a get request, zone will always be present. Example:
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
clearAcceleratorConfig() → void
clearBootImage() → void
clearDataDisk() → void
clearEncryptionConfig() → 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
clearInternalIpOnly() → void
clearMachineType() → void
clearNetwork() → void
clearNicType() → void
clearReservedIpRange() → void
clearShieldedInstanceConfig() → void
clearSubnet() → void
clearZone() → void
clone() → VirtualMachineConfig
Creates a deep copy of the fields in this message. (The generated code uses mergeFromMessage.)
override
copyWith(void updates(VirtualMachineConfig)) → VirtualMachineConfig
Apply updates to a copy of this message.
override
createEmptyInstance() → VirtualMachineConfig
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
ensureAcceleratorConfig() → RuntimeAcceleratorConfig
ensureBootImage() → VirtualMachineConfig_BootImage
ensureDataDisk() → LocalDisk
ensureEncryptionConfig() → EncryptionConfig
ensureShieldedInstanceConfig() → RuntimeShieldedInstanceConfig
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
hasAcceleratorConfig() → bool
hasBootImage() → bool
hasDataDisk() → bool
hasEncryptionConfig() → 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
hasInternalIpOnly() → bool
hasMachineType() → bool
hasNetwork() → bool
hasNicType() → bool
hasRequiredFields() → bool
Whether the message has required fields.
inherited
hasReservedIpRange() → bool
hasShieldedInstanceConfig() → bool
hasSubnet() → bool
hasZone() → 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