Class: OCI::Opsi::Models::CredentialDetails

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/opsi/models/credential_details.rb

Overview

User credential details to connect to the database.

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

CREDENTIAL_TYPE_ENUM = 
[
  CREDENTIAL_TYPE_CREDENTIALS_BY_SOURCE = 'CREDENTIALS_BY_SOURCE'.freeze,
  CREDENTIAL_TYPE_CREDENTIALS_BY_VAULT = 'CREDENTIALS_BY_VAULT'.freeze,
  CREDENTIAL_TYPE_CREDENTIALS_BY_IAM = 'CREDENTIALS_BY_IAM'.freeze,
  CREDENTIAL_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CredentialDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
 
# File 'lib/oci/opsi/models/credential_details.rb', line 75

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

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

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

  self.credential_type = attributes[:'credentialType'] if attributes[:'credentialType']

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

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

Instance Attribute Details

#credential_source_name ⇒ String

[Required] Credential source name that had been added in Management Agent wallet. This is supplied in the External Database Service.

Returns:

  • (String) 


23
24
25
 
# File 'lib/oci/opsi/models/credential_details.rb', line 23

def credential_source_name
  @credential_source_name
end

#credential_type ⇒ String

[Required] CREDENTIALS_BY_SOURCE is supplied via the External Database Service. CREDENTIALS_BY_VAULT is supplied by secret service to connection PE_COMANAGED_DATABASE and ADB as well. CREDENTIALS_BY_IAM is used db-token to connect only for Autonomous Database.

Returns:

  • (String) 


28
29
30
 
# File 'lib/oci/opsi/models/credential_details.rb', line 28

def credential_type
  @credential_type
end

Class Method Details

.attribute_map ⇒ Object

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



31
32
33
34
35
36
37
38
 
# File 'lib/oci/opsi/models/credential_details.rb', line 31

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

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



55
56
57
58
59
60
61
62
63
64
 
# File 'lib/oci/opsi/models/credential_details.rb', line 55

def self.get_subtype(object_hash)
  type = object_hash[:'credentialType'] # rubocop:disable Style/SymbolLiteral

  return 'OCI::Opsi::Models::CredentialsBySource' if type == 'CREDENTIALS_BY_SOURCE'
  return 'OCI::Opsi::Models::CredentialByVault' if type == 'CREDENTIALS_BY_VAULT'
  return 'OCI::Opsi::Models::CredentialByIam' if type == 'CREDENTIALS_BY_IAM'

  # TODO: Log a warning when the subtype is not found.
  'OCI::Opsi::Models::CredentialDetails'
end

.swagger_types ⇒ Object

Attribute type mapping.



41
42
43
44
45
46
47
48
 
# File 'lib/oci/opsi/models/credential_details.rb', line 41

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



114
115
116
117
118
119
120
 
# File 'lib/oci/opsi/models/credential_details.rb', line 114

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

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



145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
 
# File 'lib/oci/opsi/models/credential_details.rb', line 145

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


125
126
127
 
# File 'lib/oci/opsi/models/credential_details.rb', line 125

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



134
135
136
 
# File 'lib/oci/opsi/models/credential_details.rb', line 134

def hash
  [credential_source_name, credential_type].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



178
179
180
181
182
183
184
185
186
187
 
# File 'lib/oci/opsi/models/credential_details.rb', line 178

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



172
173
174
 
# File 'lib/oci/opsi/models/credential_details.rb', line 172

def to_s
  to_hash.to_s
end