Class DataSafeClient

    • Field Detail

      • SERVICE

        public static final Service SERVICE
        Service instance for DataSafe.
      • clientCommonLibraryVersion

        public final String clientCommonLibraryVersion
        Compatible SDK version, provided by the codegen.
      • minimumClientCommonLibraryVersionFromClient

        public final Optional<String> minimumClientCommonLibraryVersionFromClient
        Minimum compatible SDK version, maybe provided by the codegen.
    • Method Detail

      • 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.

        Specified by:
        setRegion in interface DataSafe
        Parameters:
        region - The region of the service.
      • 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 call setEndpoint.

        Specified by:
        setRegion in interface DataSafe
        Parameters:
        regionId - The public region ID.
      • 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 interface DataSafe
        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 interface DataSafe
        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 interface DataSafe
        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 interface DataSafe
        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) and InputStream.reset(), when a retry is necessary, the stream is reset so it starts at the beginning (or whatever the stream's position was at the time this operation is called}.

        Note this means that if the caller has used InputStream.mark(int) before, then the mark will not be the same anymore after this operation, and a subsequent call to InputStream.reset() by the caller will reset the stream not to the caller's mark, but to the position the stream was in when this operation was called.

        If the stream is a FileInputStream, and the stream's FileChannel position can be changed (like for a regular file), the stream will be wrapped in such a way that it does provide support for InputStream.mark(int) and InputStream.reset(). Then the same procedure as above is followed. If the stream's FileChannel position cannot be changed (like for a named pipe), then the stream's contents will be buffered in memory, as described below.

        If the stream does not support InputStream.mark(int) and InputStream.reset(), then the stream is wrapped in a BufferedInputStream, which means the entire contents may be buffered in memory. Then the same procedure as above is followed.

        The contents of the stream, except when the stream is a FileInputStream whose FileChannel position can be changed, should be less than 2 GiB in size if retries are used. This is because streams 2 GiB in size or larger do no guarantee that mark-and-reset can be performed. If the stream is larger, do not use built-in retries and manage retries yourself.

        Specified by:
        bulkCreateSensitiveTypes in interface DataSafe
        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 interface DataSafe
        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 interface DataSafe
        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 interface DataSafe
        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 interface DataSafe
        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 interface DataSafe
        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 interface DataSafe
        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 interface DataSafe
        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 interface DataSafe
        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 interface DataSafe
        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 interface DataSafe
        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 interface DataSafe
        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 interface DataSafe
        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 interface DataSafe
        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 interface DataSafe
        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 interface DataSafe
        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 interface DataSafe
        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 interface DataSafe
        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 interface DataSafe
        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 interface DataSafe
        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 interface DataSafe
        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 interface DataSafe
        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 interface DataSafe
        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 interface DataSafe
        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 interface DataSafe
        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 interface DataSafe
        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 interface DataSafe
        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 interface DataSafe
        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 interface DataSafe
        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 interface DataSafe
        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 interface DataSafe
        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 interface DataSafe
        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 interface DataSafe
        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 interface DataSafe
        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 interface DataSafe
        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 interface DataSafe
        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 interface DataSafe
        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 interface DataSafe
        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 interface DataSafe
        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 interface DataSafe
        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 interface DataSafe
        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 interface DataSafe
        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.
        Specified by:
        getAlert in interface DataSafe
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
      • getAlertPolicy

        public GetAlertPolicyResponse getAlertPolicy​(GetAlertPolicyRequest request)
        Description copied from interface: DataSafe
        Gets the details of alert policy by its ID.
        Specified by:
        getAlertPolicy in interface DataSafe
        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 interface DataSafe
        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 interface DataSafe
        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 interface DataSafe
        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 interface DataSafe
        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 interface DataSafe
        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 interface DataSafe
        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 interface DataSafe
        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 interface DataSafe
        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 interface DataSafe
        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 interface DataSafe
        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 interface DataSafe
        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
        Specified by:
        getReport in interface DataSafe
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
      • 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 interface DataSafe
        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 interface DataSafe
        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 interface DataSafe
        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 interface DataSafe
        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 interface DataSafe
        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 interface DataSafe
        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 interface DataSafe
        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 interface DataSafe
        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 specified compartmentId audit Events only.

        The list does not include any audit Events associated with the subcompartments of the specified compartmentId.

        The parameter `accessLevel` specifies whether to return only those compartments for which the requestor has INSPECT permissions on at least one resource directly or indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if Principal doesn't have access to even one of the child compartments. This is valid only when `compartmentIdInSubtree` is set to `true`.

        The parameter `compartmentIdInSubtree` applies when you perform ListAuditEvents on the `compartmentId` passed and when it is set to true, the entire hierarchy of compartments can be returned. To get a full list of all compartments and subcompartments in the tenancy (root compartment), set the parameter `compartmentIdInSubtree` to true and `accessLevel` to ACCESSIBLE.

        Specified by:
        listAuditEvents in interface DataSafe
        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 interface DataSafe
        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 interface DataSafe
        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 interface DataSafe
        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 interface DataSafe
        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 interface DataSafe
        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 interface DataSafe
        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 interface DataSafe
        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 interface DataSafe
        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 interface DataSafe
        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 interface DataSafe
        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 interface DataSafe
        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 interface DataSafe
        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 interface DataSafe
        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 interface DataSafe
        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 interface DataSafe
        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 interface DataSafe
        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 interface DataSafe
        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 interface DataSafe
        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 interface DataSafe
        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 interface DataSafe
        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 interface DataSafe
        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 interface DataSafe
        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 interface DataSafe
        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 interface DataSafe
        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 interface DataSafe
        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 interface DataSafe
        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 interface DataSafe
        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 interface DataSafe
        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 interface DataSafe
        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 interface DataSafe
        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 interface DataSafe
        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 interface DataSafe
        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.
        Specified by:
        listRoles in interface DataSafe
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
      • listSchemas

        public ListSchemasResponse listSchemas​(ListSchemasRequest request)
        Description copied from interface: DataSafe
        Returns list of schema.
        Specified by:
        listSchemas in interface DataSafe
        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 interface DataSafe
        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 interface DataSafe
        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 interface DataSafe
        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 interface DataSafe
        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 interface DataSafe
        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 interface DataSafe
        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 interface DataSafe
        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 interface DataSafe
        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 interface DataSafe
        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 interface DataSafe
        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 interface DataSafe
        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 interface DataSafe
        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 interface DataSafe
        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 interface DataSafe
        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 interface DataSafe
        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 interface DataSafe
        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 interface DataSafe
        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 interface DataSafe
        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 interface DataSafe
        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 interface DataSafe
        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 interface DataSafe
        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 interface DataSafe
        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.

        Specified by:
        listUsers in interface DataSafe
        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.
        Specified by:
        maskData in interface DataSafe
        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 interface DataSafe
        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 interface DataSafe
        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 interface DataSafe
        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 interface DataSafe
        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 interface DataSafe
        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 interface DataSafe
        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 interface DataSafe
        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 interface DataSafe
        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 interface DataSafe
        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 interface DataSafe
        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 interface DataSafe
        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 interface DataSafe
        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 interface DataSafe
        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 interface DataSafe
        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 interface DataSafe
        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 interface DataSafe
        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 interface DataSafe
        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 interface DataSafe
        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 interface DataSafe
        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 interface DataSafe
        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 interface DataSafe
        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 interface DataSafe
        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 interface DataSafe
        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 interface DataSafe
        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 interface DataSafe
        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 interface DataSafe
        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 interface DataSafe
        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 interface DataSafe
        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) and InputStream.reset(), when a retry is necessary, the stream is reset so it starts at the beginning (or whatever the stream's position was at the time this operation is called}.

        Note this means that if the caller has used InputStream.mark(int) before, then the mark will not be the same anymore after this operation, and a subsequent call to InputStream.reset() by the caller will reset the stream not to the caller's mark, but to the position the stream was in when this operation was called.

        If the stream is a FileInputStream, and the stream's FileChannel position can be changed (like for a regular file), the stream will be wrapped in such a way that it does provide support for InputStream.mark(int) and InputStream.reset(). Then the same procedure as above is followed. If the stream's FileChannel position cannot be changed (like for a named pipe), then the stream's contents will be buffered in memory, as described below.

        If the stream does not support InputStream.mark(int) and InputStream.reset(), then the stream is wrapped in a BufferedInputStream, which means the entire contents may be buffered in memory. Then the same procedure as above is followed.

        The contents of the stream, except when the stream is a FileInputStream whose FileChannel position can be changed, should be less than 2 GiB in size if retries are used. This is because streams 2 GiB in size or larger do no guarantee that mark-and-reset can be performed. If the stream is larger, do not use built-in retries and manage retries yourself.

        Specified by:
        uploadMaskingPolicy in interface DataSafe
        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) and InputStream.reset(), when a retry is necessary, the stream is reset so it starts at the beginning (or whatever the stream's position was at the time this operation is called}.

        Note this means that if the caller has used InputStream.mark(int) before, then the mark will not be the same anymore after this operation, and a subsequent call to InputStream.reset() by the caller will reset the stream not to the caller's mark, but to the position the stream was in when this operation was called.

        If the stream is a FileInputStream, and the stream's FileChannel position can be changed (like for a regular file), the stream will be wrapped in such a way that it does provide support for InputStream.mark(int) and InputStream.reset(). Then the same procedure as above is followed. If the stream's FileChannel position cannot be changed (like for a named pipe), then the stream's contents will be buffered in memory, as described below.

        If the stream does not support InputStream.mark(int) and InputStream.reset(), then the stream is wrapped in a BufferedInputStream, which means the entire contents may be buffered in memory. Then the same procedure as above is followed.

        The contents of the stream, except when the stream is a FileInputStream whose FileChannel position can be changed, should be less than 2 GiB in size if retries are used. This is because streams 2 GiB in size or larger do no guarantee that mark-and-reset can be performed. If the stream is larger, do not use built-in retries and manage retries yourself.

        Specified by:
        uploadSensitiveDataModel in interface DataSafe
        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 interface DataSafe
        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 interface DataSafe
        Returns:
        The service paginators.
      • 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 use
        requiredParametersMap - 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 backing HttpClient.

        This will call ClientConfigurators again, and can be used to e.g. refresh the SSL certificate.

      • getClientCommonLibraryVersion

        public String getClientCommonLibraryVersion()
      • getMinimumClientCommonLibraryVersionFromClient

        public Optional<String> getMinimumClientCommonLibraryVersionFromClient()