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_DELETE_PENDING 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.
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.
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.
lifecycle_state Gets the lifecycle_state of this OdaInstance.
lifecycle_sub_state Gets the lifecycle_sub_state 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_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_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”

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: “DELETE_PENDING”, “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.
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
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: “DELETE_PENDING”, “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
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