Class: Google::Apis::CloudidentityV1::MembershipRelation

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

Overview

Message containing membership relation.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ MembershipRelation

Returns a new instance of MembershipRelation.



2146
2147
2148
 
# File 'lib/google/apis/cloudidentity_v1/classes.rb', line 2146

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

Instance Attribute Details

#description ⇒ String

An extended description to help users determine the purpose of a Group. Corresponds to the JSON property description

Returns:

  • (String) 


2107
2108
2109
 
# File 'lib/google/apis/cloudidentity_v1/classes.rb', line 2107

def description
  @description
end

#display_name ⇒ String

The display name of the Group. Corresponds to the JSON property displayName

Returns:

  • (String) 


2112
2113
2114
 
# File 'lib/google/apis/cloudidentity_v1/classes.rb', line 2112

def display_name
  @display_name
end

#group ⇒ String

The resource name of the Group. Shall be of the form groups/group_id`. Corresponds to the JSON propertygroup`

Returns:

  • (String) 


2118
2119
2120
 
# File 'lib/google/apis/cloudidentity_v1/classes.rb', line 2118

def group
  @group
end

#group_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 groupKey

Returns:



2126
2127
2128
 
# File 'lib/google/apis/cloudidentity_v1/classes.rb', line 2126

def group_key
  @group_key
end

#labels ⇒ Hash<String,String>

One or more label entries that apply to the Group. Currently supported labels contain a key with an empty value. Corresponds to the JSON property labels

Returns:

  • (Hash<String,String>) 


2132
2133
2134
 
# File 'lib/google/apis/cloudidentity_v1/classes.rb', line 2132

def labels
  @labels
end

#membership ⇒ String

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

Returns:

  • (String) 


2139
2140
2141
 
# File 'lib/google/apis/cloudidentity_v1/classes.rb', line 2139

def membership
  @membership
end

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

The MembershipRoles that apply to the Membership. Corresponds to the JSON property roles

Returns:



2144
2145
2146
 
# File 'lib/google/apis/cloudidentity_v1/classes.rb', line 2144

def roles
  @roles
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2151
2152
2153
2154
2155
2156
2157
2158
2159
 
# File 'lib/google/apis/cloudidentity_v1/classes.rb', line 2151

def update!(**args)
  @description = args[:description] if args.key?(:description)
  @display_name = args[:display_name] if args.key?(:display_name)
  @group = args[:group] if args.key?(:group)
  @group_key = args[:group_key] if args.key?(:group_key)
  @labels = args[:labels] if args.key?(:labels)
  @membership = args[:membership] if args.key?(:membership)
  @roles = args[:roles] if args.key?(:roles)
end