@Generated(value="OracleSDKGenerator", comments="API Version: 20160918") public final class DynamicGroup extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
A dynamic group defines a matching rule. Every bare metal or virtual machine instance is deployed with an instance certificate. The certificate contains metadata about the instance. This includes the instance OCID and the compartment OCID, along with a few other optional properties. When an API call is made using this instance certificate as the authenticator, the certificate can be matched to one or multiple dynamic groups. The instance can then get access to the API based on the permissions granted in policies written for the dynamic groups.
This works like regular user/group membership. But in that case, the membership is a static relationship, whereas in a dynamic group, the membership of an instance certificate to a dynamic group is determined during runtime. For more information, see [Managing Dynamic Groups](https://docs.cloud.oracle.com/Content/Identity/dynamicgroups/managingdynamicgroups.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 DynamicGroup.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 DynamicGroup.Builder
, which maintain a
set of all explicitly set fields called DynamicGroup.Builder.__explicitlySet__
. The hashCode()
and equals(Object)
methods are implemented to take the explicitly set
fields into account. The constructor, on the other hand, does not take the explicitly set fields
into account (since the constructor cannot distinguish explicit null
from unset null
).
Modifier and Type | Class and Description |
---|---|
static class |
DynamicGroup.Builder |
static class |
DynamicGroup.LifecycleState
The group’s current state.
|
EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME
Constructor and Description |
---|
DynamicGroup(String id,
String compartmentId,
String name,
String description,
String matchingRule,
Date timeCreated,
DynamicGroup.LifecycleState lifecycleState,
Long inactiveStatus,
Map<String,String> freeformTags,
Map<String,Map<String,Object>> definedTags)
Deprecated.
|
Modifier and Type | Method and Description |
---|---|
static DynamicGroup.Builder |
builder()
Create a new builder.
|
boolean |
equals(Object o) |
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.
|
DynamicGroup.LifecycleState |
getLifecycleState()
The group’s current state.
|
String |
getMatchingRule()
A rule string that defines which instance certificates will be matched.
|
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() |
DynamicGroup.Builder |
toBuilder() |
String |
toString() |
String |
toString(boolean includeByteArrayContents)
Return a string representation of the object.
|
markPropertyAsExplicitlySet, wasPropertyExplicitlySet
@Deprecated @ConstructorProperties(value={"id","compartmentId","name","description","matchingRule","timeCreated","lifecycleState","inactiveStatus","freeformTags","definedTags"}) public DynamicGroup(String id, String compartmentId, String name, String description, String matchingRule, Date timeCreated, DynamicGroup.LifecycleState lifecycleState, Long inactiveStatus, Map<String,String> freeformTags, Map<String,Map<String,Object>> definedTags)
public static DynamicGroup.Builder builder()
Create a new builder.
public DynamicGroup.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.
(For tenancies that support identity domains) You can have an empty description.
public String getMatchingRule()
A rule string that defines which instance certificates will be matched. For syntax, see Managing Dynamic Groups.
public Date getTimeCreated()
Date and time the group was created, in the format defined by RFC3339.
Example: 2016-08-25T21:10:29.600Z
public DynamicGroup.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"}}
public String toString()
toString
in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
public String toString(boolean includeByteArrayContents)
Return a string representation of the object.
includeByteArrayContents
- true to include the full contents of byte arrayspublic boolean equals(Object o)
equals
in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
public int hashCode()
hashCode
in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
Copyright © 2016–2024. All rights reserved.