@Generated(value="OracleSDKGenerator", comments="API Version: 20160918") public final class Compartment extends Object
A collection of related resources. Compartments are a fundamental component of Oracle Cloud Infrastructure for organizing and isolating your cloud resources. You use them to clearly separate resources for the purposes of measuring usage and billing, access (through the use of IAM Service policies), and isolation (separating the resources for one project or business unit from another). A common approach is to create a compartment for each major part of your organization. For more information, see Overview of IAM and also Setting Up Your Tenancy.
To place a resource in a compartment, simply specify the compartment ID in the "Create" request object when
initially creating the resource. For example, to launch an instance into a particular compartment, specify
that compartment's OCID in the LaunchInstance request. You can't move an existing resource from one
compartment to another.
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 [Get Started with Policies](https://docs.cloud.oracle.com/Content/Identity/policiesgs/get-started-with-policies.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 Compartment.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 Compartment.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 |
Compartment.Builder |
static class |
Compartment.LifecycleState
The compartment’s current state.
|
| Constructor and Description |
|---|
Compartment(String id,
String compartmentId,
String name,
String description,
Date timeCreated,
Compartment.LifecycleState lifecycleState,
Long inactiveStatus,
Boolean isAccessible,
Map<String,String> freeformTags,
Map<String,Map<String,Object>> definedTags)
Deprecated.
|
| Modifier and Type | Method and Description |
|---|---|
static Compartment.Builder |
builder()
Create a new builder.
|
boolean |
equals(Object o) |
Set<String> |
get__explicitlySet__() |
String |
getCompartmentId()
The OCID of the parent compartment containing the compartment.
|
Map<String,Map<String,Object>> |
getDefinedTags()
Defined tags for this resource.
|
String |
getDescription()
The description you assign to the compartment.
|
Map<String,String> |
getFreeformTags()
Free-form tags for this resource.
|
String |
getId()
The OCID of the compartment.
|
Long |
getInactiveStatus()
The detailed status of INACTIVE lifecycleState.
|
Boolean |
getIsAccessible()
Indicates whether or not the compartment is accessible for the user making the request.
|
Compartment.LifecycleState |
getLifecycleState()
The compartment’s current state.
|
String |
getName()
The name you assign to the compartment during creation.
|
Date |
getTimeCreated()
Date and time the compartment was created, in the format defined by RFC3339.
|
int |
hashCode() |
Compartment.Builder |
toBuilder() |
String |
toString() |
@ConstructorProperties(value={"id","compartmentId","name","description","timeCreated","lifecycleState","inactiveStatus","isAccessible","freeformTags","definedTags"}) @Deprecated public Compartment(String id, String compartmentId, String name, String description, Date timeCreated, Compartment.LifecycleState lifecycleState, Long inactiveStatus, Boolean isAccessible, Map<String,String> freeformTags, Map<String,Map<String,Object>> definedTags)
public static Compartment.Builder builder()
Create a new builder.
public Compartment.Builder toBuilder()
public String getId()
The OCID of the compartment.
public String getCompartmentId()
The OCID of the parent compartment containing the compartment.
public String getName()
The name you assign to the compartment during creation. The name must be unique across all compartments in the parent. Avoid entering confidential information.
public String getDescription()
The description you assign to the compartment. Does not have to be unique, and it’s changeable.
public Date getTimeCreated()
Date and time the compartment was created, in the format defined by RFC3339.
Example: 2016-08-25T21:10:29.600Z
public Compartment.LifecycleState getLifecycleState()
The compartment’s current state. After creating a compartment, make sure its lifecycleState changes from
CREATING to ACTIVE before using it.
public Long getInactiveStatus()
The detailed status of INACTIVE lifecycleState.
public Boolean getIsAccessible()
Indicates whether or not the compartment is accessible for the user making the request. Returns true when the user has INSPECT permissions directly on a resource in the compartment or indirectly (permissions can be on a resource in a subcompartment).
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–2022. All rights reserved.