Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace OdaInstance

Description of {@code OdaServiceInstance} object.

Properties

Optional attachmentIds

attachmentIds: Array<string>

A list of attachment identifiers for this instance (if any). Use GetOdaInstanceAttachment to get the details of the attachments.

Optional attachmentTypes

attachmentTypes: Array<string>

A list of attachment types for this instance (if any). Use attachmentIds to get the details of the attachments.

compartmentId

compartmentId: string

Identifier of the compartment that the instance belongs to.

Optional connectorUrl

connectorUrl: undefined | string

URL for the connector's endpoint.

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. Avoid entering confidential information. 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 immutable identifier that was assigned when the instance was created.

Optional identityAppConsoleUrl

identityAppConsoleUrl: undefined | string

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.

Optional identityAppGuid

identityAppGuid: undefined | string

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.

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 importedPackageIds

importedPackageIds: Array<string>

A list of package ids imported into this instance (if any). Use GetImportedPackage to get the details of the imported packages.

Optional importedPackageNames

importedPackageNames: Array<string>

A list of package names imported into this instance (if any). Use importedPackageIds field to get the details of the imported packages.

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)

Optional lifecycleState

lifecycleState: LifecycleState

The current state of the Digital Assistant instance.

Optional lifecycleSubState

lifecycleSubState: LifecycleSubState

The current sub-state of the Digital Assistant instance.

Optional restrictedOperations

restrictedOperations: Array<RestrictedOperation>

A list of restricted operations (across all attachments) for this instance (if any). Use GetOdaInstanceAttachment to get the details of the attachments.

shapeName

shapeName: ShapeName

Shape or size of the instance.

Optional stateMessage

stateMessage: undefined | string

A message that describes 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 Assistance instance was last updated. A date-time string as described in RFC 3339, section 14.29.

Optional webAppUrl

webAppUrl: undefined | string

URL for the Digital Assistant web application that's associated with the instance.

Functions

getDeserializedJsonObj

getJsonObj