Class: OCI::Mysql::Models::BackupSummary
- Inherits:
-
Object
- Object
- OCI::Mysql::Models::BackupSummary
- Defined in:
- lib/oci/mysql/models/backup_summary.rb
Overview
Details of Backups such as OCID, description, backupType, and so on.
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.
Instance Attribute Summary collapse
-
#backup_size_in_gbs ⇒ Integer
The size of the backup in GiBs.
-
#backup_type ⇒ String
[Required] The type of backup.
-
#compartment_id ⇒ String
[Required] The OCID of the compartment the backup exists in.
-
#creation_type ⇒ String
[Required] If the backup was created automatically, or by a manual request.
-
#data_storage_size_in_gbs ⇒ Integer
Size of the data volume in GiBs.
-
#db_system_id ⇒ String
[Required] The OCID of the DB System the Backup is associated with.
-
#defined_tags ⇒ Hash<String, Hash<String, Object>>
Defined tags for this resource.
-
#description ⇒ String
A user-supplied description of the backup.
-
#display_name ⇒ String
A user-supplied display name for the backup.
-
#freeform_tags ⇒ Hash<String, String>
Simple key-value pair that is applied without any predefined name, type or scope.
-
#id ⇒ String
[Required] OCID of the backup.
-
#lifecycle_state ⇒ String
[Required] The state of the backup.
-
#mysql_version ⇒ String
The version of the DB System used for backup.
-
#retention_in_days ⇒ Integer
Number of days to retain this backup.
-
#shape_name ⇒ String
The shape of the DB System instance used for backup.
-
#time_created ⇒ DateTime
[Required] The time the backup was created.
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 = {}) ⇒ BackupSummary
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 = {}) ⇒ BackupSummary
Initializes the object
156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 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 |
# File 'lib/oci/mysql/models/backup_summary.rb', line 156 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.id = attributes[:'id'] if attributes[:'id'] 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.description = attributes[:'description'] if attributes[:'description'] 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.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.backup_type = attributes[:'backupType'] if attributes[:'backupType'] raise 'You cannot provide both :backupType and :backup_type' if attributes.key?(:'backupType') && attributes.key?(:'backup_type') self.backup_type = attributes[:'backup_type'] if attributes[:'backup_type'] self.creation_type = attributes[:'creationType'] if attributes[:'creationType'] raise 'You cannot provide both :creationType and :creation_type' if attributes.key?(:'creationType') && attributes.key?(:'creation_type') self.creation_type = attributes[:'creation_type'] if attributes[:'creation_type'] self.db_system_id = attributes[:'dbSystemId'] if attributes[:'dbSystemId'] raise 'You cannot provide both :dbSystemId and :db_system_id' if attributes.key?(:'dbSystemId') && attributes.key?(:'db_system_id') self.db_system_id = attributes[:'db_system_id'] if attributes[:'db_system_id'] 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.data_storage_size_in_gbs = attributes[:'dataStorageSizeInGBs'] if attributes[:'dataStorageSizeInGBs'] raise 'You cannot provide both :dataStorageSizeInGBs and :data_storage_size_in_gbs' if attributes.key?(:'dataStorageSizeInGBs') && attributes.key?(:'data_storage_size_in_gbs') self.data_storage_size_in_gbs = attributes[:'data_storage_size_in_gbs'] if attributes[:'data_storage_size_in_gbs'] self.backup_size_in_gbs = attributes[:'backupSizeInGBs'] if attributes[:'backupSizeInGBs'] raise 'You cannot provide both :backupSizeInGBs and :backup_size_in_gbs' if attributes.key?(:'backupSizeInGBs') && attributes.key?(:'backup_size_in_gbs') self.backup_size_in_gbs = attributes[:'backup_size_in_gbs'] if attributes[:'backup_size_in_gbs'] self.retention_in_days = attributes[:'retentionInDays'] if attributes[:'retentionInDays'] raise 'You cannot provide both :retentionInDays and :retention_in_days' if attributes.key?(:'retentionInDays') && attributes.key?(:'retention_in_days') self.retention_in_days = attributes[:'retention_in_days'] if attributes[:'retention_in_days'] self.mysql_version = attributes[:'mysqlVersion'] if attributes[:'mysqlVersion'] raise 'You cannot provide both :mysqlVersion and :mysql_version' if attributes.key?(:'mysqlVersion') && attributes.key?(:'mysql_version') self.mysql_version = attributes[:'mysql_version'] if attributes[:'mysql_version'] self.shape_name = attributes[:'shapeName'] if attributes[:'shapeName'] raise 'You cannot provide both :shapeName and :shape_name' if attributes.key?(:'shapeName') && attributes.key?(:'shape_name') self.shape_name = attributes[:'shape_name'] if attributes[:'shape_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. = 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'] end |
Instance Attribute Details
#backup_size_in_gbs ⇒ Integer
The size of the backup in GiBs.
60 61 62 |
# File 'lib/oci/mysql/models/backup_summary.rb', line 60 def backup_size_in_gbs @backup_size_in_gbs end |
#backup_type ⇒ String
[Required] The type of backup.
40 41 42 |
# File 'lib/oci/mysql/models/backup_summary.rb', line 40 def backup_type @backup_type end |
#compartment_id ⇒ String
[Required] The OCID of the compartment the backup exists in.
52 53 54 |
# File 'lib/oci/mysql/models/backup_summary.rb', line 52 def compartment_id @compartment_id end |
#creation_type ⇒ String
[Required] If the backup was created automatically, or by a manual request.
44 45 46 |
# File 'lib/oci/mysql/models/backup_summary.rb', line 44 def creation_type @creation_type end |
#data_storage_size_in_gbs ⇒ Integer
Size of the data volume in GiBs.
56 57 58 |
# File 'lib/oci/mysql/models/backup_summary.rb', line 56 def data_storage_size_in_gbs @data_storage_size_in_gbs end |
#db_system_id ⇒ String
[Required] The OCID of the DB System the Backup is associated with.
48 49 50 |
# File 'lib/oci/mysql/models/backup_summary.rb', line 48 def db_system_id @db_system_id end |
#defined_tags ⇒ Hash<String, Hash<String, Object>>
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {\"foo-namespace\": {\"bar-key\": \"value\"}}
84 85 86 |
# File 'lib/oci/mysql/models/backup_summary.rb', line 84 def @defined_tags end |
#description ⇒ String
A user-supplied description of the backup.
28 29 30 |
# File 'lib/oci/mysql/models/backup_summary.rb', line 28 def description @description end |
#display_name ⇒ String
A user-supplied display name for the backup.
24 25 26 |
# File 'lib/oci/mysql/models/backup_summary.rb', line 24 def display_name @display_name end |
#freeform_tags ⇒ Hash<String, String>
Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {\"bar-key\": \"value\"}
78 79 80 |
# File 'lib/oci/mysql/models/backup_summary.rb', line 78 def @freeform_tags end |
#id ⇒ String
[Required] OCID of the backup.
20 21 22 |
# File 'lib/oci/mysql/models/backup_summary.rb', line 20 def id @id end |
#lifecycle_state ⇒ String
[Required] The state of the backup.
36 37 38 |
# File 'lib/oci/mysql/models/backup_summary.rb', line 36 def lifecycle_state @lifecycle_state end |
#mysql_version ⇒ String
The version of the DB System used for backup.
68 69 70 |
# File 'lib/oci/mysql/models/backup_summary.rb', line 68 def mysql_version @mysql_version end |
#retention_in_days ⇒ Integer
Number of days to retain this backup.
64 65 66 |
# File 'lib/oci/mysql/models/backup_summary.rb', line 64 def retention_in_days @retention_in_days end |
#shape_name ⇒ String
The shape of the DB System instance used for backup.
72 73 74 |
# File 'lib/oci/mysql/models/backup_summary.rb', line 72 def shape_name @shape_name end |
#time_created ⇒ DateTime
[Required] The time the backup was created.
32 33 34 |
# File 'lib/oci/mysql/models/backup_summary.rb', line 32 def time_created @time_created end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 |
# File 'lib/oci/mysql/models/backup_summary.rb', line 87 def self.attribute_map { # rubocop:disable Style/SymbolLiteral 'id': :'id', 'display_name': :'displayName', 'description': :'description', 'time_created': :'timeCreated', 'lifecycle_state': :'lifecycleState', 'backup_type': :'backupType', 'creation_type': :'creationType', 'db_system_id': :'dbSystemId', 'compartment_id': :'compartmentId', 'data_storage_size_in_gbs': :'dataStorageSizeInGBs', 'backup_size_in_gbs': :'backupSizeInGBs', 'retention_in_days': :'retentionInDays', 'mysql_version': :'mysqlVersion', 'shape_name': :'shapeName', 'freeform_tags': :'freeformTags', 'defined_tags': :'definedTags' # rubocop:enable Style/SymbolLiteral } end |
.swagger_types ⇒ Object
Attribute type mapping.
111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 |
# File 'lib/oci/mysql/models/backup_summary.rb', line 111 def self.swagger_types { # rubocop:disable Style/SymbolLiteral 'id': :'String', 'display_name': :'String', 'description': :'String', 'time_created': :'DateTime', 'lifecycle_state': :'String', 'backup_type': :'String', 'creation_type': :'String', 'db_system_id': :'String', 'compartment_id': :'String', 'data_storage_size_in_gbs': :'Integer', 'backup_size_in_gbs': :'Integer', 'retention_in_days': :'Integer', 'mysql_version': :'String', 'shape_name': :'String', 'freeform_tags': :'Hash<String, String>', 'defined_tags': :'Hash<String, Hash<String, Object>>' # rubocop:enable Style/SymbolLiteral } end |
Instance Method Details
#==(other) ⇒ Object
Checks equality by comparing each attribute.
258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 |
# File 'lib/oci/mysql/models/backup_summary.rb', line 258 def ==(other) return true if equal?(other) self.class == other.class && id == other.id && display_name == other.display_name && description == other.description && time_created == other.time_created && lifecycle_state == other.lifecycle_state && backup_type == other.backup_type && creation_type == other.creation_type && db_system_id == other.db_system_id && compartment_id == other.compartment_id && data_storage_size_in_gbs == other.data_storage_size_in_gbs && backup_size_in_gbs == other.backup_size_in_gbs && retention_in_days == other.retention_in_days && mysql_version == other.mysql_version && shape_name == other.shape_name && == other. && == other. end |
#build_from_hash(attributes) ⇒ Object
Builds the object from hash
303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 |
# File 'lib/oci/mysql/models/backup_summary.rb', line 303 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
283 284 285 |
# File 'lib/oci/mysql/models/backup_summary.rb', line 283 def eql?(other) self == other end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
292 293 294 |
# File 'lib/oci/mysql/models/backup_summary.rb', line 292 def hash [id, display_name, description, time_created, lifecycle_state, backup_type, creation_type, db_system_id, compartment_id, data_storage_size_in_gbs, backup_size_in_gbs, retention_in_days, mysql_version, shape_name, , ].hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
336 337 338 339 340 341 342 343 344 345 |
# File 'lib/oci/mysql/models/backup_summary.rb', line 336 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
330 331 332 |
# File 'lib/oci/mysql/models/backup_summary.rb', line 330 def to_s to_hash.to_s end |