com.oracle.bmc.identity.model

Class Tenancy

java.lang.Object

com.oracle.bmc.identity.model.Tenancy

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20160918")
public final class Tenancy
extends Object

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.cloud.oracle.com/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 __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).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Tenancy.Builder

Constructor Summary

Constructors

Constructor and Description
Tenancy(String id, String name, String description, String homeRegionKey, String upiIdcsCompatibilityLayerEndpoint, Map<String,String> freeformTags, Map<String,Map<String,Object>> definedTags) Deprecated.

Method Summary

Modifier and Type	Method and Description
static Tenancy.Builder	builder() Create a new builder.
boolean	equals(Object o)
Set<String>	get__explicitlySet__()
Map<String,Map<String,Object>>	getDefinedTags() Defined tags for this resource.
String	getDescription() The description of the tenancy.
Map<String,String>	getFreeformTags() Free-form tags for this resource.
String	getHomeRegionKey() The region key for the tenancy’s home region.
String	getId() The OCID of the tenancy.
String	getName() The name of the tenancy.
String	getUpiIdcsCompatibilityLayerEndpoint() Url which refers to the UPI IDCS compatibility layer endpoint configured for this Tenant’s home region.
int	hashCode()
Tenancy.Builder	toBuilder()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Tenancy

@Deprecated
 @ConstructorProperties(value={"id","name","description","homeRegionKey","upiIdcsCompatibilityLayerEndpoint","freeformTags","definedTags"})
public Tenancy(String id,
                                                                                                                                                                       String name,
                                                                                                                                                                       String description,
                                                                                                                                                                       String homeRegionKey,
                                                                                                                                                                       String upiIdcsCompatibilityLayerEndpoint,
                                                                                                                                                                       Map<String,String> freeformTags,
                                                                                                                                                                       Map<String,Map<String,Object>> definedTags)

Deprecated.

Method Detail

builder

public static Tenancy.Builder builder()

Create a new builder.

toBuilder

public Tenancy.Builder toBuilder()

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 Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

get__explicitlySet__

public Set<String> get__explicitlySet__()