Class: OCI::IdentityDomains::Models::MappedAttribute

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

Overview

Schema for MappedAttribute resource.

Constant Summary collapse

IDCS_PREVENTED_OPERATIONS_ENUM = 
[
  IDCS_PREVENTED_OPERATIONS_REPLACE = 'replace'.freeze,
  IDCS_PREVENTED_OPERATIONS_UPDATE = 'update'.freeze,
  IDCS_PREVENTED_OPERATIONS_DELETE = 'delete'.freeze,
  IDCS_PREVENTED_OPERATIONS_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
IDCS_RESOURCE_TYPE_ENUM = 
[
  IDCS_RESOURCE_TYPE_USER = 'User'.freeze,
  IDCS_RESOURCE_TYPE_GROUP = 'Group'.freeze,
  IDCS_RESOURCE_TYPE_CONTAINER = 'Container'.freeze,
  IDCS_RESOURCE_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
REF_RESOURCE_TYPE_ENUM = 
[
  REF_RESOURCE_TYPE_ACCOUNT_OBJECT_CLASS = 'AccountObjectClass'.freeze,
  REF_RESOURCE_TYPE_APP = 'App'.freeze,
  REF_RESOURCE_TYPE_MANAGED_OBJECT_CLASS = 'ManagedObjectClass'.freeze,
  REF_RESOURCE_TYPE_IDENTITY_PROVIDER = 'IdentityProvider'.freeze,
  REF_RESOURCE_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
DIRECTION_ENUM = 
[
  DIRECTION_INBOUND = 'inbound'.freeze,
  DIRECTION_OUTBOUND = 'outbound'.freeze,
  DIRECTION_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ MappedAttribute

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
 
# File 'lib/oci/identity_domains/models/mapped_attribute.rb', line 338

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

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

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

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

  self.idcs_created_by = attributes[:'idcsCreatedBy'] if attributes[:'idcsCreatedBy']

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

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

  self.idcs_last_modified_by = attributes[:'idcsLastModifiedBy'] if attributes[:'idcsLastModifiedBy']

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

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

  self.idcs_prevented_operations = attributes[:'idcsPreventedOperations'] if attributes[:'idcsPreventedOperations']

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

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

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

  self.delete_in_progress = attributes[:'deleteInProgress'] unless attributes[:'deleteInProgress'].nil?

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

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

  self.idcs_last_upgraded_in_release = attributes[:'idcsLastUpgradedInRelease'] if attributes[:'idcsLastUpgradedInRelease']

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

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

  self.domain_ocid = attributes[:'domainOcid'] if attributes[:'domainOcid']

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

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

  self.compartment_ocid = attributes[:'compartmentOcid'] if attributes[:'compartmentOcid']

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

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

  self.tenancy_ocid = attributes[:'tenancyOcid'] if attributes[:'tenancyOcid']

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

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

  self.idcs_resource_type = attributes[:'idcsResourceType'] if attributes[:'idcsResourceType']

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

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

  self.ref_resource_type = attributes[:'refResourceType'] if attributes[:'refResourceType']

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

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

  self.ref_resource_id = attributes[:'refResourceID'] if attributes[:'refResourceID']

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

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

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

  self.attribute_mappings = attributes[:'attributeMappings'] if attributes[:'attributeMappings']

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

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

Instance Attribute Details

#attribute_mappings ⇒ Array<OCI::IdentityDomains::Models::MappedAttributeAttributeMappings>

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

SCIM++ Properties: - idcsCompositeKey: [idcsAttributeName, managedObjectAttributeName] - idcsSearchable: true - multiValued: true - mutability: readWrite - required: false - returned: default - type: complex - uniqueness: none

Returns:



260
261
262
 
# File 'lib/oci/identity_domains/models/mapped_attribute.rb', line 260

def attribute_mappings
  @attribute_mappings
end

#compartment_ocid ⇒ String

OCI Compartment Id (ocid) in which the resource lives.

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

Returns:

  • (String) 


172
173
174
 
# File 'lib/oci/identity_domains/models/mapped_attribute.rb', line 172

def compartment_ocid
  @compartment_ocid
end

#delete_in_progress ⇒ BOOLEAN

A boolean flag indicating this resource in the process of being deleted. Usually set to true when synchronous deletion of the resource would take too long.

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

Returns:

  • (BOOLEAN) 


130
131
132
 
# File 'lib/oci/identity_domains/models/mapped_attribute.rb', line 130

def delete_in_progress
  @delete_in_progress
end

#direction ⇒ String

[Required] Direction of the attribute mapping. inbound indicates mapping is from source ManagedObjectClass to Oracle Identity Cloud Service ResourceType. outbound indicates mapping is from Oracle Identity Cloud Service Resource Type to target ManagedObjectClass.

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

Returns:

  • (String) 


246
247
248
 
# File 'lib/oci/identity_domains/models/mapped_attribute.rb', line 246

def direction
  @direction
end

#domain_ocid ⇒ String

OCI Domain Id (ocid) in which the resource lives.

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

Returns:

  • (String) 


158
159
160
 
# File 'lib/oci/identity_domains/models/mapped_attribute.rb', line 158

def domain_ocid
  @domain_ocid
end

#id ⇒ String

Unique identifier for the SCIM Resource as defined by the Service Provider. Each representation of the Resource MUST include a non-empty id value. This identifier MUST be unique across the Service Provider's entire set of Resources. It MUST be a stable, non-reassignable identifier that does not change when the same Resource is returned in subsequent requests. The value of the id attribute is always issued by the Service Provider and MUST never be specified by the Service Consumer. bulkId: is a reserved keyword and MUST NOT be used in the unique identifier.

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

Returns:

  • (String) 


52
53
54
 
# File 'lib/oci/identity_domains/models/mapped_attribute.rb', line 52

def id
  @id
end

#idcs_created_by ⇒ OCI::IdentityDomains::Models::IdcsCreatedBy

Returns:



86
87
88
 
# File 'lib/oci/identity_domains/models/mapped_attribute.rb', line 86

def idcs_created_by
  @idcs_created_by
end

#idcs_last_modified_by ⇒ OCI::IdentityDomains::Models::IdcsLastModifiedBy

Returns:



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

def idcs_last_modified_by
  @idcs_last_modified_by
end

#idcs_last_upgraded_in_release ⇒ String

The release number when the resource was upgraded.

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

Returns:

  • (String) 


144
145
146
 
# File 'lib/oci/identity_domains/models/mapped_attribute.rb', line 144

def idcs_last_upgraded_in_release
  @idcs_last_upgraded_in_release
end

#idcs_prevented_operations ⇒ Array<String>

Each value of this attribute specifies an operation that only an internal client may perform on this particular resource.

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

Returns:

  • (Array<String>) 


102
103
104
 
# File 'lib/oci/identity_domains/models/mapped_attribute.rb', line 102

def idcs_prevented_operations
  @idcs_prevented_operations
end

#idcs_resource_type ⇒ String

[Required] The Oracle Identity Cloud Service Resource Type for which the mapping is being done

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

Returns:

  • (String) 


200
201
202
 
# File 'lib/oci/identity_domains/models/mapped_attribute.rb', line 200

def idcs_resource_type
  @idcs_resource_type
end

#meta ⇒ OCI::IdentityDomains::Models::Meta

Returns:



83
84
85
 
# File 'lib/oci/identity_domains/models/mapped_attribute.rb', line 83

def meta
  @meta
end

#ocid ⇒ String

Unique OCI identifier for the SCIM Resource.

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

Returns:

  • (String) 


66
67
68
 
# File 'lib/oci/identity_domains/models/mapped_attribute.rb', line 66

def ocid
  @ocid
end

#ref_resource_id ⇒ String

[Required] Soft Reference to store Resource ID that holds the mapping

Added In: 17.4.6

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

Returns:

  • (String) 


232
233
234
 
# File 'lib/oci/identity_domains/models/mapped_attribute.rb', line 232

def ref_resource_id
  @ref_resource_id
end

#ref_resource_type ⇒ String

[Required] The Reference Resource Type that holds the mapping

Added In: 17.4.2

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

Returns:

  • (String) 


216
217
218
 
# File 'lib/oci/identity_domains/models/mapped_attribute.rb', line 216

def ref_resource_type
  @ref_resource_type
end

#schemas ⇒ Array<String>

[Required] REQUIRED. The schemas attribute is an array of Strings which allows introspection of the supported schema version for a SCIM representation as well any schema extensions supported by that representation. Each String value must be a unique URI. This specification defines URIs for User, Group, and a standard \“enterprise\” extension. All representations of SCIM schema MUST include a non-zero value array with value(s) of the URIs supported by that representation. Duplicate values MUST NOT be included. Value order is not specified and MUST not impact behavior.

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

Returns:

  • (Array<String>) 


80
81
82
 
# File 'lib/oci/identity_domains/models/mapped_attribute.rb', line 80

def schemas
  @schemas
end

#tags ⇒ Array<OCI::IdentityDomains::Models::Tags>

A list of tags on this resource.

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

Returns:



116
117
118
 
# File 'lib/oci/identity_domains/models/mapped_attribute.rb', line 116

def tags
  @tags
end

#tenancy_ocid ⇒ String

OCI Tenant Id (ocid) in which the resource lives.

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

Returns:

  • (String) 


186
187
188
 
# File 'lib/oci/identity_domains/models/mapped_attribute.rb', line 186

def tenancy_ocid
  @tenancy_ocid
end

Class Method Details

.attribute_map ⇒ Object

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



263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
 
# File 'lib/oci/identity_domains/models/mapped_attribute.rb', line 263

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'ocid': :'ocid',
    'schemas': :'schemas',
    'meta': :'meta',
    'idcs_created_by': :'idcsCreatedBy',
    'idcs_last_modified_by': :'idcsLastModifiedBy',
    'idcs_prevented_operations': :'idcsPreventedOperations',
    'tags': :'tags',
    'delete_in_progress': :'deleteInProgress',
    'idcs_last_upgraded_in_release': :'idcsLastUpgradedInRelease',
    'domain_ocid': :'domainOcid',
    'compartment_ocid': :'compartmentOcid',
    'tenancy_ocid': :'tenancyOcid',
    'idcs_resource_type': :'idcsResourceType',
    'ref_resource_type': :'refResourceType',
    'ref_resource_id': :'refResourceID',
    'direction': :'direction',
    'attribute_mappings': :'attributeMappings'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
 
# File 'lib/oci/identity_domains/models/mapped_attribute.rb', line 289

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'ocid': :'String',
    'schemas': :'Array<String>',
    'meta': :'OCI::IdentityDomains::Models::Meta',
    'idcs_created_by': :'OCI::IdentityDomains::Models::IdcsCreatedBy',
    'idcs_last_modified_by': :'OCI::IdentityDomains::Models::IdcsLastModifiedBy',
    'idcs_prevented_operations': :'Array<String>',
    'tags': :'Array<OCI::IdentityDomains::Models::Tags>',
    'delete_in_progress': :'BOOLEAN',
    'idcs_last_upgraded_in_release': :'String',
    'domain_ocid': :'String',
    'compartment_ocid': :'String',
    'tenancy_ocid': :'String',
    'idcs_resource_type': :'String',
    'ref_resource_type': :'String',
    'ref_resource_id': :'String',
    'direction': :'String',
    'attribute_mappings': :'Array<OCI::IdentityDomains::Models::MappedAttributeAttributeMappings>'
    # 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



495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
 
# File 'lib/oci/identity_domains/models/mapped_attribute.rb', line 495

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

  self.class == other.class &&
    id == other.id &&
    ocid == other.ocid &&
    schemas == other.schemas &&
    meta == other.meta &&
    idcs_created_by == other.idcs_created_by &&
    idcs_last_modified_by == other.idcs_last_modified_by &&
    idcs_prevented_operations == other.idcs_prevented_operations &&
    tags == other.tags &&
    delete_in_progress == other.delete_in_progress &&
    idcs_last_upgraded_in_release == other.idcs_last_upgraded_in_release &&
    domain_ocid == other.domain_ocid &&
    compartment_ocid == other.compartment_ocid &&
    tenancy_ocid == other.tenancy_ocid &&
    idcs_resource_type == other.idcs_resource_type &&
    ref_resource_type == other.ref_resource_type &&
    ref_resource_id == other.ref_resource_id &&
    direction == other.direction &&
    attribute_mappings == other.attribute_mappings
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



542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
 
# File 'lib/oci/identity_domains/models/mapped_attribute.rb', line 542

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


522
523
524
 
# File 'lib/oci/identity_domains/models/mapped_attribute.rb', line 522

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



531
532
533
 
# File 'lib/oci/identity_domains/models/mapped_attribute.rb', line 531

def hash
  [id, ocid, schemas, meta, idcs_created_by, idcs_last_modified_by, idcs_prevented_operations, tags, delete_in_progress, idcs_last_upgraded_in_release, domain_ocid, compartment_ocid, tenancy_ocid, idcs_resource_type, ref_resource_type, ref_resource_id, direction, attribute_mappings].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



575
576
577
578
579
580
581
582
583
584
 
# File 'lib/oci/identity_domains/models/mapped_attribute.rb', line 575

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



569
570
571
 
# File 'lib/oci/identity_domains/models/mapped_attribute.rb', line 569

def to_s
  to_hash.to_s
end