com.oracle.bmc.identity.model.Region 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;
/**
* A localized geographic area, such as Phoenix, AZ. Oracle Cloud Infrastructure is hosted in
* regions and Availability Domains. A region is composed of several Availability Domains. An
* Availability Domain is one or more data centers located within a region. For more information,
* see [Regions and Availability
* Domains](https://docs.cloud.oracle.com/Content/General/Concepts/regions.htm).
*
* 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 = Region.Builder.class)
@com.fasterxml.jackson.annotation.JsonFilter(
com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel.EXPLICITLY_SET_FILTER_NAME)
public final class Region extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel {
@Deprecated
@java.beans.ConstructorProperties({"key", "name"})
public Region(String key, String name) {
super();
this.key = key;
this.name = name;
}
@com.fasterxml.jackson.databind.annotation.JsonPOJOBuilder(withPrefix = "")
public static class Builder {
/**
* The key of the region. See [Regions and Availability
* Domains](https://docs.cloud.oracle.com/Content/General/Concepts/regions.htm) for the full
* list of supported 3-letter region codes.
*
*
Example: {@code PHX}
*/
@com.fasterxml.jackson.annotation.JsonProperty("key")
private String key;
/**
* The key of the region. See [Regions and Availability
* Domains](https://docs.cloud.oracle.com/Content/General/Concepts/regions.htm) for the full
* list of supported 3-letter region codes.
*
*
Example: {@code PHX}
*
* @param key the value to set
* @return this builder
*/
public Builder key(String key) {
this.key = key;
this.__explicitlySet__.add("key");
return this;
}
/**
* The name of the region. See [Regions and Availability
* Domains](https://docs.cloud.oracle.com/Content/General/Concepts/regions.htm) for the full
* list of supported region names.
*
*
Example: {@code us-phoenix-1}
*/
@com.fasterxml.jackson.annotation.JsonProperty("name")
private String name;
/**
* The name of the region. See [Regions and Availability
* Domains](https://docs.cloud.oracle.com/Content/General/Concepts/regions.htm) for the full
* list of supported region names.
*
*
Example: {@code us-phoenix-1}
*
* @param name the value to set
* @return this builder
*/
public Builder name(String name) {
this.name = name;
this.__explicitlySet__.add("name");
return this;
}
@com.fasterxml.jackson.annotation.JsonIgnore
private final java.util.Set __explicitlySet__ = new java.util.HashSet();
public Region build() {
Region model = new Region(this.key, this.name);
for (String explicitlySetProperty : this.__explicitlySet__) {
model.markPropertyAsExplicitlySet(explicitlySetProperty);
}
return model;
}
@com.fasterxml.jackson.annotation.JsonIgnore
public Builder copy(Region model) {
if (model.wasPropertyExplicitlySet("key")) {
this.key(model.getKey());
}
if (model.wasPropertyExplicitlySet("name")) {
this.name(model.getName());
}
return this;
}
}
/** Create a new builder. */
public static Builder builder() {
return new Builder();
}
public Builder toBuilder() {
return new Builder().copy(this);
}
/**
* The key of the region. See [Regions and Availability
* Domains](https://docs.cloud.oracle.com/Content/General/Concepts/regions.htm) for the full
* list of supported 3-letter region codes.
*
* Example: {@code PHX}
*/
@com.fasterxml.jackson.annotation.JsonProperty("key")
private final String key;
/**
* The key of the region. See [Regions and Availability
* Domains](https://docs.cloud.oracle.com/Content/General/Concepts/regions.htm) for the full
* list of supported 3-letter region codes.
*
*
Example: {@code PHX}
*
* @return the value
*/
public String getKey() {
return key;
}
/**
* The name of the region. See [Regions and Availability
* Domains](https://docs.cloud.oracle.com/Content/General/Concepts/regions.htm) for the full
* list of supported region names.
*
*
Example: {@code us-phoenix-1}
*/
@com.fasterxml.jackson.annotation.JsonProperty("name")
private final String name;
/**
* The name of the region. See [Regions and Availability
* Domains](https://docs.cloud.oracle.com/Content/General/Concepts/regions.htm) for the full
* list of supported region names.
*
*
Example: {@code us-phoenix-1}
*
* @return the value
*/
public String getName() {
return name;
}
@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("Region(");
sb.append("super=").append(super.toString());
sb.append("key=").append(String.valueOf(this.key));
sb.append(", name=").append(String.valueOf(this.name));
sb.append(")");
return sb.toString();
}
@Override
public boolean equals(Object o) {
if (this == o) {
return true;
}
if (!(o instanceof Region)) {
return false;
}
Region other = (Region) o;
return java.util.Objects.equals(this.key, other.key)
&& java.util.Objects.equals(this.name, other.name)
&& super.equals(other);
}
@Override
public int hashCode() {
final int PRIME = 59;
int result = 1;
result = (result * PRIME) + (this.key == null ? 43 : this.key.hashCode());
result = (result * PRIME) + (this.name == null ? 43 : this.name.hashCode());
result = (result * PRIME) + super.hashCode();
return result;
}
}