Project

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

Bases: object

A Document Project containing models.

Attributes:

LIFECYCLE_STATE_ACTIVE

A constant which can be used with the lifecycle_state property of a Project.

LIFECYCLE_STATE_CREATING

A constant which can be used with the lifecycle_state property of a Project.

LIFECYCLE_STATE_DELETED

A constant which can be used with the lifecycle_state property of a Project.

LIFECYCLE_STATE_DELETING

A constant which can be used with the lifecycle_state property of a Project.

LIFECYCLE_STATE_FAILED

A constant which can be used with the lifecycle_state property of a Project.

LIFECYCLE_STATE_UPDATING

A constant which can be used with the lifecycle_state property of a Project.

compartment_id

[Required] Gets the compartment_id of this Project.

defined_tags

Gets the defined_tags of this Project.

description

Gets the description of this Project.

display_name

Gets the display_name of this Project.

freeform_tags

Gets the freeform_tags of this Project.

id

[Required] Gets the id of this Project.

lifecycle_details

Gets the lifecycle_details of this Project.

lifecycle_state

[Required] Gets the lifecycle_state of this Project.

locks

Gets the locks of this Project.

system_tags

Gets the system_tags of this Project.

time_created

[Required] Gets the time_created of this Project.

time_updated

Gets the time_updated of this Project.

Methods:

__init__(**kwargs)

Initializes a new Project object with values from keyword arguments.

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'

A constant which can be used with the lifecycle_state property of a Project. This constant has a value of “ACTIVE”

LIFECYCLE_STATE_CREATING = 'CREATING'

A constant which can be used with the lifecycle_state property of a Project. This constant has a value of “CREATING”

LIFECYCLE_STATE_DELETED = 'DELETED'

A constant which can be used with the lifecycle_state property of a Project. This constant has a value of “DELETED”

LIFECYCLE_STATE_DELETING = 'DELETING'

A constant which can be used with the lifecycle_state property of a Project. This constant has a value of “DELETING”

LIFECYCLE_STATE_FAILED = 'FAILED'

A constant which can be used with the lifecycle_state property of a Project. This constant has a value of “FAILED”

LIFECYCLE_STATE_UPDATING = 'UPDATING'

A constant which can be used with the lifecycle_state property of a Project. This constant has a value of “UPDATING”

__init__(**kwargs)

Initializes a new Project 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 Project.

  • display_name (str) – The value to assign to the display_name property of this Project.

  • description (str) – The value to assign to the description property of this Project.

  • compartment_id (str) – The value to assign to the compartment_id property of this Project.

  • time_created (datetime) – The value to assign to the time_created property of this Project.

  • time_updated (datetime) – The value to assign to the time_updated property of this Project.

  • lifecycle_state (str) – The value to assign to the lifecycle_state property of this Project. Allowed values for this property are: “CREATING”, “UPDATING”, “ACTIVE”, “DELETING”, “DELETED”, “FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

  • lifecycle_details (str) – The value to assign to the lifecycle_details property of this Project.

  • freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this Project.

  • defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this Project.

  • system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this Project.

  • locks (list[oci.ai_document.models.ResourceLock]) – The value to assign to the locks property of this Project.

property compartment_id

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

Returns

The compartment_id of this Project.

Return type

str

property defined_tags

Gets the defined_tags of this Project. 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 Project.

Return type

dict(str, dict(str, object))

property description

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

Returns

The description of this Project.

Return type

str

property display_name

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

Returns

The display_name of this Project.

Return type

str

property freeform_tags

Gets the freeform_tags of this Project. 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 Project.

Return type

dict(str, str)

property id

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

Returns

The id of this Project.

Return type

str

property lifecycle_details

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

Returns

The lifecycle_details of this Project.

Return type

str

property lifecycle_state

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

Allowed values for this property are: “CREATING”, “UPDATING”, “ACTIVE”, “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 Project.

Return type

str

property locks

Gets the locks of this Project. Locks associated with this resource.

Returns

The locks of this Project.

Return type

list[oci.ai_document.models.ResourceLock]

property system_tags

Gets the system_tags of this Project. 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 Project.

Return type

dict(str, dict(str, object))

property time_created

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

Returns

The time_created of this Project.

Return type

datetime

property time_updated

Gets the time_updated of this Project. When the project was updated, as an RFC3339 datetime string.

Returns

The time_updated of this Project.

Return type

datetime