Class: OCI::DatabaseManagement::Models::TestPreferredCredentialDetails

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

Overview

The status of the preferred credential test. The status is 'SUCCEEDED' if the preferred credential is working else the status is 'FAILED'. 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
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ TestPreferredCredentialDetails

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



62
63
64
65
66
67
68
69
# File 'lib/oci/database_management/models/test_preferred_credential_details.rb', line 62

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

Instance Attribute Details

#typeString

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

Returns:

  • (String)


19
20
21
# File 'lib/oci/database_management/models/test_preferred_credential_details.rb', line 19

def type
  @type
end

Class Method Details

.attribute_mapObject

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



22
23
24
25
26
27
28
# File 'lib/oci/database_management/models/test_preferred_credential_details.rb', line 22

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'type': :'type'
    # 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.



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

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

  return 'OCI::DatabaseManagement::Models::TestNamedPreferredCredentialDetails' if type == 'NAMED_CREDENTIAL'
  return 'OCI::DatabaseManagement::Models::TestBasicPreferredCredentialDetails' if type == 'BASIC'

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

.swagger_typesObject

Attribute type mapping.



31
32
33
34
35
36
37
# File 'lib/oci/database_management/models/test_preferred_credential_details.rb', line 31

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



86
87
88
89
90
91
# File 'lib/oci/database_management/models/test_preferred_credential_details.rb', line 86

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

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



116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
# File 'lib/oci/database_management/models/test_preferred_credential_details.rb', line 116

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


96
97
98
# File 'lib/oci/database_management/models/test_preferred_credential_details.rb', line 96

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



105
106
107
# File 'lib/oci/database_management/models/test_preferred_credential_details.rb', line 105

def hash
  [type].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



149
150
151
152
153
154
155
156
157
158
# File 'lib/oci/database_management/models/test_preferred_credential_details.rb', line 149

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



143
144
145
# File 'lib/oci/database_management/models/test_preferred_credential_details.rb', line 143

def to_s
  to_hash.to_s
end