Class: OCI::IdentityDomains::Models::MyGroup

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

Overview

The Group 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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ MyGroup

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
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
# File 'lib/oci/identity_domains/models/my_group.rb', line 315

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

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

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

  self.display_name = attributes[:'displayName'] if attributes[:'displayName']

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

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

  self.non_unique_display_name = attributes[:'nonUniqueDisplayName'] if attributes[:'nonUniqueDisplayName']

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

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

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

  self.urn_ietf_params_scim_schemas_oracle_idcs_extension_group_group = attributes[:'urn:ietf:params:scim:schemas:oracle:idcs:extension:group:Group'] if attributes[:'urn:ietf:params:scim:schemas:oracle:idcs:extension:group:Group']

  raise 'You cannot provide both :urn:ietf:params:scim:schemas:oracle:idcs:extension:group:Group and :urn_ietf_params_scim_schemas_oracle_idcs_extension_group_group' if attributes.key?(:'urn:ietf:params:scim:schemas:oracle:idcs:extension:group:Group') && attributes.key?(:'urn_ietf_params_scim_schemas_oracle_idcs_extension_group_group')

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

  self.urn_ietf_params_scim_schemas_oracle_idcs_extension_posix_group = attributes[:'urn:ietf:params:scim:schemas:oracle:idcs:extension:posix:Group'] if attributes[:'urn:ietf:params:scim:schemas:oracle:idcs:extension:posix:Group']

  raise 'You cannot provide both :urn:ietf:params:scim:schemas:oracle:idcs:extension:posix:Group and :urn_ietf_params_scim_schemas_oracle_idcs_extension_posix_group' if attributes.key?(:'urn:ietf:params:scim:schemas:oracle:idcs:extension:posix:Group') && attributes.key?(:'urn_ietf_params_scim_schemas_oracle_idcs_extension_posix_group')

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

Instance Attribute Details

#compartment_ocidString

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)


151
152
153
# File 'lib/oci/identity_domains/models/my_group.rb', line 151

def compartment_ocid
  @compartment_ocid
end

#delete_in_progressBOOLEAN

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)


109
110
111
# File 'lib/oci/identity_domains/models/my_group.rb', line 109

def delete_in_progress
  @delete_in_progress
end

#display_nameString

[Required] The Group display name.

SCIM++ Properties: - caseExact: false - idcsCsvAttributeName: Display Name - idcsCsvAttributeNameMappings: [[columnHeaderName:Name, deprecatedColumnHeaderName:Display Name]] - idcsSearchable: true - multiValued: false - mutability: readWrite - required: true - returned: always - type: string - uniqueness: global

Returns:

  • (String)


195
196
197
# File 'lib/oci/identity_domains/models/my_group.rb', line 195

def display_name
  @display_name
end

#domain_ocidString

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)


137
138
139
# File 'lib/oci/identity_domains/models/my_group.rb', line 137

def domain_ocid
  @domain_ocid
end

#external_idString

An identifier for the Resource as defined by the Service Consumer. The externalId may simplify identification of the Resource between Service Consumer and Service Provider by allowing the Consumer to refer to the Resource with its own identifier, obviating the need to store a local mapping between the local identifier of the Resource and the identifier used by the Service Provider. Each Resource MAY include a non-empty externalId value. The value of the externalId attribute is always issued by the Service Consumer and can never be specified by the Service Provider. The Service Provider MUST always interpret the externalId as scoped to the Service Consumer's tenant.

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

Returns:

  • (String)


179
180
181
# File 'lib/oci/identity_domains/models/my_group.rb', line 179

def external_id
  @external_id
end

#idString

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)


31
32
33
# File 'lib/oci/identity_domains/models/my_group.rb', line 31

def id
  @id
end

#idcs_created_byOCI::IdentityDomains::Models::IdcsCreatedBy



65
66
67
# File 'lib/oci/identity_domains/models/my_group.rb', line 65

def idcs_created_by
  @idcs_created_by
end

#idcs_last_modified_byOCI::IdentityDomains::Models::IdcsLastModifiedBy



68
69
70
# File 'lib/oci/identity_domains/models/my_group.rb', line 68

def idcs_last_modified_by
  @idcs_last_modified_by
end

#idcs_last_upgraded_in_releaseString

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)


123
124
125
# File 'lib/oci/identity_domains/models/my_group.rb', line 123

def idcs_last_upgraded_in_release
  @idcs_last_upgraded_in_release
end

#idcs_prevented_operationsArray<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>)


81
82
83
# File 'lib/oci/identity_domains/models/my_group.rb', line 81

def idcs_prevented_operations
  @idcs_prevented_operations
end

#membersArray<OCI::IdentityDomains::Models::MyGroupMembers>

The group members. Important: When requesting group members, a maximum of 10,000 members can be returned in a single request. If the response contains more than 10,000 members, the request will fail. Use 'startIndex' and 'count' to return members in pages instead of in a single response, for example: #attributes=members. This REST API is SCIM compliant.

