Class: OCI::Database::Models::CreateDataGuardAssociationDetails

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

Overview

The configuration details for creating a Data Guard association between databases.

NOTE: "ExistingDbSystem" is the only supported ‘creationType` value. Therefore, all create_data_guard_association requests must include the `peerDbSystemId` parameter found in the create_data_guard_association_to_existing_db_system_details object.

This class has direct subclasses. If you are using this class as input to a service operations then you should favor using a subclass over the base class

Constant Summary collapse

PROTECTION_MODE_ENUM = 
[PROTECTION_MODE_MAXIMUM_AVAILABILITY = 'MAXIMUM_AVAILABILITY',
PROTECTION_MODE_MAXIMUM_PERFORMANCE = 'MAXIMUM_PERFORMANCE',
PROTECTION_MODE_MAXIMUM_PROTECTION = 'MAXIMUM_PROTECTION']
TRANSPORT_TYPE_ENUM = 
[TRANSPORT_TYPE_SYNC = 'SYNC',
TRANSPORT_TYPE_ASYNC = 'ASYNC',
TRANSPORT_TYPE_FASTSYNC = 'FASTSYNC']

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateDataGuardAssociationDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
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
 
# File 'lib/oci/database/models/create_data_guard_association_details.rb', line 92

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}

  if attributes[:'creationType']
    self.creation_type = attributes[:'creationType']
  end

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

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

  if attributes[:'databaseAdminPassword']
    self.database_admin_password = attributes[:'databaseAdminPassword']
  end

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

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

  if attributes[:'protectionMode']
    self.protection_mode = attributes[:'protectionMode']
  end

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

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

  if attributes[:'transportType']
    self.transport_type = attributes[:'transportType']
  end

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

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

end

Instance Attribute Details

#creation_type ⇒ String

[Required] Specifies where to create the associated database. "ExistingDbSystem" is the only supported ‘creationType` value.

Returns:

  • (String) 


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

def creation_type
  @creation_type
end

#database_admin_password ⇒ String

[Required] A strong password for the ‘SYS`, `SYSTEM`, and `PDB Admin` users to apply during standby creation.

The password must contain no fewer than nine characters and include:

  • At least two uppercase characters.

  • At least two lowercase characters.

  • At least two numeric characters.

  • At least two special characters. Valid special characters include "_", "#", and "-" only.

**The password MUST be the same as the primary admin password.**

Returns:

  • (String) 


48
49
50
 
# File 'lib/oci/database/models/create_data_guard_association_details.rb', line 48

def database_admin_password
  @database_admin_password
end

#protection_mode ⇒ String

[Required] The protection mode to set up between the primary and standby databases. For more information, see [Oracle Data Guard Protection Modes](docs.oracle.com/database/122/SBYDB/oracle-data-guard-protection-modes.htm#SBYDB02000) in the Oracle Data Guard documentation.

IMPORTANT - The only protection mode currently supported by the Database Service is MAXIMUM_PERFORMANCE.

Returns:

  • (String) 


57
58
59
 
# File 'lib/oci/database/models/create_data_guard_association_details.rb', line 57

def protection_mode
  @protection_mode
end

#transport_type ⇒ String

[Required] The redo transport type to use for this Data Guard association. Valid values depend on the specified ‘protectionMode`:

  • MAXIMUM_AVAILABILITY - SYNC or FASTSYNC

  • MAXIMUM_PERFORMANCE - ASYNC

  • MAXIMUM_PROTECTION - SYNC

For more information, see [Redo Transport Services](docs.oracle.com/database/122/SBYDB/oracle-data-guard-redo-transport-services.htm#SBYDB00400) in the Oracle Data Guard documentation.

IMPORTANT - The only transport type currently supported by the Database Service is ASYNC.

Returns:

  • (String) 


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

def transport_type
  @transport_type
end

Class Method Details

.get_subtype(object_hash) ⇒ Object

Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.



77
78
79
80
81
82
83
84
 
# File 'lib/oci/database/models/create_data_guard_association_details.rb', line 77

def self.get_subtype(object_hash)
  type = object_hash[:'creationType']

  return 'OCI::Database::Models::CreateDataGuardAssociationToExistingDbSystemDetails' if type == 'ExistingDbSystem'

  # TODO: Log a warning when the subtype is not found.
  return 'OCI::Database::Models::CreateDataGuardAssociationDetails'
end

Instance Method Details

#==(other_object) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other_object (Object) —

    to be compared



162
163
164
165
166
167
168
169
 
# File 'lib/oci/database/models/create_data_guard_association_details.rb', line 162

def ==(other_object)
  return true if self.equal?(other_object)
  self.class == other_object.class &&
      creation_type == other_object.creation_type &&
      database_admin_password == other_object.database_admin_password &&
      protection_mode == other_object.protection_mode &&
      transport_type == other_object.transport_type
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



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

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)
        self.public_method("#{key}=").call(attributes[self.class.attribute_map[key]].map{ |v| OCI::Internal::Util.convert_to_type($1, v) } )
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.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_object) ⇒ Boolean

Parameters:

  • other_object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


173
174
175
 
# File 'lib/oci/database/models/create_data_guard_association_details.rb', line 173

def eql?(other_object)
  self == other_object
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



179
180
181
 
# File 'lib/oci/database/models/create_data_guard_association_details.rb', line 179

def hash
  [creation_type, database_admin_password, protection_mode, transport_type].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



211
212
213
214
215
216
217
218
219
 
# File 'lib/oci/database/models/create_data_guard_association_details.rb', line 211

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



205
206
207
 
# File 'lib/oci/database/models/create_data_guard_association_details.rb', line 205

def to_s
  to_hash.to_s
end