Oracle Digital Assistant: OdaPrivateEndpoint¶
Manage OCI Digital Assistant resources from Kubernetes. This page is generated from checked-in package metadata, CRD schemas, and sample manifests.
Resource Snapshot¶
| Field | Value |
|---|---|
| Service | oda |
| Resource | OdaPrivateEndpoint |
| API Version | oda.oracle.com/v1beta1 |
| Package | Oracle Digital Assistant |
| Support Status | Preview |
| Latest Released Version | v2.1.0-alpha |
| Install Namespace | oci-service-operator-oda-system |
Quick Links¶
- Resource Guide Index
- Setup Guide
- Package Page
- API Reference
- Spec Reference
- Status Reference
- Rendered Sample (
config/samples/oda_v1beta1_odaprivateendpoint.yaml)
Spec Fields¶
This summary shows the top-level spec fields. Use the full API reference for nested fields, defaults, and enum values.
| Field | Description | Type | Required |
|---|---|---|---|
compartmentId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment that the ODA private endpoint belongs to. | string |
Yes |
definedTags |
Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"foo-namespace": {"bar-key": "value"}} |
map[string, map[string, string]] |
No |
description |
Description of the ODA private endpoint. | string |
No |
displayName |
User-defined name for the ODA private endpoint. Avoid entering confidential information. You can change this value. | string |
No |
freeformTags |
Simple key-value pair that is applied without any predefined name, type, or scope. Example: {"bar-key": "value"} |
map[string, string] |
No |
nsgIds |
List of OCIDs (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of network security groups (https://docs.oracle.com/iaas/Content/Network/Concepts/networksecuritygroups.htm) | list[string] |
No |
subnetId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the subnet that the private endpoint belongs to. | string |
Yes |
Status Fields¶
This summary shows the top-level status fields. Use the full API reference for nested fields, defaults, and enum values.
| Field | Description | Type | Required |
|---|---|---|---|
compartmentId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment that the ODA private endpoint belongs to. | string |
No |
definedTags |
Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"foo-namespace": {"bar-key": "value"}} |
map[string, map[string, string]] |
No |
description |
Description of the ODA private endpoint. | string |
No |
displayName |
User-defined name for the ODA private endpoint. Avoid entering confidential information. You can change this value. | string |
No |
freeformTags |
Simple key-value pair that is applied without any predefined name, type, or scope. Example: {"bar-key": "value"} |
map[string, string] |
No |
id |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) that was assigned when the ODA private endpoint was created. | string |
No |
lifecycleState |
The current state of the ODA private endpoint. | string |
No |
nsgIds |
List of OCIDs (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of network security groups (https://docs.oracle.com/iaas/Content/Network/Concepts/networksecuritygroups.htm) | list[string] |
No |
status |
- | object |
Yes |
subnetId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the subnet that the private endpoint belongs to. | string |
No |
timeCreated |
When the resource was created. A date-time string as described in RFC 3339 (https://tools.ietf.org/rfc/rfc3339), section 14.29. | string |
No |
timeUpdated |
When the resource was last updated. A date-time string as described in RFC 3339 (https://tools.ietf.org/rfc/rfc3339), section 14.29. | string |
No |
Sample Manifest¶
This example is generated from the checked-in sample manifest at config/samples/oda_v1beta1_odaprivateendpoint.yaml. Replace placeholder values before applying it.
#
# Copyright (c) 2021, Oracle and/or its affiliates. All rights reserved.
# Licensed under the Universal Permissive License v 1.0 as shown at http://oss.oracle.com/licenses/upl.
#
apiVersion: oda.oracle.com/v1beta1
kind: OdaPrivateEndpoint
metadata:
name: odaprivateendpoint-sample
spec: {}