Class: Google::Apis::ComputeAlpha::MachineImage

Inherits:
Object
  • Object
show all
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

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ MachineImage

Returns a new instance of MachineImage.



21406
21407
21408
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 21406

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

Returns:

  • (String) 


21302
21303
21304
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 21302

def creation_timestamp
  @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

Returns:

  • (String) 


21308
21309
21310
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 21308

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

Returns:

  • (Boolean) 


21315
21316
21317
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 21315

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

Returns:

  • (Fixnum) 


21322
21323
21324
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 21322

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

Returns:

  • (String) 


21328
21329
21330
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 21328

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

Returns:



21341
21342
21343
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 21341

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

Returns:

  • (String) 


21351
21352
21353
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 21351

def name
  @name
end

#satisfies_pzs ⇒ Boolean Also known as: satisfies_pzs?

[Output Only] Reserved for future use. Corresponds to the JSON property satisfiesPzs

Returns:

  • (Boolean) 


21356
21357
21358
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 21356

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

Returns:

  • (String) 


21362
21363
21364
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 21362

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

Returns:

  • (String) 


21367
21368
21369
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 21367

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

Returns:



21374
21375
21376
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 21374

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

Returns:

  • (String) 


21382
21383
21384
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 21382

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

Returns:



21387
21388
21389
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 21387

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

Returns:

  • (String) 


21393
21394
21395
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 21393

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

Returns:

  • (Array<String>) 


21399
21400
21401
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 21399

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

Returns:

  • (Fixnum) 


21404
21405
21406
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 21404

def total_storage_bytes
  @total_storage_bytes
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



21411
21412
21413
21414
21415
21416
21417
21418
21419
21420
21421
21422
21423
21424
21425
21426
21427
21428
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 21411

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