Package com.oracle.bmc.datacatalog.model

Class GlossarySummary

java.lang.Object

com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

com.oracle.bmc.datacatalog.model.GlossarySummary

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20190325")
public final class GlossarySummary
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

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 GlossarySummary.Builder.__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take the explicitly set fields into account. The constructor, on the other hand, does not take the explicitly set fields into account (since the constructor cannot distinguish explicit null from unset null).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GlossarySummary.Builder

Field Summary

Fields inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static GlossarySummary.Builder	builder()	Create a new builder.
boolean	equals(Object o)
String	getCatalogId()	The data catalog’s OCID.
String	getDescription()	Detailed description of the glossary.
String	getDisplayName()	A user-friendly display name.
String	getImportJobDefinitionKey()	The unique key of the job definition resource that was used in the Glossary import.
String	getImportJobKey()	The unique key of the job policy for Glossary import.
String	getKey()	Unique glossary key that is immutable.
String	getLatestImportJobExecutionKey()	The unique key of the parent job execution for which the log resource was created.
String	getLatestImportJobExecutionStatus()	Status of the latest glossary import job execution, such as running, paused, or completed.
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()
GlossarySummary.Builder	toBuilder()
String	toString()
String	toString(boolean includeByteArrayContents)	Return a string representation of the object.

Methods inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

markPropertyAsExplicitlySet, wasPropertyExplicitlySet

Methods inherited from class java.lang.Object

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

Constructor Detail

GlossarySummary

@Deprecated
@ConstructorProperties({"key","displayName","catalogId","timeCreated","description","uri","workflowStatus","lifecycleState","importJobDefinitionKey","importJobKey","latestImportJobExecutionKey","latestImportJobExecutionStatus"})
public GlossarySummary(String key,
                       String displayName,
                       String catalogId,
                       Date timeCreated,
                       String description,
                       String uri,
                       TermWorkflowStatus workflowStatus,
                       LifecycleState lifecycleState,
                       String importJobDefinitionKey,
                       String importJobKey,
                       String latestImportJobExecutionKey,
                       String latestImportJobExecutionStatus)

Deprecated.

Method Detail

builder

public static GlossarySummary.Builder builder()

Create a new builder.

toBuilder

public GlossarySummary.Builder toBuilder()

getKey

public String getKey()

Unique glossary key that is immutable.

Returns:

the value

getDisplayName

public String getDisplayName()

A user-friendly display name.

Does not have to be unique, and it’s changeable. Avoid entering confidential information.

Returns:

the value

getCatalogId

public String getCatalogId()

The data catalog’s OCID.

Returns:

the value

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

Returns:

the value

getDescription

public String getDescription()

Detailed description of the glossary.

Returns:

the value

getUri

public String getUri()

URI to the glossary instance in the API.

Returns:

the value

getWorkflowStatus

public TermWorkflowStatus getWorkflowStatus()

Status of the approval process workflow for this business glossary.

Returns:

the value

getLifecycleState

public LifecycleState getLifecycleState()

State of the Glossary.

Returns:

the value

getImportJobDefinitionKey

public String getImportJobDefinitionKey()

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

Returns:

the value

getImportJobKey

public String getImportJobKey()

The unique key of the job policy for Glossary import.

Returns:

the value

getLatestImportJobExecutionKey

public String getLatestImportJobExecutionKey()

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

Returns:

the value

getLatestImportJobExecutionStatus

public String getLatestImportJobExecutionStatus()

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 value

toString

public String toString()

Overrides:

toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

toString

public String toString(boolean includeByteArrayContents)

Return a string representation of the object.

Parameters:

includeByteArrayContents - true to include the full contents of byte arrays

Returns:

string representation

equals

public boolean equals(Object o)

Overrides:

equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

hashCode

public int hashCode()

Overrides:

hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel