Class: Google::Apis::ComputeAlpha::Image

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

An Image resource. (== resource_for beta.images ==) (== resource_for v1.images ==)

Defined Under Namespace

Classes: RawDisk

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

Returns a new instance of Image



10187
10188
10189
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 10187

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

Instance Attribute Details

#archive_size_bytes ⇒ Fixnum

Size of the image tar.gz archive stored in Google Cloud Storage (in bytes). Corresponds to the JSON property archiveSizeBytes

Returns:

  • (Fixnum) 


9989
9990
9991
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 9989

def archive_size_bytes
  @archive_size_bytes
end

#creation_timestamp ⇒ String

[Output Only] Creation timestamp in RFC3339 text format. Corresponds to the JSON property creationTimestamp

Returns:

  • (String) 


9994
9995
9996
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 9994

def creation_timestamp
  @creation_timestamp
end

#deprecated ⇒ Google::Apis::ComputeAlpha::DeprecationStatus

Deprecation status for a public resource. Corresponds to the JSON property deprecated

Returns:



9999
10000
10001
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 9999

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


10005
10006
10007
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 10005

def description
  @description
end

#disk_size_gb ⇒ Fixnum

Size of the image when restored onto a persistent disk (in GB). Corresponds to the JSON property diskSizeGb

Returns:

  • (Fixnum) 


10010
10011
10012
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 10010

def disk_size_gb
  @disk_size_gb
end

#family ⇒ String

The name of the image family to which this image belongs. You can create disks by specifying an image family instead of a specific image name. The image family always returns its latest image that is not deprecated. The name of the image family must comply with RFC1035. Corresponds to the JSON property family

Returns:

  • (String) 


10018
10019
10020
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 10018

def family
  @family
end

#guest_os_features ⇒ Array<Google::Apis::ComputeAlpha::GuestOsFeature>

A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options. Corresponds to the JSON property guestOsFeatures

Returns:



10025
10026
10027
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 10025

def guest_os_features
  @guest_os_features
end

#id ⇒ Fixnum

[Output Only] The unique identifier for the resource. This identifier is defined by the server. Corresponds to the JSON property id

Returns:

  • (Fixnum) 


10031
10032
10033
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 10031

def id
  @id
end

#image_encryption_key ⇒ Google::Apis::ComputeAlpha::CustomerEncryptionKey

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

Returns:



10036
10037
10038
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 10036

def image_encryption_key
  @image_encryption_key
end

#kind ⇒ String

[Output Only] Type of the resource. Always compute#image for images. Corresponds to the JSON property kind

Returns:

  • (String) 


10041
10042
10043
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 10041

def kind
  @kind
end

#label_fingerprint ⇒ String

A fingerprint for the labels being applied to this image, which is essentially a hash of the labels 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, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an image. Corresponds to the JSON property labelFingerprint NOTE: Values are automatically base64 encoded/decoded in the client library.

Returns:

  • (String) 


10053
10054
10055
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 10053

def label_fingerprint
  @label_fingerprint
end

#labels ⇒ Hash<String,String>

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

Returns:

  • (Hash<String,String>) 


10059
10060
10061
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 10059

def labels
  @labels
end

#license_codes ⇒ Array<Fixnum>

Integer license codes indicating which licenses are attached to this image. Corresponds to the JSON property licenseCodes

Returns:

  • (Array<Fixnum>) 


10064
10065
10066
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 10064

def license_codes
  @license_codes
end

#licenses ⇒ Array<String>

Any applicable license URI. Corresponds to the JSON property licenses

Returns:

  • (Array<String>) 


10069
10070
10071
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 10069

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


10079
10080
10081
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 10079

def name
  @name
end

#raw_disk ⇒ Google::Apis::ComputeAlpha::Image::RawDisk

The parameters of the raw disk image. Corresponds to the JSON property rawDisk

Returns:



10084
10085
10086
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 10084

def raw_disk
  @raw_disk
end

#self_link ⇒ String

[Output Only] Server-defined URL for the resource. Corresponds to the JSON property selfLink

Returns:

  • (String) 


10089
10090
10091
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 10089

def self_link
  @self_link
end

#self_link_with_id ⇒ String

[Output Only] Server-defined URL for this resource's resource id. Corresponds to the JSON property selfLinkWithId

Returns:

  • (String) 


10094
10095
10096
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 10094

def self_link_with_id
  @self_link_with_id
end

#shielded_instance_initial_state ⇒ Google::Apis::ComputeAlpha::InitialStateConfig

Initial State for shielded instance, these are public keys which are safe to store in public Corresponds to the JSON property shieldedInstanceInitialState

Returns:



10100
10101
10102
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 10100

def shielded_instance_initial_state
  @shielded_instance_initial_state
end

#source_disk ⇒ String

URL of the source disk used to create this image. This can be a full or valid partial URL. You must provide either this property or the rawDisk.source property but not both to create an image. For example, the following are valid values:

Returns:

  • (String) 


10111
10112
10113
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 10111

def source_disk
  @source_disk
end

#source_disk_encryption_key ⇒ Google::Apis::ComputeAlpha::CustomerEncryptionKey

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

Returns:



10116
10117
10118
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 10116

def source_disk_encryption_key
  @source_disk_encryption_key
end

#source_disk_id ⇒ String

[Output Only] The ID value of the disk used to create this image. This value may be used to determine whether the image was taken from the current or a previous instance of a given disk name. Corresponds to the JSON property sourceDiskId

