Class: OCI::IdentityDomains::Models::UserExtApiKeys

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

Overview

A list of API keys corresponding to user.

Added In: 2012271618

SCIM++ Properties: - idcsCompositeKey: [value] - idcsSearchable: true - multiValued: true - mutability: readOnly - required: false - returned: request - type: complex - uniqueness: none

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ UserExtApiKeys

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :key (String) —

    The value to assign to the #key property

  • :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



120
121
122
123
124
125
126
127
128
129
130
131
132
133
 
# File 'lib/oci/identity_domains/models/user_ext_api_keys.rb', line 120

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

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

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

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

Instance Attribute Details

#key ⇒ String

The user's API key value.

Added In: 2106240046

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

Returns:

  • (String) 


37
38
39
 
# File 'lib/oci/identity_domains/models/user_ext_api_keys.rb', line 37

def key
  @key
end

#ocid ⇒ String

The user's API key OCID.

Added In: 2012271618

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

Returns:

  • (String) 


69
70
71
 
# File 'lib/oci/identity_domains/models/user_ext_api_keys.rb', line 69

def ocid
  @ocid
end

#ref ⇒ String

The URI of the corresponding ApiKey resource to which the user belongs.

Added In: 2012271618

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

Returns:

  • (String) 


84
85
86
 
# File 'lib/oci/identity_domains/models/user_ext_api_keys.rb', line 84

def ref
  @ref
end

#value ⇒ String

The user's API key identifier.

Added In: 2012271618

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

Returns:

  • (String) 


53
54
55
 
# File 'lib/oci/identity_domains/models/user_ext_api_keys.rb', line 53

def value
  @value
end

Class Method Details

.attribute_map ⇒ Object

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



87
88
89
90
91
92
93
94
95
96
 
# File 'lib/oci/identity_domains/models/user_ext_api_keys.rb', line 87

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

.swagger_types ⇒ Object

Attribute type mapping.



99
100
101
102
103
104
105
106
107
108
 
# File 'lib/oci/identity_domains/models/user_ext_api_keys.rb', line 99

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



142
143
144
145
146
147
148
149
150
 
# File 'lib/oci/identity_domains/models/user_ext_api_keys.rb', line 142

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

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



175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
 
# File 'lib/oci/identity_domains/models/user_ext_api_keys.rb', line 175

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


155
156
157
 
# File 'lib/oci/identity_domains/models/user_ext_api_keys.rb', line 155

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



164
165
166
 
# File 'lib/oci/identity_domains/models/user_ext_api_keys.rb', line 164

def hash
  [key, value, ocid, ref].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



208
209
210
211
212
213
214
215
216
217
 
# File 'lib/oci/identity_domains/models/user_ext_api_keys.rb', line 208

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



202
203
204
 
# File 'lib/oci/identity_domains/models/user_ext_api_keys.rb', line 202

def to_s
  to_hash.to_s
end