/** * Object Storage Service API * Use Object Storage and Archive Storage APIs to manage buckets, objects, and related resources. For more information, see [Overview of Object Storage](https://docs.oracle.com/iaas/Content/Object/Concepts/objectstorageoverview.htm) and [Overview of Archive Storage](https://docs.oracle.com/iaas/Content/Archive/Concepts/archivestorageoverview.htm). * OpenAPI spec version: 20160918 * Contact: opc_casper_users_us_grp@oracle.com * * NOTE: This class is auto generated by OracleSDKGenerator. * Do not edit the class manually. * * Copyright (c) 2020, 2026, 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"; /** * A private endpoint makes your service accessible through a private IP in the customer's private network. A private endpoint has a name and is associated with a namespace and a single compartment. * */ export interface PrivateEndpoint { /** * This name associated with the endpoint. Valid characters are uppercase or lowercase letters, numbers, hyphens, * underscores, and periods. * Example: my-new-private-endpoint1 * */ "name": string; /** * The Object Storage namespace associated with the private enpoint. */ "namespace": string; /** * The compartment which is associated with the Private Endpoint. */ "compartmentId": string; /** * The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the user who created the Private Endpoint. */ "createdBy": string; /** * The date and time the Private Endpoint was created, as described in [RFC 2616](https://tools.ietf.org/html/rfc2616#section-14.29). */ "timeCreated": Date; /** * The date and time the Private Endpoint was updated, as described in [RFC 2616](https://tools.ietf.org/html/rfc2616#section-14.29). */ "timeModified": Date; /** * The OCID of the customer's subnet where the private endpoint VNIC will reside. * */ "subnetId": string; /** * The private IP address to assign to this private endpoint. If you provide a value, * it must be an available IP address in the customer's subnet. If it's not available, an error * is returned. *

If you do not provide a value, an available IP address in the subnet is automatically chosen. * */ "privateEndpointIp": string; /** * A prefix to use for the private endpoint. The customer VCN's DNS records are * updated with this prefix. The prefix input from the customer will be the first sub-domain in the endpointFqdn. * Example: If the prefix chosen is \"abc\", then the endpointFqdn will be 'abc.private.objectstorage..oraclecloud.com' * */ "prefix": string; /** * A list of additional prefix that you can provide along with any other prefix. These resulting endpointFqdn's are added to the * customer VCN's DNS record. * */ "additionalPrefixes"?: Array; /** * A list of the OCIDs of the network security groups (NSGs) to add the private endpoint's VNIC to. * For more information about NSGs, see * {@link NetworkSecurityGroup}. * */ "nsgIds"?: Array; "fqdns": model.Fqdns; /** * The entity tag (ETag) for the Private Endpoint. */ "etag": string; /** * The Private Endpoint's lifecycle state. */ "lifecycleState"?: PrivateEndpoint.LifecycleState; /** * A list of targets that can be accessed by the private endpoint. At least one or more access targets is required for a private endpoint. * */ "accessTargets": Array; /** * 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.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). * Example: {@code {\"Department\": \"Finance\"}} * */ "freeformTags"?: { [key: string]: string; }; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. * For more information, see [Resource Tags](https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). * Example: {@code {\"Operations\": {\"CostCenter\": \"42\"}}} * */ "definedTags"?: { [key: string]: { [key: string]: any; }; }; /** * The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the PrivateEndpoint. * */ "id"?: string; } export declare namespace PrivateEndpoint { enum LifecycleState { Creating = "CREATING", Active = "ACTIVE", Inactive = "INACTIVE", Updating = "UPDATING", Deleting = "DELETING", Deleted = "DELETED", Failed = "FAILED", /** * This value is used if a service returns a value for this enum that is not recognized by this * version of the SDK. */ UnknownValue = "UNKNOWN_VALUE" } function getJsonObj(obj: PrivateEndpoint): object; function getDeserializedJsonObj(obj: PrivateEndpoint): object; }