Package com.oracle.bmc.datasafe.model

Class SensitiveColumnSummary

java.lang.Object

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

com.oracle.bmc.datasafe.model.SensitiveColumnSummary

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

Summary of a sensitive column present in a sensitive data model.
Note: Objects should always be created or deserialized using the SensitiveColumnSummary.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 SensitiveColumnSummary.Builder, which maintain a set of all explicitly set fields called SensitiveColumnSummary.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	SensitiveColumnSummary.Builder
static class	SensitiveColumnSummary.ObjectType	The type of the database object that contains the sensitive column.
static class	SensitiveColumnSummary.RelationType	The type of referential relationship the sensitive column has with its parent.
static class	SensitiveColumnSummary.Source	The source of the sensitive column.
static class	SensitiveColumnSummary.Status	The status of the sensitive column.

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

SensitiveColumnSummary(String key, String sensitiveDataModelId, SensitiveColumnLifecycleState lifecycleState, String lifecycleDetails, Date timeCreated, Date timeUpdated, String appName, String schemaName, String objectName, String columnName, SensitiveColumnSummary.ObjectType objectType, String dataType, SensitiveColumnSummary.Status status, String sensitiveTypeId, SensitiveColumnSummary.Source source, List<String> parentColumnKeys, SensitiveColumnSummary.RelationType relationType, Long estimatedDataValueCount, ConfidenceLevelEnum confidenceLevel, List<String> sampleDataValues)

Deprecated.

Method Summary

Modifier and Type	Method	Description
static SensitiveColumnSummary.Builder	builder()	Create a new builder.
boolean	equals(Object o)
String	getAppName()	The name of the application associated with the sensitive column.
String	getColumnName()	The name of the sensitive column.
ConfidenceLevelEnum	getConfidenceLevel()	The confidence level of the sensitive column associated with the sensitive type.
String	getDataType()	The data type of the sensitive column.
Long	getEstimatedDataValueCount()	The estimated number of data values the column has in the associated database.
String	getKey()	The unique key that identifies the sensitive column.
String	getLifecycleDetails()	Details about the current state of the sensitive column.
SensitiveColumnLifecycleState	getLifecycleState()	The current state of the sensitive column.
String	getObjectName()	The database object that contains the sensitive column.
SensitiveColumnSummary.ObjectType	getObjectType()	The type of the database object that contains the sensitive column.
List<String>	getParentColumnKeys()	Unique keys identifying the columns that are parents of the sensitive column.
SensitiveColumnSummary.RelationType	getRelationType()	The type of referential relationship the sensitive column has with its parent.
List<String>	getSampleDataValues()	Original data values collected for the sensitive column from the associated database.
String	getSchemaName()	The database schema that contains the sensitive column.
String	getSensitiveDataModelId()	The OCID of the sensitive data model that contains the sensitive column.
String	getSensitiveTypeId()	The OCID of the sensitive type associated with the sensitive column.
SensitiveColumnSummary.Source	getSource()	The source of the sensitive column.
SensitiveColumnSummary.Status	getStatus()	The status of the sensitive column.
Date	getTimeCreated()	The date and time, in the format defined by RFC3339, the sensitive column was created in the sensitive data model.
Date	getTimeUpdated()	The date and time, in the format defined by RFC3339, the sensitive column was last updated in the sensitive data model.
int	hashCode()
SensitiveColumnSummary.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

SensitiveColumnSummary

@Deprecated
@ConstructorProperties({"key","sensitiveDataModelId","lifecycleState","lifecycleDetails","timeCreated","timeUpdated","appName","schemaName","objectName","columnName","objectType","dataType","status","sensitiveTypeId","source","parentColumnKeys","relationType","estimatedDataValueCount","confidenceLevel","sampleDataValues"})
public SensitiveColumnSummary(String key,
                              String sensitiveDataModelId,
                              SensitiveColumnLifecycleState lifecycleState,
                              String lifecycleDetails,
                              Date timeCreated,
                              Date timeUpdated,
                              String appName,
                              String schemaName,
                              String objectName,
                              String columnName,
                              SensitiveColumnSummary.ObjectType objectType,
                              String dataType,
                              SensitiveColumnSummary.Status status,
                              String sensitiveTypeId,
                              SensitiveColumnSummary.Source source,
                              List<String> parentColumnKeys,
                              SensitiveColumnSummary.RelationType relationType,
                              Long estimatedDataValueCount,
                              ConfidenceLevelEnum confidenceLevel,
                              List<String> sampleDataValues)

