PrivateIp (Oracle Cloud Infrastructure Java SDK

java.lang.Object
- com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
- - com.oracle.bmc.vnmonitoring.model.PrivateIp

```
@Generated(value="OracleSDKGenerator",
           comments="API Version: 20160918")
public final class PrivateIp
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
```
A private IP is a conceptual term that refers to an IPv4 private IP address and related properties. The privateIp object is the API representation of a private IP.

*Note:** For information about IPv6 addresses, see Ipv6.
Each instance has a *primary private IP* that is automatically created and assigned to the primary VNIC during instance launch. If you add a secondary VNIC to the instance, it also automatically gets a primary private IP. You can't remove a primary private IP from its VNIC. The primary private IP is automatically deleted when the VNIC is terminated.
You can add *secondary private IPs* to a VNIC after it's created. For more information, see the privateIp operations and also [IP Addresses](https://docs.cloud.oracle.com/iaas/Content/Network/Tasks/managingIPaddresses.htm).
*Note:** Only listPrivateIps and getPrivateIp work with *primary* private IPs. To create and update primary private IPs, you instead work with instance and VNIC operations. For example, a primary private IP's properties come from the values you specify in CreateVnicDetails when calling either launchInstance or attachVnic. To update the hostname for a primary private IP, you use updateVnic.
PrivateIp objects that are created for use with the Oracle Cloud VMware Solution are assigned to a VLAN and not a VNIC in a subnet. See the descriptions of the relevant attributes in the PrivateIp object. Also see Vlan.
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 [Getting Started with Policies](https://docs.cloud.oracle.com/iaas/Content/Identity/Concepts/policygetstarted.htm).
Note: Objects should always be created or deserialized using the PrivateIp.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 PrivateIp.Builder, which maintain a set of all explicitly set fields called PrivateIp.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 PrivateIp.Builder

Nested Classes
Modifier and Type	Class and Description
`static class`	`PrivateIp.Builder`

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
`PrivateIp(String availabilityDomain, String compartmentId, Map<String,Map<String,Object>> definedTags, String displayName, Map<String,String> freeformTags, String hostnameLabel, String id, String ipAddress, Boolean isPrimary, String vlanId, String subnetId, Date timeCreated, String vnicId)` Deprecated.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static PrivateIp.Builder`	`builder()` Create a new builder.
`boolean`	`equals(Object o)`
`String`	`getAvailabilityDomain()` The private IP’s availability domain.
`String`	`getCompartmentId()` The OCID of the compartment containing the private IP.
`Map<String,Map<String,Object>>`	`getDefinedTags()` Defined tags for this resource.
`String`	`getDisplayName()` A user-friendly name.
`Map<String,String>`	`getFreeformTags()` Simple key-value pair that is applied without any predefined name, type or scope.
`String`	`getHostnameLabel()` The hostname for the private IP.
`String`	`getId()` The private IP’s Oracle ID (OCID).
`String`	`getIpAddress()` The private IP address of the `privateIp` object.
`Boolean`	`getIsPrimary()` Whether this private IP is the primary one on the VNIC.
`String`	`getSubnetId()` The OCID of the subnet the VNIC is in.
`Date`	`getTimeCreated()` The date and time the private IP was created, in the format defined by RFC3339.
`String`	`getVlanId()` Applicable only if the `PrivateIp` object is being used with a VLAN as part of the Oracle Cloud VMware Solution.
`String`	`getVnicId()` The OCID of the VNIC the private IP is assigned to.
`int`	`hashCode()`
`PrivateIp.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

PrivateIp

@Deprecated
 @ConstructorProperties(value={"availabilityDomain","compartmentId","definedTags","displayName","freeformTags","hostnameLabel","id","ipAddress","isPrimary","vlanId","subnetId","timeCreated","vnicId"})
public PrivateIp(String availabilityDomain,
                                                                                                                                                                                                                                      String compartmentId,
                                                                                                                                                                                                                                      Map<String,Map<String,Object>> definedTags,
                                                                                                                                                                                                                                      String displayName,
                                                                                                                                                                                                                                      Map<String,String> freeformTags,
                                                                                                                                                                                                                                      String hostnameLabel,
                                                                                                                                                                                                                                      String id,
                                                                                                                                                                                                                                      String ipAddress,
                                                                                                                                                                                                                                      Boolean isPrimary,
                                                                                                                                                                                                                                      String vlanId,
                                                                                                                                                                                                                                      String subnetId,
                                                                                                                                                                                                                                      Date timeCreated,
                                                                                                                                                                                                                                      String vnicId)

Deprecated.

Method Detail
- builder
```
public static PrivateIp.Builder builder()
```
  Create a new builder.
- toBuilder
```
public PrivateIp.Builder toBuilder()
```
- getAvailabilityDomain
```
public String getAvailabilityDomain()
```
  The private IP’s availability domain. This attribute will be null if this is a secondary private IP assigned to a VNIC that is in a regional subnet.
  
  Example: Uocm:PHX-AD-1
  
  Returns:
  
  the value
- getCompartmentId
```
public String getCompartmentId()
```
  The OCID of the compartment containing the private IP.
  
  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. Example: {"foo-namespace": {"bar-key": "value"}}
  
  Returns:
  
  the value
- getDisplayName
```
public String getDisplayName()
```
  A user-friendly name. Does not have to be unique, and it’s changeable. Avoid entering confidential information.
  
  Returns:
  
  the value
- getFreeformTags
```
public Map<String,String> getFreeformTags()
```
  Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
  
  Returns:
  
  the value
- getHostnameLabel
```
public String getHostnameLabel()
```
  The hostname for the private IP. Used for DNS. The value is the hostname portion of the private IP’s fully qualified domain name (FQDN) (for example, bminstance1 in FQDN bminstance1.subnet123.vcn1.oraclevcn.com). Must be unique across all VNICs in the subnet and comply with RFC 952 and RFC 1123.
  
  For more information, see [DNS in Your Virtual Cloud Network](https://docs.cloud.oracle.com/iaas/Content/Network/Concepts/dns.htm).
  Example: bminstance1
  
  Returns:
  
  the value
- getId
```
public String getId()
```
  The private IP’s Oracle ID (OCID).
  
  Returns:
  
  the value
- getIpAddress
```
public String getIpAddress()
```
  The private IP address of the privateIp object. The address is within the CIDR of the VNIC’s subnet.
  
  However, if the PrivateIp object is being used with a VLAN as part of the Oracle Cloud VMware Solution, the address is from the range specified by the cidrBlock attribute for the VLAN. See Vlan.
  Example: 10.0.3.3
  
  Returns:
  
  the value
- getIsPrimary
```
public Boolean getIsPrimary()
```
  Whether this private IP is the primary one on the VNIC. Primary private IPs are unassigned and deleted automatically when the VNIC is terminated.
  
  Example: true
  
  Returns:
  
  the value
- getVlanId
```
public String getVlanId()
```
  Applicable only if the PrivateIp object is being used with a VLAN as part of the Oracle Cloud VMware Solution. The vlanId is the OCID of the VLAN. See Vlan.
  
  Returns:
  
  the value
- getSubnetId
```
public String getSubnetId()
```
  The OCID of the subnet the VNIC is in.
  
  However, if the PrivateIp object is being used with a VLAN as part of the Oracle Cloud VMware Solution, the subnetId is null.
  
  Returns:
  
  the value
- getTimeCreated
```
public Date getTimeCreated()
```
  The date and time the private IP was created, in the format defined by RFC3339.
  
  Example: 2016-08-25T21:10:29.600Z
  
  Returns:
  
  the value
- getVnicId
```
public String getVnicId()
```
  The OCID of the VNIC the private IP is assigned to. The VNIC and private IP must be in the same subnet. However, if the PrivateIp object is being used with a VLAN as part of the Oracle Cloud VMware Solution, the vnicId is null.
  
  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

Class PrivateIp

Nested Class Summary

Field Summary

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

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Constructor Detail

PrivateIp

Method Detail

builder

toBuilder

getAvailabilityDomain

getCompartmentId

getDefinedTags

getDisplayName

getFreeformTags

getHostnameLabel

getId

getIpAddress

getIsPrimary

getVlanId

getSubnetId

getTimeCreated

getVnicId

toString

toString

equals

hashCode