Class: Google::Apis::CloudidentityV1::Membership

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
generated/google/apis/cloudidentity_v1/classes.rb,
generated/google/apis/cloudidentity_v1/representations.rb,
generated/google/apis/cloudidentity_v1/representations.rb

Overview

A membership within the Cloud Identity Groups API. A Membership defines a relationship between a Group and an entity belonging to that Group, referred to as a "member".

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Membership

Returns a new instance of Membership.



1239
1240
1241
 
# File 'generated/google/apis/cloudidentity_v1/classes.rb', line 1239

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#create_time ⇒ String

Output only. The time when the Membership was created. Corresponds to the JSON property createTime

Returns:

  • (String) 


1205
1206
1207
 
# File 'generated/google/apis/cloudidentity_v1/classes.rb', line 1205

def create_time
  @create_time
end

#name ⇒ String

Output only. The resource name of the Membership. Shall be of the form groups/group_id/ memberships/membership_id`. Corresponds to the JSON propertyname`

Returns:

  • (String) 


1212
1213
1214
 
# File 'generated/google/apis/cloudidentity_v1/classes.rb', line 1212

def name
  @name
end

#preferred_member_key ⇒ Google::Apis::CloudidentityV1::EntityKey

A unique identifier for an entity in the Cloud Identity Groups API. An entity can represent either a group with an optional namespace or a user without a namespace. The combination of id and namespace must be unique; however, the same id can be used with different namespaces. Corresponds to the JSON property preferredMemberKey

Returns:



1220
1221
1222
 
# File 'generated/google/apis/cloudidentity_v1/classes.rb', line 1220

def preferred_member_key
  @preferred_member_key
end

#roles ⇒ Array<Google::Apis::CloudidentityV1::MembershipRole>

The MembershipRoles that apply to the Membership. If unspecified, defaults to a single MembershipRole with name MEMBER. Must not contain duplicate MembershipRoles with the same name. Corresponds to the JSON property roles

Returns:



1227
1228
1229
 
# File 'generated/google/apis/cloudidentity_v1/classes.rb', line 1227

def roles
  @roles
end

#type ⇒ String

Output only. The type of the membership. Corresponds to the JSON property type

Returns:

  • (String) 


1232
1233
1234
 
# File 'generated/google/apis/cloudidentity_v1/classes.rb', line 1232

def type
  @type
end

#update_time ⇒ String

Output only. The time when the Membership was last updated. Corresponds to the JSON property updateTime

Returns:

  • (String) 


1237
1238
1239
 
# File 'generated/google/apis/cloudidentity_v1/classes.rb', line 1237

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1244
1245
1246
1247
1248
1249
1250
1251
 
# File 'generated/google/apis/cloudidentity_v1/classes.rb', line 1244

def update!(**args)
  @create_time = args[:create_time] if args.key?(:create_time)
  @name = args[:name] if args.key?(:name)
  @preferred_member_key = args[:preferred_member_key] if args.key?(:preferred_member_key)
  @roles = args[:roles] if args.key?(:roles)
  @type = args[:type] if args.key?(:type)
  @update_time = args[:update_time] if args.key?(:update_time)
end