Class: Google::Apis::CloudidentityV1::Group

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

A group within the Cloud Identity Groups API. A Group is a collection of entities, where each entity is either a user, another group, or a service account.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Group

Returns a new instance of Group.



1494
1495
1496
 
# File 'lib/google/apis/cloudidentity_v1/classes.rb', line 1494

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

Instance Attribute Details

#create_time ⇒ String

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

Returns:

  • (String) 


1432
1433
1434
 
# File 'lib/google/apis/cloudidentity_v1/classes.rb', line 1432

def create_time
  @create_time
end

#description ⇒ String

An extended description to help users determine the purpose of a Group. Must not be longer than 4,096 characters. Corresponds to the JSON property description

Returns:

  • (String) 


1438
1439
1440
 
# File 'lib/google/apis/cloudidentity_v1/classes.rb', line 1438

def description
  @description
end

#display_name ⇒ String

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

Returns:

  • (String) 


1443
1444
1445
 
# File 'lib/google/apis/cloudidentity_v1/classes.rb', line 1443

def display_name
  @display_name
end

#dynamic_group_metadata ⇒ Google::Apis::CloudidentityV1::DynamicGroupMetadata

Dynamic group metadata like queries and status. Corresponds to the JSON property dynamicGroupMetadata

Returns:



1448
1449
1450
 
# File 'lib/google/apis/cloudidentity_v1/classes.rb', line 1448

def dynamic_group_metadata
  @dynamic_group_metadata
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:



1456
1457
1458
 
# File 'lib/google/apis/cloudidentity_v1/classes.rb', line 1456

def group_key
  @group_key
end

#labels ⇒ Hash<String,String>

Required. One or more label entries that apply to the Group. Currently supported labels contain a key with an empty value. Google Groups are the default type of group and have a label with a key of cloudidentity.googleapis. com/groups.discussion_forum and an empty value. Existing Google Groups can have an additional label with a key of cloudidentity.googleapis.com/groups. security and an empty value added to them. This is an immutable change and the security label cannot be removed once added. Dynamic groups have a label with a key of cloudidentity.googleapis.com/groups.dynamic. Identity-mapped groups for Cloud Search have a label with a key of system/groups/external and an empty value. Corresponds to the JSON property labels

Returns:

  • (Hash<String,String>) 


1470
1471
1472
 
# File 'lib/google/apis/cloudidentity_v1/classes.rb', line 1470

def labels
  @labels
end

#name ⇒ String

Output only. The resource name of the Group. Shall be of the form groups/group`. Corresponds to the JSON propertyname`

Returns:

  • (String) 


1476
1477
1478
 
# File 'lib/google/apis/cloudidentity_v1/classes.rb', line 1476

def name
  @name
end

#parent ⇒ String

Required. Immutable. The resource name of the entity under which this Group resides in the Cloud Identity resource hierarchy. Must be of the form identitysources/identity_sourcefor external [identity-mapped groups](https: //support.google.com/a/answer/9039510) or `customers/`customer_id for Google Groups. The customer_id must begin with "C" (for example, 'C046psxkn'). Find your customer ID. Corresponds to the JSON property parent

Returns:

  • (String) 


1487
1488
1489
 
# File 'lib/google/apis/cloudidentity_v1/classes.rb', line 1487

def parent
  @parent
end

#update_time ⇒ String

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

Returns:

  • (String) 


1492
1493
1494
 
# File 'lib/google/apis/cloudidentity_v1/classes.rb', line 1492

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
 
# File 'lib/google/apis/cloudidentity_v1/classes.rb', line 1499

def update!(**args)
  @create_time = args[:create_time] if args.key?(:create_time)
  @description = args[:description] if args.key?(:description)
  @display_name = args[:display_name] if args.key?(:display_name)
  @dynamic_group_metadata = args[:dynamic_group_metadata] if args.key?(:dynamic_group_metadata)
  @group_key = args[:group_key] if args.key?(:group_key)
  @labels = args[:labels] if args.key?(:labels)
  @name = args[:name] if args.key?(:name)
  @parent = args[:parent] if args.key?(:parent)
  @update_time = args[:update_time] if args.key?(:update_time)
end