Class: Google::Apis::ComputeAlpha::Snapshot

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



60268
60269
60270
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 60268

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) 


59983
59984
59985
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 59983

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) 


59989
59990
59991
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 59989

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) 


60000
60001
60002
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 60000

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) 


60005
60006
60007
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 60005

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) 


60010
60011
60012
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 60010

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) 


60016
60017
60018
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 60016

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) 


60021
60022
60023
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 60021

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) 


60026
60027
60028
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 60026

def download_bytes
  @download_bytes
end

#enable_confidential_compute ⇒ Boolean Also known as: enable_confidential_compute?

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) 


60032
60033
60034
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 60032

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) 


60039
60040
60041
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 60039

def guest_flush
  @guest_flush
end

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

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



60047
60048
60049
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 60047

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) 


60053
60054
60055
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 60053

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) 


60059
60060
60061
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 60059

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) 


60071
60072
60073
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 60071

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


60077
60078
60079
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 60077

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


60083
60084
60085
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 60083

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


60090
60091
60092
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 60090

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) 


60096
60097
60098
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 60096

def location_hint
  @location_hint
end

#max_retention_days ⇒ Fixnum

Number of days the snapshot should be retained before being deleted automatically. Corresponds to the JSON property maxRetentionDays

Returns:

  • (Fixnum) 


60102
60103
60104
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 60102

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


60112
60113
60114
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 60112

def name
  @name
end

#params ⇒ Google::Apis::ComputeAlpha::SnapshotParams

Additional snapshot params. Corresponds to the JSON property params

Returns:



60117
60118
60119
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 60117

def params
  @params
end

#region ⇒ String

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

Returns:

  • (String) 


60123
60124
60125
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 60123

def region
  @region
end

#resource_status ⇒ Google::Apis::ComputeAlpha::SnapshotResourceStatus

[Output only] ResourceStatus of the Snapshot resource Corresponds to the JSON property resourceStatus

Returns:



60128
60129
60130
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 60128

def resource_status
  @resource_status
end

#satisfies_pzi ⇒ Boolean Also known as: satisfies_pzi?

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

Returns:

  • (Boolean) 


60133
60134
60135
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 60133

def satisfies_pzi
  @satisfies_pzi
end

#satisfies_pzs ⇒ Boolean Also known as: satisfies_pzs?

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

Returns:

  • (Boolean) 


60139
60140
60141
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 60139

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) 


60145
60146
60147
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 60145

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) 


60150
60151
60152
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 60150

def self_link_with_id
  @self_link_with_id
end

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



60162
60163
60164
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 60162

def snapshot_encryption_key
  @snapshot_encryption_key
end

#snapshot_group_id ⇒ String

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

Returns:

  • (String) 


60168
60169
60170
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 60168

def snapshot_group_id
  @snapshot_group_id
end

#snapshot_group_name ⇒ String

[Output only] The snapshot group that this snapshot belongs to. Corresponds to the JSON property snapshotGroupName

Returns:

  • (String) 


60173
60174
60175
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 60173

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) 


60178
60179
60180
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 60178

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) 


60183
60184
60185
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 60183

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:



60189
60190
60191
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 60189

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) 


60194
60195
60196
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 60194

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


60201
60202
60203
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 60201

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: - https://www.googleapis.com/compute/v1/projects/project/zones/zone / instantSnapshots/instantSnapshot - projects/project/zones/zone/ instantSnapshots/instantSnapshot - zones/zone/instantSnapshots/instantSnapshot Corresponds to the JSON property sourceInstantSnapshot

Returns:

  • (String) 


60210
60211
60212
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 60210

def source_instant_snapshot
  @source_instant_snapshot
end

#source_instant_snapshot_encryption_key ⇒ Google::Apis::ComputeAlpha::CustomerEncryptionKey

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

Returns:



60215
60216
60217
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 60215

def source_instant_snapshot_encryption_key
  @source_instant_snapshot_encryption_key
end

#source_instant_snapshot_id ⇒ String

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


60224
60225
60226
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 60224

def source_instant_snapshot_id
  @source_instant_snapshot_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) 


60229
60230
60231
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 60229

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) 


60234
60235
60236
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 60234

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) 


60240
60241
60242
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 60240

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) 


60246
60247
60248
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 60246

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) 


60254
60255
60256
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 60254

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


60260
60261
60262
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 60260

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


60266
60267
60268
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 60266

def user_licenses
  @user_licenses
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



60273
60274
60275
60276
60277
60278
60279
60280
60281
60282
60283
60284
60285
60286
60287
60288
60289
60290
60291
60292
60293
60294
60295
60296
60297
60298
60299
60300
60301
60302
60303
60304
60305
60306
60307
60308
60309
60310
60311
60312
60313
60314
60315
60316
60317
60318
60319
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 60273

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)
  @max_retention_days = args[:max_retention_days] if args.key?(:max_retention_days)
  @name = args[:name] if args.key?(:name)
  @params = args[:params] if args.key?(:params)
  @region = args[:region] if args.key?(:region)
  @resource_status = args[:resource_status] if args.key?(:resource_status)
  @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)
  @self_link_with_id = args[:self_link_with_id] if args.key?(:self_link_with_id)
  @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)
  @user_licenses = args[:user_licenses] if args.key?(:user_licenses)
end