Glossary

class oci.data_catalog.models.Glossary(**kwargs)

Bases: object

Full glossary details. 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 aatalog, 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 Glossary.

LIFECYCLE_STATE_CREATING

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

LIFECYCLE_STATE_DELETED

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

LIFECYCLE_STATE_DELETING

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

LIFECYCLE_STATE_FAILED

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

LIFECYCLE_STATE_INACTIVE

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

LIFECYCLE_STATE_MOVING

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

LIFECYCLE_STATE_UPDATING

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

WORKFLOW_STATUS_APPROVED

A constant which can be used with the workflow_status property of a Glossary.

WORKFLOW_STATUS_ESCALATED

A constant which can be used with the workflow_status property of a Glossary.

WORKFLOW_STATUS_NEW

A constant which can be used with the workflow_status property of a Glossary.

WORKFLOW_STATUS_UNDER_REVIEW

A constant which can be used with the workflow_status property of a Glossary.

catalog_id

Gets the catalog_id of this Glossary.

created_by_id

Gets the created_by_id of this Glossary.

custom_property_members

Gets the custom_property_members of this Glossary.

description

Gets the description of this Glossary.

display_name

Gets the display_name of this Glossary.

import_job_definition_key

Gets the import_job_definition_key of this Glossary.

import_job_key

Gets the import_job_key of this Glossary.

key

[Required] Gets the key of this Glossary.

latest_import_job_execution_key

Gets the latest_import_job_execution_key of this Glossary.

latest_import_job_execution_status

Gets the latest_import_job_execution_status of this Glossary.

lifecycle_state

Gets the lifecycle_state of this Glossary.

owner

Gets the owner of this Glossary.

time_created

Gets the time_created of this Glossary.

time_updated

Gets the time_updated of this Glossary.

updated_by_id

Gets the updated_by_id of this Glossary.

uri

Gets the uri of this Glossary.

workflow_status

Gets the workflow_status of this Glossary.

Methods:

__init__(**kwargs)

Initializes a new Glossary object with values from keyword arguments.

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'

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

LIFECYCLE_STATE_CREATING = 'CREATING'

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

LIFECYCLE_STATE_DELETED = 'DELETED'

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

LIFECYCLE_STATE_DELETING = 'DELETING'

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

LIFECYCLE_STATE_FAILED = 'FAILED'

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

LIFECYCLE_STATE_INACTIVE = 'INACTIVE'

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

LIFECYCLE_STATE_MOVING = 'MOVING'

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

LIFECYCLE_STATE_UPDATING = 'UPDATING'

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

WORKFLOW_STATUS_APPROVED = 'APPROVED'

A constant which can be used with the workflow_status property of a Glossary. This constant has a value of “APPROVED”

WORKFLOW_STATUS_ESCALATED = 'ESCALATED'

A constant which can be used with the workflow_status property of a Glossary. This constant has a value of “ESCALATED”

WORKFLOW_STATUS_NEW = 'NEW'

A constant which can be used with the workflow_status property of a Glossary. 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 Glossary. This constant has a value of “UNDER_REVIEW”

__init__(**kwargs)

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

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

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

  • catalog_id (str) – The value to assign to the catalog_id property of this Glossary.

  • lifecycle_state (str) – The value to assign to the lifecycle_state property of this 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’.

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

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

  • created_by_id (str) – The value to assign to the created_by_id property of this Glossary.

  • updated_by_id (str) – The value to assign to the updated_by_id property of this Glossary.

  • owner (str) – The value to assign to the owner property of this Glossary.

  • workflow_status (str) – The value to assign to the workflow_status property of this 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’.

  • custom_property_members (list[oci.data_catalog.models.CustomPropertyGetUsage]) – The value to assign to the custom_property_members property of this Glossary.

  • import_job_definition_key (str) – The value to assign to the import_job_definition_key property of this Glossary.

  • import_job_key (str) – The value to assign to the import_job_key property of this Glossary.

  • latest_import_job_execution_key (str) – The value to assign to the latest_import_job_execution_key property of this Glossary.

  • latest_import_job_execution_status (str) – The value to assign to the latest_import_job_execution_status property of this Glossary.

  • uri (str) – The value to assign to the uri property of this Glossary.

property catalog_id

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

Returns

The catalog_id of this Glossary.

Return type

str

property created_by_id

Gets the created_by_id of this Glossary. OCID of the user who created this metadata element.

Returns

The created_by_id of this Glossary.

Return type

str

property custom_property_members

Gets the custom_property_members of this Glossary. The list of customized properties along with the values for this object

Returns

The custom_property_members of this Glossary.

Return type

list[oci.data_catalog.models.CustomPropertyGetUsage]

property description

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

Returns

The description of this Glossary.

Return type

str

property display_name

Gets the display_name of this Glossary. 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 Glossary.

Return type

str

property import_job_definition_key

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

Returns

The import_job_definition_key of this Glossary.

Return type

str

property import_job_key

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

Returns

The import_job_key of this Glossary.

Return type

str

property key

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

Returns

The key of this Glossary.

Return type

str

property latest_import_job_execution_key

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

Returns

The latest_import_job_execution_key of this Glossary.

Return type

str

property latest_import_job_execution_status

Gets the latest_import_job_execution_status of this Glossary. 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 Glossary.

Return type

str

property lifecycle_state

Gets the lifecycle_state of this Glossary. The current 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 Glossary.

Return type

str

property owner

Gets the owner of this Glossary. OCID of the user who is the owner of the glossary.

Returns

The owner of this Glossary.

Return type

str

property time_created

Gets the time_created of this Glossary. 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 Glossary.

Return type

datetime

property time_updated

Gets the time_updated of this Glossary. The last time that any change was made to the glossary. An RFC3339 formatted datetime string.

Returns

The time_updated of this Glossary.

Return type

datetime

property updated_by_id

Gets the updated_by_id of this Glossary. OCID of the user who updated this metadata element.

Returns

The updated_by_id of this Glossary.

Return type

str

property uri

Gets the uri of this Glossary. URI to the tag instance in the API.

Returns

The uri of this Glossary.

Return type

str

property workflow_status

Gets the workflow_status of this Glossary. 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 Glossary.

Return type

str