Class: Google::Apis::ComputeBeta::Image

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 an Image resource. You can use images to create boot disks for your VM instances. For more information, read Images.

Defined Under Namespace

Classes: RawDisk

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Image

Returns a new instance of Image.



12714
12715
12716
 
# File 'lib/google/apis/compute_beta/classes.rb', line 12714

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

Instance Attribute Details

#architecture ⇒ String

The architecture of the image. Valid values are ARM64 or X86_64. Corresponds to the JSON property architecture

Returns:

  • (String) 


12468
12469
12470
 
# File 'lib/google/apis/compute_beta/classes.rb', line 12468

def architecture
  @architecture
end

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


12473
12474
12475
 
# File 'lib/google/apis/compute_beta/classes.rb', line 12473

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) 


12478
12479
12480
 
# File 'lib/google/apis/compute_beta/classes.rb', line 12478

def creation_timestamp
  @creation_timestamp
end

#deprecated ⇒ Google::Apis::ComputeBeta::DeprecationStatus

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

Returns:



12483
12484
12485
 
# File 'lib/google/apis/compute_beta/classes.rb', line 12483

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) 


12489
12490
12491
 
# File 'lib/google/apis/compute_beta/classes.rb', line 12489

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) 


12494
12495
12496
 
# File 'lib/google/apis/compute_beta/classes.rb', line 12494

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) 


12502
12503
12504
 
# File 'lib/google/apis/compute_beta/classes.rb', line 12502

def family
  @family
end

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

A list of features to enable on the guest operating system. Applicable only for bootable images. To see a list of available options, see the guestOSfeatures[].type parameter. Corresponds to the JSON property guestOsFeatures

Returns:



12509
12510
12511
 
# File 'lib/google/apis/compute_beta/classes.rb', line 12509

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) 


12515
12516
12517
 
# File 'lib/google/apis/compute_beta/classes.rb', line 12515

def id
  @id
end

#image_encryption_key ⇒ Google::Apis::ComputeBeta::CustomerEncryptionKey

Encrypts the image using a customer-supplied encryption key. After you encrypt an image with a customer-supplied key, you must provide the same key if you use the image later (e.g. to create a disk from the image). Customer-supplied encryption keys do not protect access to metadata of the disk. If you do not provide an encryption key when creating the image, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the image later. Corresponds to the JSON property imageEncryptionKey

Returns:



12526
12527
12528
 
# File 'lib/google/apis/compute_beta/classes.rb', line 12526

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) 


12531
12532
12533
 
# File 'lib/google/apis/compute_beta/classes.rb', line 12531

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) 


12543
12544
12545
 
# File 'lib/google/apis/compute_beta/classes.rb', line 12543

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


12549
12550
12551
 
# File 'lib/google/apis/compute_beta/classes.rb', line 12549

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


12554
12555
12556
 
# File 'lib/google/apis/compute_beta/classes.rb', line 12554

def license_codes
  @license_codes
end

#licenses ⇒ Array<String>

Any applicable license URI. Corresponds to the JSON property licenses

Returns:

  • (Array<String>) 


12559
12560
12561
 
# File 'lib/google/apis/compute_beta/classes.rb', line 12559

def licenses
  @licenses
end

#locked ⇒ Boolean Also known as: locked?

A flag for marketplace VM disk created from the image, which is designed for marketplace VM disk to prevent the proprietary data on the disk from being accessed unwantedly. The flag will be inherited by the disk created from the image. The disk with locked flag set to true will be prohibited from performing the operations below: - R/W or R/O disk attach - Disk detach, if disk is created via create-on-create - Create images - Create snapshots - Create disk clone (create disk from the current disk) The image with the locked field set to true will be prohibited from performing the operations below: - Create images from the current image - Update the locked field for the current image The instance with at least one disk with locked flag set to true will be prohibited from performing the operations below: - Secondary disk attach - Create instant snapshot - Create machine images - Create instance template - Delete the instance with --keep-disk parameter set to true Corresponds to the JSON property locked

Returns:

  • (Boolean) 


12576
12577
12578
 
# File 'lib/google/apis/compute_beta/classes.rb', line 12576

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


12587
12588
12589
 
# File 'lib/google/apis/compute_beta/classes.rb', line 12587

def name
  @name
end

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

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

Returns:



12592
12593
12594
 
# File 'lib/google/apis/compute_beta/classes.rb', line 12592

def raw_disk
  @raw_disk
end

#rollout_override ⇒ Google::Apis::ComputeBeta::RolloutPolicy

A rollout policy configuration. Corresponds to the JSON property rolloutOverride

Returns:



12597
12598
12599
 
# File 'lib/google/apis/compute_beta/classes.rb', line 12597

def rollout_override
  @rollout_override
end

#satisfies_pzs ⇒ Boolean Also known as: satisfies_pzs?

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

Returns:

  • (Boolean) 


12602
12603
12604
 
# File 'lib/google/apis/compute_beta/classes.rb', line 12602

def satisfies_pzs
  @satisfies_pzs
end

#self_link ⇒ String

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

Returns:

  • (String) 


12608
12609
12610
 
# File 'lib/google/apis/compute_beta/classes.rb', line 12608

def self_link
  @self_link
end

#shielded_instance_initial_state ⇒ Google::Apis::ComputeBeta::InitialStateConfig

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

Returns:



12614
12615
12616
 
# File 'lib/google/apis/compute_beta/classes.rb', line 12614

