@Generated(value="OracleSDKGenerator", comments="API Version: 20160918") public final class PrivateIp extends Object
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.
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.
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.
Warning:* Oracle recommends that you avoid using any confidential information when you supply string values using the API.
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 __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).
| Modifier and Type | Class and Description |
|---|---|
static class |
PrivateIp.Builder |
| 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 subnetId,
Date timeCreated,
String vnicId)
Deprecated.
|
| Modifier and Type | Method and Description |
|---|---|
static PrivateIp.Builder |
builder()
Create a new builder.
|
boolean |
equals(Object o) |
Set<String> |
get__explicitlySet__() |
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()
Free-form tags for this resource.
|
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 |
getVnicId()
The OCID of the VNIC the private IP is assigned to.
|
int |
hashCode() |
String |
toString() |
@ConstructorProperties(value={"availabilityDomain","compartmentId","definedTags","displayName","freeformTags","hostnameLabel","id","ipAddress","isPrimary","subnetId","timeCreated","vnicId"}) @Deprecated 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 subnetId, Date timeCreated, String vnicId)
public static PrivateIp.Builder builder()
Create a new builder.
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
public String getCompartmentId()
The OCID of the compartment containing the private IP.
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\"}}
public String getDisplayName()
A user-friendly name. Does not have to be unique, and it’s changeable. Avoid entering confidential information.
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\"}
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, bminstance-1 in FQDN bminstance-1.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.
Example: bminstance-1
public String getId()
The private IP’s Oracle ID (OCID).
public String getIpAddress()
The private IP address of the privateIp object. The address is within the CIDR of the VNIC’s subnet.
Example: 10.0.3.3
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
public String getSubnetId()
The OCID of the subnet the VNIC is in.
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
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.
Copyright © 2016–2020. All rights reserved.