@Generated(value="OracleSDKGenerator", comments="API Version: 20160918") public final class Policy extends Object
A document that specifies the type of access a group has to the resources in a compartment. For information about policies and other IAM Service components, see Overview of the IAM Service. If you’re new to policies, see Getting Started with Policies.
The word "policy" is used by people in different ways:
An individual statement written in the policy language * A collection of statements in a single, named "policy" document (which has an Oracle Cloud ID (OCID) assigned to it) * The overall body of policies your organization uses to control access to resources
To use any of the API operations, you must be authorized in an IAM policy. If you’re not authorized, talk to an administrator.
Note: Objects should always be created or deserialized using the Policy.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 Policy.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 |
Policy.Builder |
static class |
Policy.LifecycleState
The policy’s current state.
|
Constructor and Description |
---|
Policy(String id,
String compartmentId,
String name,
List<String> statements,
String description,
Date timeCreated,
Policy.LifecycleState lifecycleState,
Long inactiveStatus,
Date versionDate,
Map<String,String> freeformTags,
Map<String,Map<String,Object>> definedTags)
Deprecated.
|
Modifier and Type | Method and Description |
---|---|
static Policy.Builder |
builder()
Create a new builder.
|
boolean |
equals(Object o) |
Set<String> |
get__explicitlySet__() |
String |
getCompartmentId()
The OCID of the compartment containing the policy (either the tenancy or another compartment).
|
Map<String,Map<String,Object>> |
getDefinedTags()
Defined tags for this resource.
|
String |
getDescription()
The description you assign to the policy.
|
Map<String,String> |
getFreeformTags()
Free-form tags for this resource.
|
String |
getId()
The OCID of the policy.
|
Long |
getInactiveStatus()
The detailed status of INACTIVE lifecycleState.
|
Policy.LifecycleState |
getLifecycleState()
The policy’s current state.
|
String |
getName()
The name you assign to the policy during creation.
|
List<String> |
getStatements()
An array of one or more policy statements written in the policy language.
|
Date |
getTimeCreated()
Date and time the policy was created, in the format defined by RFC3339.
|
Date |
getVersionDate()
The version of the policy.
|
int |
hashCode() |
String |
toString() |
@ConstructorProperties(value={"id","compartmentId","name","statements","description","timeCreated","lifecycleState","inactiveStatus","versionDate","freeformTags","definedTags"}) @Deprecated public Policy(String id, String compartmentId, String name, List<String> statements, String description, Date timeCreated, Policy.LifecycleState lifecycleState, Long inactiveStatus, Date versionDate, Map<String,String> freeformTags, Map<String,Map<String,Object>> definedTags)
public static Policy.Builder builder()
Create a new builder.
public String getId()
The OCID of the policy.
public String getCompartmentId()
The OCID of the compartment containing the policy (either the tenancy or another compartment).
public String getName()
The name you assign to the policy during creation. The name must be unique across all policies in the tenancy and cannot be changed.
public List<String> getStatements()
An array of one or more policy statements written in the policy language.
public String getDescription()
The description you assign to the policy. Does not have to be unique, and it’s changeable.
public Date getTimeCreated()
Date and time the policy was created, in the format defined by RFC3339.
Example: 2016-08-25T21:10:29.600Z
public Policy.LifecycleState getLifecycleState()
The policy’s current state. After creating a policy, make sure its lifecycleState
changes from CREATING to ACTIVE before using it.
public Long getInactiveStatus()
The detailed status of INACTIVE lifecycleState.
public Date getVersionDate()
The version of the policy. If null or set to an empty string, when a request comes in for authorization, the policy will be evaluated according to the current behavior of the services at that moment. If set to a particular date (YYYY-MM-DD), the policy will be evaluated according to the behavior of the services on that date.
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–2019. All rights reserved.