Class: OCI::Database::Models::AutonomousDatabaseBackupSummary

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/database/models/autonomous_database_backup_summary.rb

Overview

An Autonomous Database backup. 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.

Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.

Constant Summary collapse

TYPE_ENUM =
[
  TYPE_INCREMENTAL = 'INCREMENTAL'.freeze,
  TYPE_FULL = 'FULL'.freeze,
  TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
LIFECYCLE_STATE_ENUM =
[
  LIFECYCLE_STATE_CREATING = 'CREATING'.freeze,
  LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze,
  LIFECYCLE_STATE_DELETING = 'DELETING'.freeze,
  LIFECYCLE_STATE_DELETED = 'DELETED'.freeze,
  LIFECYCLE_STATE_FAILED = 'FAILED'.freeze,
  LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ AutonomousDatabaseBackupSummary

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {})

    Model attributes in the form of hash

Options Hash (attributes):

  • :id (String)

    The value to assign to the #id property

  • :compartment_id (String)

    The value to assign to the #compartment_id property

  • :autonomous_database_id (String)

    The value to assign to the #autonomous_database_id property

  • :display_name (String)

    The value to assign to the #display_name property

  • :type (String)

    The value to assign to the #type property

  • :is_automatic (BOOLEAN)

    The value to assign to the #is_automatic property

  • :time_started (DateTime)

    The value to assign to the #time_started property

  • :time_ended (DateTime)

    The value to assign to the #time_ended property

  • :lifecycle_details (String)

    The value to assign to the #lifecycle_details property

  • :database_size_in_tbs (Float)

    The value to assign to the #database_size_in_tbs property

  • :lifecycle_state (String)

    The value to assign to the #lifecycle_state property

  • :is_restorable (BOOLEAN)

    The value to assign to the #is_restorable property



137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
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
# File 'lib/oci/database/models/autonomous_database_backup_summary.rb', line 137

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.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.autonomous_database_id = attributes[:'autonomousDatabaseId'] if attributes[:'autonomousDatabaseId']

  raise 'You cannot provide both :autonomousDatabaseId and :autonomous_database_id' if attributes.key?(:'autonomousDatabaseId') && attributes.key?(:'autonomous_database_id')

  self.autonomous_database_id = attributes[:'autonomous_database_id'] if attributes[:'autonomous_database_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.type = attributes[:'type'] if attributes[:'type']

  self.is_automatic = attributes[:'isAutomatic'] unless attributes[:'isAutomatic'].nil?

  raise 'You cannot provide both :isAutomatic and :is_automatic' if attributes.key?(:'isAutomatic') && attributes.key?(:'is_automatic')

  self.is_automatic = attributes[:'is_automatic'] unless attributes[:'is_automatic'].nil?

  self.time_started = attributes[:'timeStarted'] if attributes[:'timeStarted']

  raise 'You cannot provide both :timeStarted and :time_started' if attributes.key?(:'timeStarted') && attributes.key?(:'time_started')

  self.time_started = attributes[:'time_started'] if attributes[:'time_started']

  self.time_ended = attributes[:'timeEnded'] if attributes[:'timeEnded']

  raise 'You cannot provide both :timeEnded and :time_ended' if attributes.key?(:'timeEnded') && attributes.key?(:'time_ended')

  self.time_ended = attributes[:'time_ended'] if attributes[:'time_ended']

  self.lifecycle_details = attributes[:'lifecycleDetails'] if attributes[:'lifecycleDetails']

  raise 'You cannot provide both :lifecycleDetails and :lifecycle_details' if attributes.key?(:'lifecycleDetails') && attributes.key?(:'lifecycle_details')

  self.lifecycle_details = attributes[:'lifecycle_details'] if attributes[:'lifecycle_details']

  self.database_size_in_tbs = attributes[:'databaseSizeInTBs'] if attributes[:'databaseSizeInTBs']

  raise 'You cannot provide both :databaseSizeInTBs and :database_size_in_tbs' if attributes.key?(:'databaseSizeInTBs') && attributes.key?(:'database_size_in_tbs')

  self.database_size_in_tbs = attributes[:'database_size_in_tbs'] if attributes[:'database_size_in_tbs']

  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.is_restorable = attributes[:'isRestorable'] unless attributes[:'isRestorable'].nil?
  self.is_restorable = true if is_restorable.nil? && !attributes.key?(:'isRestorable') # rubocop:disable Style/StringLiterals

  raise 'You cannot provide both :isRestorable and :is_restorable' if attributes.key?(:'isRestorable') && attributes.key?(:'is_restorable')

  self.is_restorable = attributes[:'is_restorable'] unless attributes[:'is_restorable'].nil?
  self.is_restorable = true if is_restorable.nil? && !attributes.key?(:'isRestorable') && !attributes.key?(:'is_restorable') # rubocop:disable Style/StringLiterals
end

Instance Attribute Details

#autonomous_database_idString

[Required] The OCID of the Autonomous Database.

Returns:

  • (String)


40
41
42
# File 'lib/oci/database/models/autonomous_database_backup_summary.rb', line 40

def autonomous_database_id
  @autonomous_database_id
end

#compartment_idString

[Required] The OCID of the compartment.

Returns:

  • (String)


36
37
38
# File 'lib/oci/database/models/autonomous_database_backup_summary.rb', line 36

def compartment_id
  @compartment_id
end

#database_size_in_tbsFloat

The size of the database in terabytes at the time the backup was taken.

Returns:

  • (Float)


69
70
71
# File 'lib/oci/database/models/autonomous_database_backup_summary.rb', line 69

def database_size_in_tbs
  @database_size_in_tbs
end

#display_nameString

[Required] The user-friendly name for the backup. The name does not have to be unique.

Returns:

  • (String)


44
45
46
# File 'lib/oci/database/models/autonomous_database_backup_summary.rb', line 44

def display_name
  @display_name
end

#idString

[Required] The OCID of the Autonomous Database backup.

Returns:

  • (String)


32
33
34
# File 'lib/oci/database/models/autonomous_database_backup_summary.rb', line 32

def id
  @id
end

#is_automaticBOOLEAN

[Required] Indicates whether the backup is user-initiated or automatic.

Returns:

  • (BOOLEAN)


52
53
54
# File 'lib/oci/database/models/autonomous_database_backup_summary.rb', line 52

def is_automatic
  @is_automatic
end

#is_restorableBOOLEAN

Indicates whether the backup can be used to restore the associated Autonomous Database.

Returns:

  • (BOOLEAN)


77
78
79
# File 'lib/oci/database/models/autonomous_database_backup_summary.rb', line 77

def is_restorable
  @is_restorable
end

#lifecycle_detailsString

Additional information about the current lifecycle state.

Returns:

  • (String)


64
65
66
# File 'lib/oci/database/models/autonomous_database_backup_summary.rb', line 64

def lifecycle_details
  @lifecycle_details
end

#lifecycle_stateString

[Required] The current state of the backup.

Returns:

  • (String)


73
74
75
# File 'lib/oci/database/models/autonomous_database_backup_summary.rb', line 73

def lifecycle_state
  @lifecycle_state
end

#time_endedDateTime

The date and time the backup completed.

Returns:

  • (DateTime)


60
61
62
# File 'lib/oci/database/models/autonomous_database_backup_summary.rb', line 60

def time_ended
  @time_ended
end

#time_startedDateTime

The date and time the backup started.

Returns:

  • (DateTime)


56
57
58
# File 'lib/oci/database/models/autonomous_database_backup_summary.rb', line 56

def time_started
  @time_started
end

#typeString

[Required] The type of backup.

Returns:

  • (String)


48
49
50
# File 'lib/oci/database/models/autonomous_database_backup_summary.rb', line 48

def type
  @type
end

Class Method Details

.attribute_mapObject

Attribute mapping from ruby-style variable name to JSON key.



80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
# File 'lib/oci/database/models/autonomous_database_backup_summary.rb', line 80

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'compartment_id': :'compartmentId',
    'autonomous_database_id': :'autonomousDatabaseId',
    'display_name': :'displayName',
    'type': :'type',
    'is_automatic': :'isAutomatic',
    'time_started': :'timeStarted',
    'time_ended': :'timeEnded',
    'lifecycle_details': :'lifecycleDetails',
    'database_size_in_tbs': :'databaseSizeInTBs',
    'lifecycle_state': :'lifecycleState',
    'is_restorable': :'isRestorable'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_typesObject

Attribute type mapping.



100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
# File 'lib/oci/database/models/autonomous_database_backup_summary.rb', line 100

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'compartment_id': :'String',
    'autonomous_database_id': :'String',
    'display_name': :'String',
    'type': :'String',
    'is_automatic': :'BOOLEAN',
    'time_started': :'DateTime',
    'time_ended': :'DateTime',
    'lifecycle_details': :'String',
    'database_size_in_tbs': :'Float',
    'lifecycle_state': :'String',
    'is_restorable': :'BOOLEAN'
    # rubocop:enable Style/SymbolLiteral
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other (Object)

    the other object to be compared



243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
# File 'lib/oci/database/models/autonomous_database_backup_summary.rb', line 243

def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    id == other.id &&
    compartment_id == other.compartment_id &&
    autonomous_database_id == other.autonomous_database_id &&
    display_name == other.display_name &&
    type == other.type &&
    is_automatic == other.is_automatic &&
    time_started == other.time_started &&
    time_ended == other.time_ended &&
    lifecycle_details == other.lifecycle_details &&
    database_size_in_tbs == other.database_size_in_tbs &&
    lifecycle_state == other.lifecycle_state &&
    is_restorable == other.is_restorable
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash)

    Model attributes in the form of hash

Returns:

  • (Object)

    Returns the model itself



284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
# File 'lib/oci/database/models/autonomous_database_backup_summary.rb', line 284

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

Parameters:

  • other (Object)

    the other object to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


264
265
266
# File 'lib/oci/database/models/autonomous_database_backup_summary.rb', line 264

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



273
274
275
# File 'lib/oci/database/models/autonomous_database_backup_summary.rb', line 273

def hash
  [id, compartment_id, autonomous_database_id, display_name, type, is_automatic, time_started, time_ended, lifecycle_details, database_size_in_tbs, lifecycle_state, is_restorable].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



317
318
319
320
321
322
323
324
325
326
# File 'lib/oci/database/models/autonomous_database_backup_summary.rb', line 317

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



311
312
313
# File 'lib/oci/database/models/autonomous_database_backup_summary.rb', line 311

def to_s
  to_hash.to_s
end