Class: Google::Apis::ComputeBeta::Snapshot

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 a Persistent Disk Snapshot resource. You can use snapshots to back up data on a regular interval. For more information, read Creating persistent disk snapshots.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Snapshot

Returns a new instance of Snapshot.



35617
35618
35619
 
# File 'lib/google/apis/compute_beta/classes.rb', line 35617

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

Instance Attribute Details

#architecture ⇒ String

[Output Only] The architecture of the snapshot. Valid values are ARM64 or X86_64. Corresponds to the JSON property architecture

Returns:

  • (String) 


35418
35419
35420
 
# File 'lib/google/apis/compute_beta/classes.rb', line 35418

def architecture
  @architecture
end

#auto_created ⇒ Boolean Also known as: auto_created?

[Output Only] Set to true if snapshots are automatically created by applying resource policy on the target disk. Corresponds to the JSON property autoCreated

Returns:

  • (Boolean) 


35424
35425
35426
 
# File 'lib/google/apis/compute_beta/classes.rb', line 35424

def auto_created
  @auto_created
end

#chain_name ⇒ String

Creates the new snapshot in the snapshot chain labeled with the specified name. The chain name must be 1-63 characters long and comply with RFC1035. This is an uncommon option only for advanced service owners who needs to create separate snapshot chains, for example, for chargeback tracking. When you describe your snapshot resource, this field is visible only if it has a non- empty value. Corresponds to the JSON property chainName

Returns:

  • (String) 


35435
35436
35437
 
# File 'lib/google/apis/compute_beta/classes.rb', line 35435

def chain_name
  @chain_name
end

#creation_size_bytes ⇒ Fixnum

[Output Only] Size in bytes of the snapshot at creation time. Corresponds to the JSON property creationSizeBytes

Returns:

  • (Fixnum) 


35440
35441
35442
 
# File 'lib/google/apis/compute_beta/classes.rb', line 35440

def creation_size_bytes
  @creation_size_bytes
end

#creation_timestamp ⇒ String

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

Returns:

  • (String) 


35445
35446
35447
 
# File 'lib/google/apis/compute_beta/classes.rb', line 35445

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) 


35451
35452
35453
 
# File 'lib/google/apis/compute_beta/classes.rb', line 35451

def description
  @description
end

#disk_size_gb ⇒ Fixnum

[Output Only] Size of the source disk, specified in GB. Corresponds to the JSON property diskSizeGb

Returns:

  • (Fixnum) 


35456
35457
35458
 
# File 'lib/google/apis/compute_beta/classes.rb', line 35456

def disk_size_gb
  @disk_size_gb
end

#download_bytes ⇒ Fixnum

[Output Only] Number of bytes downloaded to restore a snapshot to a disk. Corresponds to the JSON property downloadBytes

Returns:

  • (Fixnum) 


35461
35462
35463
 
# File 'lib/google/apis/compute_beta/classes.rb', line 35461

def download_bytes
  @download_bytes
end

#guest_flush ⇒ Boolean Also known as: guest_flush?

[Input Only] Whether to attempt an application consistent snapshot by informing the OS to prepare for the snapshot process. Corresponds to the JSON property guestFlush

Returns:

  • (Boolean) 


35467
35468
35469
 
# File 'lib/google/apis/compute_beta/classes.rb', line 35467

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


35474
35475
35476
 
# File 'lib/google/apis/compute_beta/classes.rb', line 35474

def id
  @id
end

#kind ⇒ String

[Output Only] Type of the resource. Always compute#snapshot for Snapshot resources. Corresponds to the JSON property kind

Returns:

  • (String) 


35480
35481
35482
 
# File 'lib/google/apis/compute_beta/classes.rb', line 35480

def kind
  @kind
end

#label_fingerprint ⇒ String

A fingerprint for the labels being applied to this snapshot, which is essentially a hash of the labels set 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 a snapshot. Corresponds to the JSON property labelFingerprint NOTE: Values are automatically base64 encoded/decoded in the client library.

Returns:

  • (String) 


35492
35493
35494
 
# File 'lib/google/apis/compute_beta/classes.rb', line 35492

def label_fingerprint
  @label_fingerprint
end

#labels ⇒ Hash<String,String>

