com.oracle.bmc.core.model

Class PublicIp

java.lang.Object

com.oracle.bmc.core.model.PublicIp

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

A public IP is a conceptual term that refers to a public IP address and related properties. The publicIp object is the API representation of a public IP.

There are two types of public IPs: 1. Ephemeral 2. Reserved

For more information and comparison of the two types, see [Public IP Addresses](https://docs.cloud.oracle.com/iaas/Content/Network/Tasks/managingpublicIPs.htm).
Note: Objects should always be created or deserialized using the PublicIp.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 PublicIp.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	PublicIp.AssignedEntityType The type of entity the public IP is assigned to, or in the process of being assigned to.
static class	PublicIp.Builder
static class	PublicIp.LifecycleState The public IP’s current state.
static class	PublicIp.Lifetime Defines when the public IP is deleted and released back to Oracle’s public IP pool.
static class	PublicIp.Scope Whether the public IP is regional or specific to a particular availability domain.

Constructor Summary

Constructors

Constructor and Description

PublicIp(String assignedEntityId, PublicIp.AssignedEntityType assignedEntityType, String availabilityDomain, String compartmentId, Map<String,Map<String,Object>> definedTags, String displayName, Map<String,String> freeformTags, String id, String ipAddress, PublicIp.LifecycleState lifecycleState, PublicIp.Lifetime lifetime, String privateIpId, PublicIp.Scope scope, Date timeCreated, String publicIpPoolId) Deprecated.

Method Summary

Modifier and Type	Method and Description
static PublicIp.Builder	builder() Create a new builder.
boolean	equals(Object o)
Set<String>	get__explicitlySet__()
String	getAssignedEntityId() The OCID of the entity the public IP is assigned to, or in the process of being assigned to.
PublicIp.AssignedEntityType	getAssignedEntityType() The type of entity the public IP is assigned to, or in the process of being assigned to.
String	getAvailabilityDomain() The public IP’s availability domain.
String	getCompartmentId() The OCID of the compartment containing the public IP.
Map<String,Map<String,Object>>	getDefinedTags() Defined tags for this resource.
String	getDisplayName() A user-friendly name.
Map<String,String>	getFreeformTags() Free-form tags for this resource.
String	getId() The public IP’s Oracle ID (OCID).
String	getIpAddress() The public IP address of the publicIp object.
PublicIp.LifecycleState	getLifecycleState() The public IP’s current state.
PublicIp.Lifetime	getLifetime() Defines when the public IP is deleted and released back to Oracle’s public IP pool.
String	getPrivateIpId() Deprecated.
String	getPublicIpPoolId() The OCID of the pool object created in the current tenancy.
PublicIp.Scope	getScope() Whether the public IP is regional or specific to a particular availability domain.
Date	getTimeCreated() The date and time the public IP was created, in the format defined by RFC3339.
int	hashCode()
PublicIp.Builder	toBuilder()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

PublicIp

@ConstructorProperties(value={"assignedEntityId","assignedEntityType","availabilityDomain","compartmentId","definedTags","displayName","freeformTags","id","ipAddress","lifecycleState","lifetime","privateIpId","scope","timeCreated","publicIpPoolId"})
 @Deprecated
public PublicIp(String assignedEntityId,
                                                                                                                                                                                                                                                                                       PublicIp.AssignedEntityType assignedEntityType,
                                                                                                                                                                                                                                                                                       String availabilityDomain,
                                                                                                                                                                                                                                                                                       String compartmentId,
                                                                                                                                                                                                                                                                                       Map<String,Map<String,Object>> definedTags,
                                                                                                                                                                                                                                                                                       String displayName,
                                                                                                                                                                                                                                                                                       Map<String,String> freeformTags,
                                                                                                                                                                                                                                                                                       String id,
                                                                                                                                                                                                                                                                                       String ipAddress,
                                                                                                                                                                                                                                                                                       PublicIp.LifecycleState lifecycleState,
                                                                                                                                                                                                                                                                                       PublicIp.Lifetime lifetime,
                                                                                                                                                                                                                                                                                       String privateIpId,
                                                                                                                                                                                                                                                                                       PublicIp.Scope scope,
                                                                                                                                                                                                                                                                                       Date timeCreated,
                                                                                                                                                                                                                                                                                       String publicIpPoolId)

Deprecated.

Method Detail

builder

public static PublicIp.Builder builder()

Create a new builder.

toBuilder

public PublicIp.Builder toBuilder()

getAssignedEntityId

public String getAssignedEntityId()

The OCID of the entity the public IP is assigned to, or in the process of being assigned to.

getAssignedEntityType

public PublicIp.AssignedEntityType getAssignedEntityType()

The type of entity the public IP is assigned to, or in the process of being assigned to.

getAvailabilityDomain

public String getAvailabilityDomain()

The public IP’s availability domain. This property is set only for ephemeral public IPs that are assigned to a private IP (that is, when the scope of the public IP is set to AVAILABILITY_DOMAIN). The value is the availability domain of the assigned private IP.

Example: Uocm:PHX-AD-1

getCompartmentId

public String getCompartmentId()

The OCID of the compartment containing the public IP. For an ephemeral public IP, this is the compartment of its assigned entity (which can be a private IP or a regional entity such as a NAT gateway). For a reserved public IP that is currently assigned, its compartment can be different from the assigned private IP’s.

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"}}

getDisplayName

public String getDisplayName()

A user-friendly name. Does not have to be unique, and it’s changeable. Avoid entering confidential information.

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"}

getId

public String getId()

The public IP’s Oracle ID (OCID).

getIpAddress

public String getIpAddress()

The public IP address of the publicIp object.

Example: 203.0.113.2

getLifecycleState

public PublicIp.LifecycleState getLifecycleState()

The public IP’s current state.

getLifetime

public PublicIp.Lifetime getLifetime()

Defines when the public IP is deleted and released back to Oracle’s public IP pool.

EPHEMERAL: The lifetime is tied to the lifetime of its assigned entity. An ephemeral public IP must always be assigned to an entity. If the assigned entity is a private IP, the ephemeral public IP is automatically deleted when the private IP is deleted, when the VNIC is terminated, or when the instance is terminated. If the assigned entity is a NatGateway, the ephemeral public IP is automatically deleted when the NAT gateway is terminated.

RESERVED: You control the public IP's lifetime. You can delete a reserved public IP whenever you like. It does not need to be assigned to a private IP at all times.

For more information and comparison of the two types, see [Public IP Addresses](https://docs.cloud.oracle.com/iaas/Content/Network/Tasks/managingpublicIPs.htm).

getPrivateIpId

public String getPrivateIpId()

Deprecated. Use assignedEntityId instead.

The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the private IP that the public IP is currently assigned to, or in the process of being assigned to.

*Note:** This is null if the public IP is not assigned to a private IP, or is in the process of being assigned to one.

getScope

public PublicIp.Scope getScope()

Whether the public IP is regional or specific to a particular availability domain.

REGION: The public IP exists within a region and is assigned to a regional entity (such as a NatGateway), or can be assigned to a private IP in any availability domain in the region. Reserved public IPs and ephemeral public IPs assigned to a regional entity have scope = REGION.

AVAILABILITY_DOMAIN: The public IP exists within the availability domain of the entity it's assigned to, which is specified by the availabilityDomain property of the public IP object. Ephemeral public IPs that are assigned to private IPs have scope = AVAILABILITY_DOMAIN.

getTimeCreated

public Date getTimeCreated()

The date and time the public IP was created, in the format defined by RFC3339.

Example: 2016-08-25T21:10:29.600Z

getPublicIpPoolId

public String getPublicIpPoolId()

The OCID of the pool object created in the current tenancy.

get__explicitlySet__

public Set<String> get__explicitlySet__()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object