Class: Google::Apis::ComputeAlpha::MachineImage
- Inherits:
-
Object
- Object
- Google::Apis::ComputeAlpha::MachineImage
- Includes:
- Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
- Defined in:
- lib/google/apis/compute_alpha/classes.rb,
lib/google/apis/compute_alpha/representations.rb,
lib/google/apis/compute_alpha/representations.rb
Overview
Represents a machine image resource. A machine image is a Compute Engine resource that stores all the configuration, metadata, permissions, and data from one or more disks required to create a Virtual machine (VM) instance. For more information, see Machine images.
Instance Attribute Summary collapse
-
#creation_timestamp ⇒ String
[Output Only] The creation timestamp for this machine image in RFC3339 text format.
-
#description ⇒ String
An optional description of this resource.
-
#guest_flush ⇒ Boolean
(also: #guest_flush?)
[Input Only] Whether to attempt an application consistent machine image by informing the OS to prepare for the snapshot process.
-
#id ⇒ Fixnum
[Output Only] A unique identifier for this machine image.
-
#kind ⇒ String
[Output Only] The resource type, which is always compute#machineImage for machine image.
-
#machine_image_encryption_key ⇒ Google::Apis::ComputeAlpha::CustomerEncryptionKey
Encrypts the machine image using a customer-supplied encryption key.
-
#name ⇒ String
Name of the resource; provided by the client when the resource is created.
-
#satisfies_pzs ⇒ Boolean
(also: #satisfies_pzs?)
[Output Only] Reserved for future use.
-
#self_link ⇒ String
[Output Only] The URL for this machine image.
-
#self_link_with_id ⇒ String
[Output Only] Server-defined URL for this resource with the resource id.
-
#source_disk_encryption_keys ⇒ Array<Google::Apis::ComputeAlpha::SourceDiskEncryptionKey>
[Input Only] The customer-supplied encryption key of the disks attached to the source instance.
-
#source_instance ⇒ String
The source instance used to create the machine image.
-
#source_instance_properties ⇒ Google::Apis::ComputeAlpha::SourceInstanceProperties
[Output Only] Properties of source instance.
-
#status ⇒ String
[Output Only] The status of the machine image.
-
#storage_locations ⇒ Array<String>
The regional or multi-regional Cloud Storage bucket location where the machine image is stored.
-
#total_storage_bytes ⇒ Fixnum
[Output Only] Total size of the storage used by the machine image.
Instance Method Summary collapse
-
#initialize(**args) ⇒ MachineImage
constructor
A new instance of MachineImage.
-
#update!(**args) ⇒ Object
Update properties of this object.
Constructor Details
#initialize(**args) ⇒ MachineImage
Returns a new instance of MachineImage.
21392 21393 21394 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 21392 def initialize(**args) update!(**args) end |
Instance Attribute Details
#creation_timestamp ⇒ String
[Output Only] The creation timestamp for this machine image in RFC3339 text
format.
Corresponds to the JSON property creationTimestamp
21288 21289 21290 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 21288 def @creation_timestamp end |
#description ⇒ String
An optional description of this resource. Provide this property when you
create the resource.
Corresponds to the JSON property description
21294 21295 21296 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 21294 def description @description end |
#guest_flush ⇒ Boolean Also known as: guest_flush?
[Input Only] Whether to attempt an application consistent machine image by
informing the OS to prepare for the snapshot process. Currently only supported
on Windows instances using the Volume Shadow Copy Service (VSS).
Corresponds to the JSON property guestFlush
21301 21302 21303 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 21301 def guest_flush @guest_flush end |
#id ⇒ Fixnum
[Output Only] A unique identifier for this machine image. The server defines
this identifier.
Corresponds to the JSON property id
21308 21309 21310 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 21308 def id @id end |
#kind ⇒ String
[Output Only] The resource type, which is always compute#machineImage for
machine image.
Corresponds to the JSON property kind
21314 21315 21316 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 21314 def kind @kind end |
#machine_image_encryption_key ⇒ Google::Apis::ComputeAlpha::CustomerEncryptionKey
Encrypts the machine image using a customer-supplied encryption key. After you
encrypt a machine image using a customer-supplied key, you must provide the
same key if you use the machine image later. For example, you must provide the
encryption key when you create an instance from the encrypted machine image in
a future request. Customer-supplied encryption keys do not protect access to
metadata of the machine image. If you do not provide an encryption key when
creating the machine image, then the machine image will be encrypted using an
automatically generated key and you do not need to provide a key to use the
machine image later.
Corresponds to the JSON property machineImageEncryptionKey
21327 21328 21329 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 21327 def machine_image_encryption_key @machine_image_encryption_key end |
#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.
Corresponds to the JSON property name
21337 21338 21339 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 21337 def name @name end |
#satisfies_pzs ⇒ Boolean Also known as: satisfies_pzs?
[Output Only] Reserved for future use.
Corresponds to the JSON property satisfiesPzs
21342 21343 21344 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 21342 def satisfies_pzs @satisfies_pzs end |
#self_link ⇒ String
[Output Only] The URL for this machine image. The server defines this URL.
Corresponds to the JSON property selfLink
21348 21349 21350 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 21348 def self_link @self_link end |
#self_link_with_id ⇒ String
[Output Only] Server-defined URL for this resource with the resource id.
Corresponds to the JSON property selfLinkWithId
21353 21354 21355 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 21353 def self_link_with_id @self_link_with_id end |
#source_disk_encryption_keys ⇒ Array<Google::Apis::ComputeAlpha::SourceDiskEncryptionKey>
[Input Only] The customer-supplied encryption key of the disks attached to the
source instance. Required if the source disk is protected by a customer-
supplied encryption key.
Corresponds to the JSON property sourceDiskEncryptionKeys
21360 21361 21362 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 21360 def source_disk_encryption_keys @source_disk_encryption_keys end |
#source_instance ⇒ String
The source instance used to create the machine image. 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 /
instances/instance - projects/project/zones/zone/instances/instance
Corresponds to the JSON property sourceInstance
21368 21369 21370 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 21368 def source_instance @source_instance end |
#source_instance_properties ⇒ Google::Apis::ComputeAlpha::SourceInstanceProperties
[Output Only] Properties of source instance.
Corresponds to the JSON property sourceInstanceProperties
21373 21374 21375 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 21373 def source_instance_properties @source_instance_properties end |
#status ⇒ String
[Output Only] The status of the machine image. One of the following values:
INVALID, CREATING, READY, DELETING, and UPLOADING.
Corresponds to the JSON property status
21379 21380 21381 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 21379 def status @status end |
#storage_locations ⇒ Array<String>
The regional or multi-regional Cloud Storage bucket location where the machine
image is stored.
Corresponds to the JSON property storageLocations
21385 21386 21387 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 21385 def storage_locations @storage_locations end |
#total_storage_bytes ⇒ Fixnum
[Output Only] Total size of the storage used by the machine image.
Corresponds to the JSON property totalStorageBytes
21390 21391 21392 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 21390 def total_storage_bytes @total_storage_bytes end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
21397 21398 21399 21400 21401 21402 21403 21404 21405 21406 21407 21408 21409 21410 21411 21412 21413 21414 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 21397 def update!(**args) @creation_timestamp = args[:creation_timestamp] if args.key?(:creation_timestamp) @description = args[:description] if args.key?(:description) @guest_flush = args[:guest_flush] if args.key?(:guest_flush) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @machine_image_encryption_key = args[:machine_image_encryption_key] if args.key?(:machine_image_encryption_key) @name = args[:name] if args.key?(:name) @satisfies_pzs = args[:satisfies_pzs] if args.key?(:satisfies_pzs) @self_link = args[:self_link] if args.key?(:self_link) @self_link_with_id = args[:self_link_with_id] if args.key?(:self_link_with_id) @source_disk_encryption_keys = args[:source_disk_encryption_keys] if args.key?(:source_disk_encryption_keys) @source_instance = args[:source_instance] if args.key?(:source_instance) @source_instance_properties = args[:source_instance_properties] if args.key?(:source_instance_properties) @status = args[:status] if args.key?(:status) @storage_locations = args[:storage_locations] if args.key?(:storage_locations) @total_storage_bytes = args[:total_storage_bytes] if args.key?(:total_storage_bytes) end |