Class: OCI::Database::Models::DatabaseConnectionCredentialsByName

Inherits:
DatabaseConnectionCredentials show all
Defined in:
lib/oci/database/models/database_connection_credentials_by_name.rb

Overview

Existing named credential used to connect to the database.

Constant Summary

Constants inherited from DatabaseConnectionCredentials

OCI::Database::Models::DatabaseConnectionCredentials::CREDENTIAL_TYPE_ENUM

Instance Attribute Summary collapse

Attributes inherited from DatabaseConnectionCredentials

#credential_type

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from DatabaseConnectionCredentials

get_subtype

Constructor Details

#initialize(attributes = {}) ⇒ DatabaseConnectionCredentialsByName

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :credential_name (String) —

    The value to assign to the #credential_name property



53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
 
# File 'lib/oci/database/models/database_connection_credentials_by_name.rb', line 53

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

  attributes['credentialType'] = 'NAME_REFERENCE'

  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']
end

Instance Attribute Details

#credential_name ⇒ String

[Required] 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

Returns:

  • (String) 


24
25
26
 
# File 'lib/oci/database/models/database_connection_credentials_by_name.rb', line 24

def credential_name
  @credential_name
end

Class Method Details

.attribute_map ⇒ Object

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



27
28
29
30
31
32
33
34
 
# File 'lib/oci/database/models/database_connection_credentials_by_name.rb', line 27

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'credential_type': :'credentialType',
    'credential_name': :'credentialName'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



37
38
39
40
41
42
43
44
 
# File 'lib/oci/database/models/database_connection_credentials_by_name.rb', line 37

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'credential_type': :'String',
    'credential_name': :'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



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

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

  self.class == other.class &&
    credential_type == other.credential_type &&
    credential_name == other.credential_name
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



108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
 
# File 'lib/oci/database/models/database_connection_credentials_by_name.rb', line 108

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


88
89
90
 
# File 'lib/oci/database/models/database_connection_credentials_by_name.rb', line 88

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



97
98
99
 
# File 'lib/oci/database/models/database_connection_credentials_by_name.rb', line 97

def hash
  [credential_type, credential_name].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



141
142
143
144
145
146
147
148
149
150
 
# File 'lib/oci/database/models/database_connection_credentials_by_name.rb', line 141

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



135
136
137
 
# File 'lib/oci/database/models/database_connection_credentials_by_name.rb', line 135

def to_s
  to_hash.to_s
end