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. (== resource_for $ api_version.snapshots ==)

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Snapshot

Returns a new instance of Snapshot.



32126
32127
32128
 
# File 'lib/google/apis/compute_beta/classes.rb', line 32126

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

Instance Attribute Details

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


31956
31957
31958
 
# File 'lib/google/apis/compute_beta/classes.rb', line 31956

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) 


31967
31968
31969
 
# File 'lib/google/apis/compute_beta/classes.rb', line 31967

def chain_name
  @chain_name
end

#creation_timestamp ⇒ String

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

Returns:

  • (String) 


31972
31973
31974
 
# File 'lib/google/apis/compute_beta/classes.rb', line 31972

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) 


31978
31979
31980
 
# File 'lib/google/apis/compute_beta/classes.rb', line 31978

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) 


31983
31984
31985
 
# File 'lib/google/apis/compute_beta/classes.rb', line 31983

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) 


31988
31989
31990
 
# File 'lib/google/apis/compute_beta/classes.rb', line 31988

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. Currently only supported on Windows instances using the Volume Shadow Copy Service (VSS). Corresponds to the JSON property guestFlush

Returns:

  • (Boolean) 


31995
31996
31997
 
# File 'lib/google/apis/compute_beta/classes.rb', line 31995

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) 


32002
32003
32004
 
# File 'lib/google/apis/compute_beta/classes.rb', line 32002

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) 


32008
32009
32010
 
# File 'lib/google/apis/compute_beta/classes.rb', line 32008

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) 


32020
32021
32022
 
# File 'lib/google/apis/compute_beta/classes.rb', line 32020

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


32026
32027
32028
 
# File 'lib/google/apis/compute_beta/classes.rb', line 32026

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


32032
32033
32034
 
# File 'lib/google/apis/compute_beta/classes.rb', line 32032

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


32039
32040
32041
 
# File 'lib/google/apis/compute_beta/classes.rb', line 32039

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) 


32045
32046
32047
 
# File 'lib/google/apis/compute_beta/classes.rb', line 32045

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) 


32055
32056
32057
 
# File 'lib/google/apis/compute_beta/classes.rb', line 32055

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) 


32060
32061
32062
 
# File 'lib/google/apis/compute_beta/classes.rb', line 32060

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) 


32066
32067
32068
 
# File 'lib/google/apis/compute_beta/classes.rb', line 32066

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:



32080
32081
32082
 
# File 'lib/google/apis/compute_beta/classes.rb', line 32080

def snapshot_encryption_key
  @snapshot_encryption_key
end

#source_disk ⇒ String

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

Returns:

  • (String) 


32085
32086
32087
 
# File 'lib/google/apis/compute_beta/classes.rb', line 32085

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:



32091
32092
32093
 
# File 'lib/google/apis/compute_beta/classes.rb', line 32091

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) 


32098
32099
32100
 
# File 'lib/google/apis/compute_beta/classes.rb', line 32098

def source_disk_id
  @source_disk_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) 


32104
32105
32106
 
# File 'lib/google/apis/compute_beta/classes.rb', line 32104

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) 


32110
32111
32112
 
# File 'lib/google/apis/compute_beta/classes.rb', line 32110

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) 


32118
32119
32120
 
# File 'lib/google/apis/compute_beta/classes.rb', line 32118

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


32124
32125
32126
 
# File 'lib/google/apis/compute_beta/classes.rb', line 32124

def storage_locations
  @storage_locations
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



32131
32132
32133
32134
32135
32136
32137
32138
32139
32140
32141
32142
32143
32144
32145
32146
32147
32148
32149
32150
32151
32152
32153
32154
32155
32156
32157
 
# File 'lib/google/apis/compute_beta/classes.rb', line 32131

def update!(**args)
  @auto_created = args[:auto_created] if args.key?(:auto_created)
  @chain_name = args[:chain_name] if args.key?(:chain_name)
  @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)
  @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)
  @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