com.oracle.bmc.datasafe.model

Class DiscoveryJobResult.Builder

java.lang.Object

com.oracle.bmc.datasafe.model.DiscoveryJobResult.Builder

Enclosing class:

DiscoveryJobResult

public static class DiscoveryJobResult.Builder
extends Object

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
DiscoveryJobResult.Builder	appDefinedChildColumnKeys(List<String> appDefinedChildColumnKeys) Unique keys identifying the columns that are application-level (non-dictionary) children of the sensitive column.
DiscoveryJobResult.Builder	appName(String appName) The name of the application.
DiscoveryJobResult	build()
DiscoveryJobResult.Builder	columnName(String columnName) The name of the sensitive column.
DiscoveryJobResult.Builder	copy(DiscoveryJobResult model)
DiscoveryJobResult.Builder	dataType(String dataType) The data type of the sensitive column.
DiscoveryJobResult.Builder	dbDefinedChildColumnKeys(List<String> dbDefinedChildColumnKeys) Unique keys identifying the columns that are database-level (dictionary-defined) children of the sensitive column.
DiscoveryJobResult.Builder	discoveryJobId(String discoveryJobId) The OCID of the discovery job.
DiscoveryJobResult.Builder	discoveryType(DiscoveryJobResult.DiscoveryType discoveryType) The type of the discovery result.
DiscoveryJobResult.Builder	estimatedDataValueCount(Long estimatedDataValueCount) The estimated number of data values the column has in the associated database.
DiscoveryJobResult.Builder	isResultApplied(Boolean isResultApplied) Indicates whether the discovery result has been processed.
DiscoveryJobResult.Builder	key(String key) The unique key that identifies the discovery result.
DiscoveryJobResult.Builder	modifiedAttributes(ModifiedAttributes modifiedAttributes)
DiscoveryJobResult.Builder	objectName(String objectName) The database object that contains the sensitive column.
DiscoveryJobResult.Builder	objectType(DiscoveryJobResult.ObjectType objectType) The type of the database object that contains the sensitive column.
DiscoveryJobResult.Builder	parentColumnKeys(List<String> parentColumnKeys) Unique keys identifying the columns that are parents of the sensitive column.
DiscoveryJobResult.Builder	plannedAction(DiscoveryJobResult.PlannedAction plannedAction) Specifies how to process the discovery result.
DiscoveryJobResult.Builder	relationType(DiscoveryJobResult.RelationType relationType) The type of referential relationship the sensitive column has with its parent.
DiscoveryJobResult.Builder	sampleDataValues(List<String> sampleDataValues) Original data values collected for the sensitive column from the associated database.
DiscoveryJobResult.Builder	schemaName(String schemaName) The database schema that contains the sensitive column.
DiscoveryJobResult.Builder	sensitiveColumnkey(String sensitiveColumnkey) The unique key that identifies the sensitive column represented by the discovery result.
DiscoveryJobResult.Builder	sensitiveTypeId(String sensitiveTypeId) The OCID of the sensitive type associated with the sensitive column.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Method Detail

key

public DiscoveryJobResult.Builder key(String key)

The unique key that identifies the discovery result.

Parameters:

key - the value to set

Returns:

this builder

discoveryType

public DiscoveryJobResult.Builder discoveryType(DiscoveryJobResult.DiscoveryType discoveryType)

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.

Parameters:

discoveryType - the value to set

Returns:

this builder

sensitiveColumnkey

public DiscoveryJobResult.Builder sensitiveColumnkey(String sensitiveColumnkey)

The unique key that identifies the sensitive column represented by the discovery result.

Parameters:

sensitiveColumnkey - the value to set

Returns:

this builder

appName

public DiscoveryJobResult.Builder appName(String appName)

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.

Parameters:

appName - the value to set

Returns:

this builder

schemaName

public DiscoveryJobResult.Builder schemaName(String schemaName)

The database schema that contains the sensitive column.

Parameters:

schemaName - the value to set

Returns:

this builder

objectName

public DiscoveryJobResult.Builder objectName(String objectName)

The database object that contains the sensitive column.

Parameters:

objectName - the value to set

Returns:

this builder

columnName

public DiscoveryJobResult.Builder columnName(String columnName)

The name of the sensitive column.

Parameters:

columnName - the value to set

Returns:

this builder

objectType

public DiscoveryJobResult.Builder objectType(DiscoveryJobResult.ObjectType objectType)

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

Parameters:

objectType - the value to set

Returns:

this builder

dataType

public DiscoveryJobResult.Builder dataType(String dataType)

The data type of the sensitive column.

Parameters:

dataType - the value to set

Returns:

this builder

sensitiveTypeId

public DiscoveryJobResult.Builder sensitiveTypeId(String sensitiveTypeId)

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

Parameters:

sensitiveTypeId - the value to set

Returns:

this builder

parentColumnKeys

public DiscoveryJobResult.Builder parentColumnKeys(List<String> parentColumnKeys)

Unique keys identifying the columns that are parents of the sensitive column. At present, it tracks a single parent only.

Parameters:

parentColumnKeys - the value to set

Returns:

this builder

relationType

public DiscoveryJobResult.Builder relationType(DiscoveryJobResult.RelationType relationType)

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.

Parameters:

relationType - the value to set

Returns:

this builder

estimatedDataValueCount

public DiscoveryJobResult.Builder estimatedDataValueCount(Long estimatedDataValueCount)

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

Parameters:

estimatedDataValueCount - the value to set

Returns:

this builder

sampleDataValues

public DiscoveryJobResult.Builder sampleDataValues(List<String> sampleDataValues)

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.

Parameters:

sampleDataValues - the value to set

Returns:

this builder

appDefinedChildColumnKeys

public DiscoveryJobResult.Builder appDefinedChildColumnKeys(List<String> appDefinedChildColumnKeys)

Unique keys identifying the columns that are application-level (non-dictionary) children of the sensitive column.

Parameters:

appDefinedChildColumnKeys - the value to set

Returns:

this builder

dbDefinedChildColumnKeys

public DiscoveryJobResult.Builder dbDefinedChildColumnKeys(List<String> dbDefinedChildColumnKeys)

Unique keys identifying the columns that are database-level (dictionary-defined) children of the sensitive column.

Parameters:

dbDefinedChildColumnKeys - the value to set

Returns:

this builder

plannedAction

public DiscoveryJobResult.Builder plannedAction(DiscoveryJobResult.PlannedAction plannedAction)

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.

Parameters:

plannedAction - the value to set

Returns:

this builder

isResultApplied

public DiscoveryJobResult.Builder isResultApplied(Boolean isResultApplied)

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.

Parameters:

isResultApplied - the value to set

Returns:

this builder

discoveryJobId

public DiscoveryJobResult.Builder discoveryJobId(String discoveryJobId)

The OCID of the discovery job.

Parameters:

discoveryJobId - the value to set

Returns:

this builder

modifiedAttributes

public DiscoveryJobResult.Builder modifiedAttributes(ModifiedAttributes modifiedAttributes)

build

public DiscoveryJobResult build()

copy

public DiscoveryJobResult.Builder copy(DiscoveryJobResult model)