Class: OCI::DistributedDatabase::Models::DistributedDbBackupDestination

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/distributed_database/models/distributed_db_backup_destination.rb

Overview

Backup destination details

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 = {}) ⇒ DistributedDbBackupDestination

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :type (String) —

    The value to assign to the #type property

  • :id (String) —

    The value to assign to the #id property

  • :vpc_user (String) —

    The value to assign to the #vpc_user property

  • :vpc_password (String) —

    The value to assign to the #vpc_password property

  • :is_zero_data_loss_enabled (BOOLEAN) —

    The value to assign to the #is_zero_data_loss_enabled property

  • :internet_proxy (String) —

    The value to assign to the #internet_proxy property

  • :dbrs_policy_id (String) —

    The value to assign to the #dbrs_policy_id property

  • :is_remote (BOOLEAN) —

    The value to assign to the #is_remote property

  • :remote_region (String) —

    The value to assign to the #remote_region property



109
110
111
112
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
 
# File 'lib/oci/distributed_database/models/distributed_db_backup_destination.rb', line 109

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

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

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

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

  self.is_remote = attributes[:'isRemote'] unless attributes[:'isRemote'].nil?
  self.is_remote = false if is_remote.nil? && !attributes.key?(:'isRemote') # rubocop:disable Style/StringLiterals

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

  self.is_remote = attributes[:'is_remote'] unless attributes[:'is_remote'].nil?
  self.is_remote = false if is_remote.nil? && !attributes.key?(:'isRemote') && !attributes.key?(:'is_remote') # rubocop:disable Style/StringLiterals

  self.remote_region = attributes[:'remoteRegion'] if attributes[:'remoteRegion']

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

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

Instance Attribute Details

#dbrs_policy_id ⇒ String

The OCID of the DBRS policy used for backup.

Returns:

  • (String) 


47
48
49
 
# File 'lib/oci/distributed_database/models/distributed_db_backup_destination.rb', line 47

def dbrs_policy_id
  @dbrs_policy_id
end

#id ⇒ String

The OCID of the backup destination.

Returns:

  • (String) 


27
28
29
 
# File 'lib/oci/distributed_database/models/distributed_db_backup_destination.rb', line 27

def id
  @id
end

#internet_proxy ⇒ String

Proxy URL to connect to object store.

Returns:

  • (String) 


43
44
45
 
# File 'lib/oci/distributed_database/models/distributed_db_backup_destination.rb', line 43

def internet_proxy
  @internet_proxy
end

#is_remote ⇒ BOOLEAN

Indicates whether the backup destination is cross-region or local region.

Returns:

  • (BOOLEAN) 


51
52
53
 
# File 'lib/oci/distributed_database/models/distributed_db_backup_destination.rb', line 51

def is_remote
  @is_remote
end

#is_zero_data_loss_enabled ⇒ BOOLEAN

Indicates whether Zero Data Loss functionality is enabled for a Recovery Appliance backup destination in an Autonomous Container Database. When enabled, the database automatically ships all redo logs in real-time to the Recovery Appliance for a Zero Data Loss recovery setup (sub-second RPO). Defaults to TRUE if no value is given.

Returns:

  • (BOOLEAN) 


39
40
41
 
# File 'lib/oci/distributed_database/models/distributed_db_backup_destination.rb', line 39

def is_zero_data_loss_enabled
  @is_zero_data_loss_enabled
end

#remote_region ⇒ String

The name of the remote region where the remote automatic incremental backups will be stored. For information about valid region names, see Regions and Availability Domains.

Returns:

  • (String) 


58
59
60
 
# File 'lib/oci/distributed_database/models/distributed_db_backup_destination.rb', line 58

def remote_region
  @remote_region
end

#type ⇒ String

[Required] Type of the database backup destination.

Returns:

  • (String) 


23
24
25
 
# File 'lib/oci/distributed_database/models/distributed_db_backup_destination.rb', line 23

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) 


35
36
37
 
# File 'lib/oci/distributed_database/models/distributed_db_backup_destination.rb', line 35

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) 


31
32
33
 
# File 'lib/oci/distributed_database/models/distributed_db_backup_destination.rb', line 31

def vpc_user
  @vpc_user
end

Class Method Details

.attribute_map ⇒ Object

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



61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/oci/distributed_database/models/distributed_db_backup_destination.rb', line 61

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'type': :'type',
    'id': :'id',
    'vpc_user': :'vpcUser',
    'vpc_password': :'vpcPassword',
    'is_zero_data_loss_enabled': :'isZeroDataLossEnabled',
    'internet_proxy': :'internetProxy',
    'dbrs_policy_id': :'dbrsPolicyId',
    'is_remote': :'isRemote',
    'remote_region': :'remoteRegion'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
 
# File 'lib/oci/distributed_database/models/distributed_db_backup_destination.rb', line 78

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'type': :'String',
    'id': :'String',
    'vpc_user': :'String',
    'vpc_password': :'String',
    'is_zero_data_loss_enabled': :'BOOLEAN',
    'internet_proxy': :'String',
    'dbrs_policy_id': :'String',
    'is_remote': :'BOOLEAN',
    'remote_region': :'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



186
187
188
189
190
191
192
193
194
195
196
197
198
199
 
# File 'lib/oci/distributed_database/models/distributed_db_backup_destination.rb', line 186

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

  self.class == other.class &&
    type == other.type &&
    id == other.id &&
    vpc_user == other.vpc_user &&
    vpc_password == other.vpc_password &&
    is_zero_data_loss_enabled == other.is_zero_data_loss_enabled &&
    internet_proxy == other.internet_proxy &&
    dbrs_policy_id == other.dbrs_policy_id &&
    is_remote == other.is_remote &&
    remote_region == other.remote_region
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



224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
 
# File 'lib/oci/distributed_database/models/distributed_db_backup_destination.rb', line 224

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


204
205
206
 
# File 'lib/oci/distributed_database/models/distributed_db_backup_destination.rb', line 204

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



213
214
215
 
# File 'lib/oci/distributed_database/models/distributed_db_backup_destination.rb', line 213

def hash
  [type, id, vpc_user, vpc_password, is_zero_data_loss_enabled, internet_proxy, dbrs_policy_id, is_remote, remote_region].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



257
258
259
260
261
262
263
264
265
266
 
# File 'lib/oci/distributed_database/models/distributed_db_backup_destination.rb', line 257

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



251
252
253
 
# File 'lib/oci/distributed_database/models/distributed_db_backup_destination.rb', line 251

def to_s
  to_hash.to_s
end