Class Glossary

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.

Inheritance

object

Glossary

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Oci.DatacatalogService.Models

Assembly: OCI.DotNetSDK.Datacatalog.dll

Syntax

public class Glossary

Properties

CatalogId

Declaration

[JsonProperty(PropertyName = "catalogId")]
public string CatalogId { get; set; }

Property Value

Type	Description
string	The data catalog's OCID.

CreatedById

Declaration

[JsonProperty(PropertyName = "createdById")]
public string CreatedById { get; set; }

Property Value

Type	Description
string	OCID of the user who created this metadata element.

CustomPropertyMembers

Declaration

[JsonProperty(PropertyName = "customPropertyMembers")]
public List<CustomPropertyGetUsage> CustomPropertyMembers { get; set; }

Property Value

Type	Description
List<CustomPropertyGetUsage>	The list of customized properties along with the values for this object

Description

Declaration

[JsonProperty(PropertyName = "description")]
public string Description { get; set; }

Property Value

Type	Description
string	Detailed description of the glossary.

DisplayName

Declaration

[JsonProperty(PropertyName = "displayName")]
public string DisplayName { get; set; }

Property Value

Type	Description
string	A user-friendly display name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

ImportJobDefinitionKey

Declaration

[JsonProperty(PropertyName = "importJobDefinitionKey")]
public string ImportJobDefinitionKey { get; set; }

Property Value

Type	Description
string	The unique key of the job definition resource that was used in the Glossary import.

ImportJobKey

Declaration

[JsonProperty(PropertyName = "importJobKey")]
public string ImportJobKey { get; set; }

Property Value

Type	Description
string	The unique key of the job policy for Glossary import.

Key

Declaration

[Required(ErrorMessage = "Key is required.")]
[JsonProperty(PropertyName = "key")]
public string Key { get; set; }

Property Value

Type	Description
string	Unique glossary key that is immutable.

Remarks

Required

LatestImportJobExecutionKey

Declaration

[JsonProperty(PropertyName = "latestImportJobExecutionKey")]
public string LatestImportJobExecutionKey { get; set; }

Property Value

Type	Description
string	The unique key of the parent job execution for which the log resource was created.

LatestImportJobExecutionStatus

Declaration

[JsonProperty(PropertyName = "latestImportJobExecutionStatus")]
public string LatestImportJobExecutionStatus { get; set; }

Property Value

Type	Description
string	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

LifecycleState

Declaration

[JsonProperty(PropertyName = "lifecycleState")]
[JsonConverter(typeof(ResponseEnumConverter))]
public LifecycleState? LifecycleState { get; set; }

Property Value

Type	Description
LifecycleState?	The current state of the glossary.

Owner

Declaration

[JsonProperty(PropertyName = "owner")]
public string Owner { get; set; }

Property Value

Type	Description
string	OCID of the user who is the owner of the glossary.

TimeCreated

Declaration

[JsonProperty(PropertyName = "timeCreated")]
public DateTime? TimeCreated { get; set; }

Property Value

Type	Description
DateTime?	The date and time the glossary was created, in the format defined by RFC3339. Example: 2019-03-25T21:10:29.600Z

TimeUpdated

Declaration

[JsonProperty(PropertyName = "timeUpdated")]
public DateTime? TimeUpdated { get; set; }

Property Value

Type	Description
DateTime?	The last time that any change was made to the glossary. An RFC3339 formatted datetime string.

UpdatedById

Declaration

[JsonProperty(PropertyName = "updatedById")]
public string UpdatedById { get; set; }

Property Value

Type	Description
string	OCID of the user who updated this metadata element.

Uri

Declaration

[JsonProperty(PropertyName = "uri")]
public string Uri { get; set; }

Property Value

Type	Description
string	URI to the tag instance in the API.

WorkflowStatus

Declaration

[JsonProperty(PropertyName = "workflowStatus")]
[JsonConverter(typeof(ResponseEnumConverter))]
public TermWorkflowStatus? WorkflowStatus { get; set; }

Property Value

Type	Description
TermWorkflowStatus?	Status of the approval process workflow for this business glossary.