Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace PrivateEndpointSummary

A Data Flow private endpoint object used in bulk listings.

Properties

compartmentId

compartmentId: string

The OCID of a compartment.

definedTags

definedTags: object

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {@code {"Operations": {"CostCenter": "42"}}}

Type declaration

  • [key: string]: object
    • [key: string]: any

displayName

displayName: string

A user-friendly name. It does not have to be unique. Avoid entering confidential information.

dnsZones

dnsZones: Array<string>

An array of DNS zone names. Example: {@code [ "app.examplecorp.com", "app.examplecorp2.com" ]}

freeformTags

freeformTags: object

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: {@code {"Department": "Finance"}}

Type declaration

  • [key: string]: string

id

id: string

The OCID of a private endpoint.

lifecycleState

The current state of this private endpoint.

Optional maxHostCount

maxHostCount: undefined | number

The maximum number of hosts to be accessed through the private endpoint. This value is used to calculate the relevant CIDR block and should be a multiple of 256. If the value is not a multiple of 256, it is rounded up to the next multiple of 256. For example, 300 is rounded up to 512. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional nsgIds

nsgIds: Array<string>

An array of network security group OCIDs.

ownerPrincipalId

ownerPrincipalId: string

The OCID of the user who created the resource.

Optional ownerUserName

ownerUserName: undefined | string

The username of the user who created the resource. If the username of the owner does not exist, {@code null} will be returned and the caller should refer to the ownerPrincipalId value instead.

Optional scanDetails

scanDetails: Array<Scan>

An array of fqdn/port pairs used to create private endpoint. Each object is a simple key-value pair with FQDN as key and port number as value. [ { fqdn: "scan1.oracle.com", port: "1521"}, { fqdn: "scan2.oracle.com", port: "1521" } ]

subnetId

subnetId: string

The OCID of a subnet.

timeCreated

timeCreated: Date

The date and time the resource was created, expressed in RFC 3339 timestamp format. Example: {@code 2018-04-03T21:10:29.600Z}

timeUpdated

timeUpdated: Date

The date and time the resource was updated, expressed in RFC 3339 timestamp format. Example: {@code 2018-04-03T21:10:29.600Z}

Functions

getDeserializedJsonObj

getJsonObj