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

Resource representing a Group.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Google::Apis::Core::JsonObjectSupport

#to_json

Methods included from Google::Apis::Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ Group

Returns a new instance of Group



117
118
119
 
# File 'generated/google/apis/cloudidentity_v1/classes.rb', line 117

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

Instance Attribute Details

#create_time ⇒ String

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

Returns:

  • (String) 


65
66
67
 
# File 'generated/google/apis/cloudidentity_v1/classes.rb', line 65

def create_time
  @create_time
end

#description ⇒ String

An extended description to help users determine the purpose of a Group. For example, you can include information about who should join the Group, the types of messages to send to the Group, links to FAQs about the Group, or related Groups. Maximum length is 4,096 characters. Corresponds to the JSON property description

Returns:

  • (String) 


73
74
75
 
# File 'generated/google/apis/cloudidentity_v1/classes.rb', line 73

def description
  @description
end

#display_name ⇒ String

The Group's display name. Corresponds to the JSON property displayName

Returns:

  • (String) 


78
79
80
 
# File 'generated/google/apis/cloudidentity_v1/classes.rb', line 78

def display_name
  @display_name
end

#group_key ⇒ Google::Apis::CloudidentityV1::EntityKey

An EntityKey uniquely identifies an Entity. Namespaces are used to provide isolation for IDs. A single ID can be reused across namespaces but the combination of a namespace and an ID must be unique. Corresponds to the JSON property groupKey

Returns:



85
86
87
 
# File 'generated/google/apis/cloudidentity_v1/classes.rb', line 85

def group_key
  @group_key
end

#labels ⇒ Hash<String,String>

Required. Required. Labels for Group resource. For creating Groups under a namespace, set label key to 'labels/system/groups/external' and label value as empty. Corresponds to the JSON property labels

Returns:

  • (Hash<String,String>) 


92
93
94
 
# File 'generated/google/apis/cloudidentity_v1/classes.rb', line 92

def labels
  @labels
end

#name ⇒ String

Output only. Resource name of the Group in the format: groups/group_id`, where group_id is the unique ID assigned to the Group. Must be left blank while creating a Group. Corresponds to the JSON propertyname`

Returns:

  • (String) 


101
102
103
 
# File 'generated/google/apis/cloudidentity_v1/classes.rb', line 101

def name
  @name
end

#parent ⇒ String

Required. Immutable. The entity under which this Group resides in Cloud Identity resource hierarchy. Must be set when creating a Group, read-only afterwards. Currently allowed types: identitysources. Corresponds to the JSON property parent

Returns:

  • (String) 


109
110
111
 
# File 'generated/google/apis/cloudidentity_v1/classes.rb', line 109

def parent
  @parent
end

#update_time ⇒ String

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

Returns:

  • (String) 


115
116
117
 
# File 'generated/google/apis/cloudidentity_v1/classes.rb', line 115

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



122
123
124
125
126
127
128
129
130
131
 
# File 'generated/google/apis/cloudidentity_v1/classes.rb', line 122

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