Labels to apply to this snapshot. These can be later modified by the setLabels method. Label values may be empty. Corresponds to the JSON property labels

Returns:

  • (Hash<String,String>) 


35498
35499
35500
 
# File 'lib/google/apis/compute_beta/classes.rb', line 35498

def labels
  @labels
end

#license_codes ⇒ Array<Fixnum>

[Output Only] Integer license codes indicating which licenses are attached to this snapshot. Corresponds to the JSON property licenseCodes

Returns:

  • (Array<Fixnum>) 


35504
35505
35506
 
# File 'lib/google/apis/compute_beta/classes.rb', line 35504

def license_codes
  @license_codes
end

#licenses ⇒ Array<String>

[Output Only] A list of public visible licenses that apply to this snapshot. This can be because the original image had licenses attached (such as a Windows image). Corresponds to the JSON property licenses

Returns:

  • (Array<String>) 


35511
35512
35513
 
# File 'lib/google/apis/compute_beta/classes.rb', line 35511

def licenses
  @licenses
end

#location_hint ⇒ String

An opaque location hint used to place the snapshot close to other resources. This field is for use by internal tools that use the public API. Corresponds to the JSON property locationHint

Returns:

  • (String) 


35517
35518
35519
 
# File 'lib/google/apis/compute_beta/classes.rb', line 35517

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


35527
35528
35529
 
# File 'lib/google/apis/compute_beta/classes.rb', line 35527

def name
  @name
end

#satisfies_pzs ⇒ Boolean Also known as: satisfies_pzs?

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

Returns:

  • (Boolean) 


35532
35533
35534
 
# File 'lib/google/apis/compute_beta/classes.rb', line 35532

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) 


35538
35539
35540
 
# File 'lib/google/apis/compute_beta/classes.rb', line 35538

def self_link
  @self_link
end

#snapshot_encryption_key ⇒ Google::Apis::ComputeBeta::CustomerEncryptionKey

Encrypts the snapshot using a customer-supplied encryption key. After you encrypt a snapshot using a customer-supplied key, you must provide the same key if you use the snapshot later. For example, you must provide the encryption key when you create a disk from the encrypted snapshot in a future request. Customer-supplied encryption keys do not protect access to metadata of the snapshot. If you do not provide an encryption key when creating the snapshot, then the snapshot will be encrypted using an automatically generated key and you do not need to provide a key to use the snapshot later. Corresponds to the JSON property snapshotEncryptionKey

Returns:



35550
35551
35552
 
# File 'lib/google/apis/compute_beta/classes.rb', line 35550

def snapshot_encryption_key
  @snapshot_encryption_key
end

#snapshot_type ⇒ String

Indicates the type of the snapshot. Corresponds to the JSON property snapshotType

Returns:

  • (String) 


35555
35556
35557
 
# File 'lib/google/apis/compute_beta/classes.rb', line 35555

def snapshot_type
  @snapshot_type
end

#source_disk ⇒ String

The source disk used to create this snapshot. Corresponds to the JSON property sourceDisk

Returns:

  • (String) 


35560
35561
35562
 
# File 'lib/google/apis/compute_beta/classes.rb', line 35560

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:



35566
35567
35568
 
# File 'lib/google/apis/compute_beta/classes.rb', line 35566

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 snapshot. This value may be used to determine whether the snapshot was taken from the current or a previous instance of a given disk name. Corresponds to the JSON property sourceDiskId

Returns:

  • (String) 


35573
35574
35575
 
# File 'lib/google/apis/compute_beta/classes.rb', line 35573

def source_disk_id
  @source_disk_id
end

#source_snapshot_schedule_policy ⇒ String

[Output Only] URL of the resource policy which created this scheduled snapshot. Corresponds to the JSON property sourceSnapshotSchedulePolicy

Returns:

  • (String) 


35578
35579
35580
 
# File 'lib/google/apis/compute_beta/classes.rb', line 35578

def source_snapshot_schedule_policy
  @source_snapshot_schedule_policy
end

#source_snapshot_schedule_policy_id ⇒ String

[Output Only] ID of the resource policy which created this scheduled snapshot. Corresponds to the JSON property sourceSnapshotSchedulePolicyId

Returns:

  • (String) 


35583
35584
35585
 
