Package com.oracle.bmc.identity.model

Class Compartment

  • @Generated(value="OracleSDKGenerator",
           comments="API Version: 20160918")
public final class Compartment
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
    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.oracle.com/iaas/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 Compartment.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).

    • Method Detail

      • getId

        public String getId()
        The OCID of the compartment.
        Returns:
        the value

      • getCompartmentId

        public String getCompartmentId()
        The OCID of the parent compartment containing the compartment.
        Returns:
        the value

      • getName

        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.

        Returns:
        the value

      • getDescription

        public String getDescription()
        The description you assign to the compartment.

        Does not have to be unique, and it’s changeable.

        Returns:
        the value

      • getTimeCreated

        public Date getTimeCreated()
        Date and time the compartment was created, in the format defined by RFC3339.

        Example: 2016-08-25T21:10:29.600Z

        Returns:
        the value

      • getLifecycleState

        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.

        Returns:
        the value

      • getInactiveStatus

        public Long getInactiveStatus()
        The detailed status of INACTIVE lifecycleState.
        Returns:
        the value

      • getIsAccessible

        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).

        Returns:
        the value

      • getFreeformTags

        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”}

        Returns:
        the value

      • getDefinedTags

        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”}}

        Returns:
        the value

      • toString

        public String toString()
        Overrides:
        toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

      • toString

        public String toString​(boolean includeByteArrayContents)
        Return a string representation of the object.
        Parameters:
        includeByteArrayContents - true to include the full contents of byte arrays
        Returns:
        string representation

      • equals

        public boolean equals​(Object o)
        Overrides:
        equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel