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.



36787
36788
36789
 
# File 'lib/google/apis/compute_beta/classes.rb', line 36787

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) 


36588
36589
36590
 
# File 'lib/google/apis/compute_beta/classes.rb', line 36588

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) 


36594
36595
36596
 
# File 'lib/google/apis/compute_beta/classes.rb', line 36594

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) 


36605
36606
36607
 
# File 'lib/google/apis/compute_beta/classes.rb', line 36605

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) 


36610
36611
36612
 
# File 'lib/google/apis/compute_beta/classes.rb', line 36610

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) 


36615
36616
36617
 
# File 'lib/google/apis/compute_beta/classes.rb', line 36615

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) 


36621
36622
36623
 
# File 'lib/google/apis/compute_beta/classes.rb', line 36621

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) 


36626
36627
36628
 
# File 'lib/google/apis/compute_beta/classes.rb', line 36626

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) 


36631
36632
36633
 
# File 'lib/google/apis/compute_beta/classes.rb', line 36631

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) 


36637
36638
36639
 
# File 'lib/google/apis/compute_beta/classes.rb', line 36637

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) 


36644
36645
36646
 
# File 'lib/google/apis/compute_beta/classes.rb', line 36644

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) 


36650
36651
36652
 
# File 'lib/google/apis/compute_beta/classes.rb', line 36650

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) 


36662
36663
36664
 
# File 'lib/google/apis/compute_beta/classes.rb', line 36662

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


36668
36669
36670
 
# File 'lib/google/apis/compute_beta/classes.rb', line 36668

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


36674
36675
36676
 
# File 'lib/google/apis/compute_beta/classes.rb', line 36674

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


36681
36682
36683
 
# File 'lib/google/apis/compute_beta/classes.rb', line 36681

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) 


36687
36688
36689
 
# File 'lib/google/apis/compute_beta/classes.rb', line 36687

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) 


36697
36698
36699
 
# File 'lib/google/apis/compute_beta/classes.rb', line 36697

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) 


36702
36703
36704
 
# File 'lib/google/apis/compute_beta/classes.rb', line 36702

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) 


36708
36709
36710
 
# File 'lib/google/apis/compute_beta/classes.rb', line 36708

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:



36720
36721
36722
 
# File 'lib/google/apis/compute_beta/classes.rb', line 36720

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) 


36725
36726
36727
 
# File 'lib/google/apis/compute_beta/classes.rb', line 36725

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) 


36730
36731
36732
 
# File 'lib/google/apis/compute_beta/classes.rb', line 36730

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:



36736
36737
36738
 
# File 'lib/google/apis/compute_beta/classes.rb', line 36736

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) 


36743
36744
36745
 
# File 'lib/google/apis/compute_beta/classes.rb', line 36743

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) 


36748
36749
36750
 
# File 'lib/google/apis/compute_beta/classes.rb', line 36748

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) 


36753
36754
36755
 
# File 'lib/google/apis/compute_beta/classes.rb', line 36753

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) 


36759
36760
36761
 
# File 'lib/google/apis/compute_beta/classes.rb', line 36759

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) 


36765
36766
36767
 
# File 'lib/google/apis/compute_beta/classes.rb', line 36765

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) 


36773
36774
36775
 
# File 'lib/google/apis/compute_beta/classes.rb', line 36773

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


36779
36780
36781
 
# File 'lib/google/apis/compute_beta/classes.rb', line 36779

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


36785
36786
36787
 
# File 'lib/google/apis/compute_beta/classes.rb', line 36785

def user_licenses
  @user_licenses
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



36792
36793
36794
36795
36796
36797
36798
36799
36800
36801
36802
36803
36804
36805
36806
36807
36808
36809
36810
36811
36812
36813
36814
36815
36816
36817
36818
36819
36820
36821
36822
36823
36824
 
# File 'lib/google/apis/compute_beta/classes.rb', line 36792

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