@Generated(value="OracleSDKGenerator",
comments="API Version: 20181201")
public final class CreateDiscoveryJobDetails
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
Details to create a new data discovery job.
Note: Objects should always be created or deserialized using the CreateDiscoveryJobDetails.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 CreateDiscoveryJobDetails.Builder, which maintain a
set of all explicitly set fields called CreateDiscoveryJobDetails.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 |
CreateDiscoveryJobDetails.Builder |
EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME| Constructor and Description |
|---|
CreateDiscoveryJobDetails(DiscoveryJob.DiscoveryType discoveryType,
String sensitiveDataModelId,
String compartmentId,
String displayName,
List<String> schemasForDiscovery,
List<TablesForDiscovery> tablesForDiscovery,
List<String> sensitiveTypeIdsForDiscovery,
Boolean isSampleDataCollectionEnabled,
Boolean isAppDefinedRelationDiscoveryEnabled,
Boolean isIncludeAllSchemas,
Boolean isIncludeAllSensitiveTypes,
Map<String,String> freeformTags,
Map<String,Map<String,Object>> definedTags)
Deprecated.
|
| Modifier and Type | Method and Description |
|---|---|
static CreateDiscoveryJobDetails.Builder |
builder()
Create a new builder.
|
boolean |
equals(Object o) |
String |
getCompartmentId()
The OCID of the compartment where the discovery job resource should be created.
|
Map<String,Map<String,Object>> |
getDefinedTags()
Defined tags for this resource.
|
DiscoveryJob.DiscoveryType |
getDiscoveryType()
The type of the discovery job.
|
String |
getDisplayName()
A user-friendly name for the discovery job.
|
Map<String,String> |
getFreeformTags()
Free-form tags for this resource.
|
Boolean |
getIsAppDefinedRelationDiscoveryEnabled()
Indicates if the discovery job should identify potential application-level (non-dictionary)
referential relationships between columns.
|
Boolean |
getIsIncludeAllSchemas()
Indicates if all the schemas should be scanned by the discovery job.
|
Boolean |
getIsIncludeAllSensitiveTypes()
Indicates if all the existing sensitive types should be used by the discovery job.
|
Boolean |
getIsSampleDataCollectionEnabled()
Indicates if the discovery job should collect and store sample data values for the discovered
columns.
|
List<String> |
getSchemasForDiscovery()
The schemas to be scanned by the discovery job.
|
String |
getSensitiveDataModelId()
The OCID of the sensitive data model.
|
List<String> |
getSensitiveTypeIdsForDiscovery()
The OCIDs of the sensitive types to be used by the discovery job.
|
List<TablesForDiscovery> |
getTablesForDiscovery()
The data discovery jobs will scan the tables specified here, including both schemas and
tables.
|
int |
hashCode() |
CreateDiscoveryJobDetails.Builder |
toBuilder() |
String |
toString() |
String |
toString(boolean includeByteArrayContents)
Return a string representation of the object.
|
markPropertyAsExplicitlySet, wasPropertyExplicitlySet@Deprecated @ConstructorProperties(value={"discoveryType","sensitiveDataModelId","compartmentId","displayName","schemasForDiscovery","tablesForDiscovery","sensitiveTypeIdsForDiscovery","isSampleDataCollectionEnabled","isAppDefinedRelationDiscoveryEnabled","isIncludeAllSchemas","isIncludeAllSensitiveTypes","freeformTags","definedTags"}) public CreateDiscoveryJobDetails(DiscoveryJob.DiscoveryType discoveryType, String sensitiveDataModelId, String compartmentId, String displayName, List<String> schemasForDiscovery, List<TablesForDiscovery> tablesForDiscovery, List<String> sensitiveTypeIdsForDiscovery, Boolean isSampleDataCollectionEnabled, Boolean isAppDefinedRelationDiscoveryEnabled, Boolean isIncludeAllSchemas, Boolean isIncludeAllSensitiveTypes, Map<String,String> freeformTags, Map<String,Map<String,Object>> definedTags)
public static CreateDiscoveryJobDetails.Builder builder()
Create a new builder.
public CreateDiscoveryJobDetails.Builder toBuilder()
public DiscoveryJob.DiscoveryType getDiscoveryType()
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.
public String getSensitiveDataModelId()
The OCID of the sensitive data model.
public String getCompartmentId()
The OCID of the compartment where the discovery job resource should be created.
public String getDisplayName()
A user-friendly name for the discovery job. Does not have to be unique, and it is changeable. Avoid entering confidential information.
public List<String> getSchemasForDiscovery()
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.
public List<TablesForDiscovery> getTablesForDiscovery()
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.
public List<String> getSensitiveTypeIdsForDiscovery()
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.
public Boolean getIsSampleDataCollectionEnabled()
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.
public Boolean getIsAppDefinedRelationDiscoveryEnabled()
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.
public Boolean getIsIncludeAllSchemas()
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.
public Boolean getIsIncludeAllSensitiveTypes()
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.
public Map<String,String> getFreeformTags()
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"}
public Map<String,Map<String,Object>> getDefinedTags()
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags
Example: {"Operations": {"CostCenter": "42"}}
public String toString()
toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModelpublic 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.ExplicitlySetBmcModelpublic int hashCode()
hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModelCopyright © 2016–2024. All rights reserved.