GetInstanceResult class

Result data returned by getInstance.

Constructors

GetInstanceResult({required AcceleratorConfigResponse acceleratorConfig, required String bootDiskSizeGb, required String bootDiskType, required bool canIpForward, required ContainerImageResponse containerImage, required String createTime, required String creator, required String customGpuDriverPath, required String dataDiskSizeGb, required String dataDiskType, required String diskEncryption, required List<DiskResponse> disks, required bool installGpuDriver, required InstanceMigrationEligibilityResponse instanceMigrationEligibility, required List<String> instanceOwners, required String kmsKey, required Map<String, String> labels, required String machineType, required Map<String, String> metadata, required bool migrated, required String name, required String network, required String nicType, required bool noProxyAccess, required bool noPublicIp, required bool noRemoveDataDisk, required String postStartupScript, required String proxyUri, required ReservationAffinityResponse reservationAffinity, required String serviceAccount, required List<String> serviceAccountScopes, required ShieldedInstanceConfigResponse shieldedInstanceConfig, required String state, required String subnet, required List<String> tags, required String updateTime, required List<UpgradeHistoryEntryResponse> upgradeHistory, required VmImageResponse vmImage})
Creates a new GetInstanceResult. 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. bootDiskSizeGb Input only. The size of the boot disk in GB attached to this instance, up to a maximum of 64000 GB (64 TB). The minimum recommended value is 100 GB. If not specified, this defaults to 100. bootDiskType Input only. The type of the boot disk attached to this instance, defaults to standard persistent disk (PD_STANDARD). canIpForward Optional. Flag to enable ip forwarding or not, default false/off. https://cloud.google.com/vpc/docs/using-routes#canipforward containerImage Use a container image to start the notebook instance. createTime Instance creation time. creator Email address of entity that sent original CreateInstance request. customGpuDriverPath Specify a custom Cloud Storage path where the GPU driver is stored. If not specified, we'll automatically choose from official GPU drivers. dataDiskSizeGb Input only. The size of the data disk in GB attached to this instance, up to a maximum of 64000 GB (64 TB). You can choose the size of the data disk based on how big your notebooks and data are. If not specified, this defaults to 100. dataDiskType Input only. The type of the data disk attached to this instance, defaults to standard persistent disk (PD_STANDARD). diskEncryption Input only. Disk encryption method used on the boot and data disks, defaults to GMEK. disks Attached disks to notebook instance. installGpuDriver 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. instanceMigrationEligibility Checks how feasible a migration from UmN to WbI is. instanceOwners Input only. The owner of this instance after creation. Format: alias@example.com Currently supports one owner only. If not specified, all of the service account users of your VM instance's service account can use the instance. kmsKey Input only. The KMS key used to encrypt the disks, only applicable if disk_encryption is CMEK. Format: projects/{project_id}/locations/{location}/keyRings/{key_ring_id}/cryptoKeys/{key_id} Learn more about using your own encryption keys. labels Labels to apply to this instance. These can be later modified by the setLabels method. machineType The Compute Engine machine type of this instance. metadata Custom metadata to apply to this instance. For example, to specify a Cloud Storage bucket for automatic backup, you can use the gcs-data-bucket metadata tag. Format: "--metadata=gcs-data-bucket=``BUCKET''". migrated Bool indicating whether this notebook has been migrated to a Workbench Instance name The name of this notebook instance. Format: projects/{project_id}/locations/{location}/instances/{instance_id} network The name of the VPC that this instance is in. Format: projects/{project_id}/global/networks/{network_id} nicType Optional. The type of vNIC to be used on this interface. This may be gVNIC or VirtioNet. noProxyAccess If true, the notebook instance will not register with the proxy. noPublicIp If true, no external IP will be assigned to this instance. noRemoveDataDisk Input only. If true, the data disk will not be auto deleted when deleting the instance. postStartupScript 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). proxyUri The proxy endpoint that is used to access the Jupyter notebook. reservationAffinity Optional. The optional reservation affinity. Setting this field will apply the specified Zonal Compute Reservation to this notebook instance. serviceAccount 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. If not specified, the Compute Engine default service account is used. serviceAccountScopes Optional. The URIs of service account scopes to be included in Compute Engine instances. If not specified, the following scopes are defined: - https://www.googleapis.com/auth/cloud-platform - https://www.googleapis.com/auth/userinfo.email If not using default scopes, you need at least: https://www.googleapis.com/auth/compute shieldedInstanceConfig Optional. Shielded VM configuration. Images using supported Shielded VM features. state The state of this instance. subnet The name of the subnet that this instance is in. Format: projects/{project_id}/regions/{region}/subnetworks/{subnetwork_id} tags Optional. The Compute Engine tags to add to runtime (see Tagging instances). updateTime Instance update time. upgradeHistory The upgrade history of this instance. vmImage Use a Compute Engine VM image to start the notebook instance.
const
GetInstanceResult.fromMap(Map<String, dynamic> map)
factory

