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

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 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.



996
997
998
 
# File 'generated/google/apis/cloudidentity_v1/classes.rb', line 996

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) 


941
942
943
 
# File 'generated/google/apis/cloudidentity_v1/classes.rb', line 941

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) 


947
948
949
 
# File 'generated/google/apis/cloudidentity_v1/classes.rb', line 947

def description
  @description
end

#display_name ⇒ String

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

Returns:

  • (String) 


952
953
954
 
# File 'generated/google/apis/cloudidentity_v1/classes.rb', line 952

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



960
961
962
 
# File 'generated/google/apis/cloudidentity_v1/classes.rb', line 960

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. Examples: "cloudidentity.googleapis.com/groups. discussion_forum": "" or "system/groups/external": "". Corresponds to the JSON property labels

Returns:

  • (Hash<String,String>) 


975
976
977
 
# File 'generated/google/apis/cloudidentity_v1/classes.rb', line 975

def labels
  @labels
end

#name ⇒ String

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

Returns:

  • (String) 


981
982
983
 
# File 'generated/google/apis/cloudidentity_v1/classes.rb', line 981

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_source_idfor external- identity-mapped groups or ` customers/`customer_id for Google Groups. Corresponds to the JSON property parent

Returns:

  • (String) 


989
990
991
 
# File 'generated/google/apis/cloudidentity_v1/classes.rb', line 989

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) 


994
995
996
 
# File 'generated/google/apis/cloudidentity_v1/classes.rb', line 994

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
 
# File 'generated/google/apis/cloudidentity_v1/classes.rb', line 1001

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)
  @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