Group (Cloud Identity API v1-rev20241010-2.0.0)

java.lang.Object
- java.util.AbstractMap<String,Object>
- - com.google.api.client.util.GenericData
  - - com.google.api.client.json.GenericJson
    - - com.google.api.services.cloudidentity.v1.model.Group

All Implemented Interfaces:

Cloneable, Map<String,Object>
```
public final class Group
extends com.google.api.client.json.GenericJson
```
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.
This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Cloud Identity API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary
- Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
  com.google.api.client.util.GenericData.Flags
- Nested classes/interfaces inherited from class java.util.AbstractMap
  AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>
- Nested classes/interfaces inherited from interface java.util.Map
  Map.Entry<K,V>

Constructor Summary

Constructors
Constructor and Description

Group()

Constructors
Constructor and Description
`Group()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Group`	`clone()`
`List<EntityKey>`	`getAdditionalGroupKeys()` Output only.
`String`	`getCreateTime()` Output only.
`String`	`getDescription()` An extended description to help users determine the purpose of a `Group`.
`String`	`getDisplayName()` The display name of the `Group`.
`DynamicGroupMetadata`	`getDynamicGroupMetadata()` Optional.
`EntityKey`	`getGroupKey()` Required.
`Map<String,String>`	`getLabels()` Required.
`String`	`getName()` Output only.
`String`	`getParent()` Required.
`String`	`getUpdateTime()` Output only.
`Group`	`set(String fieldName, Object value)`
`Group`	`setAdditionalGroupKeys(List<EntityKey> additionalGroupKeys)` Output only.
`Group`	`setCreateTime(String createTime)` Output only.
`Group`	`setDescription(String description)` An extended description to help users determine the purpose of a `Group`.
`Group`	`setDisplayName(String displayName)` The display name of the `Group`.
`Group`	`setDynamicGroupMetadata(DynamicGroupMetadata dynamicGroupMetadata)` Optional.
`Group`	`setGroupKey(EntityKey groupKey)` Required.
`Group`	`setLabels(Map<String,String> labels)` Required.
`Group`	`setName(String name)` Output only.
`Group`	`setParent(String parent)` Required.
`Group`	`setUpdateTime(String updateTime)` Output only.

Methods inherited from class com.google.api.client.json.GenericJson
getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData
entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

- Constructor Detail
  - Group
```
public Group()
```
- Method Detail
  - getAdditionalGroupKeys
```
public List<EntityKey> getAdditionalGroupKeys()
```
    Output only. Additional group keys associated with the Group.
    
    Returns:
    
    value or null for none
  - setAdditionalGroupKeys
```
public Group setAdditionalGroupKeys(List<EntityKey> additionalGroupKeys)
```
    Output only. Additional group keys associated with the Group.
    
    Parameters:
    
    additionalGroupKeys - additionalGroupKeys or null for none
  - getCreateTime
```
public String getCreateTime()
```
    Output only. The time when the `Group` was created.
    
    Returns:
    
    value or null for none
  - setCreateTime
```
public Group setCreateTime(String createTime)
```
    Output only. The time when the `Group` was created.
    
    Parameters:
    
    createTime - createTime or null for none
  - getDescription
```
public String getDescription()
```
    An extended description to help users determine the purpose of a `Group`. Must not be longer than 4,096 characters.
    
    Returns:
    
    value or null for none
  - setDescription
```
public Group setDescription(String description)
```
    An extended description to help users determine the purpose of a `Group`. Must not be longer than 4,096 characters.
    
    Parameters:
    
    description - description or null for none
  - getDisplayName
```
public String getDisplayName()
```
    The display name of the `Group`.
    
    Returns:
    
    value or null for none
  - setDisplayName
```
public Group setDisplayName(String displayName)
```
    The display name of the `Group`.
    
    Parameters:
    
    displayName - displayName or null for none
  - getDynamicGroupMetadata
```
public DynamicGroupMetadata getDynamicGroupMetadata()
```
    Optional. Dynamic group metadata like queries and status.
    
    Returns:
    
    value or null for none
  - setDynamicGroupMetadata
```
public Group setDynamicGroupMetadata(DynamicGroupMetadata dynamicGroupMetadata)
```
    Optional. Dynamic group metadata like queries and status.
    
    Parameters:
    
    dynamicGroupMetadata - dynamicGroupMetadata or null for none
  - getGroupKey
```
public EntityKey getGroupKey()
```
    Required. The `EntityKey` of the `Group`.
    
    Returns:
    
    value or null for none
  - setGroupKey
```
public Group setGroupKey(EntityKey groupKey)
```
    Required. The `EntityKey` of the `Group`.
    
    Parameters:
    
    groupKey - groupKey or null for none
  - getLabels
```
public Map<String,String> getLabels()
```
    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.
    
    Returns:
    
    value or null for none
  - setLabels
```
public Group setLabels(Map<String,String> labels)
```
    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.
    
    Parameters:
    
    labels - labels or null for none
  - getName
```
public String getName()
```
    Output only. The [resource name](https://cloud.google.com/apis/design/resource_names) of the `Group`. Shall be of the form `groups/{group}`.
    
    Returns:
    
    value or null for none
  - setName
```
public Group setName(String name)
```
    Output only. The [resource name](https://cloud.google.com/apis/design/resource_names) of the `Group`. Shall be of the form `groups/{group}`.
    
    Parameters:
    
    name - name or null for none
  - getParent
```
public String getParent()
```
    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}` for 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.] (https://support.google.com/cloudidentity/answer/10070793)
    
    Returns:
    
    value or null for none
  - setParent
```
public Group setParent(String parent)
```
    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}` for 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.] (https://support.google.com/cloudidentity/answer/10070793)
    
    Parameters:
    
    parent - parent or null for none
  - getUpdateTime
```
public String getUpdateTime()
```
    Output only. The time when the `Group` was last updated.
    
    Returns:
    
    value or null for none
  - setUpdateTime
```
public Group setUpdateTime(String updateTime)
```
    Output only. The time when the `Group` was last updated.
    
    Parameters:
    
    updateTime - updateTime or null for none
  - set
```
public Group set(String fieldName,
                 Object value)
```
    Overrides:
    
    set in class com.google.api.client.json.GenericJson
  - clone
```
public Group clone()
```
    Overrides:
    
    clone in class com.google.api.client.json.GenericJson

Class Group

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

Nested classes/interfaces inherited from class java.util.AbstractMap

Nested classes/interfaces inherited from interface java.util.Map

Constructor Summary

Method Summary

Methods inherited from class com.google.api.client.json.GenericJson

Methods inherited from class com.google.api.client.util.GenericData

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

Group

Method Detail

getAdditionalGroupKeys

setAdditionalGroupKeys

getCreateTime

setCreateTime

getDescription

setDescription

getDisplayName

setDisplayName

getDynamicGroupMetadata

setDynamicGroupMetadata

getGroupKey

setGroupKey

getLabels

setLabels

getName

setName

getParent

setParent

getUpdateTime

setUpdateTime

set

clone