Class: OCI::IdentityDataPlane::Models::AuthenticateClientResult
- Inherits:
-
Object
- Object
- OCI::IdentityDataPlane::Models::AuthenticateClientResult
- Defined in:
- lib/oci/identity_data_plane/models/authenticate_client_result.rb
Overview
AuthenticateClientResult model.
Instance Attribute Summary collapse
-
#error_message ⇒ String
If the authentication fails for the original caller (not failing authentication of the calling service, in which case we return 401), we return a 200, but with null principal and an error message.
-
#principal ⇒ OCI::IdentityDataPlane::Models::Principal
The original caller's resolved principal object if the authentication succeeds, null otherwise.
Class Method Summary collapse
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.swagger_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(other) ⇒ Object
Checks equality by comparing each attribute.
-
#build_from_hash(attributes) ⇒ Object
Builds the object from hash.
- #eql?(other) ⇒ Boolean
-
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ AuthenticateClientResult
constructor
Initializes the object.
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
Constructor Details
#initialize(attributes = {}) ⇒ AuthenticateClientResult
Initializes the object
47 48 49 50 51 52 53 54 55 56 57 58 59 60 |
# File 'lib/oci/identity_data_plane/models/authenticate_client_result.rb', line 47 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.principal = attributes[:'principal'] if attributes[:'principal'] self. = attributes[:'errorMessage'] if attributes[:'errorMessage'] raise 'You cannot provide both :errorMessage and :error_message' if attributes.key?(:'errorMessage') && attributes.key?(:'error_message') self. = attributes[:'error_message'] if attributes[:'error_message'] end |
Instance Attribute Details
#error_message ⇒ String
If the authentication fails for the original caller (not failing authentication of the calling service, in which case we return 401), we return a 200, but with null principal and an error message
17 18 19 |
# File 'lib/oci/identity_data_plane/models/authenticate_client_result.rb', line 17 def @error_message end |
#principal ⇒ OCI::IdentityDataPlane::Models::Principal
The original caller's resolved principal object if the authentication succeeds, null otherwise.
13 14 15 |
# File 'lib/oci/identity_data_plane/models/authenticate_client_result.rb', line 13 def principal @principal end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
20 21 22 23 24 25 26 27 |
# File 'lib/oci/identity_data_plane/models/authenticate_client_result.rb', line 20 def self.attribute_map { # rubocop:disable Style/SymbolLiteral 'principal': :'principal', 'error_message': :'errorMessage' # rubocop:enable Style/SymbolLiteral } end |
.swagger_types ⇒ Object
Attribute type mapping.
30 31 32 33 34 35 36 37 |
# File 'lib/oci/identity_data_plane/models/authenticate_client_result.rb', line 30 def self.swagger_types { # rubocop:disable Style/SymbolLiteral 'principal': :'OCI::IdentityDataPlane::Models::Principal', 'error_message': :'String' # rubocop:enable Style/SymbolLiteral } end |
Instance Method Details
#==(other) ⇒ Object
Checks equality by comparing each attribute.
69 70 71 72 73 74 75 |
# File 'lib/oci/identity_data_plane/models/authenticate_client_result.rb', line 69 def ==(other) return true if equal?(other) self.class == other.class && principal == other.principal && == other. end |
#build_from_hash(attributes) ⇒ Object
Builds the object from hash
100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 |
# File 'lib/oci/identity_data_plane/models/authenticate_client_result.rb', line 100 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
80 81 82 |
# File 'lib/oci/identity_data_plane/models/authenticate_client_result.rb', line 80 def eql?(other) self == other end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
89 90 91 |
# File 'lib/oci/identity_data_plane/models/authenticate_client_result.rb', line 89 def hash [principal, ].hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
133 134 135 136 137 138 139 140 141 142 |
# File 'lib/oci/identity_data_plane/models/authenticate_client_result.rb', line 133 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
127 128 129 |
# File 'lib/oci/identity_data_plane/models/authenticate_client_result.rb', line 127 def to_s to_hash.to_s end |