com.oracle.bmc.datasafe.model

Class CreateDiscoveryJobDetails.Builder

java.lang.Object

com.oracle.bmc.datasafe.model.CreateDiscoveryJobDetails.Builder

Enclosing class:

CreateDiscoveryJobDetails

public static class CreateDiscoveryJobDetails.Builder
extends Object

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
CreateDiscoveryJobDetails	build()
CreateDiscoveryJobDetails.Builder	compartmentId(String compartmentId) The OCID of the compartment where the discovery job resource should be created.
CreateDiscoveryJobDetails.Builder	copy(CreateDiscoveryJobDetails model)
CreateDiscoveryJobDetails.Builder	definedTags(Map<String,Map<String,Object>> definedTags) Defined tags for this resource.
CreateDiscoveryJobDetails.Builder	discoveryType(DiscoveryJob.DiscoveryType discoveryType) The type of the discovery job.
CreateDiscoveryJobDetails.Builder	displayName(String displayName) A user-friendly name for the discovery job.
CreateDiscoveryJobDetails.Builder	freeformTags(Map<String,String> freeformTags) Free-form tags for this resource.
CreateDiscoveryJobDetails.Builder	isAppDefinedRelationDiscoveryEnabled(Boolean isAppDefinedRelationDiscoveryEnabled) Indicates if the discovery job should identify potential application-level (non-dictionary) referential relationships between columns.
CreateDiscoveryJobDetails.Builder	isIncludeAllSchemas(Boolean isIncludeAllSchemas) Indicates if all the schemas should be scanned by the discovery job.
CreateDiscoveryJobDetails.Builder	isIncludeAllSensitiveTypes(Boolean isIncludeAllSensitiveTypes) Indicates if all the existing sensitive types should be used by the discovery job.
CreateDiscoveryJobDetails.Builder	isSampleDataCollectionEnabled(Boolean isSampleDataCollectionEnabled) Indicates if the discovery job should collect and store sample data values for the discovered columns.
CreateDiscoveryJobDetails.Builder	schemasForDiscovery(List<String> schemasForDiscovery) The schemas to be scanned by the discovery job.
CreateDiscoveryJobDetails.Builder	sensitiveDataModelId(String sensitiveDataModelId) The OCID of the sensitive data model.
CreateDiscoveryJobDetails.Builder	sensitiveTypeIdsForDiscovery(List<String> sensitiveTypeIdsForDiscovery) The OCIDs of the sensitive types to be used by the discovery job.
CreateDiscoveryJobDetails.Builder	tablesForDiscovery(List<TablesForDiscovery> tablesForDiscovery) The data discovery jobs will scan the tables specified here, including both schemas and tables.

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

discoveryType

public CreateDiscoveryJobDetails.Builder discoveryType(DiscoveryJob.DiscoveryType discoveryType)

The type of the discovery job. It defines the job’s scope. NEW identifies new sensitive columns in the target database that are not in the sensitive data model. DELETED identifies columns that are present in the sensitive data model but have been deleted from the target database. MODIFIED identifies columns that are present in the target database as well as the sensitive data model but some of their attributes have been modified. ALL covers all the above three scenarios and reports new, deleted and modified columns.

Parameters:

discoveryType - the value to set

Returns:

this builder

sensitiveDataModelId

public CreateDiscoveryJobDetails.Builder sensitiveDataModelId(String sensitiveDataModelId)

The OCID of the sensitive data model.

Parameters:

sensitiveDataModelId - the value to set

Returns:

this builder

compartmentId

public CreateDiscoveryJobDetails.Builder compartmentId(String compartmentId)

The OCID of the compartment where the discovery job resource should be created.

Parameters:

compartmentId - the value to set

Returns:

this builder

displayName

public CreateDiscoveryJobDetails.Builder displayName(String displayName)

A user-friendly name for the discovery job. Does not have to be unique, and it is changeable. Avoid entering confidential information.

Parameters:

displayName - the value to set

Returns:

this builder

schemasForDiscovery

public CreateDiscoveryJobDetails.Builder schemasForDiscovery(List<String> schemasForDiscovery)

