GetDiskComputeV1Result class

Result data returned by getDisk.

Constructors

GetDiskComputeV1Result({required String architecture, required DiskAsyncReplicationResponseComputeV1 asyncPrimaryDisk, required Map<String, String> asyncSecondaryDisks, required String creationTimestamp, required String description, required CustomerEncryptionKeyResponseComputeV1 diskEncryptionKey, required List<GuestOsFeatureResponseComputeV1> guestOsFeatures, required String kind, required String labelFingerprint, required Map<String, String> labels, required String lastAttachTimestamp, required String lastDetachTimestamp, required List<String> licenseCodes, required List<String> licenses, required String locationHint, required String name, required String options, required DiskParamsResponseComputeV1 params, required String physicalBlockSizeBytes, required String provisionedIops, required String provisionedThroughput, required String region, required List<String> replicaZones, required List<String> resourcePolicies, required DiskResourceStatusResponseComputeV1 resourceStatus, required bool satisfiesPzs, required String selfLink, required String sizeGb, required String sourceConsistencyGroupPolicy, required String sourceConsistencyGroupPolicyId, required String sourceDisk, required String sourceDiskId, required String sourceImage, required CustomerEncryptionKeyResponseComputeV1 sourceImageEncryptionKey, required String sourceImageId, required String sourceSnapshot, required CustomerEncryptionKeyResponseComputeV1 sourceSnapshotEncryptionKey, required String sourceSnapshotId, required String sourceStorageObject, required String status, required String type, required List<String> users, required String zone})
Creates a new GetDiskComputeV1Result. architecture The architecture of the disk. Valid values are ARM64 or X86_64. asyncPrimaryDisk Disk asynchronously replicated into this disk. asyncSecondaryDisks A list of disks this disk is asynchronously replicated to. creationTimestamp Creation timestamp in RFC3339 text format. description An optional description of this resource. Provide this property when you create the resource. diskEncryptionKey Encrypts the disk using a customer-supplied encryption key or a customer-managed encryption key. Encryption keys do not protect access to metadata of the disk. After you encrypt a disk with a customer-supplied key, you must provide the same key if you use the disk later. For example, to create a disk snapshot, to create a disk image, to create a machine image, or to attach the disk to a virtual machine. After you encrypt a disk with a customer-managed key, the diskEncryptionKey.kmsKeyName is set to a key version name once the disk is created. The disk is encrypted with this version of the key. In the response, diskEncryptionKey.kmsKeyName appears in the following format: "diskEncryptionKey.kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ key_region/cryptoKeys/key /cryptoKeysVersions/version If you do not provide an encryption key when creating the disk, then the disk is encrypted using an automatically generated key and you don't need to provide a key to use the disk later. guestOsFeatures A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options. kind Type of the resource. Always compute#disk for disks. labelFingerprint A fingerprint for the labels being applied to this disk, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a disk. labels Labels to apply to this disk. These can be later modified by the setLabels method. lastAttachTimestamp Last attach timestamp in RFC3339 text format. lastDetachTimestamp Last detach timestamp in RFC3339 text format. licenseCodes Integer license codes indicating which licenses are attached to this disk. licenses A list of publicly visible licenses. Reserved for Google's use. locationHint An opaque location hint used to place the disk close to other resources. This field is for use by internal tools that use the public API. name Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. options Internal use only. params Input only. Input Only Additional params passed with the request, but not persisted as part of resource payload. physicalBlockSizeBytes Physical block size of the persistent disk, in bytes. If not present in a request, a default value is used. The currently supported size is 4096, other sizes may be added in the future. If an unsupported value is requested, the error message will list the supported values for the caller's project. provisionedIops Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. Values must be between 10,000 and 120,000. For more details, see the Extreme persistent disk documentation. provisionedThroughput Indicates how much throughput to provision for the disk. This sets the number of throughput mb per second that the disk can handle. Values must be between 1 and 7,124. region URL of the region where the disk resides. Only applicable for regional resources. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. replicaZones URLs of the zones where the disk should be replicated to. Only applicable for regional resources. resourcePolicies Resource policies applied to this disk for automatic snapshot creations. resourceStatus Status information for the disk resource. satisfiesPzs Reserved for future use. selfLink Server-defined fully-qualified URL for this resource. sizeGb Size, in GB, of the persistent disk. You can specify this field when creating a persistent disk using the sourceImage, sourceSnapshot, or sourceDisk parameter, or specify it alone to create an empty persistent disk. If you specify this field along with a source, the value of sizeGb must not be less than the size of the source. Acceptable values are greater than 0. sourceConsistencyGroupPolicy URL of the DiskConsistencyGroupPolicy for a secondary disk that was created using a consistency group. sourceConsistencyGroupPolicyId ID of the DiskConsistencyGroupPolicy for a secondary disk that was created using a consistency group. sourceDisk The source disk used to create this disk. You can provide this as a partial or full URL to the resource. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /disks/disk - https://www.googleapis.com/compute/v1/projects/project/regions/region /disks/disk - projects/project/zones/zone/disks/disk - projects/project/regions/region/disks/disk - zones/zone/disks/disk - regions/region/disks/disk sourceDiskId The unique ID of the disk used to create this disk. This value identifies the exact disk that was used to create this persistent disk. For example, if you created the persistent disk from a disk that was later deleted and recreated under the same name, the source disk ID would identify the exact version of the disk that was used. sourceImage The source image used to create this disk. If the source image is deleted, this field will not be set. To create a disk with one of the public operating system images, specify the image by its family name. For example, specify family/debian-9 to use the latest Debian 9 image: projects/debian-cloud/global/images/family/debian-9 Alternatively, use a specific version of a public operating system image: projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD To create a disk with a custom image that you created, specify the image name in the following format: global/images/my-custom-image You can also specify a custom image by its image family, which returns the latest version of the image in that family. Replace the image name with family/family-name: global/images/family/my-image-family sourceImageEncryptionKey The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key. sourceImageId The ID value of the image used to create this disk. This value identifies the exact image that was used to create this persistent disk. For example, if you created the persistent disk from an image that was later deleted and recreated under the same name, the source image ID would identify the exact version of the image that was used. sourceSnapshot The source snapshot used to create this disk. You can provide this as a partial or full URL to the resource. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project /global/snapshots/snapshot - projects/project/global/snapshots/snapshot - global/snapshots/snapshot sourceSnapshotEncryptionKey The customer-supplied encryption key of the source snapshot. Required if the source snapshot is protected by a customer-supplied encryption key. sourceSnapshotId The unique ID of the snapshot used to create this disk. This value identifies the exact snapshot that was used to create this persistent disk. For example, if you created the persistent disk from a snapshot that was later deleted and recreated under the same name, the source snapshot ID would identify the exact version of the snapshot that was used. sourceStorageObject The full Google Cloud Storage URI where the disk image is stored. This file must be a gzip-compressed tarball whose name ends in .tar.gz or virtual machine disk whose name ends in vmdk. Valid URIs may start with gs:// or https://storage.googleapis.com/. This flag is not optimized for creating multiple disks from a source storage object. To create many disks from a source storage object, use gcloud compute images import instead. status The status of disk creation. - CREATING: Disk is provisioning. - RESTORING: Source data is being copied into the disk. - FAILED: Disk creation failed. - READY: Disk is ready for use. - DELETING: Disk is deleting. type URL of the disk type resource describing which disk type to use to create the disk. Provide this when creating the disk. For example: projects/project /zones/zone/diskTypes/pd-ssd . See Persistent disk types. users Links to the users of the disk (attached instances) in form: projects/project/zones/zone/instances/instance zone URL of the zone where the disk resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
const
GetDiskComputeV1Result.fromMap(Map<String, dynamic> map)
factory

