class OCI::Database::Models::UpdateDataGuardAssociationDetails

The configuration details for updating a Data Guard association for a database.

Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.

Constants

PROTECTION_MODE_ENUM
TRANSPORT_TYPE_ENUM

Attributes

database_admin_password[RW]

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.**

@return [String]

protection_mode[R]

The protection mode for the Data Guard association's primary and standby database. 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.

@return [String]

transport_type[R]

The redo transport type to use for this Data Guard association. Valid values depend on the specified 'protectionMode':

  • MAXIMUM_AVAILABILITY - Use SYNC or FASTSYNC

  • MAXIMUM_PERFORMANCE - Use ASYNC

  • MAXIMUM_PROTECTION - Use 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.

@return [String]

Public Class Methods

attribute_map() click to toggle source

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

# File lib/oci/database/models/update_data_guard_association_details.rb, line 62
def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'database_admin_password': :'databaseAdminPassword',
    'protection_mode': :'protectionMode',
    'transport_type': :'transportType'
    # rubocop:enable Style/SymbolLiteral
  }
end
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash @option attributes [String] :database_admin_password The value to assign to the {#database_admin_password} property @option attributes [String] :protection_mode The value to assign to the {#protection_mode} property @option attributes [String] :transport_type The value to assign to the {#transport_type} property

# File lib/oci/database/models/update_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 }

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

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

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

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

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

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

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

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

  self.transport_type = attributes[:'transport_type'] if attributes[:'transport_type']
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/oci/database/models/update_data_guard_association_details.rb, line 73
def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'database_admin_password': :'String',
    'protection_mode': :'String',
    'transport_type': :'String'
    # rubocop:enable Style/SymbolLiteral
  }
end

Public Instance Methods

==(other) click to toggle source

Checks equality by comparing each attribute. @param [Object] other the other object to be compared

# File lib/oci/database/models/update_data_guard_association_details.rb, line 140
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
end
build_from_hash(attributes) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/oci/database/models/update_data_guard_association_details.rb, line 172
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) click to toggle source

@see the `==` method @param [Object] other the other object to be compared

# File lib/oci/database/models/update_data_guard_association_details.rb, line 152
def eql?(other)
  self == other
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Fixnum] Hash code

# File lib/oci/database/models/update_data_guard_association_details.rb, line 161
def hash
  [database_admin_password, protection_mode, transport_type].hash
end
protection_mode=(protection_mode) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] protection_mode Object to be assigned

# File lib/oci/database/models/update_data_guard_association_details.rb, line 121
def protection_mode=(protection_mode)
  raise "Invalid value for 'protection_mode': this must be one of the values in PROTECTION_MODE_ENUM." if protection_mode && !PROTECTION_MODE_ENUM.include?(protection_mode)

  @protection_mode = protection_mode
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# File lib/oci/database/models/update_data_guard_association_details.rb, line 205
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() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/oci/database/models/update_data_guard_association_details.rb, line 199
def to_s
  to_hash.to_s
end
transport_type=(transport_type) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] transport_type Object to be assigned

# File lib/oci/database/models/update_data_guard_association_details.rb, line 129
def transport_type=(transport_type)
  raise "Invalid value for 'transport_type': this must be one of the values in TRANSPORT_TYPE_ENUM." if transport_type && !TRANSPORT_TYPE_ENUM.include?(transport_type)

  @transport_type = transport_type
end

Private Instance Methods

_to_hash(value) click to toggle source

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash

# File lib/oci/database/models/update_data_guard_association_details.rb, line 222
def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end