Properties

acceleratorConfig → AcceleratorConfigResponse
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.
final
bootDiskSizeGb → String
Input only. The size of the boot disk in GB attached to this instance, up to a maximum of 64000 GB (64 TB). The minimum recommended value is 100 GB. If not specified, this defaults to 100.
final
bootDiskType → String
Input only. The type of the boot disk attached to this instance, defaults to standard persistent disk (PD_STANDARD).
final
canIpForward → bool
Optional. Flag to enable ip forwarding or not, default false/off. https://cloud.google.com/vpc/docs/using-routes#canipforward
final
containerImage → ContainerImageResponse
Use a container image to start the notebook instance.
final
createTime → String
Instance creation time.
final
creator → String
Email address of entity that sent original CreateInstance request.
final
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.
final
dataDiskSizeGb → String
Input only. The size of the data disk in GB attached to this instance, up to a maximum of 64000 GB (64 TB). You can choose the size of the data disk based on how big your notebooks and data are. If not specified, this defaults to 100.
final
dataDiskType → String
Input only. The type of the data disk attached to this instance, defaults to standard persistent disk (PD_STANDARD).
final
diskEncryption → String
Input only. Disk encryption method used on the boot and data disks, defaults to GMEK.
final
disks → List<DiskResponse>
Attached disks to notebook instance.
final
hashCode → int
The hash code for this object.
no setterinherited
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.
final
instanceMigrationEligibility → InstanceMigrationEligibilityResponse
Checks how feasible a migration from UmN to WbI is.
final
instanceOwners → List<String>
Input only. The owner of this instance after creation. Format: alias@example.com Currently supports one owner only. If not specified, all of the service account users of your VM instance's service account can use the instance.
final
kmsKey → String
Input only. The KMS key used to encrypt the disks, only applicable if disk_encryption is CMEK. Format: projects/{project_id}/locations/{location}/keyRings/{key_ring_id}/cryptoKeys/{key_id} Learn more about using your own encryption keys.
final
labels → Map<String, String>
Labels to apply to this instance. These can be later modified by the setLabels method.
final
machineType → String
The Compute Engine machine type of this instance.
final
metadata → Map<String, String>
Custom metadata to apply to this instance. For example, to specify a Cloud Storage bucket for automatic backup, you can use the gcs-data-bucket metadata tag. Format: "--metadata=gcs-data-bucket=``BUCKET''".
final
migrated → bool
Bool indicating whether this notebook has been migrated to a Workbench Instance
final
name → String
The name of this notebook instance. Format: projects/{project_id}/locations/{location}/instances/{instance_id}
final
network → String
The name of the VPC that this instance is in. Format: projects/{project_id}/global/networks/{network_id}
final
nicType → String
Optional. The type of vNIC to be used on this interface. This may be gVNIC or VirtioNet.
final
noProxyAccess → bool
If true, the notebook instance will not register with the proxy.
final
noPublicIp → bool
If true, no external IP will be assigned to this instance.
final
noRemoveDataDisk → bool
Input only. If true, the data disk will not be auto deleted when deleting the instance.
final
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).
final
proxyUri → String
The proxy endpoint that is used to access the Jupyter notebook.
final
reservationAffinity → ReservationAffinityResponse
Optional. The optional reservation affinity. Setting this field will apply the specified Zonal Compute Reservation to this notebook instance.
final
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. If not specified, the Compute Engine default service account is used.
final
serviceAccountScopes → List<String>
Optional. The URIs of service account scopes to be included in Compute Engine instances. If not specified, the following scopes are defined: - https://www.googleapis.com/auth/cloud-platform - https://www.googleapis.com/auth/userinfo.email If not using default scopes, you need at least: https://www.googleapis.com/auth/compute
final
shieldedInstanceConfig → ShieldedInstanceConfigResponse
Optional. Shielded VM configuration. Images using supported Shielded VM features.
final
state → String
The state of this instance.
final
subnet → String
The name of the subnet that this instance is in. Format: projects/{project_id}/regions/{region}/subnetworks/{subnetwork_id}
final
tags → List<String>
Optional. The Compute Engine tags to add to runtime (see Tagging instances).
final
updateTime → String
Instance update time.
final
upgradeHistory → List<UpgradeHistoryEntryResponse>
The upgrade history of this instance.
final
vmImage → VmImageResponse
Use a Compute Engine VM image to start the notebook instance.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toMap() → Map<String, dynamic>
toString() → String
A string representation of this object.
inherited

Operators

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