ProjectSummary

class oci.ai_document.models.ProjectSummary(**kwargs)

Bases: object

the metadata about the project.

Methods

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

Attributes

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

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

[Required] Gets the compartment_id of this ProjectSummary. The compartment identifier.

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

Gets the defined_tags of this ProjectSummary. Defined tags for this resource. Each key is predefined and scoped to a namespace. For example: {“foo-namespace”: {“bar-key”: “value”}}

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

Gets the description of this ProjectSummary. An optional description of the project.

Returns:The description of this ProjectSummary.
Return type:str
display_name

Gets the display_name of this ProjectSummary. A human-friendly name for the project, that can be changed.

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

Gets the freeform_tags of this ProjectSummary. A simple key-value pair that is applied without any predefined name, type, or scope. It exists for cross-compatibility only. For example: {“bar-key”: “value”}

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

[Required] Gets the id of this ProjectSummary. A unique identifier that is immutable after creation.

Returns:The id of this ProjectSummary.
Return type:str
lifecycle_details

Gets the lifecycle_details of this ProjectSummary. A message describing the current state in more detail, that can provide actionable information if creation failed.

Returns:The lifecycle_details of this ProjectSummary.
Return type:str
lifecycle_state

[Required] Gets the lifecycle_state of this ProjectSummary. The current state of the project.

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

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

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

[Required] Gets the time_created of this ProjectSummary. When the project was created, as an RFC3339 datetime string.

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

Gets the time_updated of this ProjectSummary. When the project was created, as an RFC3339 datetime string.

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