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.



61214
61215
61216
 
# File 'lib/google/apis/compute_beta/classes.rb', line 61214

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

Instance Attribute Details

#architecture ⇒ String

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

Returns:

  • (String) 


60916
60917
60918
 
# File 'lib/google/apis/compute_beta/classes.rb', line 60916

def architecture
  @architecture
end

#auto_created ⇒ Boolean Also known as: auto_created?

Output only. [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) 


60923
60924
60925
 
# File 'lib/google/apis/compute_beta/classes.rb', line 60923

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) 


60934
60935
60936
 
# File 'lib/google/apis/compute_beta/classes.rb', line 60934

def chain_name
  @chain_name
end

#creation_size_bytes ⇒ Fixnum

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

Returns:

  • (Fixnum) 


60939
60940
60941
 
# File 'lib/google/apis/compute_beta/classes.rb', line 60939

def creation_size_bytes
  @creation_size_bytes
end

#creation_timestamp ⇒ String

Output only. [Output Only] Creation timestamp inRFC3339 text format. Corresponds to the JSON property creationTimestamp

Returns:

  • (String) 


60945
60946
60947
 
# File 'lib/google/apis/compute_beta/classes.rb', line 60945

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) 


60951
60952
60953
 
# File 'lib/google/apis/compute_beta/classes.rb', line 60951

def description
  @description
end

#disk_size_gb ⇒ Fixnum

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

Returns:

  • (Fixnum) 


60956
60957
60958
 
# File 'lib/google/apis/compute_beta/classes.rb', line 60956

def disk_size_gb
  @disk_size_gb
end

#download_bytes ⇒ Fixnum

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

Returns:

  • (Fixnum) 


60962
60963
60964
 
# File 'lib/google/apis/compute_beta/classes.rb', line 60962

def download_bytes
  @download_bytes
end

#enable_confidential_compute ⇒ Boolean Also known as: enable_confidential_compute?

Output only. Whether this snapshot is created from a confidential compute mode disk. [Output Only]: This field is not set by user, but from source disk. Corresponds to the JSON property enableConfidentialCompute

Returns:

  • (Boolean) 


60969
60970
60971
 
# File 'lib/google/apis/compute_beta/classes.rb', line 60969

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


60976
60977
60978
 
# File 'lib/google/apis/compute_beta/classes.rb', line 60976

def guest_flush
  @guest_flush
end

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

Output only. [Output Only] 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:



60986
60987
60988
 
# File 'lib/google/apis/compute_beta/classes.rb', line 60986

def guest_os_features
  @guest_os_features
end

#id ⇒ Fixnum

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

Returns:

  • (Fixnum) 


60993
60994
60995
 
# File 'lib/google/apis/compute_beta/classes.rb', line 60993

def id
  @id
end

#kind ⇒ String

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

Returns:

  • (String) 


60999
61000
61001
 
# File 'lib/google/apis/compute_beta/classes.rb', line 60999

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


61012
61013
61014
 
# File 'lib/google/apis/compute_beta/classes.rb', line 61012

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


61019
61020
61021
 
# File 'lib/google/apis/compute_beta/classes.rb', line 61019

def labels
  @labels
end

#license_codes ⇒ Array<Fixnum>

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

Returns:

  • (Array<Fixnum>) 


61026
61027
61028
 
# File 'lib/google/apis/compute_beta/classes.rb', line 61026

def license_codes
  @license_codes
end

#licenses ⇒ Array<String>

Output only. [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>) 


61034
61035
61036
 
# File 'lib/google/apis/compute_beta/classes.rb', line 61034

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) 


61041
61042
61043
 
# File 'lib/google/apis/compute_beta/classes.rb', line 61041

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


61052
61053
61054
 
# File 'lib/google/apis/compute_beta/classes.rb', line 61052

def name
  @name
end

#params ⇒ Google::Apis::ComputeBeta::SnapshotParams

