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, seeMachine images.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ MachineImage

Returns a new instance of MachineImage.



36524
36525
36526
 
# File 'lib/google/apis/compute_beta/classes.rb', line 36524

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#creation_timestamp ⇒ String

Output only. [Output Only] The creation timestamp for this machine image inRFC3339 text format. Corresponds to the JSON property creationTimestamp

Returns:

  • (String) 


36374
36375
36376
 
# File 'lib/google/apis/compute_beta/classes.rb', line 36374

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) 


36380
36381
36382
 
# File 'lib/google/apis/compute_beta/classes.rb', line 36380

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. Corresponds to the JSON property guestFlush

Returns:

  • (Boolean) 


36386
36387
36388
 
# File 'lib/google/apis/compute_beta/classes.rb', line 36386

def guest_flush
  @guest_flush
end

#id ⇒ Fixnum

Output only. [Output Only] A unique identifier for this machine image. The server defines this identifier. Corresponds to the JSON property id

Returns:

  • (Fixnum) 


36394
36395
36396
 
# File 'lib/google/apis/compute_beta/classes.rb', line 36394

def id
  @id
end

#instance_properties ⇒ Google::Apis::ComputeBeta::InstanceProperties

[Output Only] Properties of source instance Corresponds to the JSON property instanceProperties

Returns:



36399
36400
36401
 
# File 'lib/google/apis/compute_beta/classes.rb', line 36399

def instance_properties
  @instance_properties
end

#kind ⇒ String

Output only. [Output Only] The resource type, which is alwayscompute# machineImage for machine image. Corresponds to the JSON property kind

Returns:

  • (String) 


36405
36406
36407
 
# File 'lib/google/apis/compute_beta/classes.rb', line 36405

def kind
  @kind
end

#label_fingerprint ⇒ String

A fingerprint for the labels being applied to this machine image, 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. To see the latest fingerprint, make get() request to the machine image. Corresponds to the JSON property labelFingerprint NOTE: Values are automatically base64 encoded/decoded in the client library.

Returns:

  • (String) 


36417
36418
36419
 
# File 'lib/google/apis/compute_beta/classes.rb', line 36417

def label_fingerprint
  @label_fingerprint
end

#labels ⇒ Hash<String,String>

Labels to apply to this machine image. These can be later modified by the setLabels method. Corresponds to the JSON property labels

Returns:

  • (Hash<String,String>) 


36423
36424
36425
 
# File 'lib/google/apis/compute_beta/classes.rb', line 36423

def labels
  @labels
end

#machine_image_encryption_key ⇒ Google::Apis::ComputeBeta::CustomerEncryptionKey

Encrypts the machine image using acustomer-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:



36438
36439
36440
 
# File 'lib/google/apis/compute_beta/classes.rb', line 36438

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


36449
36450
36451
 
# File 'lib/google/apis/compute_beta/classes.rb', line 36449

def name
  @name
end

#params ⇒ Google::Apis::ComputeBeta::MachineImageParams

Machine Image parameters Corresponds to the JSON property params

Returns:



36454
36455
36456
 
# File 'lib/google/apis/compute_beta/classes.rb', line 36454

def params
  @params
end

#satisfies_pzi ⇒ Boolean Also known as: satisfies_pzi?

Output only. Reserved for future use. Corresponds to the JSON property satisfiesPzi

Returns:

  • (Boolean) 


36459
36460
36461
 
# File 'lib/google/apis/compute_beta/classes.rb', line 36459

def satisfies_pzi
  @satisfies_pzi
end

#satisfies_pzs ⇒ Boolean Also known as: satisfies_pzs?

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

Returns:

  • (Boolean) 


36465
36466
36467
 
# File 'lib/google/apis/compute_beta/classes.rb', line 36465

def satisfies_pzs
  @satisfies_pzs
end

#saved_disks ⇒ Array<Google::Apis::ComputeBeta::SavedDisk>

Output only. An array of Machine Image specific properties for disks attached to the source instance Corresponds to the JSON property savedDisks

Returns:



36473
36474
36475
 
# File 'lib/google/apis/compute_beta/classes.rb', line 36473

def saved_disks
  @saved_disks
end

#self_link ⇒ String

Output only. [Output Only] The URL for this machine image. The server defines this URL. Corresponds to the JSON property selfLink

Returns:

  • (String) 


36479
36480
36481
 
# File 'lib/google/apis/compute_beta/classes.rb', line 36479

def self_link
  @self_link
end

#source_disk_encryption_keys ⇒ Array<Google::Apis::ComputeBeta::SourceDiskEncryptionKey>

[Input Only] Thecustomer-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:



36486
36487
36488
 
# File 'lib/google/apis/compute_beta/classes.rb', line 36486

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) 


36498
36499
36500
 
# File 'lib/google/apis/compute_beta/classes.rb', line 36498

def source_instance
  @source_instance
end

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

DEPRECATED: Please use compute#instanceProperties instead. New properties will not be added to this field. Corresponds to the JSON property sourceInstanceProperties

Returns:



36504
36505
36506
 
# File 'lib/google/apis/compute_beta/classes.rb', line 36504

def source_instance_properties
  @source_instance_properties
end

#status ⇒ String

Output only. [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) 


36510
36511
36512
 
# File 'lib/google/apis/compute_beta/classes.rb', line 36510

def status
  @status
end

#storage_locations ⇒ Array<String>

The regional or multi-regional Cloud Storage bucket location where themachine image is stored. Corresponds to the JSON property storageLocations

Returns:

  • (Array<String>) 


36517
36518
36519
 
# File 'lib/google/apis/compute_beta/classes.rb', line 36517

def storage_locations
  @storage_locations
end

#total_storage_bytes ⇒ Fixnum

Output only. [Output Only] Total size of the storage used by the machine image. Corresponds to the JSON property totalStorageBytes

Returns:

  • (Fixnum) 


36522
36523
36524
 
# File 'lib/google/apis/compute_beta/classes.rb', line 36522

def total_storage_bytes
  @total_storage_bytes
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



36529
36530
36531
36532
36533
36534
36535
36536
36537
36538
36539
36540
36541
36542
36543
36544
36545
36546
36547
36548
36549
36550
36551
 
# File 'lib/google/apis/compute_beta/classes.rb', line 36529

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)
  @instance_properties = args[:instance_properties] if args.key?(:instance_properties)
  @kind = args[:kind] if args.key?(:kind)
  @label_fingerprint = args[:label_fingerprint] if args.key?(:label_fingerprint)
  @labels = args[:labels] if args.key?(:labels)
  @machine_image_encryption_key = args[:machine_image_encryption_key] if args.key?(:machine_image_encryption_key)
  @name = args[:name] if args.key?(:name)
  @params = args[:params] if args.key?(:params)
  @satisfies_pzi = args[:satisfies_pzi] if args.key?(:satisfies_pzi)
  @satisfies_pzs = args[:satisfies_pzs] if args.key?(:satisfies_pzs)
  @saved_disks = args[:saved_disks] if args.key?(:saved_disks)
  @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