Class SensitiveColumn
- java.lang.Object
-
- com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
-
- com.oracle.bmc.datasafe.model.SensitiveColumn
-
@Generated(value="OracleSDKGenerator", comments="API Version: 20181201") public final class SensitiveColumn extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
A sensitive column is a resource corresponding to a database column that is considered sensitive.It’s a subresource of sensitive data model resource and is always associated with a sensitive data model. Note that referential relationships are also managed as part of sensitive columns.
Note: Objects should always be created or deserialized using theSensitiveColumn.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 theSensitiveColumn.Builder
, which maintain a set of all explicitly set fields calledSensitiveColumn.Builder.__explicitlySet__
. ThehashCode()
andequals(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
SensitiveColumn.Builder
static class
SensitiveColumn.ObjectType
The type of the database object that contains the sensitive column.static class
SensitiveColumn.RelationType
The type of referential relationship the sensitive column has with its parent.static class
SensitiveColumn.Source
The source of the sensitive column.static class
SensitiveColumn.Status
The status of the sensitive column.
-
Constructor Summary
Constructors Constructor Description SensitiveColumn(String key, String sensitiveDataModelId, Date timeCreated, Date timeUpdated, SensitiveColumnLifecycleState lifecycleState, String lifecycleDetails, String appName, String schemaName, String objectName, String columnName, SensitiveColumn.ObjectType objectType, String dataType, SensitiveColumn.Status status, String sensitiveTypeId, SensitiveColumn.Source source, List<String> parentColumnKeys, SensitiveColumn.RelationType relationType, Long estimatedDataValueCount, List<String> sampleDataValues, List<String> appDefinedChildColumnKeys, List<String> dbDefinedChildColumnKeys, List<String> columnGroups)
Deprecated.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static SensitiveColumn.Builder
builder()
Create a new builder.boolean
equals(Object o)
List<String>
getAppDefinedChildColumnKeys()
Unique keys identifying the columns that are application-level (non-dictionary) children of the sensitive column.String
getAppName()
The name of the application associated with the sensitive column.List<String>
getColumnGroups()
The composite key groups to which the sensitive column belongs.String
getColumnName()
The name of the sensitive column.String
getDataType()
The data type of the sensitive column.List<String>
getDbDefinedChildColumnKeys()
Unique keys identifying the columns that are database-level (dictionary-defined) children 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.SensitiveColumn.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.SensitiveColumn.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.SensitiveColumn.Source
getSource()
The source of the sensitive column.SensitiveColumn.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()
SensitiveColumn.Builder
toBuilder()
String
toString()
String
toString(boolean includeByteArrayContents)
Return a string representation of the object.
-
-
-
Constructor Detail
-
SensitiveColumn
@Deprecated @ConstructorProperties({"key","sensitiveDataModelId","timeCreated","timeUpdated","lifecycleState","lifecycleDetails","appName","schemaName","objectName","columnName","objectType","dataType","status","sensitiveTypeId","source","parentColumnKeys","relationType","estimatedDataValueCount","sampleDataValues","appDefinedChildColumnKeys","dbDefinedChildColumnKeys","columnGroups"}) public SensitiveColumn(String key, String sensitiveDataModelId, Date timeCreated, Date timeUpdated, SensitiveColumnLifecycleState lifecycleState, String lifecycleDetails, String appName, String schemaName, String objectName, String columnName, SensitiveColumn.ObjectType objectType, String dataType, SensitiveColumn.Status status, String sensitiveTypeId, SensitiveColumn.Source source, List<String> parentColumnKeys, SensitiveColumn.RelationType relationType, Long estimatedDataValueCount, List<String> sampleDataValues, List<String> appDefinedChildColumnKeys, List<String> dbDefinedChildColumnKeys, List<String> columnGroups)
Deprecated.
-
-
Method Detail
-
builder
public static SensitiveColumn.Builder builder()
Create a new builder.
-
toBuilder
public SensitiveColumn.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
-
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
-
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
-
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 SensitiveColumn.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 SensitiveColumn.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 SensitiveColumn.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 SensitiveColumn.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
-
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
-
getAppDefinedChildColumnKeys
public List<String> getAppDefinedChildColumnKeys()
Unique keys identifying the columns that are application-level (non-dictionary) children of the sensitive column.- Returns:
- the value
-
getDbDefinedChildColumnKeys
public List<String> getDbDefinedChildColumnKeys()
Unique keys identifying the columns that are database-level (dictionary-defined) children of the sensitive column.- Returns:
- the value
-
getColumnGroups
public List<String> getColumnGroups()
The composite key groups to which the sensitive column belongs.If the column is part of a composite key, it’s assigned a column group. It helps identify and manage referential relationships that involve composite keys.
- Returns:
- the value
-
toString
public String toString()
- Overrides:
toString
in classcom.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 classcom.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classcom.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
-
-