com.oracle.bmc.datacatalog.model

Class GlossarySummary

java.lang.Object

com.oracle.bmc.datacatalog.model.GlossarySummary

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20190325")
public final class GlossarySummary
extends 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.

Note: Objects should always be created or deserialized using the GlossarySummary.Builder. This model distinguishes fields that are null because they are unset from fields that are explicitly set to null. This is done in the setter methods of the GlossarySummary.Builder, which maintain a set of all explicitly set fields called __explicitlySet__. The hashCode() and equals(Object) methods are implemented to take __explicitlySet__ into account. The constructor, on the other hand, does not set __explicitlySet__ (since the constructor cannot distinguish explicit null from unset null).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GlossarySummary.Builder

Constructor Summary

Constructors

Constructor and Description
GlossarySummary(String key, String displayName, String catalogId, Date timeCreated, String description, String uri, TermWorkflowStatus workflowStatus, LifecycleState lifecycleState) Deprecated.

Method Summary

Modifier and Type	Method and Description
static GlossarySummary.Builder	builder() Create a new builder.
boolean	equals(Object o)
Set<String>	get__explicitlySet__()
String	getCatalogId() The data catalog’s OCID.
String	getDescription() Detailed description of the glossary.
String	getDisplayName() A user-friendly display name.
String	getKey() Unique glossary key that is immutable.
LifecycleState	getLifecycleState() State of the Glossary.
Date	getTimeCreated() The date and time the glossary was created, in the format defined by RFC3339.
String	getUri() URI to the glossary instance in the API.
TermWorkflowStatus	getWorkflowStatus() Status of the approval process workflow for this business glossary.
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

GlossarySummary

@ConstructorProperties(value={"key","displayName","catalogId","timeCreated","description","uri","workflowStatus","lifecycleState"})
 @Deprecated
public GlossarySummary(String key,
                                                                                                                                                                        String displayName,
                                                                                                                                                                        String catalogId,
                                                                                                                                                                        Date timeCreated,
                                                                                                                                                                        String description,
                                                                                                                                                                        String uri,
                                                                                                                                                                        TermWorkflowStatus workflowStatus,
                                                                                                                                                                        LifecycleState lifecycleState)

Deprecated.

Method Detail

builder

public static GlossarySummary.Builder builder()

Create a new builder.

getKey

public String getKey()

Unique glossary key that is immutable.

getDisplayName

public String getDisplayName()

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

getCatalogId

public String getCatalogId()

The data catalog’s OCID.

getTimeCreated

public Date getTimeCreated()

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

getDescription

public String getDescription()

Detailed description of the glossary.

getUri

public String getUri()

URI to the glossary instance in the API.

getWorkflowStatus

public TermWorkflowStatus getWorkflowStatus()

Status of the approval process workflow for this business glossary.

getLifecycleState

public LifecycleState getLifecycleState()

State of the Glossary.

get__explicitlySet__

public Set<String> get__explicitlySet__()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object