CatalogSummary¶
- class oci.data_catalog.models.CatalogSummary(**kwargs)¶
Bases:
objectSummary of the data catalog.
Attributes:
A constant which can be used with the lifecycle_state property of a CatalogSummary.
A constant which can be used with the lifecycle_state property of a CatalogSummary.
A constant which can be used with the lifecycle_state property of a CatalogSummary.
A constant which can be used with the lifecycle_state property of a CatalogSummary.
A constant which can be used with the lifecycle_state property of a CatalogSummary.
A constant which can be used with the lifecycle_state property of a CatalogSummary.
A constant which can be used with the lifecycle_state property of a CatalogSummary.
A constant which can be used with the lifecycle_state property of a CatalogSummary.
Gets the attached_catalog_private_endpoints of this CatalogSummary.
[Required] Gets the compartment_id of this CatalogSummary.
Gets the defined_tags of this CatalogSummary.
Gets the display_name of this CatalogSummary.
Gets the freeform_tags of this CatalogSummary.
[Required] Gets the id of this CatalogSummary.
Gets the lifecycle_details of this CatalogSummary.
Gets the lifecycle_state of this CatalogSummary.
Gets the locks of this CatalogSummary.
Gets the number_of_objects of this CatalogSummary.
Gets the system_tags of this CatalogSummary.
Gets the time_created of this CatalogSummary.
Gets the time_updated of this CatalogSummary.
Methods:
__init__(**kwargs)Initializes a new CatalogSummary object with values from keyword arguments.
- LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶
A constant which can be used with the lifecycle_state property of a CatalogSummary. This constant has a value of “ACTIVE”
- LIFECYCLE_STATE_CREATING = 'CREATING'¶
A constant which can be used with the lifecycle_state property of a CatalogSummary. This constant has a value of “CREATING”
- LIFECYCLE_STATE_DELETED = 'DELETED'¶
A constant which can be used with the lifecycle_state property of a CatalogSummary. This constant has a value of “DELETED”
- LIFECYCLE_STATE_DELETING = 'DELETING'¶
A constant which can be used with the lifecycle_state property of a CatalogSummary. This constant has a value of “DELETING”
- LIFECYCLE_STATE_FAILED = 'FAILED'¶
A constant which can be used with the lifecycle_state property of a CatalogSummary. This constant has a value of “FAILED”
- LIFECYCLE_STATE_INACTIVE = 'INACTIVE'¶
A constant which can be used with the lifecycle_state property of a CatalogSummary. This constant has a value of “INACTIVE”
- LIFECYCLE_STATE_MOVING = 'MOVING'¶
A constant which can be used with the lifecycle_state property of a CatalogSummary. This constant has a value of “MOVING”
- LIFECYCLE_STATE_UPDATING = 'UPDATING'¶
A constant which can be used with the lifecycle_state property of a CatalogSummary. This constant has a value of “UPDATING”
- __init__(**kwargs)¶
Initializes a new CatalogSummary 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 CatalogSummary.
display_name (str) – The value to assign to the display_name property of this CatalogSummary.
compartment_id (str) – The value to assign to the compartment_id property of this CatalogSummary.
time_created (datetime) – The value to assign to the time_created property of this CatalogSummary.
time_updated (datetime) – The value to assign to the time_updated property of this CatalogSummary.
number_of_objects (int) – The value to assign to the number_of_objects property of this CatalogSummary.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this CatalogSummary. Allowed values for this property are: “CREATING”, “ACTIVE”, “INACTIVE”, “UPDATING”, “DELETING”, “DELETED”, “FAILED”, “MOVING”, ‘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 CatalogSummary.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this CatalogSummary.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this CatalogSummary.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this CatalogSummary.
attached_catalog_private_endpoints (list[str]) – The value to assign to the attached_catalog_private_endpoints property of this CatalogSummary.
locks (list[oci.data_catalog.models.ResourceLock]) – The value to assign to the locks property of this CatalogSummary.
- property attached_catalog_private_endpoints¶
Gets the attached_catalog_private_endpoints of this CatalogSummary. The list of private reverse connection endpoints attached to the catalog
- Returns
The attached_catalog_private_endpoints of this CatalogSummary.
- Return type
list[str]
- property compartment_id¶
[Required] Gets the compartment_id of this CatalogSummary. Compartment identifier.
- Returns
The compartment_id of this CatalogSummary.
- Return type
str
- property defined_tags¶
Gets the defined_tags of this CatalogSummary. Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {“foo-namespace”: {“bar-key”: “value”}}
- Returns
The defined_tags of this CatalogSummary.
- Return type
dict(str, dict(str, object))
- property display_name¶
Gets the display_name of this CatalogSummary. Data catalog identifier, that can be renamed.
- Returns
The display_name of this CatalogSummary.
- Return type
str
- property freeform_tags¶
Gets the freeform_tags of this CatalogSummary. 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 CatalogSummary.
- Return type
dict(str, str)
- property id¶
[Required] Gets the id of this CatalogSummary. Unique identifier that is immutable on creation.
- Returns
The id of this CatalogSummary.
- Return type
str
- property lifecycle_details¶
Gets the lifecycle_details of this CatalogSummary. An message describing the current state in more detail. For example, can be used to provide actionable information for a resource in ‘Failed’ state.
- Returns
The lifecycle_details of this CatalogSummary.
- Return type
str
- property lifecycle_state¶
Gets the lifecycle_state of this CatalogSummary. The current state of the data catalog resource.
Allowed values for this property are: “CREATING”, “ACTIVE”, “INACTIVE”, “UPDATING”, “DELETING”, “DELETED”, “FAILED”, “MOVING”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- Returns
The lifecycle_state of this CatalogSummary.
- Return type
str
- property locks¶
Gets the locks of this CatalogSummary. Locks associated with this resource.
- Returns
The locks of this CatalogSummary.
- Return type
- property number_of_objects¶
Gets the number_of_objects of this CatalogSummary. The number of high level objects added to the data catalog.
- Returns
The number_of_objects of this CatalogSummary.
- Return type
int
- property system_tags¶
Gets the system_tags of this CatalogSummary. System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. System tags can be viewed by users, but can only be created by the system.
Example: {“orcl-cloud”: {“free-tier-retained”: “true”}}
- Returns
The system_tags of this CatalogSummary.
- Return type
dict(str, dict(str, object))