Class: OCI::IdentityDomains::Models::OAuth2ClientCredentialUser

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/identity_domains/models/o_auth2_client_credential_user.rb

Overview

The user linked to the OAuth2 client credential.

SCIM++ Properties: - caseExact: false - idcsSearchable: true - multiValued: false - mutability: immutable - required: false - returned: default - type: complex - uniqueness: none

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ OAuth2ClientCredentialUser

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :value (String) —

    The value to assign to the #value property

  • :ocid (String) —

    The value to assign to the #ocid property

  • :ref (String) —

    The value to assign to the #ref property

  • :display (String) —

    The value to assign to the #display property

  • :name (String) —

    The value to assign to the #name property



128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
 
# File 'lib/oci/identity_domains/models/o_auth2_client_credential_user.rb', line 128

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

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

  self.ref = attributes[:'$ref'] if attributes[:'$ref']

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

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

Instance Attribute Details

#display ⇒ String

The user's display name.

SCIM++ Properties: - caseExact: false - idcsSearchable: true - multiValued: false - mutability: readOnly - required: false - returned: default - type: string - uniqueness: none

Returns:

  • (String) 


75
76
77
 
# File 'lib/oci/identity_domains/models/o_auth2_client_credential_user.rb', line 75

def display
  @display
end

#name ⇒ String

The username.

SCIM++ Properties: - caseExact: false - idcsSearchable: false - multiValued: false - mutability: readOnly - required: false - returned: default - type: string - uniqueness: none

Returns:

  • (String) 


89
90
91
 
# File 'lib/oci/identity_domains/models/o_auth2_client_credential_user.rb', line 89

def name
  @name
end

#ocid ⇒ String

The user's OCID.

SCIM++ Properties: - caseExact: true - idcsSearchable: true - multiValued: false - mutability: immutable - required: false - returned: always - type: string - uniqueness: none

Returns:

  • (String) 


47
48
49
 
# File 'lib/oci/identity_domains/models/o_auth2_client_credential_user.rb', line 47

def ocid
  @ocid
end

#ref ⇒ String

The URI that corresponds to the user linked to this credential.

SCIM++ Properties: - caseExact: true - idcsSearchable: false - multiValued: false - mutability: readOnly - required: false - returned: default - type: reference - uniqueness: none

Returns:

  • (String) 


61
62
63
 
# File 'lib/oci/identity_domains/models/o_auth2_client_credential_user.rb', line 61

def ref
  @ref
end

#value ⇒ String

The user's ID.

SCIM++ Properties: - caseExact: true - idcsSearchable: true - multiValued: false - mutability: immutable - required: false - returned: always - type: string - uniqueness: none

Returns:

  • (String) 


33
34
35
 
# File 'lib/oci/identity_domains/models/o_auth2_client_credential_user.rb', line 33

def value
  @value
end

Class Method Details

.attribute_map ⇒ Object

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



92
93
94
95
96
97
98
99
100
101
102
 
# File 'lib/oci/identity_domains/models/o_auth2_client_credential_user.rb', line 92

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'value': :'value',
    'ocid': :'ocid',
    'ref': :'$ref',
    'display': :'display',
    'name': :'name'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



105
106
107
108
109
110
111
112
113
114
115
 
# File 'lib/oci/identity_domains/models/o_auth2_client_credential_user.rb', line 105

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'value': :'String',
    'ocid': :'String',
    'ref': :'String',
    'display': :'String',
    'name': :'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



152
153
154
155
156
157
158
159
160
161
 
# File 'lib/oci/identity_domains/models/o_auth2_client_credential_user.rb', line 152

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

  self.class == other.class &&
    value == other.value &&
    ocid == other.ocid &&
    ref == other.ref &&
    display == other.display &&
    name == other.name
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



186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
 
# File 'lib/oci/identity_domains/models/o_auth2_client_credential_user.rb', line 186

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


166
167
168
 
# File 'lib/oci/identity_domains/models/o_auth2_client_credential_user.rb', line 166

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



175
176
177
 
# File 'lib/oci/identity_domains/models/o_auth2_client_credential_user.rb', line 175

def hash
  [value, ocid, ref, display, name].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



219
220
221
222
223
224
225
226
227
228
 
# File 'lib/oci/identity_domains/models/o_auth2_client_credential_user.rb', line 219

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



213
214
215
 
# File 'lib/oci/identity_domains/models/o_auth2_client_credential_user.rb', line 213

def to_s
  to_hash.to_s
end