com.oracle.bmc.identity.model

Class RegionSubscription

java.lang.Object

com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

com.oracle.bmc.identity.model.RegionSubscription

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20160918")
public final class RegionSubscription
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

An object that represents your tenancy’s access to a particular region (i.e., a subscription), the status of that access, and whether that region is the home region. For more information, see Managing Regions.

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 RegionSubscription.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 RegionSubscription.Builder, which maintain a set of all explicitly set fields called RegionSubscription.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).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RegionSubscription.Builder
static class	RegionSubscription.Status The region subscription status.

Field Summary

Fields inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME

Constructor Summary

Constructors

Constructor and Description
RegionSubscription(String regionKey, String regionName, RegionSubscription.Status status, Boolean isHomeRegion) Deprecated.

Method Summary

Modifier and Type	Method and Description
static RegionSubscription.Builder	builder() Create a new builder.
boolean	equals(Object o)
Boolean	getIsHomeRegion() Indicates if the region is the home region or not.
String	getRegionKey() The region’s key.
String	getRegionName() The region’s name.
RegionSubscription.Status	getStatus() The region subscription status.
int	hashCode()
RegionSubscription.Builder	toBuilder()
String	toString()
String	toString(boolean includeByteArrayContents) Return a string representation of the object.

Methods inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

markPropertyAsExplicitlySet, wasPropertyExplicitlySet

Methods inherited from class java.lang.Object

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

Constructor Detail

RegionSubscription

@Deprecated
 @ConstructorProperties(value={"regionKey","regionName","status","isHomeRegion"})
public RegionSubscription(String regionKey,
                                                                                                                        String regionName,
                                                                                                                        RegionSubscription.Status status,
                                                                                                                        Boolean isHomeRegion)

Deprecated.

Method Detail

builder

public static RegionSubscription.Builder builder()

Create a new builder.

toBuilder

public RegionSubscription.Builder toBuilder()

getRegionKey

public String getRegionKey()

The region’s key. See Regions and Availability Domains for the full list of supported 3-letter region codes.

Example: PHX

Returns:

the value

getRegionName

public String getRegionName()

The region’s name. See Regions and Availability Domains for the full list of supported region names.

Example: us-phoenix-1

Returns:

the value

getStatus

public RegionSubscription.Status getStatus()

The region subscription status.

Returns:

the value

getIsHomeRegion

public Boolean getIsHomeRegion()

Indicates if the region is the home region or not.

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