Class: OCI::IdentityDomains::Models::GroupMembers

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

Overview

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.

Constant Summary collapse

TYPE_ENUM = 
[
  TYPE_USER = 'User'.freeze,
  TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ GroupMembers

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

  • :date_added (String) —

    The value to assign to the #date_added property

  • :ocid (String) —

    The value to assign to the #ocid property

  • :membership_ocid (String) —

    The value to assign to the #membership_ocid property

  • :ref (String) —

    The value to assign to the #ref property

  • :display (String) —

    The value to assign to the #display property

  • :type (String) —

    The value to assign to the #type property

  • :name (String) —

    The value to assign to the #name property



180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
 
# File 'lib/oci/identity_domains/models/group_members.rb', line 180

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

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

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

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

  self.membership_ocid = attributes[:'membershipOcid'] if attributes[:'membershipOcid']

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

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

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

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

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

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

Instance Attribute Details

#date_added ⇒ String

The date and time that the member was added to the group.

Added In: 2012271618

SCIM++ Properties: - caseExact: false - multiValued: false - mutability: readOnly - returned: default - type: dateTime - uniqueness: none

Returns:

  • (String) 


43
44
45
 
# File 'lib/oci/identity_domains/models/group_members.rb', line 43

def date_added
  @date_added
end

#display ⇒ String

The member's display name.

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

Returns:

  • (String) 


103
104
105
 
# File 'lib/oci/identity_domains/models/group_members.rb', line 103

def display
  @display
end

#membership_ocid ⇒ String

The membership OCID.

Added In: 2102181953

SCIM++ Properties: - caseExact: true - 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/group_members.rb', line 75

def membership_ocid
  @membership_ocid
end

#name ⇒ String

The member's name.

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

Returns:

  • (String) 


132
133
134
 
# File 'lib/oci/identity_domains/models/group_members.rb', line 132

def name
  @name
end

#ocid ⇒ String

The OCID of the member of this group.

Added In: 2012271618

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

Returns:

  • (String) 


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

def ocid
  @ocid
end

#ref ⇒ String

The URI that corresponds to the member Resource of this group.

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

Returns:

  • (String) 


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

def ref
  @ref
end

#type ⇒ String

[Required] Indicates the type of resource, for example, User or Group.

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

Returns:

  • (String) 


118
119
120
 
# File 'lib/oci/identity_domains/models/group_members.rb', line 118

def type
  @type
end

#value ⇒ String

[Required] The ID of the member of this Group

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

Returns:

  • (String) 


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

def value
  @value
end

Class Method Details

.attribute_map ⇒ Object

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



135
136
137
138
139
140
141
142
143
144
145
146
147
148
 
# File 'lib/oci/identity_domains/models/group_members.rb', line 135

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

.swagger_types ⇒ Object

Attribute type mapping.



151
152
153
154
155
156
157
158
159
160
161
162
163
164
 
# File 'lib/oci/identity_domains/models/group_members.rb', line 151

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



231
232
233
234
235
236
237
238
239
240
241
242
243
 
# File 'lib/oci/identity_domains/models/group_members.rb', line 231

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

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



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

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


248
249
250
 
# File 'lib/oci/identity_domains/models/group_members.rb', line 248

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



257
258
259
 
# File 'lib/oci/identity_domains/models/group_members.rb', line 257

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

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



301
302
303
304
305
306
307
308
309
310
 
# File 'lib/oci/identity_domains/models/group_members.rb', line 301

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



295
296
297
 
# File 'lib/oci/identity_domains/models/group_members.rb', line 295

def to_s
  to_hash.to_s
end