Additional snapshot params. Corresponds to the JSON property params

Returns:



61057
61058
61059
 
# File 'lib/google/apis/compute_beta/classes.rb', line 61057

def params
  @params
end

#region ⇒ String

Output only. [Output Only] URL of the region where the snapshot resides. Only applicable for regional snapshots. Corresponds to the JSON property region

Returns:

  • (String) 


61064
61065
61066
 
# File 'lib/google/apis/compute_beta/classes.rb', line 61064

def region
  @region
end

#satisfies_pzi ⇒ Boolean Also known as: satisfies_pzi?

Output only. Reserved for future use. Corresponds to the JSON property satisfiesPzi

Returns:

  • (Boolean) 


61069
61070
61071
 
# File 'lib/google/apis/compute_beta/classes.rb', line 61069

def satisfies_pzi
  @satisfies_pzi
end

#satisfies_pzs ⇒ Boolean Also known as: satisfies_pzs?

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

Returns:

  • (Boolean) 


61075
61076
61077
 
# File 'lib/google/apis/compute_beta/classes.rb', line 61075

def satisfies_pzs
  @satisfies_pzs
end

#self_link ⇒ String

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

Returns:

  • (String) 


61081
61082
61083
 
# File 'lib/google/apis/compute_beta/classes.rb', line 61081

def self_link
  @self_link
end

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

Encrypts the snapshot using acustomer-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:



61096
61097
61098
 
# File 'lib/google/apis/compute_beta/classes.rb', line 61096

def snapshot_encryption_key
  @snapshot_encryption_key
end

#snapshot_group_id ⇒ String

Output only. [Output Only] The unique ID of the snapshot group that this snapshot belongs to. The usage of snapshot group feature is restricted. Corresponds to the JSON property snapshotGroupId

Returns:

  • (String) 


61103
61104
61105
 
# File 'lib/google/apis/compute_beta/classes.rb', line 61103

def snapshot_group_id
  @snapshot_group_id
end

#snapshot_group_name ⇒ String

Output only. [Output only] The snapshot group that this snapshot belongs to. The usage of snapshot group feature is restricted. Corresponds to the JSON property snapshotGroupName

Returns:

  • (String) 


61110
61111
61112
 
# File 'lib/google/apis/compute_beta/classes.rb', line 61110

def snapshot_group_name
  @snapshot_group_name
end

#snapshot_type ⇒ String

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

Returns:

  • (String) 


61115
61116
61117
 
# File 'lib/google/apis/compute_beta/classes.rb', line 61115

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) 


61120
61121
61122
 
# File 'lib/google/apis/compute_beta/classes.rb', line 61120

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:



61127
61128
61129
 
# File 'lib/google/apis/compute_beta/classes.rb', line 61127

def source_disk_encryption_key
  @source_disk_encryption_key
end

#source_disk_for_recovery_checkpoint ⇒ String

The source disk whose recovery checkpoint will be used to create this snapshot. Corresponds to the JSON property sourceDiskForRecoveryCheckpoint

Returns:

  • (String) 


61133
61134
61135
 
# File 'lib/google/apis/compute_beta/classes.rb', line 61133

def source_disk_for_recovery_checkpoint
  @source_disk_for_recovery_checkpoint
end

#source_disk_id ⇒ String

Output only. [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) 


61141
61142
61143
 
# File 'lib/google/apis/compute_beta/classes.rb', line 61141

def source_disk_id
  @source_disk_id
end

#source_instant_snapshot ⇒ String

The source instant snapshot used to create this snapshot. You can provide this as a partial or full URL to the resource. For example, the following are valid values:

Returns:

  • (String) 


61154
61155
61156
 
# File 'lib/google/apis/compute_beta/classes.rb', line 61154

def source_instant_snapshot
  @source_instant_snapshot
end

#source_instant_snapshot_encryption_key ⇒ Google::Apis::ComputeBeta::CustomerEncryptionKey

