@Generated(value="OracleSDKGenerator", comments="API Version: 20181201") public final class DiscoveryJobResult extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
A discovery job result representing a sensitive column. It can be one of the following three
types: NEW: A new sensitive column in the target database that is not in the sensitive data
model. DELETED: A column that is present in the sensitive data model but has been deleted from
the target database. MODIFIED: A column that is present in the target database as well as the
sensitive data model but some of its attributes have been modified.
Note: Objects should always be created or deserialized using the DiscoveryJobResult.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 DiscoveryJobResult.Builder
, which maintain a
set of all explicitly set fields called DiscoveryJobResult.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
).
Modifier and Type | Class and Description |
---|---|
static class |
DiscoveryJobResult.Builder |
static class |
DiscoveryJobResult.DiscoveryType
The type of the discovery result.
|
static class |
DiscoveryJobResult.ObjectType
The type of the database object that contains the sensitive column.
|
static class |
DiscoveryJobResult.PlannedAction
Specifies how to process the discovery result.
|
static class |
DiscoveryJobResult.RelationType
The type of referential relationship the sensitive column has with its parent.
|
EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME
Constructor and Description |
---|
DiscoveryJobResult(String key,
DiscoveryJobResult.DiscoveryType discoveryType,
String sensitiveColumnkey,
String appName,
String schemaName,
String objectName,
String columnName,
DiscoveryJobResult.ObjectType objectType,
String dataType,
String sensitiveTypeId,
List<String> parentColumnKeys,
DiscoveryJobResult.RelationType relationType,
Long estimatedDataValueCount,
List<String> sampleDataValues,
List<String> appDefinedChildColumnKeys,
List<String> dbDefinedChildColumnKeys,
DiscoveryJobResult.PlannedAction plannedAction,
Boolean isResultApplied,
String discoveryJobId,
ModifiedAttributes modifiedAttributes)
Deprecated.
|
Modifier and Type | Method and Description |
---|---|
static DiscoveryJobResult.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.
|
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.
|
String |
getDiscoveryJobId()
The OCID of the discovery job.
|
DiscoveryJobResult.DiscoveryType |
getDiscoveryType()
The type of the discovery result.
|
Long |
getEstimatedDataValueCount()
The estimated number of data values the column has in the associated database.
|
Boolean |
getIsResultApplied()
Indicates whether the discovery result has been processed.
|
String |
getKey()
The unique key that identifies the discovery result.
|
ModifiedAttributes |
getModifiedAttributes() |
String |
getObjectName()
The database object that contains the sensitive column.
|
DiscoveryJobResult.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.
|
DiscoveryJobResult.PlannedAction |
getPlannedAction()
Specifies how to process the discovery result.
|
DiscoveryJobResult.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 |
getSensitiveColumnkey()
The unique key that identifies the sensitive column represented by the discovery result.
|
String |
getSensitiveTypeId()
The OCID of the sensitive type associated with the sensitive column.
|
int |
hashCode() |
DiscoveryJobResult.Builder |
toBuilder() |
String |
toString() |
String |
toString(boolean includeByteArrayContents)
Return a string representation of the object.
|
markPropertyAsExplicitlySet, wasPropertyExplicitlySet
@Deprecated @ConstructorProperties(value={"key","discoveryType","sensitiveColumnkey","appName","schemaName","objectName","columnName","objectType","dataType","sensitiveTypeId","parentColumnKeys","relationType","estimatedDataValueCount","sampleDataValues","appDefinedChildColumnKeys","dbDefinedChildColumnKeys","plannedAction","isResultApplied","discoveryJobId","modifiedAttributes"}) public DiscoveryJobResult(String key, DiscoveryJobResult.DiscoveryType discoveryType, String sensitiveColumnkey, String appName, String schemaName, String objectName, String columnName, DiscoveryJobResult.ObjectType objectType, String dataType, String sensitiveTypeId, List<String> parentColumnKeys, DiscoveryJobResult.RelationType relationType, Long estimatedDataValueCount, List<String> sampleDataValues, List<String> appDefinedChildColumnKeys, List<String> dbDefinedChildColumnKeys, DiscoveryJobResult.PlannedAction plannedAction, Boolean isResultApplied, String discoveryJobId, ModifiedAttributes modifiedAttributes)
public static DiscoveryJobResult.Builder builder()
Create a new builder.
public DiscoveryJobResult.Builder toBuilder()
public String getKey()
The unique key that identifies the discovery result.
public DiscoveryJobResult.DiscoveryType getDiscoveryType()
The type of the discovery result. It can be one of the following three types: NEW: A new sensitive column in the target database that is not in the sensitive data model. DELETED: A column that is present in the sensitive data model but has been deleted from the target database. MODIFIED: A column that is present in the target database as well as the sensitive data model but some of its attributes have been modified.
public String getSensitiveColumnkey()
The unique key that identifies the sensitive column represented by the discovery result.
public String getAppName()
The name of the application. An application is an entity that is identified by a schema and stores sensitive information for that schema. Its value will be same as schemaName, if no value is passed.
public String getSchemaName()
The database schema that contains the sensitive column.
public String getObjectName()
The database object that contains the sensitive column.
public String getColumnName()
The name of the sensitive column.
public DiscoveryJobResult.ObjectType getObjectType()
The type of the database object that contains the sensitive column.
public String getDataType()
The data type of the sensitive column.
public String getSensitiveTypeId()
The OCID of the sensitive type associated with the sensitive column.
public List<String> getParentColumnKeys()
Unique keys identifying the columns that are parents of the sensitive column. At present, it tracks a single parent only.
public DiscoveryJobResult.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.
public Long getEstimatedDataValueCount()
The estimated number of data values the column has in the associated database.
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.
public List<String> getAppDefinedChildColumnKeys()
Unique keys identifying the columns that are application-level (non-dictionary) children of the sensitive column.
public List<String> getDbDefinedChildColumnKeys()
Unique keys identifying the columns that are database-level (dictionary-defined) children of the sensitive column.
public DiscoveryJobResult.PlannedAction getPlannedAction()
Specifies how to process the discovery result. It’s set to NONE by default. Use the PatchDiscoveryJobResults operation to update this attribute. You can choose one of the following options: ACCEPT: To accept the discovery result and update the sensitive data model to reflect the changes. REJECT: To reject the discovery result so that it doesn’t change the sensitive data model. INVALIDATE: To invalidate a newly discovered column. It adds the column to the sensitive data model but marks it as invalid. It helps track false positives and ensure that they aren’t reported by future discovery jobs. After specifying the planned action, you can use the ApplyDiscoveryJobResults operation to automatically process the discovery results.
public Boolean getIsResultApplied()
Indicates whether the discovery result has been processed. You can update this attribute using the PatchDiscoveryJobResults operation to track whether the discovery result has already been processed and applied to the sensitive data model.
public String getDiscoveryJobId()
The OCID of the discovery job.
public ModifiedAttributes getModifiedAttributes()
public String toString()
toString
in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
public String toString(boolean includeByteArrayContents)
Return a string representation of the object.
includeByteArrayContents
- true to include the full contents of byte arrayspublic boolean equals(Object o)
equals
in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
public int hashCode()
hashCode
in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
Copyright © 2016–2024. All rights reserved.