Class: Google::Apis::ComputeV1::MachineImage

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
lib/google/apis/compute_v1/classes.rb,
lib/google/apis/compute_v1/representations.rb,
lib/google/apis/compute_v1/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.



21847
21848
21849
 
# File 'lib/google/apis/compute_v1/classes.rb', line 21847

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) 


21731
21732
21733
 
# File 'lib/google/apis/compute_v1/classes.rb', line 21731

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) 


21737
21738
21739
 
# File 'lib/google/apis/compute_v1/classes.rb', line 21737

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) 


21743
21744
21745
 
# File 'lib/google/apis/compute_v1/classes.rb', line 21743

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) 


21750
21751
21752
 
# File 'lib/google/apis/compute_v1/classes.rb', line 21750

def id
  @id
end

#instance_properties ⇒ Google::Apis::ComputeV1::InstanceProperties

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

Returns:



21755
21756
21757
 
# File 'lib/google/apis/compute_v1/classes.rb', line 21755

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) 


21761
21762
21763
 
# File 'lib/google/apis/compute_v1/classes.rb', line 21761

def kind
  @kind
end

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



21774
21775
21776
 
# File 'lib/google/apis/compute_v1/classes.rb', line 21774

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) 


21784
21785
21786
 
# File 'lib/google/apis/compute_v1/classes.rb', line 21784

def name
  @name
end

#satisfies_pzi ⇒ Boolean Also known as: satisfies_pzi?

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

Returns:

  • (Boolean) 


21789
21790
21791
 
# File 'lib/google/apis/compute_v1/classes.rb', line 21789

def satisfies_pzi
  @satisfies_pzi
end

#satisfies_pzs ⇒ Boolean Also known as: satisfies_pzs?

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

Returns:

  • (Boolean) 


21795
21796
21797
 
# File 'lib/google/apis/compute_v1/classes.rb', line 21795

def satisfies_pzs
  @satisfies_pzs
end

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

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

Returns:



21802
21803
21804
 
# File 'lib/google/apis/compute_v1/classes.rb', line 21802

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) 


21807
21808
21809
 
# File 'lib/google/apis/compute_v1/classes.rb', line 21807

def self_link
  @self_link
end

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



21814
21815
21816
 
# File 'lib/google/apis/compute_v1/classes.rb', line 21814

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) 


21822
21823
21824
 
# File 'lib/google/apis/compute_v1/classes.rb', line 21822

def source_instance
  @source_instance
end

#source_instance_properties ⇒ Google::Apis::ComputeV1::SourceInstanceProperties

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

Returns:



21828
21829
21830
 
# File 'lib/google/apis/compute_v1/classes.rb', line 21828

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) 


21834
21835
21836
 
# File 'lib/google/apis/compute_v1/classes.rb', line 21834

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


21840
21841
21842
 
# File 'lib/google/apis/compute_v1/classes.rb', line 21840

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) 


21845
21846
21847
 
# File 'lib/google/apis/compute_v1/classes.rb', line 21845

def total_storage_bytes
  @total_storage_bytes
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



21852
21853
21854
21855
21856
21857
21858
21859
21860
21861
21862
21863
21864
21865
21866
21867
21868
21869
21870
21871
 
# File 'lib/google/apis/compute_v1/classes.rb', line 21852

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