Instance class

The definition of a notebook instance.

Inheritance
  • Object
  • GeneratedMessage
  • Instance

Constructors

Instance({String? name, VmImage? vmImage, ContainerImage? containerImage, String? postStartupScript, String? proxyUri, String? serviceAccount, String? machineType, Instance_AcceleratorConfig? acceleratorConfig, Instance_State? state, bool? installGpuDriver, String? customGpuDriverPath, bool? noPublicIp, bool? noProxyAccess, String? network, String? subnet, Map<String, String>? labels, Map<String, String>? metadata, Timestamp? createTime, Timestamp? updateTime, Iterable<Instance_Disk>? disks, Iterable<Instance_UpgradeHistoryEntry>? upgradeHistory, Instance_ShieldedInstanceConfig? shieldedInstanceConfig, Iterable<String>? serviceAccountScopes, Iterable<String>? tags, Instance_NicType? nicType, ReservationAffinity? reservationAffinity, String? creator, bool? canIpForward})
factory
Instance.fromBuffer(List<int> i, [ExtensionRegistry r = $pb.ExtensionRegistry.EMPTY])
factory
Instance.fromJson(String i, [ExtensionRegistry r = $pb.ExtensionRegistry.EMPTY])
factory

Properties

acceleratorConfig ↔ Instance_AcceleratorConfig
The hardware accelerator used on this instance. If you use accelerators, make sure that your configuration has enough vCPUs and memory to support the machine_type you have selected.
getter/setter pair
canIpForward ↔ bool
Optional. Flag to enable ip forwarding or not, default false/off. https://cloud.google.com/vpc/docs/using-routes#canipforward
getter/setter pair
containerImage ↔ ContainerImage
Use a container image to start the notebook instance.
getter/setter pair
createTime ↔ Timestamp
Output only. Instance creation time.
getter/setter pair
creator ↔ String
Output only. Email address of entity that sent original CreateInstance request.
getter/setter pair
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
disks → List<Instance_Disk>
Output only. Attached disks to notebook instance.
no setter
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
info_ → BuilderInfo
no setteroverride
installGpuDriver ↔ bool
Whether the end user authorizes Google Cloud to install GPU driver on this instance. If this field is empty or set to false, the GPU driver won't be installed. Only applicable to instances with GPUs.
getter/setter pair
isFrozen → bool
Returns true if this message is marked read-only. Otherwise false.
no setterinherited
labels → Map<String, String>
Labels to apply to this instance. These can be later modified by the setLabels method.
no setter
machineType ↔ String
Required. The Compute Engine machine type of this instance.
getter/setter pair
metadata → Map<String, String>
Custom metadata to apply to this instance.
no setter
name ↔ String
Output only. The name of this notebook instance. Format: projects/{project_id}/locations/{location}/instances/{instance_id}
getter/setter pair
network ↔ String
The name of the VPC that this instance is in. Format: projects/{project_id}/global/networks/{network_id}
getter/setter pair
nicType ↔ Instance_NicType
Optional. The type of vNIC to be used on this interface. This may be gVNIC or VirtioNet.
getter/setter pair
noProxyAccess ↔ bool
If true, the notebook instance will not register with the proxy.
getter/setter pair
noPublicIp ↔ bool
If true, no external IP will be assigned to this instance.
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
proxyUri ↔ String
Output only. The proxy endpoint that is used to access the Jupyter notebook.
getter/setter pair
reservationAffinity ↔ ReservationAffinity
Optional. The optional reservation affinity. Setting this field will apply the specified Zonal Compute Reservation to this notebook instance.
getter/setter pair
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
serviceAccount ↔ String
The service account on this instance, giving access to other Google Cloud services. You can use any service account within the same project, but you must have the service account user permission to use the instance.
getter/setter pair
serviceAccountScopes → List<String>
Optional. The URIs of service account scopes to be included in Compute Engine instances.
no setter
shieldedInstanceConfig ↔ Instance_ShieldedInstanceConfig
Optional. Shielded VM configuration. Images using supported Shielded VM features.
getter/setter pair
state ↔ Instance_State
Output only. The state of this instance.
getter/setter pair
subnet ↔ String
The name of the subnet that this instance is in. Format: projects/{project_id}/regions/{region}/subnetworks/{subnetwork_id}
getter/setter pair
tags → List<String>
Optional. The Compute Engine tags to add to runtime (see Tagging instances).
no setter
unknownFields → UnknownFieldSet
no setterinherited
updateTime ↔ Timestamp
Output only. Instance update time.
getter/setter pair
upgradeHistory → List<Instance_UpgradeHistoryEntry>
The upgrade history of this instance.
no setter
vmImage ↔ VmImage
Use a Compute Engine VM image to start the notebook instance.
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
clearCanIpForward() → void
clearContainerImage() → void
clearCreateTime() → void
clearCreator() → void
clearCustomGpuDriverPath() → void
clearEnvironment() → 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
clearInstallGpuDriver() → void
clearMachineType() → void
clearName() → void
clearNetwork() → void
clearNicType() → void
clearNoProxyAccess() → void
clearNoPublicIp() → void
clearPostStartupScript() → void
clearProxyUri() → void
clearReservationAffinity() → void
clearServiceAccount() → void
clearShieldedInstanceConfig() → void
clearState() → void
clearSubnet() → void
clearUpdateTime() → void
clearVmImage() → void
clone() → Instance
Creates a deep copy of the fields in this message. (The generated code uses mergeFromMessage.)
override
copyWith(void updates(Instance)) → Instance
Apply updates to a copy of this message.
override
createEmptyInstance() → Instance
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() → Instance_AcceleratorConfig
ensureContainerImage() → ContainerImage
ensureCreateTime() → Timestamp
ensureReservationAffinity() → ReservationAffinity
ensureShieldedInstanceConfig() → Instance_ShieldedInstanceConfig
ensureUpdateTime() → Timestamp
ensureVmImage() → VmImage
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
hasCanIpForward() → bool
hasContainerImage() → bool
hasCreateTime() → bool
hasCreator() → bool
hasCustomGpuDriverPath() → 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
hasInstallGpuDriver() → bool
hasMachineType() → bool
hasName() → bool
hasNetwork() → bool
hasNicType() → bool
hasNoProxyAccess() → bool
hasNoPublicIp() → bool
hasPostStartupScript() → bool
hasProxyUri() → bool
hasRequiredFields() → bool
Whether the message has required fields.
inherited
hasReservationAffinity() → bool
hasServiceAccount() → bool
hasShieldedInstanceConfig() → bool
hasState() → bool
hasSubnet() → bool
hasUpdateTime() → bool
hasVmImage() → 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
whichEnvironment() → Instance_Environment
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

Static Methods

create() → Instance
createRepeated() → PbList<Instance>
getDefault() → Instance