Class PrivateIp.Builder

  • Enclosing class:
    PrivateIp

    public static class PrivateIp.Builder
    extends Object
    • Constructor Detail

      • Builder

        public Builder()
    • Method Detail

      • availabilityDomain

        public PrivateIp.Builder availabilityDomain​(String availabilityDomain)
        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

        Parameters:
        availabilityDomain - the value to set
        Returns:
        this builder
      • compartmentId

        public PrivateIp.Builder compartmentId​(String compartmentId)
        The OCID of the compartment containing the private IP.
        Parameters:
        compartmentId - the value to set
        Returns:
        this builder
      • definedTags

        public PrivateIp.Builder definedTags​(Map<String,​Map<String,​Object>> definedTags)
        Defined tags for this resource.

        Each key is predefined and scoped to a namespace. Example: {“foo-namespace”: {“bar-key”: “value”}}

        Parameters:
        definedTags - the value to set
        Returns:
        this builder
      • displayName

        public PrivateIp.Builder displayName​(String displayName)
        A user-friendly name.

        Does not have to be unique, and it’s changeable. Avoid entering confidential information.

        Parameters:
        displayName - the value to set
        Returns:
        this builder
      • freeformTags

        public PrivateIp.Builder freeformTags​(Map<String,​String> freeformTags)
        Simple key-value pair that is applied without any predefined name, type or scope.

        Exists for cross-compatibility only. Example: {“bar-key”: “value”}

        Parameters:
        freeformTags - the value to set
        Returns:
        this builder
      • hostnameLabel

        public PrivateIp.Builder hostnameLabel​(String hostnameLabel)
        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.oracle.com/iaas/Content/Network/Concepts/dns.htm).

        Example: bminstance1

        Parameters:
        hostnameLabel - the value to set
        Returns:
        this builder
      • id

        public PrivateIp.Builder id​(String id)
        The private IP’s Oracle ID (OCID).
        Parameters:
        id - the value to set
        Returns:
        this builder
      • ipAddress

        public PrivateIp.Builder ipAddress​(String ipAddress)
        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

        Parameters:
        ipAddress - the value to set
        Returns:
        this builder
      • isPrimary

        public PrivateIp.Builder isPrimary​(Boolean isPrimary)
        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

        Parameters:
        isPrimary - the value to set
        Returns:
        this builder
      • vlanId

        public PrivateIp.Builder vlanId​(String vlanId)
        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.

        Parameters:
        vlanId - the value to set
        Returns:
        this builder
      • subnetId

        public PrivateIp.Builder subnetId​(String subnetId)
        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.

        Parameters:
        subnetId - the value to set
        Returns:
        this builder
      • timeCreated

        public PrivateIp.Builder timeCreated​(Date timeCreated)
        The date and time the private IP was created, in the format defined by RFC3339.

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

        Parameters:
        timeCreated - the value to set
        Returns:
        this builder
      • vnicId

        public PrivateIp.Builder vnicId​(String vnicId)
        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.

        Parameters:
        vnicId - the value to set
        Returns:
        this builder