Class DataSafeClient
- java.lang.Object
-
- com.oracle.bmc.http.internal.BaseSyncClient
-
- com.oracle.bmc.datasafe.DataSafeClient
-
- All Implemented Interfaces:
DataSafe
,AutoCloseable
@Generated(value="OracleSDKGenerator", comments="API Version: 20181201") public class DataSafeClient extends BaseSyncClient implements DataSafe
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
DataSafeClient.Builder
Builder class for this client.
-
Field Summary
Fields Modifier and Type Field 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 Summary
Constructors Constructor Description DataSafeClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)
Deprecated.Use thebuilder
instead.DataSafeClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)
Deprecated.Use thebuilder
instead.DataSafeClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Deprecated.Use thebuilder
instead.DataSafeClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Deprecated.Use thebuilder
instead.DataSafeClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService)
Deprecated.Use thebuilder
instead.DataSafeClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Deprecated.Use thebuilder
instead.DataSafeClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)
Deprecated.Use thebuilder
instead.DataSafeClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)
Deprecated.Use thebuilder
instead.
-
Method Summary
-
Methods inherited from class com.oracle.bmc.http.internal.BaseSyncClient
clientCall
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface java.lang.AutoCloseable
close
-
Methods inherited from interface com.oracle.bmc.datasafe.DataSafe
getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate
-
-
-
-
Constructor Detail
-
DataSafeClient
@Deprecated public DataSafeClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeDataSafeClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)
-
DataSafeClient
@Deprecated public DataSafeClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeDataSafeClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
-ClientBuilderBase.configuration
-
DataSafeClient
@Deprecated public DataSafeClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeDataSafeClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
-ClientBuilderBase.configuration
clientConfigurator
-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
-
DataSafeClient
@Deprecated public DataSafeClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeDataSafeClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
-ClientBuilderBase.configuration
clientConfigurator
-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
defaultRequestSignerFactory
-ClientBuilderBase.requestSignerFactory
-
DataSafeClient
@Deprecated public DataSafeClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeDataSafeClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
-ClientBuilderBase.configuration
clientConfigurator
-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
defaultRequestSignerFactory
-ClientBuilderBase.requestSignerFactory
additionalClientConfigurators
-ClientBuilderBase.additionalClientConfigurators
-
DataSafeClient
@Deprecated public DataSafeClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeDataSafeClient.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)
-
DataSafeClient
@Deprecated public DataSafeClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeDataSafeClient.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
-
DataSafeClient
@Deprecated public DataSafeClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeDataSafeClient.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
-
-
Method Detail
-
builder
public static DataSafeClient.Builder builder()
Create a builder for this client.- Returns:
- builder
-
setRegion
public void setRegion(Region region)
Description copied from interface: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.
-
setRegion
public void setRegion(String regionId)
Description copied from interface: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 callsetEndpoint
.
-
activateTargetDatabase
public ActivateTargetDatabaseResponse activateTargetDatabase(ActivateTargetDatabaseRequest request)
Description copied from interface:DataSafe
Reactivates a previously deactivated Data Safe target database.- Specified by:
activateTargetDatabase
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
addMaskingColumnsFromSdm
public AddMaskingColumnsFromSdmResponse addMaskingColumnsFromSdm(AddMaskingColumnsFromSdmRequest request)
Description copied from interface: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.
- Specified by:
addMaskingColumnsFromSdm
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
alertsUpdate
public AlertsUpdateResponse alertsUpdate(AlertsUpdateRequest request)
Description copied from interface:DataSafe
Updates alerts in the specified compartment.- Specified by:
alertsUpdate
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
applyDiscoveryJobResults
public ApplyDiscoveryJobResultsResponse applyDiscoveryJobResults(ApplyDiscoveryJobResultsRequest request)
Description copied from interface: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.
- Specified by:
applyDiscoveryJobResults
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
applySdmMaskingPolicyDifference
public ApplySdmMaskingPolicyDifferenceResponse applySdmMaskingPolicyDifference(ApplySdmMaskingPolicyDifferenceRequest request)
Description copied from interface: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.
- Specified by:
applySdmMaskingPolicyDifference
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
bulkCreateSensitiveTypes
public BulkCreateSensitiveTypesResponse bulkCreateSensitiveTypes(BulkCreateSensitiveTypesRequest request)
Description copied from interface:DataSafe
Uploads a sensitive types xml file (also called template) to create new sensitive types.Note: This operation consumes a stream.
If the stream supports
InputStream.mark(int)
andInputStream.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 toInputStream.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'sFileChannel
position can be changed (like for a regular file), the stream will be wrapped in such a way that it does provide support forInputStream.mark(int)
andInputStream.reset()
. Then the same procedure as above is followed. If the stream'sFileChannel
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)
andInputStream.reset()
, then the stream is wrapped in aBufferedInputStream
, 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
whoseFileChannel
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.- Specified by:
bulkCreateSensitiveTypes
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
bulkCreateSqlFirewallAllowedSqls
public BulkCreateSqlFirewallAllowedSqlsResponse bulkCreateSqlFirewallAllowedSqls(BulkCreateSqlFirewallAllowedSqlsRequest request)
Description copied from interface:DataSafe
Appends the allowedSqls with entries from the logs.- Specified by:
bulkCreateSqlFirewallAllowedSqls
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
bulkDeleteSqlFirewallAllowedSqls
public BulkDeleteSqlFirewallAllowedSqlsResponse bulkDeleteSqlFirewallAllowedSqls(BulkDeleteSqlFirewallAllowedSqlsRequest request)
Description copied from interface:DataSafe
Delete multiple allowed sqls from the SQL firewall policy.- Specified by:
bulkDeleteSqlFirewallAllowedSqls
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
calculateAuditVolumeAvailable
public CalculateAuditVolumeAvailableResponse calculateAuditVolumeAvailable(CalculateAuditVolumeAvailableRequest request)
Description copied from interface: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.
- Specified by:
calculateAuditVolumeAvailable
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
calculateAuditVolumeCollected
public CalculateAuditVolumeCollectedResponse calculateAuditVolumeCollected(CalculateAuditVolumeCollectedRequest request)
Description copied from interface:DataSafe
Calculates the volume of audit events collected by data safe.- Specified by:
calculateAuditVolumeCollected
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
cancelWorkRequest
public CancelWorkRequestResponse cancelWorkRequest(CancelWorkRequestRequest request)
Description copied from interface:DataSafe
Cancel the specified work request.- Specified by:
cancelWorkRequest
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
changeAlertCompartment
public ChangeAlertCompartmentResponse changeAlertCompartment(ChangeAlertCompartmentRequest request)
Description copied from interface:DataSafe
Moves the specified alert into a different compartment.- Specified by:
changeAlertCompartment
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
changeAlertPolicyCompartment
public ChangeAlertPolicyCompartmentResponse changeAlertPolicyCompartment(ChangeAlertPolicyCompartmentRequest request)
Description copied from interface:DataSafe
Moves the specified alert policy into a different compartment.- Specified by:
changeAlertPolicyCompartment
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
changeAuditArchiveRetrievalCompartment
public ChangeAuditArchiveRetrievalCompartmentResponse changeAuditArchiveRetrievalCompartment(ChangeAuditArchiveRetrievalCompartmentRequest request)
Description copied from interface:DataSafe
Moves the archive retreival to the specified compartment.When provided, if-Match is checked against ETag value of the resource.
- Specified by:
changeAuditArchiveRetrievalCompartment
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
changeAuditPolicyCompartment
public ChangeAuditPolicyCompartmentResponse changeAuditPolicyCompartment(ChangeAuditPolicyCompartmentRequest request)
Description copied from interface:DataSafe
Moves the specified audit policy and its dependent resources into a different compartment.- Specified by:
changeAuditPolicyCompartment
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
changeAuditProfileCompartment
public ChangeAuditProfileCompartmentResponse changeAuditProfileCompartment(ChangeAuditProfileCompartmentRequest request)
Description copied from interface:DataSafe
Moves the specified audit profile and its dependent resources into a different compartment.- Specified by:
changeAuditProfileCompartment
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
changeDataSafePrivateEndpointCompartment
public ChangeDataSafePrivateEndpointCompartmentResponse changeDataSafePrivateEndpointCompartment(ChangeDataSafePrivateEndpointCompartmentRequest request)
Description copied from interface:DataSafe
Moves the Data Safe private endpoint and its dependent resources to the specified compartment.- Specified by:
changeDataSafePrivateEndpointCompartment
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
changeDatabaseSecurityConfigCompartment
public ChangeDatabaseSecurityConfigCompartmentResponse changeDatabaseSecurityConfigCompartment(ChangeDatabaseSecurityConfigCompartmentRequest request)
Description copied from interface:DataSafe
Moves the specified database security configuration and its dependent resources into a different compartment.- Specified by:
changeDatabaseSecurityConfigCompartment
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
changeDiscoveryJobCompartment
public ChangeDiscoveryJobCompartmentResponse changeDiscoveryJobCompartment(ChangeDiscoveryJobCompartmentRequest request)
Description copied from interface:DataSafe
Moves the specified discovery job and its dependent resources into a different compartment.- Specified by:
changeDiscoveryJobCompartment
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
changeLibraryMaskingFormatCompartment
public ChangeLibraryMaskingFormatCompartmentResponse changeLibraryMaskingFormatCompartment(ChangeLibraryMaskingFormatCompartmentRequest request)
Description copied from interface:DataSafe
Moves the specified library masking format into a different compartment.- Specified by:
changeLibraryMaskingFormatCompartment
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
changeMaskingPolicyCompartment
public ChangeMaskingPolicyCompartmentResponse changeMaskingPolicyCompartment(ChangeMaskingPolicyCompartmentRequest request)
Description copied from interface:DataSafe
Moves the specified masking policy and its dependent resources into a different compartment.- Specified by:
changeMaskingPolicyCompartment
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
changeMaskingPolicyHealthReportCompartment
public ChangeMaskingPolicyHealthReportCompartmentResponse changeMaskingPolicyHealthReportCompartment(ChangeMaskingPolicyHealthReportCompartmentRequest request)
Description copied from interface:DataSafe
Moves the specified masking policy health report and its dependent resources into a different compartment.- Specified by:
changeMaskingPolicyHealthReportCompartment
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
changeOnPremConnectorCompartment
public ChangeOnPremConnectorCompartmentResponse changeOnPremConnectorCompartment(ChangeOnPremConnectorCompartmentRequest request)
Description copied from interface:DataSafe
Moves the specified on-premises connector into a different compartment.- Specified by:
changeOnPremConnectorCompartment
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
changeReportCompartment
public ChangeReportCompartmentResponse changeReportCompartment(ChangeReportCompartmentRequest request)
Description copied from interface:DataSafe
Moves a resource into a different compartment.When provided, If-Match is checked against ETag values of the resource.
- Specified by:
changeReportCompartment
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
changeReportDefinitionCompartment
public ChangeReportDefinitionCompartmentResponse changeReportDefinitionCompartment(ChangeReportDefinitionCompartmentRequest request)
Description copied from interface:DataSafe
Moves a resource into a different compartment.When provided, If-Match is checked against ETag values of the resource.
- Specified by:
changeReportDefinitionCompartment
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
changeRetention
public ChangeRetentionResponse changeRetention(ChangeRetentionRequest request)
Description copied from interface:DataSafe
Change the online and offline months .- Specified by:
changeRetention
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
changeSdmMaskingPolicyDifferenceCompartment
public ChangeSdmMaskingPolicyDifferenceCompartmentResponse changeSdmMaskingPolicyDifferenceCompartment(ChangeSdmMaskingPolicyDifferenceCompartmentRequest request)
Description copied from interface:DataSafe
Moves the specified SDM masking policy difference into a different compartment.- Specified by:
changeSdmMaskingPolicyDifferenceCompartment
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
changeSecurityAssessmentCompartment
public ChangeSecurityAssessmentCompartmentResponse changeSecurityAssessmentCompartment(ChangeSecurityAssessmentCompartmentRequest request)
Description copied from interface: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.
- Specified by:
changeSecurityAssessmentCompartment
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
changeSecurityPolicyCompartment
public ChangeSecurityPolicyCompartmentResponse changeSecurityPolicyCompartment(ChangeSecurityPolicyCompartmentRequest request)
Description copied from interface:DataSafe
Moves the specified security policy and its dependent resources into a different compartment.- Specified by:
changeSecurityPolicyCompartment
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
changeSecurityPolicyDeploymentCompartment
public ChangeSecurityPolicyDeploymentCompartmentResponse changeSecurityPolicyDeploymentCompartment(ChangeSecurityPolicyDeploymentCompartmentRequest request)
Description copied from interface:DataSafe
Moves the specified security policy deployment and its dependent resources into a different compartment.- Specified by:
changeSecurityPolicyDeploymentCompartment
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
changeSensitiveDataModelCompartment
public ChangeSensitiveDataModelCompartmentResponse changeSensitiveDataModelCompartment(ChangeSensitiveDataModelCompartmentRequest request)
Description copied from interface:DataSafe
Moves the specified sensitive data model and its dependent resources into a different compartment.- Specified by:
changeSensitiveDataModelCompartment
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
changeSensitiveTypeCompartment
public ChangeSensitiveTypeCompartmentResponse changeSensitiveTypeCompartment(ChangeSensitiveTypeCompartmentRequest request)
Description copied from interface:DataSafe
Moves the specified sensitive type into a different compartment.- Specified by:
changeSensitiveTypeCompartment
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
changeSensitiveTypeGroupCompartment
public ChangeSensitiveTypeGroupCompartmentResponse changeSensitiveTypeGroupCompartment(ChangeSensitiveTypeGroupCompartmentRequest request)
Description copied from interface:DataSafe
Moves the sensitive type group to the specified compartment.- Specified by:
changeSensitiveTypeGroupCompartment
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
changeSensitiveTypesExportCompartment
public ChangeSensitiveTypesExportCompartmentResponse changeSensitiveTypesExportCompartment(ChangeSensitiveTypesExportCompartmentRequest request)
Description copied from interface:DataSafe
Moves the specified sensitive types export into a different compartment.- Specified by:
changeSensitiveTypesExportCompartment
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
changeSqlCollectionCompartment
public ChangeSqlCollectionCompartmentResponse changeSqlCollectionCompartment(ChangeSqlCollectionCompartmentRequest request)
Description copied from interface:DataSafe
Moves the specified SQL collection and its dependent resources into a different compartment.- Specified by:
changeSqlCollectionCompartment
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
changeSqlFirewallPolicyCompartment
public ChangeSqlFirewallPolicyCompartmentResponse changeSqlFirewallPolicyCompartment(ChangeSqlFirewallPolicyCompartmentRequest request)
Description copied from interface:DataSafe
Moves the specified SQL Firewall policy and its dependent resources into a different compartment.- Specified by:
changeSqlFirewallPolicyCompartment
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
changeTargetAlertPolicyAssociationCompartment
public ChangeTargetAlertPolicyAssociationCompartmentResponse changeTargetAlertPolicyAssociationCompartment(ChangeTargetAlertPolicyAssociationCompartmentRequest request)
Description copied from interface:DataSafe
Moves the specified target-alert policy Association into a different compartment.- Specified by:
changeTargetAlertPolicyAssociationCompartment
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
changeTargetDatabaseCompartment
public ChangeTargetDatabaseCompartmentResponse changeTargetDatabaseCompartment(ChangeTargetDatabaseCompartmentRequest request)
Description copied from interface:DataSafe
Moves the Data Safe target database to the specified compartment.- Specified by:
changeTargetDatabaseCompartment
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
changeUserAssessmentCompartment
public ChangeUserAssessmentCompartmentResponse changeUserAssessmentCompartment(ChangeUserAssessmentCompartmentRequest request)
Description copied from interface: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.
- Specified by:
changeUserAssessmentCompartment
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
compareSecurityAssessment
public CompareSecurityAssessmentResponse compareSecurityAssessment(CompareSecurityAssessmentRequest request)
Description copied from interface: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.
- Specified by:
compareSecurityAssessment
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
compareUserAssessment
public CompareUserAssessmentResponse compareUserAssessment(CompareUserAssessmentRequest request)
Description copied from interface: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.
- Specified by:
compareUserAssessment
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createAlertPolicy
public CreateAlertPolicyResponse createAlertPolicy(CreateAlertPolicyRequest request)
Description copied from interface:DataSafe
Creates a new user-defined alert policy.- Specified by:
createAlertPolicy
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createAlertPolicyRule
public CreateAlertPolicyRuleResponse createAlertPolicyRule(CreateAlertPolicyRuleRequest request)
Description copied from interface:DataSafe
Creates a new rule for the alert policy.- Specified by:
createAlertPolicyRule
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createAuditArchiveRetrieval
public CreateAuditArchiveRetrievalResponse createAuditArchiveRetrieval(CreateAuditArchiveRetrievalRequest request)
Description copied from interface: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.
- Specified by:
createAuditArchiveRetrieval
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createDataSafePrivateEndpoint
public CreateDataSafePrivateEndpointResponse createDataSafePrivateEndpoint(CreateDataSafePrivateEndpointRequest request)
Description copied from interface:DataSafe
Creates a new Data Safe private endpoint.- Specified by:
createDataSafePrivateEndpoint
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createDiscoveryJob
public CreateDiscoveryJobResponse createDiscoveryJob(CreateDiscoveryJobRequest request)
Description copied from interface: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.
- Specified by:
createDiscoveryJob
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createLibraryMaskingFormat
public CreateLibraryMaskingFormatResponse createLibraryMaskingFormat(CreateLibraryMaskingFormatRequest request)
Description copied from interface: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.
- Specified by:
createLibraryMaskingFormat
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createMaskingColumn
public CreateMaskingColumnResponse createMaskingColumn(CreateMaskingColumnRequest request)
Description copied from interface: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.
- Specified by:
createMaskingColumn
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createMaskingPolicy
public CreateMaskingPolicyResponse createMaskingPolicy(CreateMaskingPolicyRequest request)
Description copied from interface: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.
- Specified by:
createMaskingPolicy
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createOnPremConnector
public CreateOnPremConnectorResponse createOnPremConnector(CreateOnPremConnectorRequest request)
Description copied from interface:DataSafe
Creates a new on-premises connector.- Specified by:
createOnPremConnector
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createPeerTargetDatabase
public CreatePeerTargetDatabaseResponse createPeerTargetDatabase(CreatePeerTargetDatabaseRequest request)
Description copied from interface:DataSafe
Creates the peer target database under the primary target database in Data Safe.- Specified by:
createPeerTargetDatabase
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createReferentialRelation
public CreateReferentialRelationResponse createReferentialRelation(CreateReferentialRelationRequest request)
Description copied from interface:DataSafe
Creates a new referential relation in the specified sensitive data model.- Specified by:
createReferentialRelation
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createReportDefinition
public CreateReportDefinitionResponse createReportDefinition(CreateReportDefinitionRequest request)
Description copied from interface:DataSafe
Creates a new report definition with parameters specified in the body.The report definition is stored in the specified compartment.
- Specified by:
createReportDefinition
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createSdmMaskingPolicyDifference
public CreateSdmMaskingPolicyDifferenceResponse createSdmMaskingPolicyDifference(CreateSdmMaskingPolicyDifferenceRequest request)
Description copied from interface: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.
- Specified by:
createSdmMaskingPolicyDifference
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createSecurityAssessment
public CreateSecurityAssessmentResponse createSecurityAssessment(CreateSecurityAssessmentRequest request)
Description copied from interface: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.
- Specified by:
createSecurityAssessment
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createSensitiveColumn
public CreateSensitiveColumnResponse createSensitiveColumn(CreateSensitiveColumnRequest request)
Description copied from interface:DataSafe
Creates a new sensitive column in the specified sensitive data model.- Specified by:
createSensitiveColumn
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createSensitiveDataModel
public CreateSensitiveDataModelResponse createSensitiveDataModel(CreateSensitiveDataModelRequest request)
Description copied from interface: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.
- Specified by:
createSensitiveDataModel
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createSensitiveType
public CreateSensitiveTypeResponse createSensitiveType(CreateSensitiveTypeRequest request)
Description copied from interface: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.
- Specified by:
createSensitiveType
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createSensitiveTypeGroup
public CreateSensitiveTypeGroupResponse createSensitiveTypeGroup(CreateSensitiveTypeGroupRequest request)
Description copied from interface:DataSafe
Creates a new sensitive type group.- Specified by:
createSensitiveTypeGroup
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createSensitiveTypesExport
public CreateSensitiveTypesExportResponse createSensitiveTypesExport(CreateSensitiveTypesExportRequest request)
Description copied from interface:DataSafe
Generates a downloadable file corresponding to the specified list of sensitive types.It’s a prerequisite for the DownloadSensitiveTypesExport operation. Use this endpoint to generate a sensitive Types Export file and then use DownloadSensitiveTypesExport to download the generated file.
- Specified by:
createSensitiveTypesExport
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createSqlCollection
public CreateSqlCollectionResponse createSqlCollection(CreateSqlCollectionRequest request)
Description copied from interface:DataSafe
Creates a new SQL collection resource.- Specified by:
createSqlCollection
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createTargetAlertPolicyAssociation
public CreateTargetAlertPolicyAssociationResponse createTargetAlertPolicyAssociation(CreateTargetAlertPolicyAssociationRequest request)
Description copied from interface:DataSafe
Creates a new target-alert policy association to track a alert policy applied on target.- Specified by:
createTargetAlertPolicyAssociation
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createTargetDatabase
public CreateTargetDatabaseResponse createTargetDatabase(CreateTargetDatabaseRequest request)
Description copied from interface:DataSafe
Registers the specified database with Data Safe and creates a Data Safe target database in the Data Safe Console.- Specified by:
createTargetDatabase
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createUserAssessment
public CreateUserAssessmentResponse createUserAssessment(CreateUserAssessmentRequest request)
Description copied from interface: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.
- Specified by:
createUserAssessment
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deactivateTargetDatabase
public DeactivateTargetDatabaseResponse deactivateTargetDatabase(DeactivateTargetDatabaseRequest request)
Description copied from interface:DataSafe
Deactivates a target database in Data Safe.- Specified by:
deactivateTargetDatabase
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteAlertPolicy
public DeleteAlertPolicyResponse deleteAlertPolicy(DeleteAlertPolicyRequest request)
Description copied from interface:DataSafe
Deletes the specified user-defined alert policy.- Specified by:
deleteAlertPolicy
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteAlertPolicyRule
public DeleteAlertPolicyRuleResponse deleteAlertPolicyRule(DeleteAlertPolicyRuleRequest request)
Description copied from interface:DataSafe
Deletes the specified user-defined alert policy rule.- Specified by:
deleteAlertPolicyRule
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteAuditArchiveRetrieval
public DeleteAuditArchiveRetrievalResponse deleteAuditArchiveRetrieval(DeleteAuditArchiveRetrievalRequest request)
Description copied from interface:DataSafe
To unload retrieved archive data, call the operation ListAuditArchiveRetrieval first.This will return the auditArchiveRetrievalId. Then call this operation with auditArchiveRetrievalId.
- Specified by:
deleteAuditArchiveRetrieval
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteAuditTrail
public DeleteAuditTrailResponse deleteAuditTrail(DeleteAuditTrailRequest request)
Description copied from interface:DataSafe
Deletes the specified audit trail.- Specified by:
deleteAuditTrail
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteDataSafePrivateEndpoint
public DeleteDataSafePrivateEndpointResponse deleteDataSafePrivateEndpoint(DeleteDataSafePrivateEndpointRequest request)
Description copied from interface:DataSafe
Deletes the specified Data Safe private endpoint.- Specified by:
deleteDataSafePrivateEndpoint
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteDiscoveryJob
public DeleteDiscoveryJobResponse deleteDiscoveryJob(DeleteDiscoveryJobRequest request)
Description copied from interface:DataSafe
Deletes the specified discovery job.- Specified by:
deleteDiscoveryJob
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteDiscoveryJobResult
public DeleteDiscoveryJobResultResponse deleteDiscoveryJobResult(DeleteDiscoveryJobResultRequest request)
Description copied from interface:DataSafe
Deletes the specified discovery result.- Specified by:
deleteDiscoveryJobResult
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteLibraryMaskingFormat
public DeleteLibraryMaskingFormatResponse deleteLibraryMaskingFormat(DeleteLibraryMaskingFormatRequest request)
Description copied from interface:DataSafe
Deletes the specified library masking format.- Specified by:
deleteLibraryMaskingFormat
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteMaskingColumn
public DeleteMaskingColumnResponse deleteMaskingColumn(DeleteMaskingColumnRequest request)
Description copied from interface:DataSafe
Deletes the specified masking column.- Specified by:
deleteMaskingColumn
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteMaskingPolicy
public DeleteMaskingPolicyResponse deleteMaskingPolicy(DeleteMaskingPolicyRequest request)
Description copied from interface:DataSafe
Deletes the specified masking policy.- Specified by:
deleteMaskingPolicy
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteMaskingPolicyHealthReport
public DeleteMaskingPolicyHealthReportResponse deleteMaskingPolicyHealthReport(DeleteMaskingPolicyHealthReportRequest request)
Description copied from interface:DataSafe
Deletes the specified masking policy health report.- Specified by:
deleteMaskingPolicyHealthReport
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteMaskingReport
public DeleteMaskingReportResponse deleteMaskingReport(DeleteMaskingReportRequest request)
Description copied from interface:DataSafe
Deletes the specified masking report.- Specified by:
deleteMaskingReport
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteOnPremConnector
public DeleteOnPremConnectorResponse deleteOnPremConnector(DeleteOnPremConnectorRequest request)
Description copied from interface:DataSafe
Deletes the specified on-premises connector.- Specified by:
deleteOnPremConnector
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deletePeerTargetDatabase
public DeletePeerTargetDatabaseResponse deletePeerTargetDatabase(DeletePeerTargetDatabaseRequest request)
Description copied from interface:DataSafe
Removes the specified peer target database from Data Safe.- Specified by:
deletePeerTargetDatabase
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteReferentialRelation
public DeleteReferentialRelationResponse deleteReferentialRelation(DeleteReferentialRelationRequest request)
Description copied from interface:DataSafe
Deletes the specified referential relation.- Specified by:
deleteReferentialRelation
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteReportDefinition
public DeleteReportDefinitionResponse deleteReportDefinition(DeleteReportDefinitionRequest request)
Description copied from interface:DataSafe
Deletes the specified report definition.Only the user created report definition can be deleted. The seeded report definitions cannot be deleted.
- Specified by:
deleteReportDefinition
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteSdmMaskingPolicyDifference
public DeleteSdmMaskingPolicyDifferenceResponse deleteSdmMaskingPolicyDifference(DeleteSdmMaskingPolicyDifferenceRequest request)
Description copied from interface:DataSafe
Deletes the specified SDM Masking policy difference.- Specified by:
deleteSdmMaskingPolicyDifference
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteSecurityAssessment
public DeleteSecurityAssessmentResponse deleteSecurityAssessment(DeleteSecurityAssessmentRequest request)
Description copied from interface: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.
- Specified by:
deleteSecurityAssessment
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteSensitiveColumn
public DeleteSensitiveColumnResponse deleteSensitiveColumn(DeleteSensitiveColumnRequest request)
Description copied from interface:DataSafe
Deletes the specified sensitive column.- Specified by:
deleteSensitiveColumn
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteSensitiveDataModel
public DeleteSensitiveDataModelResponse deleteSensitiveDataModel(DeleteSensitiveDataModelRequest request)
Description copied from interface:DataSafe
Deletes the specified sensitive data model.- Specified by:
deleteSensitiveDataModel
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteSensitiveType
public DeleteSensitiveTypeResponse deleteSensitiveType(DeleteSensitiveTypeRequest request)
Description copied from interface:DataSafe
Deletes the specified sensitive type.- Specified by:
deleteSensitiveType
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteSensitiveTypeGroup
public DeleteSensitiveTypeGroupResponse deleteSensitiveTypeGroup(DeleteSensitiveTypeGroupRequest request)
Description copied from interface:DataSafe
Deletes the specified sensitive type group.- Specified by:
deleteSensitiveTypeGroup
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteSensitiveTypesExport
public DeleteSensitiveTypesExportResponse deleteSensitiveTypesExport(DeleteSensitiveTypesExportRequest request)
Description copied from interface:DataSafe
Deletes the specified sensitive types export.- Specified by:
deleteSensitiveTypesExport
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteSqlCollection
public DeleteSqlCollectionResponse deleteSqlCollection(DeleteSqlCollectionRequest request)
Description copied from interface:DataSafe
Deletes the specified SQL collection.- Specified by:
deleteSqlCollection
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteSqlFirewallAllowedSql
public DeleteSqlFirewallAllowedSqlResponse deleteSqlFirewallAllowedSql(DeleteSqlFirewallAllowedSqlRequest request)
Description copied from interface:DataSafe
Deletes the specified allowed sql.- Specified by:
deleteSqlFirewallAllowedSql
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteSqlFirewallPolicy
public DeleteSqlFirewallPolicyResponse deleteSqlFirewallPolicy(DeleteSqlFirewallPolicyRequest request)
Description copied from interface:DataSafe
Deletes the SQL Firewall policy resource.- Specified by:
deleteSqlFirewallPolicy
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteTargetAlertPolicyAssociation
public DeleteTargetAlertPolicyAssociationResponse deleteTargetAlertPolicyAssociation(DeleteTargetAlertPolicyAssociationRequest request)
Description copied from interface:DataSafe
Deletes the specified target-alert policy Association.- Specified by:
deleteTargetAlertPolicyAssociation
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteTargetDatabase
public DeleteTargetDatabaseResponse deleteTargetDatabase(DeleteTargetDatabaseRequest request)
Description copied from interface:DataSafe
Deregisters the specified database from Data Safe and removes the target database from the Data Safe Console.- Specified by:
deleteTargetDatabase
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteUserAssessment
public DeleteUserAssessmentResponse deleteUserAssessment(DeleteUserAssessmentRequest request)
Description copied from interface: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.
- Specified by:
deleteUserAssessment
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
discoverAuditTrails
public DiscoverAuditTrailsResponse discoverAuditTrails(DiscoverAuditTrailsRequest request)
Description copied from interface: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.- Specified by:
discoverAuditTrails
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
downloadDiscoveryReport
public DownloadDiscoveryReportResponse downloadDiscoveryReport(DownloadDiscoveryReportRequest request)
Description copied from interface: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.
- Specified by:
downloadDiscoveryReport
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
downloadMaskingLog
public DownloadMaskingLogResponse downloadMaskingLog(DownloadMaskingLogRequest request)
Description copied from interface:DataSafe
Downloads the masking log generated by the last masking operation on a target database using the specified masking policy.- Specified by:
downloadMaskingLog
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
downloadMaskingPolicy
public DownloadMaskingPolicyResponse downloadMaskingPolicy(DownloadMaskingPolicyRequest request)
Description copied from interface: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.
- Specified by:
downloadMaskingPolicy
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
downloadMaskingReport
public DownloadMaskingReportResponse downloadMaskingReport(DownloadMaskingReportRequest request)
Description copied from interface: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.
- Specified by:
downloadMaskingReport
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
downloadPrivilegeScript
public DownloadPrivilegeScriptResponse downloadPrivilegeScript(DownloadPrivilegeScriptRequest request)
Description copied from interface:DataSafe
Downloads the privilege script to grant/revoke required roles from the Data Safe account on the target database.- Specified by:
downloadPrivilegeScript
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
downloadSecurityAssessmentReport
public DownloadSecurityAssessmentReportResponse downloadSecurityAssessmentReport(DownloadSecurityAssessmentReportRequest request)
Description copied from interface: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).
- Specified by:
downloadSecurityAssessmentReport
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
downloadSensitiveDataModel
public DownloadSensitiveDataModelResponse downloadSensitiveDataModel(DownloadSensitiveDataModelRequest request)
Description copied from interface: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.
- Specified by:
downloadSensitiveDataModel
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
downloadSensitiveTypesExport
public DownloadSensitiveTypesExportResponse downloadSensitiveTypesExport(DownloadSensitiveTypesExportRequest request)
Description copied from interface:DataSafe
Downloads an already-generated file corresponding to the specified sensitive types export.Use CreateSensitiveTypesExport to generate an XML file and then use DownloadSensitiveTypesExport to download the generated file.
- Specified by:
downloadSensitiveTypesExport
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
downloadUserAssessmentReport
public DownloadUserAssessmentReportResponse downloadUserAssessmentReport(DownloadUserAssessmentReportRequest request)
Description copied from interface: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).
- Specified by:
downloadUserAssessmentReport
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
enableDataSafeConfiguration
public EnableDataSafeConfigurationResponse enableDataSafeConfiguration(EnableDataSafeConfigurationRequest request)
Description copied from interface:DataSafe
Enables Data Safe in the tenancy and region.- Specified by:
enableDataSafeConfiguration
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
generateDiscoveryReportForDownload
public GenerateDiscoveryReportForDownloadResponse generateDiscoveryReportForDownload(GenerateDiscoveryReportForDownloadRequest request)
Description copied from interface: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.
- Specified by:
generateDiscoveryReportForDownload
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
generateHealthReport
public GenerateHealthReportResponse generateHealthReport(GenerateHealthReportRequest request)
Description copied from interface:DataSafe
Performs health check on the masking policy.- Specified by:
generateHealthReport
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
generateMaskingPolicyForDownload
public GenerateMaskingPolicyForDownloadResponse generateMaskingPolicyForDownload(GenerateMaskingPolicyForDownloadRequest request)
Description copied from interface: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.
- Specified by:
generateMaskingPolicyForDownload
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
generateMaskingReportForDownload
public GenerateMaskingReportForDownloadResponse generateMaskingReportForDownload(GenerateMaskingReportForDownloadRequest request)
Description copied from interface: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.
- Specified by:
generateMaskingReportForDownload
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
generateOnPremConnectorConfiguration
public GenerateOnPremConnectorConfigurationResponse generateOnPremConnectorConfiguration(GenerateOnPremConnectorConfigurationRequest request)
Description copied from interface:DataSafe
Creates and downloads the configuration of the specified on-premises connector.- Specified by:
generateOnPremConnectorConfiguration
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
generateReport
public GenerateReportResponse generateReport(GenerateReportRequest request)
Description copied from interface:DataSafe
Generates a .xls or .pdf report based on parameters and report definition.- Specified by:
generateReport
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
generateSecurityAssessmentReport
public GenerateSecurityAssessmentReportResponse generateSecurityAssessmentReport(GenerateSecurityAssessmentReportRequest request)
Description copied from interface: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.
- Specified by:
generateSecurityAssessmentReport
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
generateSensitiveDataModelForDownload
public GenerateSensitiveDataModelForDownloadResponse generateSensitiveDataModelForDownload(GenerateSensitiveDataModelForDownloadRequest request)
Description copied from interface: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.
- Specified by:
generateSensitiveDataModelForDownload
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
generateSqlFirewallPolicy
public GenerateSqlFirewallPolicyResponse generateSqlFirewallPolicy(GenerateSqlFirewallPolicyRequest request)
Description copied from interface:DataSafe
Generates or appends to the SQL Firewall policy using the specified SQL collection.- Specified by:
generateSqlFirewallPolicy
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
generateUserAssessmentReport
public GenerateUserAssessmentReportResponse generateUserAssessmentReport(GenerateUserAssessmentReportRequest request)
Description copied from interface: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.
- Specified by:
generateUserAssessmentReport
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getAlert
public GetAlertResponse getAlert(GetAlertRequest request)
Description copied from interface:DataSafe
Gets the details of the specified alerts.
-
getAlertPolicy
public GetAlertPolicyResponse getAlertPolicy(GetAlertPolicyRequest request)
Description copied from interface:DataSafe
Gets the details of alert policy by its ID.- Specified by:
getAlertPolicy
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getAlertPolicyRule
public GetAlertPolicyRuleResponse getAlertPolicyRule(GetAlertPolicyRuleRequest request)
Description copied from interface:DataSafe
Gets the details of a policy rule by its key.- Specified by:
getAlertPolicyRule
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getAuditArchiveRetrieval
public GetAuditArchiveRetrievalResponse getAuditArchiveRetrieval(GetAuditArchiveRetrievalRequest request)
Description copied from interface:DataSafe
Gets the details of the specified archive retreival.- Specified by:
getAuditArchiveRetrieval
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getAuditPolicy
public GetAuditPolicyResponse getAuditPolicy(GetAuditPolicyRequest request)
Description copied from interface:DataSafe
Gets a audit policy by identifier.- Specified by:
getAuditPolicy
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getAuditProfile
public GetAuditProfileResponse getAuditProfile(GetAuditProfileRequest request)
Description copied from interface:DataSafe
Gets the details of audit profile resource and associated audit trails of the audit profile.- Specified by:
getAuditProfile
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getAuditTrail
public GetAuditTrailResponse getAuditTrail(GetAuditTrailRequest request)
Description copied from interface:DataSafe
Gets the details of audit trail.- Specified by:
getAuditTrail
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getCompatibleFormatsForDataTypes
public GetCompatibleFormatsForDataTypesResponse getCompatibleFormatsForDataTypes(GetCompatibleFormatsForDataTypesRequest request)
Description copied from interface: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
- Specified by:
getCompatibleFormatsForDataTypes
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getCompatibleFormatsForSensitiveTypes
public GetCompatibleFormatsForSensitiveTypesResponse getCompatibleFormatsForSensitiveTypes(GetCompatibleFormatsForSensitiveTypesRequest request)
Description copied from interface: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.
- Specified by:
getCompatibleFormatsForSensitiveTypes
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getDataSafeConfiguration
public GetDataSafeConfigurationResponse getDataSafeConfiguration(GetDataSafeConfigurationRequest request)
Description copied from interface:DataSafe
Gets the details of the Data Safe configuration.- Specified by:
getDataSafeConfiguration
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getDataSafePrivateEndpoint
public GetDataSafePrivateEndpointResponse getDataSafePrivateEndpoint(GetDataSafePrivateEndpointRequest request)
Description copied from interface:DataSafe
Gets the details of the specified Data Safe private endpoint.- Specified by:
getDataSafePrivateEndpoint
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getDatabaseSecurityConfig
public GetDatabaseSecurityConfigResponse getDatabaseSecurityConfig(GetDatabaseSecurityConfigRequest request)
Description copied from interface:DataSafe
Gets a database security configuration by identifier.- Specified by:
getDatabaseSecurityConfig
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getDatabaseTableAccessEntry
public GetDatabaseTableAccessEntryResponse getDatabaseTableAccessEntry(GetDatabaseTableAccessEntryRequest request)
Description copied from interface:DataSafe
Gets a database table access entry object by identifier.- Specified by:
getDatabaseTableAccessEntry
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getDatabaseViewAccessEntry
public GetDatabaseViewAccessEntryResponse getDatabaseViewAccessEntry(GetDatabaseViewAccessEntryRequest request)
Description copied from interface:DataSafe
Gets a database view access object by identifier.- Specified by:
getDatabaseViewAccessEntry
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getDifferenceColumn
public GetDifferenceColumnResponse getDifferenceColumn(GetDifferenceColumnRequest request)
Description copied from interface:DataSafe
Gets the details of the specified SDM Masking policy difference column.- Specified by:
getDifferenceColumn
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getDiscoveryJob
public GetDiscoveryJobResponse getDiscoveryJob(GetDiscoveryJobRequest request)
Description copied from interface:DataSafe
Gets the details of the specified discovery job.- Specified by:
getDiscoveryJob
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getDiscoveryJobResult
public GetDiscoveryJobResultResponse getDiscoveryJobResult(GetDiscoveryJobResultRequest request)
Description copied from interface:DataSafe
Gets the details of the specified discovery result.- Specified by:
getDiscoveryJobResult
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getLibraryMaskingFormat
public GetLibraryMaskingFormatResponse getLibraryMaskingFormat(GetLibraryMaskingFormatRequest request)
Description copied from interface:DataSafe
Gets the details of the specified library masking format.- Specified by:
getLibraryMaskingFormat
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getMaskingColumn
public GetMaskingColumnResponse getMaskingColumn(GetMaskingColumnRequest request)
Description copied from interface:DataSafe
Gets the details of the specified masking column.- Specified by:
getMaskingColumn
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getMaskingPolicy
public GetMaskingPolicyResponse getMaskingPolicy(GetMaskingPolicyRequest request)
Description copied from interface:DataSafe
Gets the details of the specified masking policy.- Specified by:
getMaskingPolicy
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getMaskingPolicyHealthReport
public GetMaskingPolicyHealthReportResponse getMaskingPolicyHealthReport(GetMaskingPolicyHealthReportRequest request)
Description copied from interface:DataSafe
Gets the details of the specified masking policy health report.- Specified by:
getMaskingPolicyHealthReport
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getMaskingReport
public GetMaskingReportResponse getMaskingReport(GetMaskingReportRequest request)
Description copied from interface:DataSafe
Gets the details of the specified masking report.- Specified by:
getMaskingReport
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getOnPremConnector
public GetOnPremConnectorResponse getOnPremConnector(GetOnPremConnectorRequest request)
Description copied from interface:DataSafe
Gets the details of the specified on-premises connector.- Specified by:
getOnPremConnector
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getPeerTargetDatabase
public GetPeerTargetDatabaseResponse getPeerTargetDatabase(GetPeerTargetDatabaseRequest request)
Description copied from interface:DataSafe
Returns the details of the specified Data Safe peer target database.- Specified by:
getPeerTargetDatabase
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getProfile
public GetProfileResponse getProfile(GetProfileRequest request)
Description copied from interface: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.
- Specified by:
getProfile
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getReferentialRelation
public GetReferentialRelationResponse getReferentialRelation(GetReferentialRelationRequest request)
Description copied from interface:DataSafe
Gets the details of the specified referential relation.- Specified by:
getReferentialRelation
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getReport
public GetReportResponse getReport(GetReportRequest request)
Description copied from interface:DataSafe
Gets a report by identifier
-
getReportContent
public GetReportContentResponse getReportContent(GetReportContentRequest request)
Description copied from interface:DataSafe
Downloads the specified report in the form of .xls or .pdf.- Specified by:
getReportContent
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getReportDefinition
public GetReportDefinitionResponse getReportDefinition(GetReportDefinitionRequest request)
Description copied from interface:DataSafe
Gets the details of report definition specified by the identifier- Specified by:
getReportDefinition
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getSdmMaskingPolicyDifference
public GetSdmMaskingPolicyDifferenceResponse getSdmMaskingPolicyDifference(GetSdmMaskingPolicyDifferenceRequest request)
Description copied from interface:DataSafe
Gets the details of the specified SDM Masking policy difference.- Specified by:
getSdmMaskingPolicyDifference
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getSecurityAssessment
public GetSecurityAssessmentResponse getSecurityAssessment(GetSecurityAssessmentRequest request)
Description copied from interface:DataSafe
Gets the details of the specified security assessment.- Specified by:
getSecurityAssessment
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getSecurityAssessmentComparison
public GetSecurityAssessmentComparisonResponse getSecurityAssessmentComparison(GetSecurityAssessmentComparisonRequest request)
Description copied from interface:DataSafe
Gets the details of the comparison report for the security assessments submitted for comparison.- Specified by:
getSecurityAssessmentComparison
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getSecurityPolicy
public GetSecurityPolicyResponse getSecurityPolicy(GetSecurityPolicyRequest request)
Description copied from interface:DataSafe
Gets a security policy by the specified OCID of the security policy resource.- Specified by:
getSecurityPolicy
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getSecurityPolicyDeployment
public GetSecurityPolicyDeploymentResponse getSecurityPolicyDeployment(GetSecurityPolicyDeploymentRequest request)
Description copied from interface:DataSafe
Gets a security policy deployment by identifier.- Specified by:
getSecurityPolicyDeployment
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getSecurityPolicyEntryState
public GetSecurityPolicyEntryStateResponse getSecurityPolicyEntryState(GetSecurityPolicyEntryStateRequest request)
Description copied from interface:DataSafe
Gets a security policy entity states by identifier.- Specified by:
getSecurityPolicyEntryState
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getSecurityPolicyReport
public GetSecurityPolicyReportResponse getSecurityPolicyReport(GetSecurityPolicyReportRequest request)
Description copied from interface:DataSafe
Gets a security policy report by the specified OCID of the security policy report resource.- Specified by:
getSecurityPolicyReport
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getSensitiveColumn
public GetSensitiveColumnResponse getSensitiveColumn(GetSensitiveColumnRequest request)
Description copied from interface:DataSafe
Gets the details of the specified sensitive column.- Specified by:
getSensitiveColumn
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getSensitiveDataModel
public GetSensitiveDataModelResponse getSensitiveDataModel(GetSensitiveDataModelRequest request)
Description copied from interface:DataSafe
Gets the details of the specified sensitive data model.- Specified by:
getSensitiveDataModel
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getSensitiveType
public GetSensitiveTypeResponse getSensitiveType(GetSensitiveTypeRequest request)
Description copied from interface:DataSafe
Gets the details of the specified sensitive type.- Specified by:
getSensitiveType
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getSensitiveTypeGroup
public GetSensitiveTypeGroupResponse getSensitiveTypeGroup(GetSensitiveTypeGroupRequest request)
Description copied from interface:DataSafe
Gets the details of the specified sensitive type group.- Specified by:
getSensitiveTypeGroup
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getSensitiveTypesExport
public GetSensitiveTypesExportResponse getSensitiveTypesExport(GetSensitiveTypesExportRequest request)
Description copied from interface:DataSafe
Gets the details of the specified sensitive types export by identifier.- Specified by:
getSensitiveTypesExport
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getSqlCollection
public GetSqlCollectionResponse getSqlCollection(GetSqlCollectionRequest request)
Description copied from interface:DataSafe
Gets a SQL collection by identifier.- Specified by:
getSqlCollection
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getSqlFirewallAllowedSql
public GetSqlFirewallAllowedSqlResponse getSqlFirewallAllowedSql(GetSqlFirewallAllowedSqlRequest request)
Description copied from interface:DataSafe
Gets a SQL firewall allowed SQL by identifier.- Specified by:
getSqlFirewallAllowedSql
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getSqlFirewallPolicy
public GetSqlFirewallPolicyResponse getSqlFirewallPolicy(GetSqlFirewallPolicyRequest request)
Description copied from interface:DataSafe
Gets a SQL Firewall policy by identifier.- Specified by:
getSqlFirewallPolicy
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getTargetAlertPolicyAssociation
public GetTargetAlertPolicyAssociationResponse getTargetAlertPolicyAssociation(GetTargetAlertPolicyAssociationRequest request)
Description copied from interface:DataSafe
Gets the details of target-alert policy association by its ID.- Specified by:
getTargetAlertPolicyAssociation
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getTargetDatabase
public GetTargetDatabaseResponse getTargetDatabase(GetTargetDatabaseRequest request)
Description copied from interface:DataSafe
Returns the details of the specified Data Safe target database.- Specified by:
getTargetDatabase
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getUserAssessment
public GetUserAssessmentResponse getUserAssessment(GetUserAssessmentRequest request)
Description copied from interface:DataSafe
Gets a user assessment by identifier.- Specified by:
getUserAssessment
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getUserAssessmentComparison
public GetUserAssessmentComparisonResponse getUserAssessmentComparison(GetUserAssessmentComparisonRequest request)
Description copied from interface:DataSafe
Gets the details of the comparison report for the user assessments submitted for comparison.- Specified by:
getUserAssessmentComparison
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getWorkRequest
public GetWorkRequestResponse getWorkRequest(GetWorkRequestRequest request)
Description copied from interface:DataSafe
Gets the details of the specified work request.- Specified by:
getWorkRequest
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listAlertAnalytics
public ListAlertAnalyticsResponse listAlertAnalytics(ListAlertAnalyticsRequest request)
Description copied from interface:DataSafe
Returns the aggregation details of the alerts.- Specified by:
listAlertAnalytics
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listAlertPolicies
public ListAlertPoliciesResponse listAlertPolicies(ListAlertPoliciesRequest request)
Description copied from interface:DataSafe
Gets a list of all alert policies.- Specified by:
listAlertPolicies
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listAlertPolicyRules
public ListAlertPolicyRulesResponse listAlertPolicyRules(ListAlertPolicyRulesRequest request)
Description copied from interface: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.
- Specified by:
listAlertPolicyRules
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listAlerts
public ListAlertsResponse listAlerts(ListAlertsRequest request)
Description copied from interface:DataSafe
Gets a list of all alerts.- Specified by:
listAlerts
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listAuditArchiveRetrievals
public ListAuditArchiveRetrievalsResponse listAuditArchiveRetrievals(ListAuditArchiveRetrievalsRequest request)
Description copied from interface:DataSafe
Returns the list of audit archive retrieval.- Specified by:
listAuditArchiveRetrievals
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listAuditEventAnalytics
public ListAuditEventAnalyticsResponse listAuditEventAnalytics(ListAuditEventAnalyticsRequest request)
Description copied from interface: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:** /auditEventAnalytics?summaryField=targetName&summaryField=userName&summaryField=clientHostname &summaryField=dmls&summaryField=privilegeChanges&summaryField=ddls&summaryField=loginFailure&summaryField=loginSuccess &summaryField=allRecord&scimQuery=(auditEventTime ge \"2021-06-13T23:49:14\")
/auditEventAnalytics?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.
/auditEventAnalytics?summaryField=targetName&groupBy=targetName This will give the number of events group by targetName. Only targetName summary column would be returned.
- Specified by:
listAuditEventAnalytics
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listAuditEvents
public ListAuditEventsResponse listAuditEvents(ListAuditEventsRequest request)
Description copied from interface:DataSafe
The ListAuditEvents operation returns specifiedcompartmentId
audit Events only.The list does not include any audit Events associated with the
subcompartments
of the specifiedcompartmentId
.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.
- Specified by:
listAuditEvents
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listAuditPolicies
public ListAuditPoliciesResponse listAuditPolicies(ListAuditPoliciesRequest request)
Description copied from interface: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.
- Specified by:
listAuditPolicies
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listAuditPolicyAnalytics
public ListAuditPolicyAnalyticsResponse listAuditPolicyAnalytics(ListAuditPolicyAnalyticsRequest request)
Description copied from interface: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
- Specified by:
listAuditPolicyAnalytics
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listAuditProfileAnalytics
public ListAuditProfileAnalyticsResponse listAuditProfileAnalytics(ListAuditProfileAnalyticsRequest request)
Description copied from interface: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.
- Specified by:
listAuditProfileAnalytics
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listAuditProfiles
public ListAuditProfilesResponse listAuditProfiles(ListAuditProfilesRequest request)
Description copied from interface: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.
- Specified by:
listAuditProfiles
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listAuditTrailAnalytics
public ListAuditTrailAnalyticsResponse listAuditTrailAnalytics(ListAuditTrailAnalyticsRequest request)
Description copied from interface: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.
- Specified by:
listAuditTrailAnalytics
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listAuditTrails
public ListAuditTrailsResponse listAuditTrails(ListAuditTrailsRequest request)
Description copied from interface: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.
- Specified by:
listAuditTrails
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listAvailableAuditVolumes
public ListAvailableAuditVolumesResponse listAvailableAuditVolumes(ListAvailableAuditVolumesRequest request)
Description copied from interface:DataSafe
Retrieves a list of audit trails, and associated audit event volume for each trail up to defined start date.- Specified by:
listAvailableAuditVolumes
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listCollectedAuditVolumes
public ListCollectedAuditVolumesResponse listCollectedAuditVolumes(ListCollectedAuditVolumesRequest request)
Description copied from interface:DataSafe
Gets a list of all collected audit volume data points.- Specified by:
listCollectedAuditVolumes
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listColumns
public ListColumnsResponse listColumns(ListColumnsRequest request)
Description copied from interface:DataSafe
Returns a list of column metadata objects.- Specified by:
listColumns
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listDataSafePrivateEndpoints
public ListDataSafePrivateEndpointsResponse listDataSafePrivateEndpoints(ListDataSafePrivateEndpointsRequest request)
Description copied from interface:DataSafe
Gets a list of Data Safe private endpoints.- Specified by:
listDataSafePrivateEndpoints
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listDatabaseSecurityConfigs
public ListDatabaseSecurityConfigsResponse listDatabaseSecurityConfigs(ListDatabaseSecurityConfigsRequest request)
Description copied from interface: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.
- Specified by:
listDatabaseSecurityConfigs
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listDatabaseTableAccessEntries
public ListDatabaseTableAccessEntriesResponse listDatabaseTableAccessEntries(ListDatabaseTableAccessEntriesRequest request)
Description copied from interface: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.
- Specified by:
listDatabaseTableAccessEntries
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listDatabaseViewAccessEntries
public ListDatabaseViewAccessEntriesResponse listDatabaseViewAccessEntries(ListDatabaseViewAccessEntriesRequest request)
Description copied from interface: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.
- Specified by:
listDatabaseViewAccessEntries
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listDifferenceColumns
public ListDifferenceColumnsResponse listDifferenceColumns(ListDifferenceColumnsRequest request)
Description copied from interface:DataSafe
Gets a list of columns of a SDM masking policy difference resource based on the specified query parameters.- Specified by:
listDifferenceColumns
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listDiscoveryAnalytics
public ListDiscoveryAnalyticsResponse listDiscoveryAnalytics(ListDiscoveryAnalyticsRequest request)
Description copied from interface: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.
- Specified by:
listDiscoveryAnalytics
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listDiscoveryJobResults
public ListDiscoveryJobResultsResponse listDiscoveryJobResults(ListDiscoveryJobResultsRequest request)
Description copied from interface:DataSafe
Gets a list of discovery results based on the specified query parameters.- Specified by:
listDiscoveryJobResults
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listDiscoveryJobs
public ListDiscoveryJobsResponse listDiscoveryJobs(ListDiscoveryJobsRequest request)
Description copied from interface:DataSafe
Gets a list of incremental discovery jobs based on the specified query parameters.- Specified by:
listDiscoveryJobs
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listFindingAnalytics
public ListFindingAnalyticsResponse listFindingAnalytics(ListFindingAnalyticsRequest request)
Description copied from interface: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.
- Specified by:
listFindingAnalytics
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listFindings
public ListFindingsResponse listFindings(ListFindingsRequest request)
Description copied from interface:DataSafe
List all the findings from all the targets in the specified compartment.- Specified by:
listFindings
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listFindingsChangeAuditLogs
public ListFindingsChangeAuditLogsResponse listFindingsChangeAuditLogs(ListFindingsChangeAuditLogsRequest request)
Description copied from interface:DataSafe
List all changes made by user to risk level of findings of the specified assessment.- Specified by:
listFindingsChangeAuditLogs
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listGrants
public ListGrantsResponse listGrants(ListGrantsRequest request)
Description copied from interface: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.
- Specified by:
listGrants
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listGroupedSensitiveTypes
public ListGroupedSensitiveTypesResponse listGroupedSensitiveTypes(ListGroupedSensitiveTypesRequest request)
Description copied from interface:DataSafe
Gets the list of sensitive type Ids present in the specified sensitive type group.- Specified by:
listGroupedSensitiveTypes
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listLibraryMaskingFormats
public ListLibraryMaskingFormatsResponse listLibraryMaskingFormats(ListLibraryMaskingFormatsRequest request)
Description copied from interface:DataSafe
Gets a list of library masking formats based on the specified query parameters.- Specified by:
listLibraryMaskingFormats
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listMaskedColumns
public ListMaskedColumnsResponse listMaskedColumns(ListMaskedColumnsRequest request)
Description copied from interface:DataSafe
Gets a list of masked columns present in the specified masking report and based on the specified query parameters.- Specified by:
listMaskedColumns
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listMaskingAnalytics
public ListMaskingAnalyticsResponse listMaskingAnalytics(ListMaskingAnalyticsRequest request)
Description copied from interface: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.
- Specified by:
listMaskingAnalytics
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listMaskingColumns
public ListMaskingColumnsResponse listMaskingColumns(ListMaskingColumnsRequest request)
Description copied from interface:DataSafe
Gets a list of masking columns present in the specified masking policy and based on the specified query parameters.- Specified by:
listMaskingColumns
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listMaskingErrors
public ListMaskingErrorsResponse listMaskingErrors(ListMaskingErrorsRequest request)
Description copied from interface:DataSafe
Gets a list of masking errors in a masking run based on the specified query parameters.- Specified by:
listMaskingErrors
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listMaskingObjects
public ListMaskingObjectsResponse listMaskingObjects(ListMaskingObjectsRequest request)
Description copied from interface:DataSafe
Gets a list of masking objects present in the specified masking policy and based on the specified query parameters.- Specified by:
listMaskingObjects
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listMaskingPolicies
public ListMaskingPoliciesResponse listMaskingPolicies(ListMaskingPoliciesRequest request)
Description copied from interface:DataSafe
Gets a list of masking policies based on the specified query parameters.- Specified by:
listMaskingPolicies
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listMaskingPolicyHealthReportLogs
public ListMaskingPolicyHealthReportLogsResponse listMaskingPolicyHealthReportLogs(ListMaskingPolicyHealthReportLogsRequest request)
Description copied from interface:DataSafe
Gets a list of errors and warnings from a masking policy health check.- Specified by:
listMaskingPolicyHealthReportLogs
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listMaskingPolicyHealthReports
public ListMaskingPolicyHealthReportsResponse listMaskingPolicyHealthReports(ListMaskingPolicyHealthReportsRequest request)
Description copied from interface:DataSafe
Gets a list of masking policy health reports based on the specified query parameters.- Specified by:
listMaskingPolicyHealthReports
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listMaskingPolicyReferentialRelations
public ListMaskingPolicyReferentialRelationsResponse listMaskingPolicyReferentialRelations(ListMaskingPolicyReferentialRelationsRequest request)
Description copied from interface:DataSafe
Gets a list of referential relations present in the specified masking policy based on the specified query parameters.- Specified by:
listMaskingPolicyReferentialRelations
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listMaskingReports
public ListMaskingReportsResponse listMaskingReports(ListMaskingReportsRequest request)
Description copied from interface:DataSafe
Gets a list of masking reports based on the specified query parameters.- Specified by:
listMaskingReports
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listMaskingSchemas
public ListMaskingSchemasResponse listMaskingSchemas(ListMaskingSchemasRequest request)
Description copied from interface:DataSafe
Gets a list of masking schemas present in the specified masking policy and based on the specified query parameters.- Specified by:
listMaskingSchemas
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listOnPremConnectors
public ListOnPremConnectorsResponse listOnPremConnectors(ListOnPremConnectorsRequest request)
Description copied from interface:DataSafe
Gets a list of on-premises connectors.- Specified by:
listOnPremConnectors
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listPasswordExpiryDateAnalytics
public ListPasswordExpiryDateAnalyticsResponse listPasswordExpiryDateAnalytics(ListPasswordExpiryDateAnalyticsRequest request)
Description copied from interface:DataSafe
Gets a list of count of the users with password expiry dates in next 30 days, between next 30-90 days, and beyond 90 days based on specified user assessment.It internally uses the aforementioned userAnalytics api.
When you perform the ListPasswordExpiryDateAnalytics 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 READ 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.
To use ListPasswordExpiryDateAnalytics 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.
- Specified by:
listPasswordExpiryDateAnalytics
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listPeerTargetDatabases
public ListPeerTargetDatabasesResponse listPeerTargetDatabases(ListPeerTargetDatabasesRequest request)
Description copied from interface:DataSafe
Lists all the peer target databases under the primary target database identified by the OCID passed as path parameter.- Specified by:
listPeerTargetDatabases
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listProfileAnalytics
public ListProfileAnalyticsResponse listProfileAnalytics(ListProfileAnalyticsRequest request)
Description copied from interface: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.
- Specified by:
listProfileAnalytics
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listProfileSummaries
public ListProfileSummariesResponse listProfileSummaries(ListProfileSummariesRequest request)
Description copied from interface: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.
- Specified by:
listProfileSummaries
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listReferentialRelations
public ListReferentialRelationsResponse listReferentialRelations(ListReferentialRelationsRequest request)
Description copied from interface:DataSafe
Gets a list of referential relations present in the specified sensitive data model based on the specified query parameters.- Specified by:
listReferentialRelations
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listReportDefinitions
public ListReportDefinitionsResponse listReportDefinitions(ListReportDefinitionsRequest request)
Description copied from interface: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.- Specified by:
listReportDefinitions
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listReports
public ListReportsResponse listReports(ListReportsRequest request)
Description copied from interface:DataSafe
Gets a list of all the reports in the compartment.It contains information such as report generation time.
- Specified by:
listReports
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listRoleGrantPaths
public ListRoleGrantPathsResponse listRoleGrantPaths(ListRoleGrantPathsRequest request)
Description copied from interface: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.
- Specified by:
listRoleGrantPaths
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listRoles
public ListRolesResponse listRoles(ListRolesRequest request)
Description copied from interface:DataSafe
Returns a list of role metadata objects.
-
listSchemas
public ListSchemasResponse listSchemas(ListSchemasRequest request)
Description copied from interface:DataSafe
Returns list of schema.- Specified by:
listSchemas
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listSdmMaskingPolicyDifferences
public ListSdmMaskingPolicyDifferencesResponse listSdmMaskingPolicyDifferences(ListSdmMaskingPolicyDifferencesRequest request)
Description copied from interface:DataSafe
Gets a list of SDM and masking policy difference resources based on the specified query parameters.- Specified by:
listSdmMaskingPolicyDifferences
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listSecurityAssessments
public ListSecurityAssessmentsResponse listSecurityAssessments(ListSecurityAssessmentsRequest request)
Description copied from interface: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.
- Specified by:
listSecurityAssessments
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listSecurityFeatureAnalytics
public ListSecurityFeatureAnalyticsResponse listSecurityFeatureAnalytics(ListSecurityFeatureAnalyticsRequest request)
Description copied from interface: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.
- Specified by:
listSecurityFeatureAnalytics
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listSecurityFeatures
public ListSecurityFeaturesResponse listSecurityFeatures(ListSecurityFeaturesRequest request)
Description copied from interface:DataSafe
Lists the usage of Database security features for a given compartment or a target level, based on the filters provided.- Specified by:
listSecurityFeatures
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listSecurityPolicies
public ListSecurityPoliciesResponse listSecurityPolicies(ListSecurityPoliciesRequest request)
Description copied from interface: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.
- Specified by:
listSecurityPolicies
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listSecurityPolicyDeployments
public ListSecurityPolicyDeploymentsResponse listSecurityPolicyDeployments(ListSecurityPolicyDeploymentsRequest request)
Description copied from interface: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.
- Specified by:
listSecurityPolicyDeployments
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listSecurityPolicyEntryStates
public ListSecurityPolicyEntryStatesResponse listSecurityPolicyEntryStates(ListSecurityPolicyEntryStatesRequest request)
Description copied from interface: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.
- Specified by:
listSecurityPolicyEntryStates
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listSecurityPolicyReports
public ListSecurityPolicyReportsResponse listSecurityPolicyReports(ListSecurityPolicyReportsRequest request)
Description copied from interface: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.
- Specified by:
listSecurityPolicyReports
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listSensitiveColumnAnalytics
public ListSensitiveColumnAnalyticsResponse listSensitiveColumnAnalytics(ListSensitiveColumnAnalyticsRequest request)
Description copied from interface:DataSafe
Gets consolidated sensitive columns analytics data based on the specified query parameters.When you perform the ListSensitiveColumnAnalytics 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.
To use ListSensitiveColumnAnalytics 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.
- Specified by:
listSensitiveColumnAnalytics
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listSensitiveColumns
public ListSensitiveColumnsResponse listSensitiveColumns(ListSensitiveColumnsRequest request)
Description copied from interface:DataSafe
Gets a list of sensitive columns present in the specified sensitive data model based on the specified query parameters.- Specified by:
listSensitiveColumns
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listSensitiveDataModelSensitiveTypes
public ListSensitiveDataModelSensitiveTypesResponse listSensitiveDataModelSensitiveTypes(ListSensitiveDataModelSensitiveTypesRequest request)
Description copied from interface:DataSafe
Gets a list of sensitive type Ids present in the specified sensitive data model.- Specified by:
listSensitiveDataModelSensitiveTypes
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listSensitiveDataModels
public ListSensitiveDataModelsResponse listSensitiveDataModels(ListSensitiveDataModelsRequest request)
Description copied from interface:DataSafe
Gets a list of sensitive data models based on the specified query parameters.- Specified by:
listSensitiveDataModels
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listSensitiveObjects
public ListSensitiveObjectsResponse listSensitiveObjects(ListSensitiveObjectsRequest request)
Description copied from interface:DataSafe
Gets a list of sensitive objects present in the specified sensitive data model based on the specified query parameters.- Specified by:
listSensitiveObjects
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listSensitiveSchemas
public ListSensitiveSchemasResponse listSensitiveSchemas(ListSensitiveSchemasRequest request)
Description copied from interface:DataSafe
Gets a list of sensitive schemas present in the specified sensitive data model based on the specified query parameters.- Specified by:
listSensitiveSchemas
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listSensitiveTypeGroups
public ListSensitiveTypeGroupsResponse listSensitiveTypeGroups(ListSensitiveTypeGroupsRequest request)
Description copied from interface:DataSafe
Gets a list of sensitive type groups based on the specified query parameters.- Specified by:
listSensitiveTypeGroups
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listSensitiveTypes
public ListSensitiveTypesResponse listSensitiveTypes(ListSensitiveTypesRequest request)
Description copied from interface:DataSafe
Gets a list of sensitive types based on the specified query parameters.- Specified by:
listSensitiveTypes
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listSensitiveTypesExports
public ListSensitiveTypesExportsResponse listSensitiveTypesExports(ListSensitiveTypesExportsRequest request)
Description copied from interface:DataSafe
Retrieves a list of all sensitive types export in Data Safe based on the specified query parameters.The ListSensitiveTypesExports operation returns only the sensitive types export in the specified
compartmentId
.- Specified by:
listSensitiveTypesExports
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listSqlCollectionAnalytics
public ListSqlCollectionAnalyticsResponse listSqlCollectionAnalytics(ListSqlCollectionAnalyticsRequest request)
Description copied from interface: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.
- Specified by:
listSqlCollectionAnalytics
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listSqlCollectionLogInsights
public ListSqlCollectionLogInsightsResponse listSqlCollectionLogInsights(ListSqlCollectionLogInsightsRequest request)
Description copied from interface:DataSafe
Retrieves a list of the SQL collection log analytics.- Specified by:
listSqlCollectionLogInsights
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listSqlCollections
public ListSqlCollectionsResponse listSqlCollections(ListSqlCollectionsRequest request)
Description copied from interface: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.
- Specified by:
listSqlCollections
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listSqlFirewallAllowedSqlAnalytics
public ListSqlFirewallAllowedSqlAnalyticsResponse listSqlFirewallAllowedSqlAnalytics(ListSqlFirewallAllowedSqlAnalyticsRequest request)
Description copied from interface: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.
- Specified by:
listSqlFirewallAllowedSqlAnalytics
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listSqlFirewallAllowedSqls
public ListSqlFirewallAllowedSqlsResponse listSqlFirewallAllowedSqls(ListSqlFirewallAllowedSqlsRequest request)
Description copied from interface: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.
- Specified by:
listSqlFirewallAllowedSqls
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listSqlFirewallPolicies
public ListSqlFirewallPoliciesResponse listSqlFirewallPolicies(ListSqlFirewallPoliciesRequest request)
Description copied from interface: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.
- Specified by:
listSqlFirewallPolicies
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listSqlFirewallPolicyAnalytics
public ListSqlFirewallPolicyAnalyticsResponse listSqlFirewallPolicyAnalytics(ListSqlFirewallPolicyAnalyticsRequest request)
Description copied from interface: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.
- Specified by:
listSqlFirewallPolicyAnalytics
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listSqlFirewallViolationAnalytics
public ListSqlFirewallViolationAnalyticsResponse listSqlFirewallViolationAnalytics(ListSqlFirewallViolationAnalyticsRequest request)
Description copied from interface:DataSafe
Returns the aggregation details of the SQL Firewall violations.- Specified by:
listSqlFirewallViolationAnalytics
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listSqlFirewallViolations
public ListSqlFirewallViolationsResponse listSqlFirewallViolations(ListSqlFirewallViolationsRequest request)
Description copied from interface:DataSafe
Gets a list of all the SQL Firewall violations captured by the firewall.- Specified by:
listSqlFirewallViolations
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listTables
public ListTablesResponse listTables(ListTablesRequest request)
Description copied from interface:DataSafe
Returns a list of table metadata objects.- Specified by:
listTables
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listTargetAlertPolicyAssociations
public ListTargetAlertPolicyAssociationsResponse listTargetAlertPolicyAssociations(ListTargetAlertPolicyAssociationsRequest request)
Description copied from interface:DataSafe
Gets a list of all target-alert policy associations.- Specified by:
listTargetAlertPolicyAssociations
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listTargetDatabases
public ListTargetDatabasesResponse listTargetDatabases(ListTargetDatabasesRequest request)
Description copied from interface:DataSafe
Returns the list of registered target databases in Data Safe.- Specified by:
listTargetDatabases
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listUserAccessAnalytics
public ListUserAccessAnalyticsResponse listUserAccessAnalytics(ListUserAccessAnalyticsRequest request)
Description copied from interface:DataSafe
Gets a list of aggregated user access analytics in the specified target in a compartment.- Specified by:
listUserAccessAnalytics
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listUserAnalytics
public ListUserAnalyticsResponse listUserAnalytics(ListUserAnalyticsRequest request)
Description copied from interface: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 READ 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.
- Specified by:
listUserAnalytics
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listUserAssessments
public ListUserAssessmentsResponse listUserAssessments(ListUserAssessmentsRequest request)
Description copied from interface: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.
- Specified by:
listUserAssessments
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listUsers
public ListUsersResponse listUsers(ListUsersRequest request)
Description copied from interface: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.
-
listWorkRequestErrors
public ListWorkRequestErrorsResponse listWorkRequestErrors(ListWorkRequestErrorsRequest request)
Description copied from interface:DataSafe
Gets a list of errors for the specified work request.- Specified by:
listWorkRequestErrors
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listWorkRequestLogs
public ListWorkRequestLogsResponse listWorkRequestLogs(ListWorkRequestLogsRequest request)
Description copied from interface:DataSafe
Gets a list of log entries for the specified work request.- Specified by:
listWorkRequestLogs
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listWorkRequests
public ListWorkRequestsResponse listWorkRequests(ListWorkRequestsRequest request)
Description copied from interface:DataSafe
Gets a list of work requests.- Specified by:
listWorkRequests
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
maskData
public MaskDataResponse maskData(MaskDataRequest request)
Description copied from interface:DataSafe
Masks data using the specified masking policy.
-
modifyGlobalSettings
public ModifyGlobalSettingsResponse modifyGlobalSettings(ModifyGlobalSettingsRequest request)
Description copied from interface:DataSafe
Modifies Global Settings in Data Safe in the tenancy and region.- Specified by:
modifyGlobalSettings
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
patchAlerts
public PatchAlertsResponse patchAlerts(PatchAlertsRequest request)
Description copied from interface:DataSafe
Updates the status of one or more alert specified by the alert IDs.- Specified by:
patchAlerts
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
patchDiscoveryJobResults
public PatchDiscoveryJobResultsResponse patchDiscoveryJobResults(PatchDiscoveryJobResultsRequest request)
Description copied from interface: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.
- Specified by:
patchDiscoveryJobResults
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
patchGroupedSensitiveTypes
public PatchGroupedSensitiveTypesResponse patchGroupedSensitiveTypes(PatchGroupedSensitiveTypesRequest request)
Description copied from interface:DataSafe
Patches one or more sensitive types in a sensitive type group.You can use this operation to add or remove sensitive type ids in a sensitive type group.
- Specified by:
patchGroupedSensitiveTypes
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
patchMaskingColumns
public PatchMaskingColumnsResponse patchMaskingColumns(PatchMaskingColumnsRequest request)
Description copied from interface: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.
- Specified by:
patchMaskingColumns
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
patchSdmMaskingPolicyDifferenceColumns
public PatchSdmMaskingPolicyDifferenceColumnsResponse patchSdmMaskingPolicyDifferenceColumns(PatchSdmMaskingPolicyDifferenceColumnsRequest request)
Description copied from interface: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.
- Specified by:
patchSdmMaskingPolicyDifferenceColumns
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
patchSensitiveColumns
public PatchSensitiveColumnsResponse patchSensitiveColumns(PatchSensitiveColumnsRequest request)
Description copied from interface: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.
- Specified by:
patchSensitiveColumns
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
patchSqlFirewallAllowedSql
public PatchSqlFirewallAllowedSqlResponse patchSqlFirewallAllowedSql(PatchSqlFirewallAllowedSqlRequest request)
Description copied from interface: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.
- Specified by:
patchSqlFirewallAllowedSql
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
patchTargetAlertPolicyAssociation
public PatchTargetAlertPolicyAssociationResponse patchTargetAlertPolicyAssociation(PatchTargetAlertPolicyAssociationRequest request)
Description copied from interface:DataSafe
Creates new target-alert policy associations that will be applied on the target database.- Specified by:
patchTargetAlertPolicyAssociation
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
provisionAuditPolicy
public ProvisionAuditPolicyResponse provisionAuditPolicy(ProvisionAuditPolicyRequest request)
Description copied from interface:DataSafe
Provision audit policy.- Specified by:
provisionAuditPolicy
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
purgeSqlCollectionLogs
public PurgeSqlCollectionLogsResponse purgeSqlCollectionLogs(PurgeSqlCollectionLogsRequest request)
Description copied from interface:DataSafe
Purge the SQL collection logs for the specified SqlCollection.- Specified by:
purgeSqlCollectionLogs
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
refreshDatabaseSecurityConfiguration
public RefreshDatabaseSecurityConfigurationResponse refreshDatabaseSecurityConfiguration(RefreshDatabaseSecurityConfigurationRequest request)
Description copied from interface:DataSafe
Refreshes the specified database security configuration.- Specified by:
refreshDatabaseSecurityConfiguration
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
refreshSecurityAssessment
public RefreshSecurityAssessmentResponse refreshSecurityAssessment(RefreshSecurityAssessmentRequest request)
Description copied from interface: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.
- Specified by:
refreshSecurityAssessment
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
refreshSqlCollectionLogInsights
public RefreshSqlCollectionLogInsightsResponse refreshSqlCollectionLogInsights(RefreshSqlCollectionLogInsightsRequest request)
Description copied from interface:DataSafe
Refresh the specified SQL collection Log Insights.- Specified by:
refreshSqlCollectionLogInsights
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
refreshTargetDatabase
public RefreshTargetDatabaseResponse refreshTargetDatabase(RefreshTargetDatabaseRequest request)
Description copied from interface:DataSafe
Refreshes the Data Safe target database to update it’s state.- Specified by:
refreshTargetDatabase
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
refreshUserAssessment
public RefreshUserAssessmentResponse refreshUserAssessment(RefreshUserAssessmentRequest request)
Description copied from interface: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.
- Specified by:
refreshUserAssessment
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
removeScheduleReport
public RemoveScheduleReportResponse removeScheduleReport(RemoveScheduleReportRequest request)
Description copied from interface:DataSafe
Deletes the schedule of a .xls or .pdf report.- Specified by:
removeScheduleReport
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
resumeAuditTrail
public ResumeAuditTrailResponse resumeAuditTrail(ResumeAuditTrailRequest request)
Description copied from interface:DataSafe
Resumes the specified audit trail once it got stopped.- Specified by:
resumeAuditTrail
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
resumeWorkRequest
public ResumeWorkRequestResponse resumeWorkRequest(ResumeWorkRequestRequest request)
Description copied from interface:DataSafe
Resume the given work request.Issuing a resume does not guarantee of immediate resume of the work request.
- Specified by:
resumeWorkRequest
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
retrieveAuditPolicies
public RetrieveAuditPoliciesResponse retrieveAuditPolicies(RetrieveAuditPoliciesRequest request)
Description copied from interface:DataSafe
Retrieves the audit policy details from the source target database.- Specified by:
retrieveAuditPolicies
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
scheduleReport
public ScheduleReportResponse scheduleReport(ScheduleReportRequest request)
Description copied from interface:DataSafe
Schedules a .xls or .pdf report based on parameters and report definition.- Specified by:
scheduleReport
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
setSecurityAssessmentBaseline
public SetSecurityAssessmentBaselineResponse setSecurityAssessmentBaseline(SetSecurityAssessmentBaselineRequest request)
Description copied from interface: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’.
- Specified by:
setSecurityAssessmentBaseline
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
setUserAssessmentBaseline
public SetUserAssessmentBaselineResponse setUserAssessmentBaseline(SetUserAssessmentBaselineRequest request)
Description copied from interface: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’.
- Specified by:
setUserAssessmentBaseline
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
startAuditTrail
public StartAuditTrailResponse startAuditTrail(StartAuditTrailRequest request)
Description copied from interface:DataSafe
Starts collection of audit records on the specified audit trail.- Specified by:
startAuditTrail
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
startSqlCollection
public StartSqlCollectionResponse startSqlCollection(StartSqlCollectionRequest request)
Description copied from interface:DataSafe
Start the specified SQL collection.- Specified by:
startSqlCollection
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
stopAuditTrail
public StopAuditTrailResponse stopAuditTrail(StopAuditTrailRequest request)
Description copied from interface:DataSafe
Stops the specified audit trail.- Specified by:
stopAuditTrail
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
stopSqlCollection
public StopSqlCollectionResponse stopSqlCollection(StopSqlCollectionRequest request)
Description copied from interface:DataSafe
Stops the specified SQL collection.- Specified by:
stopSqlCollection
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
suspendWorkRequest
public SuspendWorkRequestResponse suspendWorkRequest(SuspendWorkRequestRequest request)
Description copied from interface:DataSafe
Suspend the given work request.Issuing a suspend does not guarantee of a immediate suspend of the work request.
- Specified by:
suspendWorkRequest
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
unsetSecurityAssessmentBaseline
public UnsetSecurityAssessmentBaselineResponse unsetSecurityAssessmentBaseline(UnsetSecurityAssessmentBaselineRequest request)
Description copied from interface: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.
- Specified by:
unsetSecurityAssessmentBaseline
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
unsetUserAssessmentBaseline
public UnsetUserAssessmentBaselineResponse unsetUserAssessmentBaseline(UnsetUserAssessmentBaselineRequest request)
Description copied from interface: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.
- Specified by:
unsetUserAssessmentBaseline
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateAlert
public UpdateAlertResponse updateAlert(UpdateAlertRequest request)
Description copied from interface:DataSafe
Updates the status of the specified alert.- Specified by:
updateAlert
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateAlertPolicy
public UpdateAlertPolicyResponse updateAlertPolicy(UpdateAlertPolicyRequest request)
Description copied from interface:DataSafe
Updates the specified alert policy .- Specified by:
updateAlertPolicy
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateAlertPolicyRule
public UpdateAlertPolicyRuleResponse updateAlertPolicyRule(UpdateAlertPolicyRuleRequest request)
Description copied from interface:DataSafe
Updates the specified alert policy rule.- Specified by:
updateAlertPolicyRule
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateAuditArchiveRetrieval
public UpdateAuditArchiveRetrievalResponse updateAuditArchiveRetrieval(UpdateAuditArchiveRetrievalRequest request)
Description copied from interface:DataSafe
Updates the audit archive retrieval.- Specified by:
updateAuditArchiveRetrieval
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateAuditPolicy
public UpdateAuditPolicyResponse updateAuditPolicy(UpdateAuditPolicyRequest request)
Description copied from interface:DataSafe
Updates the audit policy.- Specified by:
updateAuditPolicy
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateAuditProfile
public UpdateAuditProfileResponse updateAuditProfile(UpdateAuditProfileRequest request)
Description copied from interface:DataSafe
Updates one or more attributes of the specified audit profile.- Specified by:
updateAuditProfile
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateAuditTrail
public UpdateAuditTrailResponse updateAuditTrail(UpdateAuditTrailRequest request)
Description copied from interface:DataSafe
Updates one or more attributes of the specified audit trail.- Specified by:
updateAuditTrail
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateDataSafePrivateEndpoint
public UpdateDataSafePrivateEndpointResponse updateDataSafePrivateEndpoint(UpdateDataSafePrivateEndpointRequest request)
Description copied from interface:DataSafe
Updates one or more attributes of the specified Data Safe private endpoint.- Specified by:
updateDataSafePrivateEndpoint
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateDatabaseSecurityConfig
public UpdateDatabaseSecurityConfigResponse updateDatabaseSecurityConfig(UpdateDatabaseSecurityConfigRequest request)
Description copied from interface:DataSafe
Updates the database security configuration.- Specified by:
updateDatabaseSecurityConfig
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateFinding
public UpdateFindingResponse updateFinding(UpdateFindingRequest request)
Description copied from interface:DataSafe
Updates one or more attributes of the specified finding.- Specified by:
updateFinding
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateLibraryMaskingFormat
public UpdateLibraryMaskingFormatResponse updateLibraryMaskingFormat(UpdateLibraryMaskingFormatRequest request)
Description copied from interface: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.
- Specified by:
updateLibraryMaskingFormat
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateMaskingColumn
public UpdateMaskingColumnResponse updateMaskingColumn(UpdateMaskingColumnRequest request)
Description copied from interface: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.
- Specified by:
updateMaskingColumn
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateMaskingPolicy
public UpdateMaskingPolicyResponse updateMaskingPolicy(UpdateMaskingPolicyRequest request)
Description copied from interface:DataSafe
Updates one or more attributes of the specified masking policy.- Specified by:
updateMaskingPolicy
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateOnPremConnector
public UpdateOnPremConnectorResponse updateOnPremConnector(UpdateOnPremConnectorRequest request)
Description copied from interface:DataSafe
Updates one or more attributes of the specified on-premises connector.- Specified by:
updateOnPremConnector
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateOnPremConnectorWallet
public UpdateOnPremConnectorWalletResponse updateOnPremConnectorWallet(UpdateOnPremConnectorWalletRequest request)
Description copied from interface:DataSafe
Updates the wallet for the specified on-premises connector to a new version.- Specified by:
updateOnPremConnectorWallet
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updatePeerTargetDatabase
public UpdatePeerTargetDatabaseResponse updatePeerTargetDatabase(UpdatePeerTargetDatabaseRequest request)
Description copied from interface:DataSafe
Updates one or more attributes of the specified Data Safe peer target database.- Specified by:
updatePeerTargetDatabase
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateReport
public UpdateReportResponse updateReport(UpdateReportRequest request)
Description copied from interface:DataSafe
Updates the specified report.Only tags can be updated.
- Specified by:
updateReport
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateReportDefinition
public UpdateReportDefinitionResponse updateReportDefinition(UpdateReportDefinitionRequest request)
Description copied from interface: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.
- Specified by:
updateReportDefinition
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateSdmMaskingPolicyDifference
public UpdateSdmMaskingPolicyDifferenceResponse updateSdmMaskingPolicyDifference(UpdateSdmMaskingPolicyDifferenceRequest request)
Description copied from interface:DataSafe
Updates one or more attributes of the specified sdm masking policy difference.- Specified by:
updateSdmMaskingPolicyDifference
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateSecurityAssessment
public UpdateSecurityAssessmentResponse updateSecurityAssessment(UpdateSecurityAssessmentRequest request)
Description copied from interface:DataSafe
Updates one or more attributes of the specified security assessment.This operation allows to update the security assessment displayName, description, or schedule.
- Specified by:
updateSecurityAssessment
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateSecurityPolicy
public UpdateSecurityPolicyResponse updateSecurityPolicy(UpdateSecurityPolicyRequest request)
Description copied from interface:DataSafe
Updates the security policy.- Specified by:
updateSecurityPolicy
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateSecurityPolicyDeployment
public UpdateSecurityPolicyDeploymentResponse updateSecurityPolicyDeployment(UpdateSecurityPolicyDeploymentRequest request)
Description copied from interface:DataSafe
Updates the security policy deployment.- Specified by:
updateSecurityPolicyDeployment
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateSensitiveColumn
public UpdateSensitiveColumnResponse updateSensitiveColumn(UpdateSensitiveColumnRequest request)
Description copied from interface:DataSafe
Updates one or more attributes of the specified sensitive column.- Specified by:
updateSensitiveColumn
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateSensitiveDataModel
public UpdateSensitiveDataModelResponse updateSensitiveDataModel(UpdateSensitiveDataModelRequest request)
Description copied from interface: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.
- Specified by:
updateSensitiveDataModel
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateSensitiveType
public UpdateSensitiveTypeResponse updateSensitiveType(UpdateSensitiveTypeRequest request)
Description copied from interface:DataSafe
Updates one or more attributes of the specified sensitive type.- Specified by:
updateSensitiveType
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateSensitiveTypeGroup
public UpdateSensitiveTypeGroupResponse updateSensitiveTypeGroup(UpdateSensitiveTypeGroupRequest request)
Description copied from interface:DataSafe
Updates one or more attributes of the specified sensitive type group.- Specified by:
updateSensitiveTypeGroup
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateSensitiveTypesExport
public UpdateSensitiveTypesExportResponse updateSensitiveTypesExport(UpdateSensitiveTypesExportRequest request)
Description copied from interface:DataSafe
Updates one or more attributes of the specified sensitive types export.- Specified by:
updateSensitiveTypesExport
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateSqlCollection
public UpdateSqlCollectionResponse updateSqlCollection(UpdateSqlCollectionRequest request)
Description copied from interface:DataSafe
Updates the SQL collection.- Specified by:
updateSqlCollection
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateSqlFirewallPolicy
public UpdateSqlFirewallPolicyResponse updateSqlFirewallPolicy(UpdateSqlFirewallPolicyRequest request)
Description copied from interface:DataSafe
Updates the SQL Firewall policy.- Specified by:
updateSqlFirewallPolicy
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateTargetAlertPolicyAssociation
public UpdateTargetAlertPolicyAssociationResponse updateTargetAlertPolicyAssociation(UpdateTargetAlertPolicyAssociationRequest request)
Description copied from interface:DataSafe
Updates the specified target-alert policy association.- Specified by:
updateTargetAlertPolicyAssociation
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateTargetDatabase
public UpdateTargetDatabaseResponse updateTargetDatabase(UpdateTargetDatabaseRequest request)
Description copied from interface:DataSafe
Updates one or more attributes of the specified Data Safe target database.- Specified by:
updateTargetDatabase
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateUserAssessment
public UpdateUserAssessmentResponse updateUserAssessment(UpdateUserAssessmentRequest request)
Description copied from interface:DataSafe
Updates one or more attributes of the specified user assessment.This operation allows to update the user assessment displayName, description, or schedule.
- Specified by:
updateUserAssessment
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
uploadMaskingPolicy
public UploadMaskingPolicyResponse uploadMaskingPolicy(UploadMaskingPolicyRequest request)
Description copied from interface: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)
andInputStream.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 toInputStream.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'sFileChannel
position can be changed (like for a regular file), the stream will be wrapped in such a way that it does provide support forInputStream.mark(int)
andInputStream.reset()
. Then the same procedure as above is followed. If the stream'sFileChannel
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)
andInputStream.reset()
, then the stream is wrapped in aBufferedInputStream
, 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
whoseFileChannel
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.- Specified by:
uploadMaskingPolicy
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
uploadSensitiveDataModel
public UploadSensitiveDataModelResponse uploadSensitiveDataModel(UploadSensitiveDataModelRequest request)
Description copied from interface: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)
andInputStream.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 toInputStream.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'sFileChannel
position can be changed (like for a regular file), the stream will be wrapped in such a way that it does provide support forInputStream.mark(int)
andInputStream.reset()
. Then the same procedure as above is followed. If the stream'sFileChannel
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)
andInputStream.reset()
, then the stream is wrapped in aBufferedInputStream
, 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
whoseFileChannel
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.- Specified by:
uploadSensitiveDataModel
in interfaceDataSafe
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getWaiters
public DataSafeWaiters getWaiters()
Description copied from interface:DataSafe
Gets the pre-configured waiters available for resources for this service.- Specified by:
getWaiters
in interfaceDataSafe
- Returns:
- The service waiters.
-
getPaginators
public DataSafePaginators getPaginators()
Description copied from interface: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.- Specified by:
getPaginators
in interfaceDataSafe
- Returns:
- The service paginators.
-
getDefaultConfigurator
protected ClientConfigurator getDefaultConfigurator()
-
useRealmSpecificEndpointTemplate
public void useRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled)
This method should be used to enable or disable the use of realm-specific endpoint template.The default value is null. To enable the use of endpoint template defined for the realm in use, set the flag to true To disable the use of endpoint template defined for the realm in use, set the flag to false
- Parameters:
useOfRealmSpecificEndpointTemplateEnabled
- This flag can be set to true or false to enable or disable the use of realm-specific endpoint template respectively
-
populateServiceParametersInEndpoint
public final void populateServiceParametersInEndpoint(String endpoint, Map<String,Object> requiredParametersMap)
Populate the parameters in the endpoint with its corresponding value and update the base endpoint.The value will be populated iff the parameter in endpoint is a required request path parameter or a required request query parameter. If not, the parameter in the endpoint will be ignored and left blank.
- Parameters:
endpoint
- The endpoint template in userequiredParametersMap
- Map of parameter name as key and value set in request path or query parameter as value
-
updateBaseEndpoint
public final void updateBaseEndpoint(String endpoint)
This method should be used for parameterized endpoint templates only.This does not include {region} and {secondLevelDomain} parameters.
- Parameters:
endpoint
- The updated endpoint to use
-
setEndpoint
public final void setEndpoint(String endpoint)
-
getEndpoint
public final String getEndpoint()
-
refreshClient
public final void refreshClient()
Rebuild the backingHttpClient
.This will call
ClientConfigurator
s again, and can be used to e.g. refresh the SSL certificate.
-
close
public final void close()
- Specified by:
close
in interfaceAutoCloseable
-
getClientCommonLibraryVersion
public String getClientCommonLibraryVersion()
-
-