Class: OCI::Core::Models::VolumeGroupBackup
- Inherits:
-
Object
- Object
- OCI::Core::Models::VolumeGroupBackup
- Defined in:
- lib/oci/core/models/volume_group_backup.rb
Overview
A point-in-time copy of a volume group that can then be used to create a new volume group or restore a volume group. For more information, see [Volume Groups](docs.us-phoenix-1.oraclecloud.com/Content/Block/Concepts/volumegroups.htm).
To use any of the API operations, you must be authorized in an IAM policy. If you’re not authorized, talk to an administrator. If you’re an administrator who needs to write policies to give users access, see [Getting Started with Policies](docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/policygetstarted.htm).
Constant Summary collapse
- LIFECYCLE_STATE_ENUM =
rubocop:disable Metrics/LineLength
[ LIFECYCLE_STATE_CREATING = 'CREATING'.freeze, LIFECYCLE_STATE_COMMITTED = 'COMMITTED'.freeze, LIFECYCLE_STATE_AVAILABLE = 'AVAILABLE'.freeze, LIFECYCLE_STATE_TERMINATING = 'TERMINATING'.freeze, LIFECYCLE_STATE_TERMINATED = 'TERMINATED'.freeze, LIFECYCLE_STATE_FAULTY = 'FAULTY'.freeze, LIFECYCLE_STATE_REQUEST_RECEIVED = 'REQUEST_RECEIVED'.freeze, LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze ].freeze
- TYPE_ENUM =
[ TYPE_FULL = 'FULL'.freeze, TYPE_INCREMENTAL = 'INCREMENTAL'.freeze, TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze ].freeze
Instance Attribute Summary collapse
-
#compartment_id ⇒ String
[Required] The OCID of the compartment that contains the volume group backup.
-
#defined_tags ⇒ Hash<String, Hash<String, Object>>
Defined tags for this resource.
-
#display_name ⇒ String
[Required] A user-friendly name for the volume group backup.
-
#freeform_tags ⇒ Hash<String, String>
Free-form tags for this resource.
-
#id ⇒ String
[Required] The OCID of the volume group backup.
-
#lifecycle_state ⇒ String
[Required] The current state of a volume group backup.
-
#size_in_gbs ⇒ Integer
The aggregate size of the volume group backup, in GBs.
-
#size_in_mbs ⇒ Integer
The aggregate size of the volume group backup, in MBs.
-
#time_created ⇒ DateTime
[Required] The date and time the volume group backup was created.
-
#time_request_received ⇒ DateTime
The date and time the request to create the volume group backup was received.
-
#type ⇒ String
[Required] The type of backup.
-
#unique_size_in_gbs ⇒ Integer
The aggregate size used by the volume group backup, in GBs.
-
#unique_size_in_mbs ⇒ Integer
The aggregate size used by the volume group backup, in MBs.
-
#volume_backup_ids ⇒ Array<String>
[Required] OCIDs for the volume backups in this volume group backup.
-
#volume_group_id ⇒ String
The OCID of the source volume group.
Class Method Summary collapse
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.swagger_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(other) ⇒ Object
Checks equality by comparing each attribute.
-
#build_from_hash(attributes) ⇒ Object
Builds the object from hash.
- #eql?(other) ⇒ Boolean
-
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ VolumeGroupBackup
constructor
Initializes the object.
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
Constructor Details
#initialize(attributes = {}) ⇒ VolumeGroupBackup
Initializes the object
180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 |
# File 'lib/oci/core/models/volume_group_backup.rb', line 180 def initialize(attributes = {}) return unless attributes.is_a?(Hash) # convert string to symbol for hash key attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v } self.compartment_id = attributes[:'compartmentId'] if attributes[:'compartmentId'] raise 'You cannot provide both :compartmentId and :compartment_id' if attributes.key?(:'compartmentId') && attributes.key?(:'compartment_id') self.compartment_id = attributes[:'compartment_id'] if attributes[:'compartment_id'] self. = attributes[:'definedTags'] if attributes[:'definedTags'] raise 'You cannot provide both :definedTags and :defined_tags' if attributes.key?(:'definedTags') && attributes.key?(:'defined_tags') self. = attributes[:'defined_tags'] if attributes[:'defined_tags'] self.display_name = attributes[:'displayName'] if attributes[:'displayName'] raise 'You cannot provide both :displayName and :display_name' if attributes.key?(:'displayName') && attributes.key?(:'display_name') self.display_name = attributes[:'display_name'] if attributes[:'display_name'] self. = attributes[:'freeformTags'] if attributes[:'freeformTags'] raise 'You cannot provide both :freeformTags and :freeform_tags' if attributes.key?(:'freeformTags') && attributes.key?(:'freeform_tags') self. = attributes[:'freeform_tags'] if attributes[:'freeform_tags'] self.id = attributes[:'id'] if attributes[:'id'] self.lifecycle_state = attributes[:'lifecycleState'] if attributes[:'lifecycleState'] raise 'You cannot provide both :lifecycleState and :lifecycle_state' if attributes.key?(:'lifecycleState') && attributes.key?(:'lifecycle_state') self.lifecycle_state = attributes[:'lifecycle_state'] if attributes[:'lifecycle_state'] self.size_in_mbs = attributes[:'sizeInMBs'] if attributes[:'sizeInMBs'] raise 'You cannot provide both :sizeInMBs and :size_in_mbs' if attributes.key?(:'sizeInMBs') && attributes.key?(:'size_in_mbs') self.size_in_mbs = attributes[:'size_in_mbs'] if attributes[:'size_in_mbs'] self.size_in_gbs = attributes[:'sizeInGBs'] if attributes[:'sizeInGBs'] raise 'You cannot provide both :sizeInGBs and :size_in_gbs' if attributes.key?(:'sizeInGBs') && attributes.key?(:'size_in_gbs') self.size_in_gbs = attributes[:'size_in_gbs'] if attributes[:'size_in_gbs'] self.time_created = attributes[:'timeCreated'] if attributes[:'timeCreated'] raise 'You cannot provide both :timeCreated and :time_created' if attributes.key?(:'timeCreated') && attributes.key?(:'time_created') self.time_created = attributes[:'time_created'] if attributes[:'time_created'] self.time_request_received = attributes[:'timeRequestReceived'] if attributes[:'timeRequestReceived'] raise 'You cannot provide both :timeRequestReceived and :time_request_received' if attributes.key?(:'timeRequestReceived') && attributes.key?(:'time_request_received') self.time_request_received = attributes[:'time_request_received'] if attributes[:'time_request_received'] self.type = attributes[:'type'] if attributes[:'type'] self.unique_size_in_mbs = attributes[:'uniqueSizeInMbs'] if attributes[:'uniqueSizeInMbs'] raise 'You cannot provide both :uniqueSizeInMbs and :unique_size_in_mbs' if attributes.key?(:'uniqueSizeInMbs') && attributes.key?(:'unique_size_in_mbs') self.unique_size_in_mbs = attributes[:'unique_size_in_mbs'] if attributes[:'unique_size_in_mbs'] self.unique_size_in_gbs = attributes[:'uniqueSizeInGbs'] if attributes[:'uniqueSizeInGbs'] raise 'You cannot provide both :uniqueSizeInGbs and :unique_size_in_gbs' if attributes.key?(:'uniqueSizeInGbs') && attributes.key?(:'unique_size_in_gbs') self.unique_size_in_gbs = attributes[:'unique_size_in_gbs'] if attributes[:'unique_size_in_gbs'] self.volume_backup_ids = attributes[:'volumeBackupIds'] if attributes[:'volumeBackupIds'] raise 'You cannot provide both :volumeBackupIds and :volume_backup_ids' if attributes.key?(:'volumeBackupIds') && attributes.key?(:'volume_backup_ids') self.volume_backup_ids = attributes[:'volume_backup_ids'] if attributes[:'volume_backup_ids'] self.volume_group_id = attributes[:'volumeGroupId'] if attributes[:'volumeGroupId'] raise 'You cannot provide both :volumeGroupId and :volume_group_id' if attributes.key?(:'volumeGroupId') && attributes.key?(:'volume_group_id') self.volume_group_id = attributes[:'volume_group_id'] if attributes[:'volume_group_id'] end |
Instance Attribute Details
#compartment_id ⇒ String
[Required] The OCID of the compartment that contains the volume group backup.
35 36 37 |
# File 'lib/oci/core/models/volume_group_backup.rb', line 35 def compartment_id @compartment_id end |
#defined_tags ⇒ Hash<String, Hash<String, Object>>
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
Example: ‘{"CostCenter": "42"}`
43 44 45 |
# File 'lib/oci/core/models/volume_group_backup.rb', line 43 def @defined_tags end |
#display_name ⇒ String
[Required] A user-friendly name for the volume group backup. Does not have to be unique and it’s changeable. Avoid entering confidential information.
47 48 49 |
# File 'lib/oci/core/models/volume_group_backup.rb', line 47 def display_name @display_name end |
#freeform_tags ⇒ Hash<String, String>
Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
Example: ‘"Finance"`
56 57 58 |
# File 'lib/oci/core/models/volume_group_backup.rb', line 56 def @freeform_tags end |
#id ⇒ String
[Required] The OCID of the volume group backup.
60 61 62 |
# File 'lib/oci/core/models/volume_group_backup.rb', line 60 def id @id end |
#lifecycle_state ⇒ String
[Required] The current state of a volume group backup.
64 65 66 |
# File 'lib/oci/core/models/volume_group_backup.rb', line 64 def lifecycle_state @lifecycle_state end |
#size_in_gbs ⇒ Integer
The aggregate size of the volume group backup, in GBs.
74 75 76 |
# File 'lib/oci/core/models/volume_group_backup.rb', line 74 def size_in_gbs @size_in_gbs end |
#size_in_mbs ⇒ Integer
The aggregate size of the volume group backup, in MBs.
69 70 71 |
# File 'lib/oci/core/models/volume_group_backup.rb', line 69 def size_in_mbs @size_in_mbs end |
#time_created ⇒ DateTime
[Required] The date and time the volume group backup was created. This is the time the actual point-in-time image of the volume group data was taken. Format defined by RFC3339.
80 81 82 |
# File 'lib/oci/core/models/volume_group_backup.rb', line 80 def time_created @time_created end |
#time_request_received ⇒ DateTime
The date and time the request to create the volume group backup was received. Format defined by RFC3339.
85 86 87 |
# File 'lib/oci/core/models/volume_group_backup.rb', line 85 def time_request_received @time_request_received end |
#type ⇒ String
[Required] The type of backup.
89 90 91 |
# File 'lib/oci/core/models/volume_group_backup.rb', line 89 def type @type end |
#unique_size_in_gbs ⇒ Integer
The aggregate size used by the volume group backup, in GBs. It is typically smaller than sizeInGBs, depending on the space consumed on the volume group and whether the volume backup is full or incremental.
103 104 105 |
# File 'lib/oci/core/models/volume_group_backup.rb', line 103 def unique_size_in_gbs @unique_size_in_gbs end |
#unique_size_in_mbs ⇒ Integer
The aggregate size used by the volume group backup, in MBs. It is typically smaller than sizeInMBs, depending on the space consumed on the volume group and whether the volume backup is full or incremental.
96 97 98 |
# File 'lib/oci/core/models/volume_group_backup.rb', line 96 def unique_size_in_mbs @unique_size_in_mbs end |
#volume_backup_ids ⇒ Array<String>
[Required] OCIDs for the volume backups in this volume group backup.
107 108 109 |
# File 'lib/oci/core/models/volume_group_backup.rb', line 107 def volume_backup_ids @volume_backup_ids end |
#volume_group_id ⇒ String
The OCID of the source volume group.
111 112 113 |
# File 'lib/oci/core/models/volume_group_backup.rb', line 111 def volume_group_id @volume_group_id end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 |
# File 'lib/oci/core/models/volume_group_backup.rb', line 114 def self.attribute_map { # rubocop:disable Style/SymbolLiteral 'compartment_id': :'compartmentId', 'defined_tags': :'definedTags', 'display_name': :'displayName', 'freeform_tags': :'freeformTags', 'id': :'id', 'lifecycle_state': :'lifecycleState', 'size_in_mbs': :'sizeInMBs', 'size_in_gbs': :'sizeInGBs', 'time_created': :'timeCreated', 'time_request_received': :'timeRequestReceived', 'type': :'type', 'unique_size_in_mbs': :'uniqueSizeInMbs', 'unique_size_in_gbs': :'uniqueSizeInGbs', 'volume_backup_ids': :'volumeBackupIds', 'volume_group_id': :'volumeGroupId' # rubocop:enable Style/SymbolLiteral } end |
.swagger_types ⇒ Object
Attribute type mapping.
137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 |
# File 'lib/oci/core/models/volume_group_backup.rb', line 137 def self.swagger_types { # rubocop:disable Style/SymbolLiteral 'compartment_id': :'String', 'defined_tags': :'Hash<String, Hash<String, Object>>', 'display_name': :'String', 'freeform_tags': :'Hash<String, String>', 'id': :'String', 'lifecycle_state': :'String', 'size_in_mbs': :'Integer', 'size_in_gbs': :'Integer', 'time_created': :'DateTime', 'time_request_received': :'DateTime', 'type': :'String', 'unique_size_in_mbs': :'Integer', 'unique_size_in_gbs': :'Integer', 'volume_backup_ids': :'Array<String>', 'volume_group_id': :'String' # rubocop:enable Style/SymbolLiteral } end |
Instance Method Details
#==(other) ⇒ Object
Checks equality by comparing each attribute.
306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 |
# File 'lib/oci/core/models/volume_group_backup.rb', line 306 def ==(other) return true if equal?(other) self.class == other.class && compartment_id == other.compartment_id && == other. && display_name == other.display_name && == other. && id == other.id && lifecycle_state == other.lifecycle_state && size_in_mbs == other.size_in_mbs && size_in_gbs == other.size_in_gbs && time_created == other.time_created && time_request_received == other.time_request_received && type == other.type && unique_size_in_mbs == other.unique_size_in_mbs && unique_size_in_gbs == other.unique_size_in_gbs && volume_backup_ids == other.volume_backup_ids && volume_group_id == other.volume_group_id end |
#build_from_hash(attributes) ⇒ Object
Builds the object from hash
349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 |
# File 'lib/oci/core/models/volume_group_backup.rb', line 349 def build_from_hash(attributes) return nil unless attributes.is_a?(Hash) self.class.swagger_types.each_pair do |key, type| if type =~ /^Array<(.*)>/i # check to ensure the input is an array given that the the attribute # is documented as an array but the input is not if attributes[self.class.attribute_map[key]].is_a?(Array) public_method("#{key}=").call( attributes[self.class.attribute_map[key]] .map { |v| OCI::Internal::Util.convert_to_type(Regexp.last_match(1), v) } ) end elsif !attributes[self.class.attribute_map[key]].nil? public_method("#{key}=").call( OCI::Internal::Util.convert_to_type(type, attributes[self.class.attribute_map[key]]) ) end # or else data not found in attributes(hash), not an issue as the data can be optional end self end |
#eql?(other) ⇒ Boolean
329 330 331 |
# File 'lib/oci/core/models/volume_group_backup.rb', line 329 def eql?(other) self == other end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
338 339 340 |
# File 'lib/oci/core/models/volume_group_backup.rb', line 338 def hash [compartment_id, , display_name, , id, lifecycle_state, size_in_mbs, size_in_gbs, time_created, time_request_received, type, unique_size_in_mbs, unique_size_in_gbs, volume_backup_ids, volume_group_id].hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
381 382 383 384 385 386 387 388 389 |
# File 'lib/oci/core/models/volume_group_backup.rb', line 381 def to_hash hash = {} self.class.attribute_map.each_pair do |attr, param| value = public_method(attr).call next if value.nil? && !instance_variable_defined?("@#{attr}") hash[param] = _to_hash(value) end hash end |
#to_s ⇒ String
Returns the string representation of the object
375 376 377 |
# File 'lib/oci/core/models/volume_group_backup.rb', line 375 def to_s to_hash.to_s end |