Class: Google::Apis::ComputeBeta::MachineImage

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
lib/google/apis/compute_beta/classes.rb,
lib/google/apis/compute_beta/representations.rb,
lib/google/apis/compute_beta/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. (== resource_for $api_version.machineImages ==)

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ MachineImage

Returns a new instance of MachineImage.



18311
18312
18313
 
# File 'lib/google/apis/compute_beta/classes.rb', line 18311

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) 


18209
18210
18211
 
# File 'lib/google/apis/compute_beta/classes.rb', line 18209

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) 


18215
18216
18217
 
# File 'lib/google/apis/compute_beta/classes.rb', line 18215

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) 


18222
18223
18224
 
# File 'lib/google/apis/compute_beta/classes.rb', line 18222

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) 


18229
18230
18231
 
# File 'lib/google/apis/compute_beta/classes.rb', line 18229

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) 


18235
18236
18237
 
# File 'lib/google/apis/compute_beta/classes.rb', line 18235

def kind
  @kind
end

#machine_image_encryption_key ⇒ Google::Apis::ComputeBeta::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:



18249
18250
18251
 
# File 'lib/google/apis/compute_beta/classes.rb', line 18249

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) 


18259
18260
18261
 
# File 'lib/google/apis/compute_beta/classes.rb', line 18259

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) 


18264
18265
18266
 
# File 'lib/google/apis/compute_beta/classes.rb', line 18264

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) 


18270
18271
18272
 
# File 'lib/google/apis/compute_beta/classes.rb', line 18270

def self_link
  @self_link
end

#source_disk_encryption_keys ⇒ Array<Google::Apis::ComputeBeta::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:



18277
18278
18279
 
# File 'lib/google/apis/compute_beta/classes.rb', line 18277

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:

Returns:

  • (String) 


18287
18288
18289
 
# File 'lib/google/apis/compute_beta/classes.rb', line 18287

def source_instance
  @source_instance
end

#source_instance_properties ⇒ Google::Apis::ComputeBeta::SourceInstanceProperties

Corresponds to the JSON property sourceInstanceProperties

Returns:



18292
18293
18294
 
# File 'lib/google/apis/compute_beta/classes.rb', line 18292

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) 


18298
18299
18300
 
# File 'lib/google/apis/compute_beta/classes.rb', line 18298

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>) 


18304
18305
18306
 
# File 'lib/google/apis/compute_beta/classes.rb', line 18304

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) 


18309
18310
18311
 
# File 'lib/google/apis/compute_beta/classes.rb', line 18309

def total_storage_bytes
  @total_storage_bytes
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



18316
18317
18318
18319
18320
18321
18322
18323
18324
18325
18326
18327
18328
18329
18330
18331
18332
 
# File 'lib/google/apis/compute_beta/classes.rb', line 18316

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)
  @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