Class: OCI::Identity::Models::UserGroupMembership
- Inherits:
-
Object
- Object
- OCI::Identity::Models::UserGroupMembership
- Defined in:
- lib/oci/identity/models/user_group_membership.rb
Overview
An object that represents the membership of a user in a group. When you add a user to a group, the result is a UserGroupMembership
with its own OCID. To remove a user from a group, you delete the UserGroupMembership
object.
Constant Summary collapse
- LIFECYCLE_STATE_ENUM =
[ LIFECYCLE_STATE_CREATING = 'CREATING'.freeze, LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze, LIFECYCLE_STATE_INACTIVE = 'INACTIVE'.freeze, LIFECYCLE_STATE_DELETING = 'DELETING'.freeze, LIFECYCLE_STATE_DELETED = 'DELETED'.freeze, LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze ].freeze
Instance Attribute Summary collapse
-
#compartment_id ⇒ String
[Required] The OCID of the tenancy containing the user, group, and membership object.
-
#group_id ⇒ String
[Required] The OCID of the group.
-
#id ⇒ String
[Required] The OCID of the membership.
-
#inactive_status ⇒ Integer
The detailed status of INACTIVE lifecycleState.
-
#lifecycle_state ⇒ String
[Required] The membership's current state.
-
#time_created ⇒ DateTime
[Required] Date and time the membership was created, in the format defined by RFC3339.
-
#user_id ⇒ String
[Required] The OCID of the user.
Class Method Summary collapse
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.swagger_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(other) ⇒ Object
Checks equality by comparing each attribute.
-
#build_from_hash(attributes) ⇒ Object
Builds the object from hash.
- #eql?(other) ⇒ Boolean
-
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ UserGroupMembership
constructor
Initializes the object.
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
Constructor Details
#initialize(attributes = {}) ⇒ UserGroupMembership
Initializes the object
99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 |
# File 'lib/oci/identity/models/user_group_membership.rb', line 99 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.compartment_id = attributes[:'compartmentId'] if attributes[:'compartmentId'] raise 'You cannot provide both :compartmentId and :compartment_id' if attributes.key?(:'compartmentId') && attributes.key?(:'compartment_id') self.compartment_id = attributes[:'compartment_id'] if attributes[:'compartment_id'] self.group_id = attributes[:'groupId'] if attributes[:'groupId'] raise 'You cannot provide both :groupId and :group_id' if attributes.key?(:'groupId') && attributes.key?(:'group_id') self.group_id = attributes[:'group_id'] if attributes[:'group_id'] self.user_id = attributes[:'userId'] if attributes[:'userId'] raise 'You cannot provide both :userId and :user_id' if attributes.key?(:'userId') && attributes.key?(:'user_id') self.user_id = attributes[:'user_id'] if attributes[:'user_id'] self.time_created = attributes[:'timeCreated'] if attributes[:'timeCreated'] raise 'You cannot provide both :timeCreated and :time_created' if attributes.key?(:'timeCreated') && attributes.key?(:'time_created') self.time_created = attributes[:'time_created'] if attributes[:'time_created'] self.lifecycle_state = attributes[:'lifecycleState'] if attributes[:'lifecycleState'] raise 'You cannot provide both :lifecycleState and :lifecycle_state' if attributes.key?(:'lifecycleState') && attributes.key?(:'lifecycle_state') self.lifecycle_state = attributes[:'lifecycle_state'] if attributes[:'lifecycle_state'] self.inactive_status = attributes[:'inactiveStatus'] if attributes[:'inactiveStatus'] raise 'You cannot provide both :inactiveStatus and :inactive_status' if attributes.key?(:'inactiveStatus') && attributes.key?(:'inactive_status') self.inactive_status = attributes[:'inactive_status'] if attributes[:'inactive_status'] end |
Instance Attribute Details
#compartment_id ⇒ String
[Required] The OCID of the tenancy containing the user, group, and membership object.
29 30 31 |
# File 'lib/oci/identity/models/user_group_membership.rb', line 29 def compartment_id @compartment_id end |
#group_id ⇒ String
[Required] The OCID of the group.
33 34 35 |
# File 'lib/oci/identity/models/user_group_membership.rb', line 33 def group_id @group_id end |
#id ⇒ String
[Required] The OCID of the membership.
25 26 27 |
# File 'lib/oci/identity/models/user_group_membership.rb', line 25 def id @id end |
#inactive_status ⇒ Integer
The detailed status of INACTIVE lifecycleState.
54 55 56 |
# File 'lib/oci/identity/models/user_group_membership.rb', line 54 def inactive_status @inactive_status end |
#lifecycle_state ⇒ String
[Required] The membership's current state. After creating a membership object, make sure its lifecycleState
changes from CREATING to ACTIVE before using it.
50 51 52 |
# File 'lib/oci/identity/models/user_group_membership.rb', line 50 def lifecycle_state @lifecycle_state end |
#time_created ⇒ DateTime
[Required] Date and time the membership was created, in the format defined by RFC3339.
Example: 2016-08-25T21:10:29.600Z
44 45 46 |
# File 'lib/oci/identity/models/user_group_membership.rb', line 44 def time_created @time_created end |
#user_id ⇒ String
[Required] The OCID of the user.
37 38 39 |
# File 'lib/oci/identity/models/user_group_membership.rb', line 37 def user_id @user_id end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
57 58 59 60 61 62 63 64 65 66 67 68 69 |
# File 'lib/oci/identity/models/user_group_membership.rb', line 57 def self.attribute_map { # rubocop:disable Style/SymbolLiteral 'id': :'id', 'compartment_id': :'compartmentId', 'group_id': :'groupId', 'user_id': :'userId', 'time_created': :'timeCreated', 'lifecycle_state': :'lifecycleState', 'inactive_status': :'inactiveStatus' # rubocop:enable Style/SymbolLiteral } end |
.swagger_types ⇒ Object
Attribute type mapping.
72 73 74 75 76 77 78 79 80 81 82 83 84 |
# File 'lib/oci/identity/models/user_group_membership.rb', line 72 def self.swagger_types { # rubocop:disable Style/SymbolLiteral 'id': :'String', 'compartment_id': :'String', 'group_id': :'String', 'user_id': :'String', 'time_created': :'DateTime', 'lifecycle_state': :'String', 'inactive_status': :'Integer' # rubocop:enable Style/SymbolLiteral } end |
Instance Method Details
#==(other) ⇒ Object
Checks equality by comparing each attribute.
164 165 166 167 168 169 170 171 172 173 174 175 |
# File 'lib/oci/identity/models/user_group_membership.rb', line 164 def ==(other) return true if equal?(other) self.class == other.class && id == other.id && compartment_id == other.compartment_id && group_id == other.group_id && user_id == other.user_id && time_created == other.time_created && lifecycle_state == other.lifecycle_state && inactive_status == other.inactive_status end |
#build_from_hash(attributes) ⇒ Object
Builds the object from hash
200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 |
# File 'lib/oci/identity/models/user_group_membership.rb', line 200 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
180 181 182 |
# File 'lib/oci/identity/models/user_group_membership.rb', line 180 def eql?(other) self == other end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
189 190 191 |
# File 'lib/oci/identity/models/user_group_membership.rb', line 189 def hash [id, compartment_id, group_id, user_id, time_created, lifecycle_state, inactive_status].hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
233 234 235 236 237 238 239 240 241 242 |
# File 'lib/oci/identity/models/user_group_membership.rb', line 233 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
227 228 229 |
# File 'lib/oci/identity/models/user_group_membership.rb', line 227 def to_s to_hash.to_s end |