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

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
lib/google/apis/compute_alpha/classes.rb,
lib/google/apis/compute_alpha/representations.rb,
lib/google/apis/compute_alpha/representations.rb

Overview

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



13015
13016
13017
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 13015

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) 


12791
12792
12793
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 12791

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) 


12796
12797
12798
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 12796

def creation_timestamp
  @creation_timestamp
end

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

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

Returns:



12801
12802
12803
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 12801

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) 


12807
12808
12809
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 12807

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) 


12812
12813
12814
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 12812

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) 


12820
12821
12822
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 12820

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:



12827
12828
12829
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 12827

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) 


12833
12834
12835
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 12833

def id
  @id
end

#image_encryption_key ⇒ Google::Apis::ComputeAlpha::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:



12845
12846
12847
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 12845

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) 


12850
12851
12852
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 12850

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) 


12862
12863
12864
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 12862

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


12868
12869
12870
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 12868

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


12873
12874
12875
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 12873

def license_codes
  @license_codes
end

#licenses ⇒ Array<String>

Any applicable license URI. Corresponds to the JSON property licenses

Returns:

  • (Array<String>) 


12878
12879
12880
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 12878

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) 


12888
12889
12890
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 12888

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:



12893
12894
12895
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 12893

def raw_disk
  @raw_disk
end

#rollout_override ⇒ Google::Apis::ComputeAlpha::RolloutPolicy

A rollout policy configuration. Corresponds to the JSON property rolloutOverride

Returns:



12898
12899
12900
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 12898

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) 


12903
12904
12905
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 12903

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) 


12909
12910
12911
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 12909

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) 


12914
12915
12916
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 12914

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:



12920
12921
12922
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 12920

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) 


12931
12932
12933
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 12931

def source_disk
  @source_disk
end

#source_disk_encryption_key ⇒ Google::Apis::ComputeAlpha::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:



12937
12938
12939
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 12937

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) 


12944
12945
12946
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 12944

def source_disk_id
  @source_disk_id
end

#source_image ⇒ String

URL of the source image used to create this image. In order to create an image, you must provide the full or partial URL of one of the following:

  • The selfLink URL
  • This property
  • The rawDisk.source URL
  • The sourceDisk URL Corresponds to the JSON property sourceImage

Returns:

  • (String) 


12955
12956
12957
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 12955

def source_image
  @source_image
end

#source_image_encryption_key ⇒ Google::Apis::ComputeAlpha::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:



12961
12962
12963
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 12961

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) 


12968
12969
12970
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 12968

def source_image_id
  @source_image_id
end

#source_snapshot ⇒ String

URL of the source snapshot used to create this image. In order to create an image, you must provide the full or partial URL of one of the following:

  • The selfLink URL
  • This property
  • The sourceImage URL
  • The rawDisk.source URL
  • The sourceDisk URL Corresponds to the JSON property sourceSnapshot

Returns:

  • (String) 


12980
12981
12982
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 12980

def source_snapshot
  @source_snapshot
end

#source_snapshot_encryption_key ⇒ Google::Apis::ComputeAlpha::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:



12986
12987
12988
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 12986

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) 


12993
12994
12995
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 12993

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) 


12999
13000
13001
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 12999

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) 


13007
13008
13009
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 13007

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


13013
13014
13015
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 13013

def storage_locations
  @storage_locations
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



13020
13021
13022
13023
13024
13025
13026
13027
13028
13029
13030
13031
13032
13033
13034
13035
13036
13037
13038
13039
13040
13041
13042
13043
13044
13045
13046
13047
13048
13049
13050
13051
13052
13053
13054
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 13020

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