Properties

architecture → String
The architecture of the disk. Valid values are ARM64 or X86_64.
final
asyncPrimaryDisk → DiskAsyncReplicationResponseComputeV1
Disk asynchronously replicated into this disk.
final
asyncSecondaryDisks → Map<String, String>
A list of disks this disk is asynchronously replicated to.
final
creationTimestamp → String
Creation timestamp in RFC3339 text format.
final
description → String
An optional description of this resource. Provide this property when you create the resource.
final
diskEncryptionKey → CustomerEncryptionKeyResponseComputeV1
Encrypts the disk using a customer-supplied encryption key or a customer-managed encryption key. Encryption keys do not protect access to metadata of the disk. After you encrypt a disk with a customer-supplied key, you must provide the same key if you use the disk later. For example, to create a disk snapshot, to create a disk image, to create a machine image, or to attach the disk to a virtual machine. After you encrypt a disk with a customer-managed key, the diskEncryptionKey.kmsKeyName is set to a key version name once the disk is created. The disk is encrypted with this version of the key. In the response, diskEncryptionKey.kmsKeyName appears in the following format: "diskEncryptionKey.kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ key_region/cryptoKeys/key /cryptoKeysVersions/version If you do not provide an encryption key when creating the disk, then the disk is encrypted using an automatically generated key and you don't need to provide a key to use the disk later.
final
guestOsFeatures → List<GuestOsFeatureResponseComputeV1>
A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options.
final
hashCode → int
The hash code for this object.
no setterinherited
kind → String
Type of the resource. Always compute#disk for disks.
final
labelFingerprint → String
A fingerprint for the labels being applied to this disk, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a disk.
final
labels → Map<String, String>
Labels to apply to this disk. These can be later modified by the setLabels method.
final
lastAttachTimestamp → String
Last attach timestamp in RFC3339 text format.
final
lastDetachTimestamp → String
Last detach timestamp in RFC3339 text format.
final
licenseCodes → List<String>
Integer license codes indicating which licenses are attached to this disk.
final
licenses → List<String>
A list of publicly visible licenses. Reserved for Google's use.
final
locationHint → String
An opaque location hint used to place the disk close to other resources. This field is for use by internal tools that use the public API.
final
name → String
Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
final
options → String
Internal use only.
final
params → DiskParamsResponseComputeV1
Input only. Input Only Additional params passed with the request, but not persisted as part of resource payload.
final
physicalBlockSizeBytes → String
Physical block size of the persistent disk, in bytes. If not present in a request, a default value is used. The currently supported size is 4096, other sizes may be added in the future. If an unsupported value is requested, the error message will list the supported values for the caller's project.
final
provisionedIops → String
Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. Values must be between 10,000 and 120,000. For more details, see the Extreme persistent disk documentation.
final
provisionedThroughput → String
Indicates how much throughput to provision for the disk. This sets the number of throughput mb per second that the disk can handle. Values must be between 1 and 7,124.
final
region → String
URL of the region where the disk resides. Only applicable for regional resources. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
final
replicaZones → List<String>
URLs of the zones where the disk should be replicated to. Only applicable for regional resources.
final
resourcePolicies → List<String>
Resource policies applied to this disk for automatic snapshot creations.
final
resourceStatus → DiskResourceStatusResponseComputeV1
Status information for the disk resource.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
satisfiesPzs → bool
Reserved for future use.
final
Server-defined fully-qualified URL for this resource.
final
sizeGb → String
Size, in GB, of the persistent disk. You can specify this field when creating a persistent disk using the sourceImage, sourceSnapshot, or sourceDisk parameter, or specify it alone to create an empty persistent disk. If you specify this field along with a source, the value of sizeGb must not be less than the size of the source. Acceptable values are greater than 0.
final
sourceConsistencyGroupPolicy → String
URL of the DiskConsistencyGroupPolicy for a secondary disk that was created using a consistency group.
final
sourceConsistencyGroupPolicyId → String
ID of the DiskConsistencyGroupPolicy for a secondary disk that was created using a consistency group.
final
sourceDisk → String
The source disk used to create this disk. You can provide this as a partial or full URL to the resource. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /disks/disk - https://www.googleapis.com/compute/v1/projects/project/regions/region /disks/disk - projects/project/zones/zone/disks/disk - projects/project/regions/region/disks/disk - zones/zone/disks/disk - regions/region/disks/disk
final
sourceDiskId → String
The unique ID of the disk used to create this disk. This value identifies the exact disk that was used to create this persistent disk. For example, if you created the persistent disk from a disk that was later deleted and recreated under the same name, the source disk ID would identify the exact version of the disk that was used.
final
sourceImage → String
The source image used to create this disk. If the source image is deleted, this field will not be set. To create a disk with one of the public operating system images, specify the image by its family name. For example, specify family/debian-9 to use the latest Debian 9 image: projects/debian-cloud/global/images/family/debian-9 Alternatively, use a specific version of a public operating system image: projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD To create a disk with a custom image that you created, specify the image name in the following format: global/images/my-custom-image You can also specify a custom image by its image family, which returns the latest version of the image in that family. Replace the image name with family/family-name: global/images/family/my-image-family
final
sourceImageEncryptionKey → CustomerEncryptionKeyResponseComputeV1
The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key.
final
sourceImageId → String
The ID value of the image used to create this disk. This value identifies the exact image that was used to create this persistent disk. For example, if you created the persistent disk from an image that was later deleted and recreated under the same name, the source image ID would identify the exact version of the image that was used.
final
sourceSnapshot → String
The source snapshot used to create this disk. You can provide this as a partial or full URL to the resource. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project /global/snapshots/snapshot - projects/project/global/snapshots/snapshot - global/snapshots/snapshot
final
sourceSnapshotEncryptionKey → CustomerEncryptionKeyResponseComputeV1
The customer-supplied encryption key of the source snapshot. Required if the source snapshot is protected by a customer-supplied encryption key.
final
sourceSnapshotId → String
The unique ID of the snapshot used to create this disk. This value identifies the exact snapshot that was used to create this persistent disk. For example, if you created the persistent disk from a snapshot that was later deleted and recreated under the same name, the source snapshot ID would identify the exact version of the snapshot that was used.
final
sourceStorageObject → String
The full Google Cloud Storage URI where the disk image is stored. This file must be a gzip-compressed tarball whose name ends in .tar.gz or virtual machine disk whose name ends in vmdk. Valid URIs may start with gs:// or https://storage.googleapis.com/. This flag is not optimized for creating multiple disks from a source storage object. To create many disks from a source storage object, use gcloud compute images import instead.
final
status → String
The status of disk creation. - CREATING: Disk is provisioning. - RESTORING: Source data is being copied into the disk. - FAILED: Disk creation failed. - READY: Disk is ready for use. - DELETING: Disk is deleting.
final
type → String
URL of the disk type resource describing which disk type to use to create the disk. Provide this when creating the disk. For example: projects/project /zones/zone/diskTypes/pd-ssd . See Persistent disk types.
final
users → List<String>
Links to the users of the disk (attached instances) in form: projects/project/zones/zone/instances/instance
final
zone → String
URL of the zone where the disk resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
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