@Generated(value="OracleSDKGenerator", comments="API Version: 20160918") public final class Group extends Object
A collection of users who all need the same type of access to a particular set of resources or compartment. For conceptual information about groups and other IAM Service components, see Overview of the IAM Service.
If you're federating with an identity provider (IdP), you need to create mappings between the groups
defined in the IdP and groups you define in the IAM service. For more information, see
[Identity Providers and Federation](https://docs.cloud.oracle.com/Content/Identity/Concepts/federation.htm). Also see
IdentityProvider and
IdpGroupMapping.
To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see [Getting Started with Policies](https://docs.cloud.oracle.com/Content/Identity/Concepts/policygetstarted.htm).
*Warning:** Oracle recommends that you avoid using any confidential information when you supply string values
using the API.
Note: Objects should always be created or deserialized using the Group.Builder. This model distinguishes fields
that are null because they are unset from fields that are explicitly set to null. This is done in
the setter methods of the Group.Builder, which maintain a set of all explicitly set fields called
__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take
__explicitlySet__ into account. The constructor, on the other hand, does not set __explicitlySet__
(since the constructor cannot distinguish explicit null from unset null).
| Modifier and Type | Class and Description |
|---|---|
static class |
Group.Builder |
static class |
Group.LifecycleState
The group’s current state.
|
| Constructor and Description |
|---|
Group(String id,
String compartmentId,
String name,
String description,
Date timeCreated,
Group.LifecycleState lifecycleState,
Long inactiveStatus,
Map<String,String> freeformTags,
Map<String,Map<String,Object>> definedTags)
Deprecated.
|
| Modifier and Type | Method and Description |
|---|---|
static Group.Builder |
builder()
Create a new builder.
|
boolean |
equals(Object o) |
Set<String> |
get__explicitlySet__() |
String |
getCompartmentId()
The OCID of the tenancy containing the group.
|
Map<String,Map<String,Object>> |
getDefinedTags()
Defined tags for this resource.
|
String |
getDescription()
The description you assign to the group.
|
Map<String,String> |
getFreeformTags()
Free-form tags for this resource.
|
String |
getId()
The OCID of the group.
|
Long |
getInactiveStatus()
The detailed status of INACTIVE lifecycleState.
|
Group.LifecycleState |
getLifecycleState()
The group’s current state.
|
String |
getName()
The name you assign to the group during creation.
|
Date |
getTimeCreated()
Date and time the group was created, in the format defined by RFC3339.
|
int |
hashCode() |
Group.Builder |
toBuilder() |
String |
toString() |
@ConstructorProperties(value={"id","compartmentId","name","description","timeCreated","lifecycleState","inactiveStatus","freeformTags","definedTags"}) @Deprecated public Group(String id, String compartmentId, String name, String description, Date timeCreated, Group.LifecycleState lifecycleState, Long inactiveStatus, Map<String,String> freeformTags, Map<String,Map<String,Object>> definedTags)
public static Group.Builder builder()
Create a new builder.
public Group.Builder toBuilder()
public String getId()
The OCID of the group.
public String getCompartmentId()
The OCID of the tenancy containing the group.
public String getName()
The name you assign to the group during creation. The name must be unique across all groups in the tenancy and cannot be changed.
public String getDescription()
The description you assign to the group. Does not have to be unique, and it’s changeable.
public Date getTimeCreated()
Date and time the group was created, in the format defined by RFC3339.
Example: `2016-08-25T21:10:29.600Z`
public Group.LifecycleState getLifecycleState()
The group’s current state. After creating a group, make sure its lifecycleState changes from CREATING to
ACTIVE before using it.
public Long getInactiveStatus()
The detailed status of INACTIVE lifecycleState.
public Map<String,String> getFreeformTags()
Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
For more information, see Resource Tags.
Example: {\"Department\": \"Finance\"}
public Map<String,Map<String,Object>> getDefinedTags()
Defined tags for this resource. Each key is predefined and scoped to a namespace.
For more information, see Resource Tags.
Example: {\"Operations\": {\"CostCenter\": \"42\"}}
Copyright © 2016–2021. All rights reserved.