# File 'lib/google/apis/compute_beta/classes.rb', line 35583

def source_snapshot_schedule_policy_id
  @source_snapshot_schedule_policy_id
end

#status ⇒ String

[Output Only] The status of the snapshot. This can be CREATING, DELETING, FAILED, READY, or UPLOADING. Corresponds to the JSON property status

Returns:

  • (String) 


35589
35590
35591
 
# File 'lib/google/apis/compute_beta/classes.rb', line 35589

def status
  @status
end

#storage_bytes ⇒ Fixnum

[Output Only] A size of the storage used by the snapshot. As snapshots share storage, this number is expected to change with snapshot creation/deletion. Corresponds to the JSON property storageBytes

Returns:

  • (Fixnum) 


35595
35596
35597
 
# File 'lib/google/apis/compute_beta/classes.rb', line 35595

def storage_bytes
  @storage_bytes
end

#storage_bytes_status ⇒ String

[Output Only] An indicator whether storageBytes is in a stable state or it is being adjusted as a result of shared storage reallocation. This status can either be UPDATING, meaning the size of the snapshot is being updated, or UP_TO_DATE, meaning the size of the snapshot is up-to-date. Corresponds to the JSON property storageBytesStatus

Returns:

  • (String) 


35603
35604
35605
 
# File 'lib/google/apis/compute_beta/classes.rb', line 35603

def storage_bytes_status
  @storage_bytes_status
end

#storage_locations ⇒ Array<String>

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

Returns:

  • (Array<String>) 


35609
35610
35611
 
# File 'lib/google/apis/compute_beta/classes.rb', line 35609

def storage_locations
  @storage_locations
end

#user_licenses ⇒ Array<String>

[Output Only] A list of user provided licenses represented by a list of URLs to the license resource. Corresponds to the JSON property userLicenses

Returns:

  • (Array<String>) 


35615
35616
35617
 
# File 'lib/google/apis/compute_beta/classes.rb', line 35615

def user_licenses
  @user_licenses
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



35622
35623
35624
35625
35626
35627
35628
35629
35630
35631
35632
35633
35634
35635
35636
35637
35638
35639
35640
35641
35642
35643
35644
35645
35646
35647
35648
35649
35650
35651
35652
35653
35654
 
# File 'lib/google/apis/compute_beta/classes.rb', line 35622

def update!(**args)
  @architecture = args[:architecture] if args.key?(:architecture)
  @auto_created = args[:auto_created] if args.key?(:auto_created)
  @chain_name = args[:chain_name] if args.key?(:chain_name)
  @creation_size_bytes = args[:creation_size_bytes] if args.key?(:creation_size_bytes)
  @creation_timestamp = args[:creation_timestamp] if args.key?(:creation_timestamp)
  @description = args[:description] if args.key?(:description)
  @disk_size_gb = args[:disk_size_gb] if args.key?(:disk_size_gb)
  @download_bytes = args[:download_bytes] if args.key?(:download_bytes)
  @guest_flush = args[:guest_flush] if args.key?(:guest_flush)
  @id = args[:id] if args.key?(:id)
  @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)
  @location_hint = args[:location_hint] if args.key?(:location_hint)
  @name = args[:name] if args.key?(:name)
  @satisfies_pzs = args[:satisfies_pzs] if args.key?(:satisfies_pzs)
  @self_link = args[:self_link] if args.key?(:self_link)
  @snapshot_encryption_key = args[:snapshot_encryption_key] if args.key?(:snapshot_encryption_key)
  @snapshot_type = args[:snapshot_type] if args.key?(:snapshot_type)
  @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_snapshot_schedule_policy = args[:source_snapshot_schedule_policy] if args.key?(:source_snapshot_schedule_policy)
  @source_snapshot_schedule_policy_id = args[:source_snapshot_schedule_policy_id] if args.key?(:source_snapshot_schedule_policy_id)
  @status = args[:status] if args.key?(:status)
  @storage_bytes = args[:storage_bytes] if args.key?(:storage_bytes)
  @storage_bytes_status = args[:storage_bytes_status] if args.key?(:storage_bytes_status)
  @storage_locations = args[:storage_locations] if args.key?(:storage_locations)
  @user_licenses = args[:user_licenses] if args.key?(:user_licenses)
end