Class: Google::Apis::CloudidentityV1beta1::Group
- Inherits:
-
Object
- Object
- Google::Apis::CloudidentityV1beta1::Group
- Defined in:
- generated/google/apis/cloudidentity_v1beta1/classes.rb,
generated/google/apis/cloudidentity_v1beta1/representations.rb,
generated/google/apis/cloudidentity_v1beta1/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 or
another group.
Instance Attribute Summary collapse
-
#additional_group_keys ⇒ Array<Google::Apis::CloudidentityV1beta1::EntityKey>
Optional.
-
#create_time ⇒ String
Output only.
-
#description ⇒ String
An extended description to help users determine the purpose of a
Group
. -
#display_name ⇒ String
The display name of the
Group
. -
#group_key ⇒ Google::Apis::CloudidentityV1beta1::EntityKey
A unique identifier for an entity in the Cloud Identity Groups API.
-
#labels ⇒ Hash<String,String>
Required.
-
#name ⇒ String
Output only.
-
#parent ⇒ String
Required.
-
#update_time ⇒ String
Output only.
Instance Method Summary collapse
-
#initialize(**args) ⇒ Group
constructor
A new instance of Group.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Google::Apis::Core::JsonObjectSupport
Methods included from Google::Apis::Core::Hashable
Constructor Details
#initialize(**args) ⇒ Group
Returns a new instance of Group.
129 130 131 |
# File 'generated/google/apis/cloudidentity_v1beta1/classes.rb', line 129 def initialize(**args) update!(**args) end |
Instance Attribute Details
#additional_group_keys ⇒ Array<Google::Apis::CloudidentityV1beta1::EntityKey>
Optional. Additional entity key aliases for a Group.
Corresponds to the JSON property additionalGroupKeys
72 73 74 |
# File 'generated/google/apis/cloudidentity_v1beta1/classes.rb', line 72 def additional_group_keys @additional_group_keys end |
#create_time ⇒ String
Output only. The time when the Group
was created.
Corresponds to the JSON property createTime
77 78 79 |
# File 'generated/google/apis/cloudidentity_v1beta1/classes.rb', line 77 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
83 84 85 |
# File 'generated/google/apis/cloudidentity_v1beta1/classes.rb', line 83 def description @description end |
#display_name ⇒ String
The display name of the Group
.
Corresponds to the JSON property displayName
88 89 90 |
# File 'generated/google/apis/cloudidentity_v1beta1/classes.rb', line 88 def display_name @display_name end |
#group_key ⇒ Google::Apis::CloudidentityV1beta1::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 namespace
s.
Corresponds to the JSON property groupKey
96 97 98 |
# File 'generated/google/apis/cloudidentity_v1beta1/classes.rb', line 96 def group_key @group_key end |
#labels ⇒ Hash<String,String>
Required. The labels that apply to the Group
.
Must not contain more than one entry. Must contain the entry
'cloudidentity.googleapis.com/groups.discussion_forum': ''
if the Group
is a Google Group or 'system/groups/external': ''
if the Group
is an
external-identity-mapped group.
Corresponds to the JSON property labels
105 106 107 |
# File 'generated/google/apis/cloudidentity_v1beta1/classes.rb', line 105 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 property
name`
113 114 115 |
# File 'generated/google/apis/cloudidentity_v1beta1/classes.rb', line 113 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
122 123 124 |
# File 'generated/google/apis/cloudidentity_v1beta1/classes.rb', line 122 def parent @parent end |
#update_time ⇒ String
Output only. The time when the Group
was last updated.
Corresponds to the JSON property updateTime
127 128 129 |
# File 'generated/google/apis/cloudidentity_v1beta1/classes.rb', line 127 def update_time @update_time end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
134 135 136 137 138 139 140 141 142 143 144 |
# File 'generated/google/apis/cloudidentity_v1beta1/classes.rb', line 134 def update!(**args) @additional_group_keys = args[:additional_group_keys] if args.key?(:additional_group_keys) @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 |