Deprecated.

Method Detail

builder

public static SensitiveColumnSummary.Builder builder()

Create a new builder.

toBuilder

public SensitiveColumnSummary.Builder toBuilder()

getKey

public String getKey()

The unique key that identifies the sensitive column.

It’s numeric and unique within a sensitive data model.

Returns:

the value

getSensitiveDataModelId

public String getSensitiveDataModelId()

The OCID of the sensitive data model that contains the sensitive column.

Returns:

the value

getLifecycleState

public SensitiveColumnLifecycleState getLifecycleState()

The current state of the sensitive column.

Returns:

the value

getLifecycleDetails

public String getLifecycleDetails()

Details about the current state of the sensitive column.

Returns:

the value

getTimeCreated

public Date getTimeCreated()

The date and time, in the format defined by RFC3339, the sensitive column was created in the sensitive data model.

Returns:

the value

getTimeUpdated

public Date getTimeUpdated()

The date and time, in the format defined by RFC3339, the sensitive column was last updated in the sensitive data model.

Returns:

the value

getAppName

public String getAppName()

The name of the application associated with the sensitive column.

It’s useful when the application name is different from the schema name. Otherwise, it can be ignored.

Returns:

the value

getSchemaName

public String getSchemaName()

The database schema that contains the sensitive column.

Returns:

the value

getObjectName

public String getObjectName()

The database object that contains the sensitive column.

Returns:

the value

getColumnName

public String getColumnName()

The name of the sensitive column.

Returns:

the value

getObjectType

public SensitiveColumnSummary.ObjectType getObjectType()

The type of the database object that contains the sensitive column.

Returns:

the value

getDataType

public String getDataType()

The data type of the sensitive column.

Returns:

the value

getStatus

public SensitiveColumnSummary.Status getStatus()

The status of the sensitive column.

VALID means the column is considered sensitive. INVALID means the column is not considered sensitive. Tracking invalid columns in a sensitive data model helps ensure that an incremental data discovery job does not identify these columns as sensitive again.

Returns:

the value

getSensitiveTypeId

public String getSensitiveTypeId()

The OCID of the sensitive type associated with the sensitive column.

Returns:

the value

getSource

public SensitiveColumnSummary.Source getSource()

The source of the sensitive column.

DISCOVERY indicates that the column was added to the sensitive data model using a data discovery job. MANUAL indicates that the column was added manually.

Returns:

the value

getParentColumnKeys

public List<String> getParentColumnKeys()

Unique keys identifying the columns that are parents of the sensitive column.

At present, it tracks a single parent only.

Returns:

the value

getRelationType

public SensitiveColumnSummary.RelationType getRelationType()

The type of referential relationship the sensitive column has with its parent.

NONE indicates that the sensitive column does not have a parent. DB_DEFINED indicates that the relationship is defined in the database dictionary. APP_DEFINED indicates that the relationship is defined at the application level and not in the database dictionary.

Returns:

the value

getEstimatedDataValueCount

public Long getEstimatedDataValueCount()

The estimated number of data values the column has in the associated database.

Returns:

the value

getConfidenceLevel

public ConfidenceLevelEnum getConfidenceLevel()

The confidence level of the sensitive column associated with the sensitive type.

The confidence level of the discovered sensitive columns can be either HIGH, MEDIUM or LOW. The confidence level will be NONE for manually added sensitive columns.

Returns:

the value

getSampleDataValues

public List<String> getSampleDataValues()

Original data values collected for the sensitive column from the associated database.

Sample data helps review the column and ensure that it actually contains sensitive data. Note that sample data is retrieved by a data discovery job only if the isSampleDataCollectionEnabled attribute is set to true. At present, only one data value is collected per sensitive column.

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