OdaInstance¶

class oci.oda.models.OdaInstance(**kwargs)¶

Bases: object

Description of OdaServiceInstance object.

Attributes

`LIFECYCLE_STATE_ACTIVE`	A constant which can be used with the lifecycle_state property of a OdaInstance.
`LIFECYCLE_STATE_CREATING`	A constant which can be used with the lifecycle_state property of a OdaInstance.
`LIFECYCLE_STATE_DELETED`	A constant which can be used with the lifecycle_state property of a OdaInstance.
`LIFECYCLE_STATE_DELETING`	A constant which can be used with the lifecycle_state property of a OdaInstance.
`LIFECYCLE_STATE_FAILED`	A constant which can be used with the lifecycle_state property of a OdaInstance.
`LIFECYCLE_STATE_INACTIVE`	A constant which can be used with the lifecycle_state property of a OdaInstance.
`LIFECYCLE_STATE_UPDATING`	A constant which can be used with the lifecycle_state property of a OdaInstance.
`LIFECYCLE_SUB_STATE_ACTIVATING_CUSTOMER_ENCRYPTION_KEY`	A constant which can be used with the lifecycle_sub_state property of a OdaInstance.
`LIFECYCLE_SUB_STATE_CHANGING_COMPARTMENT`	A constant which can be used with the lifecycle_sub_state property of a OdaInstance.
`LIFECYCLE_SUB_STATE_CREATING`	A constant which can be used with the lifecycle_sub_state property of a OdaInstance.
`LIFECYCLE_SUB_STATE_DEACTIVATING_CUSTOMER_ENCRYPTION_KEY`	A constant which can be used with the lifecycle_sub_state property of a OdaInstance.
`LIFECYCLE_SUB_STATE_DELETE_PENDING`	A constant which can be used with the lifecycle_sub_state property of a OdaInstance.
`LIFECYCLE_SUB_STATE_DELETING`	A constant which can be used with the lifecycle_sub_state property of a OdaInstance.
`LIFECYCLE_SUB_STATE_PURGING`	A constant which can be used with the lifecycle_sub_state property of a OdaInstance.
`LIFECYCLE_SUB_STATE_QUEUED`	A constant which can be used with the lifecycle_sub_state property of a OdaInstance.
`LIFECYCLE_SUB_STATE_RECOVERING`	A constant which can be used with the lifecycle_sub_state property of a OdaInstance.
`LIFECYCLE_SUB_STATE_STARTING`	A constant which can be used with the lifecycle_sub_state property of a OdaInstance.
`LIFECYCLE_SUB_STATE_STOPPING`	A constant which can be used with the lifecycle_sub_state property of a OdaInstance.
`LIFECYCLE_SUB_STATE_UPDATING`	A constant which can be used with the lifecycle_sub_state property of a OdaInstance.
`LIFECYCLE_SUB_STATE_UPDATING_CUSTOMER_ENCRYPTION_KEY`	A constant which can be used with the lifecycle_sub_state property of a OdaInstance.
`SHAPE_NAME_DEVELOPMENT`	A constant which can be used with the shape_name property of a OdaInstance.
`SHAPE_NAME_PRODUCTION`	A constant which can be used with the shape_name property of a OdaInstance.
`attachment_ids`	Gets the attachment_ids of this OdaInstance.
`attachment_types`	Gets the attachment_types of this OdaInstance.
`compartment_id`	[Required] Gets the compartment_id of this OdaInstance.
`connector_url`	Gets the connector_url of this OdaInstance.
`defined_tags`	Gets the defined_tags of this OdaInstance.
`description`	Gets the description of this OdaInstance.
`display_name`	Gets the display_name of this OdaInstance.
`freeform_tags`	Gets the freeform_tags of this OdaInstance.
`id`	[Required] Gets the id of this OdaInstance.
`identity_app_console_url`	Gets the identity_app_console_url of this OdaInstance.
`identity_app_guid`	Gets the identity_app_guid of this OdaInstance.
`identity_domain`	Gets the identity_domain of this OdaInstance.
`imported_package_ids`	Gets the imported_package_ids of this OdaInstance.
`imported_package_names`	Gets the imported_package_names of this OdaInstance.
`is_role_based_access`	Gets the is_role_based_access of this OdaInstance.
`lifecycle_state`	Gets the lifecycle_state of this OdaInstance.
`lifecycle_sub_state`	Gets the lifecycle_sub_state of this OdaInstance.
`restricted_operations`	Gets the restricted_operations of this OdaInstance.
`shape_name`	[Required] Gets the shape_name of this OdaInstance.
`state_message`	Gets the state_message of this OdaInstance.
`time_created`	Gets the time_created of this OdaInstance.
`time_updated`	Gets the time_updated of this OdaInstance.
`web_app_url`	Gets the web_app_url of this OdaInstance.

