Class: Google::Apis::ComputeV1::Image

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

Overview

An Image resource.

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.


3430
3431
3432
# File 'generated/google/apis/compute_v1/classes.rb', line 3430

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

Instance Attribute Details

#archive_size_bytesString

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

Returns:

  • (String)

3321
3322
3323
# File 'generated/google/apis/compute_v1/classes.rb', line 3321

def archive_size_bytes
  @archive_size_bytes
end

#creation_timestampString

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

Returns:

  • (String)

3326
3327
3328
# File 'generated/google/apis/compute_v1/classes.rb', line 3326

def creation_timestamp
  @creation_timestamp
end

#deprecatedGoogle::Apis::ComputeV1::DeprecationStatus

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


3331
3332
3333
# File 'generated/google/apis/compute_v1/classes.rb', line 3331

def deprecated
  @deprecated
end

#descriptionString

An optional description of this resource. Provide this property when you create the resource. Corresponds to the JSON property description

Returns:

  • (String)

3337
3338
3339
# File 'generated/google/apis/compute_v1/classes.rb', line 3337

def description
  @description
end

#disk_size_gbString

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

Returns:

  • (String)

3342
3343
3344
# File 'generated/google/apis/compute_v1/classes.rb', line 3342

def disk_size_gb
  @disk_size_gb
end

#familyString

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)

3350
3351
3352
# File 'generated/google/apis/compute_v1/classes.rb', line 3350

def family
  @family
end

#idString

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

Returns:

  • (String)

3356
3357
3358
# File 'generated/google/apis/compute_v1/classes.rb', line 3356

def id
  @id
end

#image_encryption_keyGoogle::Apis::ComputeV1::CustomerEncryptionKey

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


3361
3362
3363
# File 'generated/google/apis/compute_v1/classes.rb', line 3361

def image_encryption_key
  @image_encryption_key
end

#kindString

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

Returns:

  • (String)

3366
3367
3368
# File 'generated/google/apis/compute_v1/classes.rb', line 3366

def kind
  @kind
end

#licensesArray<String>

Any applicable license URI. Corresponds to the JSON property licenses

Returns:

  • (Array<String>)

3371
3372
3373
# File 'generated/google/apis/compute_v1/classes.rb', line 3371

def licenses
  @licenses
end

#nameString

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

3381
3382
3383
# File 'generated/google/apis/compute_v1/classes.rb', line 3381

def name
  @name
end

#raw_diskGoogle::Apis::ComputeV1::Image::RawDisk

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


3386
3387
3388
# File 'generated/google/apis/compute_v1/classes.rb', line 3386

def raw_disk
  @raw_disk
end

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

Returns:

  • (String)

3391
3392
3393
# File 'generated/google/apis/compute_v1/classes.rb', line 3391

def self_link
  @self_link
end

#source_diskString

URL of the 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)

3402
3403
3404
# File 'generated/google/apis/compute_v1/classes.rb', line 3402

def source_disk
  @source_disk
end

#source_disk_encryption_keyGoogle::Apis::ComputeV1::CustomerEncryptionKey

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


3407
3408
3409
# File 'generated/google/apis/compute_v1/classes.rb', line 3407

def source_disk_encryption_key
  @source_disk_encryption_key
end

#source_disk_idString

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)

3414
3415
3416
# File 'generated/google/apis/compute_v1/classes.rb', line 3414

def source_disk_id
  @source_disk_id
end

#source_typeString

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)

3420
3421
3422
# File 'generated/google/apis/compute_v1/classes.rb', line 3420

def source_type
  @source_type
end

#statusString

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

3428
3429
3430
# File 'generated/google/apis/compute_v1/classes.rb', line 3428

def status
  @status
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
# File 'generated/google/apis/compute_v1/classes.rb', line 3435

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)
  @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)
  @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)
  @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_type = args[:source_type] if args.key?(:source_type)
  @status = args[:status] if args.key?(:status)
end