Skip to content

oda.oracle.com/v1beta1

Back to API Reference

APIVersion: oda.oracle.com/v1beta1

This content is generated from the checked-in CRD schemas in config/crd/bases/. If a description is missing or incorrect, fix the source comments or generator inputs and rerun make generate manifests; do not hand-edit config/crd/bases/*.yaml.

Packages

No customer-visible package currently exposes oda.oracle.com/v1beta1.

Resources

Kind Scope Sample Packages
AuthenticationProvider Namespaced Sample -
Channel Namespaced Sample -
DigitalAssistant Namespaced Sample -
ImportedPackage Namespaced Sample -
OdaInstance Namespaced Sample -
OdaInstanceAttachment Namespaced Sample -
OdaPrivateEndpoint Namespaced Sample -
OdaPrivateEndpointAttachment Namespaced Sample -
OdaPrivateEndpointScanProxy Namespaced Sample -
Skill Namespaced Sample -
SkillParameter Namespaced Sample -
Translator Namespaced Sample -

AuthenticationProvider

AuthenticationProvider is the Schema for the authenticationproviders API.

  • Plural: authenticationproviders
  • Scope: Namespaced
  • APIVersion: oda.oracle.com/v1beta1
  • Sample: Sample (config/samples/oda_v1beta1_authenticationprovider.yaml)
  • Packages: Not currently exposed by a customer-visible package.

Spec

AuthenticationProviderSpec defines the desired state of AuthenticationProvider.

Field Description Type Required Default Enum
authorizationEndpointUrl The IDPs URL for the page that users authenticate with by entering the user name and password. string No - -
clientId The client ID for the IDP application (OAuth Client) that was registered as described in Identity Provider Registration. With Microsoft identity platform, use the application ID. string Yes - -
clientSecret The client secret for the IDP application (OAuth Client) that was registered as described in Identity Provider Registration. With Microsoft identity platform, use the application secret. 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 - -
freeformTags Simple key-value pair that is applied without any predefined name, type, or scope. Example: {"bar-key": "value"} map[string, string] No - -
grantType The grant type for the Authentication Provider. string Yes - -
identityProvider Which type of Identity Provider (IDP) you are using. string Yes - -
isVisible Whether this Authentication Provider is visible in the ODA UI. boolean No - -
name A name to identify the Authentication Provider. string Yes - -
redirectUrl The OAuth Redirect URL. string No - -
refreshTokenRetentionPeriodInDays The number of days to keep the refresh token in the Digital Assistant cache. integer No - -
revokeTokenEndpointUrl If you want to revoke all the refresh tokens and access tokens of the logged-in user from a dialog flow, then you need the IDP's revoke refresh token URL. If you provide this URL, then you can use the System.OAuth2ResetTokens component to revoke the user's tokens for this service. string No - -
scopes A space-separated list of the scopes that must be included when Digital Assistant requests an access token from the provider. Include all the scopes that are required to access the resources. If refresh tokens are enabled, include the scope that’s necessary to get the refresh token (typically offline_access). string Yes - -
shortAuthorizationCodeRequestUrl A shortened version of the authorization URL, which you can get from a URL shortener service (one that allows you to send query parameters). You might need this because the generated authorization-code-request URL could be too long for SMS and older smart phones. string No - -
subjectClaim The access-token profile claim to use to identify the user. string No - -
tokenEndpointUrl The IDPs URL for requesting access tokens. string Yes - -

Status

AuthenticationProviderStatus defines the observed state of AuthenticationProvider.

Field Description Type Required Default Enum
authorizationEndpointUrl The IDPs URL for the page that users authenticate with by entering the user name and password. string No - -
clientId The client ID for the IDP application (OAuth Client) that was registered as described in Identity Provider Registration. With Microsoft identity platform, use the application ID. 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 - -
freeformTags Simple key-value pair that is applied without any predefined name, type, or scope. Example: {"bar-key": "value"} map[string, string] No - -
grantType The grant type for the Authentication Provider. string No - -
id Unique immutable identifier that was assigned when the Authentication Provider was created. string No - -
identityProvider Which type of Identity Provider (IDP) you are using. string No - -
isVisible Whether this Authentication Provider is visible in the ODA UI. boolean No - -
lifecycleState The Authentication Provider's current state. string No - -
name A name to identify the Authentication Provider. string No - -
redirectUrl The OAuth Redirect URL. string No - -
refreshTokenRetentionPeriodInDays The number of days to keep the refresh token in the Digital Assistant cache. integer No - -
revokeTokenEndpointUrl If you want to revoke all the refresh tokens and access tokens of the logged-in user from a dialog flow, then you need the IDP's revoke refresh token URL. If you provide this URL, then you can use the System.OAuth2ResetTokens component to revoke the user's tokens for this service. string No - -
scopes A space-separated list of the scopes that must be included when Digital Assistant requests an access token from the provider. Include all the scopes that are required to access the resources. If refresh tokens are enabled, include the scope that’s necessary to get the refresh token (typically offline_access). string No - -
shortAuthorizationCodeRequestUrl A shortened version of the authorization URL, which you can get from a URL shortener service (one that allows you to send query parameters). You might need this because the generated authorization-code-request URL could be too long for SMS and older smart phones. string No - -
status - object Yes - -
subjectClaim The access-token profile claim to use to identify the user. 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 - -
tokenEndpointUrl The IDPs URL for requesting access tokens. string No - -

Status.status

Back to AuthenticationProvider status

Field Description Type Required Default Enum
async Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first. object No - -
conditions - list[object] No - -
createdAt - string (date-time) No - -
deletedAt - string (date-time) No - -
message - string No - -
ocid - string No - -
opcRequestId OpcRequestID is the latest non-empty OCI request ID from a mutating OCI response or surfaced OCI service error that materially contributed to the current shared status projection. Headerless follow-up observations keep the last non-empty value intact. string No - -
reason - string No - -
requestedAt - string (date-time) No - -
updatedAt - string (date-time) No - -

Status.status.async

Back to AuthenticationProvider status

Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first.

Field Description Type Required Default Enum
current - object No - -

Status.status.async.current

Back to AuthenticationProvider status

Field Description Type Required Default Enum
message - string No - -
normalizedClass - string Yes - attention, canceled, failed, pending, succeeded, unknown
percentComplete - number No - -
phase - string Yes - create, delete, update
rawOperationType - string No - -
rawStatus - string No - -
source - string Yes - lifecycle, none, workrequest
updatedAt - string (date-time) Yes - -
workRequestId - string No - -

Status.status.conditions[]

Back to AuthenticationProvider status

Field Description Type Required Default Enum
lastTransitionTime - string (date-time) No - -
message - string No - -
reason - string No - -
status - string Yes - -
type - string Yes - -

Channel

Channel is the Schema for the channels API.

  • Plural: channels
  • Scope: Namespaced
  • APIVersion: oda.oracle.com/v1beta1
  • Sample: Sample (config/samples/oda_v1beta1_channel.yaml)
  • Packages: Not currently exposed by a customer-visible package.

Spec

ChannelSpec defines the desired state of Channel.

Field Description Type Required Default Enum
accountSID The Account SID for the Twilio number. string No - -
allowedDomains A comma-delimited whitelist of allowed domains. The channel will only communicate with the sites from the domains that you add to this list. For example, .corp.example.com, .hdr.example.com. Entering a single asterisk (*) allows unrestricted access to the channel from any domain. Typically, you'd only enter a single asterisk during development. For production, you would add an allowlist of domains. string No - -
appSecret The app secret for your Facebook app. string No - -
authErrorUrl The URL to redirect to when authentication is unsuccessful. string No - -
authSuccessUrl The URL to redirect to when authentication is successful. string No - -
authToken The authentication token to use when connecting to the Oracle Streaming Service. string No - -
authenticationProviderName The name of the Authentication Provider to use to authenticate the user. string No - -
bootstrapServers The Oracle Streaming Service bootstrap servers. string No - -
botId The ID of the Skill or Digital Assistant that the Channel is routed to. string No - -
channelService The type of OSVC service. string No - -
clientId The Slack Client Id for the Slack app. string No - -
clientSecret The Client Secret for the Slack App. string No - -
clientType The type of Service Cloud client. 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 A short description of the Channel. string No - -
domainName The domain name. If you have access to Oracle B2C Service, you can derive this value from the URL that you use to launch the Agent Browser User Interface. For example, if the URL is sitename.exampledomain.com, then the host name prefix is sitename and the domain name is exampledomain.com. If the channel is connecting to Oracle B2C Service version 19A or later, and you have multiple interfaces, then you must include the interface ID in the host (site) name . For example, for the interface that has an ID of 2, you would use something like sitename-2.exampledomain.com. string No - -
eventSinkBotIds The IDs of the Skills and Digital Assistants that the Channel is routed to. list[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 - -
host The host. For OSVC, you can derive these values from the URL that you use to launch the Agent Browser User Interface or the chat launch page. For example, if the URL is https://sitename.exampledomain.com/app/chat/chat_launch, then the host is sitename.exampledomain.com. For FUSION, this is the host portion of your Oracle Applications Cloud (Fusion) instance's URL. For example: sitename.exampledomain.com. string No - -
hostNamePrefix The host prefix. If you have access to Oracle B2C Service, you can derive this value from the URL that you use to launch the Agent Browser User Interface. For example, if the URL is sitename.exampledomain.com, then the host name prefix is sitename and the domain name is exampledomain.com. If the channel is connecting to Oracle B2C Service version 19A or later, and you have multiple interfaces, then you must include the interface ID in the host (site) name . For example, for the interface that has an ID of 2, you would use something like sitename-2.exampledomain.com. string No - -
inboundMessageTopic The topic inbound messages are received on. string No - -
isAuthenticatedUserId True if the user id in the AIC message should be treated as an authenticated user id. boolean No - -
isClientAuthenticationEnabled Whether client authentication is enabled or not. boolean No - -
isMmsEnabled Whether MMS is enabled for this channel or not. boolean No - -
jsonData - string No - -
maxTokenExpirationTimeInMinutes The maximum time until the token expires (in minutes). integer (int64) No - -
msaAppId The Microsoft App ID that you obtained when you created your bot registration in Azure. string No - -
msaAppPassword The client secret that you obtained from your bot registration. string No - -
name The Channel's name. The name can contain only letters, numbers, periods, and underscores. The name must begin with a letter. string Yes - -
odaInstanceId Unique Digital Assistant instance identifier. string Yes - -
originalConnectorsUrl The original connectors URL (used for backward compatibility). string No - -
outboundMessageTopic The topic outbound messages are sent on. string No - -
outboundUrl The URL to send response and error messages to. string No - -
pageAccessToken The page access token that you generated for your Facebook page. string No - -
password The password for the Oracle B2C Service staff member who has the necessary profile permissions. string No - -
payloadVersion The version for payloads. string No - -
phoneNumber The Twilio phone number. string No - -
port The port. string No - -
saslMechanism The SASL mechanmism to use when conecting to the Oracle Streaming Service. See Oracle Streaming Service documentation for a list of valid values. string No - -
securityProtocol The security protocol to use when conecting to the Oracle Streaming Service. See Oracle Streaming Service documentation for a list of valid values. string No - -
sessionExpiryDurationInMilliseconds The number of milliseconds before a session expires. integer (int64) No - -
signingSecret The Signing Secret for the Slack App. string No - -
streamPoolId The stream pool OCI to use when connecting to the Oracle Streaming Service. string No - -
tenancyName The tenancy to use when connecting to the Oracle Streaming Service. string No - -
totalSessionCount The total session count. integer No - -
type - string No - -
userName The user name for an Oracle B2C Service staff member who has the necessary profile permissions. string No - -

Status

ChannelStatus defines the observed state of Channel.

Field Description Type Required Default Enum
accountSID The Account SID for the Twilio number. string No - -
allowedDomains A comma-delimited whitelist of allowed domains. The channel will only communicate with the sites from the domains that you add to this list. For example, .corp.example.com, .hdr.example.com. Entering a single asterisk (*) allows unrestricted access to the channel from any domain. Typically, you'd only enter a single asterisk during development. For production, you would add an allowlist of domains. string No - -
authErrorUrl The URL to redirect to when authentication is unsuccessful. string No - -
authSuccessUrl The URL to redirect to when authentication is successful. string No - -
authenticationProviderName The name of the Authentication Provider to use to authenticate the user. string No - -
bootstrapServers The Oracle Streaming Service bootstrap servers. string No - -
botId The ID of the Skill or Digital Assistant that the Channel is routed to. string No - -
category The category of the Channel. string No - -
channelService The type of OSVC service. string No - -
clientId The Slack Client Id for the Slack app. string No - -
clientType The type of Service Cloud client. 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 A short description of the Channel. string No - -
domainName The domain name. If you have access to Oracle B2C Service, you can derive this value from the URL that you use to launch the Agent Browser User Interface. For example, if the URL is sitename.exampledomain.com, then the host name prefix is sitename and the domain name is exampledomain.com. If the channel is connecting to Oracle B2C Service version 19A or later, and you have multiple interfaces, then you must include the interface ID in the host (site) name . For example, for the interface that has an ID of 2, you would use something like sitename-2.exampledomain.com. string No - -
eventSinkBotIds The IDs of the Skills and Digital Assistants that the Channel is routed to. list[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 - -
host The host. For OSVC, you can derive these values from the URL that you use to launch the Agent Browser User Interface or the chat launch page. For example, if the URL is https://sitename.exampledomain.com/app/chat/chat_launch, then the host is sitename.exampledomain.com. For FUSION, this is the host portion of your Oracle Applications Cloud (Fusion) instance's URL. For example: sitename.exampledomain.com. string No - -
hostNamePrefix The host prefix. If you have access to Oracle B2C Service, you can derive this value from the URL that you use to launch the Agent Browser User Interface. For example, if the URL is sitename.exampledomain.com, then the host name prefix is sitename and the domain name is exampledomain.com. If the channel is connecting to Oracle B2C Service version 19A or later, and you have multiple interfaces, then you must include the interface ID in the host (site) name . For example, for the interface that has an ID of 2, you would use something like sitename-2.exampledomain.com. string No - -
id Unique immutable identifier that was assigned when the Channel was created. string No - -
inboundMessageTopic The topic inbound messages are received on. string No - -
isAuthenticatedUserId True if the user id in the AIC message should be treated as an authenticated user id. boolean No - -
isClientAuthenticationEnabled Whether client authentication is enabled or not. boolean No - -
isMmsEnabled Whether MMS is enabled for this channel or not. boolean No - -
jsonData - string No - -
lifecycleState The Channel's current state. string No - -
maxTokenExpirationTimeInMinutes The maximum time until the token expires (in minutes). integer (int64) No - -
msaAppId The Microsoft App ID that you obtained when you created your bot registration in Azure. string No - -
name The Channel's name. The name can contain only letters, numbers, periods, and underscores. The name must begin with a letter. string No - -
originalConnectorsUrl The original connectors URL (used for backward compatibility). string No - -
outboundMessageTopic The topic outbound messages are sent on. string No - -
outboundUrl The URL for sending errors and responses to. string No - -
payloadVersion The version for payloads. string No - -
phoneNumber The Twilio phone number. string No - -
port The port. string No - -
saslMechanism The SASL mechanmism to use when conecting to the Oracle Streaming Service. See Oracle Streaming Service documentation for a list of valid values. string No - -
securityProtocol The security protocol to use when conecting to the Oracle Streaming Service. See Oracle Streaming Service documentation for a list of valid values. string No - -
sessionExpiryDurationInMilliseconds The number of milliseconds before a session expires. integer (int64) No - -
status - object Yes - -
streamPoolId The stream pool OCI to use when connecting to the Oracle Streaming Service. string No - -
tenancyName The tenancy to use when connecting to the Oracle Streaming Service. 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 - -
totalSessionCount The total session count. integer No - -
type - string No - -
userName The user name for the digital-assistant agent. string No - -
webhookUrl The URL to use to send messages to this channel. This will be generally be used to configure a webhook in a 3rd party messaging system to send messages to this channel. string No - -

Status.status

Back to Channel status

Field Description Type Required Default Enum
async Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first. object No - -
conditions - list[object] No - -
createdAt - string (date-time) No - -
deletedAt - string (date-time) No - -
message - string No - -
ocid - string No - -
opcRequestId OpcRequestID is the latest non-empty OCI request ID from a mutating OCI response or surfaced OCI service error that materially contributed to the current shared status projection. Headerless follow-up observations keep the last non-empty value intact. string No - -
reason - string No - -
requestedAt - string (date-time) No - -
updatedAt - string (date-time) No - -

Status.status.async

Back to Channel status

Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first.

Field Description Type Required Default Enum
current - object No - -

Status.status.async.current

Back to Channel status

Field Description Type Required Default Enum
message - string No - -
normalizedClass - string Yes - attention, canceled, failed, pending, succeeded, unknown
percentComplete - number No - -
phase - string Yes - create, delete, update
rawOperationType - string No - -
rawStatus - string No - -
source - string Yes - lifecycle, none, workrequest
updatedAt - string (date-time) Yes - -
workRequestId - string No - -

Status.status.conditions[]

Back to Channel status

Field Description Type Required Default Enum
lastTransitionTime - string (date-time) No - -
message - string No - -
reason - string No - -
status - string Yes - -
type - string Yes - -

DigitalAssistant

DigitalAssistant is the Schema for the digitalassistants API.

  • Plural: digitalassistants
  • Scope: Namespaced
  • APIVersion: oda.oracle.com/v1beta1
  • Sample: Sample (config/samples/oda_v1beta1_digitalassistant.yaml)
  • Packages: Not currently exposed by a customer-visible package.

Spec

DigitalAssistantSpec defines the desired state of DigitalAssistant.

Field Description Type Required Default Enum
category The resource's category. This is used to group resource's together. 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 A short description of the resource. string No - -
displayName The resource's display name. 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 unique identifier of the Digital Assistant to create a new version of. string No - -
jsonData - string No - -
kind - string No - -
multilingualMode The multilingual mode for the resource. string No - -
name The reource's name. The name can contain only letters, numbers, periods, and underscores. The name must begin with a letter. string No - -
nativeLanguageTags A list of native languages supported by this resource. list[string] No - -
platformVersion The ODA Platform Version for this resource. string No - -
primaryLanguageTag The primary language for the resource. string No - -
version The resource's version. The version can only contain numbers, letters, periods, underscores, dashes or spaces. The version must begin with a letter or a number. string No - -

Status

DigitalAssistantStatus defines the observed state of DigitalAssistant.

Field Description Type Required Default Enum
baseId The unique identifier for the base reource (when this resource extends another). string No - -
category The resource's category. This is used to group resource's together. 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 A short description of the resource. string No - -
dialogVersion The resource's dialog version. string No - -
displayName The resource's display name. 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 Unique immutable identifier that was assigned when the resource was created. string No - -
lifecycleDetails The resource's publish state. string No - -
lifecycleState The resource's current state. string No - -
multilingualMode The multilingual mode for the resource. string No - -
name The reource's name. The name can contain only letters, numbers, periods, and underscores. The name must begin with a letter. string No - -
namespace The resource's namespace. string No - -
nativeLanguageTags A list of native languages supported by this resource. list[string] No - -
platformVersion The ODA Platform Version for this resource. string No - -
primaryLanguageTag The primary language for the resource. string No - -
status - object Yes - -
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 - -
version The resource's version. The version can only contain numbers, letters, periods, underscores, dashes or spaces. The version must begin with a letter or a number. string No - -

Status.status

Back to DigitalAssistant status

Field Description Type Required Default Enum
async Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first. object No - -
conditions - list[object] No - -
createdAt - string (date-time) No - -
deletedAt - string (date-time) No - -
message - string No - -
ocid - string No - -
opcRequestId OpcRequestID is the latest non-empty OCI request ID from a mutating OCI response or surfaced OCI service error that materially contributed to the current shared status projection. Headerless follow-up observations keep the last non-empty value intact. string No - -
reason - string No - -
requestedAt - string (date-time) No - -
updatedAt - string (date-time) No - -

Status.status.async

Back to DigitalAssistant status

Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first.

Field Description Type Required Default Enum
current - object No - -

Status.status.async.current

Back to DigitalAssistant status

Field Description Type Required Default Enum
message - string No - -
normalizedClass - string Yes - attention, canceled, failed, pending, succeeded, unknown
percentComplete - number No - -
phase - string Yes - create, delete, update
rawOperationType - string No - -
rawStatus - string No - -
source - string Yes - lifecycle, none, workrequest
updatedAt - string (date-time) Yes - -
workRequestId - string No - -

Status.status.conditions[]

Back to DigitalAssistant status

Field Description Type Required Default Enum
lastTransitionTime - string (date-time) No - -
message - string No - -
reason - string No - -
status - string Yes - -
type - string Yes - -

ImportedPackage

ImportedPackage is the Schema for the importedpackages API.

  • Plural: importedpackages
  • Scope: Namespaced
  • APIVersion: oda.oracle.com/v1beta1
  • Sample: Sample (config/samples/oda_v1beta1_importedpackage.yaml)
  • Packages: Not currently exposed by a customer-visible package.

Spec

ImportedPackageSpec defines the desired state of ImportedPackage.

Field Description Type Required Default Enum
currentPackageId ID of the package to import. 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 - -
freeformTags Simple key-value pair that is applied without any predefined name, type, or scope. Example: {"bar-key": "value"} map[string, string] No - -
parameterValues A list of parameter values to use when importing the given package. Must match those defined in the import contract. map[string, string] No - -

Status

ImportedPackageStatus defines the observed state of ImportedPackage.

Field Description Type Required Default Enum
currentPackageId ID of the package. 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 - -
displayName Display name of the package (can change across versions). 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 - -
name Stable name of the package (the same across versions). string No - -
odaInstanceId ID of the host instance. string No - -
parameterValues A list of parameter values used to import the package. map[string, string] No - -
sdkStatus Status of the imported package. This uses a distinct JSON name so it can coexist with the OSOK status envelope. string No - -
status - object Yes - -
statusMessage Short message explaining the status of this imported package. string No - -
timeCreated When the imported package 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 imported package was last updated. A date-time string as described in RFC 3339 (https://tools.ietf.org/rfc/rfc3339), section 14.29. string No - -
version version of the package. string No - -

Status.status

Back to ImportedPackage status

Field Description Type Required Default Enum
async Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first. object No - -
conditions - list[object] No - -
createdAt - string (date-time) No - -
deletedAt - string (date-time) No - -
message - string No - -
ocid - string No - -
opcRequestId OpcRequestID is the latest non-empty OCI request ID from a mutating OCI response or surfaced OCI service error that materially contributed to the current shared status projection. Headerless follow-up observations keep the last non-empty value intact. string No - -
reason - string No - -
requestedAt - string (date-time) No - -
updatedAt - string (date-time) No - -

Status.status.async

Back to ImportedPackage status

Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first.

Field Description Type Required Default Enum
current - object No - -

Status.status.async.current

Back to ImportedPackage status

Field Description Type Required Default Enum
message - string No - -
normalizedClass - string Yes - attention, canceled, failed, pending, succeeded, unknown
percentComplete - number No - -
phase - string Yes - create, delete, update
rawOperationType - string No - -
rawStatus - string No - -
source - string Yes - lifecycle, none, workrequest
updatedAt - string (date-time) Yes - -
workRequestId - string No - -

Status.status.conditions[]

Back to ImportedPackage status

Field Description Type Required Default Enum
lastTransitionTime - string (date-time) No - -
message - string No - -
reason - string No - -
status - string Yes - -
type - string Yes - -

OdaInstance

OdaInstance is the Schema for the odainstances API.

  • Plural: odainstances
  • Scope: Namespaced
  • APIVersion: oda.oracle.com/v1beta1
  • Sample: Sample (config/samples/oda_v1beta1_odainstance.yaml)
  • Packages: Not currently exposed by a customer-visible package.

Spec

OdaInstanceSpec defines the desired state of OdaInstance.

Field Description Type Required Default Enum
compartmentId Identifier of the compartment. 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 Digital Assistant instance. string No - -
displayName User-friendly name for the instance. Avoid entering confidential information. You can change this value anytime. 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 - -
identityDomain If isRoleBasedAccess is set to true, this property specifies the identity domain that is to be used to implement this type of authorzation. Digital Assistant will create an Identity Application instance and Application Roles within this identity domain. The caller may then perform and user roll mappings they like to grant access to users within the identity domain. string No - -
isRoleBasedAccess Should this Digital Assistant instance use role-based authorization via an identity domain (true) or use the default policy-based authorization via IAM policies (false) boolean No - -
shapeName Shape or size of the instance. string Yes - -

Status

OdaInstanceStatus defines the observed state of OdaInstance.

Field Description Type Required Default Enum
attachmentIds A list of attachment identifiers for this instance (if any). Use GetOdaInstanceAttachment to get the details of the attachments. list[string] No - -
attachmentTypes A list of attachment types for this instance (if any). Use attachmentIds to get the details of the attachments. list[string] No - -
compartmentId Identifier of the compartment that the instance belongs to. string No - -
connectorUrl URL for the connector's endpoint. 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 Digital Assistant instance. string No - -
displayName User-defined name for the Digital Assistant instance. 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 Unique immutable identifier that was assigned when the instance was created. string No - -
identityAppConsoleUrl If isRoleBasedAccess is set to true, this property specifies the URL for the administration console used to manage the Identity Application instance Digital Assistant has created inside the user-specified identity domain. string No - -
identityAppGuid If isRoleBasedAccess is set to true, this property specifies the GUID of the Identity Application instance Digital Assistant has created inside the user-specified identity domain. This identity application instance may be used to host user roll mappings to grant access to this Digital Assistant instance for users within the identity domain. string No - -
identityDomain If isRoleBasedAccess is set to true, this property specifies the identity domain that is to be used to implement this type of authorzation. Digital Assistant will create an Identity Application instance and Application Roles within this identity domain. The caller may then perform and user roll mappings they like to grant access to users within the identity domain. string No - -
importedPackageIds A list of package ids imported into this instance (if any). Use GetImportedPackage to get the details of the imported packages. list[string] No - -
importedPackageNames A list of package names imported into this instance (if any). Use importedPackageIds field to get the details of the imported packages. list[string] No - -
isRoleBasedAccess Should this Digital Assistant instance use role-based authorization via an identity domain (true) or use the default policy-based authorization via IAM policies (false) boolean No - -
lifecycleState The current state of the Digital Assistant instance. string No - -
lifecycleSubState The current sub-state of the Digital Assistant instance. string No - -
restrictedOperations A list of restricted operations (across all attachments) for this instance (if any). Use GetOdaInstanceAttachment to get the details of the attachments. list[object] No - -
shapeName Shape or size of the instance. string No - -
stateMessage A message that describes the current state in more detail. For example, actionable information about an instance that's in the FAILED state. string No - -
status - object Yes - -
timeCreated When the Digital Assistant instance 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 Digital Assistance instance was last updated. A date-time string as described in RFC 3339 (https://tools.ietf.org/rfc/rfc3339), section 14.29. string No - -
webAppUrl URL for the Digital Assistant web application that's associated with the instance. string No - -

Status.restrictedOperations[]

Back to OdaInstance status

OdaInstanceRestrictedOperation defines nested fields for OdaInstance.RestrictedOperation.

Field Description Type Required Default Enum
operationName Name of the restricted operation. string No - -
restrictingService Name of the service restricting the operation. string No - -

Status.status

Back to OdaInstance status

Field Description Type Required Default Enum
async Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first. object No - -
conditions - list[object] No - -
createdAt - string (date-time) No - -
deletedAt - string (date-time) No - -
message - string No - -
ocid - string No - -
opcRequestId OpcRequestID is the latest non-empty OCI request ID from a mutating OCI response or surfaced OCI service error that materially contributed to the current shared status projection. Headerless follow-up observations keep the last non-empty value intact. string No - -
reason - string No - -
requestedAt - string (date-time) No - -
updatedAt - string (date-time) No - -

Status.status.async

Back to OdaInstance status

Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first.

Field Description Type Required Default Enum
current - object No - -

Status.status.async.current

Back to OdaInstance status

Field Description Type Required Default Enum
message - string No - -
normalizedClass - string Yes - attention, canceled, failed, pending, succeeded, unknown
percentComplete - number No - -
phase - string Yes - create, delete, update
rawOperationType - string No - -
rawStatus - string No - -
source - string Yes - lifecycle, none, workrequest
updatedAt - string (date-time) Yes - -
workRequestId - string No - -

Status.status.conditions[]

Back to OdaInstance status

Field Description Type Required Default Enum
lastTransitionTime - string (date-time) No - -
message - string No - -
reason - string No - -
status - string Yes - -
type - string Yes - -

OdaInstanceAttachment

OdaInstanceAttachment is the Schema for the odainstanceattachments API.

  • Plural: odainstanceattachments
  • Scope: Namespaced
  • APIVersion: oda.oracle.com/v1beta1
  • Sample: Sample (config/samples/oda_v1beta1_odainstanceattachment.yaml)
  • Packages: Not currently exposed by a customer-visible package.

Spec

OdaInstanceAttachmentSpec defines the desired state of OdaInstanceAttachment.

Field Description Type Required Default Enum
attachToId The OCID of the target instance (which could be any other OCI PaaS/SaaS resource), to which this ODA instance is being attached. string Yes - -
attachmentMetadata Attachment specific metadata. Defined by the target service. string No - -
attachmentType The type of target instance which this ODA instance is being attached. 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 - -
freeformTags Simple key-value pair that is applied without any predefined name, type, or scope. Example: {"bar-key": "value"} map[string, string] No - -
owner OdaInstanceAttachmentOwner defines nested fields for OdaInstanceAttachment.Owner. object Yes - -
restrictedOperations List of operations that are restricted while this instance is attached. list[string] No - -

Spec.owner

Back to OdaInstanceAttachment spec

OdaInstanceAttachmentOwner defines nested fields for OdaInstanceAttachment.Owner.

Field Description Type Required Default Enum
ownerServiceName Name of the owner service principal string Yes - -
ownerServiceTenancy Tenancy OCID of the owner service principal string Yes - -

Status

OdaInstanceAttachmentStatus defines the observed state of OdaInstanceAttachment.

Field Description Type Required Default Enum
attachToId The OCID of the target instance (which could be any other OCI PaaS/SaaS resource), to which the ODA instance is or is being attached. string No - -
attachmentMetadata Attachment-specific metadata, defined by the target service. string No - -
attachmentType The type of attachment defined as an enum. 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 - -
freeformTags Simple key-value pair that is applied without any predefined name, type, or scope. Example: {"bar-key": "value"} map[string, string] No - -
id Unique immutable identifier that was assigned when the ODA instance attachment was created. string No - -
instanceId The OCID of the ODA instance to which the attachment applies. string No - -
lifecycleState The current state of the attachment. string No - -
owner OdaInstanceAttachmentOwner defines nested fields for OdaInstanceAttachment.Owner. object No - -
restrictedOperations List of operation names that are restricted while this ODA instance is attached. list[string] No - -
status - object Yes - -
timeCreated The time the attachment was created. An RFC3339 formatted datetime string string No - -
timeLastUpdate The time the attachment was last modified. An RFC3339 formatted datetime string string No - -

Status.owner

Back to OdaInstanceAttachment status

OdaInstanceAttachmentOwner defines nested fields for OdaInstanceAttachment.Owner.

Field Description Type Required Default Enum
ownerServiceName Name of the owner service principal string Yes - -
ownerServiceTenancy Tenancy OCID of the owner service principal string Yes - -

Status.status

Back to OdaInstanceAttachment status

Field Description Type Required Default Enum
async Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first. object No - -
conditions - list[object] No - -
createdAt - string (date-time) No - -
deletedAt - string (date-time) No - -
message - string No - -
ocid - string No - -
opcRequestId OpcRequestID is the latest non-empty OCI request ID from a mutating OCI response or surfaced OCI service error that materially contributed to the current shared status projection. Headerless follow-up observations keep the last non-empty value intact. string No - -
reason - string No - -
requestedAt - string (date-time) No - -
updatedAt - string (date-time) No - -

Status.status.async

Back to OdaInstanceAttachment status

Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first.

Field Description Type Required Default Enum
current - object No - -

Status.status.async.current

Back to OdaInstanceAttachment status

Field Description Type Required Default Enum
message - string No - -
normalizedClass - string Yes - attention, canceled, failed, pending, succeeded, unknown
percentComplete - number No - -
phase - string Yes - create, delete, update
rawOperationType - string No - -
rawStatus - string No - -
source - string Yes - lifecycle, none, workrequest
updatedAt - string (date-time) Yes - -
workRequestId - string No - -

Status.status.conditions[]

Back to OdaInstanceAttachment status

Field Description Type Required Default Enum
lastTransitionTime - string (date-time) No - -
message - string No - -
reason - string No - -
status - string Yes - -
type - string Yes - -

OdaPrivateEndpoint

OdaPrivateEndpoint is the Schema for the odaprivateendpoints API.

  • Plural: odaprivateendpoints
  • Scope: Namespaced
  • APIVersion: oda.oracle.com/v1beta1
  • Sample: Sample (config/samples/oda_v1beta1_odaprivateendpoint.yaml)
  • Packages: Not currently exposed by a customer-visible package.

Spec

OdaPrivateEndpointSpec defines the desired state of OdaPrivateEndpoint.

Field Description Type Required Default Enum
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

OdaPrivateEndpointStatus defines the observed state of OdaPrivateEndpoint.

Field Description Type Required Default Enum
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 - -

Status.status

Back to OdaPrivateEndpoint status

Field Description Type Required Default Enum
async Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first. object No - -
conditions - list[object] No - -
createdAt - string (date-time) No - -
deletedAt - string (date-time) No - -
message - string No - -
ocid - string No - -
opcRequestId OpcRequestID is the latest non-empty OCI request ID from a mutating OCI response or surfaced OCI service error that materially contributed to the current shared status projection. Headerless follow-up observations keep the last non-empty value intact. string No - -
reason - string No - -
requestedAt - string (date-time) No - -
updatedAt - string (date-time) No - -

Status.status.async

Back to OdaPrivateEndpoint status

Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first.

Field Description Type Required Default Enum
current - object No - -

Status.status.async.current

Back to OdaPrivateEndpoint status

Field Description Type Required Default Enum
message - string No - -
normalizedClass - string Yes - attention, canceled, failed, pending, succeeded, unknown
percentComplete - number No - -
phase - string Yes - create, delete, update
rawOperationType - string No - -
rawStatus - string No - -
source - string Yes - lifecycle, none, workrequest
updatedAt - string (date-time) Yes - -
workRequestId - string No - -

Status.status.conditions[]

Back to OdaPrivateEndpoint status

Field Description Type Required Default Enum
lastTransitionTime - string (date-time) No - -
message - string No - -
reason - string No - -
status - string Yes - -
type - string Yes - -

OdaPrivateEndpointAttachment

OdaPrivateEndpointAttachment is the Schema for the odaprivateendpointattachments API.

  • Plural: odaprivateendpointattachments
  • Scope: Namespaced
  • APIVersion: oda.oracle.com/v1beta1
  • Sample: Sample (config/samples/oda_v1beta1_odaprivateendpointattachment.yaml)
  • Packages: Not currently exposed by a customer-visible package.

Spec

OdaPrivateEndpointAttachmentSpec defines the desired state of OdaPrivateEndpointAttachment.

Field Description Type Required Default Enum
odaInstanceId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the attached ODA Instance. string Yes - -
odaPrivateEndpointId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the ODA Private Endpoint. string Yes - -

Status

OdaPrivateEndpointAttachmentStatus defines the observed state of OdaPrivateEndpointAttachment.

Field Description Type Required Default Enum
compartmentId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment that the ODA private endpoint attachment belongs to. string No - -
id The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the ODA Private Endpoint Attachment. string No - -
lifecycleState The current state of the ODA Private Endpoint attachment. string No - -
odaInstanceId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the attached ODA Instance. string No - -
odaPrivateEndpointId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the ODA Private Endpoint. string No - -
status - object Yes - -
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 - -

Status.status

Back to OdaPrivateEndpointAttachment status

Field Description Type Required Default Enum
async Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first. object No - -
conditions - list[object] No - -
createdAt - string (date-time) No - -
deletedAt - string (date-time) No - -
message - string No - -
ocid - string No - -
opcRequestId OpcRequestID is the latest non-empty OCI request ID from a mutating OCI response or surfaced OCI service error that materially contributed to the current shared status projection. Headerless follow-up observations keep the last non-empty value intact. string No - -
reason - string No - -
requestedAt - string (date-time) No - -
updatedAt - string (date-time) No - -

Status.status.async

Back to OdaPrivateEndpointAttachment status

Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first.

Field Description Type Required Default Enum
current - object No - -

Status.status.async.current

Back to OdaPrivateEndpointAttachment status

Field Description Type Required Default Enum
message - string No - -
normalizedClass - string Yes - attention, canceled, failed, pending, succeeded, unknown
percentComplete - number No - -
phase - string Yes - create, delete, update
rawOperationType - string No - -
rawStatus - string No - -
source - string Yes - lifecycle, none, workrequest
updatedAt - string (date-time) Yes - -
workRequestId - string No - -

Status.status.conditions[]

Back to OdaPrivateEndpointAttachment status

Field Description Type Required Default Enum
lastTransitionTime - string (date-time) No - -
message - string No - -
reason - string No - -
status - string Yes - -
type - string Yes - -

OdaPrivateEndpointScanProxy

OdaPrivateEndpointScanProxy is the Schema for the odaprivateendpointscanproxies API.

  • Plural: odaprivateendpointscanproxies
  • Scope: Namespaced
  • APIVersion: oda.oracle.com/v1beta1
  • Sample: Sample (config/samples/oda_v1beta1_odaprivateendpointscanproxy.yaml)
  • Packages: Not currently exposed by a customer-visible package.

Spec

OdaPrivateEndpointScanProxySpec defines the desired state of OdaPrivateEndpointScanProxy.

Field Description Type Required Default Enum
protocol The protocol used for communication between client, scanProxy and RAC's scan listeners string Yes - -
scanListenerInfos The FQDN/IPs and port information of customer's Real Application Cluster (RAC)'s SCAN listeners. list[object] Yes - -
scanListenerType Type indicating whether Scan listener is specified by its FQDN or list of IPs string Yes - -

Spec.scanListenerInfos[]

Back to OdaPrivateEndpointScanProxy spec

OdaPrivateEndpointScanProxyScanListenerInfo defines nested fields for OdaPrivateEndpointScanProxy.ScanListenerInfo.

Field Description Type Required Default Enum
scanListenerFqdn FQDN of the customer's Real Application Cluster (RAC)'s SCAN listeners. string No - -
scanListenerIp A SCAN listener's IP of the customer's Real Application Cluster (RAC). string No - -
scanListenerPort The port that customer's Real Application Cluster (RAC)'s SCAN listeners are listening on. integer No - -

Status

OdaPrivateEndpointScanProxyStatus defines the observed state of OdaPrivateEndpointScanProxy.

Field Description Type Required Default Enum
id The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the ODA Private Endpoint Scan Proxy. string No - -
lifecycleState The current state of the ODA Private Endpoint Scan Proxy. string No - -
protocol The protocol used for communication between client, scanProxy and RAC's scan listeners string No - -
scanListenerInfos The FQDN/IPs and port information of customer's Real Application Cluster (RAC)'s SCAN listeners. list[object] No - -
scanListenerType Type indicating whether Scan listener is specified by its FQDN or list of IPs string No - -
status - object Yes - -
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 - -

Status.scanListenerInfos[]

Back to OdaPrivateEndpointScanProxy status

OdaPrivateEndpointScanProxyScanListenerInfo defines nested fields for OdaPrivateEndpointScanProxy.ScanListenerInfo.

Field Description Type Required Default Enum
scanListenerFqdn FQDN of the customer's Real Application Cluster (RAC)'s SCAN listeners. string No - -
scanListenerIp A SCAN listener's IP of the customer's Real Application Cluster (RAC). string No - -
scanListenerPort The port that customer's Real Application Cluster (RAC)'s SCAN listeners are listening on. integer No - -

Status.status

Back to OdaPrivateEndpointScanProxy status

Field Description Type Required Default Enum
async Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first. object No - -
conditions - list[object] No - -
createdAt - string (date-time) No - -
deletedAt - string (date-time) No - -
message - string No - -
ocid - string No - -
opcRequestId OpcRequestID is the latest non-empty OCI request ID from a mutating OCI response or surfaced OCI service error that materially contributed to the current shared status projection. Headerless follow-up observations keep the last non-empty value intact. string No - -
reason - string No - -
requestedAt - string (date-time) No - -
updatedAt - string (date-time) No - -

Status.status.async

Back to OdaPrivateEndpointScanProxy status

Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first.

Field Description Type Required Default Enum
current - object No - -

Status.status.async.current

Back to OdaPrivateEndpointScanProxy status

Field Description Type Required Default Enum
message - string No - -
normalizedClass - string Yes - attention, canceled, failed, pending, succeeded, unknown
percentComplete - number No - -
phase - string Yes - create, delete, update
rawOperationType - string No - -
rawStatus - string No - -
source - string Yes - lifecycle, none, workrequest
updatedAt - string (date-time) Yes - -
workRequestId - string No - -

Status.status.conditions[]

Back to OdaPrivateEndpointScanProxy status

Field Description Type Required Default Enum
lastTransitionTime - string (date-time) No - -
message - string No - -
reason - string No - -
status - string Yes - -
type - string Yes - -

Skill

Skill is the Schema for the skills API.

  • Plural: skills
  • Scope: Namespaced
  • APIVersion: oda.oracle.com/v1beta1
  • Sample: Sample (config/samples/oda_v1beta1_skill.yaml)
  • Packages: Not currently exposed by a customer-visible package.

Spec

SkillSpec defines the desired state of Skill.

Field Description Type Required Default Enum
category The resource's category. This is used to group resource's together. 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 A short description of the resource. string No - -
dialogVersion The resource's dialog version. string No - -
displayName The resource's display name. 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 unique identifier of the Skill to clone. string No - -
jsonData - string No - -
kind - string No - -
multilingualMode The multilingual mode for the resource. string No - -
name The reource's name. The name can contain only letters, numbers, periods, and underscores. The name must begin with a letter. string No - -
nativeLanguageTags A list of native languages supported by this resource. list[string] No - -
platformVersion The ODA Platform Version for this resource. string No - -
primaryLanguageTag The primary language for the resource. string No - -
version The resource's version. The version can only contain numbers, letters, periods, underscores, dashes or spaces. The version must begin with a letter or a number. string No - -

Status

SkillStatus defines the observed state of Skill.

Field Description Type Required Default Enum
baseId The unique identifier for the base reource (when this resource extends another). string No - -
category The resource's category. This is used to group resource's together. 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 A short description of the resource. string No - -
dialogVersion The resource's dialog version. string No - -
displayName The resource's display name. 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 Unique immutable identifier that was assigned when the resource was created. string No - -
lifecycleDetails The resource's publish state. string No - -
lifecycleState The resource's current state. string No - -
multilingualMode The multilingual mode for the resource. string No - -
name The reource's name. The name can contain only letters, numbers, periods, and underscores. The name must begin with a letter. string No - -
namespace The resource's namespace. string No - -
nativeLanguageTags A list of native languages supported by this resource. list[string] No - -
platformVersion The ODA Platform Version for this resource. string No - -
primaryLanguageTag The primary language for the resource. string No - -
status - object Yes - -
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 - -
version The resource's version. The version can only contain numbers, letters, periods, underscores, dashes or spaces. The version must begin with a letter or a number. string No - -

Status.status

Back to Skill status

Field Description Type Required Default Enum
async Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first. object No - -
conditions - list[object] No - -
createdAt - string (date-time) No - -
deletedAt - string (date-time) No - -
message - string No - -
ocid - string No - -
opcRequestId OpcRequestID is the latest non-empty OCI request ID from a mutating OCI response or surfaced OCI service error that materially contributed to the current shared status projection. Headerless follow-up observations keep the last non-empty value intact. string No - -
reason - string No - -
requestedAt - string (date-time) No - -
updatedAt - string (date-time) No - -

Status.status.async

Back to Skill status

Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first.

Field Description Type Required Default Enum
current - object No - -

Status.status.async.current

Back to Skill status

Field Description Type Required Default Enum
message - string No - -
normalizedClass - string Yes - attention, canceled, failed, pending, succeeded, unknown
percentComplete - number No - -
phase - string Yes - create, delete, update
rawOperationType - string No - -
rawStatus - string No - -
source - string Yes - lifecycle, none, workrequest
updatedAt - string (date-time) Yes - -
workRequestId - string No - -

Status.status.conditions[]

Back to Skill status

Field Description Type Required Default Enum
lastTransitionTime - string (date-time) No - -
message - string No - -
reason - string No - -
status - string Yes - -
type - string Yes - -

SkillParameter

SkillParameter is the Schema for the skillparameters API.

  • Plural: skillparameters
  • Scope: Namespaced
  • APIVersion: oda.oracle.com/v1beta1
  • Sample: Sample (config/samples/oda_v1beta1_skillparameter.yaml)
  • Packages: Not currently exposed by a customer-visible package.

Spec

SkillParameterSpec defines the desired state of SkillParameter.

Field Description Type Required Default Enum
description A description of the Parameter. string No - -
displayName The display name for the Parameter. string Yes - -
name The Parameter name. This must be unique within the parent resource. string Yes - -
type The value type. string Yes - -
value The current value. The value will be interpreted based on the type. string Yes - -

Status

SkillParameterStatus defines the observed state of SkillParameter.

Field Description Type Required Default Enum
description A description of the Parameter. string No - -
displayName The display name for the Parameter. string No - -
lifecycleState The Parameter's current state. string No - -
name The Parameter name. This must be unique within the parent resource. string No - -
status - object Yes - -
type The value type. string No - -
value The current value. The value will be interpreted based on the type. string No - -

Status.status

Back to SkillParameter status

Field Description Type Required Default Enum
async Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first. object No - -
conditions - list[object] No - -
createdAt - string (date-time) No - -
deletedAt - string (date-time) No - -
message - string No - -
ocid - string No - -
opcRequestId OpcRequestID is the latest non-empty OCI request ID from a mutating OCI response or surfaced OCI service error that materially contributed to the current shared status projection. Headerless follow-up observations keep the last non-empty value intact. string No - -
reason - string No - -
requestedAt - string (date-time) No - -
updatedAt - string (date-time) No - -

Status.status.async

Back to SkillParameter status

Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first.

Field Description Type Required Default Enum
current - object No - -

Status.status.async.current

Back to SkillParameter status

Field Description Type Required Default Enum
message - string No - -
normalizedClass - string Yes - attention, canceled, failed, pending, succeeded, unknown
percentComplete - number No - -
phase - string Yes - create, delete, update
rawOperationType - string No - -
rawStatus - string No - -
source - string Yes - lifecycle, none, workrequest
updatedAt - string (date-time) Yes - -
workRequestId - string No - -

Status.status.conditions[]

Back to SkillParameter status

Field Description Type Required Default Enum
lastTransitionTime - string (date-time) No - -
message - string No - -
reason - string No - -
status - string Yes - -
type - string Yes - -

Translator

Translator is the Schema for the translators API.

  • Plural: translators
  • Scope: Namespaced
  • APIVersion: oda.oracle.com/v1beta1
  • Sample: Sample (config/samples/oda_v1beta1_translator.yaml)
  • Packages: Not currently exposed by a customer-visible package.

Spec

TranslatorSpec defines the desired state of Translator.

Field Description Type Required Default Enum
authToken The authentication token to use when invoking the Translation Service string Yes - -
baseUrl The base URL for invoking the Translation Service. 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 - -
freeformTags Simple key-value pair that is applied without any predefined name, type, or scope. Example: {"bar-key": "value"} map[string, string] No - -
properties Properties used when invoking the translation service. Each property is a simple key-value pair. map[string, string] No - -
type The Translation Service to use for this Translator. string Yes - -

Status

TranslatorStatus defines the observed state of Translator.

Field Description Type Required Default Enum
baseUrl The base URL for invoking the Translation Service. 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 - -
freeformTags Simple key-value pair that is applied without any predefined name, type, or scope. Example: {"bar-key": "value"} map[string, string] No - -
id Unique immutable identifier that was assigned when the Translator was created. string No - -
lifecycleState The Translator's current state. string No - -
name The descriptive name for this Translator. string No - -
properties Properties used when invoking the translation service. Each property is a simple key-value pair. map[string, string] No - -
status - object Yes - -
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 - -
type The Translation Service to use for this Translator. string No - -

Status.status

Back to Translator status

Field Description Type Required Default Enum
async Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first. object No - -
conditions - list[object] No - -
createdAt - string (date-time) No - -
deletedAt - string (date-time) No - -
message - string No - -
ocid - string No - -
opcRequestId OpcRequestID is the latest non-empty OCI request ID from a mutating OCI response or surfaced OCI service error that materially contributed to the current shared status projection. Headerless follow-up observations keep the last non-empty value intact. string No - -
reason - string No - -
requestedAt - string (date-time) No - -
updatedAt - string (date-time) No - -

Status.status.async

Back to Translator status

Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first.

Field Description Type Required Default Enum
current - object No - -

Status.status.async.current

Back to Translator status

Field Description Type Required Default Enum
message - string No - -
normalizedClass - string Yes - attention, canceled, failed, pending, succeeded, unknown
percentComplete - number No - -
phase - string Yes - create, delete, update
rawOperationType - string No - -
rawStatus - string No - -
source - string Yes - lifecycle, none, workrequest
updatedAt - string (date-time) Yes - -
workRequestId - string No - -

Status.status.conditions[]

Back to Translator status

Field Description Type Required Default Enum
lastTransitionTime - string (date-time) No - -
message - string No - -
reason - string No - -
status - string Yes - -
type - string Yes - -