The schemas to be scanned by the discovery job. If not provided, the schemasForDiscovery attribute of the sensitive data model is used to get the list of schemas.

Parameters:

schemasForDiscovery - the value to set

Returns:

this builder

tablesForDiscovery

public CreateDiscoveryJobDetails.Builder tablesForDiscovery(List<TablesForDiscovery> tablesForDiscovery)

The data discovery jobs will scan the tables specified here, including both schemas and tables. In the absence of explicit input, the list of tables is obtained from the tablesForDiscovery attribute of the sensitive data model.

Parameters:

tablesForDiscovery - the value to set

Returns:

this builder

sensitiveTypeIdsForDiscovery

public CreateDiscoveryJobDetails.Builder sensitiveTypeIdsForDiscovery(List<String> sensitiveTypeIdsForDiscovery)

The OCIDs of the sensitive types to be used by the discovery job. If not provided, the sensitiveTypeIdsForDiscovery attribute of the sensitive data model is used to get the list of sensitive types.

Parameters:

sensitiveTypeIdsForDiscovery - the value to set

Returns:

this builder

isSampleDataCollectionEnabled

public CreateDiscoveryJobDetails.Builder isSampleDataCollectionEnabled(Boolean isSampleDataCollectionEnabled)

Indicates if the discovery job should collect and store sample data values for the discovered columns. Sample data helps review the discovered columns and ensure that they actually contain sensitive data. As it collects original data from the target database, it’s disabled by default and should be used only if it’s acceptable to store sample data in Data Safe’s repository in Oracle Cloud. Note that sample data values are not collected for columns with the following data types: LONG, LOB, RAW, XMLTYPE and BFILE.

Parameters:

isSampleDataCollectionEnabled - the value to set

Returns:

this builder

isAppDefinedRelationDiscoveryEnabled

public CreateDiscoveryJobDetails.Builder isAppDefinedRelationDiscoveryEnabled(Boolean isAppDefinedRelationDiscoveryEnabled)

Indicates if the discovery job should identify potential application-level (non-dictionary) referential relationships between columns. Note that data discovery automatically identifies and adds database-level (dictionary-defined) relationships. This option helps identify application-level relationships that are not defined in the database dictionary, which in turn, helps identify additional sensitive columns and preserve referential integrity during data masking. It’s disabled by default and should be used only if there is a need to identify application-level relationships.

Parameters:

isAppDefinedRelationDiscoveryEnabled - the value to set

Returns:

this builder

isIncludeAllSchemas

public CreateDiscoveryJobDetails.Builder isIncludeAllSchemas(Boolean isIncludeAllSchemas)

Indicates if all the schemas should be scanned by the discovery job. If it is set to true, sensitive data is discovered in all schemas (except for schemas maintained by Oracle). If both attributes are not provided, the configuration from the sensitive data model is used.

Parameters:

isIncludeAllSchemas - the value to set

Returns:

this builder

isIncludeAllSensitiveTypes

public CreateDiscoveryJobDetails.Builder isIncludeAllSensitiveTypes(Boolean isIncludeAllSensitiveTypes)

Indicates if all the existing sensitive types should be used by the discovery job. If it’s set to true, the sensitiveTypeIdsForDiscovery attribute is ignored and all sensitive types are used for data discovery. If both attributes are not provided, the configuration from the sensitive data model is used.

Parameters:

isIncludeAllSensitiveTypes - the value to set

Returns:

this builder

freeformTags

public CreateDiscoveryJobDetails.Builder freeformTags(Map<String,String> freeformTags)

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags

Example: {"Department": "Finance"}

Parameters:

freeformTags - the value to set

Returns:

this builder

definedTags

public CreateDiscoveryJobDetails.Builder definedTags(Map<String,Map<String,Object>> definedTags)

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags

Example: {"Operations": {"CostCenter": "42"}}

Parameters:

definedTags - the value to set

Returns:

this builder

build

public CreateDiscoveryJobDetails build()

copy

public CreateDiscoveryJobDetails.Builder copy(CreateDiscoveryJobDetails model)