Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace OdaInstanceSummary

Summary of the Digital Assistant instance.

Properties

Optional attachmentTypes

attachmentTypes: Array<string>

A list of attachment types for this instance (if any).

compartmentId

compartmentId: string

Identifier of the compartment that the instance belongs to.

Optional definedTags

definedTags: undefined | object

Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {@code {"foo-namespace": {"bar-key": "value"}}}

Optional description

description: undefined | string

Description of the Digital Assistant instance.

Optional displayName

displayName: undefined | string

User-defined name for the Digital Assistant instance. You can change this value.

Optional freeformTags

freeformTags: undefined | object

Simple key-value pair that is applied without any predefined name, type, or scope. Example: {@code {"bar-key": "value"}}

id

id: string

Unique identifier of the Digital Assistant instance.

Optional identityDomain

identityDomain: undefined | string

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.

Optional importedPackageNames

importedPackageNames: Array<string>

A list of package names imported into this instance (if any).

Optional isRoleBasedAccess

isRoleBasedAccess: undefined | false | true

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)

lifecycleState

lifecycleState: LifecycleState

The current state of the instance.

Optional lifecycleSubState

lifecycleSubState: LifecycleSubState

The current sub-state of the Digital Assistant instance.

Optional shapeName

shapeName: ShapeName

Shape or size of the instance.

Optional stateMessage

stateMessage: undefined | string

A message describing the current state in more detail. For example, actionable information about an instance that's in the {@code FAILED} state.

Optional timeCreated

timeCreated: Date

When the Digital Assistant instance was created. A date-time string as described in RFC 3339, section 14.29.

Optional timeUpdated

timeUpdated: Date

When the Digital Assistant instance was last updated. A date-time string as described in RFC 3339, section 14.29.

Functions

getDeserializedJsonObj

getJsonObj