OdaInstanceSummary¶
-
class
oci.oda.models.
OdaInstanceSummary
(**kwargs)¶ Bases:
object
Summary of the Digital Assistant instance.
Attributes
LIFECYCLE_STATE_ACTIVE
A constant which can be used with the lifecycle_state property of a OdaInstanceSummary. LIFECYCLE_STATE_CREATING
A constant which can be used with the lifecycle_state property of a OdaInstanceSummary. LIFECYCLE_STATE_DELETED
A constant which can be used with the lifecycle_state property of a OdaInstanceSummary. LIFECYCLE_STATE_DELETING
A constant which can be used with the lifecycle_state property of a OdaInstanceSummary. LIFECYCLE_STATE_FAILED
A constant which can be used with the lifecycle_state property of a OdaInstanceSummary. LIFECYCLE_STATE_INACTIVE
A constant which can be used with the lifecycle_state property of a OdaInstanceSummary. LIFECYCLE_STATE_UPDATING
A constant which can be used with the lifecycle_state property of a OdaInstanceSummary. LIFECYCLE_SUB_STATE_CHANGING_COMPARTMENT
A constant which can be used with the lifecycle_sub_state property of a OdaInstanceSummary. LIFECYCLE_SUB_STATE_CREATING
A constant which can be used with the lifecycle_sub_state property of a OdaInstanceSummary. LIFECYCLE_SUB_STATE_DELETE_PENDING
A constant which can be used with the lifecycle_sub_state property of a OdaInstanceSummary. LIFECYCLE_SUB_STATE_DELETING
A constant which can be used with the lifecycle_sub_state property of a OdaInstanceSummary. LIFECYCLE_SUB_STATE_PURGING
A constant which can be used with the lifecycle_sub_state property of a OdaInstanceSummary. LIFECYCLE_SUB_STATE_QUEUED
A constant which can be used with the lifecycle_sub_state property of a OdaInstanceSummary. LIFECYCLE_SUB_STATE_RECOVERING
A constant which can be used with the lifecycle_sub_state property of a OdaInstanceSummary. LIFECYCLE_SUB_STATE_STARTING
A constant which can be used with the lifecycle_sub_state property of a OdaInstanceSummary. LIFECYCLE_SUB_STATE_STOPPING
A constant which can be used with the lifecycle_sub_state property of a OdaInstanceSummary. SHAPE_NAME_DEVELOPMENT
A constant which can be used with the shape_name property of a OdaInstanceSummary. SHAPE_NAME_PRODUCTION
A constant which can be used with the shape_name property of a OdaInstanceSummary. compartment_id
[Required] Gets the compartment_id of this OdaInstanceSummary. defined_tags
Gets the defined_tags of this OdaInstanceSummary. description
Gets the description of this OdaInstanceSummary. display_name
Gets the display_name of this OdaInstanceSummary. freeform_tags
Gets the freeform_tags of this OdaInstanceSummary. id
[Required] Gets the id of this OdaInstanceSummary. lifecycle_state
[Required] Gets the lifecycle_state of this OdaInstanceSummary. lifecycle_sub_state
Gets the lifecycle_sub_state of this OdaInstanceSummary. shape_name
Gets the shape_name of this OdaInstanceSummary. state_message
Gets the state_message of this OdaInstanceSummary. time_created
Gets the time_created of this OdaInstanceSummary. time_updated
Gets the time_updated of this OdaInstanceSummary. Methods
__init__
(**kwargs)Initializes a new OdaInstanceSummary object with values from keyword arguments. -
LIFECYCLE_STATE_ACTIVE
= 'ACTIVE'¶ A constant which can be used with the lifecycle_state property of a OdaInstanceSummary. This constant has a value of “ACTIVE”
-
LIFECYCLE_STATE_CREATING
= 'CREATING'¶ A constant which can be used with the lifecycle_state property of a OdaInstanceSummary. This constant has a value of “CREATING”
-
LIFECYCLE_STATE_DELETED
= 'DELETED'¶ A constant which can be used with the lifecycle_state property of a OdaInstanceSummary. This constant has a value of “DELETED”
-
LIFECYCLE_STATE_DELETING
= 'DELETING'¶ A constant which can be used with the lifecycle_state property of a OdaInstanceSummary. This constant has a value of “DELETING”
-
LIFECYCLE_STATE_FAILED
= 'FAILED'¶ A constant which can be used with the lifecycle_state property of a OdaInstanceSummary. This constant has a value of “FAILED”
-
LIFECYCLE_STATE_INACTIVE
= 'INACTIVE'¶ A constant which can be used with the lifecycle_state property of a OdaInstanceSummary. This constant has a value of “INACTIVE”
-
LIFECYCLE_STATE_UPDATING
= 'UPDATING'¶ A constant which can be used with the lifecycle_state property of a OdaInstanceSummary. This constant has a value of “UPDATING”
-
LIFECYCLE_SUB_STATE_CHANGING_COMPARTMENT
= 'CHANGING_COMPARTMENT'¶ A constant which can be used with the lifecycle_sub_state property of a OdaInstanceSummary. 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 OdaInstanceSummary. This constant has a value of “CREATING”
-
LIFECYCLE_SUB_STATE_DELETE_PENDING
= 'DELETE_PENDING'¶ A constant which can be used with the lifecycle_sub_state property of a OdaInstanceSummary. 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 OdaInstanceSummary. 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 OdaInstanceSummary. 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 OdaInstanceSummary. 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 OdaInstanceSummary. 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 OdaInstanceSummary. 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 OdaInstanceSummary. This constant has a value of “STOPPING”
-
SHAPE_NAME_DEVELOPMENT
= 'DEVELOPMENT'¶ A constant which can be used with the shape_name property of a OdaInstanceSummary. This constant has a value of “DEVELOPMENT”
-
SHAPE_NAME_PRODUCTION
= 'PRODUCTION'¶ A constant which can be used with the shape_name property of a OdaInstanceSummary. This constant has a value of “PRODUCTION”
-
__init__
(**kwargs)¶ Initializes a new OdaInstanceSummary 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 OdaInstanceSummary.
- display_name (str) – The value to assign to the display_name property of this OdaInstanceSummary.
- description (str) – The value to assign to the description property of this OdaInstanceSummary.
- compartment_id (str) – The value to assign to the compartment_id property of this OdaInstanceSummary.
- shape_name (str) – The value to assign to the shape_name property of this OdaInstanceSummary. 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’.
- time_created (datetime) – The value to assign to the time_created property of this OdaInstanceSummary.
- time_updated (datetime) – The value to assign to the time_updated property of this OdaInstanceSummary.
- lifecycle_state (str) – The value to assign to the lifecycle_state property of this OdaInstanceSummary. 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 OdaInstanceSummary. Allowed values for this property are: “CREATING”, “STARTING”, “STOPPING”, “CHANGING_COMPARTMENT”, “DELETING”, “DELETE_PENDING”, “RECOVERING”, “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 OdaInstanceSummary.
- freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this OdaInstanceSummary.
- defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this OdaInstanceSummary.
-
compartment_id
¶ [Required] Gets the compartment_id of this OdaInstanceSummary. Identifier of the compartment that the instance belongs to.
Returns: The compartment_id of this OdaInstanceSummary. Return type: str
Gets the defined_tags of this OdaInstanceSummary. Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {“foo-namespace”: {“bar-key”: “value”}}
Returns: The defined_tags of this OdaInstanceSummary. Return type: dict(str, dict(str, object))
-
description
¶ Gets the description of this OdaInstanceSummary. Description of the Digital Assistant instance.
Returns: The description of this OdaInstanceSummary. Return type: str
-
display_name
¶ Gets the display_name of this OdaInstanceSummary. User-defined name for the Digital Assistant instance. You can change this value.
Returns: The display_name of this OdaInstanceSummary. Return type: str
Gets the freeform_tags of this OdaInstanceSummary. Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {“bar-key”: “value”}
Returns: The freeform_tags of this OdaInstanceSummary. Return type: dict(str, str)
-
id
¶ [Required] Gets the id of this OdaInstanceSummary. Unique identifier of the Digital Assistant instance.
Returns: The id of this OdaInstanceSummary. Return type: str
-
lifecycle_state
¶ [Required] Gets the lifecycle_state of this OdaInstanceSummary. The current state of the 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 OdaInstanceSummary. Return type: str
-
lifecycle_sub_state
¶ Gets the lifecycle_sub_state of this OdaInstanceSummary. The current sub-state of the Digital Assistant instance.
Allowed values for this property are: “CREATING”, “STARTING”, “STOPPING”, “CHANGING_COMPARTMENT”, “DELETING”, “DELETE_PENDING”, “RECOVERING”, “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 OdaInstanceSummary. Return type: str
-
shape_name
¶ Gets the shape_name of this OdaInstanceSummary. 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 OdaInstanceSummary. Return type: str
-
state_message
¶ Gets the state_message of this OdaInstanceSummary. A message describing 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 OdaInstanceSummary. Return type: str
-