Methods

__init__(**kwargs) Initializes a new OdaInstance object with values from keyword arguments.

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶: A constant which can be used with the lifecycle_state property of a OdaInstance. This constant has a value of “ACTIVE”

LIFECYCLE_STATE_CREATING = 'CREATING'¶: A constant which can be used with the lifecycle_state property of a OdaInstance. This constant has a value of “CREATING”

LIFECYCLE_STATE_DELETED = 'DELETED'¶: A constant which can be used with the lifecycle_state property of a OdaInstance. This constant has a value of “DELETED”

LIFECYCLE_STATE_DELETING = 'DELETING'¶: A constant which can be used with the lifecycle_state property of a OdaInstance. This constant has a value of “DELETING”

LIFECYCLE_STATE_FAILED = 'FAILED'¶: A constant which can be used with the lifecycle_state property of a OdaInstance. This constant has a value of “FAILED”

LIFECYCLE_STATE_INACTIVE = 'INACTIVE'¶: A constant which can be used with the lifecycle_state property of a OdaInstance. This constant has a value of “INACTIVE”

LIFECYCLE_STATE_UPDATING = 'UPDATING'¶: A constant which can be used with the lifecycle_state property of a OdaInstance. This constant has a value of “UPDATING”

LIFECYCLE_SUB_STATE_ACTIVATING_CUSTOMER_ENCRYPTION_KEY = 'ACTIVATING_CUSTOMER_ENCRYPTION_KEY'¶: A constant which can be used with the lifecycle_sub_state property of a OdaInstance. This constant has a value of “ACTIVATING_CUSTOMER_ENCRYPTION_KEY”

LIFECYCLE_SUB_STATE_CHANGING_COMPARTMENT = 'CHANGING_COMPARTMENT'¶: A constant which can be used with the lifecycle_sub_state property of a OdaInstance. This constant has a value of “CHANGING_COMPARTMENT”

LIFECYCLE_SUB_STATE_CREATING = 'CREATING'¶: A constant which can be used with the lifecycle_sub_state property of a OdaInstance. This constant has a value of “CREATING”

LIFECYCLE_SUB_STATE_DEACTIVATING_CUSTOMER_ENCRYPTION_KEY = 'DEACTIVATING_CUSTOMER_ENCRYPTION_KEY'¶: A constant which can be used with the lifecycle_sub_state property of a OdaInstance. This constant has a value of “DEACTIVATING_CUSTOMER_ENCRYPTION_KEY”

LIFECYCLE_SUB_STATE_DELETE_PENDING = 'DELETE_PENDING'¶: A constant which can be used with the lifecycle_sub_state property of a OdaInstance. This constant has a value of “DELETE_PENDING”

LIFECYCLE_SUB_STATE_DELETING = 'DELETING'¶: A constant which can be used with the lifecycle_sub_state property of a OdaInstance. This constant has a value of “DELETING”

LIFECYCLE_SUB_STATE_PURGING = 'PURGING'¶: A constant which can be used with the lifecycle_sub_state property of a OdaInstance. This constant has a value of “PURGING”

LIFECYCLE_SUB_STATE_QUEUED = 'QUEUED'¶: A constant which can be used with the lifecycle_sub_state property of a OdaInstance. This constant has a value of “QUEUED”

LIFECYCLE_SUB_STATE_RECOVERING = 'RECOVERING'¶: A constant which can be used with the lifecycle_sub_state property of a OdaInstance. This constant has a value of “RECOVERING”

LIFECYCLE_SUB_STATE_STARTING = 'STARTING'¶: A constant which can be used with the lifecycle_sub_state property of a OdaInstance. This constant has a value of “STARTING”

LIFECYCLE_SUB_STATE_STOPPING = 'STOPPING'¶: A constant which can be used with the lifecycle_sub_state property of a OdaInstance. This constant has a value of “STOPPING”

LIFECYCLE_SUB_STATE_UPDATING = 'UPDATING'¶: A constant which can be used with the lifecycle_sub_state property of a OdaInstance. This constant has a value of “UPDATING”

LIFECYCLE_SUB_STATE_UPDATING_CUSTOMER_ENCRYPTION_KEY = 'UPDATING_CUSTOMER_ENCRYPTION_KEY'¶: A constant which can be used with the lifecycle_sub_state property of a OdaInstance. This constant has a value of “UPDATING_CUSTOMER_ENCRYPTION_KEY”

SHAPE_NAME_DEVELOPMENT = 'DEVELOPMENT'¶: A constant which can be used with the shape_name property of a OdaInstance. This constant has a value of “DEVELOPMENT”

SHAPE_NAME_PRODUCTION = 'PRODUCTION'¶: A constant which can be used with the shape_name property of a OdaInstance. This constant has a value of “PRODUCTION”

__init__(**kwargs)¶

Initializes a new OdaInstance object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:

id (str) – The value to assign to the id property of this OdaInstance.
display_name (str) – The value to assign to the display_name property of this OdaInstance.
description (str) – The value to assign to the description property of this OdaInstance.
compartment_id (str) – The value to assign to the compartment_id property of this OdaInstance.
shape_name (str) – The value to assign to the shape_name property of this OdaInstance. Allowed values for this property are: “DEVELOPMENT”, “PRODUCTION”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
web_app_url (str) – The value to assign to the web_app_url property of this OdaInstance.
connector_url (str) – The value to assign to the connector_url property of this OdaInstance.
time_created (datetime) – The value to assign to the time_created property of this OdaInstance.
time_updated (datetime) – The value to assign to the time_updated property of this OdaInstance.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this OdaInstance. Allowed values for this property are: “CREATING”, “UPDATING”, “ACTIVE”, “INACTIVE”, “DELETING”, “DELETED”, “FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
lifecycle_sub_state (str) – The value to assign to the lifecycle_sub_state property of this OdaInstance. Allowed values for this property are: “CREATING”, “STARTING”, “STOPPING”, “CHANGING_COMPARTMENT”, “ACTIVATING_CUSTOMER_ENCRYPTION_KEY”, “UPDATING_CUSTOMER_ENCRYPTION_KEY”, “DEACTIVATING_CUSTOMER_ENCRYPTION_KEY”, “DELETING”, “DELETE_PENDING”, “RECOVERING”, “UPDATING”, “PURGING”, “QUEUED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
state_message (str) – The value to assign to the state_message property of this OdaInstance.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this OdaInstance.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this OdaInstance.
is_role_based_access (bool) – The value to assign to the is_role_based_access property of this OdaInstance.
identity_domain (str) – The value to assign to the identity_domain property of this OdaInstance.
identity_app_guid (str) – The value to assign to the identity_app_guid property of this OdaInstance.
identity_app_console_url (str) – The value to assign to the identity_app_console_url property of this OdaInstance.
imported_package_names (list[str]) – The value to assign to the imported_package_names property of this OdaInstance.
imported_package_ids (list[str]) – The value to assign to the imported_package_ids property of this OdaInstance.
attachment_types (list[str]) – The value to assign to the attachment_types property of this OdaInstance.
attachment_ids (list[str]) – The value to assign to the attachment_ids property of this OdaInstance.
restricted_operations (list[oci.oda.models.RestrictedOperation]) – The value to assign to the restricted_operations property of this OdaInstance.

attachment_ids¶

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

Returns:	The attachment_ids of this OdaInstance.
Return type:	list[str]

attachment_types¶

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

Returns:	The attachment_types of this OdaInstance.
Return type:	list[str]

compartment_id¶

[Required] Gets the compartment_id of this OdaInstance. Identifier of the compartment that the instance belongs to.

Returns:	The compartment_id of this OdaInstance.
Return type:	str

