Package com.oracle.bmc.identity.model

Class Tenancy

  • @Generated(value="OracleSDKGenerator",
           comments="API Version: 20160918")
public final class Tenancy
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
    The root compartment that contains all of your organization’s compartments and other Oracle Cloud Infrastructure cloud resources.

    When you sign up for Oracle Cloud Infrastructure, Oracle creates a tenancy for your company, which is a secure and isolated partition where you can create, organize, and administer your cloud 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. 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).
    Note: Objects should always be created or deserialized using the Tenancy.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 Tenancy.Builder, which maintain a set of all explicitly set fields called Tenancy.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 tenancy.
        Returns:
        the value

      • getName

        public String getName()
        The name of the tenancy.
        Returns:
        the value

      • getDescription

        public String getDescription()
        The description of the tenancy.
        Returns:
        the value

      • getHomeRegionKey

        public String getHomeRegionKey()
        The region key for the tenancy’s home region.

        For the full list of supported regions, see Regions and Availability Domains.

        Example: PHX

        Returns:
        the value

      • getUpiIdcsCompatibilityLayerEndpoint

        public String getUpiIdcsCompatibilityLayerEndpoint()
        Url which refers to the UPI IDCS compatibility layer endpoint configured for this Tenant’s home region.
        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