Class: OCI::Database::Models::BackupDestinationConfigurationSummary

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

Overview

Information about the Autonomous Container Database's secondary backup destination(s).

Constant Summary collapse

TYPE_ENUM = 
[
  TYPE_NFS = 'NFS'.freeze,
  TYPE_RECOVERY_APPLIANCE = 'RECOVERY_APPLIANCE'.freeze,
  TYPE_OBJECT_STORE = 'OBJECT_STORE'.freeze,
  TYPE_LOCAL = 'LOCAL'.freeze,
  TYPE_DBRS = 'DBRS'.freeze,
  TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ BackupDestinationConfigurationSummary

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
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
 
# File 'lib/oci/database/models/backup_destination_configuration_summary.rb', line 113

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

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

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

  self.backup_destination_attach_history = attributes[:'backupDestinationAttachHistory'] if attributes[:'backupDestinationAttachHistory']

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

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

  self.space_utilized_in_gbs = attributes[:'spaceUtilizedInGBs'] if attributes[:'spaceUtilizedInGBs']

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

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

  self.time_at_which_storage_details_are_updated = attributes[:'timeAtWhichStorageDetailsAreUpdated'] if attributes[:'timeAtWhichStorageDetailsAreUpdated']

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

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

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

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

  self.vpc_user = attributes[:'vpcUser'] if attributes[:'vpcUser']

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

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

  self.vpc_password = attributes[:'vpcPassword'] if attributes[:'vpcPassword']

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

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

  self.internet_proxy = attributes[:'internetProxy'] if attributes[:'internetProxy']

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

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

  self.dbrs_policy_id = attributes[:'dbrsPolicyId'] if attributes[:'dbrsPolicyId']

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

  self.dbrs_policy_id = attributes[:'dbrs_policy_id'] if attributes[:'dbrs_policy_id']
end

Instance Attribute Details

#backup_destination_attach_history ⇒ Array<DateTime>

The timestamps at which this backup destination is used as the preferred destination to host the Autonomous Container Database backups.

Returns:

  • (Array<DateTime>) 


27
28
29
 
# File 'lib/oci/database/models/backup_destination_configuration_summary.rb', line 27

def backup_destination_attach_history
  @backup_destination_attach_history
end

#dbrs_policy_id ⇒ String

The OCID of the DBRS policy used for backup.

Returns:

  • (String) 


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

def dbrs_policy_id
  @dbrs_policy_id
end

#id ⇒ String

The OCID of the backup destination.

Returns:

  • (String) 


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

def id
  @id
end

#internet_proxy ⇒ String

Proxy URL to connect to object store.

Returns:

  • (String) 


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

def internet_proxy
  @internet_proxy
end

#recovery_window_in_days ⇒ Integer

Number of days between the current and earliest point of recoverability covered by automatic backups and manual backups, but not long term backups.

Returns:

  • (Integer) 


23
24
25
 
# File 'lib/oci/database/models/backup_destination_configuration_summary.rb', line 23

def recovery_window_in_days
  @recovery_window_in_days
end

#space_utilized_in_gbs ⇒ Integer

The total space utilized (in GBs) by this Autonomous Container Database on this backup destination, rounded to the nearest integer.

Returns:

  • (Integer) 


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

def space_utilized_in_gbs
  @space_utilized_in_gbs
end

#time_at_which_storage_details_are_updated ⇒ DateTime

The latest timestamp when the backup destination details, such as 'spaceUtilized,' are updated.

Returns:

  • (DateTime) 


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

def time_at_which_storage_details_are_updated
  @time_at_which_storage_details_are_updated
end

#type ⇒ String

[Required] Type of the database backup destination.

Returns:

  • (String) 


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

def type
  @type
end

#vpc_password ⇒ String

For a RECOVERY_APPLIANCE backup destination, the password for the VPC user that is used to access the Recovery Appliance.

Returns:

  • (String) 


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

def vpc_password
  @vpc_password
end

#vpc_user ⇒ String

For a RECOVERY_APPLIANCE backup destination, the Virtual Private Catalog (VPC) user that is used to access the Recovery Appliance.

Returns:

  • (String) 


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

def vpc_user
  @vpc_user
end

Class Method Details

.attribute_map ⇒ Object

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



62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/oci/database/models/backup_destination_configuration_summary.rb', line 62

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'recovery_window_in_days': :'recoveryWindowInDays',
    'backup_destination_attach_history': :'backupDestinationAttachHistory',
    'space_utilized_in_gbs': :'spaceUtilizedInGBs',
    'time_at_which_storage_details_are_updated': :'timeAtWhichStorageDetailsAreUpdated',
    'type': :'type',
    'id': :'id',
    'vpc_user': :'vpcUser',
    'vpc_password': :'vpcPassword',
    'internet_proxy': :'internetProxy',
    'dbrs_policy_id': :'dbrsPolicyId'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'recovery_window_in_days': :'Integer',
    'backup_destination_attach_history': :'Array<DateTime>',
    'space_utilized_in_gbs': :'Integer',
    'time_at_which_storage_details_are_updated': :'DateTime',
    'type': :'String',
    'id': :'String',
    'vpc_user': :'String',
    'vpc_password': :'String',
    'internet_proxy': :'String',
    'dbrs_policy_id': :'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



192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
 
# File 'lib/oci/database/models/backup_destination_configuration_summary.rb', line 192

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

  self.class == other.class &&
    recovery_window_in_days == other.recovery_window_in_days &&
    backup_destination_attach_history == other.backup_destination_attach_history &&
    space_utilized_in_gbs == other.space_utilized_in_gbs &&
    time_at_which_storage_details_are_updated == other.time_at_which_storage_details_are_updated &&
    type == other.type &&
    id == other.id &&
    vpc_user == other.vpc_user &&
    vpc_password == other.vpc_password &&
    internet_proxy == other.internet_proxy &&
    dbrs_policy_id == other.dbrs_policy_id
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



231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
 
# File 'lib/oci/database/models/backup_destination_configuration_summary.rb', line 231

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


211
212
213
 
# File 'lib/oci/database/models/backup_destination_configuration_summary.rb', line 211

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



220
221
222
 
# File 'lib/oci/database/models/backup_destination_configuration_summary.rb', line 220

def hash
  [recovery_window_in_days, backup_destination_attach_history, space_utilized_in_gbs, time_at_which_storage_details_are_updated, type, id, vpc_user, vpc_password, internet_proxy, dbrs_policy_id].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



264
265
266
267
268
269
270
271
272
273
 
# File 'lib/oci/database/models/backup_destination_configuration_summary.rb', line 264

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



258
259
260
 
# File 'lib/oci/database/models/backup_destination_configuration_summary.rb', line 258

def to_s
  to_hash.to_s
end