connector_url¶

Gets the connector_url of this OdaInstance. URL for the connector’s endpoint.

Returns:	The connector_url of this OdaInstance.
Return type:	str

defined_tags¶

Gets the defined_tags of this OdaInstance. Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {“foo-namespace”: {“bar-key”: “value”}}

Returns:	The defined_tags of this OdaInstance.
Return type:	dict(str, dict(str, object))

description¶

Gets the description of this OdaInstance. Description of the Digital Assistant instance.

Returns:	The description of this OdaInstance.
Return type:	str

display_name¶

Gets the display_name of this OdaInstance. User-defined name for the Digital Assistant instance. Avoid entering confidential information. You can change this value.

Returns:	The display_name of this OdaInstance.
Return type:	str

freeform_tags¶

Gets the freeform_tags of this OdaInstance. Simple key-value pair that is applied without any predefined name, type, or scope. Example: {“bar-key”: “value”}

Returns:	The freeform_tags of this OdaInstance.
Return type:	dict(str, str)

id¶

[Required] Gets the id of this OdaInstance. Unique immutable identifier that was assigned when the instance was created.

Returns:	The id of this OdaInstance.
Return type:	str

identity_app_console_url¶

Gets the identity_app_console_url of this OdaInstance. 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.

Returns:	The identity_app_console_url of this OdaInstance.
Return type:	str

identity_app_guid¶

Gets the identity_app_guid of this OdaInstance. 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.

Returns:	The identity_app_guid of this OdaInstance.
Return type:	str

identity_domain¶

Gets the identity_domain of this OdaInstance. 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.

Returns:	The identity_domain of this OdaInstance.
Return type:	str

imported_package_ids¶

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

Returns:	The imported_package_ids of this OdaInstance.
Return type:	list[str]

imported_package_names¶

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

Returns:	The imported_package_names of this OdaInstance.
Return type:	list[str]

is_role_based_access¶

Gets the is_role_based_access of this OdaInstance. 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)

Returns:	The is_role_based_access of this OdaInstance.
Return type:	bool

lifecycle_state¶

Gets the lifecycle_state of this OdaInstance. The current state of the Digital Assistant instance.

Allowed values for this property are: “CREATING”, “UPDATING”, “ACTIVE”, “INACTIVE”, “DELETING”, “DELETED”, “FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The lifecycle_state of this OdaInstance.
Return type:	str

lifecycle_sub_state¶

Gets the lifecycle_sub_state of this OdaInstance. The current sub-state of the Digital Assistant instance.

Allowed values for this property are: “CREATING”, “STARTING”, “STOPPING”, “CHANGING_COMPARTMENT”, “ACTIVATING_CUSTOMER_ENCRYPTION_KEY”, “UPDATING_CUSTOMER_ENCRYPTION_KEY”, “DEACTIVATING_CUSTOMER_ENCRYPTION_KEY”, “DELETING”, “DELETE_PENDING”, “RECOVERING”, “UPDATING”, “PURGING”, “QUEUED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The lifecycle_sub_state of this OdaInstance.
Return type:	str

restricted_operations¶

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

Returns:	The restricted_operations of this OdaInstance.
Return type:	list[oci.oda.models.RestrictedOperation]

shape_name¶

[Required] Gets the shape_name of this OdaInstance. Shape or size of the instance.

Allowed values for this property are: “DEVELOPMENT”, “PRODUCTION”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The shape_name of this OdaInstance.
Return type:	str

state_message¶

Gets the state_message of this OdaInstance. A message that describes the current state in more detail. For example, actionable information about an instance that’s in the FAILED state.

Returns:	The state_message of this OdaInstance.
Return type:	str

time_created¶

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

Returns:	The time_created of this OdaInstance.
Return type:	datetime

time_updated¶

Gets the time_updated of this OdaInstance. When the Digital Assistance instance was last updated. A date-time string as described in RFC 3339, section 14.29.

Returns:	The time_updated of this OdaInstance.
Return type:	datetime

web_app_url¶

Gets the web_app_url of this OdaInstance. URL for the Digital Assistant web application that’s associated with the instance.

Returns:	The web_app_url of this OdaInstance.
Return type:	str