Returns:

  • (String) 


10123
10124
10125
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 10123

def source_disk_id
  @source_disk_id
end

#source_image ⇒ String

URL of the source image used to create this image. This can be a full or valid partial URL. You must provide exactly one of:

  • this property, or
  • the rawDisk.source property, or
  • the sourceDisk property in order to create an image. Corresponds to the JSON property sourceImage

Returns:

  • (String) 


10132
10133
10134
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 10132

def source_image
  @source_image
end

#source_image_encryption_key ⇒ Google::Apis::ComputeAlpha::CustomerEncryptionKey

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

Returns:



10137
10138
10139
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 10137

def source_image_encryption_key
  @source_image_encryption_key
end

#source_image_id ⇒ String

[Output Only] The ID value of the image used to create this image. This value may be used to determine whether the image was taken from the current or a previous instance of a given image name. Corresponds to the JSON property sourceImageId

Returns:

  • (String) 


10144
10145
10146
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 10144

def source_image_id
  @source_image_id
end

#source_snapshot ⇒ String

URL of the source snapshot used to create this image. This can be a full or valid partial URL. You must provide exactly one of:

  • this property, or
  • the sourceImage property, or
  • the rawDisk.source property, or
  • the sourceDisk property in order to create an image. Corresponds to the JSON property sourceSnapshot

Returns:

  • (String) 


10154
10155
10156
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 10154

def source_snapshot
  @source_snapshot
end

#source_snapshot_encryption_key ⇒ Google::Apis::ComputeAlpha::CustomerEncryptionKey

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

Returns:



10159
10160
10161
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 10159

def source_snapshot_encryption_key
  @source_snapshot_encryption_key
end

#source_snapshot_id ⇒ String

[Output Only] The ID value of the snapshot used to create this image. This value may be used to determine whether the snapshot was taken from the current or a previous instance of a given snapshot name. Corresponds to the JSON property sourceSnapshotId

Returns:

  • (String) 


10166
10167
10168
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 10166

def source_snapshot_id
  @source_snapshot_id
end

#source_type ⇒ String

The type of the image used to create this disk. The default and only value is RAW Corresponds to the JSON property sourceType

Returns:

  • (String) 


10172
10173
10174
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 10172

def source_type
  @source_type
end

#status ⇒ String

[Output Only] The status of the image. An image can be used to create other resources, such as instances, only after the image has been successfully created and the status is set to READY. Possible values are FAILED, PENDING, or READY. Corresponds to the JSON property status

Returns:

  • (String) 


10180
10181
10182
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 10180

def status
  @status
end

#storage_locations ⇒ Array<String>

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

Returns:

  • (Array<String>) 


10185
10186
10187
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 10185

def storage_locations
  @storage_locations
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



10192
10193
10194
10195
10196
10197
10198
10199
10200
10201
10202
10203
10204
10205
10206
10207
10208
10209
10210
10211
10212
10213
10214
10215
10216
10217
10218
10219
10220
10221
10222
10223
10224
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 10192

def update!(**args)
  @archive_size_bytes = args[:archive_size_bytes] if args.key?(:archive_size_bytes)
  @creation_timestamp = args[:creation_timestamp] if args.key?(:creation_timestamp)
  @deprecated = args[:deprecated] if args.key?(:deprecated)
  @description = args[:description] if args.key?(:description)
  @disk_size_gb = args[:disk_size_gb] if args.key?(:disk_size_gb)
  @family = args[:family] if args.key?(:family)
  @guest_os_features = args[:guest_os_features] if args.key?(:guest_os_features)
  @id = args[:id] if args.key?(:id)
  @image_encryption_key = args[:image_encryption_key] if args.key?(:image_encryption_key)
  @kind = args[:kind] if args.key?(:kind)
  @label_fingerprint = args[:label_fingerprint] if args.key?(:label_fingerprint)
  @labels = args[:labels] if args.key?(:labels)
  @license_codes = args[:license_codes] if args.key?(:license_codes)
  @licenses = args[:licenses] if args.key?(:licenses)
  @name = args[:name] if args.key?(:name)
  @raw_disk = args[:raw_disk] if args.key?(:raw_disk)
  @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)
  @shielded_instance_initial_state = args[:shielded_instance_initial_state] if args.key?(:shielded_instance_initial_state)
  @source_disk = args[:source_disk] if args.key?(:source_disk)
  @source_disk_encryption_key = args[:source_disk_encryption_key] if args.key?(:source_disk_encryption_key)
  @source_disk_id = args[:source_disk_id] if args.key?(:source_disk_id)
  @source_image = args[:source_image] if args.key?(:source_image)
  @source_image_encryption_key = args[:source_image_encryption_key] if args.key?(:source_image_encryption_key)
  @source_image_id = args[:source_image_id] if args.key?(:source_image_id)
  @source_snapshot = args[:source_snapshot] if args.key?(:source_snapshot)
  @source_snapshot_encryption_key = args[:source_snapshot_encryption_key] if args.key?(:source_snapshot_encryption_key)
  @source_snapshot_id = args[:source_snapshot_id] if args.key?(:source_snapshot_id)
  @source_type = args[:source_type] if args.key?(:source_type)
  @status = args[:status] if args.key?(:status)
  @storage_locations = args[:storage_locations] if args.key?(:storage_locations)
end