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

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Google::Apis::Core::JsonObjectSupport

#to_json

Methods included from Google::Apis::Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ MachineImage

Returns a new instance of MachineImage.



17626
17627
17628
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 17626

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) 


17535
17536
17537
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 17535

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) 


17541
17542
17543
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 17541

def description
  @description
end

#guest_flush ⇒ Boolean Also known as: guest_flush?

[Input Only] Specifies to create 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) 


17548
17549
17550
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 17548

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) 


17555
17556
17557
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 17555

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) 


17561
17562
17563
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 17561

def kind
  @kind
end

#machine_image_encryption_key ⇒ Google::Apis::ComputeAlpha::CustomerEncryptionKey

Represents a customer-supplied encryption key Corresponds to the JSON property machineImageEncryptionKey

Returns:



17566
17567
17568
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 17566

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) 


17576
17577
17578
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 17576

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


17581
17582
17583
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 17581

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) 


17586
17587
17588
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 17586

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:



17593
17594
17595
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 17593

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) 


17603
17604
17605
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 17603

def source_instance
  @source_instance
end

#source_instance_properties ⇒ Google::Apis::ComputeAlpha::SourceInstanceProperties

Corresponds to the JSON property sourceInstanceProperties

Returns:



17608
17609
17610
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 17608

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) 


17614
17615
17616
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 17614

def status
  @status
end

#storage_locations ⇒ Array<String>

GCS bucket storage location of the machine image (regional or multi-regional). Corresponds to the JSON property storageLocations

Returns:

  • (Array<String>) 


17619
17620
17621
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 17619

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) 


17624
17625
17626
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 17624

def total_storage_bytes
  @total_storage_bytes
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



17631
17632
17633
17634
17635
17636
17637
17638
17639
17640
17641
17642
17643
17644
17645
17646
17647
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 17631

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