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](docs.cloud.oracle.com/Content/Identity/Concepts/policygetstarted.htm).

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



129
130
131
132
133
134
135
136
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
 
# File 'lib/oci/database/models/autonomous_database_backup_summary.rb', line 129

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']
end

Instance Attribute Details

#autonomous_database_id ⇒ String

[Required] The [OCID](docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the Autonomous Database.

Returns:

  • (String) 


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

def autonomous_database_id
  @autonomous_database_id
end

#compartment_id ⇒ String

[Required] The [OCID](docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the compartment.

Returns:

  • (String) 


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

def compartment_id
  @compartment_id
end

#database_size_in_tbs ⇒ Float

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

Returns:

  • (Float) 


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

def database_size_in_tbs
  @database_size_in_tbs
end

#display_name ⇒ String

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

Returns:

  • (String) 


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

def display_name
  @display_name
end

#id ⇒ String

[Required] The [OCID](docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the Autonomous Database backup.

Returns:

  • (String) 


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

def id
  @id
end

#is_automatic ⇒ BOOLEAN

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

Returns:

  • (BOOLEAN) 


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

def is_automatic
  @is_automatic
end

#lifecycle_details ⇒ String

Additional information about the current lifecycle state.

Returns:

  • (String) 


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

def lifecycle_details
  @lifecycle_details
end

#lifecycle_state ⇒ String

[Required] The current state of the backup.

Returns:

  • (String) 


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

def lifecycle_state
  @lifecycle_state
end

#time_ended ⇒ DateTime

The date and time the backup completed.

Returns:

  • (DateTime) 


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

def time_ended
  @time_ended
end

#time_started ⇒ DateTime

The date and time the backup started.

Returns:

  • (DateTime) 


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

def time_started
  @time_started
end

#type ⇒ String

[Required] The type of backup.

Returns:

  • (String) 


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

def type
  @type
end

Class Method Details

.attribute_map ⇒ Object

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



75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/oci/database/models/autonomous_database_backup_summary.rb', line 75

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'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
 
# File 'lib/oci/database/models/autonomous_database_backup_summary.rb', line 94

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



227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
 
# File 'lib/oci/database/models/autonomous_database_backup_summary.rb', line 227

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



267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
 
# File 'lib/oci/database/models/autonomous_database_backup_summary.rb', line 267

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


247
248
249
 
# File 'lib/oci/database/models/autonomous_database_backup_summary.rb', line 247

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



256
257
258
 
# File 'lib/oci/database/models/autonomous_database_backup_summary.rb', line 256

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].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



300
301
302
303
304
305
306
307
308
309
 
# File 'lib/oci/database/models/autonomous_database_backup_summary.rb', line 300

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

Returns:

  • (String) —

    String presentation of the object



294
295
296
 
# File 'lib/oci/database/models/autonomous_database_backup_summary.rb', line 294

def to_s
  to_hash.to_s
end