@Generated(value="OracleSDKGenerator", comments="API Version: 20181201") public class DataSafeClient extends BaseSyncClient implements DataSafe
Modifier and Type | Class and Description |
---|---|
static class |
DataSafeClient.Builder
Builder class for this client.
|
Modifier and Type | Field and Description |
---|---|
String |
clientCommonLibraryVersion
Compatible SDK version, provided by the codegen.
|
Optional<String> |
minimumClientCommonLibraryVersionFromClient
Minimum compatible SDK version, maybe provided by the codegen.
|
static Service |
SERVICE
Service instance for DataSafe.
|
Constructor and Description |
---|
DataSafeClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory)
Deprecated.
Use the
builder instead. |
DataSafeClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
List<ClientConfigurator> additionalClientConfigurators)
Deprecated.
Use the
builder instead. |
DataSafeClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
List<ClientConfigurator> additionalClientConfigurators,
String endpoint)
Deprecated.
Use the
builder instead. |
DataSafeClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
List<ClientConfigurator> additionalClientConfigurators,
String endpoint)
Deprecated.
Use the
builder instead. |
DataSafeClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
List<ClientConfigurator> additionalClientConfigurators,
String endpoint,
ExecutorService executorService)
Deprecated.
Use the
builder instead. |
DataSafeClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Deprecated.
Use the
builder instead. |
DataSafeClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration)
Deprecated.
Use the
builder instead. |
DataSafeClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator)
Deprecated.
Use the
builder instead. |
clientCall
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate
close
public static final Service SERVICE
Service instance for DataSafe.
public final String clientCommonLibraryVersion
@Deprecated public DataSafeClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
builder
instead.Create a new client instance.
authenticationDetailsProvider
- The authentication details (see DataSafeClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)@Deprecated public DataSafeClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)
builder
instead.Create a new client instance.
authenticationDetailsProvider
- The authentication details (see DataSafeClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
- ClientBuilderBase.configuration
@Deprecated public DataSafeClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)
builder
instead.Create a new client instance.
authenticationDetailsProvider
- The authentication details (see DataSafeClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
- ClientBuilderBase.configuration
clientConfigurator
- ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
@Deprecated public DataSafeClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)
builder
instead.Create a new client instance.
authenticationDetailsProvider
- The authentication details (see DataSafeClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
- ClientBuilderBase.configuration
clientConfigurator
- ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
defaultRequestSignerFactory
- ClientBuilderBase.requestSignerFactory
@Deprecated public DataSafeClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)
builder
instead.Create a new client instance.
authenticationDetailsProvider
- The authentication details (see DataSafeClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
- ClientBuilderBase.configuration
clientConfigurator
- ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
defaultRequestSignerFactory
- ClientBuilderBase.requestSignerFactory
additionalClientConfigurators
- ClientBuilderBase.additionalClientConfigurators
@Deprecated public DataSafeClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
builder
instead.Create a new client instance.
authenticationDetailsProvider
- The authentication details (see DataSafeClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
- ClientBuilderBase.configuration
clientConfigurator
- ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
defaultRequestSignerFactory
- ClientBuilderBase.requestSignerFactory
additionalClientConfigurators
- ClientBuilderBase.additionalClientConfigurators
endpoint
- ClientBuilderBase.endpoint(java.lang.String)
@Deprecated public DataSafeClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
builder
instead.Create a new client instance.
authenticationDetailsProvider
- The authentication details (see DataSafeClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
- ClientBuilderBase.configuration
clientConfigurator
- ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
defaultRequestSignerFactory
- ClientBuilderBase.requestSignerFactory
additionalClientConfigurators
- ClientBuilderBase.additionalClientConfigurators
endpoint
- ClientBuilderBase.endpoint(java.lang.String)
signingStrategyRequestSignerFactories
- ClientBuilderBase.signingStrategyRequestSignerFactories
@Deprecated public DataSafeClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService)
builder
instead.Create a new client instance.
authenticationDetailsProvider
- The authentication details (see DataSafeClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
- ClientBuilderBase.configuration
clientConfigurator
- ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
defaultRequestSignerFactory
- ClientBuilderBase.requestSignerFactory
additionalClientConfigurators
- ClientBuilderBase.additionalClientConfigurators
endpoint
- ClientBuilderBase.endpoint(java.lang.String)
signingStrategyRequestSignerFactories
- ClientBuilderBase.signingStrategyRequestSignerFactories
executorService
- DataSafeClient.Builder.executorService
public static DataSafeClient.Builder builder()
Create a builder for this client.
public void setRegion(Region region)
DataSafe
Sets the region to call (ex, Region.US_PHOENIX_1).
Note, this will call setEndpoint
after resolving the
endpoint. If the service is not available in this Region, however, an
IllegalArgumentException will be raised.
public void setRegion(String regionId)
DataSafe
Sets the region to call (ex, ‘us-phoenix-1’).
Note, this will first try to map the region ID to a known Region and call setRegion
.
If no known Region could be determined, it will create an endpoint based on the default
endpoint format (Region.formatDefaultRegionEndpoint(Service, String)
and then call setEndpoint
.
public ActivateTargetDatabaseResponse activateTargetDatabase(ActivateTargetDatabaseRequest request)
DataSafe
Reactivates a previously deactivated Data Safe target database.
activateTargetDatabase
in interface DataSafe
request
- The request object containing the details to sendpublic AddMaskingColumnsFromSdmResponse addMaskingColumnsFromSdm(AddMaskingColumnsFromSdmRequest request)
DataSafe
Adds columns to the specified masking policy from the associated sensitive data model. It automatically pulls all the sensitive columns and their relationships from the sensitive data model and uses this information to create columns in the masking policy. It also assigns default masking formats to these columns based on the associated sensitive types.
addMaskingColumnsFromSdm
in interface DataSafe
request
- The request object containing the details to sendpublic AlertsUpdateResponse alertsUpdate(AlertsUpdateRequest request)
DataSafe
Updates alerts in the specified compartment.
alertsUpdate
in interface DataSafe
request
- The request object containing the details to sendpublic ApplyDiscoveryJobResultsResponse applyDiscoveryJobResults(ApplyDiscoveryJobResultsRequest request)
DataSafe
Applies the results of a discovery job to the specified sensitive data model. Note that the plannedAction attribute of discovery results is used for processing them. You should first use PatchDiscoveryJobResults to set the plannedAction attribute of the discovery results you want to process. ApplyDiscoveryJobResults automatically reads the plannedAction attribute and updates the sensitive data model to reflect the actions you planned.
applyDiscoveryJobResults
in interface DataSafe
request
- The request object containing the details to sendpublic ApplySdmMaskingPolicyDifferenceResponse applySdmMaskingPolicyDifference(ApplySdmMaskingPolicyDifferenceRequest request)
DataSafe
Applies the difference of a SDM Masking policy difference resource to the specified masking policy. Note that the plannedAction attribute of difference columns is used for processing. You should first use PatchSdmMaskingPolicyDifferenceColumns to set the plannedAction attribute of the difference columns you want to process. ApplySdmMaskingPolicyDifference automatically reads the plannedAction attribute and updates the masking policy to reflect the actions you planned. If the sdmMaskingPolicydifferenceId is not passed, the latest sdmMaskingPolicydifference is used. Note that if the masking policy associated with the SdmMaskingPolicyDifference used for this operation is not associated with the original SDM anymore, this operation won’t be allowed.
applySdmMaskingPolicyDifference
in interface DataSafe
request
- The request object containing the details to sendpublic BulkCreateSqlFirewallAllowedSqlsResponse bulkCreateSqlFirewallAllowedSqls(BulkCreateSqlFirewallAllowedSqlsRequest request)
DataSafe
Appends the allowedSqls with entries from the logs.
bulkCreateSqlFirewallAllowedSqls
in interface DataSafe
request
- The request object containing the details to sendpublic BulkDeleteSqlFirewallAllowedSqlsResponse bulkDeleteSqlFirewallAllowedSqls(BulkDeleteSqlFirewallAllowedSqlsRequest request)
DataSafe
Delete multiple allowed sqls from the SQL firewall policy.
bulkDeleteSqlFirewallAllowedSqls
in interface DataSafe
request
- The request object containing the details to sendpublic CalculateAuditVolumeAvailableResponse calculateAuditVolumeAvailable(CalculateAuditVolumeAvailableRequest request)
DataSafe
Calculates the volume of audit events available on the target database to be collected. Measurable up to the defined retention period of the audit target resource.
calculateAuditVolumeAvailable
in interface DataSafe
request
- The request object containing the details to sendpublic CalculateAuditVolumeCollectedResponse calculateAuditVolumeCollected(CalculateAuditVolumeCollectedRequest request)
DataSafe
Calculates the volume of audit events collected by data safe.
calculateAuditVolumeCollected
in interface DataSafe
request
- The request object containing the details to sendpublic CancelWorkRequestResponse cancelWorkRequest(CancelWorkRequestRequest request)
DataSafe
Cancel the specified work request.
cancelWorkRequest
in interface DataSafe
request
- The request object containing the details to sendpublic ChangeAlertCompartmentResponse changeAlertCompartment(ChangeAlertCompartmentRequest request)
DataSafe
Moves the specified alert into a different compartment.
changeAlertCompartment
in interface DataSafe
request
- The request object containing the details to sendpublic ChangeAlertPolicyCompartmentResponse changeAlertPolicyCompartment(ChangeAlertPolicyCompartmentRequest request)
DataSafe
Moves the specified alert policy into a different compartment.
changeAlertPolicyCompartment
in interface DataSafe
request
- The request object containing the details to sendpublic ChangeAuditArchiveRetrievalCompartmentResponse changeAuditArchiveRetrievalCompartment(ChangeAuditArchiveRetrievalCompartmentRequest request)
DataSafe
Moves the archive retreival to the specified compartment. When provided, if-Match is checked against ETag value of the resource.
changeAuditArchiveRetrievalCompartment
in interface DataSafe
request
- The request object containing the details to sendpublic ChangeAuditPolicyCompartmentResponse changeAuditPolicyCompartment(ChangeAuditPolicyCompartmentRequest request)
DataSafe
Moves the specified audit policy and its dependent resources into a different compartment.
changeAuditPolicyCompartment
in interface DataSafe
request
- The request object containing the details to sendpublic ChangeAuditProfileCompartmentResponse changeAuditProfileCompartment(ChangeAuditProfileCompartmentRequest request)
DataSafe
Moves the specified audit profile and its dependent resources into a different compartment.
changeAuditProfileCompartment
in interface DataSafe
request
- The request object containing the details to sendpublic ChangeDataSafePrivateEndpointCompartmentResponse changeDataSafePrivateEndpointCompartment(ChangeDataSafePrivateEndpointCompartmentRequest request)
DataSafe
Moves the Data Safe private endpoint and its dependent resources to the specified compartment.
changeDataSafePrivateEndpointCompartment
in interface DataSafe
request
- The request object containing the details to sendpublic ChangeDatabaseSecurityConfigCompartmentResponse changeDatabaseSecurityConfigCompartment(ChangeDatabaseSecurityConfigCompartmentRequest request)
DataSafe
Moves the specified database security configuration and its dependent resources into a different compartment.
changeDatabaseSecurityConfigCompartment
in interface DataSafe
request
- The request object containing the details to sendpublic ChangeDiscoveryJobCompartmentResponse changeDiscoveryJobCompartment(ChangeDiscoveryJobCompartmentRequest request)
DataSafe
Moves the specified discovery job and its dependent resources into a different compartment.
changeDiscoveryJobCompartment
in interface DataSafe
request
- The request object containing the details to sendpublic ChangeLibraryMaskingFormatCompartmentResponse changeLibraryMaskingFormatCompartment(ChangeLibraryMaskingFormatCompartmentRequest request)
DataSafe
Moves the specified library masking format into a different compartment.
changeLibraryMaskingFormatCompartment
in interface DataSafe
request
- The request object containing the details to sendpublic ChangeMaskingPolicyCompartmentResponse changeMaskingPolicyCompartment(ChangeMaskingPolicyCompartmentRequest request)
DataSafe
Moves the specified masking policy and its dependent resources into a different compartment.
changeMaskingPolicyCompartment
in interface DataSafe
request
- The request object containing the details to sendpublic ChangeMaskingPolicyHealthReportCompartmentResponse changeMaskingPolicyHealthReportCompartment(ChangeMaskingPolicyHealthReportCompartmentRequest request)
DataSafe
Moves the specified masking policy health report and its dependent resources into a different compartment.
changeMaskingPolicyHealthReportCompartment
in interface DataSafe
request
- The request object containing the details to sendpublic ChangeOnPremConnectorCompartmentResponse changeOnPremConnectorCompartment(ChangeOnPremConnectorCompartmentRequest request)
DataSafe
Moves the specified on-premises connector into a different compartment.
changeOnPremConnectorCompartment
in interface DataSafe
request
- The request object containing the details to sendpublic ChangeReportCompartmentResponse changeReportCompartment(ChangeReportCompartmentRequest request)
DataSafe
Moves a resource into a different compartment. When provided, If-Match is checked against ETag values of the resource.
changeReportCompartment
in interface DataSafe
request
- The request object containing the details to sendpublic ChangeReportDefinitionCompartmentResponse changeReportDefinitionCompartment(ChangeReportDefinitionCompartmentRequest request)
DataSafe
Moves a resource into a different compartment. When provided, If-Match is checked against ETag values of the resource.
changeReportDefinitionCompartment
in interface DataSafe
request
- The request object containing the details to sendpublic ChangeRetentionResponse changeRetention(ChangeRetentionRequest request)
DataSafe
Change the online and offline months .
changeRetention
in interface DataSafe
request
- The request object containing the details to sendpublic ChangeSdmMaskingPolicyDifferenceCompartmentResponse changeSdmMaskingPolicyDifferenceCompartment(ChangeSdmMaskingPolicyDifferenceCompartmentRequest request)
DataSafe
Moves the specified SDM masking policy difference into a different compartment.
changeSdmMaskingPolicyDifferenceCompartment
in interface DataSafe
request
- The request object containing the details to sendpublic ChangeSecurityAssessmentCompartmentResponse changeSecurityAssessmentCompartment(ChangeSecurityAssessmentCompartmentRequest request)
DataSafe
Moves the specified saved security assessment or future scheduled assessments into a different compartment.
To start, call first the operation ListSecurityAssessments with filters \"type = save_schedule\". This returns the scheduleAssessmentId. Then, call this changeCompartment with the scheduleAssessmentId.
The existing saved security assessments created due to the schedule are not moved. However, all new saves will be associated with the new compartment.
changeSecurityAssessmentCompartment
in interface DataSafe
request
- The request object containing the details to sendpublic ChangeSecurityPolicyCompartmentResponse changeSecurityPolicyCompartment(ChangeSecurityPolicyCompartmentRequest request)
DataSafe
Moves the specified security policy and its dependent resources into a different compartment.
changeSecurityPolicyCompartment
in interface DataSafe
request
- The request object containing the details to sendpublic ChangeSecurityPolicyDeploymentCompartmentResponse changeSecurityPolicyDeploymentCompartment(ChangeSecurityPolicyDeploymentCompartmentRequest request)
DataSafe
Moves the specified security policy deployment and its dependent resources into a different compartment.
changeSecurityPolicyDeploymentCompartment
in interface DataSafe
request
- The request object containing the details to sendpublic ChangeSensitiveDataModelCompartmentResponse changeSensitiveDataModelCompartment(ChangeSensitiveDataModelCompartmentRequest request)
DataSafe
Moves the specified sensitive data model and its dependent resources into a different compartment.
changeSensitiveDataModelCompartment
in interface DataSafe
request
- The request object containing the details to sendpublic ChangeSensitiveTypeCompartmentResponse changeSensitiveTypeCompartment(ChangeSensitiveTypeCompartmentRequest request)
DataSafe
Moves the specified sensitive type into a different compartment.
changeSensitiveTypeCompartment
in interface DataSafe
request
- The request object containing the details to sendpublic ChangeSqlCollectionCompartmentResponse changeSqlCollectionCompartment(ChangeSqlCollectionCompartmentRequest request)
DataSafe
Moves the specified SQL collection and its dependent resources into a different compartment.
changeSqlCollectionCompartment
in interface DataSafe
request
- The request object containing the details to sendpublic ChangeSqlFirewallPolicyCompartmentResponse changeSqlFirewallPolicyCompartment(ChangeSqlFirewallPolicyCompartmentRequest request)
DataSafe
Moves the specified SQL Firewall policy and its dependent resources into a different compartment.
changeSqlFirewallPolicyCompartment
in interface DataSafe
request
- The request object containing the details to sendpublic ChangeTargetAlertPolicyAssociationCompartmentResponse changeTargetAlertPolicyAssociationCompartment(ChangeTargetAlertPolicyAssociationCompartmentRequest request)
DataSafe
Moves the specified target-alert policy Association into a different compartment.
changeTargetAlertPolicyAssociationCompartment
in interface DataSafe
request
- The request object containing the details to sendpublic ChangeTargetDatabaseCompartmentResponse changeTargetDatabaseCompartment(ChangeTargetDatabaseCompartmentRequest request)
DataSafe
Moves the Data Safe target database to the specified compartment.
changeTargetDatabaseCompartment
in interface DataSafe
request
- The request object containing the details to sendpublic ChangeUserAssessmentCompartmentResponse changeUserAssessmentCompartment(ChangeUserAssessmentCompartmentRequest request)
DataSafe
Moves the specified saved user assessment or future scheduled assessments into a different compartment. To start storing scheduled user assessments on a different compartment, first call the operation ListUserAssessments with the filters "type = save_schedule". That call returns the scheduleAssessmentId. Then call ChangeUserAssessmentCompartment with the scheduleAssessmentId. The existing saved user assessments created per the schedule are not be moved. However, all new saves will be associated with the new compartment.
changeUserAssessmentCompartment
in interface DataSafe
request
- The request object containing the details to sendpublic CompareSecurityAssessmentResponse compareSecurityAssessment(CompareSecurityAssessmentRequest request)
DataSafe
Compares two security assessments. For this comparison, a security assessment can be a saved assessment, a latest assessment, or a baseline assessment. For example, you can compare saved assessment or a latest assessment against a baseline.
compareSecurityAssessment
in interface DataSafe
request
- The request object containing the details to sendpublic CompareUserAssessmentResponse compareUserAssessment(CompareUserAssessmentRequest request)
DataSafe
Compares two user assessments. For this comparison, a user assessment can be a saved, a latest assessment, or a baseline. As an example, it can be used to compare a user assessment saved or a latest assessment with a baseline.
compareUserAssessment
in interface DataSafe
request
- The request object containing the details to sendpublic CreateAlertPolicyResponse createAlertPolicy(CreateAlertPolicyRequest request)
DataSafe
Creates a new user-defined alert policy.
createAlertPolicy
in interface DataSafe
request
- The request object containing the details to sendpublic CreateAlertPolicyRuleResponse createAlertPolicyRule(CreateAlertPolicyRuleRequest request)
DataSafe
Creates a new rule for the alert policy.
createAlertPolicyRule
in interface DataSafe
request
- The request object containing the details to sendpublic CreateAuditArchiveRetrievalResponse createAuditArchiveRetrieval(CreateAuditArchiveRetrievalRequest request)
DataSafe
Creates a work request to retrieve archived audit data. This asynchronous process will usually take over an hour to complete. Save the id from the response of this operation. Call GetAuditArchiveRetrieval operation after an hour, passing the id to know the status of this operation.
createAuditArchiveRetrieval
in interface DataSafe
request
- The request object containing the details to sendpublic CreateDataSafePrivateEndpointResponse createDataSafePrivateEndpoint(CreateDataSafePrivateEndpointRequest request)
DataSafe
Creates a new Data Safe private endpoint.
createDataSafePrivateEndpoint
in interface DataSafe
request
- The request object containing the details to sendpublic CreateDiscoveryJobResponse createDiscoveryJob(CreateDiscoveryJobRequest request)
DataSafe
Performs incremental data discovery for the specified sensitive data model. It uses the target database associated with the sensitive data model. After performing data discovery, you can use ListDiscoveryJobResults to view the discovery results, PatchDiscoveryJobResults to specify the action you want perform on these results, and then ApplyDiscoveryJobResults to process the results and apply them to the sensitive data model.
createDiscoveryJob
in interface DataSafe
request
- The request object containing the details to sendpublic CreateLibraryMaskingFormatResponse createLibraryMaskingFormat(CreateLibraryMaskingFormatRequest request)
DataSafe
Creates a new library masking format. A masking format can have one or more format entries. The combined output of all the format entries is used for masking. It provides the flexibility to define a masking format that can generate different parts of a data value separately and then combine them to get the final data value for masking. Note that you cannot define masking condition in a library masking format.
createLibraryMaskingFormat
in interface DataSafe
request
- The request object containing the details to sendpublic CreateMaskingColumnResponse createMaskingColumn(CreateMaskingColumnRequest request)
DataSafe
Creates a new masking column in the specified masking policy. Use this operation to add parent columns only. It automatically adds the child columns from the associated sensitive data model or target database. If you provide the sensitiveTypeId attribute but not the maskingFormats attribute, it automatically assigns the default masking format associated with the specified sensitive type. Alternatively, if you provide the maskingFormats attribute, the specified masking formats are assigned to the column.
Using the maskingFormats attribute, you can assign one or more masking formats to a column. You need to specify a condition as part of each masking format. It enables you to do conditional masking so that you can mask the column data values differently using different masking conditions. A masking format can have one or more format entries. The combined output of all the format entries is used for masking. It provides the flexibility to define a masking format that can generate different parts of a data value separately and then combine them to get the final data value for masking.
You can use the maskingColumnGroup attribute to group the columns that you would like to mask together. It enables you to do group or compound masking that ensures that the masked data across the columns in a group continue to retain the same logical relationship.
createMaskingColumn
in interface DataSafe
request
- The request object containing the details to sendpublic CreateMaskingPolicyResponse createMaskingPolicy(CreateMaskingPolicyRequest request)
DataSafe
Creates a new masking policy and associates it with a sensitive data model or a target database.
To use a sensitive data model as the source of masking columns, set the columnSource attribute to SENSITIVE_DATA_MODEL and provide the sensitiveDataModelId attribute. After creating a masking policy, you can use the AddMaskingColumnsFromSdm operation to automatically add all the columns from the associated sensitive data model. In this case, the target database associated with the sensitive data model is used for column and masking format validations.
You can also create a masking policy without using a sensitive data model. In this case, you need to associate your masking policy with a target database by setting the columnSource attribute to TARGET and providing the targetId attribute. The specified target database is used for column and masking format validations.
After creating a masking policy, you can use the CreateMaskingColumn or PatchMaskingColumns operation to manually add columns to the policy. You need to add the parent columns only, and it automatically adds the child columns (in referential relationship with the parent columns) from the associated sensitive data model or target database.
createMaskingPolicy
in interface DataSafe
request
- The request object containing the details to sendpublic CreateOnPremConnectorResponse createOnPremConnector(CreateOnPremConnectorRequest request)
DataSafe
Creates a new on-premises connector.
createOnPremConnector
in interface DataSafe
request
- The request object containing the details to sendpublic CreatePeerTargetDatabaseResponse createPeerTargetDatabase(CreatePeerTargetDatabaseRequest request)
DataSafe
Creates the peer target database under the primary target database in Data Safe.
createPeerTargetDatabase
in interface DataSafe
request
- The request object containing the details to sendpublic CreateReportDefinitionResponse createReportDefinition(CreateReportDefinitionRequest request)
DataSafe
Creates a new report definition with parameters specified in the body. The report definition is stored in the specified compartment.
createReportDefinition
in interface DataSafe
request
- The request object containing the details to sendpublic CreateSdmMaskingPolicyDifferenceResponse createSdmMaskingPolicyDifference(CreateSdmMaskingPolicyDifferenceRequest request)
DataSafe
Creates SDM masking policy difference for the specified masking policy. It finds the difference between masking columns of the masking policy and sensitive columns of the SDM. After performing this operation, you can use ListDifferenceColumns to view the difference columns, PatchSdmMaskingPolicyDifferenceColumns to specify the action you want perform on these columns, and then ApplySdmMaskingPolicyDifference to process the difference columns and apply them to the masking policy.
createSdmMaskingPolicyDifference
in interface DataSafe
request
- The request object containing the details to sendpublic CreateSecurityAssessmentResponse createSecurityAssessment(CreateSecurityAssessmentRequest request)
DataSafe
Creates a new saved security assessment for one or multiple targets in a compartment. When this operation is performed, it will save the latest assessments in the specified compartment. If a schedule is passed, it will persist the latest assessments, at the defined date and time, in the format defined by RFC3339.
createSecurityAssessment
in interface DataSafe
request
- The request object containing the details to sendpublic CreateSensitiveColumnResponse createSensitiveColumn(CreateSensitiveColumnRequest request)
DataSafe
Creates a new sensitive column in the specified sensitive data model.
createSensitiveColumn
in interface DataSafe
request
- The request object containing the details to sendpublic CreateSensitiveDataModelResponse createSensitiveDataModel(CreateSensitiveDataModelRequest request)
DataSafe
Creates a new sensitive data model. If schemas and sensitive types are provided, it automatically runs data discovery and adds the discovered columns to the sensitive data model. Otherwise, it creates an empty sensitive data model that can be updated later.
createSensitiveDataModel
in interface DataSafe
request
- The request object containing the details to sendpublic CreateSensitiveTypeResponse createSensitiveType(CreateSensitiveTypeRequest request)
DataSafe
Creates a new sensitive type, which can be a basic sensitive type with regular expressions or a sensitive category. While sensitive types are used for data discovery, sensitive categories are used for logically grouping the related or similar sensitive types.
createSensitiveType
in interface DataSafe
request
- The request object containing the details to sendpublic CreateSqlCollectionResponse createSqlCollection(CreateSqlCollectionRequest request)
DataSafe
Creates a new SQL collection resource.
createSqlCollection
in interface DataSafe
request
- The request object containing the details to sendpublic CreateTargetAlertPolicyAssociationResponse createTargetAlertPolicyAssociation(CreateTargetAlertPolicyAssociationRequest request)
DataSafe
Creates a new target-alert policy association to track a alert policy applied on target.
createTargetAlertPolicyAssociation
in interface DataSafe
request
- The request object containing the details to sendpublic CreateTargetDatabaseResponse createTargetDatabase(CreateTargetDatabaseRequest request)
DataSafe
Registers the specified database with Data Safe and creates a Data Safe target database in the Data Safe Console.
createTargetDatabase
in interface DataSafe
request
- The request object containing the details to sendpublic CreateUserAssessmentResponse createUserAssessment(CreateUserAssessmentRequest request)
DataSafe
Creates a new saved user assessment for one or multiple targets in a compartment. It saves the latest assessments in the specified compartment. If a scheduled is passed in, this operation persists the latest assessments that exist at the defined date and time, in the format defined by RFC3339.
createUserAssessment
in interface DataSafe
request
- The request object containing the details to sendpublic DeactivateTargetDatabaseResponse deactivateTargetDatabase(DeactivateTargetDatabaseRequest request)
DataSafe
Deactivates a target database in Data Safe.
deactivateTargetDatabase
in interface DataSafe
request
- The request object containing the details to sendpublic DeleteAlertPolicyResponse deleteAlertPolicy(DeleteAlertPolicyRequest request)
DataSafe
Deletes the specified user-defined alert policy.
deleteAlertPolicy
in interface DataSafe
request
- The request object containing the details to sendpublic DeleteAlertPolicyRuleResponse deleteAlertPolicyRule(DeleteAlertPolicyRuleRequest request)
DataSafe
Deletes the specified user-defined alert policy rule.
deleteAlertPolicyRule
in interface DataSafe
request
- The request object containing the details to sendpublic DeleteAuditArchiveRetrievalResponse deleteAuditArchiveRetrieval(DeleteAuditArchiveRetrievalRequest request)
DataSafe
To unload retrieved archive data, call the operation ListAuditArchiveRetrieval first. This will return the auditArchiveRetrievalId. Then call this operation with auditArchiveRetrievalId.
deleteAuditArchiveRetrieval
in interface DataSafe
request
- The request object containing the details to sendpublic DeleteAuditTrailResponse deleteAuditTrail(DeleteAuditTrailRequest request)
DataSafe
Deletes the specified audit trail.
deleteAuditTrail
in interface DataSafe
request
- The request object containing the details to sendpublic DeleteDataSafePrivateEndpointResponse deleteDataSafePrivateEndpoint(DeleteDataSafePrivateEndpointRequest request)
DataSafe
Deletes the specified Data Safe private endpoint.
deleteDataSafePrivateEndpoint
in interface DataSafe
request
- The request object containing the details to sendpublic DeleteDiscoveryJobResponse deleteDiscoveryJob(DeleteDiscoveryJobRequest request)
DataSafe
Deletes the specified discovery job.
deleteDiscoveryJob
in interface DataSafe
request
- The request object containing the details to sendpublic DeleteDiscoveryJobResultResponse deleteDiscoveryJobResult(DeleteDiscoveryJobResultRequest request)
DataSafe
Deletes the specified discovery result.
deleteDiscoveryJobResult
in interface DataSafe
request
- The request object containing the details to sendpublic DeleteLibraryMaskingFormatResponse deleteLibraryMaskingFormat(DeleteLibraryMaskingFormatRequest request)
DataSafe
Deletes the specified library masking format.
deleteLibraryMaskingFormat
in interface DataSafe
request
- The request object containing the details to sendpublic DeleteMaskingColumnResponse deleteMaskingColumn(DeleteMaskingColumnRequest request)
DataSafe
Deletes the specified masking column.
deleteMaskingColumn
in interface DataSafe
request
- The request object containing the details to sendpublic DeleteMaskingPolicyResponse deleteMaskingPolicy(DeleteMaskingPolicyRequest request)
DataSafe
Deletes the specified masking policy.
deleteMaskingPolicy
in interface DataSafe
request
- The request object containing the details to sendpublic DeleteMaskingPolicyHealthReportResponse deleteMaskingPolicyHealthReport(DeleteMaskingPolicyHealthReportRequest request)
DataSafe
Deletes the specified masking policy health report.
deleteMaskingPolicyHealthReport
in interface DataSafe
request
- The request object containing the details to sendpublic DeleteOnPremConnectorResponse deleteOnPremConnector(DeleteOnPremConnectorRequest request)
DataSafe
Deletes the specified on-premises connector.
deleteOnPremConnector
in interface DataSafe
request
- The request object containing the details to sendpublic DeletePeerTargetDatabaseResponse deletePeerTargetDatabase(DeletePeerTargetDatabaseRequest request)
DataSafe
Removes the specified peer target database from Data Safe.
deletePeerTargetDatabase
in interface DataSafe
request
- The request object containing the details to sendpublic DeleteReportDefinitionResponse deleteReportDefinition(DeleteReportDefinitionRequest request)
DataSafe
Deletes the specified report definition. Only the user created report definition can be deleted. The seeded report definitions cannot be deleted.
deleteReportDefinition
in interface DataSafe
request
- The request object containing the details to sendpublic DeleteSdmMaskingPolicyDifferenceResponse deleteSdmMaskingPolicyDifference(DeleteSdmMaskingPolicyDifferenceRequest request)
DataSafe
Deletes the specified SDM Masking policy difference.
deleteSdmMaskingPolicyDifference
in interface DataSafe
request
- The request object containing the details to sendpublic DeleteSecurityAssessmentResponse deleteSecurityAssessment(DeleteSecurityAssessmentRequest request)
DataSafe
Deletes the specified saved security assessment or schedule. To delete a security assessment schedule, first call the operation ListSecurityAssessments with filters "type = save_schedule". That operation returns the scheduleAssessmentId. Then, call DeleteSecurityAssessment with the scheduleAssessmentId. If the assessment being deleted is the baseline for that compartment, then it will impact all baselines in the compartment.
deleteSecurityAssessment
in interface DataSafe
request
- The request object containing the details to sendpublic DeleteSensitiveColumnResponse deleteSensitiveColumn(DeleteSensitiveColumnRequest request)
DataSafe
Deletes the specified sensitive column.
deleteSensitiveColumn
in interface DataSafe
request
- The request object containing the details to sendpublic DeleteSensitiveDataModelResponse deleteSensitiveDataModel(DeleteSensitiveDataModelRequest request)
DataSafe
Deletes the specified sensitive data model.
deleteSensitiveDataModel
in interface DataSafe
request
- The request object containing the details to sendpublic DeleteSensitiveTypeResponse deleteSensitiveType(DeleteSensitiveTypeRequest request)
DataSafe
Deletes the specified sensitive type.
deleteSensitiveType
in interface DataSafe
request
- The request object containing the details to sendpublic DeleteSqlCollectionResponse deleteSqlCollection(DeleteSqlCollectionRequest request)
DataSafe
Deletes the specified SQL collection.
deleteSqlCollection
in interface DataSafe
request
- The request object containing the details to sendpublic DeleteSqlFirewallAllowedSqlResponse deleteSqlFirewallAllowedSql(DeleteSqlFirewallAllowedSqlRequest request)
DataSafe
Deletes the specified allowed sql.
deleteSqlFirewallAllowedSql
in interface DataSafe
request
- The request object containing the details to sendpublic DeleteSqlFirewallPolicyResponse deleteSqlFirewallPolicy(DeleteSqlFirewallPolicyRequest request)
DataSafe
Deletes the SQL Firewall policy resource.
deleteSqlFirewallPolicy
in interface DataSafe
request
- The request object containing the details to sendpublic DeleteTargetAlertPolicyAssociationResponse deleteTargetAlertPolicyAssociation(DeleteTargetAlertPolicyAssociationRequest request)
DataSafe
Deletes the specified target-alert policy Association.
deleteTargetAlertPolicyAssociation
in interface DataSafe
request
- The request object containing the details to sendpublic DeleteTargetDatabaseResponse deleteTargetDatabase(DeleteTargetDatabaseRequest request)
DataSafe
Deregisters the specified database from Data Safe and removes the target database from the Data Safe Console.
deleteTargetDatabase
in interface DataSafe
request
- The request object containing the details to sendpublic DeleteUserAssessmentResponse deleteUserAssessment(DeleteUserAssessmentRequest request)
DataSafe
Deletes the specified saved user assessment or schedule. To delete a user assessment schedule, first call the operation ListUserAssessments with filters "type = save_schedule". That call returns the scheduleAssessmentId. Then call DeleteUserAssessment with the scheduleAssessmentId. If the assessment being deleted is the baseline for that compartment, then it will impact all baselines in the compartment.
deleteUserAssessment
in interface DataSafe
request
- The request object containing the details to sendpublic DiscoverAuditTrailsResponse discoverAuditTrails(DiscoverAuditTrailsRequest request)
DataSafe
Updates the list of audit trails created under audit profile.The operation can be used to create new audit trails for target database when they become available for audit collection because of change of database version or change of database unified mode or change of data base edition or being deleted previously etc.
discoverAuditTrails
in interface DataSafe
request
- The request object containing the details to sendpublic DownloadDiscoveryReportResponse downloadDiscoveryReport(DownloadDiscoveryReportRequest request)
DataSafe
Downloads an already-generated discovery report. Note that the GenerateDiscoveryReportForDownload operation is a prerequisite for the DownloadDiscoveryReport operation. Use GenerateDiscoveryReportForDownload to generate a discovery report file and then use DownloadDiscoveryReport to download the generated file. By default, it downloads report for all the columns in a sensitive data model. Use the discoveryJobId attribute to download report for a specific discovery job.
downloadDiscoveryReport
in interface DataSafe
request
- The request object containing the details to sendpublic DownloadMaskingLogResponse downloadMaskingLog(DownloadMaskingLogRequest request)
DataSafe
Downloads the masking log generated by the last masking operation on a target database using the specified masking policy.
downloadMaskingLog
in interface DataSafe
request
- The request object containing the details to sendpublic DownloadMaskingPolicyResponse downloadMaskingPolicy(DownloadMaskingPolicyRequest request)
DataSafe
Downloads an already-generated file corresponding to the specified masking policy. Note that the GenerateMaskingPolicyForDownload operation is a prerequisite for the DownloadMaskingPolicy operation. Use GenerateMaskingPolicyForDownload to generate a masking policy file and then use DownloadMaskingPolicy to download the generated file.
downloadMaskingPolicy
in interface DataSafe
request
- The request object containing the details to sendpublic DownloadMaskingReportResponse downloadMaskingReport(DownloadMaskingReportRequest request)
DataSafe
Downloads an already-generated masking report. Note that the GenerateMaskingReportForDownload operation is a prerequisite for the DownloadMaskingReport operation. Use GenerateMaskingReportForDownload to generate a masking report file and then use DownloadMaskingReport to download the generated file.
downloadMaskingReport
in interface DataSafe
request
- The request object containing the details to sendpublic DownloadPrivilegeScriptResponse downloadPrivilegeScript(DownloadPrivilegeScriptRequest request)
DataSafe
Downloads the privilege script to grant/revoke required roles from the Data Safe account on the target database.
downloadPrivilegeScript
in interface DataSafe
request
- The request object containing the details to sendpublic DownloadSecurityAssessmentReportResponse downloadSecurityAssessmentReport(DownloadSecurityAssessmentReportRequest request)
DataSafe
Downloads the report of the specified security assessment. To download the security assessment report, it needs to be generated first. Please use GenerateSecurityAssessmentReport to generate a downloadable report in the preferred format (PDF, XLS).
downloadSecurityAssessmentReport
in interface DataSafe
request
- The request object containing the details to sendpublic DownloadSensitiveDataModelResponse downloadSensitiveDataModel(DownloadSensitiveDataModelRequest request)
DataSafe
Downloads an already-generated file corresponding to the specified sensitive data model. Note that the GenerateSensitiveDataModelForDownload operation is a prerequisite for the DownloadSensitiveDataModel operation. Use GenerateSensitiveDataModelForDownload to generate a data model file and then use DownloadSensitiveDataModel to download the generated file.
downloadSensitiveDataModel
in interface DataSafe
request
- The request object containing the details to sendpublic DownloadUserAssessmentReportResponse downloadUserAssessmentReport(DownloadUserAssessmentReportRequest request)
DataSafe
Downloads the report of the specified user assessment. To download the user assessment report, it needs to be generated first. Please use GenerateUserAssessmentReport to generate a downloadable report in the preferred format (PDF, XLS).
downloadUserAssessmentReport
in interface DataSafe
request
- The request object containing the details to sendpublic EnableDataSafeConfigurationResponse enableDataSafeConfiguration(EnableDataSafeConfigurationRequest request)
DataSafe
Enables Data Safe in the tenancy and region.
enableDataSafeConfiguration
in interface DataSafe
request
- The request object containing the details to sendpublic GenerateDiscoveryReportForDownloadResponse generateDiscoveryReportForDownload(GenerateDiscoveryReportForDownloadRequest request)
DataSafe
Generates a downloadable discovery report. It’s a prerequisite for the DownloadDiscoveryReport operation. Use this endpoint to generate a discovery report file and then use DownloadDiscoveryReport to download the generated file. By default, it generates report for all the columns in a sensitive data model. Use the discoveryJobId attribute to generate report for a specific discovery job.
generateDiscoveryReportForDownload
in interface DataSafe
request
- The request object containing the details to sendpublic GenerateHealthReportResponse generateHealthReport(GenerateHealthReportRequest request)
DataSafe
Performs health check on the masking policy.
generateHealthReport
in interface DataSafe
request
- The request object containing the details to sendpublic GenerateMaskingPolicyForDownloadResponse generateMaskingPolicyForDownload(GenerateMaskingPolicyForDownloadRequest request)
DataSafe
Generates a downloadable file corresponding to the specified masking policy. It’s a prerequisite for the DownloadMaskingPolicy operation. Use this endpoint to generate a masking policy file and then use DownloadMaskingPolicy to download the generated file. Note that file generation and download are serial operations. The download operation can’t be invoked while the generate operation is in progress.
generateMaskingPolicyForDownload
in interface DataSafe
request
- The request object containing the details to sendpublic GenerateMaskingReportForDownloadResponse generateMaskingReportForDownload(GenerateMaskingReportForDownloadRequest request)
DataSafe
Generates a downloadable masking report. It’s a prerequisite for the DownloadMaskingReport operation. Use this endpoint to generate a masking report file and then use DownloadMaskingReport to download the generated file.
generateMaskingReportForDownload
in interface DataSafe
request
- The request object containing the details to sendpublic GenerateOnPremConnectorConfigurationResponse generateOnPremConnectorConfiguration(GenerateOnPremConnectorConfigurationRequest request)
DataSafe
Creates and downloads the configuration of the specified on-premises connector.
generateOnPremConnectorConfiguration
in interface DataSafe
request
- The request object containing the details to sendpublic GenerateReportResponse generateReport(GenerateReportRequest request)
DataSafe
Generates a .xls or .pdf report based on parameters and report definition.
generateReport
in interface DataSafe
request
- The request object containing the details to sendpublic GenerateSecurityAssessmentReportResponse generateSecurityAssessmentReport(GenerateSecurityAssessmentReportRequest request)
DataSafe
Generates the report of the specified security assessment. You can get the report in PDF or XLS format. After generating the report, use DownloadSecurityAssessmentReport to download it in the preferred format.
generateSecurityAssessmentReport
in interface DataSafe
request
- The request object containing the details to sendpublic GenerateSensitiveDataModelForDownloadResponse generateSensitiveDataModelForDownload(GenerateSensitiveDataModelForDownloadRequest request)
DataSafe
Generates a downloadable file corresponding to the specified sensitive data model. It’s a prerequisite for the DownloadSensitiveDataModel operation. Use this endpoint to generate a data model file and then use DownloadSensitiveDataModel to download the generated file. Note that file generation and download are serial operations. The download operation can’t be invoked while the generate operation is in progress.
generateSensitiveDataModelForDownload
in interface DataSafe
request
- The request object containing the details to sendpublic GenerateSqlFirewallPolicyResponse generateSqlFirewallPolicy(GenerateSqlFirewallPolicyRequest request)
DataSafe
Generates or appends to the SQL Firewall policy using the specified SQL collection.
generateSqlFirewallPolicy
in interface DataSafe
request
- The request object containing the details to sendpublic GenerateUserAssessmentReportResponse generateUserAssessmentReport(GenerateUserAssessmentReportRequest request)
DataSafe
Generates the report of the specified user assessment. The report is available in PDF or XLS format. After generating the report, use DownloadUserAssessmentReport to download it in the preferred format.
generateUserAssessmentReport
in interface DataSafe
request
- The request object containing the details to sendpublic GetAlertResponse getAlert(GetAlertRequest request)
DataSafe
Gets the details of the specified alerts.
public GetAlertPolicyResponse getAlertPolicy(GetAlertPolicyRequest request)
DataSafe
Gets the details of alert policy by its ID.
getAlertPolicy
in interface DataSafe
request
- The request object containing the details to sendpublic GetAlertPolicyRuleResponse getAlertPolicyRule(GetAlertPolicyRuleRequest request)
DataSafe
Gets the details of a policy rule by its key.
getAlertPolicyRule
in interface DataSafe
request
- The request object containing the details to sendpublic GetAuditArchiveRetrievalResponse getAuditArchiveRetrieval(GetAuditArchiveRetrievalRequest request)
DataSafe
Gets the details of the specified archive retreival.
getAuditArchiveRetrieval
in interface DataSafe
request
- The request object containing the details to sendpublic GetAuditPolicyResponse getAuditPolicy(GetAuditPolicyRequest request)
DataSafe
Gets a audit policy by identifier.
getAuditPolicy
in interface DataSafe
request
- The request object containing the details to sendpublic GetAuditProfileResponse getAuditProfile(GetAuditProfileRequest request)
DataSafe
Gets the details of audit profile resource and associated audit trails of the audit profile.
getAuditProfile
in interface DataSafe
request
- The request object containing the details to sendpublic GetAuditTrailResponse getAuditTrail(GetAuditTrailRequest request)
DataSafe
Gets the details of audit trail.
getAuditTrail
in interface DataSafe
request
- The request object containing the details to sendpublic GetCompatibleFormatsForDataTypesResponse getCompatibleFormatsForDataTypes(GetCompatibleFormatsForDataTypesRequest request)
DataSafe
Gets a list of basic masking formats compatible with the supported data types. The data types are grouped into the following categories - Character - Includes CHAR, NCHAR, VARCHAR2, and NVARCHAR2 Numeric - Includes NUMBER, FLOAT, RAW, BINARY_FLOAT, and BINARY_DOUBLE Date - Includes DATE and TIMESTAMP LOB - Includes BLOB, CLOB, and NCLOB All - Includes all the supported data types
getCompatibleFormatsForDataTypes
in interface DataSafe
request
- The request object containing the details to sendpublic GetCompatibleFormatsForSensitiveTypesResponse getCompatibleFormatsForSensitiveTypes(GetCompatibleFormatsForSensitiveTypesRequest request)
DataSafe
Gets a list of library masking formats compatible with the existing sensitive types. For each sensitive type, it returns the assigned default masking format as well as the other library masking formats that have the sensitiveTypeIds attribute containing the OCID of the sensitive type.
getCompatibleFormatsForSensitiveTypes
in interface DataSafe
request
- The request object containing the details to sendpublic GetDataSafeConfigurationResponse getDataSafeConfiguration(GetDataSafeConfigurationRequest request)
DataSafe
Gets the details of the Data Safe configuration.
getDataSafeConfiguration
in interface DataSafe
request
- The request object containing the details to sendpublic GetDataSafePrivateEndpointResponse getDataSafePrivateEndpoint(GetDataSafePrivateEndpointRequest request)
DataSafe
Gets the details of the specified Data Safe private endpoint.
getDataSafePrivateEndpoint
in interface DataSafe
request
- The request object containing the details to sendpublic GetDatabaseSecurityConfigResponse getDatabaseSecurityConfig(GetDatabaseSecurityConfigRequest request)
DataSafe
Gets a database security configuration by identifier.
getDatabaseSecurityConfig
in interface DataSafe
request
- The request object containing the details to sendpublic GetDatabaseTableAccessEntryResponse getDatabaseTableAccessEntry(GetDatabaseTableAccessEntryRequest request)
DataSafe
Gets a database table access entry object by identifier.
getDatabaseTableAccessEntry
in interface DataSafe
request
- The request object containing the details to sendpublic GetDatabaseViewAccessEntryResponse getDatabaseViewAccessEntry(GetDatabaseViewAccessEntryRequest request)
DataSafe
Gets a database view access object by identifier.
getDatabaseViewAccessEntry
in interface DataSafe
request
- The request object containing the details to sendpublic GetDifferenceColumnResponse getDifferenceColumn(GetDifferenceColumnRequest request)
DataSafe
Gets the details of the specified SDM Masking policy difference column.
getDifferenceColumn
in interface DataSafe
request
- The request object containing the details to sendpublic GetDiscoveryJobResponse getDiscoveryJob(GetDiscoveryJobRequest request)
DataSafe
Gets the details of the specified discovery job.
getDiscoveryJob
in interface DataSafe
request
- The request object containing the details to sendpublic GetDiscoveryJobResultResponse getDiscoveryJobResult(GetDiscoveryJobResultRequest request)
DataSafe
Gets the details of the specified discovery result.
getDiscoveryJobResult
in interface DataSafe
request
- The request object containing the details to sendpublic GetLibraryMaskingFormatResponse getLibraryMaskingFormat(GetLibraryMaskingFormatRequest request)
DataSafe
Gets the details of the specified library masking format.
getLibraryMaskingFormat
in interface DataSafe
request
- The request object containing the details to sendpublic GetMaskingColumnResponse getMaskingColumn(GetMaskingColumnRequest request)
DataSafe
Gets the details of the specified masking column.
getMaskingColumn
in interface DataSafe
request
- The request object containing the details to sendpublic GetMaskingPolicyResponse getMaskingPolicy(GetMaskingPolicyRequest request)
DataSafe
Gets the details of the specified masking policy.
getMaskingPolicy
in interface DataSafe
request
- The request object containing the details to sendpublic GetMaskingPolicyHealthReportResponse getMaskingPolicyHealthReport(GetMaskingPolicyHealthReportRequest request)
DataSafe
Gets the details of the specified masking policy health report.
getMaskingPolicyHealthReport
in interface DataSafe
request
- The request object containing the details to sendpublic GetMaskingReportResponse getMaskingReport(GetMaskingReportRequest request)
DataSafe
Gets the details of the specified masking report.
getMaskingReport
in interface DataSafe
request
- The request object containing the details to sendpublic GetOnPremConnectorResponse getOnPremConnector(GetOnPremConnectorRequest request)
DataSafe
Gets the details of the specified on-premises connector.
getOnPremConnector
in interface DataSafe
request
- The request object containing the details to sendpublic GetPeerTargetDatabaseResponse getPeerTargetDatabase(GetPeerTargetDatabaseRequest request)
DataSafe
Returns the details of the specified Data Safe peer target database.
getPeerTargetDatabase
in interface DataSafe
request
- The request object containing the details to sendpublic GetProfileResponse getProfile(GetProfileRequest request)
DataSafe
Lists the details of given profile available on the target.
The GetProfile operation returns only the profiles in the specified 'userAssessmentId'. This does not include any subcompartments of the current compartment.
getProfile
in interface DataSafe
request
- The request object containing the details to sendpublic GetReportResponse getReport(GetReportRequest request)
DataSafe
Gets a report by identifier
public GetReportContentResponse getReportContent(GetReportContentRequest request)
DataSafe
Downloads the specified report in the form of .xls or .pdf.
getReportContent
in interface DataSafe
request
- The request object containing the details to sendpublic GetReportDefinitionResponse getReportDefinition(GetReportDefinitionRequest request)
DataSafe
Gets the details of report definition specified by the identifier
getReportDefinition
in interface DataSafe
request
- The request object containing the details to sendpublic GetSdmMaskingPolicyDifferenceResponse getSdmMaskingPolicyDifference(GetSdmMaskingPolicyDifferenceRequest request)
DataSafe
Gets the details of the specified SDM Masking policy difference.
getSdmMaskingPolicyDifference
in interface DataSafe
request
- The request object containing the details to sendpublic GetSecurityAssessmentResponse getSecurityAssessment(GetSecurityAssessmentRequest request)
DataSafe
Gets the details of the specified security assessment.
getSecurityAssessment
in interface DataSafe
request
- The request object containing the details to sendpublic GetSecurityAssessmentComparisonResponse getSecurityAssessmentComparison(GetSecurityAssessmentComparisonRequest request)
DataSafe
Gets the details of the comparison report for the security assessments submitted for comparison.
getSecurityAssessmentComparison
in interface DataSafe
request
- The request object containing the details to sendpublic GetSecurityPolicyResponse getSecurityPolicy(GetSecurityPolicyRequest request)
DataSafe
Gets a security policy by the specified OCID of the security policy resource.
getSecurityPolicy
in interface DataSafe
request
- The request object containing the details to sendpublic GetSecurityPolicyDeploymentResponse getSecurityPolicyDeployment(GetSecurityPolicyDeploymentRequest request)
DataSafe
Gets a security policy deployment by identifier.
getSecurityPolicyDeployment
in interface DataSafe
request
- The request object containing the details to sendpublic GetSecurityPolicyEntryStateResponse getSecurityPolicyEntryState(GetSecurityPolicyEntryStateRequest request)
DataSafe
Gets a security policy entity states by identifier.
getSecurityPolicyEntryState
in interface DataSafe
request
- The request object containing the details to sendpublic GetSecurityPolicyReportResponse getSecurityPolicyReport(GetSecurityPolicyReportRequest request)
DataSafe
Gets a security policy report by the specified OCID of the security policy report resource.
getSecurityPolicyReport
in interface DataSafe
request
- The request object containing the details to sendpublic GetSensitiveColumnResponse getSensitiveColumn(GetSensitiveColumnRequest request)
DataSafe
Gets the details of the specified sensitive column.
getSensitiveColumn
in interface DataSafe
request
- The request object containing the details to sendpublic GetSensitiveDataModelResponse getSensitiveDataModel(GetSensitiveDataModelRequest request)
DataSafe
Gets the details of the specified sensitive data model.
getSensitiveDataModel
in interface DataSafe
request
- The request object containing the details to sendpublic GetSensitiveTypeResponse getSensitiveType(GetSensitiveTypeRequest request)
DataSafe
Gets the details of the specified sensitive type.
getSensitiveType
in interface DataSafe
request
- The request object containing the details to sendpublic GetSqlCollectionResponse getSqlCollection(GetSqlCollectionRequest request)
DataSafe
Gets a SQL collection by identifier.
getSqlCollection
in interface DataSafe
request
- The request object containing the details to sendpublic GetSqlFirewallAllowedSqlResponse getSqlFirewallAllowedSql(GetSqlFirewallAllowedSqlRequest request)
DataSafe
Gets a SQL firewall allowed SQL by identifier.
getSqlFirewallAllowedSql
in interface DataSafe
request
- The request object containing the details to sendpublic GetSqlFirewallPolicyResponse getSqlFirewallPolicy(GetSqlFirewallPolicyRequest request)
DataSafe
Gets a SQL Firewall policy by identifier.
getSqlFirewallPolicy
in interface DataSafe
request
- The request object containing the details to sendpublic GetTargetAlertPolicyAssociationResponse getTargetAlertPolicyAssociation(GetTargetAlertPolicyAssociationRequest request)
DataSafe
Gets the details of target-alert policy association by its ID.
getTargetAlertPolicyAssociation
in interface DataSafe
request
- The request object containing the details to sendpublic GetTargetDatabaseResponse getTargetDatabase(GetTargetDatabaseRequest request)
DataSafe
Returns the details of the specified Data Safe target database.
getTargetDatabase
in interface DataSafe
request
- The request object containing the details to sendpublic GetUserAssessmentResponse getUserAssessment(GetUserAssessmentRequest request)
DataSafe
Gets a user assessment by identifier.
getUserAssessment
in interface DataSafe
request
- The request object containing the details to sendpublic GetUserAssessmentComparisonResponse getUserAssessmentComparison(GetUserAssessmentComparisonRequest request)
DataSafe
Gets the details of the comparison report for the user assessments submitted for comparison.
getUserAssessmentComparison
in interface DataSafe
request
- The request object containing the details to sendpublic GetWorkRequestResponse getWorkRequest(GetWorkRequestRequest request)
DataSafe
Gets the details of the specified work request.
getWorkRequest
in interface DataSafe
request
- The request object containing the details to sendpublic ListAlertAnalyticsResponse listAlertAnalytics(ListAlertAnalyticsRequest request)
DataSafe
Returns the aggregation details of the alerts.
listAlertAnalytics
in interface DataSafe
request
- The request object containing the details to sendpublic ListAlertPoliciesResponse listAlertPolicies(ListAlertPoliciesRequest request)
DataSafe
Gets a list of all alert policies.
listAlertPolicies
in interface DataSafe
request
- The request object containing the details to sendpublic ListAlertPolicyRulesResponse listAlertPolicyRules(ListAlertPolicyRulesRequest request)
DataSafe
Lists the rules of the specified alert policy. The alert policy is said to be satisfied when all rules in the policy evaulate to true. If there are three rules: rule1,rule2 and rule3, the policy is satisfied if rule1 AND rule2 AND rule3 is True.
listAlertPolicyRules
in interface DataSafe
request
- The request object containing the details to sendpublic ListAlertsResponse listAlerts(ListAlertsRequest request)
DataSafe
Gets a list of all alerts.
listAlerts
in interface DataSafe
request
- The request object containing the details to sendpublic ListAuditArchiveRetrievalsResponse listAuditArchiveRetrievals(ListAuditArchiveRetrievalsRequest request)
DataSafe
Returns the list of audit archive retrieval.
listAuditArchiveRetrievals
in interface DataSafe
request
- The request object containing the details to sendpublic ListAuditEventAnalyticsResponse listAuditEventAnalytics(ListAuditEventAnalyticsRequest request)
DataSafe
By default the ListAuditEventAnalytics operation will return all of the summary columns. To
filter for a specific summary column, specify it in the summaryField
query parameter.
*Example:** /ListAuditEventAnalytics?summaryField=targetName&summaryField=userName&summaryField=clientHostname &summaryField=dmls&summaryField=privilegeChanges&summaryField=ddls&summaryField=loginFailure&summaryField=loginSuccess &summaryField=allRecord&q=(auditEventTime ge \"2021-06-13T23:49:14\")
/ListAuditEventAnalytics?timeStarted=2022-08-18T11:02:26.000Z&timeEnded=2022-08-24T11:02:26.000Z This will give number of events grouped by periods. Period can be 1 day, 1 week, etc.
/ListAuditEventAnalytics?summaryField=targetName&groupBy=targetName This will give the number of events group by targetName. Only targetName summary column would be returned.
listAuditEventAnalytics
in interface DataSafe
request
- The request object containing the details to sendpublic ListAuditEventsResponse listAuditEvents(ListAuditEventsRequest request)
DataSafe
The ListAuditEvents operation returns specified compartmentId
audit Events only. The list
does not include any audit Events associated with the subcompartments
of the specified
compartmentId
.
The parameter `accessLevel` specifies whether to return only those compartments for which the requestor has INSPECT permissions on at least one resource directly or indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if Principal doesn't have access to even one of the child compartments. This is valid only when `compartmentIdInSubtree` is set to `true`.
The parameter `compartmentIdInSubtree` applies when you perform ListAuditEvents on the `compartmentId` passed and when it is set to true, the entire hierarchy of compartments can be returned. To get a full list of all compartments and subcompartments in the tenancy (root compartment), set the parameter `compartmentIdInSubtree` to true and `accessLevel` to ACCESSIBLE.
listAuditEvents
in interface DataSafe
request
- The request object containing the details to sendpublic ListAuditPoliciesResponse listAuditPolicies(ListAuditPoliciesRequest request)
DataSafe
Retrieves a list of all audited targets with their corresponding provisioned audit policies, and their provisioning conditions.
The ListAuditPolicies operation returns only the audit policies in the specified `compartmentId`. The list does not include any subcompartments of the compartmentId passed.
The parameter `accessLevel` specifies whether to return only those compartments for which the requestor has INSPECT permissions on at least one resource directly or indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if Principal doesn't have access to even one of the child compartments. This is valid only when `compartmentIdInSubtree` is set to `true`.
The parameter `compartmentIdInSubtree` applies when you perform ListAuditPolicies on the `compartmentId` passed and when it is set to true, the entire hierarchy of compartments can be returned. To get a full list of all compartments and subcompartments in the tenancy (root compartment), set the parameter `compartmentIdInSubtree` to true and `accessLevel` to ACCESSIBLE.
listAuditPolicies
in interface DataSafe
request
- The request object containing the details to sendpublic ListAuditPolicyAnalyticsResponse listAuditPolicyAnalytics(ListAuditPolicyAnalyticsRequest request)
DataSafe
Gets a list of aggregated audit policy details on the target databases. A audit policy aggregation helps understand the overall state of policies provisioned on targets. It is especially useful to create dashboards or to support analytics.
The parameter `accessLevel` specifies whether to return only those compartments for which the requestor has INSPECT permissions on at least one resource directly or indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if principal doesn't have access to even one of the child compartments. This is valid only when `compartmentIdInSubtree` is set to `true`.
The parameter `compartmentIdInSubtree` applies when you perform SummarizedAuditPolicyInfo on the specified `compartmentId` and when it is set to true, the entire hierarchy of compartments can be returned. To get a full list of all compartments and subcompartments in the tenancy (root compartment), set the parameter `compartmentIdInSubtree` to true and `accessLevel` to ACCESSIBLE.
*Example:** ListAuditPolicyAnalytics?groupBy=auditPolicyCategory
listAuditPolicyAnalytics
in interface DataSafe
request
- The request object containing the details to sendpublic ListAuditProfileAnalyticsResponse listAuditProfileAnalytics(ListAuditProfileAnalyticsRequest request)
DataSafe
Gets a list of audit profile aggregated details . A audit profile aggregation helps understand the overall state of audit profile profiles. As an example, it helps understand how many audit profiles have paid usage. It is especially useful to create dashboards or to support analytics.
The parameter `accessLevel` specifies whether to return only those compartments for which the requestor has INSPECT permissions on at least one resource directly or indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if Principal doesn't have access to even one of the child compartments. This is valid only when `compartmentIdInSubtree` is set to `true`.
The parameter `compartmentIdInSubtree` applies when you perform AuditProfileAnalytics on the `compartmentId` passed and when it is set to true, the entire hierarchy of compartments can be returned. To get a full list of all compartments and subcompartments in the tenancy (root compartment), set the parameter `compartmentIdInSubtree` to true and `accessLevel` to ACCESSIBLE.
listAuditProfileAnalytics
in interface DataSafe
request
- The request object containing the details to sendpublic ListAuditProfilesResponse listAuditProfiles(ListAuditProfilesRequest request)
DataSafe
Gets a list of all audit profiles.
The ListAuditProfiles operation returns only the audit profiles in the specified `compartmentId`. The list does not include any subcompartments of the compartmentId passed.
The parameter `accessLevel` specifies whether to return only those compartments for which the requestor has INSPECT permissions on at least one resource directly or indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if Principal doesn't have access to even one of the child compartments. This is valid only when `compartmentIdInSubtree` is set to `true`.
The parameter `compartmentIdInSubtree` applies when you perform ListAuditProfiles on the `compartmentId` passed and when it is set to true, the entire hierarchy of compartments can be returned. To get a full list of all compartments and subcompartments in the tenancy (root compartment), set the parameter `compartmentIdInSubtree` to true and `accessLevel` to ACCESSIBLE.
listAuditProfiles
in interface DataSafe
request
- The request object containing the details to sendpublic ListAuditTrailAnalyticsResponse listAuditTrailAnalytics(ListAuditTrailAnalyticsRequest request)
DataSafe
Gets a list of audit trail aggregated details . A audit trail aggregation helps understand the overall state of trails. As an example, it helps understand how many trails are running or stopped. It is especially useful to create dashboards or to support analytics.
The parameter `accessLevel` specifies whether to return only those compartments for which the requestor has INSPECT permissions on at least one resource directly or indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if Principal doesn't have access to even one of the child compartments. This is valid only when `compartmentIdInSubtree` is set to `true`.
The parameter `compartmentIdInSubtree` applies when you perform AuditTrailAnalytics on the `compartmentId` passed and when it is set to true, the entire hierarchy of compartments can be returned. To get a full list of all compartments and subcompartments in the tenancy (root compartment), set the parameter `compartmentIdInSubtree` to true and `accessLevel` to ACCESSIBLE.
listAuditTrailAnalytics
in interface DataSafe
request
- The request object containing the details to sendpublic ListAuditTrailsResponse listAuditTrails(ListAuditTrailsRequest request)
DataSafe
Gets a list of all audit trails. The ListAuditTrails operation returns only the audit trails
in the specified compartmentId
. The list does not include any subcompartments of the
compartmentId passed.
The parameter `accessLevel` specifies whether to return only those compartments for which the requestor has INSPECT permissions on at least one resource directly or indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if Principal doesn't have access to even one of the child compartments. This is valid only when `compartmentIdInSubtree` is set to `true`.
The parameter `compartmentIdInSubtree` applies when you perform ListAuditTrails on the `compartmentId` passed and when it is set to true, the entire hierarchy of compartments can be returned. To get a full list of all compartments and subcompartments in the tenancy (root compartment), set the parameter `compartmentIdInSubtree` to true and `accessLevel` to ACCESSIBLE.
listAuditTrails
in interface DataSafe
request
- The request object containing the details to sendpublic ListAvailableAuditVolumesResponse listAvailableAuditVolumes(ListAvailableAuditVolumesRequest request)
DataSafe
Retrieves a list of audit trails, and associated audit event volume for each trail up to defined start date.
listAvailableAuditVolumes
in interface DataSafe
request
- The request object containing the details to sendpublic ListCollectedAuditVolumesResponse listCollectedAuditVolumes(ListCollectedAuditVolumesRequest request)
DataSafe
Gets a list of all collected audit volume data points.
listCollectedAuditVolumes
in interface DataSafe
request
- The request object containing the details to sendpublic ListColumnsResponse listColumns(ListColumnsRequest request)
DataSafe
Returns a list of column metadata objects.
listColumns
in interface DataSafe
request
- The request object containing the details to sendpublic ListDataSafePrivateEndpointsResponse listDataSafePrivateEndpoints(ListDataSafePrivateEndpointsRequest request)
DataSafe
Gets a list of Data Safe private endpoints.
listDataSafePrivateEndpoints
in interface DataSafe
request
- The request object containing the details to sendpublic ListDatabaseSecurityConfigsResponse listDatabaseSecurityConfigs(ListDatabaseSecurityConfigsRequest request)
DataSafe
Retrieves a list of all database security configurations in Data Safe.
The ListDatabaseSecurityConfigs operation returns only the database security configurations in the specified `compartmentId`.
The parameter `accessLevel` specifies whether to return only those compartments for which the requestor has INSPECT permissions on at least one resource directly or indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if Principal doesn't have access to even one of the child compartments. This is valid only when `compartmentIdInSubtree` is set to `true`.
The parameter `compartmentIdInSubtree` applies when you perform ListDatabaseSecurityConfigs on the `compartmentId` passed and when it is set to true, the entire hierarchy of compartments can be returned. To get a full list of all compartments and subcompartments in the tenancy (root compartment), set the parameter `compartmentIdInSubtree` to true and `accessLevel` to ACCESSIBLE.
listDatabaseSecurityConfigs
in interface DataSafe
request
- The request object containing the details to sendpublic ListDatabaseTableAccessEntriesResponse listDatabaseTableAccessEntries(ListDatabaseTableAccessEntriesRequest request)
DataSafe
Retrieves a list of all database table access entries in Data Safe.
The ListDatabaseTableAccessEntries operation returns only the database table access reports for the specified security policy report.
listDatabaseTableAccessEntries
in interface DataSafe
request
- The request object containing the details to sendpublic ListDatabaseViewAccessEntriesResponse listDatabaseViewAccessEntries(ListDatabaseViewAccessEntriesRequest request)
DataSafe
Retrieves a list of all database view access entries in Data Safe.
The ListDatabaseViewAccessEntries operation returns only the database view access objects for the specified security policy report.
listDatabaseViewAccessEntries
in interface DataSafe
request
- The request object containing the details to sendpublic ListDifferenceColumnsResponse listDifferenceColumns(ListDifferenceColumnsRequest request)
DataSafe
Gets a list of columns of a SDM masking policy difference resource based on the specified query parameters.
listDifferenceColumns
in interface DataSafe
request
- The request object containing the details to sendpublic ListDiscoveryAnalyticsResponse listDiscoveryAnalytics(ListDiscoveryAnalyticsRequest request)
DataSafe
Gets consolidated discovery analytics data based on the specified query parameters. If CompartmentIdInSubtreeQueryParam is specified as true, the behaviour is equivalent to accessLevel "ACCESSIBLE" by default.
listDiscoveryAnalytics
in interface DataSafe
request
- The request object containing the details to sendpublic ListDiscoveryJobResultsResponse listDiscoveryJobResults(ListDiscoveryJobResultsRequest request)
DataSafe
Gets a list of discovery results based on the specified query parameters.
listDiscoveryJobResults
in interface DataSafe
request
- The request object containing the details to sendpublic ListDiscoveryJobsResponse listDiscoveryJobs(ListDiscoveryJobsRequest request)
DataSafe
Gets a list of incremental discovery jobs based on the specified query parameters.
listDiscoveryJobs
in interface DataSafe
request
- The request object containing the details to sendpublic ListFindingAnalyticsResponse listFindingAnalytics(ListFindingAnalyticsRequest request)
DataSafe
Gets a list of findings aggregated details in the specified compartment. This provides information about the overall state of security assessment findings. You can use groupBy to get the count of findings under a certain risk level and with a certain findingKey, and as well as get the list of the targets that match the condition. This data is especially useful content for the statistic chart or to support analytics.
When you perform the ListFindingAnalytics operation, if the parameter compartmentIdInSubtree is set to \"true,\" and if the parameter accessLevel is set to ACCESSIBLE, then the operation returns statistics from the compartments in which the requestor has INSPECT permissions on at least one resource, directly or indirectly (in subcompartments). If the operation is performed at the root compartment and the requestor does not have access to at least one subcompartment of the compartment specified by compartmentId, then \"Not Authorized\" is returned.
listFindingAnalytics
in interface DataSafe
request
- The request object containing the details to sendpublic ListFindingsResponse listFindings(ListFindingsRequest request)
DataSafe
List all the findings from all the targets in the specified compartment.
listFindings
in interface DataSafe
request
- The request object containing the details to sendpublic ListFindingsChangeAuditLogsResponse listFindingsChangeAuditLogs(ListFindingsChangeAuditLogsRequest request)
DataSafe
List all changes made by user to risk level of findings of the specified assessment.
listFindingsChangeAuditLogs
in interface DataSafe
request
- The request object containing the details to sendpublic ListGrantsResponse listGrants(ListGrantsRequest request)
DataSafe
Gets a list of grants for a particular user in the specified user assessment. A user grant contains details such as the privilege name, type, category, and depth level. The depth level indicates how deep in the hierarchy of roles granted to roles a privilege grant is. The userKey in this operation is a system-generated identifier. Perform the operation ListUsers to get the userKey for a particular user.
listGrants
in interface DataSafe
request
- The request object containing the details to sendpublic ListLibraryMaskingFormatsResponse listLibraryMaskingFormats(ListLibraryMaskingFormatsRequest request)
DataSafe
Gets a list of library masking formats based on the specified query parameters.
listLibraryMaskingFormats
in interface DataSafe
request
- The request object containing the details to sendpublic ListMaskedColumnsResponse listMaskedColumns(ListMaskedColumnsRequest request)
DataSafe
Gets a list of masked columns present in the specified masking report and based on the specified query parameters.
listMaskedColumns
in interface DataSafe
request
- The request object containing the details to sendpublic ListMaskingAnalyticsResponse listMaskingAnalytics(ListMaskingAnalyticsRequest request)
DataSafe
Gets consolidated masking analytics data based on the specified query parameters. If CompartmentIdInSubtreeQueryParam is specified as true, the behaviour is equivalent to accessLevel "ACCESSIBLE" by default.
listMaskingAnalytics
in interface DataSafe
request
- The request object containing the details to sendpublic ListMaskingColumnsResponse listMaskingColumns(ListMaskingColumnsRequest request)
DataSafe
Gets a list of masking columns present in the specified masking policy and based on the specified query parameters.
listMaskingColumns
in interface DataSafe
request
- The request object containing the details to sendpublic ListMaskingObjectsResponse listMaskingObjects(ListMaskingObjectsRequest request)
DataSafe
Gets a list of masking objects present in the specified masking policy and based on the specified query parameters.
listMaskingObjects
in interface DataSafe
request
- The request object containing the details to sendpublic ListMaskingPoliciesResponse listMaskingPolicies(ListMaskingPoliciesRequest request)
DataSafe
Gets a list of masking policies based on the specified query parameters.
listMaskingPolicies
in interface DataSafe
request
- The request object containing the details to sendpublic ListMaskingPolicyHealthReportLogsResponse listMaskingPolicyHealthReportLogs(ListMaskingPolicyHealthReportLogsRequest request)
DataSafe
Gets a list of errors and warnings from a masking policy health check.
listMaskingPolicyHealthReportLogs
in interface DataSafe
request
- The request object containing the details to sendpublic ListMaskingPolicyHealthReportsResponse listMaskingPolicyHealthReports(ListMaskingPolicyHealthReportsRequest request)
DataSafe
Gets a list of masking policy health reports based on the specified query parameters.
listMaskingPolicyHealthReports
in interface DataSafe
request
- The request object containing the details to sendpublic ListMaskingReportsResponse listMaskingReports(ListMaskingReportsRequest request)
DataSafe
Gets a list of masking reports based on the specified query parameters.
listMaskingReports
in interface DataSafe
request
- The request object containing the details to sendpublic ListMaskingSchemasResponse listMaskingSchemas(ListMaskingSchemasRequest request)
DataSafe
Gets a list of masking schemas present in the specified masking policy and based on the specified query parameters.
listMaskingSchemas
in interface DataSafe
request
- The request object containing the details to sendpublic ListOnPremConnectorsResponse listOnPremConnectors(ListOnPremConnectorsRequest request)
DataSafe
Gets a list of on-premises connectors.
listOnPremConnectors
in interface DataSafe
request
- The request object containing the details to sendpublic ListPeerTargetDatabasesResponse listPeerTargetDatabases(ListPeerTargetDatabasesRequest request)
DataSafe
Lists all the peer target databases under the primary target database identified by the OCID passed as path parameter.
listPeerTargetDatabases
in interface DataSafe
request
- The request object containing the details to sendpublic ListProfileAnalyticsResponse listProfileAnalytics(ListProfileAnalyticsRequest request)
DataSafe
Gets a list of aggregated user profile details in the specified compartment. This provides information about the overall profiles available. For example, the user profile details include how many users have the profile assigned and do how many use password verification function. This data is especially useful content for dashboards or to support analytics.
When you perform the ListProfileAnalytics operation, if the parameter compartmentIdInSubtree is set to \"true,\" and if the parameter accessLevel is set to ACCESSIBLE, then the operation returns compartments in which the requestor has INSPECT permissions on at least one resource, directly or indirectly (in subcompartments). If the operation is performed at the root compartment and the requestor does not have access to at least one subcompartment of the compartment specified by compartmentId, then \"Not Authorized\" is returned.
The parameter compartmentIdInSubtree applies when you perform ListProfileAnalytics on the compartmentId passed and when it is set to true, the entire hierarchy of compartments can be returned.
To use ListProfileAnalytics to get a full list of all compartments and subcompartments in the tenancy from the root compartment, set the parameter compartmentIdInSubtree to true and accessLevel to ACCESSIBLE.
listProfileAnalytics
in interface DataSafe
request
- The request object containing the details to sendpublic ListProfileSummariesResponse listProfileSummaries(ListProfileSummariesRequest request)
DataSafe
Gets a list of user profiles containing the profile details along with the target id and user counts.
The ListProfiles operation returns only the profiles belonging to a certain target. If compartment type user assessment id is provided, then profile information for all the targets belonging to the pertaining compartment is returned. The list does not include any subcompartments of the compartment under consideration.
The parameter 'accessLevel' specifies whether to return only those compartments for which the requestor has INSPECT permissions on at least one resource directly or indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if Principal doesn't have access to even one of the child compartments. This is valid only when 'compartmentIdInSubtree' is set to 'true'.
The parameter 'compartmentIdInSubtree' applies when you perform ListUserProfiles on the 'compartmentId' belonging to the assessmentId passed and when it is set to true, the entire hierarchy of compartments can be returned. To get a full list of all compartments and subcompartments in the tenancy (root compartment), set the parameter 'compartmentIdInSubtree' to true and 'accessLevel' to ACCESSIBLE.
listProfileSummaries
in interface DataSafe
request
- The request object containing the details to sendpublic ListReportDefinitionsResponse listReportDefinitions(ListReportDefinitionsRequest request)
DataSafe
Gets a list of report definitions. The ListReportDefinitions operation returns only the
report definitions in the specified compartmentId
. It also returns the seeded report
definitions which are available to all the compartments.
listReportDefinitions
in interface DataSafe
request
- The request object containing the details to sendpublic ListReportsResponse listReports(ListReportsRequest request)
DataSafe
Gets a list of all the reports in the compartment. It contains information such as report generation time.
listReports
in interface DataSafe
request
- The request object containing the details to sendpublic ListRoleGrantPathsResponse listRoleGrantPaths(ListRoleGrantPathsRequest request)
DataSafe
Retrieves a list of all role grant paths for a particular user.
The ListRoleGrantPaths operation returns only the role grant paths for the specified security policy report.
listRoleGrantPaths
in interface DataSafe
request
- The request object containing the details to sendpublic ListRolesResponse listRoles(ListRolesRequest request)
DataSafe
Returns a list of role metadata objects.
public ListSchemasResponse listSchemas(ListSchemasRequest request)
DataSafe
Returns list of schema.
listSchemas
in interface DataSafe
request
- The request object containing the details to sendpublic ListSdmMaskingPolicyDifferencesResponse listSdmMaskingPolicyDifferences(ListSdmMaskingPolicyDifferencesRequest request)
DataSafe
Gets a list of SDM and masking policy difference resources based on the specified query parameters.
listSdmMaskingPolicyDifferences
in interface DataSafe
request
- The request object containing the details to sendpublic ListSecurityAssessmentsResponse listSecurityAssessments(ListSecurityAssessmentsRequest request)
DataSafe
Gets a list of security assessments.
The ListSecurityAssessments operation returns only the assessments in the specified `compartmentId`. The list does not include any subcompartments of the compartmentId passed.
The parameter `accessLevel` specifies whether to return only those compartments for which the requestor has INSPECT permissions on at least one resource directly or indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if Principal doesn't have access to even one of the child compartments. This is valid only when `compartmentIdInSubtree` is set to `true`.
The parameter `compartmentIdInSubtree` applies when you perform ListSecurityAssessments on the `compartmentId` passed and when it is set to true, the entire hierarchy of compartments can be returned. To get a full list of all compartments and subcompartments in the tenancy (root compartment), set the parameter `compartmentIdInSubtree` to true and `accessLevel` to ACCESSIBLE.
listSecurityAssessments
in interface DataSafe
request
- The request object containing the details to sendpublic ListSecurityFeatureAnalyticsResponse listSecurityFeatureAnalytics(ListSecurityFeatureAnalyticsRequest request)
DataSafe
Gets a list of Database security feature usage aggregated details in the specified compartment. This provides information about the overall security controls, by returning the counting number of the target databases using the security features.
When you perform the ListSecurityFeatureAnalytics operation, if the parameter compartmentIdInSubtree is set to \"true,\" and if the parameter accessLevel is set to ACCESSIBLE, then the operation returns statistics from the compartments in which the requestor has INSPECT permissions on at least one resource, directly or indirectly (in subcompartments). If the operation is performed at the root compartment and the requestor does not have access to at least one subcompartment of the compartment specified by compartmentId, then \"Not Authorized\" is returned.
listSecurityFeatureAnalytics
in interface DataSafe
request
- The request object containing the details to sendpublic ListSecurityFeaturesResponse listSecurityFeatures(ListSecurityFeaturesRequest request)
DataSafe
Lists the usage of Database security features for a given compartment or a target level, based on the filters provided.
listSecurityFeatures
in interface DataSafe
request
- The request object containing the details to sendpublic ListSecurityPoliciesResponse listSecurityPolicies(ListSecurityPoliciesRequest request)
DataSafe
Retrieves a list of all security policies in Data Safe.
The ListSecurityPolicies operation returns only the security policies in the specified `compartmentId`.
The parameter `accessLevel` specifies whether to return only those compartments for which the requestor has INSPECT permissions on at least one resource directly or indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if Principal doesn't have access to even one of the child compartments. This is valid only when `compartmentIdInSubtree` is set to `true`.
The parameter `compartmentIdInSubtree` applies when you perform ListSecurityPolicies on the `compartmentId` passed and when it is set to true, the entire hierarchy of compartments can be returned. To get a full list of all compartments and subcompartments in the tenancy (root compartment), set the parameter `compartmentIdInSubtree` to true and `accessLevel` to ACCESSIBLE.
listSecurityPolicies
in interface DataSafe
request
- The request object containing the details to sendpublic ListSecurityPolicyDeploymentsResponse listSecurityPolicyDeployments(ListSecurityPolicyDeploymentsRequest request)
DataSafe
Retrieves a list of all security policy deployments in Data Safe.
The ListSecurityPolicyDeployments operation returns only the security policy deployments in the specified `compartmentId`.
The parameter `accessLevel` specifies whether to return only those compartments for which the requestor has INSPECT permissions on at least one resource directly or indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if Principal doesn't have access to even one of the child compartments. This is valid only when `compartmentIdInSubtree` is set to `true`.
The parameter `compartmentIdInSubtree` applies when you perform ListSecurityPolicyDeployments on the `compartmentId` passed and when it is set to true, the entire hierarchy of compartments can be returned. To get a full list of all compartments and subcompartments in the tenancy (root compartment), set the parameter `compartmentIdInSubtree` to true and `accessLevel` to ACCESSIBLE.
listSecurityPolicyDeployments
in interface DataSafe
request
- The request object containing the details to sendpublic ListSecurityPolicyEntryStatesResponse listSecurityPolicyEntryStates(ListSecurityPolicyEntryStatesRequest request)
DataSafe
Retrieves a list of all security policy entry states in Data Safe.
The ListSecurityPolicyEntryStates operation returns only the security policy entry states for the specified security policy entry.
listSecurityPolicyEntryStates
in interface DataSafe
request
- The request object containing the details to sendpublic ListSecurityPolicyReportsResponse listSecurityPolicyReports(ListSecurityPolicyReportsRequest request)
DataSafe
Retrieves a list of all security policy reports in Data Safe.
The ListSecurityPolicyReports operation returns only the security policy reports in the specified `compartmentId`.
The parameter `accessLevel` specifies whether to return only those compartments for which the requestor has INSPECT permissions on at least one resource directly or indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if Principal doesn't have access to even one of the child compartments. This is valid only when `compartmentIdInSubtree` is set to `true`.
The parameter `compartmentIdInSubtree` applies when you perform ListSecurityPolicyReports on the `compartmentId` passed and when it is set to true, the entire hierarchy of compartments can be returned. To get a full list of all compartments and subcompartments in the tenancy (root compartment), set the parameter `compartmentIdInSubtree` to true and `accessLevel` to ACCESSIBLE.
listSecurityPolicyReports
in interface DataSafe
request
- The request object containing the details to sendpublic ListSensitiveColumnsResponse listSensitiveColumns(ListSensitiveColumnsRequest request)
DataSafe
Gets a list of sensitive columns present in the specified sensitive data model based on the specified query parameters.
listSensitiveColumns
in interface DataSafe
request
- The request object containing the details to sendpublic ListSensitiveDataModelSensitiveTypesResponse listSensitiveDataModelSensitiveTypes(ListSensitiveDataModelSensitiveTypesRequest request)
DataSafe
Gets a list of sensitive type Ids present in the specified sensitive data model.
listSensitiveDataModelSensitiveTypes
in interface DataSafe
request
- The request object containing the details to sendpublic ListSensitiveDataModelsResponse listSensitiveDataModels(ListSensitiveDataModelsRequest request)
DataSafe
Gets a list of sensitive data models based on the specified query parameters.
listSensitiveDataModels
in interface DataSafe
request
- The request object containing the details to sendpublic ListSensitiveObjectsResponse listSensitiveObjects(ListSensitiveObjectsRequest request)
DataSafe
Gets a list of sensitive objects present in the specified sensitive data model based on the specified query parameters.
listSensitiveObjects
in interface DataSafe
request
- The request object containing the details to sendpublic ListSensitiveSchemasResponse listSensitiveSchemas(ListSensitiveSchemasRequest request)
DataSafe
Gets a list of sensitive schemas present in the specified sensitive data model based on the specified query parameters.
listSensitiveSchemas
in interface DataSafe
request
- The request object containing the details to sendpublic ListSensitiveTypesResponse listSensitiveTypes(ListSensitiveTypesRequest request)
DataSafe
Gets a list of sensitive types based on the specified query parameters.
listSensitiveTypes
in interface DataSafe
request
- The request object containing the details to sendpublic ListSqlCollectionAnalyticsResponse listSqlCollectionAnalytics(ListSqlCollectionAnalyticsRequest request)
DataSafe
Retrieves a list of all SQL collection analytics in Data Safe.
The ListSqlCollectionAnalytics operation returns only the analytics for the SQL collections in the specified `compartmentId`.
The parameter `accessLevel` specifies whether to return only those compartments for which the requestor has INSPECT permissions on at least one resource directly or indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if Principal doesn't have access to even one of the child compartments. This is valid only when `compartmentIdInSubtree` is set to `true`.
The parameter `compartmentIdInSubtree` applies when you perform ListSqlCollections on the `compartmentId` passed and when it is set to true, the entire hierarchy of compartments can be returned. To get a full list of all compartments and subcompartments in the tenancy (root compartment), set the parameter `compartmentIdInSubtree` to true and `accessLevel` to ACCESSIBLE.
listSqlCollectionAnalytics
in interface DataSafe
request
- The request object containing the details to sendpublic ListSqlCollectionLogInsightsResponse listSqlCollectionLogInsights(ListSqlCollectionLogInsightsRequest request)
DataSafe
Retrieves a list of the SQL collection log analytics.
listSqlCollectionLogInsights
in interface DataSafe
request
- The request object containing the details to sendpublic ListSqlCollectionsResponse listSqlCollections(ListSqlCollectionsRequest request)
DataSafe
Retrieves a list of all SQL collections in Data Safe.
The ListSqlCollections operation returns only the SQL collections in the specified `compartmentId`.
The parameter `accessLevel` specifies whether to return only those compartments for which the requestor has INSPECT permissions on at least one resource directly or indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if Principal doesn't have access to even one of the child compartments. This is valid only when `compartmentIdInSubtree` is set to `true`.
The parameter `compartmentIdInSubtree` applies when you perform ListSqlCollections on the `compartmentId` passed and when it is set to true, the entire hierarchy of compartments can be returned. To get a full list of all compartments and subcompartments in the tenancy (root compartment), set the parameter `compartmentIdInSubtree` to true and `accessLevel` to ACCESSIBLE.
listSqlCollections
in interface DataSafe
request
- The request object containing the details to sendpublic ListSqlFirewallAllowedSqlAnalyticsResponse listSqlFirewallAllowedSqlAnalytics(ListSqlFirewallAllowedSqlAnalyticsRequest request)
DataSafe
Returns the aggregation details of all SQL Firewall allowed SQL statements.
The ListSqlFirewallAllowedSqlAnalytics operation returns the aggregates of the SQL Firewall allowed SQL statements in the specified `compartmentId`.
The parameter `accessLevel` specifies whether to return only those compartments for which the requestor has INSPECT permissions on at least one resource directly or indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if Principal doesn't have access to even one of the child compartments. This is valid only when `compartmentIdInSubtree` is set to `true`.
The parameter `compartmentIdInSubtree` applies when you perform ListSqlFirewallAllowedSqlAnalytics on the `compartmentId` passed and when it is set to true, the entire hierarchy of compartments can be returned. To get a full list of all compartments and subcompartments in the tenancy (root compartment), set the parameter `compartmentIdInSubtree` to true and `accessLevel` to ACCESSIBLE.
listSqlFirewallAllowedSqlAnalytics
in interface DataSafe
request
- The request object containing the details to sendpublic ListSqlFirewallAllowedSqlsResponse listSqlFirewallAllowedSqls(ListSqlFirewallAllowedSqlsRequest request)
DataSafe
Retrieves a list of all SQL Firewall allowed SQL statements.
The ListSqlFirewallAllowedSqls operation returns only the SQL Firewall allowed SQL statements in the specified `compartmentId`.
The parameter `accessLevel` specifies whether to return only those compartments for which the requestor has INSPECT permissions on at least one resource directly or indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if Principal doesn't have access to even one of the child compartments. This is valid only when `compartmentIdInSubtree` is set to `true`.
The parameter `compartmentIdInSubtree` applies when you perform ListSqlFirewallPolicies on the `compartmentId` passed and when it is set to true, the entire hierarchy of compartments can be returned. To get a full list of all compartments and subcompartments in the tenancy (root compartment), set the parameter `compartmentIdInSubtree` to true and `accessLevel` to ACCESSIBLE.
listSqlFirewallAllowedSqls
in interface DataSafe
request
- The request object containing the details to sendpublic ListSqlFirewallPoliciesResponse listSqlFirewallPolicies(ListSqlFirewallPoliciesRequest request)
DataSafe
Retrieves a list of all SQL Firewall policies.
The ListSqlFirewallPolicies operation returns only the SQL Firewall policies in the specified `compartmentId`.
The parameter `accessLevel` specifies whether to return only those compartments for which the requestor has INSPECT permissions on at least one resource directly or indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if Principal doesn't have access to even one of the child compartments. This is valid only when `compartmentIdInSubtree` is set to `true`.
The parameter `compartmentIdInSubtree` applies when you perform ListSqlFirewallPolicies on the `compartmentId` passed and when it is set to true, the entire hierarchy of compartments can be returned. To get a full list of all compartments and subcompartments in the tenancy (root compartment), set the parameter `compartmentIdInSubtree` to true and `accessLevel` to ACCESSIBLE.
listSqlFirewallPolicies
in interface DataSafe
request
- The request object containing the details to sendpublic ListSqlFirewallPolicyAnalyticsResponse listSqlFirewallPolicyAnalytics(ListSqlFirewallPolicyAnalyticsRequest request)
DataSafe
Gets a list of aggregated SQL Firewall policy details.
The parameter `accessLevel` specifies whether to return only those compartments for which the requestor has INSPECT permissions on at least one resource directly or indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if principal doesn't have access to even one of the child compartments. This is valid only when `compartmentIdInSubtree` is set to `true`.
The parameter `compartmentIdInSubtree` applies when you perform SummarizedSqlFirewallPolicyInfo on the specified `compartmentId` and when it is set to true, the entire hierarchy of compartments can be returned. To get a full list of all compartments and subcompartments in the tenancy (root compartment), set the parameter `compartmentIdInSubtree` to true and `accessLevel` to ACCESSIBLE.
listSqlFirewallPolicyAnalytics
in interface DataSafe
request
- The request object containing the details to sendpublic ListSqlFirewallViolationAnalyticsResponse listSqlFirewallViolationAnalytics(ListSqlFirewallViolationAnalyticsRequest request)
DataSafe
Returns the aggregation details of the SQL Firewall violations.
listSqlFirewallViolationAnalytics
in interface DataSafe
request
- The request object containing the details to sendpublic ListSqlFirewallViolationsResponse listSqlFirewallViolations(ListSqlFirewallViolationsRequest request)
DataSafe
Gets a list of all the SQL Firewall violations captured by the firewall.
listSqlFirewallViolations
in interface DataSafe
request
- The request object containing the details to sendpublic ListTablesResponse listTables(ListTablesRequest request)
DataSafe
Returns a list of table metadata objects.
listTables
in interface DataSafe
request
- The request object containing the details to sendpublic ListTargetAlertPolicyAssociationsResponse listTargetAlertPolicyAssociations(ListTargetAlertPolicyAssociationsRequest request)
DataSafe
Gets a list of all target-alert policy associations.
listTargetAlertPolicyAssociations
in interface DataSafe
request
- The request object containing the details to sendpublic ListTargetDatabasesResponse listTargetDatabases(ListTargetDatabasesRequest request)
DataSafe
Returns the list of registered target databases in Data Safe.
listTargetDatabases
in interface DataSafe
request
- The request object containing the details to sendpublic ListUserAccessAnalyticsResponse listUserAccessAnalytics(ListUserAccessAnalyticsRequest request)
DataSafe
Gets a list of aggregated user access analytics in the specified target in a compartment.
listUserAccessAnalytics
in interface DataSafe
request
- The request object containing the details to sendpublic ListUserAnalyticsResponse listUserAnalytics(ListUserAnalyticsRequest request)
DataSafe
Gets a list of aggregated user details from the specified user assessment. This provides information about the overall state. of database user security. For example, the user details include how many users have the DBA role and how many users are in the critical category. This data is especially useful content for dashboards or to support analytics.
When you perform the ListUserAnalytics operation, if the parameter compartmentIdInSubtree is set to \"true,\" and if the parameter accessLevel is set to ACCESSIBLE, then the operation returns compartments in which the requestor has INSPECT permissions on at least one resource, directly or indirectly (in subcompartments). If the operation is performed at the root compartment and the requestor does not have access to at least one subcompartment of the compartment specified by compartmentId, then \"Not Authorized\" is returned.
The parameter compartmentIdInSubtree applies when you perform ListUserAnalytics on the compartmentId passed and when it is set to true, the entire hierarchy of compartments can be returned.
To use ListUserAnalytics to get a full list of all compartments and subcompartments in the tenancy from the root compartment, set the parameter compartmentIdInSubtree to true and accessLevel to ACCESSIBLE.
listUserAnalytics
in interface DataSafe
request
- The request object containing the details to sendpublic ListUserAssessmentsResponse listUserAssessments(ListUserAssessmentsRequest request)
DataSafe
Gets a list of user assessments.
The ListUserAssessments operation returns only the assessments in the specified `compartmentId`. The list does not include any subcompartments of the compartmentId passed.
The parameter `accessLevel` specifies whether to return only those compartments for which the requestor has INSPECT permissions on at least one resource directly or indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if Principal doesn't have access to even one of the child compartments. This is valid only when `compartmentIdInSubtree` is set to `true`.
The parameter `compartmentIdInSubtree` applies when you perform ListUserAssessments on the `compartmentId` passed and when it is set to true, the entire hierarchy of compartments can be returned. To get a full list of all compartments and subcompartments in the tenancy (root compartment), set the parameter `compartmentIdInSubtree` to true and `accessLevel` to ACCESSIBLE.
listUserAssessments
in interface DataSafe
request
- The request object containing the details to sendpublic ListUsersResponse listUsers(ListUsersRequest request)
DataSafe
Gets a list of users of the specified user assessment. The result contains the database user details for each user, such as user type, account status, last login time, user creation time, authentication type, user profile, and the date and time of the latest password change. It also contains the user category derived from these user details as well as privileges granted to each user.
public ListWorkRequestErrorsResponse listWorkRequestErrors(ListWorkRequestErrorsRequest request)
DataSafe
Gets a list of errors for the specified work request.
listWorkRequestErrors
in interface DataSafe
request
- The request object containing the details to sendpublic ListWorkRequestLogsResponse listWorkRequestLogs(ListWorkRequestLogsRequest request)
DataSafe
Gets a list of log entries for the specified work request.
listWorkRequestLogs
in interface DataSafe
request
- The request object containing the details to sendpublic ListWorkRequestsResponse listWorkRequests(ListWorkRequestsRequest request)
DataSafe
Gets a list of work requests.
listWorkRequests
in interface DataSafe
request
- The request object containing the details to sendpublic MaskDataResponse maskData(MaskDataRequest request)
DataSafe
Masks data using the specified masking policy.
public ModifyGlobalSettingsResponse modifyGlobalSettings(ModifyGlobalSettingsRequest request)
DataSafe
Modifies Global Settings in Data Safe in the tenancy and region.
modifyGlobalSettings
in interface DataSafe
request
- The request object containing the details to sendpublic PatchAlertsResponse patchAlerts(PatchAlertsRequest request)
DataSafe
Updates the status of one or more alert specified by the alert IDs.
patchAlerts
in interface DataSafe
request
- The request object containing the details to sendpublic PatchDiscoveryJobResultsResponse patchDiscoveryJobResults(PatchDiscoveryJobResultsRequest request)
DataSafe
Patches one or more discovery results. You can use this operation to set the plannedAction attribute before using ApplyDiscoveryJobResults to process the results based on this attribute.
patchDiscoveryJobResults
in interface DataSafe
request
- The request object containing the details to sendpublic PatchMaskingColumnsResponse patchMaskingColumns(PatchMaskingColumnsRequest request)
DataSafe
Patches one or more columns in the specified masking policy. Use it to create, or update masking columns. To create masking columns, use CreateMaskingColumnDetails as the patch value. And to update masking columns, use UpdateMaskingColumnDetails as the patch value.
patchMaskingColumns
in interface DataSafe
request
- The request object containing the details to sendpublic PatchSdmMaskingPolicyDifferenceColumnsResponse patchSdmMaskingPolicyDifferenceColumns(PatchSdmMaskingPolicyDifferenceColumnsRequest request)
DataSafe
Patches one or more SDM masking policy difference columns. You can use this operation to set the plannedAction attribute before using ApplySdmMaskingPolicyDifference to process the difference based on this attribute.
patchSdmMaskingPolicyDifferenceColumns
in interface DataSafe
request
- The request object containing the details to sendpublic PatchSensitiveColumnsResponse patchSensitiveColumns(PatchSensitiveColumnsRequest request)
DataSafe
Patches one or more columns in the specified sensitive data model. Use it to create, update, or delete sensitive columns. To create sensitive columns, use CreateSensitiveColumnDetails as the patch value. And to update sensitive columns, use UpdateSensitiveColumnDetails as the patch value.
patchSensitiveColumns
in interface DataSafe
request
- The request object containing the details to sendpublic PatchSqlFirewallAllowedSqlResponse patchSqlFirewallAllowedSql(PatchSqlFirewallAllowedSqlRequest request)
DataSafe
Delete multiple allowed sqls. You can use this operation to delete one or more allowed sqls. Create and update of multiple allowed sqls is not supported.
patchSqlFirewallAllowedSql
in interface DataSafe
request
- The request object containing the details to sendpublic PatchTargetAlertPolicyAssociationResponse patchTargetAlertPolicyAssociation(PatchTargetAlertPolicyAssociationRequest request)
DataSafe
Creates new target-alert policy associations that will be applied on the target database.
patchTargetAlertPolicyAssociation
in interface DataSafe
request
- The request object containing the details to sendpublic ProvisionAuditPolicyResponse provisionAuditPolicy(ProvisionAuditPolicyRequest request)
DataSafe
Provision audit policy.
provisionAuditPolicy
in interface DataSafe
request
- The request object containing the details to sendpublic PurgeSqlCollectionLogsResponse purgeSqlCollectionLogs(PurgeSqlCollectionLogsRequest request)
DataSafe
Purge the SQL collection logs for the specified SqlCollection.
purgeSqlCollectionLogs
in interface DataSafe
request
- The request object containing the details to sendpublic RefreshDatabaseSecurityConfigurationResponse refreshDatabaseSecurityConfiguration(RefreshDatabaseSecurityConfigurationRequest request)
DataSafe
Refreshes the specified database security configuration.
refreshDatabaseSecurityConfiguration
in interface DataSafe
request
- The request object containing the details to sendpublic RefreshSecurityAssessmentResponse refreshSecurityAssessment(RefreshSecurityAssessmentRequest request)
DataSafe
Runs a security assessment, refreshes the latest assessment, and saves it for future reference. The assessment runs with a securityAssessmentId of type LATEST. Before you start, first call the ListSecurityAssessments operation with filter "type = latest" to get the security assessment id for the target’s latest assessment.
refreshSecurityAssessment
in interface DataSafe
request
- The request object containing the details to sendpublic RefreshSqlCollectionLogInsightsResponse refreshSqlCollectionLogInsights(RefreshSqlCollectionLogInsightsRequest request)
DataSafe
Refresh the specified SQL collection Log Insights.
refreshSqlCollectionLogInsights
in interface DataSafe
request
- The request object containing the details to sendpublic RefreshTargetDatabaseResponse refreshTargetDatabase(RefreshTargetDatabaseRequest request)
DataSafe
Refreshes the Data Safe target database to update it’s state.
refreshTargetDatabase
in interface DataSafe
request
- The request object containing the details to sendpublic RefreshUserAssessmentResponse refreshUserAssessment(RefreshUserAssessmentRequest request)
DataSafe
Refreshes the latest assessment and saves it for future reference. This operation runs with a userAssessmentId of type LATEST. Before you start, first call the ListUserAssessments operation with filter "type = latest" to get the user assessment ID for the target’s latest assessment.
refreshUserAssessment
in interface DataSafe
request
- The request object containing the details to sendpublic RemoveScheduleReportResponse removeScheduleReport(RemoveScheduleReportRequest request)
DataSafe
Deletes the schedule of a .xls or .pdf report.
removeScheduleReport
in interface DataSafe
request
- The request object containing the details to sendpublic ResumeAuditTrailResponse resumeAuditTrail(ResumeAuditTrailRequest request)
DataSafe
Resumes the specified audit trail once it got stopped.
resumeAuditTrail
in interface DataSafe
request
- The request object containing the details to sendpublic ResumeWorkRequestResponse resumeWorkRequest(ResumeWorkRequestRequest request)
DataSafe
Resume the given work request. Issuing a resume does not guarantee of immediate resume of the work request.
resumeWorkRequest
in interface DataSafe
request
- The request object containing the details to sendpublic RetrieveAuditPoliciesResponse retrieveAuditPolicies(RetrieveAuditPoliciesRequest request)
DataSafe
Retrieves the audit policy details from the source target database.
retrieveAuditPolicies
in interface DataSafe
request
- The request object containing the details to sendpublic ScheduleReportResponse scheduleReport(ScheduleReportRequest request)
DataSafe
Schedules a .xls or .pdf report based on parameters and report definition.
scheduleReport
in interface DataSafe
request
- The request object containing the details to sendpublic SetSecurityAssessmentBaselineResponse setSecurityAssessmentBaseline(SetSecurityAssessmentBaselineRequest request)
DataSafe
Sets the saved security assessment as the baseline in the compartment where the the specified assessment resides. The security assessment needs to be of type ‘SAVED’.
setSecurityAssessmentBaseline
in interface DataSafe
request
- The request object containing the details to sendpublic SetUserAssessmentBaselineResponse setUserAssessmentBaseline(SetUserAssessmentBaselineRequest request)
DataSafe
Sets the saved user assessment as the baseline in the compartment where the specified assessment resides. The user assessment needs to be of type ‘SAVED’.
setUserAssessmentBaseline
in interface DataSafe
request
- The request object containing the details to sendpublic StartAuditTrailResponse startAuditTrail(StartAuditTrailRequest request)
DataSafe
Starts collection of audit records on the specified audit trail.
startAuditTrail
in interface DataSafe
request
- The request object containing the details to sendpublic StartSqlCollectionResponse startSqlCollection(StartSqlCollectionRequest request)
DataSafe
Start the specified SQL collection.
startSqlCollection
in interface DataSafe
request
- The request object containing the details to sendpublic StopAuditTrailResponse stopAuditTrail(StopAuditTrailRequest request)
DataSafe
Stops the specified audit trail.
stopAuditTrail
in interface DataSafe
request
- The request object containing the details to sendpublic StopSqlCollectionResponse stopSqlCollection(StopSqlCollectionRequest request)
DataSafe
Stops the specified SQL collection.
stopSqlCollection
in interface DataSafe
request
- The request object containing the details to sendpublic SuspendWorkRequestResponse suspendWorkRequest(SuspendWorkRequestRequest request)
DataSafe
Suspend the given work request. Issuing a suspend does not guarantee of a immediate suspend of the work request.
suspendWorkRequest
in interface DataSafe
request
- The request object containing the details to sendpublic UnsetSecurityAssessmentBaselineResponse unsetSecurityAssessmentBaseline(UnsetSecurityAssessmentBaselineRequest request)
DataSafe
Removes the baseline setting for the saved security assessment associated with the targetId passed via body. If no body or empty body is passed then the baseline settings of all the saved security assessments pertaining to the baseline assessment OCID provided in the path will be removed. Sets the if-match parameter to the value of the etag from a previous GET or POST response for that resource.
unsetSecurityAssessmentBaseline
in interface DataSafe
request
- The request object containing the details to sendpublic UnsetUserAssessmentBaselineResponse unsetUserAssessmentBaseline(UnsetUserAssessmentBaselineRequest request)
DataSafe
Removes the baseline setting for the saved user assessment associated with the targetId passed via body. If no body or empty body is passed then the baseline settings of all the saved user assessments pertaining to the baseline assessment OCID provided in the path will be removed. Sets the if-match parameter to the value of the etag from a previous GET or POST response for that resource.
unsetUserAssessmentBaseline
in interface DataSafe
request
- The request object containing the details to sendpublic UpdateAlertResponse updateAlert(UpdateAlertRequest request)
DataSafe
Updates the status of the specified alert.
updateAlert
in interface DataSafe
request
- The request object containing the details to sendpublic UpdateAlertPolicyResponse updateAlertPolicy(UpdateAlertPolicyRequest request)
DataSafe
Updates the specified alert policy .
updateAlertPolicy
in interface DataSafe
request
- The request object containing the details to sendpublic UpdateAlertPolicyRuleResponse updateAlertPolicyRule(UpdateAlertPolicyRuleRequest request)
DataSafe
Updates the specified alert policy rule.
updateAlertPolicyRule
in interface DataSafe
request
- The request object containing the details to sendpublic UpdateAuditArchiveRetrievalResponse updateAuditArchiveRetrieval(UpdateAuditArchiveRetrievalRequest request)
DataSafe
Updates the audit archive retrieval.
updateAuditArchiveRetrieval
in interface DataSafe
request
- The request object containing the details to sendpublic UpdateAuditPolicyResponse updateAuditPolicy(UpdateAuditPolicyRequest request)
DataSafe
Updates the audit policy.
updateAuditPolicy
in interface DataSafe
request
- The request object containing the details to sendpublic UpdateAuditProfileResponse updateAuditProfile(UpdateAuditProfileRequest request)
DataSafe
Updates one or more attributes of the specified audit profile.
updateAuditProfile
in interface DataSafe
request
- The request object containing the details to sendpublic UpdateAuditTrailResponse updateAuditTrail(UpdateAuditTrailRequest request)
DataSafe
Updates one or more attributes of the specified audit trail.
updateAuditTrail
in interface DataSafe
request
- The request object containing the details to sendpublic UpdateDataSafePrivateEndpointResponse updateDataSafePrivateEndpoint(UpdateDataSafePrivateEndpointRequest request)
DataSafe
Updates one or more attributes of the specified Data Safe private endpoint.
updateDataSafePrivateEndpoint
in interface DataSafe
request
- The request object containing the details to sendpublic UpdateDatabaseSecurityConfigResponse updateDatabaseSecurityConfig(UpdateDatabaseSecurityConfigRequest request)
DataSafe
Updates the database security configuration.
updateDatabaseSecurityConfig
in interface DataSafe
request
- The request object containing the details to sendpublic UpdateFindingResponse updateFinding(UpdateFindingRequest request)
DataSafe
Updates one or more attributes of the specified finding.
updateFinding
in interface DataSafe
request
- The request object containing the details to sendpublic UpdateLibraryMaskingFormatResponse updateLibraryMaskingFormat(UpdateLibraryMaskingFormatRequest request)
DataSafe
Updates one or more attributes of the specified library masking format. Note that updating the formatEntries attribute replaces all the existing masking format entries with the specified format entries.
updateLibraryMaskingFormat
in interface DataSafe
request
- The request object containing the details to sendpublic UpdateMaskingColumnResponse updateMaskingColumn(UpdateMaskingColumnRequest request)
DataSafe
Updates one or more attributes of the specified masking column. Note that updating the maskingFormats attribute replaces the currently assigned masking formats with the specified masking formats.
updateMaskingColumn
in interface DataSafe
request
- The request object containing the details to sendpublic UpdateMaskingPolicyResponse updateMaskingPolicy(UpdateMaskingPolicyRequest request)
DataSafe
Updates one or more attributes of the specified masking policy.
updateMaskingPolicy
in interface DataSafe
request
- The request object containing the details to sendpublic UpdateOnPremConnectorResponse updateOnPremConnector(UpdateOnPremConnectorRequest request)
DataSafe
Updates one or more attributes of the specified on-premises connector.
updateOnPremConnector
in interface DataSafe
request
- The request object containing the details to sendpublic UpdateOnPremConnectorWalletResponse updateOnPremConnectorWallet(UpdateOnPremConnectorWalletRequest request)
DataSafe
Updates the wallet for the specified on-premises connector to a new version.
updateOnPremConnectorWallet
in interface DataSafe
request
- The request object containing the details to sendpublic UpdatePeerTargetDatabaseResponse updatePeerTargetDatabase(UpdatePeerTargetDatabaseRequest request)
DataSafe
Updates one or more attributes of the specified Data Safe peer target database.
updatePeerTargetDatabase
in interface DataSafe
request
- The request object containing the details to sendpublic UpdateReportResponse updateReport(UpdateReportRequest request)
DataSafe
Updates the specified report. Only tags can be updated.
updateReport
in interface DataSafe
request
- The request object containing the details to sendpublic UpdateReportDefinitionResponse updateReportDefinition(UpdateReportDefinitionRequest request)
DataSafe
Updates the specified report definition. Only user created report definition can be updated. Seeded report definitions need to be saved as new report definition first.
updateReportDefinition
in interface DataSafe
request
- The request object containing the details to sendpublic UpdateSdmMaskingPolicyDifferenceResponse updateSdmMaskingPolicyDifference(UpdateSdmMaskingPolicyDifferenceRequest request)
DataSafe
Updates one or more attributes of the specified sdm masking policy difference.
updateSdmMaskingPolicyDifference
in interface DataSafe
request
- The request object containing the details to sendpublic UpdateSecurityAssessmentResponse updateSecurityAssessment(UpdateSecurityAssessmentRequest request)
DataSafe
Updates one or more attributes of the specified security assessment. This operation allows to update the security assessment displayName, description, or schedule.
updateSecurityAssessment
in interface DataSafe
request
- The request object containing the details to sendpublic UpdateSecurityPolicyResponse updateSecurityPolicy(UpdateSecurityPolicyRequest request)
DataSafe
Updates the security policy.
updateSecurityPolicy
in interface DataSafe
request
- The request object containing the details to sendpublic UpdateSecurityPolicyDeploymentResponse updateSecurityPolicyDeployment(UpdateSecurityPolicyDeploymentRequest request)
DataSafe
Updates the security policy deployment.
updateSecurityPolicyDeployment
in interface DataSafe
request
- The request object containing the details to sendpublic UpdateSensitiveColumnResponse updateSensitiveColumn(UpdateSensitiveColumnRequest request)
DataSafe
Updates one or more attributes of the specified sensitive column.
updateSensitiveColumn
in interface DataSafe
request
- The request object containing the details to sendpublic UpdateSensitiveDataModelResponse updateSensitiveDataModel(UpdateSensitiveDataModelRequest request)
DataSafe
Updates one or more attributes of the specified sensitive data model. Note that updating any attribute of a sensitive data model does not perform data discovery.
updateSensitiveDataModel
in interface DataSafe
request
- The request object containing the details to sendpublic UpdateSensitiveTypeResponse updateSensitiveType(UpdateSensitiveTypeRequest request)
DataSafe
Updates one or more attributes of the specified sensitive type.
updateSensitiveType
in interface DataSafe
request
- The request object containing the details to sendpublic UpdateSqlCollectionResponse updateSqlCollection(UpdateSqlCollectionRequest request)
DataSafe
Updates the SQL collection.
updateSqlCollection
in interface DataSafe
request
- The request object containing the details to sendpublic UpdateSqlFirewallPolicyResponse updateSqlFirewallPolicy(UpdateSqlFirewallPolicyRequest request)
DataSafe
Updates the SQL Firewall policy.
updateSqlFirewallPolicy
in interface DataSafe
request
- The request object containing the details to sendpublic UpdateTargetAlertPolicyAssociationResponse updateTargetAlertPolicyAssociation(UpdateTargetAlertPolicyAssociationRequest request)
DataSafe
Updates the specified target-alert policy association.
updateTargetAlertPolicyAssociation
in interface DataSafe
request
- The request object containing the details to sendpublic UpdateTargetDatabaseResponse updateTargetDatabase(UpdateTargetDatabaseRequest request)
DataSafe
Updates one or more attributes of the specified Data Safe target database.
updateTargetDatabase
in interface DataSafe
request
- The request object containing the details to sendpublic UpdateUserAssessmentResponse updateUserAssessment(UpdateUserAssessmentRequest request)
DataSafe
Updates one or more attributes of the specified user assessment. This operation allows to update the user assessment displayName, description, or schedule.
updateUserAssessment
in interface DataSafe
request
- The request object containing the details to sendpublic UploadMaskingPolicyResponse uploadMaskingPolicy(UploadMaskingPolicyRequest request)
DataSafe
Uploads a masking policy file (also called template) to update the specified masking policy. To create a new masking policy using a file, first use the CreateMaskingPolicy operation to create an empty masking policy and then use this endpoint to upload the masking policy file. Note that the upload operation replaces the content of the specified masking policy, including all the existing columns and masking formats, with the content of the file.
Note: This operation consumes a stream.
If the stream supports InputStream.mark(int)
and InputStream.reset()
, when a retry is necessary, the stream is reset so it starts at
the beginning (or whatever the stream's position was at the time this operation is called}.
Note this means that if the caller has used InputStream.mark(int)
before,
then the mark will not be the same anymore after this operation, and a subsequent call to
InputStream.reset()
by the caller will reset the stream not to the caller's
mark, but to the position the stream was in when this operation was called.
If the stream is a FileInputStream
, and the stream's FileChannel
position can be changed (like for a regular file), the stream
will be wrapped in such a way that it does provide support for InputStream.mark(int)
and InputStream.reset()
. Then the same
procedure as above is followed. If the stream's FileChannel
position cannot be changed (like for a named pipe), then the stream's contents will be
buffered in memory, as described below.
If the stream does not support InputStream.mark(int)
and InputStream.reset()
, then the stream is wrapped in a BufferedInputStream
, which means the entire contents may be buffered in memory. Then
the same procedure as above is followed.
The contents of the stream, except when the stream is a FileInputStream
whose FileChannel
position can be changed, should be less than 2
GiB in size if retries are used. This is because streams 2 GiB in size or larger do no
guarantee that mark-and-reset can be performed. If the stream is larger, do not use built-in
retries and manage retries yourself.
uploadMaskingPolicy
in interface DataSafe
request
- The request object containing the details to sendpublic UploadSensitiveDataModelResponse uploadSensitiveDataModel(UploadSensitiveDataModelRequest request)
DataSafe
Uploads a sensitive data model file (also called template) to update the specified sensitive data model. To create a new sensitive data model using a file, first use the CreateSensitiveDataModel operation to create an empty data model and then use this endpoint to upload the data model file. Note that the upload operation replaces the content of the specified sensitive data model, including all the existing columns and their relationships, with the content of the file.
Note: This operation consumes a stream.
If the stream supports InputStream.mark(int)
and InputStream.reset()
, when a retry is necessary, the stream is reset so it starts at
the beginning (or whatever the stream's position was at the time this operation is called}.
Note this means that if the caller has used InputStream.mark(int)
before,
then the mark will not be the same anymore after this operation, and a subsequent call to
InputStream.reset()
by the caller will reset the stream not to the caller's
mark, but to the position the stream was in when this operation was called.
If the stream is a FileInputStream
, and the stream's FileChannel
position can be changed (like for a regular file), the stream
will be wrapped in such a way that it does provide support for InputStream.mark(int)
and InputStream.reset()
. Then the same
procedure as above is followed. If the stream's FileChannel
position cannot be changed (like for a named pipe), then the stream's contents will be
buffered in memory, as described below.
If the stream does not support InputStream.mark(int)
and InputStream.reset()
, then the stream is wrapped in a BufferedInputStream
, which means the entire contents may be buffered in memory. Then
the same procedure as above is followed.
The contents of the stream, except when the stream is a FileInputStream
whose FileChannel
position can be changed, should be less than 2
GiB in size if retries are used. This is because streams 2 GiB in size or larger do no
guarantee that mark-and-reset can be performed. If the stream is larger, do not use built-in
retries and manage retries yourself.
uploadSensitiveDataModel
in interface DataSafe
request
- The request object containing the details to sendpublic DataSafeWaiters getWaiters()
DataSafe
Gets the pre-configured waiters available for resources for this service.
getWaiters
in interface DataSafe
public DataSafePaginators getPaginators()
DataSafe
Gets the pre-configured paginators available for list operations in this service which may
return multiple pages of data. These paginators provide an Iterable
interface so that service responses, or resources/records, can be iterated through without
having to manually deal with pagination and page tokens.
getPaginators
in interface DataSafe
protected ClientConfigurator getDefaultConfigurator()
public void useRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled)
useOfRealmSpecificEndpointTemplateEnabled
- This flag can be set to true or false to
enable or disable the use of realm-specific endpoint template respectivelypublic final void populateServiceParametersInEndpoint(String endpoint, Map<String,Object> requiredParametersMap)
endpoint
- The endpoint template in userequiredParametersMap
- Map of parameter name as key and value set in request path or
query parameter as valuepublic final void updateBaseEndpoint(String endpoint)
endpoint
- The updated endpoint to usepublic final void setEndpoint(String endpoint)
public final String getEndpoint()
public final void refreshClient()
HttpClient
. This will call ClientConfigurator
s again, and
can be used to e.g. refresh the SSL certificate.public final void close()
close
in interface AutoCloseable
public String getClientCommonLibraryVersion()
Copyright © 2016–2024. All rights reserved.