GlossarySummary¶

class oci.data_catalog.models.GlossarySummary(**kwargs)¶

Bases: object

Summary of a glossary. A glossary of business terms, such as ‘Customer’, ‘Account’, ‘Contact’, ‘Address’, or ‘Product’, with definitions, used to provide common meaning across disparate data assets. Business glossaries may be hierarchical where some terms may contain child terms to allow them to be used as ‘taxonomies’. By linking data assets, data entities, and attributes to glossaries and glossary terms, the glossary can act as a way of organizing data catalog objects in a hierarchy to make a large number of objects more navigable and easier to consume. Objects in the data catalog, such as data assets or data entities, may be linked to any level in the glossary, so that the glossary can be used to browse the available data according to the business model of the organization.

Attributes

`LIFECYCLE_STATE_ACTIVE`	A constant which can be used with the lifecycle_state property of a GlossarySummary.
`LIFECYCLE_STATE_CREATING`	A constant which can be used with the lifecycle_state property of a GlossarySummary.
`LIFECYCLE_STATE_DELETED`	A constant which can be used with the lifecycle_state property of a GlossarySummary.
`LIFECYCLE_STATE_DELETING`	A constant which can be used with the lifecycle_state property of a GlossarySummary.
`LIFECYCLE_STATE_FAILED`	A constant which can be used with the lifecycle_state property of a GlossarySummary.
`LIFECYCLE_STATE_INACTIVE`	A constant which can be used with the lifecycle_state property of a GlossarySummary.
`LIFECYCLE_STATE_MOVING`	A constant which can be used with the lifecycle_state property of a GlossarySummary.
`LIFECYCLE_STATE_UPDATING`	A constant which can be used with the lifecycle_state property of a GlossarySummary.
`WORKFLOW_STATUS_APPROVED`	A constant which can be used with the workflow_status property of a GlossarySummary.
`WORKFLOW_STATUS_ESCALATED`	A constant which can be used with the workflow_status property of a GlossarySummary.
`WORKFLOW_STATUS_NEW`	A constant which can be used with the workflow_status property of a GlossarySummary.
`WORKFLOW_STATUS_UNDER_REVIEW`	A constant which can be used with the workflow_status property of a GlossarySummary.
`catalog_id`	Gets the catalog_id of this GlossarySummary.
`description`	Gets the description of this GlossarySummary.
`display_name`	Gets the display_name of this GlossarySummary.
`import_job_definition_key`	Gets the import_job_definition_key of this GlossarySummary.
`import_job_key`	Gets the import_job_key of this GlossarySummary.
`key`	[Required] Gets the key of this GlossarySummary.
`latest_import_job_execution_key`	Gets the latest_import_job_execution_key of this GlossarySummary.
`latest_import_job_execution_status`	Gets the latest_import_job_execution_status of this GlossarySummary.
`lifecycle_state`	Gets the lifecycle_state of this GlossarySummary.
`time_created`	Gets the time_created of this GlossarySummary.
`uri`	Gets the uri of this GlossarySummary.
`workflow_status`	Gets the workflow_status of this GlossarySummary.

Methods

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

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶: A constant which can be used with the lifecycle_state property of a GlossarySummary. This constant has a value of “ACTIVE”

LIFECYCLE_STATE_CREATING = 'CREATING'¶: A constant which can be used with the lifecycle_state property of a GlossarySummary. This constant has a value of “CREATING”

LIFECYCLE_STATE_DELETED = 'DELETED'¶: A constant which can be used with the lifecycle_state property of a GlossarySummary. This constant has a value of “DELETED”

LIFECYCLE_STATE_DELETING = 'DELETING'¶: A constant which can be used with the lifecycle_state property of a GlossarySummary. This constant has a value of “DELETING”

LIFECYCLE_STATE_FAILED = 'FAILED'¶: A constant which can be used with the lifecycle_state property of a GlossarySummary. This constant has a value of “FAILED”

LIFECYCLE_STATE_INACTIVE = 'INACTIVE'¶: A constant which can be used with the lifecycle_state property of a GlossarySummary. This constant has a value of “INACTIVE”

LIFECYCLE_STATE_MOVING = 'MOVING'¶: A constant which can be used with the lifecycle_state property of a GlossarySummary. This constant has a value of “MOVING”

LIFECYCLE_STATE_UPDATING = 'UPDATING'¶: A constant which can be used with the lifecycle_state property of a GlossarySummary. This constant has a value of “UPDATING”

