class OCI::Database::Models::DatabaseConnectionCredentialsByDetails

User information to connect to the database. Required when performing the {#create_external_database_connector_details create_external_database_connector_details} operation. IMPORTANT: Not supported for the {#update_external_database_connector_details update_external_database_connector_details} operation.

Constants

ROLE_ENUM

Attributes

credential_name[RW]

The name of the credential information that used to connect to the database. The name should be in "x.y" format, where the length of "x" has a maximum of 64 characters, and length of "y" has a maximum of 199 characters. The name strings can contain letters, numbers and the underscore character only. Other characters are not valid, except for the "." character that separates the "x" and "y" portions of the name. IMPORTANT - The name must be unique within the OCI region the credential is being created in. If you specify a name that duplicates the name of another credential within the same OCI region, you may overwrite or corrupt the credential that is already using the name.

For example: inventorydb.abc112233445566778899

@return [String]

password[RW]

[Required] The password that will be used to connect to the database. @return [String]

role[R]

[Required] The role of the user that will be connecting to the database. @return [String]

username[RW]

[Required] The username that will be used to connect to the database. @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/database_connection_credentials_by_details.rb, line 46
def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'credential_type': :'credentialType',
    'credential_name': :'credentialName',
    'username': :'username',
    'password': :'password',
    'role': :'role'
    # 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] :credential_name The value to assign to the {#credential_name} property @option attributes [String] :username The value to assign to the {#username} property @option attributes [String] :password The value to assign to the {#password} property @option attributes [String] :role The value to assign to the {#role} property

# File lib/oci/database/models/database_connection_credentials_by_details.rb, line 81
def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  attributes['credentialType'] = 'DETAILS'

  super(attributes)

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

  self.credential_name = attributes[:'credentialName'] if attributes[:'credentialName']

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

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

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

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

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

Attribute type mapping.

# File lib/oci/database/models/database_connection_credentials_by_details.rb, line 59
def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'credential_type': :'String',
    'credential_name': :'String',
    'username': :'String',
    'password': :'String',
    'role': :'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/database_connection_credentials_by_details.rb, line 124
def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    credential_type == other.credential_type &&
    credential_name == other.credential_name &&
    username == other.username &&
    password == other.password &&
    role == other.role
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/database_connection_credentials_by_details.rb, line 158
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/database_connection_credentials_by_details.rb, line 138
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/database_connection_credentials_by_details.rb, line 147
def hash
  [credential_type, credential_name, username, password, role].hash
end
role=(role) click to toggle source

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

# File lib/oci/database/models/database_connection_credentials_by_details.rb, line 108
def role=(role)
  # rubocop:disable Style/ConditionalAssignment
  if role && !ROLE_ENUM.include?(role)
    OCI.logger.debug("Unknown value for 'role' [" + role + "]. Mapping to 'ROLE_UNKNOWN_ENUM_VALUE'") if OCI.logger
    @role = ROLE_UNKNOWN_ENUM_VALUE
  else
    @role = role
  end
  # rubocop:enable Style/ConditionalAssignment
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/database_connection_credentials_by_details.rb, line 191
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/database_connection_credentials_by_details.rb, line 185
def to_s
  to_hash.to_s
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/database_connection_credentials_by_details.rb, line 208
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