Customer provided encryption key when creating Snapshot from Instant Snapshot. Corresponds to the JSON property sourceInstantSnapshotEncryptionKey

Returns:



61160
61161
61162
 
# File 'lib/google/apis/compute_beta/classes.rb', line 61160

def source_instant_snapshot_encryption_key
  @source_instant_snapshot_encryption_key
end

#source_instant_snapshot_id ⇒ String

Output only. [Output Only] The unique ID of the instant snapshot used to create this snapshot. This value identifies the exact instant snapshot that was used to create this snapshot. For example, if you created the snapshot from an instant snapshot that was later deleted and recreated under the same name, the source instant snapshot ID would identify the exact instant snapshot that was used. Corresponds to the JSON property sourceInstantSnapshotId

Returns:

  • (String) 


61171
61172
61173
 
# File 'lib/google/apis/compute_beta/classes.rb', line 61171

def source_instant_snapshot_id
  @source_instant_snapshot_id
end

#source_snapshot_schedule_policy ⇒ String

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

Returns:

  • (String) 


61177
61178
61179
 
# File 'lib/google/apis/compute_beta/classes.rb', line 61177

def source_snapshot_schedule_policy
  @source_snapshot_schedule_policy
end

#source_snapshot_schedule_policy_id ⇒ String

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

Returns:

  • (String) 


61183
61184
61185
 
# File 'lib/google/apis/compute_beta/classes.rb', line 61183

def source_snapshot_schedule_policy_id
  @source_snapshot_schedule_policy_id
end

#status ⇒ String

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

Returns:

  • (String) 


61189
61190
61191
 
# File 'lib/google/apis/compute_beta/classes.rb', line 61189

def status
  @status
end

#storage_bytes ⇒ Fixnum

Output only. [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) 


61197
61198
61199
 
# File 'lib/google/apis/compute_beta/classes.rb', line 61197

def storage_bytes
  @storage_bytes
end

#storage_bytes_status ⇒ String

Output only. [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) 


61206
61207
61208
 
# File 'lib/google/apis/compute_beta/classes.rb', line 61206

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


61212
61213
61214
 
# File 'lib/google/apis/compute_beta/classes.rb', line 61212

def storage_locations
  @storage_locations
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



61219
61220
61221
61222
61223
61224
61225
61226
61227
61228
61229
61230
61231
61232
61233
61234
61235
61236
61237
61238
61239
61240
61241
61242
61243
61244
61245
61246
61247
61248
61249
61250
61251
61252
61253
61254
61255
61256
61257
61258
61259
61260
61261
 
# File 'lib/google/apis/compute_beta/classes.rb', line 61219

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)
  @enable_confidential_compute = args[:enable_confidential_compute] if args.key?(:enable_confidential_compute)
  @guest_flush = args[:guest_flush] if args.key?(:guest_flush)
  @guest_os_features = args[:guest_os_features] if args.key?(:guest_os_features)
  @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)
  @params = args[:params] if args.key?(:params)
  @region = args[:region] if args.key?(:region)
  @satisfies_pzi = args[:satisfies_pzi] if args.key?(:satisfies_pzi)
  @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_group_id = args[:snapshot_group_id] if args.key?(:snapshot_group_id)
  @snapshot_group_name = args[:snapshot_group_name] if args.key?(:snapshot_group_name)
  @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_for_recovery_checkpoint = args[:source_disk_for_recovery_checkpoint] if args.key?(:source_disk_for_recovery_checkpoint)
  @source_disk_id = args[:source_disk_id] if args.key?(:source_disk_id)
  @source_instant_snapshot = args[:source_instant_snapshot] if args.key?(:source_instant_snapshot)
  @source_instant_snapshot_encryption_key = args[:source_instant_snapshot_encryption_key] if args.key?(:source_instant_snapshot_encryption_key)
  @source_instant_snapshot_id = args[:source_instant_snapshot_id] if args.key?(:source_instant_snapshot_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)
end