Class: OCI::Database::Models::CreateDataGuardAssociationWithNewDbSystemDetails

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

Overview

The configuration details for creating a Data Guard association for a virtual machine DB system database. For this type of DB system database, the ‘creationType` should be `NewDbSystem`. A new DB system will be launched to create the standby database.

To create a Data Guard association for a database in a bare metal or Exadata DB system, use the create_data_guard_association_to_existing_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, #protection_mode, #transport_type

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from CreateDataGuardAssociationDetails

get_subtype

Constructor Details

#initialize(attributes = {}) ⇒ CreateDataGuardAssociationWithNewDbSystemDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :database_admin_password (String) —

    The value to assign to the #database_admin_password proprety

  • :protection_mode (String) —

    The value to assign to the #protection_mode proprety

  • :transport_type (String) —

    The value to assign to the #transport_type proprety

  • :display_name (String) —

    The value to assign to the #display_name property

  • :availability_domain (String) —

    The value to assign to the #availability_domain property

  • :shape (String) —

    The value to assign to the #shape property

  • :subnet_id (String) —

    The value to assign to the #subnet_id property

  • :nsg_ids (Array<String>) —

    The value to assign to the #nsg_ids property

  • :backup_network_nsg_ids (Array<String>) —

    The value to assign to the #backup_network_nsg_ids property

  • :hostname (String) —

    The value to assign to the #hostname property



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
 
# File 'lib/oci/database/models/create_data_guard_association_with_new_db_system_details.rb', line 111

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

  attributes['creationType'] = 'NewDbSystem'

  super(attributes)

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

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

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

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

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

  self.subnet_id = attributes[:'subnetId'] if attributes[:'subnetId']

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

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

  self.nsg_ids = attributes[:'nsgIds'] if attributes[:'nsgIds']

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

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

  self.backup_network_nsg_ids = attributes[:'backupNetworkNsgIds'] if attributes[:'backupNetworkNsgIds']

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

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

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

Instance Attribute Details

#availability_domain ⇒ String

The name of the availability domain that the standby database DB system will be located in. For example- "Uocm:PHX-AD-1".

Returns:

  • (String) 


20
21
22
 
# File 'lib/oci/database/models/create_data_guard_association_with_new_db_system_details.rb', line 20

def availability_domain
  @availability_domain
end

#backup_network_nsg_ids ⇒ Array<String>

A list of the [OCIDs](docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the network security groups (NSGs) that the backup network of this DB system belongs to. Setting this to an empty array after the list is created removes the resource from all NSGs. For more information about NSGs, see [Security Rules](docs.cloud.oracle.com/Content/Network/Concepts/securityrules.htm). Applicable only to Exadata DB systems.

Returns:

  • (Array<String>) 


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

def backup_network_nsg_ids
  @backup_network_nsg_ids
end

#display_name ⇒ String

The user-friendly name of the DB system that will contain the the standby database. The display name does not have to be unique.

Returns:

  • (String) 


16
17
18
 
# File 'lib/oci/database/models/create_data_guard_association_with_new_db_system_details.rb', line 16

def display_name
  @display_name
end

#hostname ⇒ String

The hostname for the DB node.

Returns:

  • (String) 


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

def hostname
  @hostname
end

#nsg_ids ⇒ Array<String>

A list of the [OCIDs](docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the network security groups (NSGs) that this resource belongs to. Setting this to an empty array after the list is created removes the resource from all NSGs. For more information about NSGs, see [Security Rules](docs.cloud.oracle.com/Content/Network/Concepts/securityrules.htm). **NsgIds restrictions:**

  • Autonomous Databases with private access require at least 1 Network Security Group (NSG). The nsgIds array cannot be empty.

Returns:

  • (Array<String>) 


46
47
48
 
# File 'lib/oci/database/models/create_data_guard_association_with_new_db_system_details.rb', line 46

def nsg_ids
  @nsg_ids
end

#shape ⇒ String

The virtual machine DB system shape to launch for the standby database in the Data Guard association. The shape determines the number of CPU cores and the amount of memory available for the DB system. Only virtual machine shapes are valid options. If you do not supply this parameter, the default shape is the shape of the primary DB system.

To get a list of all shapes, use the list_db_system_shapes operation.

Returns:

  • (String) 


28
29
30
 
# File 'lib/oci/database/models/create_data_guard_association_with_new_db_system_details.rb', line 28

def shape
  @shape
end

#subnet_id ⇒ String

The OCID of the subnet the DB system is associated with. **Subnet Restrictions:**

  • For 1- and 2-node RAC DB systems, do not use a subnet that overlaps with 192.168.16.16/28

These subnets are used by the Oracle Clusterware private interconnect on the database instance. Specifying an overlapping subnet will cause the private interconnect to malfunction. This restriction applies to both the client subnet and backup subnet.

Returns:

  • (String) 


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

def subnet_id
  @subnet_id
end

Class Method Details

.attribute_map ⇒ Object

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



58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/oci/database/models/create_data_guard_association_with_new_db_system_details.rb', line 58

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'database_admin_password': :'databaseAdminPassword',
    'protection_mode': :'protectionMode',
    'transport_type': :'transportType',
    'creation_type': :'creationType',
    'display_name': :'displayName',
    'availability_domain': :'availabilityDomain',
    'shape': :'shape',
    'subnet_id': :'subnetId',
    'nsg_ids': :'nsgIds',
    'backup_network_nsg_ids': :'backupNetworkNsgIds',
    'hostname': :'hostname'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'database_admin_password': :'String',
    'protection_mode': :'String',
    'transport_type': :'String',
    'creation_type': :'String',
    'display_name': :'String',
    'availability_domain': :'String',
    'shape': :'String',
    'subnet_id': :'String',
    'nsg_ids': :'Array<String>',
    'backup_network_nsg_ids': :'Array<String>',
    'hostname': :'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



163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
 
# File 'lib/oci/database/models/create_data_guard_association_with_new_db_system_details.rb', line 163

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

  self.class == other.class &&
    database_admin_password == other.database_admin_password &&
    protection_mode == other.protection_mode &&
    transport_type == other.transport_type &&
    creation_type == other.creation_type &&
    display_name == other.display_name &&
    availability_domain == other.availability_domain &&
    shape == other.shape &&
    subnet_id == other.subnet_id &&
    nsg_ids == other.nsg_ids &&
    backup_network_nsg_ids == other.backup_network_nsg_ids &&
    hostname == other.hostname
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



203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
 
# File 'lib/oci/database/models/create_data_guard_association_with_new_db_system_details.rb', line 203

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


183
184
185
 
# File 'lib/oci/database/models/create_data_guard_association_with_new_db_system_details.rb', line 183

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



192
193
194
 
# File 'lib/oci/database/models/create_data_guard_association_with_new_db_system_details.rb', line 192

def hash
  [database_admin_password, protection_mode, transport_type, creation_type, display_name, availability_domain, shape, subnet_id, nsg_ids, backup_network_nsg_ids, hostname].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



236
237
238
239
240
241
242
243
244
245
 
# File 'lib/oci/database/models/create_data_guard_association_with_new_db_system_details.rb', line 236

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



230
231
232
 
# File 'lib/oci/database/models/create_data_guard_association_with_new_db_system_details.rb', line 230

def to_s
  to_hash.to_s
end