def shielded_instance_initial_state
  @shielded_instance_initial_state
end

#source_disk ⇒ String

URL of the source disk used to create this image. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/ zones/zone /disks/disk - projects/project/zones/zone/disks/disk - zones/zone/ disks/disk In order to create an image, you must provide the full or partial URL of one of the following: - The rawDisk.source URL - The sourceDisk URL - The sourceImage URL - The sourceSnapshot URL Corresponds to the JSON property sourceDisk

Returns:

  • (String) 


12624
12625
12626
 
# File 'lib/google/apis/compute_beta/classes.rb', line 12624

def source_disk
  @source_disk
end

#source_disk_encryption_key ⇒ Google::Apis::ComputeBeta::CustomerEncryptionKey

The customer-supplied encryption key of the source disk. Required if the source disk is protected by a customer-supplied encryption key. Corresponds to the JSON property sourceDiskEncryptionKey

Returns:



12630
12631
12632
 
# File 'lib/google/apis/compute_beta/classes.rb', line 12630

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) 


12637
12638
12639
 
# File 'lib/google/apis/compute_beta/classes.rb', line 12637

def source_disk_id
  @source_disk_id
end

#source_image ⇒ String

URL of the source image used to create this image. The following are valid formats for the URL: - https://www.googleapis.com/compute/v1/projects/ project_id/global/ images/image_name - projects/project_id/global/images/ image_name In order to create an image, you must provide the full or partial URL of one of the following: - The rawDisk.source URL - The sourceDisk URL - The sourceImage URL - The sourceSnapshot URL Corresponds to the JSON property sourceImage

Returns:

  • (String) 


12647
12648
12649
 
# File 'lib/google/apis/compute_beta/classes.rb', line 12647

def source_image
  @source_image
end

#source_image_encryption_key ⇒ Google::Apis::ComputeBeta::CustomerEncryptionKey

The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key. Corresponds to the JSON property sourceImageEncryptionKey

Returns:



12653
12654
12655
 
# File 'lib/google/apis/compute_beta/classes.rb', line 12653

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) 


12660
12661
12662
 
# File 'lib/google/apis/compute_beta/classes.rb', line 12660

def source_image_id
  @source_image_id
end

#source_snapshot ⇒ String

URL of the source snapshot used to create this image. The following are valid formats for the URL: - https://www.googleapis.com/compute/v1/projects/ project_id/global/ snapshots/snapshot_name - projects/project_id/global/ snapshots/snapshot_name In order to create an image, you must provide the full or partial URL of one of the following: - The rawDisk.source URL - The sourceDisk URL - The sourceImage URL - The sourceSnapshot URL Corresponds to the JSON property sourceSnapshot

Returns:

  • (String) 


12670
12671
12672
 
# File 'lib/google/apis/compute_beta/classes.rb', line 12670

def source_snapshot
  @source_snapshot
end

#source_snapshot_encryption_key ⇒ Google::Apis::ComputeBeta::CustomerEncryptionKey

The customer-supplied encryption key of the source snapshot. Required if the source snapshot is protected by a customer-supplied encryption key. Corresponds to the JSON property sourceSnapshotEncryptionKey

Returns:



12676
12677
12678
 
# File 'lib/google/apis/compute_beta/classes.rb', line 12676

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) 


12683
12684
12685
 
# File 'lib/google/apis/compute_beta/classes.rb', line 12683

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 valid value is RAW. Corresponds to the JSON property sourceType

Returns:

  • (String) 


12689
12690
12691
 
# File 'lib/google/apis/compute_beta/classes.rb', line 12689

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) 


12697
12698
12699
 
# File 'lib/google/apis/compute_beta/classes.rb', line 12697

def status
  @status
end

#storage_locations ⇒ Array<String>

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

Returns:

  • (Array<String>) 


12703
12704
12705
 
# File 'lib/google/apis/compute_beta/classes.rb', line 12703

def storage_locations
  @storage_locations
end

#user_licenses ⇒ Array<String>

A list of publicly visible user-licenses. Unlike regular licenses, user provided licenses can be modified after the disk is created. This includes a list of URLs to the license resource. For example, to provide a debian license: https://www.googleapis.com/compute/v1/projects/debian-cloud/global/licenses/ debian-9-stretch Corresponds to the JSON property userLicenses

Returns:

  • (Array<String>) 


12712
12713
12714
 
# File 'lib/google/apis/compute_beta/classes.rb', line 12712

def user_licenses
  @user_licenses
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



12719
12720
12721
12722
12723
12724
12725
12726
12727
12728
12729
12730
12731
12732
12733
12734
12735
12736
12737
12738
12739
12740
12741
12742
12743
12744
12745
12746
12747
12748
12749
12750
12751
12752
12753
12754
12755
 
# File 'lib/google/apis/compute_beta/classes.rb', line 12719

def update!(**args)
  @architecture = args[:architecture] if args.key?(:architecture)
  @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)
  @locked = args[:locked] if args.key?(:locked)
  @name = args[:name] if args.key?(:name)
  @raw_disk = args[:raw_disk] if args.key?(:raw_disk)
  @rollout_override = args[:rollout_override] if args.key?(:rollout_override)
  @satisfies_pzs = args[:satisfies_pzs] if args.key?(:satisfies_pzs)
  @self_link = args[:self_link] if args.key?(:self_link)
  @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)
  @user_licenses = args[:user_licenses] if args.key?(:user_licenses)
end