KnowledgeBaseSummary

class oci.adm.models.KnowledgeBaseSummary(**kwargs)

Bases: object

The summary of a knowledge base.

Methods

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

Attributes

compartment_id [Required] Gets the compartment_id of this KnowledgeBaseSummary.
defined_tags [Required] Gets the defined_tags of this KnowledgeBaseSummary.
display_name [Required] Gets the display_name of this KnowledgeBaseSummary.
freeform_tags [Required] Gets the freeform_tags of this KnowledgeBaseSummary.
id [Required] Gets the id of this KnowledgeBaseSummary.
lifecycle_state [Required] Gets the lifecycle_state of this KnowledgeBaseSummary.
system_tags Gets the system_tags of this KnowledgeBaseSummary.
time_created [Required] Gets the time_created of this KnowledgeBaseSummary.
time_updated [Required] Gets the time_updated of this KnowledgeBaseSummary.
__init__(**kwargs)

Initializes a new KnowledgeBaseSummary 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 KnowledgeBaseSummary.
  • display_name (str) – The value to assign to the display_name property of this KnowledgeBaseSummary.
  • time_created (datetime) – The value to assign to the time_created property of this KnowledgeBaseSummary.
  • time_updated (datetime) – The value to assign to the time_updated property of this KnowledgeBaseSummary.
  • compartment_id (str) – The value to assign to the compartment_id property of this KnowledgeBaseSummary.
  • lifecycle_state (str) – The value to assign to the lifecycle_state property of this KnowledgeBaseSummary.
  • freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this KnowledgeBaseSummary.
  • defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this KnowledgeBaseSummary.
  • system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this KnowledgeBaseSummary.
compartment_id

[Required] Gets the compartment_id of this KnowledgeBaseSummary. The compartment Oracle Cloud Identifier (OCID) of the knowledge base.

Returns:The compartment_id of this KnowledgeBaseSummary.
Return type:str
defined_tags

[Required] Gets the defined_tags of this KnowledgeBaseSummary. Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {“foo-namespace”: {“bar-key”: “value”}}

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

[Required] Gets the display_name of this KnowledgeBaseSummary. The name of the knowledge base.

Returns:The display_name of this KnowledgeBaseSummary.
Return type:str
freeform_tags

[Required] Gets the freeform_tags of this KnowledgeBaseSummary. 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 KnowledgeBaseSummary.
Return type:dict(str, str)
id

[Required] Gets the id of this KnowledgeBaseSummary. The Oracle Cloud Identifier (OCID) of the knowledge base.

Returns:The id of this KnowledgeBaseSummary.
Return type:str
lifecycle_state

[Required] Gets the lifecycle_state of this KnowledgeBaseSummary. The current lifecycle state of the knowledge base.

Returns:The lifecycle_state of this KnowledgeBaseSummary.
Return type:str
system_tags

Gets the system_tags of this KnowledgeBaseSummary. Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {“orcl-cloud”: {“free-tier-retained”: “true”}}

Returns:The system_tags of this KnowledgeBaseSummary.
Return type:dict(str, dict(str, object))
time_created

[Required] Gets the time_created of this KnowledgeBaseSummary. The creation date and time of the knowledge base (formatted according to RFC3339).

Returns:The time_created of this KnowledgeBaseSummary.
Return type:datetime
time_updated

[Required] Gets the time_updated of this KnowledgeBaseSummary. The date and time the knowledge base was last updated (formatted according to RFC3339).

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