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

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

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.



16194
16195
16196
 
# File 'generated/google/apis/compute_beta/classes.rb', line 16194

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) 


16108
16109
16110
 
# File 'generated/google/apis/compute_beta/classes.rb', line 16108

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) 


16114
16115
16116
 
# File 'generated/google/apis/compute_beta/classes.rb', line 16114

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) 


16121
16122
16123
 
# File 'generated/google/apis/compute_beta/classes.rb', line 16121

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) 


16128
16129
16130
 
# File 'generated/google/apis/compute_beta/classes.rb', line 16128

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) 


16134
16135
16136
 
# File 'generated/google/apis/compute_beta/classes.rb', line 16134

def kind
  @kind
end

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

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

Returns:



16139
16140
16141
 
# File 'generated/google/apis/compute_beta/classes.rb', line 16139

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) 


16149
16150
16151
 
# File 'generated/google/apis/compute_beta/classes.rb', line 16149

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) 


16154
16155
16156
 
# File 'generated/google/apis/compute_beta/classes.rb', line 16154

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:



16161
16162
16163
 
# File 'generated/google/apis/compute_beta/classes.rb', line 16161

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) 


16171
16172
16173
 
# File 'generated/google/apis/compute_beta/classes.rb', line 16171

def source_instance
  @source_instance
end

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

Corresponds to the JSON property sourceInstanceProperties

Returns:



16176
16177
16178
 
# File 'generated/google/apis/compute_beta/classes.rb', line 16176

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) 


16182
16183
16184
 
# File 'generated/google/apis/compute_beta/classes.rb', line 16182

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


16187
16188
16189
 
# File 'generated/google/apis/compute_beta/classes.rb', line 16187

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) 


16192
16193
16194
 
# File 'generated/google/apis/compute_beta/classes.rb', line 16192

def total_storage_bytes
  @total_storage_bytes
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



16199
16200
16201
16202
16203
16204
16205
16206
16207
16208
16209
16210
16211
16212
16213
16214
 
# File 'generated/google/apis/compute_beta/classes.rb', line 16199

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