Package com.oracle.bmc.vnmonitoring.model

Class Ipv6

  • @Generated(value="OracleSDKGenerator",
           comments="API Version: 20160918")
public final class Ipv6
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
    An IPv6 is a conceptual term that refers to an IPv6 address and related properties.

    The IPv6 object is the API representation of an IPv6.

    You can create and assign an IPv6 to any VNIC that is in an IPv6-enabled subnet in an IPv6-enabled VCN.

    *Note:** IPv6 addressing is supported for all commercial and government regions. For important details about IPv6 addressing in a VCN, see [IPv6 Addresses](https://docs.oracle.com/iaas/Content/Network/Concepts/ipv6.htm).
    Note: Objects should always be created or deserialized using the Ipv6.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 Ipv6.Builder, which maintain a set of all explicitly set fields called Ipv6.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).

    • Method Detail

      • builder

        public static Ipv6.Builder builder()
        Create a new builder.

      • getCompartmentId

        public String getCompartmentId()
        The OCID of the compartment containing the IPv6.

        This is the same as the VNIC’s compartment.

        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

      • getId

        public String getId()
        The OCID of the IPv6.
        Returns:
        the value

      • getIpAddress

        public String getIpAddress()
        The IPv6 address of the IPv6 object.

        The address is within the IPv6 prefix of the VNIC’s subnet (see the ipv6CidrBlock attribute for the Subnet object.

        Example: 2001:0db8:0123:1111:abcd:ef01:2345:6789

        Returns:
        the value

      • getIsInternetAccessAllowed

        public Boolean getIsInternetAccessAllowed()
        Whether the IPv6 can be used for internet communication.

        Allowed by default for an IPv6 in a public subnet. Never allowed for an IPv6 in a private subnet. If the value is true, the IPv6 uses its public IP address for internet communication.

        Example: true

        Returns:
        the value

      • getLifecycleState

        public Ipv6.LifecycleState getLifecycleState()
        The IPv6’s current state.
        Returns:
        the value

      • getPublicIpAddress

        public String getPublicIpAddress()
        The IPv6 address to be used for internet communication.

        The address is within the IPv6 prefix of the VNIC’s subnet (see the ipv6PublicCidrBlock attribute for the Subnet object).

        If your organization did NOT assign a custom IPv6 prefix to the VCN for the private address space, Oracle provides the IPv6 prefix and uses that same prefix for the private and public address space. Therefore the publicIpAddress would be the same as the ipAddress.

        If your organization assigned a custom IPv6 prefix to the VCN for the address space, the right 80 bits of the IPv6 IP (the subnet and address bits) are the same as for the ipAddress. But the left 48 bits are from the IPv6 prefix that Oracle assigned to the VCN.

        This is null if the IPv6 is created with isInternetAccessAllowed set to false.

        Example: 2001:0db8:0123:1111:abcd:ef01:2345:6789

        Returns:
        the value

      • getSubnetId

        public String getSubnetId()
        The OCID of the subnet the VNIC is in.
        Returns:
        the value

      • getTimeCreated

        public Date getTimeCreated()
        The date and time the IPv6 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 IPv6 is assigned to.

        The VNIC and IPv6 must be in the same subnet.

        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