/**
 * Core Services API
 * Use the Core Services API to manage resources such as virtual cloud networks (VCNs),
compute instances, and block storage volumes. For more information, see the console
documentation for the [Networking](/iaas/Content/Network/Concepts/overview.htm),
[Compute](/iaas/Content/Compute/Concepts/computeoverview.htm), and
[Block Volume](/iaas/Content/Block/Concepts/overview.htm) services.

 * OpenAPI spec version: 20160918
 *
 *
 * NOTE: This class is auto generated by OracleSDKGenerator.
 * Do not edit the class manually.
 *
 * Copyright (c) 2020, 2022, Oracle and/or its affiliates.  All rights reserved.
 * This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license.
 */ import * as model from "../model" ; import common = require ( "oci-common" ) ; /**
* 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.
* <p>
**Note:** For information about IPv6 addresses, see  Ipv6 .
* <p>
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.
* <p>
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).
* <p>
**Note:** Only
*  {@link #listPrivateIps(ListPrivateIpsRequest) listPrivateIps} and
*  {@link #getPrivateIp(GetPrivateIpRequest) 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
*  {@link #launchInstance(LaunchInstanceRequest) launchInstance} or
*  {@link #attachVnic(AttachVnicRequest) attachVnic} . To update the hostname
* for a primary private IP, you use  {@link #updateVnic(UpdateVnicRequest) updateVnic} .
* <p>
`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 .
* <p>
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).
*
 export interface PrivateIp { /**
      * 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.
  * <p>
  Example: `Uocm:PHX-AD-1`
  *
      */ "availabilityDomain" ? : string ; /**
     * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the private IP.
     */ "compartmentId" ? : string ; /**
      * Defined tags for this resource. Each key is predefined and scoped to a
  * namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
  * <p>
  Example: `{\"Operations\": {\"CostCenter\": \"42\"}}`
  *
      */ "definedTags" ? : { [ key ] : { [ key ] : any ; } ; } ; /**
     * A user-friendly name. Does not have to be unique, and it's changeable.
     * Avoid entering confidential information.
     *
     */ "displayName" ? : string ; /**
      * 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](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
  * <p>
  Example: `{\"Department\": \"Finance\"}`
  *
      */ "freeformTags" ? : { [ key ] : string ; } ; /**
      * 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](https://tools.ietf.org/html/rfc952) and
  * [RFC 1123](https://tools.ietf.org/html/rfc1123).
  * <p>
  For more information, see
  * [DNS in Your Virtual Cloud Network](https://docs.cloud.oracle.com/iaas/Content/Network/Concepts/dns.htm).
  * <p>
  Example: `bminstance-1`
  *
      */ "hostnameLabel" ? : string ; /**
     * The private IP's Oracle ID ([OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm)).
     */ "id" ? : string ; /**
      * The private IP address of the `privateIp` object. The address is within the CIDR
  * of the VNIC's subnet.
  * <p>
  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 .
  * <p>
  Example: `10.0.3.3`
  *
       "ipAddress" ? : string ; /**
      * Whether this private IP is the primary one on the VNIC. Primary private IPs
  * are unassigned and deleted automatically when the VNIC is terminated.
  * <p>
  Example: `true`
  *
      */ "isPrimary" ? : boolean ; /**
     * 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](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VLAN. See
     *  Vlan .
     *
      "vlanId" ? : string ; /**
      * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the subnet the VNIC is in.
  * <p>
  However, if the `PrivateIp` object is being used with a VLAN as part of
  * the Oracle Cloud VMware Solution, the `subnetId` is null.
  *
      */ "subnetId" ? : string ; /**
      * The date and time the private IP was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339).
  * <p>
  Example: `2016-08-25T21:10:29.600Z`
  *
      */ "timeCreated" ? : Date ; /**
     * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) 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.
     *
     */ "vnicId" ? : string ; } export namespace PrivateIp { export function getJsonObj ( obj ) { const jsonObj = { ... obj , ... { } } ; return jsonObj ; } export function getDeserializedJsonObj ( obj ) { const jsonObj = { ... obj , ... { } } ; return jsonObj ; } }