WORKFLOW_STATUS_APPROVED = 'APPROVED'¶: A constant which can be used with the workflow_status property of a GlossarySummary. This constant has a value of “APPROVED”

WORKFLOW_STATUS_ESCALATED = 'ESCALATED'¶: A constant which can be used with the workflow_status property of a GlossarySummary. This constant has a value of “ESCALATED”

WORKFLOW_STATUS_NEW = 'NEW'¶: A constant which can be used with the workflow_status property of a GlossarySummary. This constant has a value of “NEW”

WORKFLOW_STATUS_UNDER_REVIEW = 'UNDER_REVIEW'¶: A constant which can be used with the workflow_status property of a GlossarySummary. This constant has a value of “UNDER_REVIEW”

__init__(**kwargs)¶

Initializes a new GlossarySummary object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:

key (str) – The value to assign to the key property of this GlossarySummary.
display_name (str) – The value to assign to the display_name property of this GlossarySummary.
catalog_id (str) – The value to assign to the catalog_id property of this GlossarySummary.
time_created (datetime) – The value to assign to the time_created property of this GlossarySummary.
description (str) – The value to assign to the description property of this GlossarySummary.
uri (str) – The value to assign to the uri property of this GlossarySummary.
workflow_status (str) – The value to assign to the workflow_status property of this GlossarySummary. Allowed values for this property are: “NEW”, “APPROVED”, “UNDER_REVIEW”, “ESCALATED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this GlossarySummary. 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’.
import_job_definition_key (str) – The value to assign to the import_job_definition_key property of this GlossarySummary.
import_job_key (str) – The value to assign to the import_job_key property of this GlossarySummary.
latest_import_job_execution_key (str) – The value to assign to the latest_import_job_execution_key property of this GlossarySummary.
latest_import_job_execution_status (str) – The value to assign to the latest_import_job_execution_status property of this GlossarySummary.

catalog_id¶

Gets the catalog_id of this GlossarySummary. The data catalog’s OCID.

Returns:	The catalog_id of this GlossarySummary.
Return type:	str

description¶

Gets the description of this GlossarySummary. Detailed description of the glossary.

Returns:	The description of this GlossarySummary.
Return type:	str

display_name¶

Gets the display_name of this GlossarySummary. A user-friendly display name. Does not have to be unique, and it’s changeable. Avoid entering confidential information.

Returns:	The display_name of this GlossarySummary.
Return type:	str

import_job_definition_key¶

Gets the import_job_definition_key of this GlossarySummary. The unique key of the job definition resource that was used in the Glossary import.

Returns:	The import_job_definition_key of this GlossarySummary.
Return type:	str

import_job_key¶

Gets the import_job_key of this GlossarySummary. The unique key of the job policy for Glossary import.

Returns:	The import_job_key of this GlossarySummary.
Return type:	str

key¶

[Required] Gets the key of this GlossarySummary. Unique glossary key that is immutable.

Returns:	The key of this GlossarySummary.
Return type:	str

latest_import_job_execution_key¶

Gets the latest_import_job_execution_key of this GlossarySummary. The unique key of the parent job execution for which the log resource was created.

Returns:	The latest_import_job_execution_key of this GlossarySummary.
Return type:	str

latest_import_job_execution_status¶

Gets the latest_import_job_execution_status of this GlossarySummary. Status of the latest glossary import job execution, such as running, paused, or completed. This may include additional information like time import started , import file size and % of completion

Returns:	The latest_import_job_execution_status of this GlossarySummary.
Return type:	str

lifecycle_state¶

Gets the lifecycle_state of this GlossarySummary. State of the Glossary.

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 GlossarySummary.
Return type:	str

time_created¶

Gets the time_created of this GlossarySummary. The date and time the glossary was created, in the format defined by RFC3339. Example: 2019-03-25T21:10:29.600Z

Returns:	The time_created of this GlossarySummary.
Return type:	datetime

uri¶

Gets the uri of this GlossarySummary. URI to the glossary instance in the API.

Returns:	The uri of this GlossarySummary.
Return type:	str

workflow_status¶

Gets the workflow_status of this GlossarySummary. Status of the approval process workflow for this business glossary.

Allowed values for this property are: “NEW”, “APPROVED”, “UNDER_REVIEW”, “ESCALATED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The workflow_status of this GlossarySummary.
Return type:	str