Class: OCI::IdentityDomains::Models::MappedAttributeAttributeMappings

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

Overview

A list of attribute mappings between Oracle Identity Cloud Service Resource Type and Account Object Class

Constant Summary collapse

APPLIES_TO_ACTIONS_ENUM =
[
  APPLIES_TO_ACTIONS_CREATE = 'create'.freeze,
  APPLIES_TO_ACTIONS_UPDATE = 'update'.freeze,
  APPLIES_TO_ACTIONS_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ MappedAttributeAttributeMappings

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
# File 'lib/oci/identity_domains/models/mapped_attribute_attribute_mappings.rb', line 124

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

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

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

  self.idcs_attribute_name = attributes[:'idcsAttributeName'] if attributes[:'idcsAttributeName']

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

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

  self.required = attributes[:'required'] unless attributes[:'required'].nil?

  self.applies_to_actions = attributes[:'appliesToActions'] if attributes[:'appliesToActions']

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

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

  self.saml_format = attributes[:'samlFormat'] if attributes[:'samlFormat']

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

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

Instance Attribute Details

#applies_to_actionsArray<String>

If specified, indicates a subset of mappedActions to which this attribute-mapping applies.If not specified, this attribute-mapping applies to all mappedActions that use mappedAttributes

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

Returns:

  • (Array<String>)


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

def applies_to_actions
  @applies_to_actions
end

#idcs_attribute_nameString

[Required] The name or expression of an attribute that corresponds to the Oracle Identity Cloud Service Resource referred in the \“idcsResourceType\” attribute.

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

Returns:

  • (String)


42
43
44
# File 'lib/oci/identity_domains/models/mapped_attribute_attribute_mappings.rb', line 42

def idcs_attribute_name
  @idcs_attribute_name
end

#managed_object_attribute_nameString

[Required] The name or expression of an attribute defined in the schema of the Managed Object Class. This is the SCIM compliant Oracle Identity Cloud Service Name of the attribute that maps to the \“idcsName\” attribute in the schema of an Managed Object Class.

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

Returns:

  • (String)


29
30
31
# File 'lib/oci/identity_domains/models/mapped_attribute_attribute_mappings.rb', line 29

def managed_object_attribute_name
  @managed_object_attribute_name
end

#requiredBOOLEAN

If true, indicates that this attribute must have a value. This attribute maps to the \“required\” sub-attribute in the schema of an Managed Object Class.

SCIM++ Properties: - idcsSearchable: false - multiValued: false - mutability: readWrite - required: false - returned: default - type: boolean - uniqueness: none

Returns:

  • (BOOLEAN)


55
56
57
# File 'lib/oci/identity_domains/models/mapped_attribute_attribute_mappings.rb', line 55

def required
  @required
end

#saml_formatString

Indicates the format of the assertion attribute. Also stores AttributeNamespace for WSFed1.1.

Added In: 17.4.2

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

Returns:

  • (String)


85
86
87
# File 'lib/oci/identity_domains/models/mapped_attribute_attribute_mappings.rb', line 85

def saml_format
  @saml_format
end

Class Method Details

.attribute_mapObject

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



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

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'managed_object_attribute_name': :'managedObjectAttributeName',
    'idcs_attribute_name': :'idcsAttributeName',
    'required': :'required',
    'applies_to_actions': :'appliesToActions',
    'saml_format': :'samlFormat'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_typesObject

Attribute type mapping.



101
102
103
104
105
106
107
108
109
110
111
# File 'lib/oci/identity_domains/models/mapped_attribute_attribute_mappings.rb', line 101

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'managed_object_attribute_name': :'String',
    'idcs_attribute_name': :'String',
    'required': :'BOOLEAN',
    'applies_to_actions': :'Array<String>',
    'saml_format': :'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



184
185
186
187
188
189
190
191
192
193
# File 'lib/oci/identity_domains/models/mapped_attribute_attribute_mappings.rb', line 184

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

  self.class == other.class &&
    managed_object_attribute_name == other.managed_object_attribute_name &&
    idcs_attribute_name == other.idcs_attribute_name &&
    required == other.required &&
    applies_to_actions == other.applies_to_actions &&
    saml_format == other.saml_format
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



218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
# File 'lib/oci/identity_domains/models/mapped_attribute_attribute_mappings.rb', line 218

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


198
199
200
# File 'lib/oci/identity_domains/models/mapped_attribute_attribute_mappings.rb', line 198

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



207
208
209
# File 'lib/oci/identity_domains/models/mapped_attribute_attribute_mappings.rb', line 207

def hash
  [managed_object_attribute_name, idcs_attribute_name, required, applies_to_actions, saml_format].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



251
252
253
254
255
256
257
258
259
260
# File 'lib/oci/identity_domains/models/mapped_attribute_attribute_mappings.rb', line 251

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



245
246
247
# File 'lib/oci/identity_domains/models/mapped_attribute_attribute_mappings.rb', line 245

def to_s
  to_hash.to_s
end