com.oracle.bmc.identity.model.Tenancy Maven / Gradle / Ivy
Show all versions of oci-java-sdk-shaded-full Show documentation
/**
* Copyright (c) 2016, 2024, Oracle and/or its affiliates. All rights reserved.
* This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license.
*/
package com.oracle.bmc.identity.model;
/**
* 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 {@link Builder}. This model
* distinguishes fields that are {@code null} because they are unset from fields that are explicitly
* set to {@code null}. This is done in the setter methods of the {@link Builder}, which maintain a
* set of all explicitly set fields called {@link Builder#__explicitlySet__}. The {@link
* #hashCode()} and {@link #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 {@code null} from unset {@code
* null}).
*/
@jakarta.annotation.Generated(value = "OracleSDKGenerator", comments = "API Version: 20160918")
@com.fasterxml.jackson.databind.annotation.JsonDeserialize(builder = Tenancy.Builder.class)
@com.fasterxml.jackson.annotation.JsonFilter(
com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel.EXPLICITLY_SET_FILTER_NAME)
public final class Tenancy extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel {
@Deprecated
@java.beans.ConstructorProperties({
"id",
"name",
"description",
"homeRegionKey",
"upiIdcsCompatibilityLayerEndpoint",
"freeformTags",
"definedTags"
})
public Tenancy(
String id,
String name,
String description,
String homeRegionKey,
String upiIdcsCompatibilityLayerEndpoint,
java.util.Map freeformTags,
java.util.Map> definedTags) {
super();
this.id = id;
this.name = name;
this.description = description;
this.homeRegionKey = homeRegionKey;
this.upiIdcsCompatibilityLayerEndpoint = upiIdcsCompatibilityLayerEndpoint;
this.freeformTags = freeformTags;
this.definedTags = definedTags;
}
@com.fasterxml.jackson.databind.annotation.JsonPOJOBuilder(withPrefix = "")
public static class Builder {
/** The OCID of the tenancy. */
@com.fasterxml.jackson.annotation.JsonProperty("id")
private String id;
/**
* The OCID of the tenancy.
*
* @param id the value to set
* @return this builder
*/
public Builder id(String id) {
this.id = id;
this.__explicitlySet__.add("id");
return this;
}
/** The name of the tenancy. */
@com.fasterxml.jackson.annotation.JsonProperty("name")
private String name;
/**
* The name of the tenancy.
*
* @param name the value to set
* @return this builder
*/
public Builder name(String name) {
this.name = name;
this.__explicitlySet__.add("name");
return this;
}
/** The description of the tenancy. */
@com.fasterxml.jackson.annotation.JsonProperty("description")
private String description;
/**
* The description of the tenancy.
*
* @param description the value to set
* @return this builder
*/
public Builder description(String description) {
this.description = description;
this.__explicitlySet__.add("description");
return this;
}
/**
* The region key for the tenancy's home region. For the full list of supported regions, see
* [Regions and Availability
* Domains](https://docs.cloud.oracle.com/Content/General/Concepts/regions.htm).
*
* Example: {@code PHX}
*/
@com.fasterxml.jackson.annotation.JsonProperty("homeRegionKey")
private String homeRegionKey;
/**
* The region key for the tenancy's home region. For the full list of supported regions, see
* [Regions and Availability
* Domains](https://docs.cloud.oracle.com/Content/General/Concepts/regions.htm).
*
*
Example: {@code PHX}
*
* @param homeRegionKey the value to set
* @return this builder
*/
public Builder homeRegionKey(String homeRegionKey) {
this.homeRegionKey = homeRegionKey;
this.__explicitlySet__.add("homeRegionKey");
return this;
}
/**
* Url which refers to the UPI IDCS compatibility layer endpoint configured for this
* Tenant's home region.
*/
@com.fasterxml.jackson.annotation.JsonProperty("upiIdcsCompatibilityLayerEndpoint")
private String upiIdcsCompatibilityLayerEndpoint;
/**
* Url which refers to the UPI IDCS compatibility layer endpoint configured for this
* Tenant's home region.
*
* @param upiIdcsCompatibilityLayerEndpoint the value to set
* @return this builder
*/
public Builder upiIdcsCompatibilityLayerEndpoint(String upiIdcsCompatibilityLayerEndpoint) {
this.upiIdcsCompatibilityLayerEndpoint = upiIdcsCompatibilityLayerEndpoint;
this.__explicitlySet__.add("upiIdcsCompatibilityLayerEndpoint");
return this;
}
/**
* 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](https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm). Example:
* {@code {"Department": "Finance"}}
*/
@com.fasterxml.jackson.annotation.JsonProperty("freeformTags")
private java.util.Map freeformTags;
/**
* 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](https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm). Example:
* {@code {"Department": "Finance"}}
*
* @param freeformTags the value to set
* @return this builder
*/
public Builder freeformTags(java.util.Map freeformTags) {
this.freeformTags = freeformTags;
this.__explicitlySet__.add("freeformTags");
return this;
}
/**
* Defined tags for this resource. Each key is predefined and scoped to a namespace. For
* more information, see [Resource
* Tags](https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm). Example:
* {@code {"Operations": {"CostCenter": "42"}}}
*/
@com.fasterxml.jackson.annotation.JsonProperty("definedTags")
private java.util.Map> definedTags;
/**
* Defined tags for this resource. Each key is predefined and scoped to a namespace. For
* more information, see [Resource
* Tags](https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm). Example:
* {@code {"Operations": {"CostCenter": "42"}}}
*
* @param definedTags the value to set
* @return this builder
*/
public Builder definedTags(
java.util.Map> definedTags) {
this.definedTags = definedTags;
this.__explicitlySet__.add("definedTags");
return this;
}
@com.fasterxml.jackson.annotation.JsonIgnore
private final java.util.Set __explicitlySet__ = new java.util.HashSet();
public Tenancy build() {
Tenancy model =
new Tenancy(
this.id,
this.name,
this.description,
this.homeRegionKey,
this.upiIdcsCompatibilityLayerEndpoint,
this.freeformTags,
this.definedTags);
for (String explicitlySetProperty : this.__explicitlySet__) {
model.markPropertyAsExplicitlySet(explicitlySetProperty);
}
return model;
}
@com.fasterxml.jackson.annotation.JsonIgnore
public Builder copy(Tenancy model) {
if (model.wasPropertyExplicitlySet("id")) {
this.id(model.getId());
}
if (model.wasPropertyExplicitlySet("name")) {
this.name(model.getName());
}
if (model.wasPropertyExplicitlySet("description")) {
this.description(model.getDescription());
}
if (model.wasPropertyExplicitlySet("homeRegionKey")) {
this.homeRegionKey(model.getHomeRegionKey());
}
if (model.wasPropertyExplicitlySet("upiIdcsCompatibilityLayerEndpoint")) {
this.upiIdcsCompatibilityLayerEndpoint(
model.getUpiIdcsCompatibilityLayerEndpoint());
}
if (model.wasPropertyExplicitlySet("freeformTags")) {
this.freeformTags(model.getFreeformTags());
}
if (model.wasPropertyExplicitlySet("definedTags")) {
this.definedTags(model.getDefinedTags());
}
return this;
}
}
/** Create a new builder. */
public static Builder builder() {
return new Builder();
}
public Builder toBuilder() {
return new Builder().copy(this);
}
/** The OCID of the tenancy. */
@com.fasterxml.jackson.annotation.JsonProperty("id")
private final String id;
/**
* The OCID of the tenancy.
*
* @return the value
*/
public String getId() {
return id;
}
/** The name of the tenancy. */
@com.fasterxml.jackson.annotation.JsonProperty("name")
private final String name;
/**
* The name of the tenancy.
*
* @return the value
*/
public String getName() {
return name;
}
/** The description of the tenancy. */
@com.fasterxml.jackson.annotation.JsonProperty("description")
private final String description;
/**
* The description of the tenancy.
*
* @return the value
*/
public String getDescription() {
return description;
}
/**
* The region key for the tenancy's home region. For the full list of supported regions, see
* [Regions and Availability
* Domains](https://docs.cloud.oracle.com/Content/General/Concepts/regions.htm).
*
* Example: {@code PHX}
*/
@com.fasterxml.jackson.annotation.JsonProperty("homeRegionKey")
private final String homeRegionKey;
/**
* The region key for the tenancy's home region. For the full list of supported regions, see
* [Regions and Availability
* Domains](https://docs.cloud.oracle.com/Content/General/Concepts/regions.htm).
*
*
Example: {@code PHX}
*
* @return the value
*/
public String getHomeRegionKey() {
return homeRegionKey;
}
/**
* Url which refers to the UPI IDCS compatibility layer endpoint configured for this Tenant's
* home region.
*/
@com.fasterxml.jackson.annotation.JsonProperty("upiIdcsCompatibilityLayerEndpoint")
private final String upiIdcsCompatibilityLayerEndpoint;
/**
* Url which refers to the UPI IDCS compatibility layer endpoint configured for this Tenant's
* home region.
*
* @return the value
*/
public String getUpiIdcsCompatibilityLayerEndpoint() {
return upiIdcsCompatibilityLayerEndpoint;
}
/**
* 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](https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm). Example:
* {@code {"Department": "Finance"}}
*/
@com.fasterxml.jackson.annotation.JsonProperty("freeformTags")
private final java.util.Map freeformTags;
/**
* 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](https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm). Example:
* {@code {"Department": "Finance"}}
*
* @return the value
*/
public java.util.Map getFreeformTags() {
return freeformTags;
}
/**
* Defined tags for this resource. Each key is predefined and scoped to a namespace. For more
* information, see [Resource
* Tags](https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm). Example:
* {@code {"Operations": {"CostCenter": "42"}}}
*/
@com.fasterxml.jackson.annotation.JsonProperty("definedTags")
private final java.util.Map> definedTags;
/**
* Defined tags for this resource. Each key is predefined and scoped to a namespace. For more
* information, see [Resource
* Tags](https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm). Example:
* {@code {"Operations": {"CostCenter": "42"}}}
*
* @return the value
*/
public java.util.Map> getDefinedTags() {
return definedTags;
}
@Override
public String toString() {
return this.toString(true);
}
/**
* Return a string representation of the object.
*
* @param includeByteArrayContents true to include the full contents of byte arrays
* @return string representation
*/
public String toString(boolean includeByteArrayContents) {
java.lang.StringBuilder sb = new java.lang.StringBuilder();
sb.append("Tenancy(");
sb.append("super=").append(super.toString());
sb.append("id=").append(String.valueOf(this.id));
sb.append(", name=").append(String.valueOf(this.name));
sb.append(", description=").append(String.valueOf(this.description));
sb.append(", homeRegionKey=").append(String.valueOf(this.homeRegionKey));
sb.append(", upiIdcsCompatibilityLayerEndpoint=")
.append(String.valueOf(this.upiIdcsCompatibilityLayerEndpoint));
sb.append(", freeformTags=").append(String.valueOf(this.freeformTags));
sb.append(", definedTags=").append(String.valueOf(this.definedTags));
sb.append(")");
return sb.toString();
}
@Override
public boolean equals(Object o) {
if (this == o) {
return true;
}
if (!(o instanceof Tenancy)) {
return false;
}
Tenancy other = (Tenancy) o;
return java.util.Objects.equals(this.id, other.id)
&& java.util.Objects.equals(this.name, other.name)
&& java.util.Objects.equals(this.description, other.description)
&& java.util.Objects.equals(this.homeRegionKey, other.homeRegionKey)
&& java.util.Objects.equals(
this.upiIdcsCompatibilityLayerEndpoint,
other.upiIdcsCompatibilityLayerEndpoint)
&& java.util.Objects.equals(this.freeformTags, other.freeformTags)
&& java.util.Objects.equals(this.definedTags, other.definedTags)
&& super.equals(other);
}
@Override
public int hashCode() {
final int PRIME = 59;
int result = 1;
result = (result * PRIME) + (this.id == null ? 43 : this.id.hashCode());
result = (result * PRIME) + (this.name == null ? 43 : this.name.hashCode());
result = (result * PRIME) + (this.description == null ? 43 : this.description.hashCode());
result =
(result * PRIME)
+ (this.homeRegionKey == null ? 43 : this.homeRegionKey.hashCode());
result =
(result * PRIME)
+ (this.upiIdcsCompatibilityLayerEndpoint == null
? 43
: this.upiIdcsCompatibilityLayerEndpoint.hashCode());
result = (result * PRIME) + (this.freeformTags == null ? 43 : this.freeformTags.hashCode());
result = (result * PRIME) + (this.definedTags == null ? 43 : this.definedTags.hashCode());
result = (result * PRIME) + super.hashCode();
return result;
}
}