Class: OCI::DatabaseManagement::Models::PreferredCredential

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/database_management/models/preferred_credential.rb

Overview

The details of the preferred credential. 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

TYPE_ENUM = 
[
  TYPE_BASIC = 'BASIC'.freeze,
  TYPE_NAMED_CREDENTIAL = 'NAMED_CREDENTIAL'.freeze,
  TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
STATUS_ENUM = 
[
  STATUS_SET = 'SET'.freeze,
  STATUS_NOT_SET = 'NOT_SET'.freeze,
  STATUS_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PreferredCredential

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :type (String) —

    The value to assign to the #type property

  • :credential_name (String) —

    The value to assign to the #credential_name property

  • :status (String) —

    The value to assign to the #status property

  • :is_accessible (BOOLEAN) —

    The value to assign to the #is_accessible property



91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
 
# File 'lib/oci/database_management/models/preferred_credential.rb', line 91

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

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

  self.is_accessible = attributes[:'isAccessible'] unless attributes[:'isAccessible'].nil?

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

  self.is_accessible = attributes[:'is_accessible'] unless attributes[:'is_accessible'].nil?
end

Instance Attribute Details

#credential_name ⇒ String

The name of the preferred credential.

Returns:

  • (String) 


31
32
33
 
# File 'lib/oci/database_management/models/preferred_credential.rb', line 31

def credential_name
  @credential_name
end

#is_accessible ⇒ BOOLEAN

Indicates whether the preferred credential is accessible.

Returns:

  • (BOOLEAN) 


39
40
41
 
# File 'lib/oci/database_management/models/preferred_credential.rb', line 39

def is_accessible
  @is_accessible
end

#status ⇒ String

The status of the preferred credential.

Returns:

  • (String) 


35
36
37
 
# File 'lib/oci/database_management/models/preferred_credential.rb', line 35

def status
  @status
end

#type ⇒ String

The type of preferred credential. Only 'BASIC' is supported currently.

Returns:

  • (String) 


27
28
29
 
# File 'lib/oci/database_management/models/preferred_credential.rb', line 27

def type
  @type
end

Class Method Details

.attribute_map ⇒ Object

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



42
43
44
45
46
47
48
49
50
51
 
# File 'lib/oci/database_management/models/preferred_credential.rb', line 42

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'type': :'type',
    'credential_name': :'credentialName',
    'status': :'status',
    'is_accessible': :'isAccessible'
    # 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.



70
71
72
73
74
75
76
77
78
 
# File 'lib/oci/database_management/models/preferred_credential.rb', line 70

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

  return 'OCI::DatabaseManagement::Models::NamedPreferredCredential' if type == 'NAMED_CREDENTIAL'
  return 'OCI::DatabaseManagement::Models::BasicPreferredCredential' if type == 'BASIC'

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

.swagger_types ⇒ Object

Attribute type mapping.



54
55
56
57
58
59
60
61
62
63
 
# File 'lib/oci/database_management/models/preferred_credential.rb', line 54

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



147
148
149
150
151
152
153
154
155
 
# File 'lib/oci/database_management/models/preferred_credential.rb', line 147

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

  self.class == other.class &&
    type == other.type &&
    credential_name == other.credential_name &&
    status == other.status &&
    is_accessible == other.is_accessible
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



180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
 
# File 'lib/oci/database_management/models/preferred_credential.rb', line 180

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


160
161
162
 
# File 'lib/oci/database_management/models/preferred_credential.rb', line 160

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



169
170
171
 
# File 'lib/oci/database_management/models/preferred_credential.rb', line 169

def hash
  [type, credential_name, status, is_accessible].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



213
214
215
216
217
218
219
220
221
222
 
# File 'lib/oci/database_management/models/preferred_credential.rb', line 213

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



207
208
209
 
# File 'lib/oci/database_management/models/preferred_credential.rb', line 207

def to_s
  to_hash.to_s
end