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.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ MachineImage

Returns a new instance of MachineImage.



20726
20727
20728
 
# File 'lib/google/apis/compute_beta/classes.rb', line 20726

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) 


20616
20617
20618
 
# File 'lib/google/apis/compute_beta/classes.rb', line 20616

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) 


20622
20623
20624
 
# File 'lib/google/apis/compute_beta/classes.rb', line 20622

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) 


20628
20629
20630
 
# File 'lib/google/apis/compute_beta/classes.rb', line 20628

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) 


20635
20636
20637
 
# File 'lib/google/apis/compute_beta/classes.rb', line 20635

def id
  @id
end

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

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

Returns:



20640
20641
20642
 
# File 'lib/google/apis/compute_beta/classes.rb', line 20640

def instance_properties
  @instance_properties
end

#kind ⇒ String

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

Returns:

  • (String) 


20646
20647
20648
 
# File 'lib/google/apis/compute_beta/classes.rb', line 20646

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:



20659
20660
20661
 
# File 'lib/google/apis/compute_beta/classes.rb', line 20659

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) 


20669
20670
20671
 
# File 'lib/google/apis/compute_beta/classes.rb', line 20669

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) 


20674
20675
20676
 
# File 'lib/google/apis/compute_beta/classes.rb', line 20674

def satisfies_pzs
  @satisfies_pzs
end

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

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

Returns:



20681
20682
20683
 
# File 'lib/google/apis/compute_beta/classes.rb', line 20681

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


20686
20687
20688
 
# File 'lib/google/apis/compute_beta/classes.rb', line 20686

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:



20693
20694
20695
 
# File 'lib/google/apis/compute_beta/classes.rb', line 20693

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) 


20701
20702
20703
 
# File 'lib/google/apis/compute_beta/classes.rb', line 20701

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:



20707
20708
20709
 
# File 'lib/google/apis/compute_beta/classes.rb', line 20707

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) 


20713
20714
20715
 
# File 'lib/google/apis/compute_beta/classes.rb', line 20713

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


20719
20720
20721
 
# File 'lib/google/apis/compute_beta/classes.rb', line 20719

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) 


20724
20725
20726
 
# File 'lib/google/apis/compute_beta/classes.rb', line 20724

def total_storage_bytes
  @total_storage_bytes
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



20731
20732
20733
20734
20735
20736
20737
20738
20739
20740
20741
20742
20743
20744
20745
20746
20747
20748
20749
 
# File 'lib/google/apis/compute_beta/classes.rb', line 20731

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