SCIM++ Properties: - caseExact: false - idcsCompositeKey: [value] - idcsCsvAttributeNameMappings: [[columnHeaderName:User Members, mapsTo:members.value, multiValueDelimiter:;]] - idcsSearchable: true - multiValued: true - mutability: readWrite - required: false - returned: request - idcsPaginateResponse: true - type: complex - uniqueness: none



228
229
230
# File 'lib/oci/identity_domains/models/my_group.rb', line 228

def members
  @members
end

#metaOCI::IdentityDomains::Models::Meta



62
63
64
# File 'lib/oci/identity_domains/models/my_group.rb', line 62

def meta
  @meta
end

#non_unique_display_nameString

A human readable name for the group as defined by the Service Consumer.

Added In: 2011192329

SCIM++ Properties: - caseExact: false - idcsCsvAttributeName: Non-Unique Display Name - idcsSearchable: true - multiValued: false - mutability: readWrite - required: false - returned: always - type: string

Returns:

  • (String)


211
212
213
# File 'lib/oci/identity_domains/models/my_group.rb', line 211

def non_unique_display_name
  @non_unique_display_name
end

#ocidString

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)


45
46
47
# File 'lib/oci/identity_domains/models/my_group.rb', line 45

def ocid
  @ocid
end

#schemasArray<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>)


59
60
61
# File 'lib/oci/identity_domains/models/my_group.rb', line 59

def schemas
  @schemas
end

#tagsArray<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



95
96
97
# File 'lib/oci/identity_domains/models/my_group.rb', line 95

def tags
  @tags
end

#tenancy_ocidString

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)


165
166
167
# File 'lib/oci/identity_domains/models/my_group.rb', line 165

def tenancy_ocid
  @tenancy_ocid
end

#urn_ietf_params_scim_schemas_oracle_idcs_extension_group_groupOCI::IdentityDomains::Models::ExtensionGroupGroup



231
232
233
# File 'lib/oci/identity_domains/models/my_group.rb', line 231

def urn_ietf_params_scim_schemas_oracle_idcs_extension_group_group
  @urn_ietf_params_scim_schemas_oracle_idcs_extension_group_group
end

#urn_ietf_params_scim_schemas_oracle_idcs_extension_posix_groupOCI::IdentityDomains::Models::ExtensionPosixGroup



234
235
236
# File 'lib/oci/identity_domains/models/my_group.rb', line 234

def urn_ietf_params_scim_schemas_oracle_idcs_extension_posix_group
  @urn_ietf_params_scim_schemas_oracle_idcs_extension_posix_group
end

Class Method Details

.attribute_mapObject

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



237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
# File 'lib/oci/identity_domains/models/my_group.rb', line 237

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',
    'external_id': :'externalId',
    'display_name': :'displayName',
    'non_unique_display_name': :'nonUniqueDisplayName',
    'members': :'members',
    'urn_ietf_params_scim_schemas_oracle_idcs_extension_group_group': :'urn:ietf:params:scim:schemas:oracle:idcs:extension:group:Group',
    'urn_ietf_params_scim_schemas_oracle_idcs_extension_posix_group': :'urn:ietf:params:scim:schemas:oracle:idcs:extension:posix:Group'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_typesObject

Attribute type mapping.



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

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',
    'external_id': :'String',
    'display_name': :'String',
    'non_unique_display_name': :'String',
    'members': :'Array<OCI::IdentityDomains::Models::MyGroupMembers>',
    'urn_ietf_params_scim_schemas_oracle_idcs_extension_group_group': :'OCI::IdentityDomains::Models::ExtensionGroupGroup',
    'urn_ietf_params_scim_schemas_oracle_idcs_extension_posix_group': :'OCI::IdentityDomains::Models::ExtensionPosixGroup'
    # 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



439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
# File 'lib/oci/identity_domains/models/my_group.rb', line 439

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 &&
    external_id == other.external_id &&
    display_name == other.display_name &&
    non_unique_display_name == other.non_unique_display_name &&
    members == other.members &&
    urn_ietf_params_scim_schemas_oracle_idcs_extension_group_group == other.urn_ietf_params_scim_schemas_oracle_idcs_extension_group_group &&
    urn_ietf_params_scim_schemas_oracle_idcs_extension_posix_group == other.urn_ietf_params_scim_schemas_oracle_idcs_extension_posix_group
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



487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
# File 'lib/oci/identity_domains/models/my_group.rb', line 487

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


467
468
469
# File 'lib/oci/identity_domains/models/my_group.rb', line 467

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



476
477
478
# File 'lib/oci/identity_domains/models/my_group.rb', line 476

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, external_id, display_name, non_unique_display_name, members, urn_ietf_params_scim_schemas_oracle_idcs_extension_group_group, urn_ietf_params_scim_schemas_oracle_idcs_extension_posix_group].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



520
521
522
523
524
525
526
527
528
529
# File 'lib/oci/identity_domains/models/my_group.rb', line 520

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



514
515
516
# File 'lib/oci/identity_domains/models/my_group.rb', line 514

def to_s
  to_hash.to_s
end