Class: OCI::DatabaseTools::Models::ValidationExternalAuthenticationStatus

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/database_tools/models/validation_external_authentication_status.rb

Overview

Status details for an external authentication

Constant Summary collapse

TYPE_ENUM = 
[
  TYPE_OCI_IAM = 'OCI_IAM'.freeze,
  TYPE_AZURE_AD = 'AZURE_AD'.freeze,
  TYPE_NONE = 'NONE'.freeze,
  TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
STATUS_ENUM = 
[
  STATUS_AVAILABLE = 'AVAILABLE'.freeze,
  STATUS_UNAVAILABLE = 'UNAVAILABLE'.freeze,
  STATUS_ENABLED = 'ENABLED'.freeze,
  STATUS_UNKNOWN = 'UNKNOWN'.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 = {}) ⇒ ValidationExternalAuthenticationStatus

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

  • :status (String) —

    The value to assign to the #status property

  • :status_details (String) —

    The value to assign to the #status_details property



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/oci/database_tools/models/validation_external_authentication_status.rb', line 72

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

  self.status_details = attributes[:'statusDetails'] if attributes[:'statusDetails']

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

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

Instance Attribute Details

#status ⇒ String

The status of the external authentication. AVAILABLE if the external authentication can be used with this connection. UNAVAILABLE if not. ENABLED if the external authentication is enabled.

Returns:

  • (String) 


35
36
37
 
# File 'lib/oci/database_tools/models/validation_external_authentication_status.rb', line 35

def status
  @status
end

#status_details ⇒ String

If the status is UNAVAILABLE this displays the cause.

Returns:

  • (String) 


39
40
41
 
# File 'lib/oci/database_tools/models/validation_external_authentication_status.rb', line 39

def status_details
  @status_details
end

#type ⇒ String

The Database Tools identity provider type.

Returns:

  • (String) 


29
30
31
 
# File 'lib/oci/database_tools/models/validation_external_authentication_status.rb', line 29

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
 
# File 'lib/oci/database_tools/models/validation_external_authentication_status.rb', line 42

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'type': :'type',
    'status': :'status',
    'status_details': :'statusDetails'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



53
54
55
56
57
58
59
60
61
 
# File 'lib/oci/database_tools/models/validation_external_authentication_status.rb', line 53

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



122
123
124
125
126
127
128
129
 
# File 'lib/oci/database_tools/models/validation_external_authentication_status.rb', line 122

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

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



154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
 
# File 'lib/oci/database_tools/models/validation_external_authentication_status.rb', line 154

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


134
135
136
 
# File 'lib/oci/database_tools/models/validation_external_authentication_status.rb', line 134

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



143
144
145
 
# File 'lib/oci/database_tools/models/validation_external_authentication_status.rb', line 143

def hash
  [type, status, status_details].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



187
188
189
190
191
192
193
194
195
196
 
# File 'lib/oci/database_tools/models/validation_external_authentication_status.rb', line 187

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



181
182
183
 
# File 'lib/oci/database_tools/models/validation_external_authentication_status.rb', line 181

def to_s
  to_hash.to_s
end