Class: OCI::Database::Models::CreateDataGuardAssociationToExistingDbSystemDetails

Inherits:
CreateDataGuardAssociationDetails show all
Defined in:
lib/oci/database/models/create_data_guard_association_to_existing_db_system_details.rb

Overview

The configuration details for creating a Data Guard association for a bare metal or Exadata DB system database. For these types of DB system databases, the creationType should be ExistingDbSystem. A standby database will be created in the DB system you specify.

To create a Data Guard association for a database in a virtual machine DB system, use the create_data_guard_association_with_new_db_system_details subtype instead.

Constant Summary

Constants inherited from CreateDataGuardAssociationDetails

OCI::Database::Models::CreateDataGuardAssociationDetails::PROTECTION_MODE_ENUM, OCI::Database::Models::CreateDataGuardAssociationDetails::TRANSPORT_TYPE_ENUM

Instance Attribute Summary collapse

Attributes inherited from CreateDataGuardAssociationDetails

#creation_type, #database_admin_password, #database_software_image_id, #is_active_data_guard_enabled, #peer_db_unique_name, #peer_sid_prefix, #protection_mode, #transport_type

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from CreateDataGuardAssociationDetails

get_subtype

Constructor Details

#initialize(attributes = {}) ⇒ CreateDataGuardAssociationToExistingDbSystemDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  attributes['creationType'] = 'ExistingDbSystem'

  super(attributes)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  self.peer_db_system_id = attributes[:'peerDbSystemId'] if attributes[:'peerDbSystemId']

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

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

  self.peer_db_home_id = attributes[:'peerDbHomeId'] if attributes[:'peerDbHomeId']

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

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

Instance Attribute Details

#peer_db_home_id ⇒ String

The OCID of the DB home in which to create the standby database. You must supply this value to create standby database with an existing DB home

Returns:

  • (String) 


25
26
27
 
# File 'lib/oci/database/models/create_data_guard_association_to_existing_db_system_details.rb', line 25

def peer_db_home_id
  @peer_db_home_id
end

#peer_db_system_id ⇒ String

The OCID of the DB system in which to create the standby database. You must supply this value if creationType is ExistingDbSystem.

Returns:

  • (String) 


19
20
21
 
# File 'lib/oci/database/models/create_data_guard_association_to_existing_db_system_details.rb', line 19

def peer_db_system_id
  @peer_db_system_id
end

Class Method Details

.attribute_map ⇒ Object

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



28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
 
# File 'lib/oci/database/models/create_data_guard_association_to_existing_db_system_details.rb', line 28

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'database_software_image_id': :'databaseSoftwareImageId',
    'database_admin_password': :'databaseAdminPassword',
    'protection_mode': :'protectionMode',
    'transport_type': :'transportType',
    'creation_type': :'creationType',
    'is_active_data_guard_enabled': :'isActiveDataGuardEnabled',
    'peer_db_unique_name': :'peerDbUniqueName',
    'peer_sid_prefix': :'peerSidPrefix',
    'peer_db_system_id': :'peerDbSystemId',
    'peer_db_home_id': :'peerDbHomeId'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
 
# File 'lib/oci/database/models/create_data_guard_association_to_existing_db_system_details.rb', line 46

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'database_software_image_id': :'String',
    'database_admin_password': :'String',
    'protection_mode': :'String',
    'transport_type': :'String',
    'creation_type': :'String',
    'is_active_data_guard_enabled': :'BOOLEAN',
    'peer_db_unique_name': :'String',
    'peer_sid_prefix': :'String',
    'peer_db_system_id': :'String',
    'peer_db_home_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



108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
 
# File 'lib/oci/database/models/create_data_guard_association_to_existing_db_system_details.rb', line 108

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

  self.class == other.class &&
    database_software_image_id == other.database_software_image_id &&
    database_admin_password == other.database_admin_password &&
    protection_mode == other.protection_mode &&
    transport_type == other.transport_type &&
    creation_type == other.creation_type &&
    is_active_data_guard_enabled == other.is_active_data_guard_enabled &&
    peer_db_unique_name == other.peer_db_unique_name &&
    peer_sid_prefix == other.peer_sid_prefix &&
    peer_db_system_id == other.peer_db_system_id &&
    peer_db_home_id == other.peer_db_home_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



147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
 
# File 'lib/oci/database/models/create_data_guard_association_to_existing_db_system_details.rb', line 147

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


127
128
129
 
# File 'lib/oci/database/models/create_data_guard_association_to_existing_db_system_details.rb', line 127

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



136
137
138
 
# File 'lib/oci/database/models/create_data_guard_association_to_existing_db_system_details.rb', line 136

def hash
  [database_software_image_id, database_admin_password, protection_mode, transport_type, creation_type, is_active_data_guard_enabled, peer_db_unique_name, peer_sid_prefix, peer_db_system_id, peer_db_home_id].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



180
181
182
183
184
185
186
187
188
189
 
# File 'lib/oci/database/models/create_data_guard_association_to_existing_db_system_details.rb', line 180

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



174
175
176
 
# File 'lib/oci/database/models/create_data_guard_association_to_existing_db_system_details.rb', line 174

def to_s
  to_hash.to_s
end