Class: OCI::DataSafe::DataSafeClient

Inherits:

Object

• Object
• OCI::DataSafe::DataSafeClient

Defined in:

lib/oci/data_safe/data_safe_client.rb

Overview

APIs for using Oracle Data Safe.

Instance Attribute Summary

• #api_client ⇒ OCI::ApiClient readonly

  Client used to make HTTP requests.

• #endpoint ⇒ String readonly

  Fully qualified endpoint URL.

• #region ⇒ String

  The region, which will usually correspond to a value in Regions::REGION_ENUM.

• #retry_config ⇒ OCI::Retry::RetryConfig readonly

  The default retry configuration to apply to all operations in this service client.

Instance Method Summary

• #activate_target_database(activate_target_database_details, target_database_id, opts = {}) ⇒ Response

  Reactivates a previously deactivated Data Safe target database.

• #add_masking_columns_from_sdm(masking_policy_id, opts = {}) ⇒ Response

  Adds columns to the specified masking policy from the associated sensitive data model.

• #alerts_update(alerts_update_details, opts = {}) ⇒ Response

  Updates alerts in the specified compartment.

• #apply_discovery_job_results(sensitive_data_model_id, apply_discovery_job_results_details, opts = {}) ⇒ Response

  Applies the results of a discovery job to the specified sensitive data model.

• #apply_sdm_masking_policy_difference(masking_policy_id, apply_sdm_masking_policy_difference_details, opts = {}) ⇒ Response

  Applies the difference of a SDM Masking policy difference resource to the specified masking policy.

• #calculate_audit_volume_available(audit_profile_id, calculate_audit_volume_available_details, opts = {}) ⇒ Response

  Calculates the volume of audit events available on the target database to be collected.

• #calculate_audit_volume_collected(audit_profile_id, calculate_audit_volume_collected_details, opts = {}) ⇒ Response

  Calculates the volume of audit events collected by data safe.

• #cancel_work_request(work_request_id, opts = {}) ⇒ Response

  Cancel the specified work request.

• #change_alert_compartment(alert_id, change_alert_compartment_details, opts = {}) ⇒ Response

  Moves the specified alert into a different compartment.

• #change_audit_archive_retrieval_compartment(audit_archive_retrieval_id, change_audit_archive_retrieval_compartment_details, opts = {}) ⇒ Response

  Moves the archive retreival to the specified compartment.

• #change_audit_policy_compartment(audit_policy_id, change_audit_policy_compartment_details, opts = {}) ⇒ Response

  Moves the specified audit policy and its dependent resources into a different compartment.

• #change_audit_profile_compartment(audit_profile_id, change_audit_profile_compartment_details, opts = {}) ⇒ Response

  Moves the specified audit profile and its dependent resources into a different compartment.

• #change_data_safe_private_endpoint_compartment(data_safe_private_endpoint_id, change_data_safe_private_endpoint_compartment_details, opts = {}) ⇒ Response

  Moves the Data Safe private endpoint and its dependent resources to the specified compartment.

• #change_database_security_config_compartment(database_security_config_id, change_database_security_config_compartment_details, opts = {}) ⇒ Response

  Moves the specified database security configuration and its dependent resources into a different compartment.

• #change_discovery_job_compartment(discovery_job_id, change_discovery_job_compartment_details, opts = {}) ⇒ Response

  Moves the specified discovery job and its dependent resources into a different compartment.

• #change_library_masking_format_compartment(library_masking_format_id, change_library_masking_format_compartment_details, opts = {}) ⇒ Response

  Moves the specified library masking format into a different compartment.

• #change_masking_policy_compartment(masking_policy_id, change_masking_policy_compartment_details, opts = {}) ⇒ Response

  Moves the specified masking policy and its dependent resources into a different compartment.

• #change_on_prem_connector_compartment(on_prem_connector_id, change_on_prem_connector_compartment_details, opts = {}) ⇒ Response

  Moves the specified on-premises connector into a different compartment.

• #change_report_compartment(report_id, change_report_compartment_details, opts = {}) ⇒ Response

  Moves a resource into a different compartment.

• #change_report_definition_compartment(report_definition_id, change_report_definition_compartment_details, opts = {}) ⇒ Response

  Moves a resource into a different compartment.

• #change_retention(audit_profile_id, change_retention_details, opts = {}) ⇒ Response

  Change the online and offline months .

• #change_sdm_masking_policy_difference_compartment(sdm_masking_policy_difference_id, change_sdm_masking_policy_difference_compartment_details, opts = {}) ⇒ Response

  Moves the specified SDM masking policy difference into a different compartment.

• #change_security_assessment_compartment(security_assessment_id, change_security_assessment_compartment_details, opts = {}) ⇒ Response

  Moves the specified saved security assessment or future scheduled assessments into a different compartment.

• #change_security_policy_compartment(security_policy_id, change_security_policy_compartment_details, opts = {}) ⇒ Response

  Moves the specified security policy and its dependent resources into a different compartment.

• #change_security_policy_deployment_compartment(security_policy_deployment_id, change_security_policy_deployment_compartment_details, opts = {}) ⇒ Response

  Moves the specified security policy deployment and its dependent resources into a different compartment.

• #change_sensitive_data_model_compartment(sensitive_data_model_id, change_sensitive_data_model_compartment_details, opts = {}) ⇒ Response

  Moves the specified sensitive data model and its dependent resources into a different compartment.

• #change_sensitive_type_compartment(sensitive_type_id, change_sensitive_type_compartment_details, opts = {}) ⇒ Response

  Moves the specified sensitive type into a different compartment.

• #change_sql_collection_compartment(sql_collection_id, change_sql_collection_compartment_details, opts = {}) ⇒ Response

  Moves the specified SQL collection and its dependent resources into a different compartment.

• #change_sql_firewall_policy_compartment(sql_firewall_policy_id, change_sql_firewall_policy_compartment_details, opts = {}) ⇒ Response

  Moves the specified SQL firewall policy and its dependent resources into a different compartment.

• #change_target_alert_policy_association_compartment(target_alert_policy_association_id, change_target_alert_policy_association_compartment_details, opts = {}) ⇒ Response

  Moves the specified target-alert policy Association into a different compartment.

• #change_target_database_compartment(target_database_id, change_target_database_compartment_details, opts = {}) ⇒ Response

  Moves the Data Safe target database to the specified compartment.

• #change_user_assessment_compartment(user_assessment_id, change_user_assessment_compartment_details, opts = {}) ⇒ Response

  Moves the specified saved user assessment or future scheduled assessments into a different compartment.

• #compare_security_assessment(security_assessment_id, compare_security_assessment_details, opts = {}) ⇒ Response

  Compares two security assessments.

• #compare_user_assessment(user_assessment_id, compare_user_assessment_details, opts = {}) ⇒ Response

  Compares two user assessments.

• #create_audit_archive_retrieval(create_audit_archive_retrieval_details, opts = {}) ⇒ Response

  Creates a work request to retrieve archived audit data.

• #create_data_safe_private_endpoint(create_data_safe_private_endpoint_details, opts = {}) ⇒ Response

  Creates a new Data Safe private endpoint.

• #create_discovery_job(create_discovery_job_details, opts = {}) ⇒ Response

  Performs incremental data discovery for the specified sensitive data model.

• #create_library_masking_format(create_library_masking_format_details, opts = {}) ⇒ Response

  Creates a new library masking format.

• #create_masking_column(create_masking_column_details, masking_policy_id, opts = {}) ⇒ Response

  Creates a new masking column in the specified masking policy.

• #create_masking_policy(create_masking_policy_details, opts = {}) ⇒ Response

  Creates a new masking policy and associates it with a sensitive data model or a target database.

• #create_on_prem_connector(create_on_prem_connector_details, opts = {}) ⇒ Response

  Creates a new on-premises connector.

• #create_report_definition(create_report_definition_details, opts = {}) ⇒ Response

  Creates a new report definition with parameters specified in the body.

• #create_sdm_masking_policy_difference(create_sdm_masking_policy_difference_details, opts = {}) ⇒ Response

  Creates SDM masking policy difference for the specified masking policy.

• #create_security_assessment(create_security_assessment_details, opts = {}) ⇒ Response

  Creates a new saved security assessment for one or multiple targets in a compartment.

• #create_sensitive_column(sensitive_data_model_id, create_sensitive_column_details, opts = {}) ⇒ Response

  Creates a new sensitive column in the specified sensitive data model.

• #create_sensitive_data_model(create_sensitive_data_model_details, opts = {}) ⇒ Response

  Creates a new sensitive data model.

• #create_sensitive_type(create_sensitive_type_details, opts = {}) ⇒ Response

  Creates a new sensitive type, which can be a basic sensitive type with regular expressions or a sensitive category.

• #create_sql_collection(create_sql_collection_details, opts = {}) ⇒ Response

  Creates a new SQL collection resource.

• #create_target_alert_policy_association(create_target_alert_policy_association_details, opts = {}) ⇒ Response

  Creates a new target-alert policy association to track a alert policy applied on target.

• #create_target_database(create_target_database_details, opts = {}) ⇒ Response

  Registers the specified database with Data Safe and creates a Data Safe target database in the Data Safe Console.

• #create_user_assessment(create_user_assessment_details, opts = {}) ⇒ Response

  Creates a new saved user assessment for one or multiple targets in a compartment.

• #deactivate_target_database(target_database_id, opts = {}) ⇒ Response

  Deactivates a target database in Data Safe.

• #delete_audit_archive_retrieval(audit_archive_retrieval_id, opts = {}) ⇒ Response

  To unload retrieved archive data, call the operation ListAuditArchiveRetrieval first.

• #delete_audit_trail(audit_trail_id, opts = {}) ⇒ Response

  Deletes the specified audit trail.

• #delete_data_safe_private_endpoint(data_safe_private_endpoint_id, opts = {}) ⇒ Response

  Deletes the specified Data Safe private endpoint.

• #delete_discovery_job(discovery_job_id, opts = {}) ⇒ Response

  Deletes the specified discovery job.

• #delete_discovery_job_result(discovery_job_id, result_key, opts = {}) ⇒ Response

  Deletes the specified discovery result.

• #delete_library_masking_format(library_masking_format_id, opts = {}) ⇒ Response

  Deletes the specified library masking format.

• #delete_masking_column(masking_column_key, masking_policy_id, opts = {}) ⇒ Response

  Deletes the specified masking column.

• #delete_masking_policy(masking_policy_id, opts = {}) ⇒ Response

  Deletes the specified masking policy.

• #delete_on_prem_connector(on_prem_connector_id, opts = {}) ⇒ Response

  Deletes the specified on-premises connector.

• #delete_report_definition(report_definition_id, opts = {}) ⇒ Response

  Deletes the specified report definition.

• #delete_sdm_masking_policy_difference(sdm_masking_policy_difference_id, opts = {}) ⇒ Response

  Deletes the specified SDM Masking policy difference.

• #delete_security_assessment(security_assessment_id, opts = {}) ⇒ Response

  Deletes the specified saved security assessment or schedule.

• #delete_sensitive_column(sensitive_data_model_id, sensitive_column_key, opts = {}) ⇒ Response

  Deletes the specified sensitive column.

• #delete_sensitive_data_model(sensitive_data_model_id, opts = {}) ⇒ Response

  Deletes the specified sensitive data model.

• #delete_sensitive_type(sensitive_type_id, opts = {}) ⇒ Response

  Deletes the specified sensitive type.

• #delete_sql_collection(sql_collection_id, opts = {}) ⇒ Response

  Deletes the specified SQL collection.

• #delete_sql_firewall_policy(sql_firewall_policy_id, opts = {}) ⇒ Response

  Deletes the SQL firewall policy resource.

• #delete_target_alert_policy_association(target_alert_policy_association_id, opts = {}) ⇒ Response

  Deletes the specified target-alert policy Association.

• #delete_target_database(target_database_id, opts = {}) ⇒ Response

  Deregisters the specified database from Data Safe and removes the target database from the Data Safe Console.

• #delete_user_assessment(user_assessment_id, opts = {}) ⇒ Response

  Deletes the specified saved user assessment or schedule.

• #discover_audit_trails(audit_profile_id, opts = {}) ⇒ Response

  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.

• #download_discovery_report(sensitive_data_model_id, download_discovery_report_details, opts = {}, &block) ⇒ Response

  Downloads an already-generated discovery report.

• #download_masking_log(masking_policy_id, download_masking_log_details, opts = {}, &block) ⇒ Response

  Downloads the masking log generated by the last masking operation on a target database using the specified masking policy.

• #download_masking_policy(masking_policy_id, download_masking_policy_details, opts = {}, &block) ⇒ Response

  Downloads an already-generated file corresponding to the specified masking policy.

• #download_masking_report(masking_policy_id, download_masking_report_details, opts = {}, &block) ⇒ Response

  Downloads an already-generated masking report.

• #download_privilege_script(opts = {}, &block) ⇒ Response

  Downloads the privilege script to grant/revoke required roles from the Data Safe account on the target database.

• #download_security_assessment_report(security_assessment_id, download_security_assessment_report_details, opts = {}, &block) ⇒ Response

  Downloads the report of the specified security assessment.

• #download_sensitive_data_model(sensitive_data_model_id, download_sensitive_data_model_details, opts = {}, &block) ⇒ Response

  Downloads an already-generated file corresponding to the specified sensitive data model.

• #download_user_assessment_report(user_assessment_id, download_user_assessment_report_details, opts = {}, &block) ⇒ Response

  Downloads the report of the specified user assessment.

• #enable_data_safe_configuration(enable_data_safe_configuration_details, opts = {}) ⇒ Response

  Enables Data Safe in the tenancy and region.

• #generate_discovery_report_for_download(sensitive_data_model_id, generate_discovery_report_for_download_details, opts = {}) ⇒ Response

  Generates a downloadable discovery report.

• #generate_masking_policy_for_download(masking_policy_id, generate_masking_policy_for_download_details, opts = {}) ⇒ Response

  Generates a downloadable file corresponding to the specified masking policy.

• #generate_masking_report_for_download(masking_policy_id, generate_masking_report_for_download_details, opts = {}) ⇒ Response

  Generates a downloadable masking report.

• #generate_on_prem_connector_configuration(generate_on_prem_connector_configuration_details, on_prem_connector_id, opts = {}, &block) ⇒ Response

  Creates and downloads the configuration of the specified on-premises connector.

• #generate_report(report_definition_id, generate_report_details, opts = {}) ⇒ Response

  Generates a PDF or XLS report based on parameters and report definition.

• #generate_security_assessment_report(security_assessment_id, generate_security_assessment_report_details, opts = {}) ⇒ Response

  Generates the report of the specified security assessment.

• #generate_sensitive_data_model_for_download(sensitive_data_model_id, generate_sensitive_data_model_for_download_details, opts = {}) ⇒ Response

  Generates a downloadable file corresponding to the specified sensitive data model.

• #generate_sql_firewall_policy(sql_collection_id, opts = {}) ⇒ Response

  Generates or appends to the SQL firewall policy using the specified SQL collection.

• #generate_user_assessment_report(user_assessment_id, generate_user_assessment_report_details, opts = {}) ⇒ Response

  Generates the report of the specified user assessment.

• #get_alert(alert_id, opts = {}) ⇒ Response

  Gets the details of the specified alerts.

• #get_alert_policy(alert_policy_id, opts = {}) ⇒ Response

  Gets the details of alert policy by its ID.

• #get_audit_archive_retrieval(audit_archive_retrieval_id, opts = {}) ⇒ Response

  Gets the details of the specified archive retreival.

• #get_audit_policy(audit_policy_id, opts = {}) ⇒ Response

  Gets a audit policy by identifier.

• #get_audit_profile(audit_profile_id, opts = {}) ⇒ Response

  Gets the details of audit profile resource and associated audit trails of the audit profile.

• #get_audit_trail(audit_trail_id, opts = {}) ⇒ Response

  Gets the details of audit trail.

• #get_compatible_formats_for_data_types(opts = {}) ⇒ Response

  Gets a list of basic masking formats compatible with the supported data types.

• #get_compatible_formats_for_sensitive_types(compartment_id, opts = {}) ⇒ Response

  Gets a list of library masking formats compatible with the existing sensitive types.

• #get_data_safe_configuration(opts = {}) ⇒ Response

  Gets the details of the Data Safe configuration.

• #get_data_safe_private_endpoint(data_safe_private_endpoint_id, opts = {}) ⇒ Response

  Gets the details of the specified Data Safe private endpoint.

• #get_database_security_config(database_security_config_id, opts = {}) ⇒ Response

  Gets a database security configuration by identifier.

• #get_difference_column(sdm_masking_policy_difference_id, difference_column_key, opts = {}) ⇒ Response

  Gets the details of the specified SDM Masking policy difference column.

• #get_discovery_job(discovery_job_id, opts = {}) ⇒ Response

  Gets the details of the specified discovery job.

• #get_discovery_job_result(discovery_job_id, result_key, opts = {}) ⇒ Response

  Gets the details of the specified discovery result.

• #get_library_masking_format(library_masking_format_id, opts = {}) ⇒ Response

  Gets the details of the specified library masking format.

• #get_masking_column(masking_policy_id, masking_column_key, opts = {}) ⇒ Response

  Gets the details of the specified masking column.

• #get_masking_policy(masking_policy_id, opts = {}) ⇒ Response

  Gets the details of the specified masking policy.

• #get_masking_report(masking_report_id, opts = {}) ⇒ Response

  Gets the details of the specified masking report.

• #get_on_prem_connector(on_prem_connector_id, opts = {}) ⇒ Response

  Gets the details of the specified on-premises connector.

• #get_profile(user_assessment_id, profile_name, opts = {}) ⇒ Response

  Lists the details of given profile available on the target.

• #get_report(report_id, opts = {}) ⇒ Response

  Gets a report by identifier.

• #get_report_content(report_id, opts = {}, &block) ⇒ Response

  Downloads the specified report in the form of PDF or XLXS.

• #get_report_definition(report_definition_id, opts = {}) ⇒ Response

  Gets the details of report definition specified by the identifier.

• #get_sdm_masking_policy_difference(sdm_masking_policy_difference_id, opts = {}) ⇒ Response

  Gets the details of the specified SDM Masking policy difference.

• #get_security_assessment(security_assessment_id, opts = {}) ⇒ Response

  Gets the details of the specified security assessment.

• #get_security_assessment_comparison(security_assessment_id, comparison_security_assessment_id, opts = {}) ⇒ Response

  Gets the details of the comparison report for the security assessments submitted for comparison.

• #get_security_policy(security_policy_id, opts = {}) ⇒ Response

  Gets a security policy by the specified OCID of the security policy resource.

• #get_security_policy_deployment(security_policy_deployment_id, opts = {}) ⇒ Response

  Gets a security policy deployment by identifier.

• #get_security_policy_entry_state(security_policy_deployment_id, security_policy_entry_state_id, opts = {}) ⇒ Response

  Gets a security policy entity states by identifier.

• #get_sensitive_column(sensitive_data_model_id, sensitive_column_key, opts = {}) ⇒ Response

  Gets the details of the specified sensitive column.

• #get_sensitive_data_model(sensitive_data_model_id, opts = {}) ⇒ Response

  Gets the details of the specified sensitive data model.

• #get_sensitive_type(sensitive_type_id, opts = {}) ⇒ Response

  Gets the details of the specified sensitive type.

• #get_sql_collection(sql_collection_id, opts = {}) ⇒ Response

  Gets a SQL collection by identifier.

• #get_sql_firewall_policy(sql_firewall_policy_id, opts = {}) ⇒ Response

  Gets a SQL firewall policy by identifier.

• #get_target_alert_policy_association(target_alert_policy_association_id, opts = {}) ⇒ Response

  Gets the details of target-alert policy association by its ID.

• #get_target_database(target_database_id, opts = {}) ⇒ Response

  Returns the details of the specified Data Safe target database.

• #get_user_assessment(user_assessment_id, opts = {}) ⇒ Response

  Gets a user assessment by identifier.

• #get_user_assessment_comparison(user_assessment_id, comparison_user_assessment_id, opts = {}) ⇒ Response

  Gets the details of the comparison report for the user assessments submitted for comparison.

• #get_work_request(work_request_id, opts = {}) ⇒ Response

  Gets the details of the specified work request.

• #initialize(config: nil, region: nil, endpoint: nil, signer: nil, proxy_settings: nil, retry_config: nil) ⇒ DataSafeClient constructor

  Creates a new DataSafeClient.

• #list_alert_analytics(compartment_id, opts = {}) ⇒ Response

  Returns the aggregation details of the alerts.

• #list_alert_policies(compartment_id, opts = {}) ⇒ Response

  Gets a list of all alert policies.

• #list_alert_policy_rules(alert_policy_id, opts = {}) ⇒ Response

  Lists the rules of the specified alert policy.

• #list_alerts(compartment_id, opts = {}) ⇒ Response

  Gets a list of all alerts.

• #list_audit_archive_retrievals(compartment_id, opts = {}) ⇒ Response

  Returns the list of audit archive retrieval.

• #list_audit_event_analytics(compartment_id, opts = {}) ⇒ Response

  By default the ListAuditEventAnalytics operation will return all of the summary columns.

• #list_audit_events(compartment_id, opts = {}) ⇒ Response

  The ListAuditEvents operation returns specified compartmentId audit Events only.

• #list_audit_policies(compartment_id, opts = {}) ⇒ Response

  Retrieves a list of all audited targets with their corresponding provisioned audit policies, and their provisioning conditions.

• #list_audit_policy_analytics(compartment_id, opts = {}) ⇒ Response

  Gets a list of aggregated audit policy details on the target databases.

• #list_audit_profile_analytics(compartment_id, opts = {}) ⇒ Response

  Gets a list of audit profile aggregated details .

• #list_audit_profiles(compartment_id, opts = {}) ⇒ Response

  Gets a list of all audit profiles.

• #list_audit_trail_analytics(compartment_id, opts = {}) ⇒ Response

  Gets a list of audit trail aggregated details .

• #list_audit_trails(compartment_id, opts = {}) ⇒ Response

  Gets a list of all audit trails.

• #list_available_audit_volumes(audit_profile_id, work_request_id, opts = {}) ⇒ Response

  Retrieves a list of audit trails, and associated audit event volume for each trail up to defined start date.

• #list_collected_audit_volumes(audit_profile_id, work_request_id, opts = {}) ⇒ Response

  Gets a list of all collected audit volume data points.

• #list_columns(target_database_id, opts = {}) ⇒ Response

  Returns a list of column metadata objects.

• #list_data_safe_private_endpoints(compartment_id, opts = {}) ⇒ Response

  Gets a list of Data Safe private endpoints.

• #list_database_security_configs(compartment_id, opts = {}) ⇒ Response

  Retrieves a list of all database security configurations in Data Safe.

• #list_difference_columns(sdm_masking_policy_difference_id, opts = {}) ⇒ Response

  Gets a list of columns of a SDM masking policy difference resource based on the specified query parameters.

• #list_discovery_analytics(compartment_id, opts = {}) ⇒ Response

  Gets consolidated discovery analytics data based on the specified query parameters.

• #list_discovery_job_results(discovery_job_id, opts = {}) ⇒ Response

  Gets a list of discovery results based on the specified query parameters.

• #list_discovery_jobs(compartment_id, opts = {}) ⇒ Response

  Gets a list of incremental discovery jobs based on the specified query parameters.

• #list_findings(security_assessment_id, opts = {}) ⇒ Response

  List all the findings from all the targets in the specified compartment.

• #list_grants(user_assessment_id, user_key, opts = {}) ⇒ Response

  Gets a list of grants for a particular user in the specified user assessment.

• #list_library_masking_formats(compartment_id, opts = {}) ⇒ Response

  Gets a list of library masking formats based on the specified query parameters.

• #list_masked_columns(masking_report_id, opts = {}) ⇒ Response

  Gets a list of masked columns present in the specified masking report and based on the specified query parameters.

• #list_masking_analytics(compartment_id, opts = {}) ⇒ Response

  Gets consolidated masking analytics data based on the specified query parameters.

• #list_masking_columns(masking_policy_id, opts = {}) ⇒ Response

  Gets a list of masking columns present in the specified masking policy and based on the specified query parameters.

• #list_masking_objects(masking_policy_id, opts = {}) ⇒ Response

  Gets a list of masking objects present in the specified masking policy and based on the specified query parameters.

• #list_masking_policies(compartment_id, opts = {}) ⇒ Response

  Gets a list of masking policies based on the specified query parameters.

• #list_masking_reports(compartment_id, opts = {}) ⇒ Response

  Gets a list of masking reports based on the specified query parameters.

• #list_masking_schemas(masking_policy_id, opts = {}) ⇒ Response

  Gets a list of masking schemas present in the specified masking policy and based on the specified query parameters.

• #list_on_prem_connectors(compartment_id, opts = {}) ⇒ Response

  Gets a list of on-premises connectors.

• #list_profile_analytics(user_assessment_id, compartment_id, opts = {}) ⇒ Response

  Gets a list of aggregated user profile details in the specified compartment.

• #list_profile_summaries(user_assessment_id, compartment_id, opts = {}) ⇒ Response

  Gets a list of user profiles containing the profile details along with the target id and user counts.

• #list_report_definitions(compartment_id, opts = {}) ⇒ Response

  Gets a list of report definitions.

• #list_reports(compartment_id, opts = {}) ⇒ Response

  Gets a list of all the reports in the compartment.

• #list_roles(target_database_id, opts = {}) ⇒ Response

  Returns a list of role metadata objects.

• #list_schemas(target_database_id, opts = {}) ⇒ Response

  Returns list of schema.

• #list_sdm_masking_policy_differences(compartment_id, opts = {}) ⇒ Response

  Gets a list of SDM and masking policy difference resources based on the specified query parameters.

• #list_security_assessments(compartment_id, opts = {}) ⇒ Response

  Gets a list of security assessments.

• #list_security_policies(compartment_id, opts = {}) ⇒ Response

  Retrieves a list of all security policies in Data Safe.

• #list_security_policy_deployments(compartment_id, opts = {}) ⇒ Response

  Retrieves a list of all security policy deployments in Data Safe.

• #list_security_policy_entry_states(security_policy_deployment_id, opts = {}) ⇒ Response

  Retrieves a list of all security policy entry states in Data Safe.

• #list_sensitive_columns(sensitive_data_model_id, opts = {}) ⇒ Response

  Gets a list of sensitive columns present in the specified sensitive data model based on the specified query parameters.

• #list_sensitive_data_models(compartment_id, opts = {}) ⇒ Response

  Gets a list of sensitive data models based on the specified query parameters.

• #list_sensitive_objects(sensitive_data_model_id, opts = {}) ⇒ Response

  Gets a list of sensitive objects present in the specified sensitive data model based on the specified query parameters.

• #list_sensitive_schemas(sensitive_data_model_id, opts = {}) ⇒ Response

  Gets a list of sensitive schemas present in the specified sensitive data model based on the specified query parameters.

• #list_sensitive_types(compartment_id, opts = {}) ⇒ Response

  Gets a list of sensitive types based on the specified query parameters.

• #list_sql_collection_analytics(compartment_id, opts = {}) ⇒ Response

  Retrieves a list of all SQL collection analytics in Data Safe.

• #list_sql_collection_log_insights(time_started, time_ended, sql_collection_id, opts = {}) ⇒ Response

  Retrieves a list of the SQL collection log analytics.

• #list_sql_collections(compartment_id, opts = {}) ⇒ Response

  Retrieves a list of all SQL collections in Data Safe.

• #list_sql_firewall_allowed_sql_analytics(compartment_id, opts = {}) ⇒ Response

  Returns the aggregation details of all SQL firewall allowed SQL statements.

• #list_sql_firewall_allowed_sqls(compartment_id, opts = {}) ⇒ Response

  Retrieves a list of all SQL firewall allowed SQL statements.

• #list_sql_firewall_policies(compartment_id, opts = {}) ⇒ Response

  Retrieves a list of all SQL firewall policies.

• #list_sql_firewall_policy_analytics(compartment_id, opts = {}) ⇒ Response

  Gets a list of aggregated SQL firewall policy details.

• #list_sql_firewall_violation_analytics(compartment_id, opts = {}) ⇒ Response

  Returns the aggregation details of the SQL firewall violations.

• #list_sql_firewall_violations(compartment_id, opts = {}) ⇒ Response

  Gets a list of all the SQL firewall violations captured by the firewall.

• #list_tables(target_database_id, opts = {}) ⇒ Response

  Returns a list of table metadata objects.

• #list_target_alert_policy_associations(compartment_id, opts = {}) ⇒ Response

  Gets a list of all target-alert policy associations.

• #list_target_databases(compartment_id, opts = {}) ⇒ Response

  Returns the list of registered target databases in Data Safe.

• #list_user_analytics(user_assessment_id, opts = {}) ⇒ Response

  Gets a list of aggregated user details from the specified user assessment.

• #list_user_assessments(compartment_id, opts = {}) ⇒ Response

  Gets a list of user assessments.

• #list_users(user_assessment_id, opts = {}) ⇒ Response

  Gets a list of users of the specified user assessment.

• #list_work_request_errors(work_request_id, opts = {}) ⇒ Response

  Gets a list of errors for the specified work request.

• #list_work_request_logs(work_request_id, opts = {}) ⇒ Response

  Gets a list of log entries for the specified work request.

• #list_work_requests(compartment_id, opts = {}) ⇒ Response

  Gets a list of work requests.

• #logger ⇒ Logger

  The logger for this client.

• #mask_data(masking_policy_id, mask_data_details, opts = {}) ⇒ Response

  Masks data using the specified masking policy.

• #modify_global_settings(modify_global_settings_details, compartment_id, opts = {}) ⇒ Response

  Modifies Global Settings in Data Safe in the tenancy and region.

• #patch_alerts(patch_alerts_details, opts = {}) ⇒ Response

  Updates the status of one or more alert specified by the alert IDs.

• #patch_discovery_job_results(discovery_job_id, patch_discovery_job_result_details, opts = {}) ⇒ Response

  Patches one or more discovery results.

• #patch_masking_columns(masking_policy_id, patch_masking_columns_details, opts = {}) ⇒ Response

  Patches one or more columns in the specified masking policy.

• #patch_sdm_masking_policy_difference_columns(sdm_masking_policy_difference_id, patch_sdm_masking_policy_difference_columns_details, opts = {}) ⇒ Response

  Patches one or more SDM masking policy difference columns.

• #patch_sensitive_columns(sensitive_data_model_id, patch_sensitive_column_details, opts = {}) ⇒ Response

  Patches one or more columns in the specified sensitive data model.

• #patch_target_alert_policy_association(patch_target_alert_policy_association_details, opts = {}) ⇒ Response

  Creates new target-alert policy associations that will be applied on the target database.

• #provision_audit_policy(provision_audit_policy_details, audit_policy_id, opts = {}) ⇒ Response

  Provision audit policy.

• #purge_sql_collection_logs(sql_collection_id, opts = {}) ⇒ Response

  Purge the SQL collection logs for the specified SqlCollection.

• #refresh_database_security_configuration(database_security_config_id, opts = {}) ⇒ Response

  Refreshes the specified database security configuration.

• #refresh_security_assessment(security_assessment_id, run_security_assessment_details, opts = {}) ⇒ Response

  Runs a security assessment, refreshes the latest assessment, and saves it for future reference.

• #refresh_sql_collection_log_insights(sql_collection_id, opts = {}) ⇒ Response

  Refresh the specified SQL collection Log Insights.

• #refresh_user_assessment(user_assessment_id, run_user_assessment_details, opts = {}) ⇒ Response

  Refreshes the latest assessment and saves it for future reference.

• #remove_schedule_report(report_definition_id, opts = {}) ⇒ Response

  Deletes the schedule of a PDF or XLS report.

• #resume_audit_trail(audit_trail_id, opts = {}) ⇒ Response

  Resumes the specified audit trail once it got stopped.

• #resume_work_request(work_request_id, opts = {}) ⇒ Response

  Resume the given work request.

• #retrieve_audit_policies(audit_policy_id, opts = {}) ⇒ Response

  Retrieves the audit policy details from the source target database.

• #schedule_report(report_definition_id, schedule_report_details, opts = {}) ⇒ Response

  Schedules a PDF or XLS report based on parameters and report definition.

• #set_security_assessment_baseline(security_assessment_id, opts = {}) ⇒ Response

  Sets the saved security assessment as the baseline in the compartment where the the specified assessment resides.

• #set_user_assessment_baseline(user_assessment_id, opts = {}) ⇒ Response

  Sets the saved user assessment as the baseline in the compartment where the specified assessment resides.

• #start_audit_trail(start_audit_trail_details, audit_trail_id, opts = {}) ⇒ Response

  Starts collection of audit records on the specified audit trail.

• #start_sql_collection(sql_collection_id, opts = {}) ⇒ Response

  Start the specified SQL collection.

• #stop_audit_trail(audit_trail_id, opts = {}) ⇒ Response

  Stops the specified audit trail.

• #stop_sql_collection(sql_collection_id, opts = {}) ⇒ Response

  Stops the specified SQL collection.

• #suspend_work_request(work_request_id, opts = {}) ⇒ Response

  Suspend the given work request.

• #unset_security_assessment_baseline(security_assessment_id, opts = {}) ⇒ Response

  Removes the baseline setting for the saved security assessment.

• #unset_user_assessment_baseline(user_assessment_id, opts = {}) ⇒ Response

  Removes the baseline setting for the saved user assessment.

• #update_alert(alert_id, update_alert_details, opts = {}) ⇒ Response

  Updates the status of the specified alert.

• #update_audit_archive_retrieval(audit_archive_retrieval_id, update_audit_archive_retrieval_details, opts = {}) ⇒ Response

  Updates the audit archive retrieval.

• #update_audit_policy(audit_policy_id, update_audit_policy_details, opts = {}) ⇒ Response

  Updates the audit policy.

• #update_audit_profile(audit_profile_id, update_audit_profile_details, opts = {}) ⇒ Response

  Updates one or more attributes of the specified audit profile.

• #update_audit_trail(audit_trail_id, update_audit_trail_details, opts = {}) ⇒ Response

  Updates one or more attributes of the specified audit trail.

• #update_data_safe_private_endpoint(data_safe_private_endpoint_id, update_data_safe_private_endpoint_details, opts = {}) ⇒ Response

  Updates one or more attributes of the specified Data Safe private endpoint.

• #update_database_security_config(database_security_config_id, update_database_security_config_details, opts = {}) ⇒ Response

  Updates the database security configuration.

• #update_library_masking_format(library_masking_format_id, update_library_masking_format_details, opts = {}) ⇒ Response

  Updates one or more attributes of the specified library masking format.

• #update_masking_column(masking_column_key, masking_policy_id, update_masking_column_details, opts = {}) ⇒ Response

  Updates one or more attributes of the specified masking column.

• #update_masking_policy(masking_policy_id, update_masking_policy_details, opts = {}) ⇒ Response

  Updates one or more attributes of the specified masking policy.

• #update_on_prem_connector(on_prem_connector_id, update_on_prem_connector_details, opts = {}) ⇒ Response

  Updates one or more attributes of the specified on-premises connector.

• #update_on_prem_connector_wallet(update_on_prem_connector_wallet_details, on_prem_connector_id, opts = {}) ⇒ Response

  Updates the wallet for the specified on-premises connector to a new version.

• #update_report_definition(report_definition_id, update_report_definition_details, opts = {}) ⇒ Response

  Updates the specified report definition.

• #update_sdm_masking_policy_difference(sdm_masking_policy_difference_id, update_sdm_masking_policy_difference_details, opts = {}) ⇒ Response

  Updates one or more attributes of the specified sdm masking policy difference.

• #update_security_assessment(security_assessment_id, update_security_assessment_details, opts = {}) ⇒ Response

  Updates one or more attributes of the specified security assessment.

• #update_security_policy(security_policy_id, update_security_policy_details, opts = {}) ⇒ Response

  Updates the security policy.

• #update_security_policy_deployment(security_policy_deployment_id, update_security_policy_deployment_details, opts = {}) ⇒ Response

  Updates the security policy deployment.

• #update_sensitive_column(sensitive_data_model_id, sensitive_column_key, update_sensitive_column_details, opts = {}) ⇒ Response

  Updates one or more attributes of the specified sensitive column.

• #update_sensitive_data_model(sensitive_data_model_id, update_sensitive_data_model_details, opts = {}) ⇒ Response

  Updates one or more attributes of the specified sensitive data model.

• #update_sensitive_type(sensitive_type_id, update_sensitive_type_details, opts = {}) ⇒ Response

  Updates one or more attributes of the specified sensitive type.

• #update_sql_collection(sql_collection_id, update_sql_collection_details, opts = {}) ⇒ Response

  Updates the SQL collection.

• #update_sql_firewall_policy(sql_firewall_policy_id, update_sql_firewall_policy_details, opts = {}) ⇒ Response

  Updates the SQL firewall policy.

• #update_target_alert_policy_association(target_alert_policy_association_id, update_target_alert_policy_association_details, opts = {}) ⇒ Response

  Updates the specified target-alert policy association.

• #update_target_database(target_database_id, update_target_database_details, opts = {}) ⇒ Response

  Updates one or more attributes of the specified Data Safe target database.

• #update_user_assessment(user_assessment_id, update_user_assessment_details, opts = {}) ⇒ Response

  Updates one or more attributes of the specified user assessment.

• #upload_masking_policy(upload_masking_policy_details, masking_policy_id, opts = {}) ⇒ Response

  Uploads a masking policy file (also called template) to update the specified masking policy.

• #upload_sensitive_data_model(sensitive_data_model_id, upload_sensitive_data_model_details, opts = {}) ⇒ Response

  Uploads a sensitive data model file (also called template) to update the specified sensitive data model.

Constructor Details

#initialize(config: nil, region: nil, endpoint: nil, signer: nil, proxy_settings: nil, retry_config: nil) ⇒ DataSafeClient

Creates a new DataSafeClient. Notes: If a config is not specified, then the global OCI.config will be used.

This client is not thread-safe

Either a region or an endpoint must be specified. If an endpoint is specified, it will be used instead of the region. A region may be specified in the config or via or the region parameter. If specified in both, then the region parameter will be used.

Parameters:

• config (Config) (defaults to: nil) —

  A Config object.

• region (String) (defaults to: nil) —

  A region used to determine the service endpoint. This will usually correspond to a value in Regions::REGION_ENUM, but may be an arbitrary string.

• endpoint (String) (defaults to: nil) —

  The fully qualified endpoint URL

• signer (OCI::BaseSigner) (defaults to: nil) —

  A signer implementation which can be used by this client. If this is not provided then a signer will be constructed via the provided config. One use case of this parameter is instance principals authentication, so that the instance principals signer can be provided to the client

• proxy_settings (OCI::ApiClientProxySettings) (defaults to: nil) —

  If your environment requires you to use a proxy server for outgoing HTTP requests the details for the proxy can be provided in this parameter

• retry_config (OCI::Retry::RetryConfig) (defaults to: nil) —

  The retry configuration for this service client. This represents the default retry configuration to apply across all operations. This can be overridden on a per-operation basis. The default retry configuration value is nil, which means that an operation will not perform any retries

# File 'lib/oci/data_safe/data_safe_client.rb', line 55

def initialize(config: nil, region: nil, endpoint: nil, signer: nil, proxy_settings: nil, retry_config: nil)
  # If the signer is an InstancePrincipalsSecurityTokenSigner or SecurityTokenSigner and no config was supplied (they are self-sufficient signers)
  # then create a dummy config to pass to the ApiClient constructor. If customers wish to create a client which uses instance principals
  # and has config (either populated programmatically or loaded from a file), they must construct that config themselves and then
  # pass it to this constructor.
  #
  # If there is no signer (or the signer is not an instance principals signer) and no config was supplied, this is not valid
  # so try and load the config from the default file.
  config = OCI::Config.validate_and_build_config_with_signer(config, signer)

  signer = OCI::Signer.config_file_auth_builder(config) if signer.nil?

  @api_client = OCI::ApiClient.new(config, signer, proxy_settings: proxy_settings)
  @retry_config = retry_config

  if endpoint
    @endpoint = endpoint + '/20181201'
  else
    region ||= config.region
    region ||= signer.region if signer.respond_to?(:region)
    self.region = region
  end
  logger.info "DataSafeClient endpoint set to '#{@endpoint}'." if logger
end

Instance Attribute Details

#api_client ⇒ OCI::ApiClient (readonly)

Client used to make HTTP requests.

Returns:

• (OCI::ApiClient)

# File 'lib/oci/data_safe/data_safe_client.rb', line 15

def api_client
  @api_client
end

#endpoint ⇒ String (readonly)

Fully qualified endpoint URL

Returns:

• (String)

# File 'lib/oci/data_safe/data_safe_client.rb', line 19

def endpoint
  @endpoint
end

#region ⇒ String

The region, which will usually correspond to a value in Regions::REGION_ENUM.

Returns:

• (String)

# File 'lib/oci/data_safe/data_safe_client.rb', line 29

def region
  @region
end

#retry_config ⇒ OCI::Retry::RetryConfig (readonly)

The default retry configuration to apply to all operations in this service client. This can be overridden on a per-operation basis. The default retry configuration value is nil, which means that an operation will not perform any retries

Returns:

• (OCI::Retry::RetryConfig)

# File 'lib/oci/data_safe/data_safe_client.rb', line 25

def retry_config
  @retry_config
end

Instance Method Details

#activate_target_database(activate_target_database_details, target_database_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use activate_target_database API.

Reactivates a previously deactivated Data Safe target database.

Parameters:

• activate_target_database_details (OCI::DataSafe::Models::ActivateTargetDatabaseDetails) —

  The details used to reactivate a target database in Data Safe.

• target_database_id (String) —

  The OCID of the Data Safe target database.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :opc_retry_token (String) —

  A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

• :if_match (String) —

  For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

• :opc_request_id (String) —

  Unique identifier for the request.

Returns:

• (Response) —

  A Response object with data of type nil

# File 'lib/oci/data_safe/data_safe_client.rb', line 124

def activate_target_database(activate_target_database_details, target_database_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#activate_target_database.' if logger

  raise "Missing the required parameter 'activate_target_database_details' when calling activate_target_database." if activate_target_database_details.nil?
  raise "Missing the required parameter 'target_database_id' when calling activate_target_database." if target_database_id.nil?
  raise "Parameter value for 'target_database_id' must not be blank" if OCI::Internal::Util.blank_string?(target_database_id)

  path = '/targetDatabases/{targetDatabaseId}/actions/activate'.sub('{targetDatabaseId}', target_database_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(activate_target_database_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#activate_target_database') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#add_masking_columns_from_sdm(masking_policy_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use add_masking_columns_from_sdm API.

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.

Parameters:

• masking_policy_id (String) —

  The OCID of the masking policy.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :if_match (String) —

  For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

• :opc_request_id (String) —

  Unique identifier for the request.

Returns:

• (Response) —

  A Response object with data of type nil

# File 'lib/oci/data_safe/data_safe_client.rb', line 191

def add_masking_columns_from_sdm(masking_policy_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#add_masking_columns_from_sdm.' if logger

  raise "Missing the required parameter 'masking_policy_id' when calling add_masking_columns_from_sdm." if masking_policy_id.nil?
  raise "Parameter value for 'masking_policy_id' must not be blank" if OCI::Internal::Util.blank_string?(masking_policy_id)

  path = '/maskingPolicies/{maskingPolicyId}/actions/addMaskingColumnsFromSdm'.sub('{maskingPolicyId}', masking_policy_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#add_masking_columns_from_sdm') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#alerts_update(alerts_update_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use alerts_update API.

Updates alerts in the specified compartment.

Parameters:

• alerts_update_details (OCI::DataSafe::Models::AlertsUpdateDetails) —

  The details to update the alerts in the specified compartment.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :opc_request_id (String) —

  Unique identifier for the request.

• :if_match (String) —

  For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

• :opc_retry_token (String) —

  A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

• :compartment_id_in_subtree (BOOLEAN) —

  Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting. (default to false)

• :access_level (String) —

  Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed. (default to RESTRICTED) Allowed values are: RESTRICTED, ACCESSIBLE

Returns:

• (Response) —

  A Response object with data of type nil

# File 'lib/oci/data_safe/data_safe_client.rb', line 265

def alerts_update(alerts_update_details, opts = {})
  logger.debug 'Calling operation DataSafeClient#alerts_update.' if logger

  raise "Missing the required parameter 'alerts_update_details' when calling alerts_update." if alerts_update_details.nil?

  if opts[:access_level] && !%w[RESTRICTED ACCESSIBLE].include?(opts[:access_level])
    raise 'Invalid value for "access_level", must be one of RESTRICTED, ACCESSIBLE.'
  end

  path = '/alerts/actions/updateAll'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentIdInSubtree] = opts[:compartment_id_in_subtree] if !opts[:compartment_id_in_subtree].nil?
  query_params[:accessLevel] = opts[:access_level] if opts[:access_level]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(alerts_update_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#alerts_update') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#apply_discovery_job_results(sensitive_data_model_id, apply_discovery_job_results_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use apply_discovery_job_results API.

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.

Parameters:

• sensitive_data_model_id (String) —

  The OCID of the sensitive data model.

• apply_discovery_job_results_details (OCI::DataSafe::Models::ApplyDiscoveryJobResultsDetails) —

  Details to apply the discovery results to a sensitive data model.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :if_match (String) —

  For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

• :opc_request_id (String) —

  Unique identifier for the request.

Returns:

• (Response) —

  A Response object with data of type nil

# File 'lib/oci/data_safe/data_safe_client.rb', line 337

def apply_discovery_job_results(sensitive_data_model_id, apply_discovery_job_results_details, opts = {})
  logger.debug 'Calling operation DataSafeClient#apply_discovery_job_results.' if logger

  raise "Missing the required parameter 'sensitive_data_model_id' when calling apply_discovery_job_results." if sensitive_data_model_id.nil?
  raise "Missing the required parameter 'apply_discovery_job_results_details' when calling apply_discovery_job_results." if apply_discovery_job_results_details.nil?
  raise "Parameter value for 'sensitive_data_model_id' must not be blank" if OCI::Internal::Util.blank_string?(sensitive_data_model_id)

  path = '/sensitiveDataModels/{sensitiveDataModelId}/sensitiveColumns/actions/applyDiscoveryJobResults'.sub('{sensitiveDataModelId}', sensitive_data_model_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(apply_discovery_job_results_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#apply_discovery_job_results') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#apply_sdm_masking_policy_difference(masking_policy_id, apply_sdm_masking_policy_difference_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use apply_sdm_masking_policy_difference API.

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.

Parameters:

• masking_policy_id (String) —

  The OCID of the masking policy.

• apply_sdm_masking_policy_difference_details (OCI::DataSafe::Models::ApplySdmMaskingPolicyDifferenceDetails) —

  Details to apply the SDM Masking policy difference columns to a masking policy.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :if_match (String) —

  For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

• :opc_request_id (String) —

  Unique identifier for the request.

• :opc_retry_token (String) —

  A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

Returns:

• (Response) —

  A Response object with data of type nil

# File 'lib/oci/data_safe/data_safe_client.rb', line 410

def apply_sdm_masking_policy_difference(masking_policy_id, apply_sdm_masking_policy_difference_details, opts = {})
  logger.debug 'Calling operation DataSafeClient#apply_sdm_masking_policy_difference.' if logger

  raise "Missing the required parameter 'masking_policy_id' when calling apply_sdm_masking_policy_difference." if masking_policy_id.nil?
  raise "Missing the required parameter 'apply_sdm_masking_policy_difference_details' when calling apply_sdm_masking_policy_difference." if apply_sdm_masking_policy_difference_details.nil?
  raise "Parameter value for 'masking_policy_id' must not be blank" if OCI::Internal::Util.blank_string?(masking_policy_id)

  path = '/maskingPolicies/{maskingPolicyId}/maskingColumns/actions/applyDifferenceToMaskingColumns'.sub('{maskingPolicyId}', masking_policy_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(apply_sdm_masking_policy_difference_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#apply_sdm_masking_policy_difference') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#calculate_audit_volume_available(audit_profile_id, calculate_audit_volume_available_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use calculate_audit_volume_available API.

Calculates the volume of audit events available on the target database to be collected. Measurable up to the defined retention period of the audit target resource.

Parameters:

• audit_profile_id (String) —

  The OCID of the audit.

• calculate_audit_volume_available_details (OCI::DataSafe::Models::CalculateAuditVolumeAvailableDetails) —

  Details for the calculation of audit volume available on target database.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :if_match (String) —

  For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

• :opc_retry_token (String) —

  A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

• :opc_request_id (String) —

  Unique identifier for the request.

Returns:

• (Response) —

  A Response object with data of type nil

# File 'lib/oci/data_safe/data_safe_client.rb', line 479

def calculate_audit_volume_available(audit_profile_id, calculate_audit_volume_available_details, opts = {})
  logger.debug 'Calling operation DataSafeClient#calculate_audit_volume_available.' if logger

  raise "Missing the required parameter 'audit_profile_id' when calling calculate_audit_volume_available." if audit_profile_id.nil?
  raise "Missing the required parameter 'calculate_audit_volume_available_details' when calling calculate_audit_volume_available." if calculate_audit_volume_available_details.nil?
  raise "Parameter value for 'audit_profile_id' must not be blank" if OCI::Internal::Util.blank_string?(audit_profile_id)

  path = '/auditProfiles/{auditProfileId}/actions/calculateAuditVolumeAvailable'.sub('{auditProfileId}', audit_profile_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(calculate_audit_volume_available_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#calculate_audit_volume_available') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#calculate_audit_volume_collected(audit_profile_id, calculate_audit_volume_collected_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use calculate_audit_volume_collected API.

Calculates the volume of audit events collected by data safe.

Parameters:

• audit_profile_id (String) —

  The OCID of the audit.

• calculate_audit_volume_collected_details (OCI::DataSafe::Models::CalculateAuditVolumeCollectedDetails) —

  Details for the calculation of audit volume collected by data safe.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :if_match (String) —

  For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

• :opc_retry_token (String) —

  A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

• :opc_request_id (String) —

  Unique identifier for the request.

Returns:

• (Response) —

  A Response object with data of type nil

# File 'lib/oci/data_safe/data_safe_client.rb', line 548

def calculate_audit_volume_collected(audit_profile_id, calculate_audit_volume_collected_details, opts = {})
  logger.debug 'Calling operation DataSafeClient#calculate_audit_volume_collected.' if logger

  raise "Missing the required parameter 'audit_profile_id' when calling calculate_audit_volume_collected." if audit_profile_id.nil?
  raise "Missing the required parameter 'calculate_audit_volume_collected_details' when calling calculate_audit_volume_collected." if calculate_audit_volume_collected_details.nil?
  raise "Parameter value for 'audit_profile_id' must not be blank" if OCI::Internal::Util.blank_string?(audit_profile_id)

  path = '/auditProfiles/{auditProfileId}/actions/calculateAuditVolumeCollected'.sub('{auditProfileId}', audit_profile_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(calculate_audit_volume_collected_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#calculate_audit_volume_collected') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#cancel_work_request(work_request_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use cancel_work_request API.

Cancel the specified work request.

Parameters:

• work_request_id (String) —

  The OCID of the work request.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :opc_retry_token (String) —

  A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

• :opc_request_id (String) —

  Unique identifier for the request.

• :if_match (String) —

  For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

Returns:

• (Response) —

  A Response object with data of type nil

# File 'lib/oci/data_safe/data_safe_client.rb', line 617

def cancel_work_request(work_request_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#cancel_work_request.' if logger

  raise "Missing the required parameter 'work_request_id' when calling cancel_work_request." if work_request_id.nil?
  raise "Parameter value for 'work_request_id' must not be blank" if OCI::Internal::Util.blank_string?(work_request_id)

  path = '/workRequests/{workRequestId}'.sub('{workRequestId}', work_request_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#cancel_work_request') do
    @api_client.call_api(
      :DELETE,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#change_alert_compartment(alert_id, change_alert_compartment_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use change_alert_compartment API.

Moves the specified alert into a different compartment.

Parameters:

• alert_id (String) —

  The OCID of alert.

• change_alert_compartment_details (OCI::DataSafe::Models::ChangeAlertCompartmentDetails) —

  The details used to change the compartment of an alert.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :opc_request_id (String) —

  Unique identifier for the request.

• :if_match (String) —

  For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

• :opc_retry_token (String) —

  A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

Returns:

• (Response) —

  A Response object with data of type nil

# File 'lib/oci/data_safe/data_safe_client.rb', line 685

def change_alert_compartment(alert_id, change_alert_compartment_details, opts = {})
  logger.debug 'Calling operation DataSafeClient#change_alert_compartment.' if logger

  raise "Missing the required parameter 'alert_id' when calling change_alert_compartment." if alert_id.nil?
  raise "Missing the required parameter 'change_alert_compartment_details' when calling change_alert_compartment." if change_alert_compartment_details.nil?
  raise "Parameter value for 'alert_id' must not be blank" if OCI::Internal::Util.blank_string?(alert_id)

  path = '/alerts/{alertId}/actions/changeCompartment'.sub('{alertId}', alert_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(change_alert_compartment_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#change_alert_compartment') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#change_audit_archive_retrieval_compartment(audit_archive_retrieval_id, change_audit_archive_retrieval_compartment_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use change_audit_archive_retrieval_compartment API.

Moves the archive retreival to the specified compartment. When provided, if-Match is checked against ETag value of the resource.

Parameters:

• audit_archive_retrieval_id (String) —

  OCID of the archive retrieval.

• change_audit_archive_retrieval_compartment_details (OCI::DataSafe::Models::ChangeAuditArchiveRetrievalCompartmentDetails) —

  The details used to change the compartment of a archive retrieval.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :if_match (String) —

  For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

• :opc_request_id (String) —

  Unique identifier for the request.

• :opc_retry_token (String) —

  A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

Returns:

• (Response) —

  A Response object with data of type nil

# File 'lib/oci/data_safe/data_safe_client.rb', line 755

def change_audit_archive_retrieval_compartment(audit_archive_retrieval_id, change_audit_archive_retrieval_compartment_details, opts = {})
  logger.debug 'Calling operation DataSafeClient#change_audit_archive_retrieval_compartment.' if logger

  raise "Missing the required parameter 'audit_archive_retrieval_id' when calling change_audit_archive_retrieval_compartment." if audit_archive_retrieval_id.nil?
  raise "Missing the required parameter 'change_audit_archive_retrieval_compartment_details' when calling change_audit_archive_retrieval_compartment." if change_audit_archive_retrieval_compartment_details.nil?
  raise "Parameter value for 'audit_archive_retrieval_id' must not be blank" if OCI::Internal::Util.blank_string?(audit_archive_retrieval_id)

  path = '/auditArchiveRetrievals/{auditArchiveRetrievalId}/actions/changeCompartment'.sub('{auditArchiveRetrievalId}', audit_archive_retrieval_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(change_audit_archive_retrieval_compartment_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#change_audit_archive_retrieval_compartment') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#change_audit_policy_compartment(audit_policy_id, change_audit_policy_compartment_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use change_audit_policy_compartment API.

Moves the specified audit policy and its dependent resources into a different compartment.

Parameters:

• audit_policy_id (String) —

  Unique audit policy identifier.

• change_audit_policy_compartment_details (OCI::DataSafe::Models::ChangeAuditPolicyCompartmentDetails) —

  Details for the compartment move.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :if_match (String) —

  For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

• :opc_request_id (String) —

  Unique identifier for the request.

• :opc_retry_token (String) —

  A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

Returns:

• (Response) —

  A Response object with data of type nil

# File 'lib/oci/data_safe/data_safe_client.rb', line 824

def change_audit_policy_compartment(audit_policy_id, change_audit_policy_compartment_details, opts = {})
  logger.debug 'Calling operation DataSafeClient#change_audit_policy_compartment.' if logger

  raise "Missing the required parameter 'audit_policy_id' when calling change_audit_policy_compartment." if audit_policy_id.nil?
  raise "Missing the required parameter 'change_audit_policy_compartment_details' when calling change_audit_policy_compartment." if change_audit_policy_compartment_details.nil?
  raise "Parameter value for 'audit_policy_id' must not be blank" if OCI::Internal::Util.blank_string?(audit_policy_id)

  path = '/auditPolicies/{auditPolicyId}/actions/changeCompartment'.sub('{auditPolicyId}', audit_policy_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(change_audit_policy_compartment_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#change_audit_policy_compartment') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#change_audit_profile_compartment(audit_profile_id, change_audit_profile_compartment_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use change_audit_profile_compartment API.

Moves the specified audit profile and its dependent resources into a different compartment.

Parameters:

• audit_profile_id (String) —

  The OCID of the audit.

• change_audit_profile_compartment_details (OCI::DataSafe::Models::ChangeAuditProfileCompartmentDetails) —

  Details for the compartment move.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :if_match (String) —

  For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

• :opc_retry_token (String) —

  A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

• :opc_request_id (String) —

  Unique identifier for the request.

Returns:

• (Response) —

  A Response object with data of type nil

# File 'lib/oci/data_safe/data_safe_client.rb', line 893

def change_audit_profile_compartment(audit_profile_id, change_audit_profile_compartment_details, opts = {})
  logger.debug 'Calling operation DataSafeClient#change_audit_profile_compartment.' if logger

  raise "Missing the required parameter 'audit_profile_id' when calling change_audit_profile_compartment." if audit_profile_id.nil?
  raise "Missing the required parameter 'change_audit_profile_compartment_details' when calling change_audit_profile_compartment." if change_audit_profile_compartment_details.nil?
  raise "Parameter value for 'audit_profile_id' must not be blank" if OCI::Internal::Util.blank_string?(audit_profile_id)

  path = '/auditProfiles/{auditProfileId}/actions/changeCompartment'.sub('{auditProfileId}', audit_profile_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(change_audit_profile_compartment_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#change_audit_profile_compartment') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#change_data_safe_private_endpoint_compartment(data_safe_private_endpoint_id, change_data_safe_private_endpoint_compartment_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use change_data_safe_private_endpoint_compartment API.

Moves the Data Safe private endpoint and its dependent resources to the specified compartment.

Parameters:

• data_safe_private_endpoint_id (String) —

  The OCID of the private endpoint.

• change_data_safe_private_endpoint_compartment_details (OCI::DataSafe::Models::ChangeDataSafePrivateEndpointCompartmentDetails) —

  The details used to change the compartment of a Data Safe private endpoint.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :opc_request_id (String) —

  Unique identifier for the request.

• :if_match (String) —

  For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

Returns:

• (Response) —

  A Response object with data of type nil

# File 'lib/oci/data_safe/data_safe_client.rb', line 957

def change_data_safe_private_endpoint_compartment(data_safe_private_endpoint_id, change_data_safe_private_endpoint_compartment_details, opts = {})
  logger.debug 'Calling operation DataSafeClient#change_data_safe_private_endpoint_compartment.' if logger

  raise "Missing the required parameter 'data_safe_private_endpoint_id' when calling change_data_safe_private_endpoint_compartment." if data_safe_private_endpoint_id.nil?
  raise "Missing the required parameter 'change_data_safe_private_endpoint_compartment_details' when calling change_data_safe_private_endpoint_compartment." if change_data_safe_private_endpoint_compartment_details.nil?
  raise "Parameter value for 'data_safe_private_endpoint_id' must not be blank" if OCI::Internal::Util.blank_string?(data_safe_private_endpoint_id)

  path = '/dataSafePrivateEndpoints/{dataSafePrivateEndpointId}/actions/changeCompartment'.sub('{dataSafePrivateEndpointId}', data_safe_private_endpoint_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(change_data_safe_private_endpoint_compartment_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#change_data_safe_private_endpoint_compartment') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#change_database_security_config_compartment(database_security_config_id, change_database_security_config_compartment_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use change_database_security_config_compartment API.

Moves the specified database security configuration and its dependent resources into a different compartment.

Parameters:

• database_security_config_id (String) —

  The OCID of the database security configuration resource.

• change_database_security_config_compartment_details (OCI::DataSafe::Models::ChangeDatabaseSecurityConfigCompartmentDetails) —

  Details for the compartment move.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :if_match (String) —

  For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

• :opc_request_id (String) —

  Unique identifier for the request.

• :opc_retry_token (String) —

  A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

Returns:

• (Response) —

  A Response object with data of type nil

# File 'lib/oci/data_safe/data_safe_client.rb', line 1024

def change_database_security_config_compartment(database_security_config_id, change_database_security_config_compartment_details, opts = {})
  logger.debug 'Calling operation DataSafeClient#change_database_security_config_compartment.' if logger

  raise "Missing the required parameter 'database_security_config_id' when calling change_database_security_config_compartment." if database_security_config_id.nil?
  raise "Missing the required parameter 'change_database_security_config_compartment_details' when calling change_database_security_config_compartment." if change_database_security_config_compartment_details.nil?
  raise "Parameter value for 'database_security_config_id' must not be blank" if OCI::Internal::Util.blank_string?(database_security_config_id)

  path = '/databaseSecurityConfigs/{databaseSecurityConfigId}/actions/changeCompartment'.sub('{databaseSecurityConfigId}', database_security_config_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(change_database_security_config_compartment_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#change_database_security_config_compartment') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#change_discovery_job_compartment(discovery_job_id, change_discovery_job_compartment_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use change_discovery_job_compartment API.

Moves the specified discovery job and its dependent resources into a different compartment.

Parameters:

• discovery_job_id (String) —

  The OCID of the discovery job.

• change_discovery_job_compartment_details (OCI::DataSafe::Models::ChangeDiscoveryJobCompartmentDetails) —

  The details used to change the compartment of a resource.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :if_match (String) —

  For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

• :opc_request_id (String) —

  Unique identifier for the request.

• :opc_retry_token (String) —

  A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

Returns:

• (Response) —

  A Response object with data of type nil

# File 'lib/oci/data_safe/data_safe_client.rb', line 1093

def change_discovery_job_compartment(discovery_job_id, change_discovery_job_compartment_details, opts = {})
  logger.debug 'Calling operation DataSafeClient#change_discovery_job_compartment.' if logger

  raise "Missing the required parameter 'discovery_job_id' when calling change_discovery_job_compartment." if discovery_job_id.nil?
  raise "Missing the required parameter 'change_discovery_job_compartment_details' when calling change_discovery_job_compartment." if change_discovery_job_compartment_details.nil?
  raise "Parameter value for 'discovery_job_id' must not be blank" if OCI::Internal::Util.blank_string?(discovery_job_id)

  path = '/discoveryJobs/{discoveryJobId}/actions/changeCompartment'.sub('{discoveryJobId}', discovery_job_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(change_discovery_job_compartment_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#change_discovery_job_compartment') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#change_library_masking_format_compartment(library_masking_format_id, change_library_masking_format_compartment_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use change_library_masking_format_compartment API.

Moves the specified library masking format into a different compartment.

Parameters:

• library_masking_format_id (String) —

  The OCID of the library masking format.

• change_library_masking_format_compartment_details (OCI::DataSafe::Models::ChangeLibraryMaskingFormatCompartmentDetails) —

  Details to change the compartment of a library masking format.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :if_match (String) —

  For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

• :opc_retry_token (String) —

  A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

• :opc_request_id (String) —

  Unique identifier for the request.

Returns:

• (Response) —

  A Response object with data of type nil

# File 'lib/oci/data_safe/data_safe_client.rb', line 1162

def change_library_masking_format_compartment(library_masking_format_id, change_library_masking_format_compartment_details, opts = {})
  logger.debug 'Calling operation DataSafeClient#change_library_masking_format_compartment.' if logger

  raise "Missing the required parameter 'library_masking_format_id' when calling change_library_masking_format_compartment." if library_masking_format_id.nil?
  raise "Missing the required parameter 'change_library_masking_format_compartment_details' when calling change_library_masking_format_compartment." if change_library_masking_format_compartment_details.nil?
  raise "Parameter value for 'library_masking_format_id' must not be blank" if OCI::Internal::Util.blank_string?(library_masking_format_id)

  path = '/libraryMaskingFormats/{libraryMaskingFormatId}/actions/changeCompartment'.sub('{libraryMaskingFormatId}', library_masking_format_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(change_library_masking_format_compartment_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#change_library_masking_format_compartment') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#change_masking_policy_compartment(masking_policy_id, change_masking_policy_compartment_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use change_masking_policy_compartment API.

Moves the specified masking policy and its dependent resources into a different compartment.

Parameters:

• masking_policy_id (String) —

  The OCID of the masking policy.

• change_masking_policy_compartment_details (OCI::DataSafe::Models::ChangeMaskingPolicyCompartmentDetails) —

  Details to change the compartment of a masking policy.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :if_match (String) —

  For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

• :opc_retry_token (String) —

  A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

• :opc_request_id (String) —

  Unique identifier for the request.

Returns:

• (Response) —

  A Response object with data of type nil

# File 'lib/oci/data_safe/data_safe_client.rb', line 1231

def change_masking_policy_compartment(masking_policy_id, change_masking_policy_compartment_details, opts = {})
  logger.debug 'Calling operation DataSafeClient#change_masking_policy_compartment.' if logger

  raise "Missing the required parameter 'masking_policy_id' when calling change_masking_policy_compartment." if masking_policy_id.nil?
  raise "Missing the required parameter 'change_masking_policy_compartment_details' when calling change_masking_policy_compartment." if change_masking_policy_compartment_details.nil?
  raise "Parameter value for 'masking_policy_id' must not be blank" if OCI::Internal::Util.blank_string?(masking_policy_id)

  path = '/maskingPolicies/{maskingPolicyId}/actions/changeCompartment'.sub('{maskingPolicyId}', masking_policy_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(change_masking_policy_compartment_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#change_masking_policy_compartment') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#change_on_prem_connector_compartment(on_prem_connector_id, change_on_prem_connector_compartment_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use change_on_prem_connector_compartment API.

Moves the specified on-premises connector into a different compartment.

Parameters:

• on_prem_connector_id (String) —

  The OCID of the on-premises connector.

• change_on_prem_connector_compartment_details (OCI::DataSafe::Models::ChangeOnPremConnectorCompartmentDetails) —

  The details used to change the compartment of an on-premises connector.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :opc_request_id (String) —

  Unique identifier for the request.

• :if_match (String) —

  For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

• :opc_retry_token (String) —

  A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

Returns:

• (Response) —

  A Response object with data of type nil

# File 'lib/oci/data_safe/data_safe_client.rb', line 1300

def change_on_prem_connector_compartment(on_prem_connector_id, change_on_prem_connector_compartment_details, opts = {})
  logger.debug 'Calling operation DataSafeClient#change_on_prem_connector_compartment.' if logger

  raise "Missing the required parameter 'on_prem_connector_id' when calling change_on_prem_connector_compartment." if on_prem_connector_id.nil?
  raise "Missing the required parameter 'change_on_prem_connector_compartment_details' when calling change_on_prem_connector_compartment." if change_on_prem_connector_compartment_details.nil?
  raise "Parameter value for 'on_prem_connector_id' must not be blank" if OCI::Internal::Util.blank_string?(on_prem_connector_id)

  path = '/onPremConnectors/{onPremConnectorId}/actions/changeCompartment'.sub('{onPremConnectorId}', on_prem_connector_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(change_on_prem_connector_compartment_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#change_on_prem_connector_compartment') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#change_report_compartment(report_id, change_report_compartment_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use change_report_compartment API.

Moves a resource into a different compartment. When provided, If-Match is checked against ETag values of the resource.

Parameters:

• report_id (String) —

  Unique report identifier

• change_report_compartment_details (OCI::DataSafe::Models::ChangeReportCompartmentDetails) —

  Details for the different Report.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :if_match (String) —

  For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

• :opc_request_id (String) —

  Unique identifier for the request.

• :opc_retry_token (String) —

  A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

Returns:

• (Response) —

  A Response object with data of type nil

# File 'lib/oci/data_safe/data_safe_client.rb', line 1369

def change_report_compartment(report_id, change_report_compartment_details, opts = {})
  logger.debug 'Calling operation DataSafeClient#change_report_compartment.' if logger

  raise "Missing the required parameter 'report_id' when calling change_report_compartment." if report_id.nil?
  raise "Missing the required parameter 'change_report_compartment_details' when calling change_report_compartment." if change_report_compartment_details.nil?
  raise "Parameter value for 'report_id' must not be blank" if OCI::Internal::Util.blank_string?(report_id)

  path = '/reports/{reportId}/actions/changeCompartment'.sub('{reportId}', report_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(change_report_compartment_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#change_report_compartment') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#change_report_definition_compartment(report_definition_id, change_report_definition_compartment_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use change_report_definition_compartment API.

Moves a resource into a different compartment. When provided, If-Match is checked against ETag values of the resource.

Parameters:

• report_definition_id (String) —

  Unique report definition identifier

• change_report_definition_compartment_details (OCI::DataSafe::Models::ChangeReportDefinitionCompartmentDetails) —

  Details for the different ReportDefinition.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :if_match (String) —

  For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

• :opc_request_id (String) —

  Unique identifier for the request.

• :opc_retry_token (String) —

  A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

Returns:

• (Response) —

  A Response object with data of type nil

# File 'lib/oci/data_safe/data_safe_client.rb', line 1438

def change_report_definition_compartment(report_definition_id, change_report_definition_compartment_details, opts = {})
  logger.debug 'Calling operation DataSafeClient#change_report_definition_compartment.' if logger

  raise "Missing the required parameter 'report_definition_id' when calling change_report_definition_compartment." if report_definition_id.nil?
  raise "Missing the required parameter 'change_report_definition_compartment_details' when calling change_report_definition_compartment." if change_report_definition_compartment_details.nil?
  raise "Parameter value for 'report_definition_id' must not be blank" if OCI::Internal::Util.blank_string?(report_definition_id)

  path = '/reportDefinitions/{reportDefinitionId}/actions/changeCompartment'.sub('{reportDefinitionId}', report_definition_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(change_report_definition_compartment_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#change_report_definition_compartment') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#change_retention(audit_profile_id, change_retention_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use change_retention API.

Change the online and offline months .

Parameters:

• audit_profile_id (String) —

  The OCID of the audit.

• change_retention_details (OCI::DataSafe::Models::ChangeRetentionDetails) —

  Details for the audit retention months to be modified.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :if_match (String) —

  For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

• :opc_request_id (String) —

  Unique identifier for the request.

• :opc_retry_token (String) —

  A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

Returns:

• (Response) —

  A Response object with data of type nil

# File 'lib/oci/data_safe/data_safe_client.rb', line 1507

def change_retention(audit_profile_id, change_retention_details, opts = {})
  logger.debug 'Calling operation DataSafeClient#change_retention.' if logger

  raise "Missing the required parameter 'audit_profile_id' when calling change_retention." if audit_profile_id.nil?
  raise "Missing the required parameter 'change_retention_details' when calling change_retention." if change_retention_details.nil?
  raise "Parameter value for 'audit_profile_id' must not be blank" if OCI::Internal::Util.blank_string?(audit_profile_id)

  path = '/auditProfiles/{auditProfileId}/actions/changeRetention'.sub('{auditProfileId}', audit_profile_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(change_retention_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#change_retention') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#change_sdm_masking_policy_difference_compartment(sdm_masking_policy_difference_id, change_sdm_masking_policy_difference_compartment_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use change_sdm_masking_policy_difference_compartment API.

Moves the specified SDM masking policy difference into a different compartment.

Parameters:

• sdm_masking_policy_difference_id (String) —

  The OCID of the SDM masking policy difference.

• change_sdm_masking_policy_difference_compartment_details (OCI::DataSafe::Models::ChangeSdmMaskingPolicyDifferenceCompartmentDetails) —

  The details used to change the compartment of a resource.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :if_match (String) —

  For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

• :opc_request_id (String) —

  Unique identifier for the request.

• :opc_retry_token (String) —

  A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

Returns:

• (Response) —

  A Response object with data of type nil

# File 'lib/oci/data_safe/data_safe_client.rb', line 1576

def change_sdm_masking_policy_difference_compartment(sdm_masking_policy_difference_id, change_sdm_masking_policy_difference_compartment_details, opts = {})
  logger.debug 'Calling operation DataSafeClient#change_sdm_masking_policy_difference_compartment.' if logger

  raise "Missing the required parameter 'sdm_masking_policy_difference_id' when calling change_sdm_masking_policy_difference_compartment." if sdm_masking_policy_difference_id.nil?
  raise "Missing the required parameter 'change_sdm_masking_policy_difference_compartment_details' when calling change_sdm_masking_policy_difference_compartment." if change_sdm_masking_policy_difference_compartment_details.nil?
  raise "Parameter value for 'sdm_masking_policy_difference_id' must not be blank" if OCI::Internal::Util.blank_string?(sdm_masking_policy_difference_id)

  path = '/sdmMaskingPolicyDifferences/{sdmMaskingPolicyDifferenceId}/actions/changeCompartment'.sub('{sdmMaskingPolicyDifferenceId}', sdm_masking_policy_difference_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(change_sdm_masking_policy_difference_compartment_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#change_sdm_masking_policy_difference_compartment') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#change_security_assessment_compartment(security_assessment_id, change_security_assessment_compartment_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use change_security_assessment_compartment API.

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.

Parameters:

• security_assessment_id (String) —

  The OCID of the security assessment.

• change_security_assessment_compartment_details (OCI::DataSafe::Models::ChangeSecurityAssessmentCompartmentDetails) —

  The details used to change the compartment of a security assessment.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :opc_request_id (String) —

  Unique identifier for the request.

• :if_match (String) —

  For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

• :opc_retry_token (String) —

  A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

Returns:

• (Response) —

  A Response object with data of type nil

# File 'lib/oci/data_safe/data_safe_client.rb', line 1650

def change_security_assessment_compartment(security_assessment_id, change_security_assessment_compartment_details, opts = {})
  logger.debug 'Calling operation DataSafeClient#change_security_assessment_compartment.' if logger

  raise "Missing the required parameter 'security_assessment_id' when calling change_security_assessment_compartment." if security_assessment_id.nil?
  raise "Missing the required parameter 'change_security_assessment_compartment_details' when calling change_security_assessment_compartment." if change_security_assessment_compartment_details.nil?
  raise "Parameter value for 'security_assessment_id' must not be blank" if OCI::Internal::Util.blank_string?(security_assessment_id)

  path = '/securityAssessments/{securityAssessmentId}/actions/changeCompartment'.sub('{securityAssessmentId}', security_assessment_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(change_security_assessment_compartment_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#change_security_assessment_compartment') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#change_security_policy_compartment(security_policy_id, change_security_policy_compartment_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use change_security_policy_compartment API.

Moves the specified security policy and its dependent resources into a different compartment.

Parameters:

• security_policy_id (String) —

  The OCID of the security policy resource.

• change_security_policy_compartment_details (OCI::DataSafe::Models::ChangeSecurityPolicyCompartmentDetails) —

  Details for the compartment move.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :if_match (String) —

  For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

• :opc_request_id (String) —

  Unique identifier for the request.

• :opc_retry_token (String) —

  A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

Returns:

• (Response) —

  A Response object with data of type nil

# File 'lib/oci/data_safe/data_safe_client.rb', line 1719

def change_security_policy_compartment(security_policy_id, change_security_policy_compartment_details, opts = {})
  logger.debug 'Calling operation DataSafeClient#change_security_policy_compartment.' if logger

  raise "Missing the required parameter 'security_policy_id' when calling change_security_policy_compartment." if security_policy_id.nil?
  raise "Missing the required parameter 'change_security_policy_compartment_details' when calling change_security_policy_compartment." if change_security_policy_compartment_details.nil?
  raise "Parameter value for 'security_policy_id' must not be blank" if OCI::Internal::Util.blank_string?(security_policy_id)

  path = '/securityPolicies/{securityPolicyId}/actions/changeCompartment'.sub('{securityPolicyId}', security_policy_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(change_security_policy_compartment_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#change_security_policy_compartment') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#change_security_policy_deployment_compartment(security_policy_deployment_id, change_security_policy_deployment_compartment_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use change_security_policy_deployment_compartment API.

Moves the specified security policy deployment and its dependent resources into a different compartment.

Parameters:

• security_policy_deployment_id (String) —

  The OCID of the security policy deployment resource.

• change_security_policy_deployment_compartment_details (OCI::DataSafe::Models::ChangeSecurityPolicyDeploymentCompartmentDetails) —

  Details for the compartment move.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :if_match (String) —

  For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

• :opc_request_id (String) —

  Unique identifier for the request.

• :opc_retry_token (String) —

  A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

Returns:

• (Response) —

  A Response object with data of type nil

# File 'lib/oci/data_safe/data_safe_client.rb', line 1788

def change_security_policy_deployment_compartment(security_policy_deployment_id, change_security_policy_deployment_compartment_details, opts = {})
  logger.debug 'Calling operation DataSafeClient#change_security_policy_deployment_compartment.' if logger

  raise "Missing the required parameter 'security_policy_deployment_id' when calling change_security_policy_deployment_compartment." if security_policy_deployment_id.nil?
  raise "Missing the required parameter 'change_security_policy_deployment_compartment_details' when calling change_security_policy_deployment_compartment." if change_security_policy_deployment_compartment_details.nil?
  raise "Parameter value for 'security_policy_deployment_id' must not be blank" if OCI::Internal::Util.blank_string?(security_policy_deployment_id)

  path = '/securityPolicyDeployments/{securityPolicyDeploymentId}/actions/changeCompartment'.sub('{securityPolicyDeploymentId}', security_policy_deployment_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(change_security_policy_deployment_compartment_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#change_security_policy_deployment_compartment') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#change_sensitive_data_model_compartment(sensitive_data_model_id, change_sensitive_data_model_compartment_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use change_sensitive_data_model_compartment API.

Moves the specified sensitive data model and its dependent resources into a different compartment.

Parameters:

• sensitive_data_model_id (String) —

  The OCID of the sensitive data model.

• change_sensitive_data_model_compartment_details (OCI::DataSafe::Models::ChangeSensitiveDataModelCompartmentDetails) —

  Details to change the compartment of a sensitive data model.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :if_match (String) —

  For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

• :opc_request_id (String) —

  Unique identifier for the request.

• :opc_retry_token (String) —

  A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

Returns:

• (Response) —

  A Response object with data of type nil

# File 'lib/oci/data_safe/data_safe_client.rb', line 1857

def change_sensitive_data_model_compartment(sensitive_data_model_id, change_sensitive_data_model_compartment_details, opts = {})
  logger.debug 'Calling operation DataSafeClient#change_sensitive_data_model_compartment.' if logger

  raise "Missing the required parameter 'sensitive_data_model_id' when calling change_sensitive_data_model_compartment." if sensitive_data_model_id.nil?
  raise "Missing the required parameter 'change_sensitive_data_model_compartment_details' when calling change_sensitive_data_model_compartment." if change_sensitive_data_model_compartment_details.nil?
  raise "Parameter value for 'sensitive_data_model_id' must not be blank" if OCI::Internal::Util.blank_string?(sensitive_data_model_id)

  path = '/sensitiveDataModels/{sensitiveDataModelId}/actions/changeCompartment'.sub('{sensitiveDataModelId}', sensitive_data_model_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(change_sensitive_data_model_compartment_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#change_sensitive_data_model_compartment') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#change_sensitive_type_compartment(sensitive_type_id, change_sensitive_type_compartment_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use change_sensitive_type_compartment API.

Moves the specified sensitive type into a different compartment.

Parameters:

• sensitive_type_id (String) —

  The OCID of the sensitive type.

• change_sensitive_type_compartment_details (OCI::DataSafe::Models::ChangeSensitiveTypeCompartmentDetails) —

  Details to change the compartment of a sensitive type.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :if_match (String) —

  For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

• :opc_request_id (String) —

  Unique identifier for the request.

• :opc_retry_token (String) —

  A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

Returns:

• (Response) —

  A Response object with data of type nil

# File 'lib/oci/data_safe/data_safe_client.rb', line 1926

def change_sensitive_type_compartment(sensitive_type_id, change_sensitive_type_compartment_details, opts = {})
  logger.debug 'Calling operation DataSafeClient#change_sensitive_type_compartment.' if logger

  raise "Missing the required parameter 'sensitive_type_id' when calling change_sensitive_type_compartment." if sensitive_type_id.nil?
  raise "Missing the required parameter 'change_sensitive_type_compartment_details' when calling change_sensitive_type_compartment." if change_sensitive_type_compartment_details.nil?
  raise "Parameter value for 'sensitive_type_id' must not be blank" if OCI::Internal::Util.blank_string?(sensitive_type_id)

  path = '/sensitiveTypes/{sensitiveTypeId}/actions/changeCompartment'.sub('{sensitiveTypeId}', sensitive_type_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(change_sensitive_type_compartment_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#change_sensitive_type_compartment') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#change_sql_collection_compartment(sql_collection_id, change_sql_collection_compartment_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use change_sql_collection_compartment API.

Moves the specified SQL collection and its dependent resources into a different compartment.

Parameters:

• sql_collection_id (String) —

  The OCID of the SQL collection resource.

• change_sql_collection_compartment_details (OCI::DataSafe::Models::ChangeSqlCollectionCompartmentDetails) —

  Details for the compartment move.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :if_match (String) —

  For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

• :opc_request_id (String) —

  Unique identifier for the request.

• :opc_retry_token (String) —

  A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

Returns:

• (Response) —

  A Response object with data of type nil

# File 'lib/oci/data_safe/data_safe_client.rb', line 1995

def change_sql_collection_compartment(sql_collection_id, change_sql_collection_compartment_details, opts = {})
  logger.debug 'Calling operation DataSafeClient#change_sql_collection_compartment.' if logger

  raise "Missing the required parameter 'sql_collection_id' when calling change_sql_collection_compartment." if sql_collection_id.nil?
  raise "Missing the required parameter 'change_sql_collection_compartment_details' when calling change_sql_collection_compartment." if change_sql_collection_compartment_details.nil?
  raise "Parameter value for 'sql_collection_id' must not be blank" if OCI::Internal::Util.blank_string?(sql_collection_id)

  path = '/sqlCollections/{sqlCollectionId}/actions/changeCompartment'.sub('{sqlCollectionId}', sql_collection_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(change_sql_collection_compartment_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#change_sql_collection_compartment') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#change_sql_firewall_policy_compartment(sql_firewall_policy_id, change_sql_firewall_policy_compartment_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use change_sql_firewall_policy_compartment API.

Moves the specified SQL firewall policy and its dependent resources into a different compartment.

Parameters:

• sql_firewall_policy_id (String) —

  The OCID of the SQL firewall policy resource.

• change_sql_firewall_policy_compartment_details (OCI::DataSafe::Models::ChangeSqlFirewallPolicyCompartmentDetails) —

  Details for the compartment move.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :if_match (String) —

  For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

• :opc_request_id (String) —

  Unique identifier for the request.

• :opc_retry_token (String) —

  A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

Returns:

• (Response) —

  A Response object with data of type nil

# File 'lib/oci/data_safe/data_safe_client.rb', line 2064

def change_sql_firewall_policy_compartment(sql_firewall_policy_id, change_sql_firewall_policy_compartment_details, opts = {})
  logger.debug 'Calling operation DataSafeClient#change_sql_firewall_policy_compartment.' if logger

  raise "Missing the required parameter 'sql_firewall_policy_id' when calling change_sql_firewall_policy_compartment." if sql_firewall_policy_id.nil?
  raise "Missing the required parameter 'change_sql_firewall_policy_compartment_details' when calling change_sql_firewall_policy_compartment." if change_sql_firewall_policy_compartment_details.nil?
  raise "Parameter value for 'sql_firewall_policy_id' must not be blank" if OCI::Internal::Util.blank_string?(sql_firewall_policy_id)

  path = '/sqlFirewallPolicies/{sqlFirewallPolicyId}/actions/changeCompartment'.sub('{sqlFirewallPolicyId}', sql_firewall_policy_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(change_sql_firewall_policy_compartment_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#change_sql_firewall_policy_compartment') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#change_target_alert_policy_association_compartment(target_alert_policy_association_id, change_target_alert_policy_association_compartment_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use change_target_alert_policy_association_compartment API.

Moves the specified target-alert policy Association into a different compartment.

Parameters:

• target_alert_policy_association_id (String) —

  The OCID of the target-alert policy association.

• change_target_alert_policy_association_compartment_details (OCI::DataSafe::Models::ChangeTargetAlertPolicyAssociationCompartmentDetails) —

  The details used to change the compartment of a target-alert policy association.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :opc_request_id (String) —

  Unique identifier for the request.

• :if_match (String) —

  For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

• :opc_retry_token (String) —

  A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

Returns:

• (Response) —

  A Response object with data of type nil

# File 'lib/oci/data_safe/data_safe_client.rb', line 2133

def change_target_alert_policy_association_compartment(target_alert_policy_association_id, change_target_alert_policy_association_compartment_details, opts = {})
  logger.debug 'Calling operation DataSafeClient#change_target_alert_policy_association_compartment.' if logger

  raise "Missing the required parameter 'target_alert_policy_association_id' when calling change_target_alert_policy_association_compartment." if target_alert_policy_association_id.nil?
  raise "Missing the required parameter 'change_target_alert_policy_association_compartment_details' when calling change_target_alert_policy_association_compartment." if change_target_alert_policy_association_compartment_details.nil?
  raise "Parameter value for 'target_alert_policy_association_id' must not be blank" if OCI::Internal::Util.blank_string?(target_alert_policy_association_id)

  path = '/targetAlertPolicyAssociations/{targetAlertPolicyAssociationId}/actions/changeCompartment'.sub('{targetAlertPolicyAssociationId}', target_alert_policy_association_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(change_target_alert_policy_association_compartment_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#change_target_alert_policy_association_compartment') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#change_target_database_compartment(target_database_id, change_target_database_compartment_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use change_target_database_compartment API.

Moves the Data Safe target database to the specified compartment.

Parameters:

• target_database_id (String) —

  The OCID of the Data Safe target database.

• change_target_database_compartment_details (OCI::DataSafe::Models::ChangeTargetDatabaseCompartmentDetails) —

  Details of the move compartment request.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :if_match (String) —

  For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

• :opc_request_id (String) —

  Unique identifier for the request.

• :opc_retry_token (String) —

  A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

Returns:

• (Response) —

  A Response object with data of type nil

# File 'lib/oci/data_safe/data_safe_client.rb', line 2202

def change_target_database_compartment(target_database_id, change_target_database_compartment_details, opts = {})
  logger.debug 'Calling operation DataSafeClient#change_target_database_compartment.' if logger

  raise "Missing the required parameter 'target_database_id' when calling change_target_database_compartment." if target_database_id.nil?
  raise "Missing the required parameter 'change_target_database_compartment_details' when calling change_target_database_compartment." if change_target_database_compartment_details.nil?
  raise "Parameter value for 'target_database_id' must not be blank" if OCI::Internal::Util.blank_string?(target_database_id)

  path = '/targetDatabases/{targetDatabaseId}/actions/changeCompartment'.sub('{targetDatabaseId}', target_database_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(change_target_database_compartment_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#change_target_database_compartment') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#change_user_assessment_compartment(user_assessment_id, change_user_assessment_compartment_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use change_user_assessment_compartment API.

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.

Parameters:

• user_assessment_id (String) —

  The OCID of the user assessment.

• change_user_assessment_compartment_details (OCI::DataSafe::Models::ChangeUserAssessmentCompartmentDetails) —

  The details used to change the compartment of a user assessment.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :if_match (String) —

  For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

• :opc_retry_token (String) —

  A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

• :opc_request_id (String) —

  Unique identifier for the request.

Returns:

• (Response) —

  A Response object with data of type nil

# File 'lib/oci/data_safe/data_safe_client.rb', line 2276

def change_user_assessment_compartment(user_assessment_id, change_user_assessment_compartment_details, opts = {})
  logger.debug 'Calling operation DataSafeClient#change_user_assessment_compartment.' if logger

  raise "Missing the required parameter 'user_assessment_id' when calling change_user_assessment_compartment." if user_assessment_id.nil?
  raise "Missing the required parameter 'change_user_assessment_compartment_details' when calling change_user_assessment_compartment." if change_user_assessment_compartment_details.nil?
  raise "Parameter value for 'user_assessment_id' must not be blank" if OCI::Internal::Util.blank_string?(user_assessment_id)

  path = '/userAssessments/{userAssessmentId}/actions/changeCompartment'.sub('{userAssessmentId}', user_assessment_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(change_user_assessment_compartment_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#change_user_assessment_compartment') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#compare_security_assessment(security_assessment_id, compare_security_assessment_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use compare_security_assessment API.

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.

Parameters:

• security_assessment_id (String) —

  The OCID of the security assessment.

• compare_security_assessment_details (OCI::DataSafe::Models::CompareSecurityAssessmentDetails) —

  Details of the security assessment comparison.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :opc_retry_token (String) —

  A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

• :opc_request_id (String) —

  Unique identifier for the request.

• :if_match (String) —

  For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

Returns:

• (Response) —

  A Response object with data of type nil

# File 'lib/oci/data_safe/data_safe_client.rb', line 2347

def compare_security_assessment(security_assessment_id, compare_security_assessment_details, opts = {})
  logger.debug 'Calling operation DataSafeClient#compare_security_assessment.' if logger

  raise "Missing the required parameter 'security_assessment_id' when calling compare_security_assessment." if security_assessment_id.nil?
  raise "Missing the required parameter 'compare_security_assessment_details' when calling compare_security_assessment." if compare_security_assessment_details.nil?
  raise "Parameter value for 'security_assessment_id' must not be blank" if OCI::Internal::Util.blank_string?(security_assessment_id)

  path = '/securityAssessments/{securityAssessmentId}/actions/compare'.sub('{securityAssessmentId}', security_assessment_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(compare_security_assessment_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#compare_security_assessment') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#compare_user_assessment(user_assessment_id, compare_user_assessment_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use compare_user_assessment API.

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.

Parameters:

• user_assessment_id (String) —

  The OCID of the user assessment.

• compare_user_assessment_details (OCI::DataSafe::Models::CompareUserAssessmentDetails) —

  Details of the user assessment comparison.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :opc_retry_token (String) —

  A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

• :opc_request_id (String) —

  Unique identifier for the request.

• :if_match (String) —

  For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

Returns:

• (Response) —

  A Response object with data of type nil

# File 'lib/oci/data_safe/data_safe_client.rb', line 2418

def compare_user_assessment(user_assessment_id, compare_user_assessment_details, opts = {})
  logger.debug 'Calling operation DataSafeClient#compare_user_assessment.' if logger

  raise "Missing the required parameter 'user_assessment_id' when calling compare_user_assessment." if user_assessment_id.nil?
  raise "Missing the required parameter 'compare_user_assessment_details' when calling compare_user_assessment." if compare_user_assessment_details.nil?
  raise "Parameter value for 'user_assessment_id' must not be blank" if OCI::Internal::Util.blank_string?(user_assessment_id)

  path = '/userAssessments/{userAssessmentId}/actions/compare'.sub('{userAssessmentId}', user_assessment_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(compare_user_assessment_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#compare_user_assessment') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_audit_archive_retrieval(create_audit_archive_retrieval_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use create_audit_archive_retrieval API.

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.

Parameters:

• create_audit_archive_retrieval_details (OCI::DataSafe::Models::CreateAuditArchiveRetrievalDetails) —

  Details for creating retrieving archived audit data.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :opc_retry_token (String) —

  A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

• :opc_request_id (String) —

  Unique identifier for the request.

Returns:

• (Response) —

  A Response object with data of type AuditArchiveRetrieval

# File 'lib/oci/data_safe/data_safe_client.rb', line 2483

def create_audit_archive_retrieval(create_audit_archive_retrieval_details, opts = {})
  logger.debug 'Calling operation DataSafeClient#create_audit_archive_retrieval.' if logger

  raise "Missing the required parameter 'create_audit_archive_retrieval_details' when calling create_audit_archive_retrieval." if create_audit_archive_retrieval_details.nil?

  path = '/auditArchiveRetrievals'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(create_audit_archive_retrieval_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#create_audit_archive_retrieval') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataSafe::Models::AuditArchiveRetrieval'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_data_safe_private_endpoint(create_data_safe_private_endpoint_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use create_data_safe_private_endpoint API.

Creates a new Data Safe private endpoint.

Parameters:

• create_data_safe_private_endpoint_details (OCI::DataSafe::Models::CreateDataSafePrivateEndpointDetails) —

  Details to create a new private endpoint.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :opc_retry_token (String) —

  A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

• :opc_request_id (String) —

  Unique identifier for the request.

Returns:

• (Response) —

  A Response object with data of type DataSafePrivateEndpoint

# File 'lib/oci/data_safe/data_safe_client.rb', line 2544

def create_data_safe_private_endpoint(create_data_safe_private_endpoint_details, opts = {})
  logger.debug 'Calling operation DataSafeClient#create_data_safe_private_endpoint.' if logger

  raise "Missing the required parameter 'create_data_safe_private_endpoint_details' when calling create_data_safe_private_endpoint." if create_data_safe_private_endpoint_details.nil?

  path = '/dataSafePrivateEndpoints'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(create_data_safe_private_endpoint_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#create_data_safe_private_endpoint') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataSafe::Models::DataSafePrivateEndpoint'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_discovery_job(create_discovery_job_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use create_discovery_job API.

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.

Parameters:

• create_discovery_job_details (OCI::DataSafe::Models::CreateDiscoveryJobDetails) —

  The details used to run an incremental data discovery job

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :opc_retry_token (String) —

  A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

• :opc_request_id (String) —

  Unique identifier for the request.

Returns:

• (Response) —

  A Response object with data of type DiscoveryJob

# File 'lib/oci/data_safe/data_safe_client.rb', line 2609

def create_discovery_job(create_discovery_job_details, opts = {})
  logger.debug 'Calling operation DataSafeClient#create_discovery_job.' if logger

  raise "Missing the required parameter 'create_discovery_job_details' when calling create_discovery_job." if create_discovery_job_details.nil?

  path = '/discoveryJobs'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(create_discovery_job_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#create_discovery_job') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataSafe::Models::DiscoveryJob'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_library_masking_format(create_library_masking_format_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use create_library_masking_format API.

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.

Parameters:

• create_library_masking_format_details (OCI::DataSafe::Models::CreateLibraryMaskingFormatDetails) —

  Details to create a new library masking format.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :opc_retry_token (String) —

  A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

• :opc_request_id (String) —

  Unique identifier for the request.

Returns:

• (Response) —

  A Response object with data of type LibraryMaskingFormat

# File 'lib/oci/data_safe/data_safe_client.rb', line 2674

def create_library_masking_format(create_library_masking_format_details, opts = {})
  logger.debug 'Calling operation DataSafeClient#create_library_masking_format.' if logger

  raise "Missing the required parameter 'create_library_masking_format_details' when calling create_library_masking_format." if create_library_masking_format_details.nil?

  path = '/libraryMaskingFormats'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(create_library_masking_format_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#create_library_masking_format') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataSafe::Models::LibraryMaskingFormat'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_masking_column(create_masking_column_details, masking_policy_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use create_masking_column API.

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 <a href="conditional“>docs.oracle.com/en/cloud/paas/data-safe/udscs/conditional-masking.html">conditional masking</a> 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 <a href="group“>docs.oracle.com/en/cloud/paas/data-safe/udscs/group-masking1.html#GUID-755056B9-9540-48C0-9491-262A44A85037">group or compound masking</a> that ensures that the masked data across the columns in a group continue to retain the same logical relationship.

Parameters:

• create_masking_column_details (OCI::DataSafe::Models::CreateMaskingColumnDetails) —

  Details to create a new masking column.

• masking_policy_id (String) —

  The OCID of the masking policy.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :opc_retry_token (String) —

  A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

• :opc_request_id (String) —

  Unique identifier for the request.

Returns:

• (Response) —

  A Response object with data of type nil

# File 'lib/oci/data_safe/data_safe_client.rb', line 2755

def create_masking_column(create_masking_column_details, masking_policy_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#create_masking_column.' if logger

  raise "Missing the required parameter 'create_masking_column_details' when calling create_masking_column." if create_masking_column_details.nil?
  raise "Missing the required parameter 'masking_policy_id' when calling create_masking_column." if masking_policy_id.nil?
  raise "Parameter value for 'masking_policy_id' must not be blank" if OCI::Internal::Util.blank_string?(masking_policy_id)

  path = '/maskingPolicies/{maskingPolicyId}/maskingColumns'.sub('{maskingPolicyId}', masking_policy_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(create_masking_column_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#create_masking_column') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_masking_policy(create_masking_policy_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use create_masking_policy API.

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.

Parameters:

• create_masking_policy_details (OCI::DataSafe::Models::CreateMaskingPolicyDetails) —

  Details to create a new masking policy.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :opc_retry_token (String) —

  A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

• :opc_request_id (String) —

  Unique identifier for the request.

Returns:

• (Response) —

  A Response object with data of type MaskingPolicy

# File 'lib/oci/data_safe/data_safe_client.rb', line 2833

def create_masking_policy(create_masking_policy_details, opts = {})
  logger.debug 'Calling operation DataSafeClient#create_masking_policy.' if logger

  raise "Missing the required parameter 'create_masking_policy_details' when calling create_masking_policy." if create_masking_policy_details.nil?

  path = '/maskingPolicies'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(create_masking_policy_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#create_masking_policy') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataSafe::Models::MaskingPolicy'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_on_prem_connector(create_on_prem_connector_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use create_on_prem_connector API.

Creates a new on-premises connector.

Parameters:

• create_on_prem_connector_details (OCI::DataSafe::Models::CreateOnPremConnectorDetails) —

  The details used to create a new on-premises connector.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :opc_retry_token (String) —

  A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

• :opc_request_id (String) —

  Unique identifier for the request.

Returns:

• (Response) —

  A Response object with data of type OnPremConnector

# File 'lib/oci/data_safe/data_safe_client.rb', line 2894

def create_on_prem_connector(create_on_prem_connector_details, opts = {})
  logger.debug 'Calling operation DataSafeClient#create_on_prem_connector.' if logger

  raise "Missing the required parameter 'create_on_prem_connector_details' when calling create_on_prem_connector." if create_on_prem_connector_details.nil?

  path = '/onPremConnectors'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(create_on_prem_connector_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#create_on_prem_connector') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataSafe::Models::OnPremConnector'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_report_definition(create_report_definition_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use create_report_definition API.

Creates a new report definition with parameters specified in the body. The report definition is stored in the specified compartment.

Parameters:

• create_report_definition_details (OCI::DataSafe::Models::CreateReportDefinitionDetails) —

  Details for the new report definition.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :opc_retry_token (String) —

  A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

• :opc_request_id (String) —

  Unique identifier for the request.

Returns:

• (Response) —

  A Response object with data of type ReportDefinition

# File 'lib/oci/data_safe/data_safe_client.rb', line 2955

def create_report_definition(create_report_definition_details, opts = {})
  logger.debug 'Calling operation DataSafeClient#create_report_definition.' if logger

  raise "Missing the required parameter 'create_report_definition_details' when calling create_report_definition." if create_report_definition_details.nil?

  path = '/reportDefinitions'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(create_report_definition_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#create_report_definition') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataSafe::Models::ReportDefinition'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_sdm_masking_policy_difference(create_sdm_masking_policy_difference_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use create_sdm_masking_policy_difference API.

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.

Parameters:

• create_sdm_masking_policy_difference_details (OCI::DataSafe::Models::CreateSdmMaskingPolicyDifferenceDetails) —

  The details used to create a SDM masking policy difference resource

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :opc_retry_token (String) —

  A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

• :opc_request_id (String) —

  Unique identifier for the request.

Returns:

• (Response) —

  A Response object with data of type SdmMaskingPolicyDifference

# File 'lib/oci/data_safe/data_safe_client.rb', line 3020

def create_sdm_masking_policy_difference(create_sdm_masking_policy_difference_details, opts = {})
  logger.debug 'Calling operation DataSafeClient#create_sdm_masking_policy_difference.' if logger

  raise "Missing the required parameter 'create_sdm_masking_policy_difference_details' when calling create_sdm_masking_policy_difference." if create_sdm_masking_policy_difference_details.nil?

  path = '/sdmMaskingPolicyDifferences'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(create_sdm_masking_policy_difference_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#create_sdm_masking_policy_difference') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataSafe::Models::SdmMaskingPolicyDifference'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_security_assessment(create_security_assessment_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use create_security_assessment API.

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.

Parameters:

• create_security_assessment_details (OCI::DataSafe::Models::CreateSecurityAssessmentDetails) —

  The details used to create a new saved security assessment.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :opc_retry_token (String) —

  A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

• :opc_request_id (String) —

  Unique identifier for the request.

Returns:

• (Response) —

  A Response object with data of type SecurityAssessment

# File 'lib/oci/data_safe/data_safe_client.rb', line 3083

def create_security_assessment(create_security_assessment_details, opts = {})
  logger.debug 'Calling operation DataSafeClient#create_security_assessment.' if logger

  raise "Missing the required parameter 'create_security_assessment_details' when calling create_security_assessment." if create_security_assessment_details.nil?

  path = '/securityAssessments'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(create_security_assessment_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#create_security_assessment') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataSafe::Models::SecurityAssessment'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_sensitive_column(sensitive_data_model_id, create_sensitive_column_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use create_sensitive_column API.

Creates a new sensitive column in the specified sensitive data model.

Parameters:

• sensitive_data_model_id (String) —

  The OCID of the sensitive data model.

• create_sensitive_column_details (OCI::DataSafe::Models::CreateSensitiveColumnDetails) —

  Details to create a new sensitive column.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :opc_retry_token (String) —

  A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

• :opc_request_id (String) —

  Unique identifier for the request.

Returns:

• (Response) —

  A Response object with data of type nil

# File 'lib/oci/data_safe/data_safe_client.rb', line 3145

def create_sensitive_column(sensitive_data_model_id, create_sensitive_column_details, opts = {})
  logger.debug 'Calling operation DataSafeClient#create_sensitive_column.' if logger

  raise "Missing the required parameter 'sensitive_data_model_id' when calling create_sensitive_column." if sensitive_data_model_id.nil?
  raise "Missing the required parameter 'create_sensitive_column_details' when calling create_sensitive_column." if create_sensitive_column_details.nil?
  raise "Parameter value for 'sensitive_data_model_id' must not be blank" if OCI::Internal::Util.blank_string?(sensitive_data_model_id)

  path = '/sensitiveDataModels/{sensitiveDataModelId}/sensitiveColumns'.sub('{sensitiveDataModelId}', sensitive_data_model_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(create_sensitive_column_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#create_sensitive_column') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_sensitive_data_model(create_sensitive_data_model_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use create_sensitive_data_model API.

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.

Parameters:

• create_sensitive_data_model_details (OCI::DataSafe::Models::CreateSensitiveDataModelDetails) —

  Details to create a new sensitive data model.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :opc_retry_token (String) —

  A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

• :opc_request_id (String) —

  Unique identifier for the request.

Returns:

• (Response) —

  A Response object with data of type SensitiveDataModel

# File 'lib/oci/data_safe/data_safe_client.rb', line 3209

def create_sensitive_data_model(create_sensitive_data_model_details, opts = {})
  logger.debug 'Calling operation DataSafeClient#create_sensitive_data_model.' if logger

  raise "Missing the required parameter 'create_sensitive_data_model_details' when calling create_sensitive_data_model." if create_sensitive_data_model_details.nil?

  path = '/sensitiveDataModels'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(create_sensitive_data_model_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#create_sensitive_data_model') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataSafe::Models::SensitiveDataModel'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_sensitive_type(create_sensitive_type_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use create_sensitive_type API.

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.

Parameters:

• create_sensitive_type_details (OCI::DataSafe::Models::CreateSensitiveTypeDetails) —

  Details to create a new sensitive type.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :opc_retry_token (String) —

  A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

• :opc_request_id (String) —

  Unique identifier for the request.

Returns:

• (Response) —

  A Response object with data of type SensitiveType

# File 'lib/oci/data_safe/data_safe_client.rb', line 3272

def create_sensitive_type(create_sensitive_type_details, opts = {})
  logger.debug 'Calling operation DataSafeClient#create_sensitive_type.' if logger

  raise "Missing the required parameter 'create_sensitive_type_details' when calling create_sensitive_type." if create_sensitive_type_details.nil?

  path = '/sensitiveTypes'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(create_sensitive_type_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#create_sensitive_type') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataSafe::Models::SensitiveType'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_sql_collection(create_sql_collection_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use create_sql_collection API.

Creates a new SQL collection resource.

Parameters:

• create_sql_collection_details (OCI::DataSafe::Models::CreateSqlCollectionDetails) —

  Details of the SQL collection.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :opc_retry_token (String) —

  A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

• :opc_request_id (String) —

  Unique identifier for the request.

Returns:

• (Response) —

  A Response object with data of type SqlCollection

# File 'lib/oci/data_safe/data_safe_client.rb', line 3333

def create_sql_collection(create_sql_collection_details, opts = {})
  logger.debug 'Calling operation DataSafeClient#create_sql_collection.' if logger

  raise "Missing the required parameter 'create_sql_collection_details' when calling create_sql_collection." if create_sql_collection_details.nil?

  path = '/sqlCollections'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(create_sql_collection_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#create_sql_collection') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataSafe::Models::SqlCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_target_alert_policy_association(create_target_alert_policy_association_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use create_target_alert_policy_association API.

Creates a new target-alert policy association to track a alert policy applied on target.

Parameters:

• create_target_alert_policy_association_details (OCI::DataSafe::Models::CreateTargetAlertPolicyAssociationDetails) —

  The details used to create a new target-alert policy association.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :opc_retry_token (String) —

  A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

• :opc_request_id (String) —

  Unique identifier for the request.

Returns:

• (Response) —

  A Response object with data of type TargetAlertPolicyAssociation

# File 'lib/oci/data_safe/data_safe_client.rb', line 3394

def create_target_alert_policy_association(create_target_alert_policy_association_details, opts = {})
  logger.debug 'Calling operation DataSafeClient#create_target_alert_policy_association.' if logger

  raise "Missing the required parameter 'create_target_alert_policy_association_details' when calling create_target_alert_policy_association." if create_target_alert_policy_association_details.nil?

  path = '/targetAlertPolicyAssociations'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(create_target_alert_policy_association_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#create_target_alert_policy_association') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataSafe::Models::TargetAlertPolicyAssociation'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_target_database(create_target_database_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use create_target_database API.

Registers the specified database with Data Safe and creates a Data Safe target database in the Data Safe Console.

Parameters:

• create_target_database_details (OCI::DataSafe::Models::CreateTargetDatabaseDetails) —

  Details of the target database.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :opc_retry_token (String) —

  A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

• :opc_request_id (String) —

  Unique identifier for the request.

Returns:

• (Response) —

  A Response object with data of type TargetDatabase

# File 'lib/oci/data_safe/data_safe_client.rb', line 3455

def create_target_database(create_target_database_details, opts = {})
  logger.debug 'Calling operation DataSafeClient#create_target_database.' if logger

  raise "Missing the required parameter 'create_target_database_details' when calling create_target_database." if create_target_database_details.nil?

  path = '/targetDatabases'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(create_target_database_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#create_target_database') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataSafe::Models::TargetDatabase'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_user_assessment(create_user_assessment_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use create_user_assessment API.

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.

Parameters:

• create_user_assessment_details (OCI::DataSafe::Models::CreateUserAssessmentDetails) —

  The details used to create a new saved user assessment.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :opc_retry_token (String) —

  A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

• :opc_request_id (String) —

  Unique identifier for the request.

Returns:

• (Response) —

  A Response object with data of type UserAssessment

# File 'lib/oci/data_safe/data_safe_client.rb', line 3518

def create_user_assessment(create_user_assessment_details, opts = {})
  logger.debug 'Calling operation DataSafeClient#create_user_assessment.' if logger

  raise "Missing the required parameter 'create_user_assessment_details' when calling create_user_assessment." if create_user_assessment_details.nil?

  path = '/userAssessments'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(create_user_assessment_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#create_user_assessment') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataSafe::Models::UserAssessment'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#deactivate_target_database(target_database_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use deactivate_target_database API.

Deactivates a target database in Data Safe.

Parameters:

• target_database_id (String) —

  The OCID of the Data Safe target database.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :opc_retry_token (String) —

  A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

• :if_match (String) —

  For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

• :opc_request_id (String) —

  Unique identifier for the request.

Returns:

• (Response) —

  A Response object with data of type nil

# File 'lib/oci/data_safe/data_safe_client.rb', line 3585

def deactivate_target_database(target_database_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#deactivate_target_database.' if logger

  raise "Missing the required parameter 'target_database_id' when calling deactivate_target_database." if target_database_id.nil?
  raise "Parameter value for 'target_database_id' must not be blank" if OCI::Internal::Util.blank_string?(target_database_id)

  path = '/targetDatabases/{targetDatabaseId}/actions/deactivate'.sub('{targetDatabaseId}', target_database_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#deactivate_target_database') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#delete_audit_archive_retrieval(audit_archive_retrieval_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use delete_audit_archive_retrieval API.

To unload retrieved archive data, call the operation ListAuditArchiveRetrieval first. This will return the auditArchiveRetrievalId. Then call this operation with auditArchiveRetrievalId.

Parameters:

• audit_archive_retrieval_id (String) —

  OCID of the archive retrieval.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :if_match (String) —

  For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

• :opc_request_id (String) —

  Unique identifier for the request.

Returns:

• (Response) —

  A Response object with data of type nil

# File 'lib/oci/data_safe/data_safe_client.rb', line 3649

def delete_audit_archive_retrieval(audit_archive_retrieval_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#delete_audit_archive_retrieval.' if logger

  raise "Missing the required parameter 'audit_archive_retrieval_id' when calling delete_audit_archive_retrieval." if audit_archive_retrieval_id.nil?
  raise "Parameter value for 'audit_archive_retrieval_id' must not be blank" if OCI::Internal::Util.blank_string?(audit_archive_retrieval_id)

  path = '/auditArchiveRetrievals/{auditArchiveRetrievalId}'.sub('{auditArchiveRetrievalId}', audit_archive_retrieval_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#delete_audit_archive_retrieval') do
    @api_client.call_api(
      :DELETE,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#delete_audit_trail(audit_trail_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use delete_audit_trail API.

Deletes the specified audit trail.

Parameters:

• audit_trail_id (String) —

  The OCID of the audit trail.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :if_match (String) —

  For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

• :opc_request_id (String) —

  Unique identifier for the request.

Returns:

• (Response) —

  A Response object with data of type nil

# File 'lib/oci/data_safe/data_safe_client.rb', line 3709

def delete_audit_trail(audit_trail_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#delete_audit_trail.' if logger

  raise "Missing the required parameter 'audit_trail_id' when calling delete_audit_trail." if audit_trail_id.nil?
  raise "Parameter value for 'audit_trail_id' must not be blank" if OCI::Internal::Util.blank_string?(audit_trail_id)

  path = '/auditTrails/{auditTrailId}'.sub('{auditTrailId}', audit_trail_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#delete_audit_trail') do
    @api_client.call_api(
      :DELETE,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#delete_data_safe_private_endpoint(data_safe_private_endpoint_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use delete_data_safe_private_endpoint API.

Deletes the specified Data Safe private endpoint.

Parameters:

• data_safe_private_endpoint_id (String) —

  The OCID of the private endpoint.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :if_match (String) —

  For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

• :opc_request_id (String) —

  Unique identifier for the request.

Returns:

• (Response) —

  A Response object with data of type nil

# File 'lib/oci/data_safe/data_safe_client.rb', line 3769

def delete_data_safe_private_endpoint(data_safe_private_endpoint_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#delete_data_safe_private_endpoint.' if logger

  raise "Missing the required parameter 'data_safe_private_endpoint_id' when calling delete_data_safe_private_endpoint." if data_safe_private_endpoint_id.nil?
  raise "Parameter value for 'data_safe_private_endpoint_id' must not be blank" if OCI::Internal::Util.blank_string?(data_safe_private_endpoint_id)

  path = '/dataSafePrivateEndpoints/{dataSafePrivateEndpointId}'.sub('{dataSafePrivateEndpointId}', data_safe_private_endpoint_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#delete_data_safe_private_endpoint') do
    @api_client.call_api(
      :DELETE,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#delete_discovery_job(discovery_job_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use delete_discovery_job API.

Deletes the specified discovery job.

Parameters:

• discovery_job_id (String) —

  The OCID of the discovery job.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :if_match (String) —

  For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

• :opc_request_id (String) —

  Unique identifier for the request.

Returns:

• (Response) —

  A Response object with data of type nil

# File 'lib/oci/data_safe/data_safe_client.rb', line 3829

def delete_discovery_job(discovery_job_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#delete_discovery_job.' if logger

  raise "Missing the required parameter 'discovery_job_id' when calling delete_discovery_job." if discovery_job_id.nil?
  raise "Parameter value for 'discovery_job_id' must not be blank" if OCI::Internal::Util.blank_string?(discovery_job_id)

  path = '/discoveryJobs/{discoveryJobId}'.sub('{discoveryJobId}', discovery_job_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#delete_discovery_job') do
    @api_client.call_api(
      :DELETE,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#delete_discovery_job_result(discovery_job_id, result_key, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use delete_discovery_job_result API.

Deletes the specified discovery result.

Parameters:

• discovery_job_id (String) —

  The OCID of the discovery job.

• result_key (String) —

  The unique key that identifies the discovery result.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :if_match (String) —

  For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

• :opc_request_id (String) —

  Unique identifier for the request.

Returns:

• (Response) —

  A Response object with data of type nil

# File 'lib/oci/data_safe/data_safe_client.rb', line 3890

def delete_discovery_job_result(discovery_job_id, result_key, opts = {})
  logger.debug 'Calling operation DataSafeClient#delete_discovery_job_result.' if logger

  raise "Missing the required parameter 'discovery_job_id' when calling delete_discovery_job_result." if discovery_job_id.nil?
  raise "Missing the required parameter 'result_key' when calling delete_discovery_job_result." if result_key.nil?
  raise "Parameter value for 'discovery_job_id' must not be blank" if OCI::Internal::Util.blank_string?(discovery_job_id)
  raise "Parameter value for 'result_key' must not be blank" if OCI::Internal::Util.blank_string?(result_key)

  path = '/discoveryJobs/{discoveryJobId}/results/{resultKey}'.sub('{discoveryJobId}', discovery_job_id.to_s).sub('{resultKey}', result_key.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#delete_discovery_job_result') do
    @api_client.call_api(
      :DELETE,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#delete_library_masking_format(library_masking_format_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use delete_library_masking_format API.

Deletes the specified library masking format.

Parameters:

• library_masking_format_id (String) —

  The OCID of the library masking format.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :if_match (String) —

  For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

• :opc_request_id (String) —

  Unique identifier for the request.

Returns:

• (Response) —

  A Response object with data of type nil

# File 'lib/oci/data_safe/data_safe_client.rb', line 3952

def delete_library_masking_format(library_masking_format_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#delete_library_masking_format.' if logger

  raise "Missing the required parameter 'library_masking_format_id' when calling delete_library_masking_format." if library_masking_format_id.nil?
  raise "Parameter value for 'library_masking_format_id' must not be blank" if OCI::Internal::Util.blank_string?(library_masking_format_id)

  path = '/libraryMaskingFormats/{libraryMaskingFormatId}'.sub('{libraryMaskingFormatId}', library_masking_format_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#delete_library_masking_format') do
    @api_client.call_api(
      :DELETE,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#delete_masking_column(masking_column_key, masking_policy_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use delete_masking_column API.

Deletes the specified masking column.

Parameters:

• masking_column_key (String) —

  The unique key that identifies the masking column. It's numeric and unique within a masking policy.

• masking_policy_id (String) —

  The OCID of the masking policy.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :if_match (String) —

  For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

• :opc_request_id (String) —

  Unique identifier for the request.

Returns:

• (Response) —

  A Response object with data of type nil

# File 'lib/oci/data_safe/data_safe_client.rb', line 4013

def delete_masking_column(masking_column_key, masking_policy_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#delete_masking_column.' if logger

  raise "Missing the required parameter 'masking_column_key' when calling delete_masking_column." if masking_column_key.nil?
  raise "Missing the required parameter 'masking_policy_id' when calling delete_masking_column." if masking_policy_id.nil?
  raise "Parameter value for 'masking_column_key' must not be blank" if OCI::Internal::Util.blank_string?(masking_column_key)
  raise "Parameter value for 'masking_policy_id' must not be blank" if OCI::Internal::Util.blank_string?(masking_policy_id)

  path = '/maskingPolicies/{maskingPolicyId}/maskingColumns/{maskingColumnKey}'.sub('{maskingColumnKey}', masking_column_key.to_s).sub('{maskingPolicyId}', masking_policy_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#delete_masking_column') do
    @api_client.call_api(
      :DELETE,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#delete_masking_policy(masking_policy_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use delete_masking_policy API.

Deletes the specified masking policy.

Parameters:

• masking_policy_id (String) —

  The OCID of the masking policy.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :if_match (String) —

  For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

• :opc_request_id (String) —

  Unique identifier for the request.

Returns:

• (Response) —

  A Response object with data of type nil

# File 'lib/oci/data_safe/data_safe_client.rb', line 4075

def delete_masking_policy(masking_policy_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#delete_masking_policy.' if logger

  raise "Missing the required parameter 'masking_policy_id' when calling delete_masking_policy." if masking_policy_id.nil?
  raise "Parameter value for 'masking_policy_id' must not be blank" if OCI::Internal::Util.blank_string?(masking_policy_id)

  path = '/maskingPolicies/{maskingPolicyId}'.sub('{maskingPolicyId}', masking_policy_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#delete_masking_policy') do
    @api_client.call_api(
      :DELETE,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#delete_on_prem_connector(on_prem_connector_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use delete_on_prem_connector API.

Deletes the specified on-premises connector.

Parameters:

• on_prem_connector_id (String) —

  The OCID of the on-premises connector.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :if_match (String) —

  For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

• :opc_request_id (String) —

  Unique identifier for the request.

Returns:

• (Response) —

  A Response object with data of type nil

# File 'lib/oci/data_safe/data_safe_client.rb', line 4135

def delete_on_prem_connector(on_prem_connector_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#delete_on_prem_connector.' if logger

  raise "Missing the required parameter 'on_prem_connector_id' when calling delete_on_prem_connector." if on_prem_connector_id.nil?
  raise "Parameter value for 'on_prem_connector_id' must not be blank" if OCI::Internal::Util.blank_string?(on_prem_connector_id)

  path = '/onPremConnectors/{onPremConnectorId}'.sub('{onPremConnectorId}', on_prem_connector_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#delete_on_prem_connector') do
    @api_client.call_api(
      :DELETE,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#delete_report_definition(report_definition_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use delete_report_definition API.

Deletes the specified report definition. Only the user created report definition can be deleted. The seeded report definitions cannot be deleted.

Parameters:

• report_definition_id (String) —

  Unique report definition identifier

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :if_match (String) —

  For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

• :opc_request_id (String) —

  Unique identifier for the request.

Returns:

• (Response) —

  A Response object with data of type nil

# File 'lib/oci/data_safe/data_safe_client.rb', line 4195

def delete_report_definition(report_definition_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#delete_report_definition.' if logger

  raise "Missing the required parameter 'report_definition_id' when calling delete_report_definition." if report_definition_id.nil?
  raise "Parameter value for 'report_definition_id' must not be blank" if OCI::Internal::Util.blank_string?(report_definition_id)

  path = '/reportDefinitions/{reportDefinitionId}'.sub('{reportDefinitionId}', report_definition_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#delete_report_definition') do
    @api_client.call_api(
      :DELETE,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#delete_sdm_masking_policy_difference(sdm_masking_policy_difference_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use delete_sdm_masking_policy_difference API.

Deletes the specified SDM Masking policy difference.

Parameters:

• sdm_masking_policy_difference_id (String) —

  The OCID of the SDM masking policy difference.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :if_match (String) —

  For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

• :opc_request_id (String) —

  Unique identifier for the request.

Returns:

• (Response) —

  A Response object with data of type nil

# File 'lib/oci/data_safe/data_safe_client.rb', line 4255

def delete_sdm_masking_policy_difference(sdm_masking_policy_difference_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#delete_sdm_masking_policy_difference.' if logger

  raise "Missing the required parameter 'sdm_masking_policy_difference_id' when calling delete_sdm_masking_policy_difference." if sdm_masking_policy_difference_id.nil?
  raise "Parameter value for 'sdm_masking_policy_difference_id' must not be blank" if OCI::Internal::Util.blank_string?(sdm_masking_policy_difference_id)

  path = '/sdmMaskingPolicyDifferences/{sdmMaskingPolicyDifferenceId}'.sub('{sdmMaskingPolicyDifferenceId}', sdm_masking_policy_difference_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#delete_sdm_masking_policy_difference') do
    @api_client.call_api(
      :DELETE,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#delete_security_assessment(security_assessment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use delete_security_assessment API.

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.

Parameters:

• security_assessment_id (String) —

  The OCID of the security assessment.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :opc_request_id (String) —

  Unique identifier for the request.

• :if_match (String) —

  For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

Returns:

• (Response) —

  A Response object with data of type nil

# File 'lib/oci/data_safe/data_safe_client.rb', line 4319

def delete_security_assessment(security_assessment_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#delete_security_assessment.' if logger

  raise "Missing the required parameter 'security_assessment_id' when calling delete_security_assessment." if security_assessment_id.nil?
  raise "Parameter value for 'security_assessment_id' must not be blank" if OCI::Internal::Util.blank_string?(security_assessment_id)

  path = '/securityAssessments/{securityAssessmentId}'.sub('{securityAssessmentId}', security_assessment_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#delete_security_assessment') do
    @api_client.call_api(
      :DELETE,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#delete_sensitive_column(sensitive_data_model_id, sensitive_column_key, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use delete_sensitive_column API.

Deletes the specified sensitive column.

Parameters:

• sensitive_data_model_id (String) —

  The OCID of the sensitive data model.

• sensitive_column_key (String) —

  The unique key that identifies the sensitive column. It's numeric and unique within a sensitive data model.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :if_match (String) —

  For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

• :opc_request_id (String) —

  Unique identifier for the request.

Returns:

• (Response) —

  A Response object with data of type nil

# File 'lib/oci/data_safe/data_safe_client.rb', line 4380

def delete_sensitive_column(sensitive_data_model_id, sensitive_column_key, opts = {})
  logger.debug 'Calling operation DataSafeClient#delete_sensitive_column.' if logger

  raise "Missing the required parameter 'sensitive_data_model_id' when calling delete_sensitive_column." if sensitive_data_model_id.nil?
  raise "Missing the required parameter 'sensitive_column_key' when calling delete_sensitive_column." if sensitive_column_key.nil?
  raise "Parameter value for 'sensitive_data_model_id' must not be blank" if OCI::Internal::Util.blank_string?(sensitive_data_model_id)
  raise "Parameter value for 'sensitive_column_key' must not be blank" if OCI::Internal::Util.blank_string?(sensitive_column_key)

  path = '/sensitiveDataModels/{sensitiveDataModelId}/sensitiveColumns/{sensitiveColumnKey}'.sub('{sensitiveDataModelId}', sensitive_data_model_id.to_s).sub('{sensitiveColumnKey}', sensitive_column_key.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#delete_sensitive_column') do
    @api_client.call_api(
      :DELETE,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#delete_sensitive_data_model(sensitive_data_model_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use delete_sensitive_data_model API.

Deletes the specified sensitive data model.

Parameters:

• sensitive_data_model_id (String) —

  The OCID of the sensitive data model.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :if_match (String) —

  For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

• :opc_request_id (String) —

  Unique identifier for the request.

Returns:

• (Response) —

  A Response object with data of type nil

# File 'lib/oci/data_safe/data_safe_client.rb', line 4442

def delete_sensitive_data_model(sensitive_data_model_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#delete_sensitive_data_model.' if logger

  raise "Missing the required parameter 'sensitive_data_model_id' when calling delete_sensitive_data_model." if sensitive_data_model_id.nil?
  raise "Parameter value for 'sensitive_data_model_id' must not be blank" if OCI::Internal::Util.blank_string?(sensitive_data_model_id)

  path = '/sensitiveDataModels/{sensitiveDataModelId}'.sub('{sensitiveDataModelId}', sensitive_data_model_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#delete_sensitive_data_model') do
    @api_client.call_api(
      :DELETE,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#delete_sensitive_type(sensitive_type_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use delete_sensitive_type API.

Deletes the specified sensitive type.

Parameters:

• sensitive_type_id (String) —

  The OCID of the sensitive type.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :if_match (String) —

  For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

• :opc_request_id (String) —

  Unique identifier for the request.

Returns:

• (Response) —

  A Response object with data of type nil

# File 'lib/oci/data_safe/data_safe_client.rb', line 4502

def delete_sensitive_type(sensitive_type_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#delete_sensitive_type.' if logger

  raise "Missing the required parameter 'sensitive_type_id' when calling delete_sensitive_type." if sensitive_type_id.nil?
  raise "Parameter value for 'sensitive_type_id' must not be blank" if OCI::Internal::Util.blank_string?(sensitive_type_id)

  path = '/sensitiveTypes/{sensitiveTypeId}'.sub('{sensitiveTypeId}', sensitive_type_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#delete_sensitive_type') do
    @api_client.call_api(
      :DELETE,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#delete_sql_collection(sql_collection_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use delete_sql_collection API.

Deletes the specified SQL collection.

Parameters:

• sql_collection_id (String) —

  The OCID of the SQL collection resource.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :if_match (String) —

  For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

• :opc_request_id (String) —

  Unique identifier for the request.

Returns:

• (Response) —

  A Response object with data of type nil

# File 'lib/oci/data_safe/data_safe_client.rb', line 4562

def delete_sql_collection(sql_collection_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#delete_sql_collection.' if logger

  raise "Missing the required parameter 'sql_collection_id' when calling delete_sql_collection." if sql_collection_id.nil?
  raise "Parameter value for 'sql_collection_id' must not be blank" if OCI::Internal::Util.blank_string?(sql_collection_id)

  path = '/sqlCollections/{sqlCollectionId}'.sub('{sqlCollectionId}', sql_collection_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#delete_sql_collection') do
    @api_client.call_api(
      :DELETE,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#delete_sql_firewall_policy(sql_firewall_policy_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use delete_sql_firewall_policy API.

Deletes the SQL firewall policy resource.

Parameters:

• sql_firewall_policy_id (String) —

  The OCID of the SQL firewall policy resource.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :if_match (String) —

  For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

• :opc_request_id (String) —

  Unique identifier for the request.

Returns:

• (Response) —

  A Response object with data of type nil

# File 'lib/oci/data_safe/data_safe_client.rb', line 4623

def delete_sql_firewall_policy(sql_firewall_policy_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#delete_sql_firewall_policy.' if logger

  raise "Missing the required parameter 'sql_firewall_policy_id' when calling delete_sql_firewall_policy." if sql_firewall_policy_id.nil?
  raise "Parameter value for 'sql_firewall_policy_id' must not be blank" if OCI::Internal::Util.blank_string?(sql_firewall_policy_id)

  path = '/sqlFirewallPolicies/{sqlFirewallPolicyId}'.sub('{sqlFirewallPolicyId}', sql_firewall_policy_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#delete_sql_firewall_policy') do
    @api_client.call_api(
      :DELETE,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#delete_target_alert_policy_association(target_alert_policy_association_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use delete_target_alert_policy_association API.

Deletes the specified target-alert policy Association.

Parameters:

• target_alert_policy_association_id (String) —

  The OCID of the target-alert policy association.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :if_match (String) —

  For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

• :opc_request_id (String) —

  Unique identifier for the request.

Returns:

• (Response) —

  A Response object with data of type nil

# File 'lib/oci/data_safe/data_safe_client.rb', line 4683

def delete_target_alert_policy_association(target_alert_policy_association_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#delete_target_alert_policy_association.' if logger

  raise "Missing the required parameter 'target_alert_policy_association_id' when calling delete_target_alert_policy_association." if target_alert_policy_association_id.nil?
  raise "Parameter value for 'target_alert_policy_association_id' must not be blank" if OCI::Internal::Util.blank_string?(target_alert_policy_association_id)

  path = '/targetAlertPolicyAssociations/{targetAlertPolicyAssociationId}'.sub('{targetAlertPolicyAssociationId}', target_alert_policy_association_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#delete_target_alert_policy_association') do
    @api_client.call_api(
      :DELETE,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#delete_target_database(target_database_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use delete_target_database API.

Deregisters the specified database from Data Safe and removes the target database from the Data Safe Console.

Parameters:

• target_database_id (String) —

  The OCID of the Data Safe target database.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :if_match (String) —

  For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

• :opc_request_id (String) —

  Unique identifier for the request.

Returns:

• (Response) —

  A Response object with data of type nil

# File 'lib/oci/data_safe/data_safe_client.rb', line 4743

def delete_target_database(target_database_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#delete_target_database.' if logger

  raise "Missing the required parameter 'target_database_id' when calling delete_target_database." if target_database_id.nil?
  raise "Parameter value for 'target_database_id' must not be blank" if OCI::Internal::Util.blank_string?(target_database_id)

  path = '/targetDatabases/{targetDatabaseId}'.sub('{targetDatabaseId}', target_database_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#delete_target_database') do
    @api_client.call_api(
      :DELETE,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#delete_user_assessment(user_assessment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use delete_user_assessment API.

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.

Parameters:

• user_assessment_id (String) —

  The OCID of the user assessment.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :if_match (String) —

  For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

• :opc_request_id (String) —

  Unique identifier for the request.

Returns:

• (Response) —

  A Response object with data of type nil

# File 'lib/oci/data_safe/data_safe_client.rb', line 4807

def delete_user_assessment(user_assessment_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#delete_user_assessment.' if logger

  raise "Missing the required parameter 'user_assessment_id' when calling delete_user_assessment." if user_assessment_id.nil?
  raise "Parameter value for 'user_assessment_id' must not be blank" if OCI::Internal::Util.blank_string?(user_assessment_id)

  path = '/userAssessments/{userAssessmentId}'.sub('{userAssessmentId}', user_assessment_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#delete_user_assessment') do
    @api_client.call_api(
      :DELETE,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#discover_audit_trails(audit_profile_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use discover_audit_trails API.

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.

Parameters:

• audit_profile_id (String) —

  The OCID of the audit.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :opc_request_id (String) —

  Unique identifier for the request.

• :if_match (String) —

  For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

• :opc_retry_token (String) —

  A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

Returns:

• (Response) —

  A Response object with data of type nil

# File 'lib/oci/data_safe/data_safe_client.rb', line 4876

def discover_audit_trails(audit_profile_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#discover_audit_trails.' if logger

  raise "Missing the required parameter 'audit_profile_id' when calling discover_audit_trails." if audit_profile_id.nil?
  raise "Parameter value for 'audit_profile_id' must not be blank" if OCI::Internal::Util.blank_string?(audit_profile_id)

  path = '/auditProfiles/{auditProfileId}/actions/discoverAuditTrails'.sub('{auditProfileId}', audit_profile_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#discover_audit_trails') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#download_discovery_report(sensitive_data_model_id, download_discovery_report_details, opts = {}, &block) ⇒ Response

Note:

Click here to see an example of how to use download_discovery_report API.

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.

Parameters:

• sensitive_data_model_id (String) —

  The OCID of the sensitive data model.

• download_discovery_report_details (OCI::DataSafe::Models::DownloadDiscoveryReportDetails) —

  Details to download a discovery report.

• opts (Hash) (defaults to: {}) —

  the optional parameters

• [Block] (Hash) —

  a customizable set of options

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :opc_request_id (String) —

  Unique identifier for the request.

• :response_target (String, IO) —

  Streaming http body into a file (specified by file name or File object) or IO object if the block is not given

Returns:

• (Response) —

  A Response object with data of type String if response_target and block are not given, otherwise with nil data

# File 'lib/oci/data_safe/data_safe_client.rb', line 4939

def download_discovery_report(sensitive_data_model_id, download_discovery_report_details, opts = {}, &block)
  logger.debug 'Calling operation DataSafeClient#download_discovery_report.' if logger

  raise "Missing the required parameter 'sensitive_data_model_id' when calling download_discovery_report." if sensitive_data_model_id.nil?
  raise "Missing the required parameter 'download_discovery_report_details' when calling download_discovery_report." if download_discovery_report_details.nil?
  raise "Parameter value for 'sensitive_data_model_id' must not be blank" if OCI::Internal::Util.blank_string?(sensitive_data_model_id)

  path = '/sensitiveDataModels/{sensitiveDataModelId}/actions/downloadReport'.sub('{sensitiveDataModelId}', sensitive_data_model_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = opts[:accept] if opts[:accept]
  header_params[:accept] ||= 'application/json'
  header_params[:'accept-encoding'] = opts[:accept_encoding] if opts[:accept_encoding]
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(download_discovery_report_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#download_discovery_report') do
    if !block.nil?
      @api_client.call_api(
        :POST,
        path,
        endpoint,
        header_params: header_params,
        query_params: query_params,
        operation_signing_strategy: operation_signing_strategy,
        body: post_body,
        return_type: 'Stream',
        &block
      )
    elsif opts[:response_target]
      if opts[:response_target].respond_to? :write
        @api_client.call_api(
          :POST,
          path,
          endpoint,
          header_params: header_params,
          query_params: query_params,
          operation_signing_strategy: operation_signing_strategy,
          body: post_body,
          return_type: 'Stream',
          &proc { |chunk, _response| opts[:response_target].write(chunk) }
        )
      elsif opts[:response_target].is_a?(String)
        File.open(opts[:response_target], 'wb') do |output|
          return @api_client.call_api(
            :POST,
            path,
            endpoint,
            header_params: header_params,
            query_params: query_params,
            operation_signing_strategy: operation_signing_strategy,
            body: post_body,
            return_type: 'Stream',
            &proc { |chunk, _response| output.write(chunk) }
          )
        end
      end
    else
      @api_client.call_api(
        :POST,
        path,
        endpoint,
        header_params: header_params,
        query_params: query_params,
        operation_signing_strategy: operation_signing_strategy,
        body: post_body,
        return_type: 'String'
      )
    end
  end
  # rubocop:enable Metrics/BlockLength
end

#download_masking_log(masking_policy_id, download_masking_log_details, opts = {}, &block) ⇒ Response

Note:

Click here to see an example of how to use download_masking_log API.

Downloads the masking log generated by the last masking operation on a target database using the specified masking policy.

Parameters:

• masking_policy_id (String) —

  The OCID of the masking policy.

• download_masking_log_details (OCI::DataSafe::Models::DownloadMaskingLogDetails) —

  Details to download masking log.

• opts (Hash) (defaults to: {}) —

  the optional parameters

• [Block] (Hash) —

  a customizable set of options

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :opc_request_id (String) —

  Unique identifier for the request.

• :response_target (String, IO) —

  Streaming http body into a file (specified by file name or File object) or IO object if the block is not given

Returns:

• (Response) —

  A Response object with data of type String if response_target and block are not given, otherwise with nil data

# File 'lib/oci/data_safe/data_safe_client.rb', line 5041

def download_masking_log(masking_policy_id, download_masking_log_details, opts = {}, &block)
  logger.debug 'Calling operation DataSafeClient#download_masking_log.' if logger

  raise "Missing the required parameter 'masking_policy_id' when calling download_masking_log." if masking_policy_id.nil?
  raise "Missing the required parameter 'download_masking_log_details' when calling download_masking_log." if download_masking_log_details.nil?
  raise "Parameter value for 'masking_policy_id' must not be blank" if OCI::Internal::Util.blank_string?(masking_policy_id)

  path = '/maskingPolicies/{maskingPolicyId}/actions/downloadLog'.sub('{maskingPolicyId}', masking_policy_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = opts[:accept] if opts[:accept]
  header_params[:accept] ||= 'application/octet-stream'
  header_params[:'accept-encoding'] = opts[:accept_encoding] if opts[:accept_encoding]
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(download_masking_log_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#download_masking_log') do
    if !block.nil?
      @api_client.call_api(
        :POST,
        path,
        endpoint,
        header_params: header_params,
        query_params: query_params,
        operation_signing_strategy: operation_signing_strategy,
        body: post_body,
        return_type: 'Stream',
        &block
      )
    elsif opts[:response_target]
      if opts[:response_target].respond_to? :write
        @api_client.call_api(
          :POST,
          path,
          endpoint,
          header_params: header_params,
          query_params: query_params,
          operation_signing_strategy: operation_signing_strategy,
          body: post_body,
          return_type: 'Stream',
          &proc { |chunk, _response| opts[:response_target].write(chunk) }
        )
      elsif opts[:response_target].is_a?(String)
        File.open(opts[:response_target], 'wb') do |output|
          return @api_client.call_api(
            :POST,
            path,
            endpoint,
            header_params: header_params,
            query_params: query_params,
            operation_signing_strategy: operation_signing_strategy,
            body: post_body,
            return_type: 'Stream',
            &proc { |chunk, _response| output.write(chunk) }
          )
        end
      end
    else
      @api_client.call_api(
        :POST,
        path,
        endpoint,
        header_params: header_params,
        query_params: query_params,
        operation_signing_strategy: operation_signing_strategy,
        body: post_body,
        return_type: 'String'
      )
    end
  end
  # rubocop:enable Metrics/BlockLength
end

#download_masking_policy(masking_policy_id, download_masking_policy_details, opts = {}, &block) ⇒ Response

Note:

Click here to see an example of how to use download_masking_policy API.

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.

Parameters:

• masking_policy_id (String) —

  The OCID of the masking policy.

• download_masking_policy_details (OCI::DataSafe::Models::DownloadMaskingPolicyDetails) —

  Details to download a masking policy file.

• opts (Hash) (defaults to: {}) —

  the optional parameters

• [Block] (Hash) —

  a customizable set of options

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :opc_request_id (String) —

  Unique identifier for the request.

• :response_target (String, IO) —

  Streaming http body into a file (specified by file name or File object) or IO object if the block is not given

Returns:

• (Response) —

  A Response object with data of type String if response_target and block are not given, otherwise with nil data

# File 'lib/oci/data_safe/data_safe_client.rb', line 5147

def download_masking_policy(masking_policy_id, download_masking_policy_details, opts = {}, &block)
  logger.debug 'Calling operation DataSafeClient#download_masking_policy.' if logger

  raise "Missing the required parameter 'masking_policy_id' when calling download_masking_policy." if masking_policy_id.nil?
  raise "Missing the required parameter 'download_masking_policy_details' when calling download_masking_policy." if download_masking_policy_details.nil?
  raise "Parameter value for 'masking_policy_id' must not be blank" if OCI::Internal::Util.blank_string?(masking_policy_id)

  path = '/maskingPolicies/{maskingPolicyId}/actions/download'.sub('{maskingPolicyId}', masking_policy_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = opts[:accept] if opts[:accept]
  header_params[:accept] ||= 'application/octet-stream'
  header_params[:'accept-encoding'] = opts[:accept_encoding] if opts[:accept_encoding]
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(download_masking_policy_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#download_masking_policy') do
    if !block.nil?
      @api_client.call_api(
        :POST,
        path,
        endpoint,
        header_params: header_params,
        query_params: query_params,
        operation_signing_strategy: operation_signing_strategy,
        body: post_body,
        return_type: 'Stream',
        &block
      )
    elsif opts[:response_target]
      if opts[:response_target].respond_to? :write
        @api_client.call_api(
          :POST,
          path,
          endpoint,
          header_params: header_params,
          query_params: query_params,
          operation_signing_strategy: operation_signing_strategy,
          body: post_body,
          return_type: 'Stream',
          &proc { |chunk, _response| opts[:response_target].write(chunk) }
        )
      elsif opts[:response_target].is_a?(String)
        File.open(opts[:response_target], 'wb') do |output|
          return @api_client.call_api(
            :POST,
            path,
            endpoint,
            header_params: header_params,
            query_params: query_params,
            operation_signing_strategy: operation_signing_strategy,
            body: post_body,
            return_type: 'Stream',
            &proc { |chunk, _response| output.write(chunk) }
          )
        end
      end
    else
      @api_client.call_api(
        :POST,
        path,
        endpoint,
        header_params: header_params,
        query_params: query_params,
        operation_signing_strategy: operation_signing_strategy,
        body: post_body,
        return_type: 'String'
      )
    end
  end
  # rubocop:enable Metrics/BlockLength
end

#download_masking_report(masking_policy_id, download_masking_report_details, opts = {}, &block) ⇒ Response

Note:

Click here to see an example of how to use download_masking_report API.

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.

Parameters:

• masking_policy_id (String) —

  The OCID of the masking policy.

• download_masking_report_details (OCI::DataSafe::Models::DownloadMaskingReportDetails) —

  Details to download a masking report.

• opts (Hash) (defaults to: {}) —

  the optional parameters

• [Block] (Hash) —

  a customizable set of options

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :opc_request_id (String) —

  Unique identifier for the request.

• :response_target (String, IO) —

  Streaming http body into a file (specified by file name or File object) or IO object if the block is not given

Returns:

• (Response) —

  A Response object with data of type String if response_target and block are not given, otherwise with nil data

# File 'lib/oci/data_safe/data_safe_client.rb', line 5252

def download_masking_report(masking_policy_id, download_masking_report_details, opts = {}, &block)
  logger.debug 'Calling operation DataSafeClient#download_masking_report.' if logger

  raise "Missing the required parameter 'masking_policy_id' when calling download_masking_report." if masking_policy_id.nil?
  raise "Missing the required parameter 'download_masking_report_details' when calling download_masking_report." if download_masking_report_details.nil?
  raise "Parameter value for 'masking_policy_id' must not be blank" if OCI::Internal::Util.blank_string?(masking_policy_id)

  path = '/maskingPolicies/{maskingPolicyId}/actions/downloadReport'.sub('{maskingPolicyId}', masking_policy_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = opts[:accept] if opts[:accept]
  header_params[:accept] ||= 'application/json'
  header_params[:'accept-encoding'] = opts[:accept_encoding] if opts[:accept_encoding]
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(download_masking_report_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#download_masking_report') do
    if !block.nil?
      @api_client.call_api(
        :POST,
        path,
        endpoint,
        header_params: header_params,
        query_params: query_params,
        operation_signing_strategy: operation_signing_strategy,
        body: post_body,
        return_type: 'Stream',
        &block
      )
    elsif opts[:response_target]
      if opts[:response_target].respond_to? :write
        @api_client.call_api(
          :POST,
          path,
          endpoint,
          header_params: header_params,
          query_params: query_params,
          operation_signing_strategy: operation_signing_strategy,
          body: post_body,
          return_type: 'Stream',
          &proc { |chunk, _response| opts[:response_target].write(chunk) }
        )
      elsif opts[:response_target].is_a?(String)
        File.open(opts[:response_target], 'wb') do |output|
          return @api_client.call_api(
            :POST,
            path,
            endpoint,
            header_params: header_params,
            query_params: query_params,
            operation_signing_strategy: operation_signing_strategy,
            body: post_body,
            return_type: 'Stream',
            &proc { |chunk, _response| output.write(chunk) }
          )
        end
      end
    else
      @api_client.call_api(
        :POST,
        path,
        endpoint,
        header_params: header_params,
        query_params: query_params,
        operation_signing_strategy: operation_signing_strategy,
        body: post_body,
        return_type: 'String'
      )
    end
  end
  # rubocop:enable Metrics/BlockLength
end

#download_privilege_script(opts = {}, &block) ⇒ Response

Note:

Click here to see an example of how to use download_privilege_script API.

Downloads the privilege script to grant/revoke required roles from the Data Safe account on the target database.

Parameters:

• opts (Hash) (defaults to: {}) —

  the optional parameters

• [Block] (Hash) —

  a customizable set of options

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :opc_retry_token (String) —

  A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

• :opc_request_id (String) —

  Unique identifier for the request.

• :if_match (String) —

  For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

• :response_target (String, IO) —

  Streaming http body into a file (specified by file name or File object) or IO object if the block is not given

Returns:

• (Response) —

  A Response object with data of type String if response_target and block are not given, otherwise with nil data

# File 'lib/oci/data_safe/data_safe_client.rb', line 5364

def download_privilege_script(opts = {}, &block)
  logger.debug 'Calling operation DataSafeClient#download_privilege_script.' if logger


  path = '/actions/downloadPrivilegeScript'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = opts[:accept] if opts[:accept]
  header_params[:accept] ||= 'application/octet-stream'
  header_params[:'accept-encoding'] = opts[:accept_encoding] if opts[:accept_encoding]
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#download_privilege_script') do
    if !block.nil?
      @api_client.call_api(
        :POST,
        path,
        endpoint,
        header_params: header_params,
        query_params: query_params,
        operation_signing_strategy: operation_signing_strategy,
        body: post_body,
        return_type: 'Stream',
        &block
      )
    elsif opts[:response_target]
      if opts[:response_target].respond_to? :write
        @api_client.call_api(
          :POST,
          path,
          endpoint,
          header_params: header_params,
          query_params: query_params,
          operation_signing_strategy: operation_signing_strategy,
          body: post_body,
          return_type: 'Stream',
          &proc { |chunk, _response| opts[:response_target].write(chunk) }
        )
      elsif opts[:response_target].is_a?(String)
        File.open(opts[:response_target], 'wb') do |output|
          return @api_client.call_api(
            :POST,
            path,
            endpoint,
            header_params: header_params,
            query_params: query_params,
            operation_signing_strategy: operation_signing_strategy,
            body: post_body,
            return_type: 'Stream',
            &proc { |chunk, _response| output.write(chunk) }
          )
        end
      end
    else
      @api_client.call_api(
        :POST,
        path,
        endpoint,
        header_params: header_params,
        query_params: query_params,
        operation_signing_strategy: operation_signing_strategy,
        body: post_body,
        return_type: 'String'
      )
    end
  end
  # rubocop:enable Metrics/BlockLength
end

#download_security_assessment_report(security_assessment_id, download_security_assessment_report_details, opts = {}, &block) ⇒ Response

Note:

Click here to see an example of how to use download_security_assessment_report API.

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

Parameters:

• security_assessment_id (String) —

  The OCID of the security assessment.

• download_security_assessment_report_details (OCI::DataSafe::Models::DownloadSecurityAssessmentReportDetails) —

  Details of the report.

• opts (Hash) (defaults to: {}) —

  the optional parameters

• [Block] (Hash) —

  a customizable set of options

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :if_match (String) —

  For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

• :opc_retry_token (String) —

  A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

• :opc_request_id (String) —

  Unique identifier for the request.

• :response_target (String, IO) —

  Streaming http body into a file (specified by file name or File object) or IO object if the block is not given

Returns:

• (Response) —

  A Response object with data of type String if response_target and block are not given, otherwise with nil data

# File 'lib/oci/data_safe/data_safe_client.rb', line 5479

def download_security_assessment_report(security_assessment_id, download_security_assessment_report_details, opts = {}, &block)
  logger.debug 'Calling operation DataSafeClient#download_security_assessment_report.' if logger

  raise "Missing the required parameter 'security_assessment_id' when calling download_security_assessment_report." if security_assessment_id.nil?
  raise "Missing the required parameter 'download_security_assessment_report_details' when calling download_security_assessment_report." if download_security_assessment_report_details.nil?
  raise "Parameter value for 'security_assessment_id' must not be blank" if OCI::Internal::Util.blank_string?(security_assessment_id)

  path = '/securityAssessments/{securityAssessmentId}/actions/downloadReport'.sub('{securityAssessmentId}', security_assessment_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = opts[:accept] if opts[:accept]
  header_params[:accept] ||= 'application/json'
  header_params[:'accept-encoding'] = opts[:accept_encoding] if opts[:accept_encoding]
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(download_security_assessment_report_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#download_security_assessment_report') do
    if !block.nil?
      @api_client.call_api(
        :POST,
        path,
        endpoint,
        header_params: header_params,
        query_params: query_params,
        operation_signing_strategy: operation_signing_strategy,
        body: post_body,
        return_type: 'Stream',
        &block
      )
    elsif opts[:response_target]
      if opts[:response_target].respond_to? :write
        @api_client.call_api(
          :POST,
          path,
          endpoint,
          header_params: header_params,
          query_params: query_params,
          operation_signing_strategy: operation_signing_strategy,
          body: post_body,
          return_type: 'Stream',
          &proc { |chunk, _response| opts[:response_target].write(chunk) }
        )
      elsif opts[:response_target].is_a?(String)
        File.open(opts[:response_target], 'wb') do |output|
          return @api_client.call_api(
            :POST,
            path,
            endpoint,
            header_params: header_params,
            query_params: query_params,
            operation_signing_strategy: operation_signing_strategy,
            body: post_body,
            return_type: 'Stream',
            &proc { |chunk, _response| output.write(chunk) }
          )
        end
      end
    else
      @api_client.call_api(
        :POST,
        path,
        endpoint,
        header_params: header_params,
        query_params: query_params,
        operation_signing_strategy: operation_signing_strategy,
        body: post_body,
        return_type: 'String'
      )
    end
  end
  # rubocop:enable Metrics/BlockLength
end

#download_sensitive_data_model(sensitive_data_model_id, download_sensitive_data_model_details, opts = {}, &block) ⇒ Response

Note:

Click here to see an example of how to use download_sensitive_data_model API.

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.

Parameters:

• sensitive_data_model_id (String) —

  The OCID of the sensitive data model.

• download_sensitive_data_model_details (OCI::DataSafe::Models::DownloadSensitiveDataModelDetails) —

  Details to download a sensitive data model file.

• opts (Hash) (defaults to: {}) —

  the optional parameters

• [Block] (Hash) —

  a customizable set of options

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :opc_request_id (String) —

  Unique identifier for the request.

• :response_target (String, IO) —

  Streaming http body into a file (specified by file name or File object) or IO object if the block is not given

Returns:

• (Response) —

  A Response object with data of type String if response_target and block are not given, otherwise with nil data

# File 'lib/oci/data_safe/data_safe_client.rb', line 5588

def download_sensitive_data_model(sensitive_data_model_id, download_sensitive_data_model_details, opts = {}, &block)
  logger.debug 'Calling operation DataSafeClient#download_sensitive_data_model.' if logger

  raise "Missing the required parameter 'sensitive_data_model_id' when calling download_sensitive_data_model." if sensitive_data_model_id.nil?
  raise "Missing the required parameter 'download_sensitive_data_model_details' when calling download_sensitive_data_model." if download_sensitive_data_model_details.nil?
  raise "Parameter value for 'sensitive_data_model_id' must not be blank" if OCI::Internal::Util.blank_string?(sensitive_data_model_id)

  path = '/sensitiveDataModels/{sensitiveDataModelId}/actions/download'.sub('{sensitiveDataModelId}', sensitive_data_model_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = opts[:accept] if opts[:accept]
  header_params[:accept] ||= 'application/octet-stream'
  header_params[:'accept-encoding'] = opts[:accept_encoding] if opts[:accept_encoding]
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(download_sensitive_data_model_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#download_sensitive_data_model') do
    if !block.nil?
      @api_client.call_api(
        :POST,
        path,
        endpoint,
        header_params: header_params,
        query_params: query_params,
        operation_signing_strategy: operation_signing_strategy,
        body: post_body,
        return_type: 'Stream',
        &block
      )
    elsif opts[:response_target]
      if opts[:response_target].respond_to? :write
        @api_client.call_api(
          :POST,
          path,
          endpoint,
          header_params: header_params,
          query_params: query_params,
          operation_signing_strategy: operation_signing_strategy,
          body: post_body,
          return_type: 'Stream',
          &proc { |chunk, _response| opts[:response_target].write(chunk) }
        )
      elsif opts[:response_target].is_a?(String)
        File.open(opts[:response_target], 'wb') do |output|
          return @api_client.call_api(
            :POST,
            path,
            endpoint,
            header_params: header_params,
            query_params: query_params,
            operation_signing_strategy: operation_signing_strategy,
            body: post_body,
            return_type: 'Stream',
            &proc { |chunk, _response| output.write(chunk) }
          )
        end
      end
    else
      @api_client.call_api(
        :POST,
        path,
        endpoint,
        header_params: header_params,
        query_params: query_params,
        operation_signing_strategy: operation_signing_strategy,
        body: post_body,
        return_type: 'String'
      )
    end
  end
  # rubocop:enable Metrics/BlockLength
end

#download_user_assessment_report(user_assessment_id, download_user_assessment_report_details, opts = {}, &block) ⇒ Response

Note:

Click here to see an example of how to use download_user_assessment_report API.

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

Parameters:

• user_assessment_id (String) —

  The OCID of the user assessment.

• download_user_assessment_report_details (OCI::DataSafe::Models::DownloadUserAssessmentReportDetails) —

  Details of the report.

• opts (Hash) (defaults to: {}) —

  the optional parameters

• [Block] (Hash) —

  a customizable set of options

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :if_match (String) —

  For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

• :opc_retry_token (String) —

  A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

• :opc_request_id (String) —

  Unique identifier for the request.

• :response_target (String, IO) —

  Streaming http body into a file (specified by file name or File object) or IO object if the block is not given

Returns:

• (Response) —

  A Response object with data of type String if response_target and block are not given, otherwise with nil data

# File 'lib/oci/data_safe/data_safe_client.rb', line 5703

def download_user_assessment_report(user_assessment_id, download_user_assessment_report_details, opts = {}, &block)
  logger.debug 'Calling operation DataSafeClient#download_user_assessment_report.' if logger

  raise "Missing the required parameter 'user_assessment_id' when calling download_user_assessment_report." if user_assessment_id.nil?
  raise "Missing the required parameter 'download_user_assessment_report_details' when calling download_user_assessment_report." if download_user_assessment_report_details.nil?
  raise "Parameter value for 'user_assessment_id' must not be blank" if OCI::Internal::Util.blank_string?(user_assessment_id)

  path = '/userAssessments/{userAssessmentId}/actions/downloadReport'.sub('{userAssessmentId}', user_assessment_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = opts[:accept] if opts[:accept]
  header_params[:accept] ||= 'application/json'
  header_params[:'accept-encoding'] = opts[:accept_encoding] if opts[:accept_encoding]
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(download_user_assessment_report_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#download_user_assessment_report') do
    if !block.nil?
      @api_client.call_api(
        :POST,
        path,
        endpoint,
        header_params: header_params,
        query_params: query_params,
        operation_signing_strategy: operation_signing_strategy,
        body: post_body,
        return_type: 'Stream',
        &block
      )
    elsif opts[:response_target]
      if opts[:response_target].respond_to? :write
        @api_client.call_api(
          :POST,
          path,
          endpoint,
          header_params: header_params,
          query_params: query_params,
          operation_signing_strategy: operation_signing_strategy,
          body: post_body,
          return_type: 'Stream',
          &proc { |chunk, _response| opts[:response_target].write(chunk) }
        )
      elsif opts[:response_target].is_a?(String)
        File.open(opts[:response_target], 'wb') do |output|
          return @api_client.call_api(
            :POST,
            path,
            endpoint,
            header_params: header_params,
            query_params: query_params,
            operation_signing_strategy: operation_signing_strategy,
            body: post_body,
            return_type: 'Stream',
            &proc { |chunk, _response| output.write(chunk) }
          )
        end
      end
    else
      @api_client.call_api(
        :POST,
        path,
        endpoint,
        header_params: header_params,
        query_params: query_params,
        operation_signing_strategy: operation_signing_strategy,
        body: post_body,
        return_type: 'String'
      )
    end
  end
  # rubocop:enable Metrics/BlockLength
end

#enable_data_safe_configuration(enable_data_safe_configuration_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use enable_data_safe_configuration API.

Enables Data Safe in the tenancy and region.

Parameters:

• enable_data_safe_configuration_details (OCI::DataSafe::Models::EnableDataSafeConfigurationDetails) —

  The details used to enable Data Safe.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :compartment_id (String) —

  A filter to return only resources that match the specified compartment OCID.

• :if_match (String) —

  For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

• :opc_request_id (String) —

  Unique identifier for the request.

Returns:

• (Response) —

  A Response object with data of type nil

# File 'lib/oci/data_safe/data_safe_client.rb', line 5813

def enable_data_safe_configuration(enable_data_safe_configuration_details, opts = {})
  logger.debug 'Calling operation DataSafeClient#enable_data_safe_configuration.' if logger

  raise "Missing the required parameter 'enable_data_safe_configuration_details' when calling enable_data_safe_configuration." if enable_data_safe_configuration_details.nil?

  path = '/configuration'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = opts[:compartment_id] if opts[:compartment_id]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(enable_data_safe_configuration_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#enable_data_safe_configuration') do
    @api_client.call_api(
      :PUT,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#generate_discovery_report_for_download(sensitive_data_model_id, generate_discovery_report_for_download_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use generate_discovery_report_for_download API.

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.

Parameters:

• sensitive_data_model_id (String) —

  The OCID of the sensitive data model.

• generate_discovery_report_for_download_details (OCI::DataSafe::Models::GenerateDiscoveryReportForDownloadDetails) —

  Details to generate a downloadable discovery report.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :opc_request_id (String) —

  Unique identifier for the request.

Returns:

• (Response) —

  A Response object with data of type nil

# File 'lib/oci/data_safe/data_safe_client.rb', line 5872

def generate_discovery_report_for_download(sensitive_data_model_id, generate_discovery_report_for_download_details, opts = {})
  logger.debug 'Calling operation DataSafeClient#generate_discovery_report_for_download.' if logger

  raise "Missing the required parameter 'sensitive_data_model_id' when calling generate_discovery_report_for_download." if sensitive_data_model_id.nil?
  raise "Missing the required parameter 'generate_discovery_report_for_download_details' when calling generate_discovery_report_for_download." if generate_discovery_report_for_download_details.nil?
  raise "Parameter value for 'sensitive_data_model_id' must not be blank" if OCI::Internal::Util.blank_string?(sensitive_data_model_id)

  path = '/sensitiveDataModels/{sensitiveDataModelId}/actions/generateReportForDownload'.sub('{sensitiveDataModelId}', sensitive_data_model_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(generate_discovery_report_for_download_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#generate_discovery_report_for_download') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#generate_masking_policy_for_download(masking_policy_id, generate_masking_policy_for_download_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use generate_masking_policy_for_download API.

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.

Parameters:

• masking_policy_id (String) —

  The OCID of the masking policy.

• generate_masking_policy_for_download_details (OCI::DataSafe::Models::GenerateMaskingPolicyForDownloadDetails) —

  Details to generate a masking policy file.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :opc_request_id (String) —

  Unique identifier for the request.

Returns:

• (Response) —

  A Response object with data of type nil

# File 'lib/oci/data_safe/data_safe_client.rb', line 5932

def generate_masking_policy_for_download(masking_policy_id, generate_masking_policy_for_download_details, opts = {})
  logger.debug 'Calling operation DataSafeClient#generate_masking_policy_for_download.' if logger

  raise "Missing the required parameter 'masking_policy_id' when calling generate_masking_policy_for_download." if masking_policy_id.nil?
  raise "Missing the required parameter 'generate_masking_policy_for_download_details' when calling generate_masking_policy_for_download." if generate_masking_policy_for_download_details.nil?
  raise "Parameter value for 'masking_policy_id' must not be blank" if OCI::Internal::Util.blank_string?(masking_policy_id)

  path = '/maskingPolicies/{maskingPolicyId}/actions/generatePolicyForDownload'.sub('{maskingPolicyId}', masking_policy_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(generate_masking_policy_for_download_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#generate_masking_policy_for_download') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#generate_masking_report_for_download(masking_policy_id, generate_masking_report_for_download_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use generate_masking_report_for_download API.

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.

Parameters:

• masking_policy_id (String) —

  The OCID of the masking policy.

• generate_masking_report_for_download_details (OCI::DataSafe::Models::GenerateMaskingReportForDownloadDetails) —

  Details to generate a downloadable masking report.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :opc_request_id (String) —

  Unique identifier for the request.

Returns:

• (Response) —

  A Response object with data of type nil

# File 'lib/oci/data_safe/data_safe_client.rb', line 5991

def generate_masking_report_for_download(masking_policy_id, generate_masking_report_for_download_details, opts = {})
  logger.debug 'Calling operation DataSafeClient#generate_masking_report_for_download.' if logger

  raise "Missing the required parameter 'masking_policy_id' when calling generate_masking_report_for_download." if masking_policy_id.nil?
  raise "Missing the required parameter 'generate_masking_report_for_download_details' when calling generate_masking_report_for_download." if generate_masking_report_for_download_details.nil?
  raise "Parameter value for 'masking_policy_id' must not be blank" if OCI::Internal::Util.blank_string?(masking_policy_id)

  path = '/maskingPolicies/{maskingPolicyId}/actions/generateReportForDownload'.sub('{maskingPolicyId}', masking_policy_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(generate_masking_report_for_download_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#generate_masking_report_for_download') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#generate_on_prem_connector_configuration(generate_on_prem_connector_configuration_details, on_prem_connector_id, opts = {}, &block) ⇒ Response

Note:

Click here to see an example of how to use generate_on_prem_connector_configuration API.

Creates and downloads the configuration of the specified on-premises connector.

Parameters:

• generate_on_prem_connector_configuration_details (OCI::DataSafe::Models::GenerateOnPremConnectorConfigurationDetails) —

  The details used to create and download on-premises connector's configuration.

• on_prem_connector_id (String) —

  The OCID of the on-premises connector.

• opts (Hash) (defaults to: {}) —

  the optional parameters

• [Block] (Hash) —

  a customizable set of options

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :opc_retry_token (String) —

  A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

• :opc_request_id (String) —

  Unique identifier for the request.

• :if_match (String) —

  For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

• :response_target (String, IO) —

  Streaming http body into a file (specified by file name or File object) or IO object if the block is not given

Returns:

• (Response) —

  A Response object with data of type String if response_target and block are not given, otherwise with nil data

# File 'lib/oci/data_safe/data_safe_client.rb', line 6060

def generate_on_prem_connector_configuration(generate_on_prem_connector_configuration_details, on_prem_connector_id, opts = {}, &block)
  logger.debug 'Calling operation DataSafeClient#generate_on_prem_connector_configuration.' if logger

  raise "Missing the required parameter 'generate_on_prem_connector_configuration_details' when calling generate_on_prem_connector_configuration." if generate_on_prem_connector_configuration_details.nil?
  raise "Missing the required parameter 'on_prem_connector_id' when calling generate_on_prem_connector_configuration." if on_prem_connector_id.nil?
  raise "Parameter value for 'on_prem_connector_id' must not be blank" if OCI::Internal::Util.blank_string?(on_prem_connector_id)

  path = '/onPremConnectors/{onPremConnectorId}/actions/generateConfiguration'.sub('{onPremConnectorId}', on_prem_connector_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = opts[:accept] if opts[:accept]
  header_params[:accept] ||= 'application/octet-stream'
  header_params[:'accept-encoding'] = opts[:accept_encoding] if opts[:accept_encoding]
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(generate_on_prem_connector_configuration_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#generate_on_prem_connector_configuration') do
    if !block.nil?
      @api_client.call_api(
        :POST,
        path,
        endpoint,
        header_params: header_params,
        query_params: query_params,
        operation_signing_strategy: operation_signing_strategy,
        body: post_body,
        return_type: 'Stream',
        &block
      )
    elsif opts[:response_target]
      if opts[:response_target].respond_to? :write
        @api_client.call_api(
          :POST,
          path,
          endpoint,
          header_params: header_params,
          query_params: query_params,
          operation_signing_strategy: operation_signing_strategy,
          body: post_body,
          return_type: 'Stream',
          &proc { |chunk, _response| opts[:response_target].write(chunk) }
        )
      elsif opts[:response_target].is_a?(String)
        File.open(opts[:response_target], 'wb') do |output|
          return @api_client.call_api(
            :POST,
            path,
            endpoint,
            header_params: header_params,
            query_params: query_params,
            operation_signing_strategy: operation_signing_strategy,
            body: post_body,
            return_type: 'Stream',
            &proc { |chunk, _response| output.write(chunk) }
          )
        end
      end
    else
      @api_client.call_api(
        :POST,
        path,
        endpoint,
        header_params: header_params,
        query_params: query_params,
        operation_signing_strategy: operation_signing_strategy,
        body: post_body,
        return_type: 'String'
      )
    end
  end
  # rubocop:enable Metrics/BlockLength
end

#generate_report(report_definition_id, generate_report_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use generate_report API.

Generates a PDF or XLS report based on parameters and report definition.

Parameters:

• report_definition_id (String) —

  Unique report definition identifier

• generate_report_details (OCI::DataSafe::Models::GenerateReportDetails) —

  Details for report generation. It contains details such as PDF/XLS and filter parameters like audit event time limits, number of rows and target databases etc

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :if_match (String) —

  For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

• :opc_request_id (String) —

  Unique identifier for the request.

• :opc_retry_token (String) —

  A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

• :scim_query (String) —

  The scimQuery query parameter accepts filter expressions that use the syntax described in Section 3.2.2.2 of the System for Cross-Domain Identity Management (SCIM) specification, which is available at RFC3339. In SCIM filtering expressions, text, date, and time values must be enclosed in quotation marks, with date and time values using ISO-8601 format. (Numeric and boolean values should not be quoted.)

  Example: query=(dateGenerated ge '2021-12-18T01-00-26') and (ilmTarget eq 'dscs-target')

Returns:

• (Response) —

  A Response object with data of type nil

# File 'lib/oci/data_safe/data_safe_client.rb', line 6182

def generate_report(report_definition_id, generate_report_details, opts = {})
  logger.debug 'Calling operation DataSafeClient#generate_report.' if logger

  raise "Missing the required parameter 'report_definition_id' when calling generate_report." if report_definition_id.nil?
  raise "Missing the required parameter 'generate_report_details' when calling generate_report." if generate_report_details.nil?
  raise "Parameter value for 'report_definition_id' must not be blank" if OCI::Internal::Util.blank_string?(report_definition_id)

  path = '/reportDefinitions/{reportDefinitionId}/actions/generateReport'.sub('{reportDefinitionId}', report_definition_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:scimQuery] = opts[:scim_query] if opts[:scim_query]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(generate_report_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#generate_report') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#generate_security_assessment_report(security_assessment_id, generate_security_assessment_report_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use generate_security_assessment_report API.

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.

Parameters:

• security_assessment_id (String) —

  The OCID of the security assessment.

• generate_security_assessment_report_details (OCI::DataSafe::Models::GenerateSecurityAssessmentReportDetails) —

  Details of the report.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :if_match (String) —

  For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

• :opc_retry_token (String) —

  A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

• :opc_request_id (String) —

  Unique identifier for the request.

Returns:

• (Response) —

  A Response object with data of type nil

# File 'lib/oci/data_safe/data_safe_client.rb', line 6254

def generate_security_assessment_report(security_assessment_id, generate_security_assessment_report_details, opts = {})
  logger.debug 'Calling operation DataSafeClient#generate_security_assessment_report.' if logger

  raise "Missing the required parameter 'security_assessment_id' when calling generate_security_assessment_report." if security_assessment_id.nil?
  raise "Missing the required parameter 'generate_security_assessment_report_details' when calling generate_security_assessment_report." if generate_security_assessment_report_details.nil?
  raise "Parameter value for 'security_assessment_id' must not be blank" if OCI::Internal::Util.blank_string?(security_assessment_id)

  path = '/securityAssessments/{securityAssessmentId}/actions/generateReport'.sub('{securityAssessmentId}', security_assessment_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(generate_security_assessment_report_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#generate_security_assessment_report') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#generate_sensitive_data_model_for_download(sensitive_data_model_id, generate_sensitive_data_model_for_download_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use generate_sensitive_data_model_for_download API.

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.

Parameters:

• sensitive_data_model_id (String) —

  The OCID of the sensitive data model.

• generate_sensitive_data_model_for_download_details (OCI::DataSafe::Models::GenerateSensitiveDataModelForDownloadDetails) —

  Details to generate a sensitive data model file.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :opc_request_id (String) —

  Unique identifier for the request.

Returns:

• (Response) —

  A Response object with data of type nil

# File 'lib/oci/data_safe/data_safe_client.rb', line 6316

def generate_sensitive_data_model_for_download(sensitive_data_model_id, generate_sensitive_data_model_for_download_details, opts = {})
  logger.debug 'Calling operation DataSafeClient#generate_sensitive_data_model_for_download.' if logger

  raise "Missing the required parameter 'sensitive_data_model_id' when calling generate_sensitive_data_model_for_download." if sensitive_data_model_id.nil?
  raise "Missing the required parameter 'generate_sensitive_data_model_for_download_details' when calling generate_sensitive_data_model_for_download." if generate_sensitive_data_model_for_download_details.nil?
  raise "Parameter value for 'sensitive_data_model_id' must not be blank" if OCI::Internal::Util.blank_string?(sensitive_data_model_id)

  path = '/sensitiveDataModels/{sensitiveDataModelId}/actions/generateDataModelForDownload'.sub('{sensitiveDataModelId}', sensitive_data_model_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(generate_sensitive_data_model_for_download_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#generate_sensitive_data_model_for_download') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#generate_sql_firewall_policy(sql_collection_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use generate_sql_firewall_policy API.

Generates or appends to the SQL firewall policy using the specified SQL collection.

Parameters:

• sql_collection_id (String) —

  The OCID of the SQL collection resource.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :if_match (String) —

  For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

• :opc_request_id (String) —

  Unique identifier for the request.

• :opc_retry_token (String) —

  A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

Returns:

• (Response) —

  A Response object with data of type nil

# File 'lib/oci/data_safe/data_safe_client.rb', line 6381

def generate_sql_firewall_policy(sql_collection_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#generate_sql_firewall_policy.' if logger

  raise "Missing the required parameter 'sql_collection_id' when calling generate_sql_firewall_policy." if sql_collection_id.nil?
  raise "Parameter value for 'sql_collection_id' must not be blank" if OCI::Internal::Util.blank_string?(sql_collection_id)

  path = '/sqlCollections/{sqlCollectionId}/actions/generateSqlFirewallPolicy'.sub('{sqlCollectionId}', sql_collection_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#generate_sql_firewall_policy') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#generate_user_assessment_report(user_assessment_id, generate_user_assessment_report_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use generate_user_assessment_report API.

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.

Parameters:

• user_assessment_id (String) —

  The OCID of the user assessment.

• generate_user_assessment_report_details (OCI::DataSafe::Models::GenerateUserAssessmentReportDetails) —

  Details of the report.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :if_match (String) —

  For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

• :opc_retry_token (String) —

  A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

• :opc_request_id (String) —

  Unique identifier for the request.

Returns:

• (Response) —

  A Response object with data of type nil

# File 'lib/oci/data_safe/data_safe_client.rb', line 6451

def generate_user_assessment_report(user_assessment_id, generate_user_assessment_report_details, opts = {})
  logger.debug 'Calling operation DataSafeClient#generate_user_assessment_report.' if logger

  raise "Missing the required parameter 'user_assessment_id' when calling generate_user_assessment_report." if user_assessment_id.nil?
  raise "Missing the required parameter 'generate_user_assessment_report_details' when calling generate_user_assessment_report." if generate_user_assessment_report_details.nil?
  raise "Parameter value for 'user_assessment_id' must not be blank" if OCI::Internal::Util.blank_string?(user_assessment_id)

  path = '/userAssessments/{userAssessmentId}/actions/generateReport'.sub('{userAssessmentId}', user_assessment_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(generate_user_assessment_report_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#generate_user_assessment_report') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_alert(alert_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_alert API.

Gets the details of the specified alerts.

Parameters:

• alert_id (String) —

  The OCID of alert.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :opc_request_id (String) —

  Unique identifier for the request.

Returns:

• (Response) —

  A Response object with data of type Alert

# File 'lib/oci/data_safe/data_safe_client.rb', line 6508

def get_alert(alert_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#get_alert.' if logger

  raise "Missing the required parameter 'alert_id' when calling get_alert." if alert_id.nil?
  raise "Parameter value for 'alert_id' must not be blank" if OCI::Internal::Util.blank_string?(alert_id)

  path = '/alerts/{alertId}'.sub('{alertId}', alert_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#get_alert') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataSafe::Models::Alert'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_alert_policy(alert_policy_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_alert_policy API.

Gets the details of alert policy by its ID.

Parameters:

• alert_policy_id (String) —

  The OCID of the alert policy.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :opc_request_id (String) —

  Unique identifier for the request.

Returns:

• (Response) —

  A Response object with data of type AlertPolicy

# File 'lib/oci/data_safe/data_safe_client.rb', line 6562

def get_alert_policy(alert_policy_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#get_alert_policy.' if logger

  raise "Missing the required parameter 'alert_policy_id' when calling get_alert_policy." if alert_policy_id.nil?
  raise "Parameter value for 'alert_policy_id' must not be blank" if OCI::Internal::Util.blank_string?(alert_policy_id)

  path = '/alertPolicies/{alertPolicyId}'.sub('{alertPolicyId}', alert_policy_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#get_alert_policy') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataSafe::Models::AlertPolicy'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_audit_archive_retrieval(audit_archive_retrieval_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_audit_archive_retrieval API.

Gets the details of the specified archive retreival.

Parameters:

• audit_archive_retrieval_id (String) —

  OCID of the archive retrieval.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :if_match (String) —

  For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

• :opc_request_id (String) —

  Unique identifier for the request.

Returns:

• (Response) —

  A Response object with data of type AuditArchiveRetrieval

# File 'lib/oci/data_safe/data_safe_client.rb', line 6622

def get_audit_archive_retrieval(audit_archive_retrieval_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#get_audit_archive_retrieval.' if logger

  raise "Missing the required parameter 'audit_archive_retrieval_id' when calling get_audit_archive_retrieval." if audit_archive_retrieval_id.nil?
  raise "Parameter value for 'audit_archive_retrieval_id' must not be blank" if OCI::Internal::Util.blank_string?(audit_archive_retrieval_id)

  path = '/auditArchiveRetrievals/{auditArchiveRetrievalId}'.sub('{auditArchiveRetrievalId}', audit_archive_retrieval_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#get_audit_archive_retrieval') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataSafe::Models::AuditArchiveRetrieval'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_audit_policy(audit_policy_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_audit_policy API.

Gets a audit policy by identifier.

Parameters:

• audit_policy_id (String) —

  Unique audit policy identifier.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :opc_request_id (String) —

  Unique identifier for the request.

Returns:

• (Response) —

  A Response object with data of type AuditPolicy

# File 'lib/oci/data_safe/data_safe_client.rb', line 6677

def get_audit_policy(audit_policy_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#get_audit_policy.' if logger

  raise "Missing the required parameter 'audit_policy_id' when calling get_audit_policy." if audit_policy_id.nil?
  raise "Parameter value for 'audit_policy_id' must not be blank" if OCI::Internal::Util.blank_string?(audit_policy_id)

  path = '/auditPolicies/{auditPolicyId}'.sub('{auditPolicyId}', audit_policy_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#get_audit_policy') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataSafe::Models::AuditPolicy'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_audit_profile(audit_profile_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_audit_profile API.

Gets the details of audit profile resource and associated audit trails of the audit profile.

Parameters:

• audit_profile_id (String) —

  The OCID of the audit.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :opc_request_id (String) —

  Unique identifier for the request.

Returns:

• (Response) —

  A Response object with data of type AuditProfile

# File 'lib/oci/data_safe/data_safe_client.rb', line 6731

def get_audit_profile(audit_profile_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#get_audit_profile.' if logger

  raise "Missing the required parameter 'audit_profile_id' when calling get_audit_profile." if audit_profile_id.nil?
  raise "Parameter value for 'audit_profile_id' must not be blank" if OCI::Internal::Util.blank_string?(audit_profile_id)

  path = '/auditProfiles/{auditProfileId}'.sub('{auditProfileId}', audit_profile_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#get_audit_profile') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataSafe::Models::AuditProfile'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_audit_trail(audit_trail_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_audit_trail API.

Gets the details of audit trail.

Parameters:

• audit_trail_id (String) —

  The OCID of the audit trail.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :opc_request_id (String) —

  Unique identifier for the request.

Returns:

• (Response) —

  A Response object with data of type AuditTrail

# File 'lib/oci/data_safe/data_safe_client.rb', line 6785

def get_audit_trail(audit_trail_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#get_audit_trail.' if logger

  raise "Missing the required parameter 'audit_trail_id' when calling get_audit_trail." if audit_trail_id.nil?
  raise "Parameter value for 'audit_trail_id' must not be blank" if OCI::Internal::Util.blank_string?(audit_trail_id)

  path = '/auditTrails/{auditTrailId}'.sub('{auditTrailId}', audit_trail_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#get_audit_trail') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataSafe::Models::AuditTrail'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_compatible_formats_for_data_types(opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_compatible_formats_for_data_types API.

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

Parameters:

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :limit (Integer) —

  For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

• :page (String) —

  For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

• :opc_request_id (String) —

  Unique identifier for the request.

Returns:

• (Response) —

  A Response object with data of type CompatibleFormatsForDataTypes

# File 'lib/oci/data_safe/data_safe_client.rb', line 6847

def get_compatible_formats_for_data_types(opts = {})
  logger.debug 'Calling operation DataSafeClient#get_compatible_formats_for_data_types.' if logger


  path = '/compatibleFormatsForDataTypes'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#get_compatible_formats_for_data_types') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataSafe::Models::CompatibleFormatsForDataTypes'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_compatible_formats_for_sensitive_types(compartment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_compatible_formats_for_sensitive_types API.

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.

Parameters:

• compartment_id (String) —

  A filter to return only resources that match the specified compartment OCID.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :compartment_id_in_subtree (BOOLEAN) —

  Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting. (default to false)

• :access_level (String) —

  Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed. (default to RESTRICTED) Allowed values are: RESTRICTED, ACCESSIBLE

• :limit (Integer) —

  For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

• :page (String) —

  For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

• :opc_request_id (String) —

  Unique identifier for the request.

Returns:

• (Response) —

  A Response object with data of type CompatibleFormatsForSensitiveTypes

# File 'lib/oci/data_safe/data_safe_client.rb', line 6916

def get_compatible_formats_for_sensitive_types(compartment_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#get_compatible_formats_for_sensitive_types.' if logger

  raise "Missing the required parameter 'compartment_id' when calling get_compatible_formats_for_sensitive_types." if compartment_id.nil?

  if opts[:access_level] && !%w[RESTRICTED ACCESSIBLE].include?(opts[:access_level])
    raise 'Invalid value for "access_level", must be one of RESTRICTED, ACCESSIBLE.'
  end

  path = '/compatibleFormatsForSensitiveTypes'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:compartmentIdInSubtree] = opts[:compartment_id_in_subtree] if !opts[:compartment_id_in_subtree].nil?
  query_params[:accessLevel] = opts[:access_level] if opts[:access_level]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#get_compatible_formats_for_sensitive_types') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataSafe::Models::CompatibleFormatsForSensitiveTypes'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_data_safe_configuration(opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_data_safe_configuration API.

Gets the details of the Data Safe configuration.

Parameters:

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :compartment_id (String) —

  A filter to return only resources that match the specified compartment OCID.

• :opc_request_id (String) —

  Unique identifier for the request.

Returns:

• (Response) —

  A Response object with data of type DataSafeConfiguration

# File 'lib/oci/data_safe/data_safe_client.rb', line 6978

def get_data_safe_configuration(opts = {})
  logger.debug 'Calling operation DataSafeClient#get_data_safe_configuration.' if logger


  path = '/configuration'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = opts[:compartment_id] if opts[:compartment_id]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#get_data_safe_configuration') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataSafe::Models::DataSafeConfiguration'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_data_safe_private_endpoint(data_safe_private_endpoint_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_data_safe_private_endpoint API.

Gets the details of the specified Data Safe private endpoint.

Parameters:

• data_safe_private_endpoint_id (String) —

  The OCID of the private endpoint.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :opc_request_id (String) —

  Unique identifier for the request.

Returns:

• (Response) —

  A Response object with data of type DataSafePrivateEndpoint

# File 'lib/oci/data_safe/data_safe_client.rb', line 7031

def get_data_safe_private_endpoint(data_safe_private_endpoint_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#get_data_safe_private_endpoint.' if logger

  raise "Missing the required parameter 'data_safe_private_endpoint_id' when calling get_data_safe_private_endpoint." if data_safe_private_endpoint_id.nil?
  raise "Parameter value for 'data_safe_private_endpoint_id' must not be blank" if OCI::Internal::Util.blank_string?(data_safe_private_endpoint_id)

  path = '/dataSafePrivateEndpoints/{dataSafePrivateEndpointId}'.sub('{dataSafePrivateEndpointId}', data_safe_private_endpoint_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#get_data_safe_private_endpoint') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataSafe::Models::DataSafePrivateEndpoint'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_database_security_config(database_security_config_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_database_security_config API.

Gets a database security configuration by identifier.

Parameters:

• database_security_config_id (String) —

  The OCID of the database security configuration resource.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :opc_request_id (String) —

  Unique identifier for the request.

Returns:

• (Response) —

  A Response object with data of type DatabaseSecurityConfig

# File 'lib/oci/data_safe/data_safe_client.rb', line 7085

def get_database_security_config(database_security_config_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#get_database_security_config.' if logger

  raise "Missing the required parameter 'database_security_config_id' when calling get_database_security_config." if database_security_config_id.nil?
  raise "Parameter value for 'database_security_config_id' must not be blank" if OCI::Internal::Util.blank_string?(database_security_config_id)

  path = '/databaseSecurityConfigs/{databaseSecurityConfigId}'.sub('{databaseSecurityConfigId}', database_security_config_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#get_database_security_config') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataSafe::Models::DatabaseSecurityConfig'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_difference_column(sdm_masking_policy_difference_id, difference_column_key, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_difference_column API.

Gets the details of the specified SDM Masking policy difference column.

Parameters:

• sdm_masking_policy_difference_id (String) —

  The OCID of the SDM masking policy difference.

• difference_column_key (String) —

  The unique key that identifies the difference column.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :opc_request_id (String) —

  Unique identifier for the request.

Returns:

• (Response) —

  A Response object with data of type DifferenceColumn

# File 'lib/oci/data_safe/data_safe_client.rb', line 7140

def get_difference_column(sdm_masking_policy_difference_id, difference_column_key, opts = {})
  logger.debug 'Calling operation DataSafeClient#get_difference_column.' if logger

  raise "Missing the required parameter 'sdm_masking_policy_difference_id' when calling get_difference_column." if sdm_masking_policy_difference_id.nil?
  raise "Missing the required parameter 'difference_column_key' when calling get_difference_column." if difference_column_key.nil?
  raise "Parameter value for 'sdm_masking_policy_difference_id' must not be blank" if OCI::Internal::Util.blank_string?(sdm_masking_policy_difference_id)
  raise "Parameter value for 'difference_column_key' must not be blank" if OCI::Internal::Util.blank_string?(difference_column_key)

  path = '/sdmMaskingPolicyDifferences/{sdmMaskingPolicyDifferenceId}/differenceColumns/{differenceColumnKey}'.sub('{sdmMaskingPolicyDifferenceId}', sdm_masking_policy_difference_id.to_s).sub('{differenceColumnKey}', difference_column_key.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#get_difference_column') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataSafe::Models::DifferenceColumn'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_discovery_job(discovery_job_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_discovery_job API.

Gets the details of the specified discovery job.

Parameters:

• discovery_job_id (String) —

  The OCID of the discovery job.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :opc_request_id (String) —

  Unique identifier for the request.

Returns:

• (Response) —

  A Response object with data of type DiscoveryJob

# File 'lib/oci/data_safe/data_safe_client.rb', line 7196

def get_discovery_job(discovery_job_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#get_discovery_job.' if logger

  raise "Missing the required parameter 'discovery_job_id' when calling get_discovery_job." if discovery_job_id.nil?
  raise "Parameter value for 'discovery_job_id' must not be blank" if OCI::Internal::Util.blank_string?(discovery_job_id)

  path = '/discoveryJobs/{discoveryJobId}'.sub('{discoveryJobId}', discovery_job_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#get_discovery_job') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataSafe::Models::DiscoveryJob'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_discovery_job_result(discovery_job_id, result_key, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_discovery_job_result API.

Gets the details of the specified discovery result.

Parameters:

• discovery_job_id (String) —

  The OCID of the discovery job.

• result_key (String) —

  The unique key that identifies the discovery result.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :opc_request_id (String) —

  Unique identifier for the request.

Returns:

• (Response) —

  A Response object with data of type DiscoveryJobResult

# File 'lib/oci/data_safe/data_safe_client.rb', line 7251

def get_discovery_job_result(discovery_job_id, result_key, opts = {})
  logger.debug 'Calling operation DataSafeClient#get_discovery_job_result.' if logger

  raise "Missing the required parameter 'discovery_job_id' when calling get_discovery_job_result." if discovery_job_id.nil?
  raise "Missing the required parameter 'result_key' when calling get_discovery_job_result." if result_key.nil?
  raise "Parameter value for 'discovery_job_id' must not be blank" if OCI::Internal::Util.blank_string?(discovery_job_id)
  raise "Parameter value for 'result_key' must not be blank" if OCI::Internal::Util.blank_string?(result_key)

  path = '/discoveryJobs/{discoveryJobId}/results/{resultKey}'.sub('{discoveryJobId}', discovery_job_id.to_s).sub('{resultKey}', result_key.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#get_discovery_job_result') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataSafe::Models::DiscoveryJobResult'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_library_masking_format(library_masking_format_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_library_masking_format API.

Gets the details of the specified library masking format.

Parameters:

• library_masking_format_id (String) —

  The OCID of the library masking format.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :opc_request_id (String) —

  Unique identifier for the request.

Returns:

• (Response) —

  A Response object with data of type LibraryMaskingFormat

# File 'lib/oci/data_safe/data_safe_client.rb', line 7307

def get_library_masking_format(library_masking_format_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#get_library_masking_format.' if logger

  raise "Missing the required parameter 'library_masking_format_id' when calling get_library_masking_format." if library_masking_format_id.nil?
  raise "Parameter value for 'library_masking_format_id' must not be blank" if OCI::Internal::Util.blank_string?(library_masking_format_id)

  path = '/libraryMaskingFormats/{libraryMaskingFormatId}'.sub('{libraryMaskingFormatId}', library_masking_format_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#get_library_masking_format') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataSafe::Models::LibraryMaskingFormat'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_masking_column(masking_policy_id, masking_column_key, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_masking_column API.

Gets the details of the specified masking column.

Parameters:

• masking_policy_id (String) —

  The OCID of the masking policy.

• masking_column_key (String) —

  The unique key that identifies the masking column. It's numeric and unique within a masking policy.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :opc_request_id (String) —

  Unique identifier for the request.

Returns:

• (Response) —

  A Response object with data of type MaskingColumn

# File 'lib/oci/data_safe/data_safe_client.rb', line 7362

def get_masking_column(masking_policy_id, masking_column_key, opts = {})
  logger.debug 'Calling operation DataSafeClient#get_masking_column.' if logger

  raise "Missing the required parameter 'masking_policy_id' when calling get_masking_column." if masking_policy_id.nil?
  raise "Missing the required parameter 'masking_column_key' when calling get_masking_column." if masking_column_key.nil?
  raise "Parameter value for 'masking_policy_id' must not be blank" if OCI::Internal::Util.blank_string?(masking_policy_id)
  raise "Parameter value for 'masking_column_key' must not be blank" if OCI::Internal::Util.blank_string?(masking_column_key)

  path = '/maskingPolicies/{maskingPolicyId}/maskingColumns/{maskingColumnKey}'.sub('{maskingPolicyId}', masking_policy_id.to_s).sub('{maskingColumnKey}', masking_column_key.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#get_masking_column') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataSafe::Models::MaskingColumn'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_masking_policy(masking_policy_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_masking_policy API.

Gets the details of the specified masking policy.

Parameters:

• masking_policy_id (String) —

  The OCID of the masking policy.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :opc_request_id (String) —

  Unique identifier for the request.

Returns:

• (Response) —

  A Response object with data of type MaskingPolicy

# File 'lib/oci/data_safe/data_safe_client.rb', line 7418

def get_masking_policy(masking_policy_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#get_masking_policy.' if logger

  raise "Missing the required parameter 'masking_policy_id' when calling get_masking_policy." if masking_policy_id.nil?
  raise "Parameter value for 'masking_policy_id' must not be blank" if OCI::Internal::Util.blank_string?(masking_policy_id)

  path = '/maskingPolicies/{maskingPolicyId}'.sub('{maskingPolicyId}', masking_policy_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#get_masking_policy') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataSafe::Models::MaskingPolicy'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_masking_report(masking_report_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_masking_report API.

Gets the details of the specified masking report.

Parameters:

• masking_report_id (String) —

  The OCID of the masking report.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :opc_request_id (String) —

  Unique identifier for the request.

Returns:

• (Response) —

  A Response object with data of type MaskingReport

# File 'lib/oci/data_safe/data_safe_client.rb', line 7472

def get_masking_report(masking_report_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#get_masking_report.' if logger

  raise "Missing the required parameter 'masking_report_id' when calling get_masking_report." if masking_report_id.nil?
  raise "Parameter value for 'masking_report_id' must not be blank" if OCI::Internal::Util.blank_string?(masking_report_id)

  path = '/maskingReports/{maskingReportId}'.sub('{maskingReportId}', masking_report_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#get_masking_report') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataSafe::Models::MaskingReport'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_on_prem_connector(on_prem_connector_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_on_prem_connector API.

Gets the details of the specified on-premises connector.

Parameters:

• on_prem_connector_id (String) —

  The OCID of the on-premises connector.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :opc_request_id (String) —

  Unique identifier for the request.

Returns:

• (Response) —

  A Response object with data of type OnPremConnector

# File 'lib/oci/data_safe/data_safe_client.rb', line 7526

def get_on_prem_connector(on_prem_connector_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#get_on_prem_connector.' if logger

  raise "Missing the required parameter 'on_prem_connector_id' when calling get_on_prem_connector." if on_prem_connector_id.nil?
  raise "Parameter value for 'on_prem_connector_id' must not be blank" if OCI::Internal::Util.blank_string?(on_prem_connector_id)

  path = '/onPremConnectors/{onPremConnectorId}'.sub('{onPremConnectorId}', on_prem_connector_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#get_on_prem_connector') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataSafe::Models::OnPremConnector'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_profile(user_assessment_id, profile_name, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_profile API.

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.

Parameters:

• user_assessment_id (String) —

  The OCID of the user assessment.

• profile_name (String) —

  Profile name to get detailed information .

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :opc_request_id (String) —

  Unique identifier for the request.

Returns:

• (Response) —

  A Response object with data of type Array<Profile>

# File 'lib/oci/data_safe/data_safe_client.rb', line 7585

def get_profile(user_assessment_id, profile_name, opts = {})
  logger.debug 'Calling operation DataSafeClient#get_profile.' if logger

  raise "Missing the required parameter 'user_assessment_id' when calling get_profile." if user_assessment_id.nil?
  raise "Missing the required parameter 'profile_name' when calling get_profile." if profile_name.nil?
  raise "Parameter value for 'user_assessment_id' must not be blank" if OCI::Internal::Util.blank_string?(user_assessment_id)
  raise "Parameter value for 'profile_name' must not be blank" if OCI::Internal::Util.blank_string?(profile_name)

  path = '/userAssessments/{userAssessmentId}/profiles/{profileName}'.sub('{userAssessmentId}', user_assessment_id.to_s).sub('{profileName}', profile_name.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#get_profile') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'Array<OCI::DataSafe::Models::Profile>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_report(report_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_report API.

Gets a report by identifier

Parameters:

• report_id (String) —

  Unique report identifier

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :opc_request_id (String) —

  Unique identifier for the request.

Returns:

• (Response) —

  A Response object with data of type Report

# File 'lib/oci/data_safe/data_safe_client.rb', line 7641

def get_report(report_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#get_report.' if logger

  raise "Missing the required parameter 'report_id' when calling get_report." if report_id.nil?
  raise "Parameter value for 'report_id' must not be blank" if OCI::Internal::Util.blank_string?(report_id)

  path = '/reports/{reportId}'.sub('{reportId}', report_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#get_report') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataSafe::Models::Report'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_report_content(report_id, opts = {}, &block) ⇒ Response

Note:

Click here to see an example of how to use get_report_content API.

Downloads the specified report in the form of PDF or XLXS.

Parameters:

• report_id (String) —

  Unique report identifier

• opts (Hash) (defaults to: {}) —

  the optional parameters

• [Block] (Hash) —

  a customizable set of options

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :opc_request_id (String) —

  Unique identifier for the request.

• :response_target (String, IO) —

  Streaming http body into a file (specified by file name or File object) or IO object if the block is not given

Returns:

• (Response) —

  A Response object with data of type String if response_target and block are not given, otherwise with nil data

# File 'lib/oci/data_safe/data_safe_client.rb', line 7697

def get_report_content(report_id, opts = {}, &block)
  logger.debug 'Calling operation DataSafeClient#get_report_content.' if logger

  raise "Missing the required parameter 'report_id' when calling get_report_content." if report_id.nil?
  raise "Parameter value for 'report_id' must not be blank" if OCI::Internal::Util.blank_string?(report_id)

  path = '/reports/{reportId}/content'.sub('{reportId}', report_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = opts[:accept] if opts[:accept]
  header_params[:accept] ||= 'application/json'
  header_params[:'accept-encoding'] = opts[:accept_encoding] if opts[:accept_encoding]
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#get_report_content') do
    if !block.nil?
      @api_client.call_api(
        :GET,
        path,
        endpoint,
        header_params: header_params,
        query_params: query_params,
        operation_signing_strategy: operation_signing_strategy,
        body: post_body,
        return_type: 'Stream',
        &block
      )
    elsif opts[:response_target]
      if opts[:response_target].respond_to? :write
        @api_client.call_api(
          :GET,
          path,
          endpoint,
          header_params: header_params,
          query_params: query_params,
          operation_signing_strategy: operation_signing_strategy,
          body: post_body,
          return_type: 'Stream',
          &proc { |chunk, _response| opts[:response_target].write(chunk) }
        )
      elsif opts[:response_target].is_a?(String)
        File.open(opts[:response_target], 'wb') do |output|
          return @api_client.call_api(
            :GET,
            path,
            endpoint,
            header_params: header_params,
            query_params: query_params,
            operation_signing_strategy: operation_signing_strategy,
            body: post_body,
            return_type: 'Stream',
            &proc { |chunk, _response| output.write(chunk) }
          )
        end
      end
    else
      @api_client.call_api(
        :GET,
        path,
        endpoint,
        header_params: header_params,
        query_params: query_params,
        operation_signing_strategy: operation_signing_strategy,
        body: post_body,
        return_type: 'String'
      )
    end
  end
  # rubocop:enable Metrics/BlockLength
end

#get_report_definition(report_definition_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_report_definition API.

Gets the details of report definition specified by the identifier

Parameters:

• report_definition_id (String) —

  Unique report definition identifier

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :opc_request_id (String) —

  Unique identifier for the request.

Returns:

• (Response) —

  A Response object with data of type ReportDefinition

# File 'lib/oci/data_safe/data_safe_client.rb', line 7795

def get_report_definition(report_definition_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#get_report_definition.' if logger

  raise "Missing the required parameter 'report_definition_id' when calling get_report_definition." if report_definition_id.nil?
  raise "Parameter value for 'report_definition_id' must not be blank" if OCI::Internal::Util.blank_string?(report_definition_id)

  path = '/reportDefinitions/{reportDefinitionId}'.sub('{reportDefinitionId}', report_definition_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#get_report_definition') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataSafe::Models::ReportDefinition'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_sdm_masking_policy_difference(sdm_masking_policy_difference_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_sdm_masking_policy_difference API.

Gets the details of the specified SDM Masking policy difference.

Parameters:

• sdm_masking_policy_difference_id (String) —

  The OCID of the SDM masking policy difference.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :opc_request_id (String) —

  Unique identifier for the request.

Returns:

• (Response) —

  A Response object with data of type SdmMaskingPolicyDifference

# File 'lib/oci/data_safe/data_safe_client.rb', line 7849

def get_sdm_masking_policy_difference(sdm_masking_policy_difference_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#get_sdm_masking_policy_difference.' if logger

  raise "Missing the required parameter 'sdm_masking_policy_difference_id' when calling get_sdm_masking_policy_difference." if sdm_masking_policy_difference_id.nil?
  raise "Parameter value for 'sdm_masking_policy_difference_id' must not be blank" if OCI::Internal::Util.blank_string?(sdm_masking_policy_difference_id)

  path = '/sdmMaskingPolicyDifferences/{sdmMaskingPolicyDifferenceId}'.sub('{sdmMaskingPolicyDifferenceId}', sdm_masking_policy_difference_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#get_sdm_masking_policy_difference') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataSafe::Models::SdmMaskingPolicyDifference'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_security_assessment(security_assessment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_security_assessment API.

Gets the details of the specified security assessment.

Parameters:

• security_assessment_id (String) —

  The OCID of the security assessment.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :opc_request_id (String) —

  Unique identifier for the request.

Returns:

• (Response) —

  A Response object with data of type SecurityAssessment

# File 'lib/oci/data_safe/data_safe_client.rb', line 7903

def get_security_assessment(security_assessment_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#get_security_assessment.' if logger

  raise "Missing the required parameter 'security_assessment_id' when calling get_security_assessment." if security_assessment_id.nil?
  raise "Parameter value for 'security_assessment_id' must not be blank" if OCI::Internal::Util.blank_string?(security_assessment_id)

  path = '/securityAssessments/{securityAssessmentId}'.sub('{securityAssessmentId}', security_assessment_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#get_security_assessment') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataSafe::Models::SecurityAssessment'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_security_assessment_comparison(security_assessment_id, comparison_security_assessment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_security_assessment_comparison API.

Gets the details of the comparison report for the security assessments submitted for comparison.

Parameters:

• security_assessment_id (String) —

  The OCID of the security assessment.

• comparison_security_assessment_id (String) —

  The OCID of the security assessment baseline.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :opc_request_id (String) —

  Unique identifier for the request.

Returns:

• (Response) —

  A Response object with data of type SecurityAssessmentComparison

# File 'lib/oci/data_safe/data_safe_client.rb', line 7958

def get_security_assessment_comparison(security_assessment_id, comparison_security_assessment_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#get_security_assessment_comparison.' if logger

  raise "Missing the required parameter 'security_assessment_id' when calling get_security_assessment_comparison." if security_assessment_id.nil?
  raise "Missing the required parameter 'comparison_security_assessment_id' when calling get_security_assessment_comparison." if comparison_security_assessment_id.nil?
  raise "Parameter value for 'security_assessment_id' must not be blank" if OCI::Internal::Util.blank_string?(security_assessment_id)
  raise "Parameter value for 'comparison_security_assessment_id' must not be blank" if OCI::Internal::Util.blank_string?(comparison_security_assessment_id)

  path = '/securityAssessments/{securityAssessmentId}/comparison/{comparisonSecurityAssessmentId}'.sub('{securityAssessmentId}', security_assessment_id.to_s).sub('{comparisonSecurityAssessmentId}', comparison_security_assessment_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#get_security_assessment_comparison') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataSafe::Models::SecurityAssessmentComparison'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_security_policy(security_policy_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_security_policy API.

Gets a security policy by the specified OCID of the security policy resource.

Parameters:

• security_policy_id (String) —

  The OCID of the security policy resource.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :opc_request_id (String) —

  Unique identifier for the request.

Returns:

• (Response) —

  A Response object with data of type SecurityPolicy

# File 'lib/oci/data_safe/data_safe_client.rb', line 8014

def get_security_policy(security_policy_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#get_security_policy.' if logger

  raise "Missing the required parameter 'security_policy_id' when calling get_security_policy." if security_policy_id.nil?
  raise "Parameter value for 'security_policy_id' must not be blank" if OCI::Internal::Util.blank_string?(security_policy_id)

  path = '/securityPolicies/{securityPolicyId}'.sub('{securityPolicyId}', security_policy_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#get_security_policy') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataSafe::Models::SecurityPolicy'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_security_policy_deployment(security_policy_deployment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_security_policy_deployment API.

Gets a security policy deployment by identifier.

Parameters:

• security_policy_deployment_id (String) —

  The OCID of the security policy deployment resource.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :opc_request_id (String) —

  Unique identifier for the request.

Returns:

• (Response) —

  A Response object with data of type SecurityPolicyDeployment

# File 'lib/oci/data_safe/data_safe_client.rb', line 8068

def get_security_policy_deployment(security_policy_deployment_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#get_security_policy_deployment.' if logger

  raise "Missing the required parameter 'security_policy_deployment_id' when calling get_security_policy_deployment." if security_policy_deployment_id.nil?
  raise "Parameter value for 'security_policy_deployment_id' must not be blank" if OCI::Internal::Util.blank_string?(security_policy_deployment_id)

  path = '/securityPolicyDeployments/{securityPolicyDeploymentId}'.sub('{securityPolicyDeploymentId}', security_policy_deployment_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#get_security_policy_deployment') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataSafe::Models::SecurityPolicyDeployment'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_security_policy_entry_state(security_policy_deployment_id, security_policy_entry_state_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_security_policy_entry_state API.

Gets a security policy entity states by identifier.

Parameters:

• security_policy_deployment_id (String) —

  The OCID of the security policy deployment resource.

• security_policy_entry_state_id (String) —

  Unique security policy entry state identifier. The unique id for a given security policy entry state can be obtained from the list api by passing the OCID of the corresponding security policy deployment resource as the query parameter.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :opc_request_id (String) —

  Unique identifier for the request.

Returns:

• (Response) —

  A Response object with data of type SecurityPolicyEntryState

# File 'lib/oci/data_safe/data_safe_client.rb', line 8127

def get_security_policy_entry_state(security_policy_deployment_id, security_policy_entry_state_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#get_security_policy_entry_state.' if logger

  raise "Missing the required parameter 'security_policy_deployment_id' when calling get_security_policy_entry_state." if security_policy_deployment_id.nil?
  raise "Missing the required parameter 'security_policy_entry_state_id' when calling get_security_policy_entry_state." if security_policy_entry_state_id.nil?
  raise "Parameter value for 'security_policy_deployment_id' must not be blank" if OCI::Internal::Util.blank_string?(security_policy_deployment_id)
  raise "Parameter value for 'security_policy_entry_state_id' must not be blank" if OCI::Internal::Util.blank_string?(security_policy_entry_state_id)

  path = '/securityPolicyDeployments/{securityPolicyDeploymentId}/securityPolicyEntryStates/{securityPolicyEntryStateId}'.sub('{securityPolicyDeploymentId}', security_policy_deployment_id.to_s).sub('{securityPolicyEntryStateId}', security_policy_entry_state_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#get_security_policy_entry_state') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataSafe::Models::SecurityPolicyEntryState'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_sensitive_column(sensitive_data_model_id, sensitive_column_key, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_sensitive_column API.

Gets the details of the specified sensitive column.

Parameters:

• sensitive_data_model_id (String) —

  The OCID of the sensitive data model.

• sensitive_column_key (String) —

  The unique key that identifies the sensitive column. It's numeric and unique within a sensitive data model.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :opc_request_id (String) —

  Unique identifier for the request.

Returns:

• (Response) —

  A Response object with data of type SensitiveColumn

# File 'lib/oci/data_safe/data_safe_client.rb', line 8184

def get_sensitive_column(sensitive_data_model_id, sensitive_column_key, opts = {})
  logger.debug 'Calling operation DataSafeClient#get_sensitive_column.' if logger

  raise "Missing the required parameter 'sensitive_data_model_id' when calling get_sensitive_column." if sensitive_data_model_id.nil?
  raise "Missing the required parameter 'sensitive_column_key' when calling get_sensitive_column." if sensitive_column_key.nil?
  raise "Parameter value for 'sensitive_data_model_id' must not be blank" if OCI::Internal::Util.blank_string?(sensitive_data_model_id)
  raise "Parameter value for 'sensitive_column_key' must not be blank" if OCI::Internal::Util.blank_string?(sensitive_column_key)

  path = '/sensitiveDataModels/{sensitiveDataModelId}/sensitiveColumns/{sensitiveColumnKey}'.sub('{sensitiveDataModelId}', sensitive_data_model_id.to_s).sub('{sensitiveColumnKey}', sensitive_column_key.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#get_sensitive_column') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataSafe::Models::SensitiveColumn'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_sensitive_data_model(sensitive_data_model_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_sensitive_data_model API.

Gets the details of the specified sensitive data model.

Parameters:

• sensitive_data_model_id (String) —

  The OCID of the sensitive data model.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :opc_request_id (String) —

  Unique identifier for the request.

Returns:

• (Response) —

  A Response object with data of type SensitiveDataModel

# File 'lib/oci/data_safe/data_safe_client.rb', line 8240

def get_sensitive_data_model(sensitive_data_model_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#get_sensitive_data_model.' if logger

  raise "Missing the required parameter 'sensitive_data_model_id' when calling get_sensitive_data_model." if sensitive_data_model_id.nil?
  raise "Parameter value for 'sensitive_data_model_id' must not be blank" if OCI::Internal::Util.blank_string?(sensitive_data_model_id)

  path = '/sensitiveDataModels/{sensitiveDataModelId}'.sub('{sensitiveDataModelId}', sensitive_data_model_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#get_sensitive_data_model') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataSafe::Models::SensitiveDataModel'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_sensitive_type(sensitive_type_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_sensitive_type API.

Gets the details of the specified sensitive type.

Parameters:

• sensitive_type_id (String) —

  The OCID of the sensitive type.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :opc_request_id (String) —

  Unique identifier for the request.

Returns:

• (Response) —

  A Response object with data of type SensitiveType

# File 'lib/oci/data_safe/data_safe_client.rb', line 8294

def get_sensitive_type(sensitive_type_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#get_sensitive_type.' if logger

  raise "Missing the required parameter 'sensitive_type_id' when calling get_sensitive_type." if sensitive_type_id.nil?
  raise "Parameter value for 'sensitive_type_id' must not be blank" if OCI::Internal::Util.blank_string?(sensitive_type_id)

  path = '/sensitiveTypes/{sensitiveTypeId}'.sub('{sensitiveTypeId}', sensitive_type_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#get_sensitive_type') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataSafe::Models::SensitiveType'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_sql_collection(sql_collection_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_sql_collection API.

Gets a SQL collection by identifier.

Parameters:

• sql_collection_id (String) —

  The OCID of the SQL collection resource.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :opc_request_id (String) —

  Unique identifier for the request.

Returns:

• (Response) —

  A Response object with data of type SqlCollection

# File 'lib/oci/data_safe/data_safe_client.rb', line 8348

def get_sql_collection(sql_collection_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#get_sql_collection.' if logger

  raise "Missing the required parameter 'sql_collection_id' when calling get_sql_collection." if sql_collection_id.nil?
  raise "Parameter value for 'sql_collection_id' must not be blank" if OCI::Internal::Util.blank_string?(sql_collection_id)

  path = '/sqlCollections/{sqlCollectionId}'.sub('{sqlCollectionId}', sql_collection_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#get_sql_collection') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataSafe::Models::SqlCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_sql_firewall_policy(sql_firewall_policy_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_sql_firewall_policy API.

Gets a SQL firewall policy by identifier.

Parameters:

• sql_firewall_policy_id (String) —

  The OCID of the SQL firewall policy resource.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :opc_request_id (String) —

  Unique identifier for the request.

Returns:

• (Response) —

  A Response object with data of type SqlFirewallPolicy

# File 'lib/oci/data_safe/data_safe_client.rb', line 8402

def get_sql_firewall_policy(sql_firewall_policy_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#get_sql_firewall_policy.' if logger

  raise "Missing the required parameter 'sql_firewall_policy_id' when calling get_sql_firewall_policy." if sql_firewall_policy_id.nil?
  raise "Parameter value for 'sql_firewall_policy_id' must not be blank" if OCI::Internal::Util.blank_string?(sql_firewall_policy_id)

  path = '/sqlFirewallPolicies/{sqlFirewallPolicyId}'.sub('{sqlFirewallPolicyId}', sql_firewall_policy_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#get_sql_firewall_policy') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataSafe::Models::SqlFirewallPolicy'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_target_alert_policy_association(target_alert_policy_association_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_target_alert_policy_association API.

Gets the details of target-alert policy association by its ID.

Parameters:

• target_alert_policy_association_id (String) —

  The OCID of the target-alert policy association.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :opc_request_id (String) —

  Unique identifier for the request.

Returns:

• (Response) —

  A Response object with data of type TargetAlertPolicyAssociation

# File 'lib/oci/data_safe/data_safe_client.rb', line 8456

def get_target_alert_policy_association(target_alert_policy_association_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#get_target_alert_policy_association.' if logger

  raise "Missing the required parameter 'target_alert_policy_association_id' when calling get_target_alert_policy_association." if target_alert_policy_association_id.nil?
  raise "Parameter value for 'target_alert_policy_association_id' must not be blank" if OCI::Internal::Util.blank_string?(target_alert_policy_association_id)

  path = '/targetAlertPolicyAssociations/{targetAlertPolicyAssociationId}'.sub('{targetAlertPolicyAssociationId}', target_alert_policy_association_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#get_target_alert_policy_association') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataSafe::Models::TargetAlertPolicyAssociation'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_target_database(target_database_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_target_database API.

Returns the details of the specified Data Safe target database.

Parameters:

• target_database_id (String) —

  The OCID of the Data Safe target database.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :opc_request_id (String) —

  Unique identifier for the request.

Returns:

• (Response) —

  A Response object with data of type TargetDatabase

# File 'lib/oci/data_safe/data_safe_client.rb', line 8511

def get_target_database(target_database_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#get_target_database.' if logger

  raise "Missing the required parameter 'target_database_id' when calling get_target_database." if target_database_id.nil?
  raise "Parameter value for 'target_database_id' must not be blank" if OCI::Internal::Util.blank_string?(target_database_id)

  path = '/targetDatabases/{targetDatabaseId}'.sub('{targetDatabaseId}', target_database_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#get_target_database') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataSafe::Models::TargetDatabase'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_user_assessment(user_assessment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_user_assessment API.

Gets a user assessment by identifier.

Parameters:

• user_assessment_id (String) —

  The OCID of the user assessment.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :opc_request_id (String) —

  Unique identifier for the request.

Returns:

• (Response) —

  A Response object with data of type UserAssessment

# File 'lib/oci/data_safe/data_safe_client.rb', line 8565

def get_user_assessment(user_assessment_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#get_user_assessment.' if logger

  raise "Missing the required parameter 'user_assessment_id' when calling get_user_assessment." if user_assessment_id.nil?
  raise "Parameter value for 'user_assessment_id' must not be blank" if OCI::Internal::Util.blank_string?(user_assessment_id)

  path = '/userAssessments/{userAssessmentId}'.sub('{userAssessmentId}', user_assessment_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#get_user_assessment') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataSafe::Models::UserAssessment'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_user_assessment_comparison(user_assessment_id, comparison_user_assessment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_user_assessment_comparison API.

Gets the details of the comparison report for the user assessments submitted for comparison.

Parameters:

• user_assessment_id (String) —

  The OCID of the user assessment.

• comparison_user_assessment_id (String) —

  The OCID of the baseline user assessment.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :opc_request_id (String) —

  Unique identifier for the request.

Returns:

• (Response) —

  A Response object with data of type UserAssessmentComparison

# File 'lib/oci/data_safe/data_safe_client.rb', line 8620

def get_user_assessment_comparison(user_assessment_id, comparison_user_assessment_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#get_user_assessment_comparison.' if logger

  raise "Missing the required parameter 'user_assessment_id' when calling get_user_assessment_comparison." if user_assessment_id.nil?
  raise "Missing the required parameter 'comparison_user_assessment_id' when calling get_user_assessment_comparison." if comparison_user_assessment_id.nil?
  raise "Parameter value for 'user_assessment_id' must not be blank" if OCI::Internal::Util.blank_string?(user_assessment_id)
  raise "Parameter value for 'comparison_user_assessment_id' must not be blank" if OCI::Internal::Util.blank_string?(comparison_user_assessment_id)

  path = '/userAssessments/{userAssessmentId}/comparison/{comparisonUserAssessmentId}'.sub('{userAssessmentId}', user_assessment_id.to_s).sub('{comparisonUserAssessmentId}', comparison_user_assessment_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#get_user_assessment_comparison') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataSafe::Models::UserAssessmentComparison'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_work_request(work_request_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_work_request API.

Gets the details of the specified work request.

Parameters:

• work_request_id (String) —

  The OCID of the work request.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :opc_request_id (String) —

  Unique identifier for the request.

Returns:

• (Response) —

  A Response object with data of type WorkRequest

# File 'lib/oci/data_safe/data_safe_client.rb', line 8676

def get_work_request(work_request_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#get_work_request.' if logger

  raise "Missing the required parameter 'work_request_id' when calling get_work_request." if work_request_id.nil?
  raise "Parameter value for 'work_request_id' must not be blank" if OCI::Internal::Util.blank_string?(work_request_id)

  path = '/workRequests/{workRequestId}'.sub('{workRequestId}', work_request_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#get_work_request') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataSafe::Models::WorkRequest'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_alert_analytics(compartment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_alert_analytics API.

Returns the aggregation details of the alerts.

Allowed values are: displayName, timeCreated

Parameters:

• compartment_id (String) —

  A filter to return only resources that match the specified compartment OCID.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :compartment_id_in_subtree (BOOLEAN) —

  Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting. (default to false)

• :limit (Integer) —

  For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

• :page (String) —

  For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

• :opc_request_id (String) —

  Unique identifier for the request.

• :if_match (String) —

  For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

• :time_started (DateTime) —

  An optional filter to return audit events whose creation time in the database is greater than and equal to the date-time specified, in the format defined by RFC3339.

• :time_ended (DateTime) —

  An optional filter to return audit events whose creation time in the database is less than and equal to the date-time specified, in the format defined by RFC3339.

• :query_time_zone (String) —

  Default time zone is UTC if no time zone provided. The date-time considerations of the resource will be in accordance with the specified time zone. (default to UTC)

• :sort_order (String) —

  The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

• :sort_by (String) —

  The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. If no value is specified timeCreated is default. (default to timeCreated)

• :access_level (String) —

  Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed. (default to RESTRICTED) Allowed values are: RESTRICTED, ACCESSIBLE

• :scim_query (String) —

  The scimQuery query parameter accepts filter expressions that use the syntax described in Section 3.2.2.2 of the System for Cross-Domain Identity Management (SCIM) specification, which is available at RFC3339. In SCIM filtering expressions, text, date, and time values must be enclosed in quotation marks, with date and time values using ISO-8601 format. (Numeric and boolean values should not be quoted.)

  Example: | query=(timeCreated ge '2021-06-04T01-00-26') and (targetNames eq 'target_1') query=(featureDetails.userName eq "user") and (targetNames eq "target_1") Supported fields: severity status alertType targetIds targetNames operationTime lifecycleState displayName timeCreated timeUpdated featureDetails.* (* can be any field in nestedStrMap in Feature Attributes in Alert Summary. For example - userName,object,clientHostname,osUserName,clientIPs,clientId,commandText,commandParam,clientProgram,objectType,targetOwner)

• :summary_field (Array<String>) —

  Specifies a subset of summarized fields to be returned in the response. Allowed values are: alertType, targetIds, targetNames, alertSeverity, alertStatus, timeCreated, policyId, open, closed, critical, high, medium, low, alertcount

• :group_by (Array<String>) —

  A groupBy can only be used in combination with summaryField parameter. A groupBy value has to be a subset of the values mentioned in summaryField parameter.

  Allowed values are: alertType, targetIds, targetNames, alertSeverity, alertStatus, timeCreated, policyId

• :opc_retry_token (String) —

  A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

Returns:

• (Response) —

  A Response object with data of type AlertAnalyticsCollection

# File 'lib/oci/data_safe/data_safe_client.rb', line 8795

def list_alert_analytics(compartment_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#list_alert_analytics.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_alert_analytics." if compartment_id.nil?

  if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of ASC, DESC.'
  end

  if opts[:sort_by] && !%w[displayName timeCreated].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of displayName, timeCreated.'
  end

  if opts[:access_level] && !%w[RESTRICTED ACCESSIBLE].include?(opts[:access_level])
    raise 'Invalid value for "access_level", must be one of RESTRICTED, ACCESSIBLE.'
  end


  summary_field_allowable_values = %w[alertType targetIds targetNames alertSeverity alertStatus timeCreated policyId open closed critical high medium low alertcount]
  if opts[:summary_field] && !opts[:summary_field].empty?
    opts[:summary_field].each do |val_to_check|
      unless summary_field_allowable_values.include?(val_to_check)
        raise 'Invalid value for "summary_field", must be one of alertType, targetIds, targetNames, alertSeverity, alertStatus, timeCreated, policyId, open, closed, critical, high, medium, low, alertcount.'
      end
    end
  end


  group_by_allowable_values = %w[alertType targetIds targetNames alertSeverity alertStatus timeCreated policyId]
  if opts[:group_by] && !opts[:group_by].empty?
    opts[:group_by].each do |val_to_check|
      unless group_by_allowable_values.include?(val_to_check)
        raise 'Invalid value for "group_by", must be one of alertType, targetIds, targetNames, alertSeverity, alertStatus, timeCreated, policyId.'
      end
    end
  end

  path = '/alertAnalytics'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:compartmentIdInSubtree] = opts[:compartment_id_in_subtree] if !opts[:compartment_id_in_subtree].nil?
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:timeStarted] = opts[:time_started] if opts[:time_started]
  query_params[:timeEnded] = opts[:time_ended] if opts[:time_ended]
  query_params[:queryTimeZone] = opts[:query_time_zone] if opts[:query_time_zone]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:accessLevel] = opts[:access_level] if opts[:access_level]
  query_params[:scimQuery] = opts[:scim_query] if opts[:scim_query]
  query_params[:summaryField] = OCI::ApiClient.build_collection_params(opts[:summary_field], :multi) if opts[:summary_field] && !opts[:summary_field].empty?
  query_params[:groupBy] = OCI::ApiClient.build_collection_params(opts[:group_by], :multi) if opts[:group_by] && !opts[:group_by].empty?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#list_alert_analytics') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataSafe::Models::AlertAnalyticsCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_alert_policies(compartment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_alert_policies API.

Gets a list of all alert policies.

Allowed values are: displayName, timeCreated

Parameters:

• compartment_id (String) —

  A filter to return only resources that match the specified compartment OCID.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :alert_policy_id (String) —

  A filter to return policy by it's OCID.

• :type (String) —

  An optional filter to return only alert policies of a certain type.

• :is_user_defined (BOOLEAN) —

  An optional filter to return only alert policies that are user-defined or not. (default to false)

• :display_name (String) —

  A filter to return only resources that match the specified display name.

• :lifecycle_state (String) —

  An optional filter to return only alert policies that have the given life-cycle state.

• :limit (Integer) —

  For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

• :page (String) —

  For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

• :sort_order (String) —

  The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

• :sort_by (String) —

  The field to sort by. Only one sort parameter may be provided. (default to timeCreated)

• :opc_request_id (String) —

  Unique identifier for the request.

• :time_created_greater_than_or_equal_to (DateTime) —

  A filter to return only the resources that were created after the specified date and time, as defined by RFC3339. Using TimeCreatedGreaterThanOrEqualToQueryParam parameter retrieves all resources created after that date.

  Example: 2016-12-19T16:39:57.600Z

• :time_created_less_than (DateTime) —

  Search for resources that were created before a specific date. Specifying this parameter corresponding timeCreatedLessThan parameter will retrieve all resources created before the specified created date, in "YYYY-MM-ddThh:mmZ" format with a Z offset, as defined by RFC 3339.

  Example: 2016-12-19T16:39:57.600Z

• :compartment_id_in_subtree (BOOLEAN) —

  Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting. (default to false)

• :access_level (String) —

  Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed. (default to RESTRICTED) Allowed values are: RESTRICTED, ACCESSIBLE

Returns:

• (Response) —

  A Response object with data of type AlertPolicyCollection

# File 'lib/oci/data_safe/data_safe_client.rb', line 8932

def list_alert_policies(compartment_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#list_alert_policies.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_alert_policies." if compartment_id.nil?

  if opts[:type] && !OCI::DataSafe::Models::ALERT_POLICY_TYPE_ENUM.include?(opts[:type])
    raise 'Invalid value for "type", must be one of the values in OCI::DataSafe::Models::ALERT_POLICY_TYPE_ENUM.'
  end

  if opts[:lifecycle_state] && !OCI::DataSafe::Models::ALERT_POLICY_LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::DataSafe::Models::ALERT_POLICY_LIFECYCLE_STATE_ENUM.'
  end

  if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of ASC, DESC.'
  end

  if opts[:sort_by] && !%w[displayName timeCreated].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of displayName, timeCreated.'
  end

  if opts[:access_level] && !%w[RESTRICTED ACCESSIBLE].include?(opts[:access_level])
    raise 'Invalid value for "access_level", must be one of RESTRICTED, ACCESSIBLE.'
  end

  path = '/alertPolicies'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:alertPolicyId] = opts[:alert_policy_id] if opts[:alert_policy_id]
  query_params[:type] = opts[:type] if opts[:type]
  query_params[:isUserDefined] = opts[:is_user_defined] if !opts[:is_user_defined].nil?
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:timeCreatedGreaterThanOrEqualTo] = opts[:time_created_greater_than_or_equal_to] if opts[:time_created_greater_than_or_equal_to]
  query_params[:timeCreatedLessThan] = opts[:time_created_less_than] if opts[:time_created_less_than]
  query_params[:compartmentIdInSubtree] = opts[:compartment_id_in_subtree] if !opts[:compartment_id_in_subtree].nil?
  query_params[:accessLevel] = opts[:access_level] if opts[:access_level]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#list_alert_policies') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataSafe::Models::AlertPolicyCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_alert_policy_rules(alert_policy_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_alert_policy_rules API.

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.

Parameters:

• alert_policy_id (String) —

  The OCID of the alert policy.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :opc_request_id (String) —

  Unique identifier for the request.

• :limit (Integer) —

  For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

• :page (String) —

  For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

Returns:

• (Response) —

  A Response object with data of type AlertPolicyRuleCollection

# File 'lib/oci/data_safe/data_safe_client.rb', line 9023

def list_alert_policy_rules(alert_policy_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#list_alert_policy_rules.' if logger

  raise "Missing the required parameter 'alert_policy_id' when calling list_alert_policy_rules." if alert_policy_id.nil?
  raise "Parameter value for 'alert_policy_id' must not be blank" if OCI::Internal::Util.blank_string?(alert_policy_id)

  path = '/alertPolicies/{alertPolicyId}/rules'.sub('{alertPolicyId}', alert_policy_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#list_alert_policy_rules') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataSafe::Models::AlertPolicyRuleCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_alerts(compartment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_alerts API.

Gets a list of all alerts.

Allowed values are: displayName, timeCreated

Parameters:

• compartment_id (String) —

  A filter to return only resources that match the specified compartment OCID.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :id (String) —

  A filter to return alert by it's OCID.

• :compartment_id_in_subtree (BOOLEAN) —

  Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting. (default to false)

• :limit (Integer) —

  For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

• :page (String) —

  For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

• :opc_request_id (String) —

  Unique identifier for the request.

• :access_level (String) —

  Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed. (default to RESTRICTED) Allowed values are: RESTRICTED, ACCESSIBLE

• :sort_order (String) —

  The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

• :sort_by (String) —

  The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. If no value is specified timeCreated is default. (default to timeCreated)

• :scim_query (String) —

  The scimQuery query parameter accepts filter expressions that use the syntax described in Section 3.2.2.2 of the System for Cross-Domain Identity Management (SCIM) specification, which is available at RFC3339. In SCIM filtering expressions, text, date, and time values must be enclosed in quotation marks, with date and time values using ISO-8601 format. (Numeric and boolean values should not be quoted.)

  Example: | query=(timeCreated ge '2021-06-04T01-00-26') and (targetNames eq 'target_1') query=(featureDetails.userName eq "user") and (targetNames eq "target_1") Supported fields: severity status alertType targetIds targetNames operationTime lifecycleState displayName timeCreated timeUpdated featureDetails.* (* can be any field in nestedStrMap in Feature Attributes in Alert Summary. For example - userName,object,clientHostname,osUserName,clientIPs,clientId,commandText,commandParam,clientProgram,objectType,targetOwner)

• :field (Array<String>) —

  Specifies a subset of fields to be returned in the response. Allowed values are: id, displayName, alertType, targetIds, targetNames, severity, status, operationTime, operation, operationStatus, timeCreated, timeUpdated, policyId, lifecycleState

Returns:

• (Response) —

  A Response object with data of type AlertCollection

# File 'lib/oci/data_safe/data_safe_client.rb', line 9122

def list_alerts(compartment_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#list_alerts.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_alerts." if compartment_id.nil?

  if opts[:access_level] && !%w[RESTRICTED ACCESSIBLE].include?(opts[:access_level])
    raise 'Invalid value for "access_level", must be one of RESTRICTED, ACCESSIBLE.'
  end

  if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of ASC, DESC.'
  end

  if opts[:sort_by] && !%w[displayName timeCreated].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of displayName, timeCreated.'
  end


  field_allowable_values = %w[id displayName alertType targetIds targetNames severity status operationTime operation operationStatus timeCreated timeUpdated policyId lifecycleState]
  if opts[:field] && !opts[:field].empty?
    opts[:field].each do |val_to_check|
      unless field_allowable_values.include?(val_to_check)
        raise 'Invalid value for "field", must be one of id, displayName, alertType, targetIds, targetNames, severity, status, operationTime, operation, operationStatus, timeCreated, timeUpdated, policyId, lifecycleState.'
      end
    end
  end

  path = '/alerts'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:id] = opts[:id] if opts[:id]
  query_params[:compartmentIdInSubtree] = opts[:compartment_id_in_subtree] if !opts[:compartment_id_in_subtree].nil?
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:accessLevel] = opts[:access_level] if opts[:access_level]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:scimQuery] = opts[:scim_query] if opts[:scim_query]
  query_params[:field] = OCI::ApiClient.build_collection_params(opts[:field], :multi) if opts[:field] && !opts[:field].empty?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#list_alerts') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataSafe::Models::AlertCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_audit_archive_retrievals(compartment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_audit_archive_retrievals API.

Returns the list of audit archive retrieval.

Parameters:

• compartment_id (String) —

  A filter to return only resources that match the specified compartment OCID.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :display_name (String) —

  A filter to return only resources that match the specified display name.

• :compartment_id_in_subtree (BOOLEAN) —

  Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting. (default to false)

• :access_level (String) —

  Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed. (default to RESTRICTED) Allowed values are: RESTRICTED, ACCESSIBLE

• :audit_archive_retrieval_id (String) —

  OCID of the archive retrieval.

• :target_id (String) —

  The OCID of the target associated with the archive retrieval.

• :limit (Integer) —

  For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

• :page (String) —

  For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

• :lifecycle_state (String) —

  A filter to return only resources that matches the specified lifecycle state.

• :time_of_expiry (DateTime) —

  The date time when retrieved archive data will be deleted from Data Safe and unloaded back into archival.

• :sort_order (String) —

  The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

• :sort_by (String) —

  The field used for sorting. Only one sorting order (sortOrder) can be specified. The default order for TIMECREATED is descending. The default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. (default to TIMECREATED) Allowed values are: TIMECREATED, DISPLAYNAME

• :opc_request_id (String) —

  Unique identifier for the request.

Returns:

• (Response) —

  A Response object with data of type AuditArchiveRetrievalCollection

# File 'lib/oci/data_safe/data_safe_client.rb', line 9232

def list_audit_archive_retrievals(compartment_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#list_audit_archive_retrievals.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_audit_archive_retrievals." if compartment_id.nil?

  if opts[:access_level] && !%w[RESTRICTED ACCESSIBLE].include?(opts[:access_level])
    raise 'Invalid value for "access_level", must be one of RESTRICTED, ACCESSIBLE.'
  end

  if opts[:lifecycle_state] && !OCI::DataSafe::Models::AUDIT_ARCHIVE_RETRIEVAL_LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::DataSafe::Models::AUDIT_ARCHIVE_RETRIEVAL_LIFECYCLE_STATE_ENUM.'
  end

  if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of ASC, DESC.'
  end

  if opts[:sort_by] && !%w[TIMECREATED DISPLAYNAME].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of TIMECREATED, DISPLAYNAME.'
  end

  path = '/auditArchiveRetrievals'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:compartmentIdInSubtree] = opts[:compartment_id_in_subtree] if !opts[:compartment_id_in_subtree].nil?
  query_params[:accessLevel] = opts[:access_level] if opts[:access_level]
  query_params[:auditArchiveRetrievalId] = opts[:audit_archive_retrieval_id] if opts[:audit_archive_retrieval_id]
  query_params[:targetId] = opts[:target_id] if opts[:target_id]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:timeOfExpiry] = opts[:time_of_expiry] if opts[:time_of_expiry]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#list_audit_archive_retrievals') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataSafe::Models::AuditArchiveRetrievalCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_audit_event_analytics(compartment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_audit_event_analytics API.

By default the ListAuditEventAnalytics operation will return all of the summary columns. To filter for a specific summary column, specify it in the summaryField query parameter.

Example: /ListAuditEventAnalytics?summaryField=targetName&summaryField=userName&summaryField=clientHostname &summaryField=dmls&summaryField=privilegeChanges&summaryField=ddls&summaryField=loginFailure&summaryField=loginSuccess &summaryField=allRecord&q=(auditEventTime ge "2021-06-13T23:49:14")

/ListAuditEventAnalytics?timeStarted=2022-08-18T11:02:26.000Z&timeEnded=2022-08-24T11:02:26.000Z This will give number of events grouped by periods. Period can be 1 day, 1 week, etc.

/ListAuditEventAnalytics?summaryField=targetName&groupBy=targetName This will give the number of events group by targetName. Only targetName summary column would be returned.

Parameters:

• compartment_id (String) —

  A filter to return only resources that match the specified compartment OCID.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :opc_request_id (String) —

  Unique identifier for the request.

• :if_match (String) —

  For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

• :limit (Integer) —

  For details about how pagination works, see List Pagination.

• :page (String) —

  It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

• :compartment_id_in_subtree (BOOLEAN) —

  Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting. (default to false)

• :access_level (String) —

  Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed. (default to RESTRICTED) Allowed values are: RESTRICTED, ACCESSIBLE

• :scim_query (String) —

  The scimQuery query parameter accepts filter expressions that use the syntax described in Section 3.2.2.2 of the System for Cross-Domain Identity Management (SCIM) specification, which is available at RFC3339. In SCIM filtering expressions, text, date, and time values must be enclosed in quotation marks, with date and time values using ISO-8601 format. (Numeric and boolean values should not be quoted.)

  Example: query=(operationTime ge '2021-06-04T01-00-26') and (eventName eq 'LOGON')

• :summary_field (Array<String>) —

  Specifies a subset of summarized fields to be returned in the response. Allowed values are: auditEventTime, dbUserName, targetId, targetName, targetClass, objectType, clientHostname, clientProgram, clientId, auditType, eventName, allRecord, auditSettingsChange, dbSchemaChange, entitlementChange, loginFailure, loginSuccess, allViolations, realmViolations, ruleViolations, dvconfigActivities, ddls, dmls, privilegeChanges, auditSettingsEnables, auditSettingsDisables, selects, creates, alters, drops, grants, revokes

• :time_started (DateTime) —

  An optional filter to return audit events whose creation time in the database is greater than and equal to the date-time specified, in the format defined by RFC3339.

• :time_ended (DateTime) —

  An optional filter to return audit events whose creation time in the database is less than and equal to the date-time specified, in the format defined by RFC3339.

• :query_time_zone (String) —

  Default time zone is UTC if no time zone provided. The date-time considerations of the resource will be in accordance with the specified time zone. (default to UTC)

• :group_by (Array<String>) —

  A groupBy can only be used in combination with summaryField parameter. A groupBy value has to be a subset of the values mentioned in summaryField parameter.

  Allowed values are: auditEventTime, dbUserName, targetId, targetName, targetClass, objectType, clientHostname, clientProgram, clientId, auditType, eventName

• :opc_retry_token (String) —

  A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

• :sort_order (String) —

  The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

• :sort_by (String) —

  If this query parameter is specified, the result is ordered based on this query parameter value. Allowed values are: targetId, targetClass, targetName, objectType, dbUserName, eventName, auditEventTime, clientHostname, clientProgram, clientId, auditType

Returns:

• (Response) —

  A Response object with data of type AuditEventAnalyticsCollection

# File 'lib/oci/data_safe/data_safe_client.rb', line 9377

def list_audit_event_analytics(compartment_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#list_audit_event_analytics.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_audit_event_analytics." if compartment_id.nil?

  if opts[:access_level] && !%w[RESTRICTED ACCESSIBLE].include?(opts[:access_level])
    raise 'Invalid value for "access_level", must be one of RESTRICTED, ACCESSIBLE.'
  end


  summary_field_allowable_values = %w[auditEventTime dbUserName targetId targetName targetClass objectType clientHostname clientProgram clientId auditType eventName allRecord auditSettingsChange dbSchemaChange entitlementChange loginFailure loginSuccess allViolations realmViolations ruleViolations dvconfigActivities ddls dmls privilegeChanges auditSettingsEnables auditSettingsDisables selects creates alters drops grants revokes]
  if opts[:summary_field] && !opts[:summary_field].empty?
    opts[:summary_field].each do |val_to_check|
      unless summary_field_allowable_values.include?(val_to_check)
        raise 'Invalid value for "summary_field", must be one of auditEventTime, dbUserName, targetId, targetName, targetClass, objectType, clientHostname, clientProgram, clientId, auditType, eventName, allRecord, auditSettingsChange, dbSchemaChange, entitlementChange, loginFailure, loginSuccess, allViolations, realmViolations, ruleViolations, dvconfigActivities, ddls, dmls, privilegeChanges, auditSettingsEnables, auditSettingsDisables, selects, creates, alters, drops, grants, revokes.'
      end
    end
  end


  group_by_allowable_values = %w[auditEventTime dbUserName targetId targetName targetClass objectType clientHostname clientProgram clientId auditType eventName]
  if opts[:group_by] && !opts[:group_by].empty?
    opts[:group_by].each do |val_to_check|
      unless group_by_allowable_values.include?(val_to_check)
        raise 'Invalid value for "group_by", must be one of auditEventTime, dbUserName, targetId, targetName, targetClass, objectType, clientHostname, clientProgram, clientId, auditType, eventName.'
      end
    end
  end

  if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of ASC, DESC.'
  end

  if opts[:sort_by] && !%w[targetId targetClass targetName objectType dbUserName eventName auditEventTime clientHostname clientProgram clientId auditType].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of targetId, targetClass, targetName, objectType, dbUserName, eventName, auditEventTime, clientHostname, clientProgram, clientId, auditType.'
  end

  path = '/auditEventAnalytics'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:compartmentIdInSubtree] = opts[:compartment_id_in_subtree] if !opts[:compartment_id_in_subtree].nil?
  query_params[:accessLevel] = opts[:access_level] if opts[:access_level]
  query_params[:scimQuery] = opts[:scim_query] if opts[:scim_query]
  query_params[:summaryField] = OCI::ApiClient.build_collection_params(opts[:summary_field], :multi) if opts[:summary_field] && !opts[:summary_field].empty?
  query_params[:timeStarted] = opts[:time_started] if opts[:time_started]
  query_params[:timeEnded] = opts[:time_ended] if opts[:time_ended]
  query_params[:queryTimeZone] = opts[:query_time_zone] if opts[:query_time_zone]
  query_params[:groupBy] = OCI::ApiClient.build_collection_params(opts[:group_by], :multi) if opts[:group_by] && !opts[:group_by].empty?
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#list_audit_event_analytics') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataSafe::Models::AuditEventAnalyticsCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_audit_events(compartment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_audit_events API.

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.

Allowed values are: dbUserName, targetName, databaseType, targetClass, auditEventTime, timeCollected, osUserName, operation, operationStatus, eventName, errorCode, errorMessage, objectType, objectName, objectOwner, clientHostname, clientIp, isAlerted, actionTaken, clientProgram, commandText, commandParam, extendedEventAttributes, auditLocation, osTerminal, clientId, auditPolicies, auditType

Parameters:

• compartment_id (String) —

  A filter to return only resources that match the specified compartment OCID.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :opc_request_id (String) —

  Unique identifier for the request.

• :compartment_id_in_subtree (BOOLEAN) —

  Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting. (default to false)

• :access_level (String) —

  Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed. (default to RESTRICTED) Allowed values are: RESTRICTED, ACCESSIBLE

• :limit (Integer) —

  For details about how pagination works, see List Pagination.

• :page (String) —

  It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

• :scim_query (String) —

  The scimQuery query parameter accepts filter expressions that use the syntax described in Section 3.2.2.2 of the System for Cross-Domain Identity Management (SCIM) specification, which is available at RFC3339. In SCIM filtering expressions, text, date, and time values must be enclosed in quotation marks, with date and time values using ISO-8601 format. (Numeric and boolean values should not be quoted.)

  Example: query=(operationTime ge '2021-06-04T01-00-26') and (eventName eq 'LOGON')

• :sort_order (String) —

  The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

• :sort_by (String) —

  If this query parameter is specified, the result is sorted by this query parameter value. (default to auditEventTime)

Returns:

• (Response) —

  A Response object with data of type AuditEventCollection

# File 'lib/oci/data_safe/data_safe_client.rb', line 9518

def list_audit_events(compartment_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#list_audit_events.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_audit_events." if compartment_id.nil?

  if opts[:access_level] && !%w[RESTRICTED ACCESSIBLE].include?(opts[:access_level])
    raise 'Invalid value for "access_level", must be one of RESTRICTED, ACCESSIBLE.'
  end

  if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of ASC, DESC.'
  end

  if opts[:sort_by] && !%w[dbUserName targetName databaseType targetClass auditEventTime timeCollected osUserName operation operationStatus eventName errorCode errorMessage objectType objectName objectOwner clientHostname clientIp isAlerted actionTaken clientProgram commandText commandParam extendedEventAttributes auditLocation osTerminal clientId auditPolicies auditType].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of dbUserName, targetName, databaseType, targetClass, auditEventTime, timeCollected, osUserName, operation, operationStatus, eventName, errorCode, errorMessage, objectType, objectName, objectOwner, clientHostname, clientIp, isAlerted, actionTaken, clientProgram, commandText, commandParam, extendedEventAttributes, auditLocation, osTerminal, clientId, auditPolicies, auditType.'
  end

  path = '/auditEvents'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:compartmentIdInSubtree] = opts[:compartment_id_in_subtree] if !opts[:compartment_id_in_subtree].nil?
  query_params[:accessLevel] = opts[:access_level] if opts[:access_level]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:scimQuery] = opts[:scim_query] if opts[:scim_query]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json, application/xml'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#list_audit_events') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataSafe::Models::AuditEventCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_audit_policies(compartment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_audit_policies API.

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.

Parameters:

• compartment_id (String) —

  A filter to return only resources that match the specified compartment OCID.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :compartment_id_in_subtree (BOOLEAN) —

  Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting. (default to false)

• :access_level (String) —

  Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed. (default to RESTRICTED) Allowed values are: RESTRICTED, ACCESSIBLE

• :display_name (String) —

  A filter to return only resources that match the specified display name.

• :limit (Integer) —

  For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

• :page (String) —

  For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

• :target_id (String) —

  A filter to return only items related to a specific target OCID.

• :lifecycle_state (String) —

  The current state of the audit policy.

• :audit_policy_id (String) —

  An optional filter to return only resources that match the specified id.

• :sort_order (String) —

  The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

• :sort_by (String) —

  The field used for sorting. Only one sorting order (sortOrder) can be specified. The default order for TIMECREATED is descending. The default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. (default to TIMECREATED) Allowed values are: TIMECREATED, DISPLAYNAME

• :opc_request_id (String) —

  Unique identifier for the request.

Returns:

• (Response) —

  A Response object with data of type AuditPolicyCollection

# File 'lib/oci/data_safe/data_safe_client.rb', line 9629

def list_audit_policies(compartment_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#list_audit_policies.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_audit_policies." if compartment_id.nil?

  if opts[:access_level] && !%w[RESTRICTED ACCESSIBLE].include?(opts[:access_level])
    raise 'Invalid value for "access_level", must be one of RESTRICTED, ACCESSIBLE.'
  end

  if opts[:lifecycle_state] && !OCI::DataSafe::Models::AUDIT_POLICY_LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::DataSafe::Models::AUDIT_POLICY_LIFECYCLE_STATE_ENUM.'
  end

  if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of ASC, DESC.'
  end

  if opts[:sort_by] && !%w[TIMECREATED DISPLAYNAME].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of TIMECREATED, DISPLAYNAME.'
  end

  path = '/auditPolicies'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:compartmentIdInSubtree] = opts[:compartment_id_in_subtree] if !opts[:compartment_id_in_subtree].nil?
  query_params[:accessLevel] = opts[:access_level] if opts[:access_level]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:targetId] = opts[:target_id] if opts[:target_id]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:auditPolicyId] = opts[:audit_policy_id] if opts[:audit_policy_id]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#list_audit_policies') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataSafe::Models::AuditPolicyCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_audit_policy_analytics(compartment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_audit_policy_analytics API.

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

Parameters:

• compartment_id (String) —

  A filter to return only resources that match the specified compartment OCID.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :compartment_id_in_subtree (BOOLEAN) —

  Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting. (default to false)

• :access_level (String) —

  Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed. (default to RESTRICTED) Allowed values are: RESTRICTED, ACCESSIBLE

• :limit (Integer) —

  For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

• :page (String) —

  For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

• :group_by (Array<String>) —

  The group by parameter to summarize audit policy aggregation. Allowed values are: auditPolicyCategory, auditPolicyName, targetId

• :audit_policy_category (String) —

  The category to which the audit policy belongs to.

• :audit_policy_name (String) —

  In case of seeded policies, it is the policy name defined by Data Safe. In case of custom Policies, it is the policy name that is used to create the policies on the target database. In case of Oracle Pre-seeded policies, it is the default policy name of the same.

• :target_id (String) —

  A filter to return only items related to a specific target OCID.

• :lifecycle_state (String) —

  The current state of the audit policy.

• :opc_request_id (String) —

  Unique identifier for the request.

Returns:

• (Response) —

  A Response object with data of type AuditPolicyAnalyticCollection

# File 'lib/oci/data_safe/data_safe_client.rb', line 9745

def list_audit_policy_analytics(compartment_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#list_audit_policy_analytics.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_audit_policy_analytics." if compartment_id.nil?

  if opts[:access_level] && !%w[RESTRICTED ACCESSIBLE].include?(opts[:access_level])
    raise 'Invalid value for "access_level", must be one of RESTRICTED, ACCESSIBLE.'
  end


  group_by_allowable_values = %w[auditPolicyCategory auditPolicyName targetId]
  if opts[:group_by] && !opts[:group_by].empty?
    opts[:group_by].each do |val_to_check|
      unless group_by_allowable_values.include?(val_to_check)
        raise 'Invalid value for "group_by", must be one of auditPolicyCategory, auditPolicyName, targetId.'
      end
    end
  end

  if opts[:audit_policy_category] && !OCI::DataSafe::Models::AUDIT_POLICY_CATEGORY_ENUM.include?(opts[:audit_policy_category])
    raise 'Invalid value for "audit_policy_category", must be one of the values in OCI::DataSafe::Models::AUDIT_POLICY_CATEGORY_ENUM.'
  end

  if opts[:lifecycle_state] && !OCI::DataSafe::Models::AUDIT_POLICY_LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::DataSafe::Models::AUDIT_POLICY_LIFECYCLE_STATE_ENUM.'
  end

  path = '/auditPolicyAnalytics'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:compartmentIdInSubtree] = opts[:compartment_id_in_subtree] if !opts[:compartment_id_in_subtree].nil?
  query_params[:accessLevel] = opts[:access_level] if opts[:access_level]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:groupBy] = OCI::ApiClient.build_collection_params(opts[:group_by], :multi) if opts[:group_by] && !opts[:group_by].empty?
  query_params[:auditPolicyCategory] = opts[:audit_policy_category] if opts[:audit_policy_category]
  query_params[:auditPolicyName] = opts[:audit_policy_name] if opts[:audit_policy_name]
  query_params[:targetId] = opts[:target_id] if opts[:target_id]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#list_audit_policy_analytics') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataSafe::Models::AuditPolicyAnalyticCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_audit_profile_analytics(compartment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_audit_profile_analytics API.

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.

Parameters:

• compartment_id (String) —

  A filter to return only resources that match the specified compartment OCID.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :compartment_id_in_subtree (BOOLEAN) —

  Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting. (default to false)

• :access_level (String) —

  Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed. (default to RESTRICTED) Allowed values are: RESTRICTED, ACCESSIBLE

• :limit (Integer) —

  For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

• :page (String) —

  For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

• :group_by (Array<String>) —

  The group by parameter for summarize operation on audit. Allowed values are: isPaidUsageEnabled

• :opc_request_id (String) —

  Unique identifier for the request.

Returns:

• (Response) —

  A Response object with data of type AuditProfileAnalyticCollection

# File 'lib/oci/data_safe/data_safe_client.rb', line 9856

def list_audit_profile_analytics(compartment_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#list_audit_profile_analytics.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_audit_profile_analytics." if compartment_id.nil?

  if opts[:access_level] && !%w[RESTRICTED ACCESSIBLE].include?(opts[:access_level])
    raise 'Invalid value for "access_level", must be one of RESTRICTED, ACCESSIBLE.'
  end


  group_by_allowable_values = %w[isPaidUsageEnabled]
  if opts[:group_by] && !opts[:group_by].empty?
    opts[:group_by].each do |val_to_check|
      unless group_by_allowable_values.include?(val_to_check)
        raise 'Invalid value for "group_by", must be one of isPaidUsageEnabled.'
      end
    end
  end

  path = '/auditProfileAnalytics'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:compartmentIdInSubtree] = opts[:compartment_id_in_subtree] if !opts[:compartment_id_in_subtree].nil?
  query_params[:accessLevel] = opts[:access_level] if opts[:access_level]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:groupBy] = OCI::ApiClient.build_collection_params(opts[:group_by], :multi) if opts[:group_by] && !opts[:group_by].empty?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#list_audit_profile_analytics') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataSafe::Models::AuditProfileAnalyticCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_audit_profiles(compartment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_audit_profiles API.

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.

Parameters:

• compartment_id (String) —

  A filter to return only resources that match the specified compartment OCID.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :compartment_id_in_subtree (BOOLEAN) —

  Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting. (default to false)

• :access_level (String) —

  Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed. (default to RESTRICTED) Allowed values are: RESTRICTED, ACCESSIBLE

• :audit_profile_id (String) —

  A optional filter to return only resources that match the specified id.

• :target_id (String) —

  A filter to return only items related to a specific target OCID.

• :display_name (String) —

  A filter to return only resources that match the specified display name.

• :limit (Integer) —

  For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

• :page (String) —

  For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

• :lifecycle_state (String) —

  A optional filter to return only resources that match the specified lifecycle state.

• :is_override_global_retention_setting (BOOLEAN) —

  A optional filter to return only resources that match the specified retention configured value.

• :is_paid_usage_enabled (BOOLEAN) —

  Indicates if you want to continue audit record collection beyond the free limit of one million audit records per month per target database, incurring additional charges. The default value is inherited from the global settings. You can change at the global level or at the target level.

• :audit_collected_volume_greater_than_or_equal_to (Integer) —

  A filter to return only items that have count of audit records collected greater than or equal to the specified value.

• :sort_order (String) —

  The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

• :sort_by (String) —

  The field used for sorting. Only one sorting order (sortOrder) can be specified. The default order for TIMECREATED is descending. The default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. (default to TIMECREATED) Allowed values are: TIMECREATED, DISPLAYNAME

• :opc_request_id (String) —

  Unique identifier for the request.

Returns:

• (Response) —

  A Response object with data of type AuditProfileCollection

# File 'lib/oci/data_safe/data_safe_client.rb', line 9974

def list_audit_profiles(compartment_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#list_audit_profiles.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_audit_profiles." if compartment_id.nil?

  if opts[:access_level] && !%w[RESTRICTED ACCESSIBLE].include?(opts[:access_level])
    raise 'Invalid value for "access_level", must be one of RESTRICTED, ACCESSIBLE.'
  end

  if opts[:lifecycle_state] && !OCI::DataSafe::Models::AUDIT_PROFILE_LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::DataSafe::Models::AUDIT_PROFILE_LIFECYCLE_STATE_ENUM.'
  end

  if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of ASC, DESC.'
  end

  if opts[:sort_by] && !%w[TIMECREATED DISPLAYNAME].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of TIMECREATED, DISPLAYNAME.'
  end

  path = '/auditProfiles'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:compartmentIdInSubtree] = opts[:compartment_id_in_subtree] if !opts[:compartment_id_in_subtree].nil?
  query_params[:accessLevel] = opts[:access_level] if opts[:access_level]
  query_params[:auditProfileId] = opts[:audit_profile_id] if opts[:audit_profile_id]
  query_params[:targetId] = opts[:target_id] if opts[:target_id]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:isOverrideGlobalRetentionSetting] = opts[:is_override_global_retention_setting] if !opts[:is_override_global_retention_setting].nil?
  query_params[:isPaidUsageEnabled] = opts[:is_paid_usage_enabled] if !opts[:is_paid_usage_enabled].nil?
  query_params[:auditCollectedVolumeGreaterThanOrEqualTo] = opts[:audit_collected_volume_greater_than_or_equal_to] if opts[:audit_collected_volume_greater_than_or_equal_to]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#list_audit_profiles') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataSafe::Models::AuditProfileCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_audit_trail_analytics(compartment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_audit_trail_analytics API.

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.

Parameters:

• compartment_id (String) —

  A filter to return only resources that match the specified compartment OCID.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :compartment_id_in_subtree (BOOLEAN) —

  Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting. (default to false)

• :access_level (String) —

  Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed. (default to RESTRICTED) Allowed values are: RESTRICTED, ACCESSIBLE

• :limit (Integer) —

  For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

• :page (String) —

  For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

• :group_by (Array<String>) —

  The group by parameter for summarize operation on audit trail. Allowed values are: location, lifecycleState, status, targetId

• :target_id (String) —

  A filter to return only items related to a specific target OCID.

• :opc_request_id (String) —

  Unique identifier for the request.

Returns:

• (Response) —

  A Response object with data of type AuditTrailAnalyticCollection

# File 'lib/oci/data_safe/data_safe_client.rb', line 10084

def list_audit_trail_analytics(compartment_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#list_audit_trail_analytics.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_audit_trail_analytics." if compartment_id.nil?

  if opts[:access_level] && !%w[RESTRICTED ACCESSIBLE].include?(opts[:access_level])
    raise 'Invalid value for "access_level", must be one of RESTRICTED, ACCESSIBLE.'
  end


  group_by_allowable_values = %w[location lifecycleState status targetId]
  if opts[:group_by] && !opts[:group_by].empty?
    opts[:group_by].each do |val_to_check|
      unless group_by_allowable_values.include?(val_to_check)
        raise 'Invalid value for "group_by", must be one of location, lifecycleState, status, targetId.'
      end
    end
  end

  path = '/auditTrailAnalytics'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:compartmentIdInSubtree] = opts[:compartment_id_in_subtree] if !opts[:compartment_id_in_subtree].nil?
  query_params[:accessLevel] = opts[:access_level] if opts[:access_level]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:groupBy] = OCI::ApiClient.build_collection_params(opts[:group_by], :multi) if opts[:group_by] && !opts[:group_by].empty?
  query_params[:targetId] = opts[:target_id] if opts[:target_id]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#list_audit_trail_analytics') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataSafe::Models::AuditTrailAnalyticCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_audit_trails(compartment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_audit_trails API.

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.

Parameters:

• compartment_id (String) —

  A filter to return only resources that match the specified compartment OCID.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :compartment_id_in_subtree (BOOLEAN) —

  Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting. (default to false)

• :access_level (String) —

  Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed. (default to RESTRICTED) Allowed values are: RESTRICTED, ACCESSIBLE

• :audit_trail_id (String) —

  A optional filter to return only resources that match the specified id.

• :display_name (String) —

  A filter to return only resources that match the specified display name.

• :target_id (String) —

  A filter to return only items related to a specific target OCID.

• :limit (Integer) —

  For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

• :page (String) —

  For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

• :lifecycle_state (String) —

  A optional filter to return only resources that match the specified lifecycle state.

• :status (String) —

  A optional filter to return only resources that match the specified sub-state of audit trail.

• :sort_order (String) —

  The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

• :sort_by (String) —

  The field used for sorting. Only one sorting order (sortOrder) can be specified. The default order for TIMECREATED is descending. The default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. (default to TIMECREATED) Allowed values are: TIMECREATED, DISPLAYNAME

• :opc_request_id (String) —

  Unique identifier for the request.

Returns:

• (Response) —

  A Response object with data of type AuditTrailCollection

# File 'lib/oci/data_safe/data_safe_client.rb', line 10196

def list_audit_trails(compartment_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#list_audit_trails.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_audit_trails." if compartment_id.nil?

  if opts[:access_level] && !%w[RESTRICTED ACCESSIBLE].include?(opts[:access_level])
    raise 'Invalid value for "access_level", must be one of RESTRICTED, ACCESSIBLE.'
  end

  if opts[:lifecycle_state] && !OCI::DataSafe::Models::AUDIT_TRAIL_LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::DataSafe::Models::AUDIT_TRAIL_LIFECYCLE_STATE_ENUM.'
  end

  if opts[:status] && !OCI::DataSafe::Models::AUDIT_TRAIL_STATUS_ENUM.include?(opts[:status])
    raise 'Invalid value for "status", must be one of the values in OCI::DataSafe::Models::AUDIT_TRAIL_STATUS_ENUM.'
  end

  if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of ASC, DESC.'
  end

  if opts[:sort_by] && !%w[TIMECREATED DISPLAYNAME].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of TIMECREATED, DISPLAYNAME.'
  end

  path = '/auditTrails'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:compartmentIdInSubtree] = opts[:compartment_id_in_subtree] if !opts[:compartment_id_in_subtree].nil?
  query_params[:accessLevel] = opts[:access_level] if opts[:access_level]
  query_params[:auditTrailId] = opts[:audit_trail_id] if opts[:audit_trail_id]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:targetId] = opts[:target_id] if opts[:target_id]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:status] = opts[:status] if opts[:status]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#list_audit_trails') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataSafe::Models::AuditTrailCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_available_audit_volumes(audit_profile_id, work_request_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_available_audit_volumes API.

Retrieves a list of audit trails, and associated audit event volume for each trail up to defined start date. Allowed values are: monthInConsideration, volume, trailLocation

Parameters:

• audit_profile_id (String) —

  The OCID of the audit.

• work_request_id (String) —

  The OCID of the work request.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :trail_location (String) —

  The audit trail location.

• :month_in_consideration_greater_than (DateTime) —

  Specifying monthInConsiderationGreaterThan parameter will retrieve all items for which the event month is greater than the date and time specified, in the format defined by RFC3339.

  Example: 2016-12-19T00:00:00.000Z

• :month_in_consideration_less_than (DateTime) —

  Specifying monthInConsiderationLessThan parameter will retrieve all items for which the event month is less than the date and time specified, in the format defined by RFC3339.

  Example: 2016-12-19T00:00:00.000Z

• :limit (Integer) —

  For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

• :page (String) —

  For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

• :sort_order (String) —

  The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

• :sort_by (String) —

  The field to sort by. You can specify only one sort order(sortOrder). The default order for all fields is ascending. (default to monthInConsideration)

• :opc_request_id (String) —

  Unique identifier for the request.

Returns:

• (Response) —

  A Response object with data of type AvailableAuditVolumeCollection

# File 'lib/oci/data_safe/data_safe_client.rb', line 10304

def list_available_audit_volumes(audit_profile_id, work_request_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#list_available_audit_volumes.' if logger

  raise "Missing the required parameter 'audit_profile_id' when calling list_available_audit_volumes." if audit_profile_id.nil?
  raise "Missing the required parameter 'work_request_id' when calling list_available_audit_volumes." if work_request_id.nil?

  if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of ASC, DESC.'
  end

  if opts[:sort_by] && !%w[monthInConsideration volume trailLocation].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of monthInConsideration, volume, trailLocation.'
  end
  raise "Parameter value for 'audit_profile_id' must not be blank" if OCI::Internal::Util.blank_string?(audit_profile_id)

  path = '/auditProfiles/{auditProfileId}/availableAuditVolumes'.sub('{auditProfileId}', audit_profile_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:workRequestId] = work_request_id
  query_params[:trailLocation] = opts[:trail_location] if opts[:trail_location]
  query_params[:monthInConsiderationGreaterThan] = opts[:month_in_consideration_greater_than] if opts[:month_in_consideration_greater_than]
  query_params[:monthInConsiderationLessThan] = opts[:month_in_consideration_less_than] if opts[:month_in_consideration_less_than]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#list_available_audit_volumes') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataSafe::Models::AvailableAuditVolumeCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_collected_audit_volumes(audit_profile_id, work_request_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_collected_audit_volumes API.

Gets a list of all collected audit volume data points. Allowed values are: monthInConsideration, onlineVolume, archivedVolume

Parameters:

• audit_profile_id (String) —

  The OCID of the audit.

• work_request_id (String) —

  The OCID of the work request.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :month_in_consideration_greater_than (DateTime) —

  Specifying monthInConsiderationGreaterThan parameter will retrieve all items for which the event month is greater than the date and time specified, in the format defined by RFC3339.

  Example: 2016-12-19T00:00:00.000Z

• :month_in_consideration_less_than (DateTime) —

  Specifying monthInConsiderationLessThan parameter will retrieve all items for which the event month is less than the date and time specified, in the format defined by RFC3339.

  Example: 2016-12-19T00:00:00.000Z

• :limit (Integer) —

  For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

• :page (String) —

  For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

• :sort_order (String) —

  The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

• :sort_by (String) —

  The field to sort by. You can specify only one sort order(sortOrder). The default order for all fields is ascending. (default to monthInConsideration)

• :opc_request_id (String) —

  Unique identifier for the request.

Returns:

• (Response) —

  A Response object with data of type CollectedAuditVolumeCollection

# File 'lib/oci/data_safe/data_safe_client.rb', line 10397

def list_collected_audit_volumes(audit_profile_id, work_request_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#list_collected_audit_volumes.' if logger

  raise "Missing the required parameter 'audit_profile_id' when calling list_collected_audit_volumes." if audit_profile_id.nil?
  raise "Missing the required parameter 'work_request_id' when calling list_collected_audit_volumes." if work_request_id.nil?

  if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of ASC, DESC.'
  end

  if opts[:sort_by] && !%w[monthInConsideration onlineVolume archivedVolume].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of monthInConsideration, onlineVolume, archivedVolume.'
  end
  raise "Parameter value for 'audit_profile_id' must not be blank" if OCI::Internal::Util.blank_string?(audit_profile_id)

  path = '/auditProfiles/{auditProfileId}/collectedAuditVolumes'.sub('{auditProfileId}', audit_profile_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:workRequestId] = work_request_id
  query_params[:monthInConsiderationGreaterThan] = opts[:month_in_consideration_greater_than] if opts[:month_in_consideration_greater_than]
  query_params[:monthInConsiderationLessThan] = opts[:month_in_consideration_less_than] if opts[:month_in_consideration_less_than]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#list_collected_audit_volumes') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataSafe::Models::CollectedAuditVolumeCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_columns(target_database_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_columns API.

Returns a list of column metadata objects.

Allowed values are: SCHEMANAME, TABLENAME, COLUMNNAME, DATATYPE

Parameters:

• target_database_id (String) —

  The OCID of the Data Safe target database.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :opc_request_id (String) —

  Unique identifier for the request.

• :limit (Integer) —

  For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

• :page (String) —

  For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

• :schema_name (Array<String>) —

  A filter to return only items related to specific schema name.

• :table_name (Array<String>) —

  A filter to return only items related to specific table name.

• :column_name (Array<String>) —

  A filter to return only a specific column based on column name.

• :datatype (Array<String>) —

  A filter to return only items related to specific datatype.

• :sort_order (String) —

  The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

• :sort_by (String) —

  The field used for sorting. Only one sorting order (sortOrder) can be specified. (default to COLUMNNAME)

• :schema_name_contains (String) —

  A filter to return only items if schema name contains a specific string.

• :table_name_contains (String) —

  A filter to return only items if table name contains a specific string.

• :column_name_contains (String) —

  A filter to return only items if column name contains a specific string.

Returns:

• (Response) —

  A Response object with data of type Array<ColumnSummary>

# File 'lib/oci/data_safe/data_safe_client.rb', line 10482

def list_columns(target_database_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#list_columns.' if logger

  raise "Missing the required parameter 'target_database_id' when calling list_columns." if target_database_id.nil?

  if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of ASC, DESC.'
  end

  if opts[:sort_by] && !%w[SCHEMANAME TABLENAME COLUMNNAME DATATYPE].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of SCHEMANAME, TABLENAME, COLUMNNAME, DATATYPE.'
  end
  raise "Parameter value for 'target_database_id' must not be blank" if OCI::Internal::Util.blank_string?(target_database_id)

  path = '/targetDatabases/{targetDatabaseId}/columns'.sub('{targetDatabaseId}', target_database_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:schemaName] = OCI::ApiClient.build_collection_params(opts[:schema_name], :multi) if opts[:schema_name] && !opts[:schema_name].empty?
  query_params[:tableName] = OCI::ApiClient.build_collection_params(opts[:table_name], :multi) if opts[:table_name] && !opts[:table_name].empty?
  query_params[:columnName] = OCI::ApiClient.build_collection_params(opts[:column_name], :multi) if opts[:column_name] && !opts[:column_name].empty?
  query_params[:datatype] = OCI::ApiClient.build_collection_params(opts[:datatype], :multi) if opts[:datatype] && !opts[:datatype].empty?
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:schemaNameContains] = opts[:schema_name_contains] if opts[:schema_name_contains]
  query_params[:tableNameContains] = opts[:table_name_contains] if opts[:table_name_contains]
  query_params[:columnNameContains] = opts[:column_name_contains] if opts[:column_name_contains]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#list_columns') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'Array<OCI::DataSafe::Models::ColumnSummary>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_data_safe_private_endpoints(compartment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_data_safe_private_endpoints API.

Gets a list of Data Safe private endpoints.

Parameters:

• compartment_id (String) —

  A filter to return only resources that match the specified compartment OCID.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :display_name (String) —

  A filter to return only resources that match the specified display name.

• :vcn_id (String) —

  A filter to return only resources that match the specified VCN OCID.

• :lifecycle_state (String) —

  A filter to return only resources that match the specified lifecycle state.

• :limit (Integer) —

  For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

• :page (String) —

  For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

• :sort_order (String) —

  The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

• :sort_by (String) —

  The field used for sorting. Only one sorting order (sortOrder) can be specified. The default order for TIMECREATED is descending. The default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. (default to TIMECREATED) Allowed values are: TIMECREATED, DISPLAYNAME

• :opc_request_id (String) —

  Unique identifier for the request.

• :compartment_id_in_subtree (BOOLEAN) —

  Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting. (default to false)

• :access_level (String) —

  Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed. (default to RESTRICTED) Allowed values are: RESTRICTED, ACCESSIBLE

Returns:

• (Response) —

  A Response object with data of type Array<DataSafePrivateEndpointSummary>

# File 'lib/oci/data_safe/data_safe_client.rb', line 10578

def list_data_safe_private_endpoints(compartment_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#list_data_safe_private_endpoints.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_data_safe_private_endpoints." if compartment_id.nil?

  if opts[:lifecycle_state] && !OCI::DataSafe::Models::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::DataSafe::Models::LIFECYCLE_STATE_ENUM.'
  end

  if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of ASC, DESC.'
  end

  if opts[:sort_by] && !%w[TIMECREATED DISPLAYNAME].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of TIMECREATED, DISPLAYNAME.'
  end

  if opts[:access_level] && !%w[RESTRICTED ACCESSIBLE].include?(opts[:access_level])
    raise 'Invalid value for "access_level", must be one of RESTRICTED, ACCESSIBLE.'
  end

  path = '/dataSafePrivateEndpoints'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:vcnId] = opts[:vcn_id] if opts[:vcn_id]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:compartmentIdInSubtree] = opts[:compartment_id_in_subtree] if !opts[:compartment_id_in_subtree].nil?
  query_params[:accessLevel] = opts[:access_level] if opts[:access_level]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#list_data_safe_private_endpoints') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'Array<OCI::DataSafe::Models::DataSafePrivateEndpointSummary>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_database_security_configs(compartment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_database_security_configs API.

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.

Parameters:

• compartment_id (String) —

  A filter to return only resources that match the specified compartment OCID.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :compartment_id_in_subtree (BOOLEAN) —

  Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting. (default to false)

• :access_level (String) —

  Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed. (default to RESTRICTED) Allowed values are: RESTRICTED, ACCESSIBLE

• :display_name (String) —

  A filter to return only resources that match the specified display name.

• :limit (Integer) —

  For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

• :page (String) —

  For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

• :lifecycle_state (String) —

  The current state of the database security configuration.

• :database_security_config_id (String) —

  An optional filter to return only resources that match the specified OCID of the database security configuration resource.

• :time_created_greater_than_or_equal_to (DateTime) —

  A filter to return only the resources that were created after the specified date and time, as defined by RFC3339. Using TimeCreatedGreaterThanOrEqualToQueryParam parameter retrieves all resources created after that date.

  Example: 2016-12-19T16:39:57.600Z

• :time_created_less_than (DateTime) —

  Search for resources that were created before a specific date. Specifying this parameter corresponding timeCreatedLessThan parameter will retrieve all resources created before the specified created date, in "YYYY-MM-ddThh:mmZ" format with a Z offset, as defined by RFC 3339.

  Example: 2016-12-19T16:39:57.600Z

• :target_id (String) —

  A filter to return only items related to a specific target OCID.

• :sort_order (String) —

  The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

• :sort_by (String) —

  The field used for sorting. Only one sorting order (sortOrder) can be specified. The default order for TIMECREATED is descending. The default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. (default to TIMECREATED) Allowed values are: TIMECREATED, DISPLAYNAME

• :opc_request_id (String) —

  Unique identifier for the request.

Returns:

• (Response) —

  A Response object with data of type DatabaseSecurityConfigCollection

# File 'lib/oci/data_safe/data_safe_client.rb', line 10707

def list_database_security_configs(compartment_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#list_database_security_configs.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_database_security_configs." if compartment_id.nil?

  if opts[:access_level] && !%w[RESTRICTED ACCESSIBLE].include?(opts[:access_level])
    raise 'Invalid value for "access_level", must be one of RESTRICTED, ACCESSIBLE.'
  end

  if opts[:lifecycle_state] && !OCI::DataSafe::Models::DATABASE_SECURITY_CONFIG_LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::DataSafe::Models::DATABASE_SECURITY_CONFIG_LIFECYCLE_STATE_ENUM.'
  end

  if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of ASC, DESC.'
  end

  if opts[:sort_by] && !%w[TIMECREATED DISPLAYNAME].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of TIMECREATED, DISPLAYNAME.'
  end

  path = '/databaseSecurityConfigs'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:compartmentIdInSubtree] = opts[:compartment_id_in_subtree] if !opts[:compartment_id_in_subtree].nil?
  query_params[:accessLevel] = opts[:access_level] if opts[:access_level]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:databaseSecurityConfigId] = opts[:database_security_config_id] if opts[:database_security_config_id]
  query_params[:timeCreatedGreaterThanOrEqualTo] = opts[:time_created_greater_than_or_equal_to] if opts[:time_created_greater_than_or_equal_to]
  query_params[:timeCreatedLessThan] = opts[:time_created_less_than] if opts[:time_created_less_than]
  query_params[:targetId] = opts[:target_id] if opts[:target_id]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#list_database_security_configs') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataSafe::Models::DatabaseSecurityConfigCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_difference_columns(sdm_masking_policy_difference_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_difference_columns API.

Gets a list of columns of a SDM masking policy difference resource based on the specified query parameters.

Parameters:

• sdm_masking_policy_difference_id (String) —

  The OCID of the SDM masking policy difference.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :difference_type (String) —

  A filter to return only the SDM masking policy difference columns that match the specified difference type

• :planned_action (String) —

  A filter to return only the SDM masking policy difference columns that match the specified planned action.

• :sync_status (String) —

  A filter to return the SDM masking policy difference columns based on the value of their syncStatus attribute.

• :schema_name (Array<String>) —

  A filter to return only items related to specific schema name.

• :object_name (Array<String>) —

  A filter to return only items related to a specific object name.

• :column_name (Array<String>) —

  A filter to return only a specific column based on column name.

• :sort_order (String) —

  The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

• :sort_by (String) —

  The field to sort by. You can specify only one sorting parameter (sortOrder). The default order for schemaName is descending. The default order for differenceType, schemaName, objectName, columnName and plannedAction is ascending. (default to schemaName) Allowed values are: differenceType, schemaName, objectName, columnName, plannedAction

• :opc_request_id (String) —

  Unique identifier for the request.

• :limit (Integer) —

  For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

• :page (String) —

  For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

Returns:

• (Response) —

  A Response object with data of type SdmMaskingPolicyDifferenceColumnCollection

# File 'lib/oci/data_safe/data_safe_client.rb', line 10803

def list_difference_columns(sdm_masking_policy_difference_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#list_difference_columns.' if logger

  raise "Missing the required parameter 'sdm_masking_policy_difference_id' when calling list_difference_columns." if sdm_masking_policy_difference_id.nil?

  if opts[:difference_type] && !OCI::DataSafe::Models::SdmMaskingPolicyDifference::DIFFERENCE_TYPE_ENUM.include?(opts[:difference_type])
    raise 'Invalid value for "difference_type", must be one of the values in OCI::DataSafe::Models::SdmMaskingPolicyDifference::DIFFERENCE_TYPE_ENUM.'
  end

  if opts[:planned_action] && !OCI::DataSafe::Models::DifferenceColumn::PLANNED_ACTION_ENUM.include?(opts[:planned_action])
    raise 'Invalid value for "planned_action", must be one of the values in OCI::DataSafe::Models::DifferenceColumn::PLANNED_ACTION_ENUM.'
  end

  if opts[:sync_status] && !OCI::DataSafe::Models::DifferenceColumn::SYNC_STATUS_ENUM.include?(opts[:sync_status])
    raise 'Invalid value for "sync_status", must be one of the values in OCI::DataSafe::Models::DifferenceColumn::SYNC_STATUS_ENUM.'
  end

  if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of ASC, DESC.'
  end

  if opts[:sort_by] && !%w[differenceType schemaName objectName columnName plannedAction].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of differenceType, schemaName, objectName, columnName, plannedAction.'
  end
  raise "Parameter value for 'sdm_masking_policy_difference_id' must not be blank" if OCI::Internal::Util.blank_string?(sdm_masking_policy_difference_id)

  path = '/sdmMaskingPolicyDifferences/{sdmMaskingPolicyDifferenceId}/differenceColumns'.sub('{sdmMaskingPolicyDifferenceId}', sdm_masking_policy_difference_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:differenceType] = opts[:difference_type] if opts[:difference_type]
  query_params[:plannedAction] = opts[:planned_action] if opts[:planned_action]
  query_params[:syncStatus] = opts[:sync_status] if opts[:sync_status]
  query_params[:schemaName] = OCI::ApiClient.build_collection_params(opts[:schema_name], :multi) if opts[:schema_name] && !opts[:schema_name].empty?
  query_params[:objectName] = OCI::ApiClient.build_collection_params(opts[:object_name], :multi) if opts[:object_name] && !opts[:object_name].empty?
  query_params[:columnName] = OCI::ApiClient.build_collection_params(opts[:column_name], :multi) if opts[:column_name] && !opts[:column_name].empty?
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#list_difference_columns') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataSafe::Models::SdmMaskingPolicyDifferenceColumnCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_discovery_analytics(compartment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_discovery_analytics API.

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.

Parameters:

• compartment_id (String) —

  A filter to return only resources that match the specified compartment OCID.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :compartment_id_in_subtree (BOOLEAN) —

  Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting. (default to false)

• :group_by (String) —

  Attribute by which the discovery analytics data should be grouped. Allowed values are: targetId, sensitiveDataModelId

• :target_id (String) —

  A filter to return only items related to a specific target OCID.

• :sensitive_data_model_id (String) —

  A filter to return only the resources that match the specified sensitive data model OCID.

• :limit (Integer) —

  For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

• :page (String) —

  For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

• :opc_request_id (String) —

  Unique identifier for the request.

Returns:

• (Response) —

  A Response object with data of type DiscoveryAnalyticsCollection

# File 'lib/oci/data_safe/data_safe_client.rb', line 10899

def list_discovery_analytics(compartment_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#list_discovery_analytics.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_discovery_analytics." if compartment_id.nil?

  if opts[:group_by] && !%w[targetId sensitiveDataModelId].include?(opts[:group_by])
    raise 'Invalid value for "group_by", must be one of targetId, sensitiveDataModelId.'
  end

  path = '/discoveryAnalytics'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:compartmentIdInSubtree] = opts[:compartment_id_in_subtree] if !opts[:compartment_id_in_subtree].nil?
  query_params[:groupBy] = opts[:group_by] if opts[:group_by]
  query_params[:targetId] = opts[:target_id] if opts[:target_id]
  query_params[:sensitiveDataModelId] = opts[:sensitive_data_model_id] if opts[:sensitive_data_model_id]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#list_discovery_analytics') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataSafe::Models::DiscoveryAnalyticsCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_discovery_job_results(discovery_job_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_discovery_job_results API.

Gets a list of discovery results based on the specified query parameters.

Parameters:

• discovery_job_id (String) —

  The OCID of the discovery job.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :discovery_type (String) —

  A filter to return only the resources that match the specified discovery type.

• :planned_action (String) —

  A filter to return only the resources that match the specified planned action.

• :is_result_applied (BOOLEAN) —

  A filter to return the discovery result resources based on the value of their isResultApplied attribute.

• :schema_name (Array<String>) —

  A filter to return only items related to specific schema name.

• :object_name (Array<String>) —

  A filter to return only items related to a specific object name.

• :column_name (Array<String>) —

  A filter to return only a specific column based on column name.

• :sort_order (String) —

  The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

• :sort_by (String) —

  The field to sort by. You can specify only one sorting parameter (sortOrder). The default order for timeFinished is descending. The default order for discoveryType, schemaName, objectName, columnName and plannedAction is ascending. (default to timeFinished) Allowed values are: discoveryType, timeFinished, schemaName, objectName, columnName, plannedAction

• :opc_request_id (String) —

  Unique identifier for the request.

• :limit (Integer) —

  For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

• :page (String) —

  For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

Returns:

• (Response) —

  A Response object with data of type DiscoveryJobResultCollection

# File 'lib/oci/data_safe/data_safe_client.rb', line 10977

def list_discovery_job_results(discovery_job_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#list_discovery_job_results.' if logger

  raise "Missing the required parameter 'discovery_job_id' when calling list_discovery_job_results." if discovery_job_id.nil?

  if opts[:discovery_type] && !OCI::DataSafe::Models::DiscoveryJob::DISCOVERY_TYPE_ENUM.include?(opts[:discovery_type])
    raise 'Invalid value for "discovery_type", must be one of the values in OCI::DataSafe::Models::DiscoveryJob::DISCOVERY_TYPE_ENUM.'
  end

  if opts[:planned_action] && !OCI::DataSafe::Models::DiscoveryJobResult::PLANNED_ACTION_ENUM.include?(opts[:planned_action])
    raise 'Invalid value for "planned_action", must be one of the values in OCI::DataSafe::Models::DiscoveryJobResult::PLANNED_ACTION_ENUM.'
  end

  if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of ASC, DESC.'
  end

  if opts[:sort_by] && !%w[discoveryType timeFinished schemaName objectName columnName plannedAction].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of discoveryType, timeFinished, schemaName, objectName, columnName, plannedAction.'
  end
  raise "Parameter value for 'discovery_job_id' must not be blank" if OCI::Internal::Util.blank_string?(discovery_job_id)

  path = '/discoveryJobs/{discoveryJobId}/results'.sub('{discoveryJobId}', discovery_job_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:discoveryType] = opts[:discovery_type] if opts[:discovery_type]
  query_params[:plannedAction] = opts[:planned_action] if opts[:planned_action]
  query_params[:isResultApplied] = opts[:is_result_applied] if !opts[:is_result_applied].nil?
  query_params[:schemaName] = OCI::ApiClient.build_collection_params(opts[:schema_name], :multi) if opts[:schema_name] && !opts[:schema_name].empty?
  query_params[:objectName] = OCI::ApiClient.build_collection_params(opts[:object_name], :multi) if opts[:object_name] && !opts[:object_name].empty?
  query_params[:columnName] = OCI::ApiClient.build_collection_params(opts[:column_name], :multi) if opts[:column_name] && !opts[:column_name].empty?
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#list_discovery_job_results') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataSafe::Models::DiscoveryJobResultCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_discovery_jobs(compartment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_discovery_jobs API.

Gets a list of incremental discovery jobs based on the specified query parameters.

Parameters:

• compartment_id (String) —

  A filter to return only resources that match the specified compartment OCID.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :compartment_id_in_subtree (BOOLEAN) —

  Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting. (default to false)

• :access_level (String) —

  Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed. (default to RESTRICTED) Allowed values are: RESTRICTED, ACCESSIBLE

• :display_name (String) —

  A filter to return only resources that match the specified display name.

• :discovery_job_id (String) —

  A filter to return only the resources that match the specified discovery job OCID.

• :target_id (String) —

  A filter to return only items related to a specific target OCID.

• :lifecycle_state (String) —

  A filter to return only the resources that match the specified lifecycle state.

• :sensitive_data_model_id (String) —

  A filter to return only the resources that match the specified sensitive data model OCID.

• :sort_order (String) —

  The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

• :sort_by (String) —

  The field to sort by. You can specify only one sorting parameter (sortOrder). The default order for timeFinished is descending. The default order for displayName is ascending. (default to timeStarted) Allowed values are: timeStarted, displayName

• :opc_request_id (String) —

  Unique identifier for the request.

• :limit (Integer) —

  For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

• :page (String) —

  For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

Returns:

• (Response) —

  A Response object with data of type DiscoveryJobCollection

# File 'lib/oci/data_safe/data_safe_client.rb', line 11080

def list_discovery_jobs(compartment_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#list_discovery_jobs.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_discovery_jobs." if compartment_id.nil?

  if opts[:access_level] && !%w[RESTRICTED ACCESSIBLE].include?(opts[:access_level])
    raise 'Invalid value for "access_level", must be one of RESTRICTED, ACCESSIBLE.'
  end

  if opts[:lifecycle_state] && !OCI::DataSafe::Models::DISCOVERY_LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::DataSafe::Models::DISCOVERY_LIFECYCLE_STATE_ENUM.'
  end

  if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of ASC, DESC.'
  end

  if opts[:sort_by] && !%w[timeStarted displayName].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of timeStarted, displayName.'
  end

  path = '/discoveryJobs'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:compartmentIdInSubtree] = opts[:compartment_id_in_subtree] if !opts[:compartment_id_in_subtree].nil?
  query_params[:accessLevel] = opts[:access_level] if opts[:access_level]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:discoveryJobId] = opts[:discovery_job_id] if opts[:discovery_job_id]
  query_params[:targetId] = opts[:target_id] if opts[:target_id]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:sensitiveDataModelId] = opts[:sensitive_data_model_id] if opts[:sensitive_data_model_id]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#list_discovery_jobs') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataSafe::Models::DiscoveryJobCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_findings(security_assessment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_findings API.

List all the findings from all the targets in the specified compartment.

Parameters:

• security_assessment_id (String) —

  The OCID of the security assessment.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :opc_request_id (String) —

  Unique identifier for the request.

• :severity (String) —

  A filter to return only findings of a particular risk level. Allowed values are: HIGH, MEDIUM, LOW, EVALUATE, ADVISORY, PASS

• :references (String) —

  An optional filter to return only findings that match the specified reference.

• :limit (Integer) —

  For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

• :page (String) —

  For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

• :compartment_id_in_subtree (BOOLEAN) —

  Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting. (default to false)

• :access_level (String) —

  Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed. (default to RESTRICTED) Allowed values are: RESTRICTED, ACCESSIBLE

• :finding_key (String) —

  Each finding in security assessment has an associated key (think of key as a finding's name). For a given finding, the key will be the same across targets. The user can use these keys to filter the findings.

Returns:

• (Response) —

  A Response object with data of type Array<FindingSummary>

# File 'lib/oci/data_safe/data_safe_client.rb', line 11179

def list_findings(security_assessment_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#list_findings.' if logger

  raise "Missing the required parameter 'security_assessment_id' when calling list_findings." if security_assessment_id.nil?

  if opts[:severity] && !%w[HIGH MEDIUM LOW EVALUATE ADVISORY PASS].include?(opts[:severity])
    raise 'Invalid value for "severity", must be one of HIGH, MEDIUM, LOW, EVALUATE, ADVISORY, PASS.'
  end

  if opts[:references] && !OCI::DataSafe::Models::SECURITY_ASSESSMENT_REFERENCES_ENUM.include?(opts[:references])
    raise 'Invalid value for "references", must be one of the values in OCI::DataSafe::Models::SECURITY_ASSESSMENT_REFERENCES_ENUM.'
  end

  if opts[:access_level] && !%w[RESTRICTED ACCESSIBLE].include?(opts[:access_level])
    raise 'Invalid value for "access_level", must be one of RESTRICTED, ACCESSIBLE.'
  end
  raise "Parameter value for 'security_assessment_id' must not be blank" if OCI::Internal::Util.blank_string?(security_assessment_id)

  path = '/securityAssessments/{securityAssessmentId}/findings'.sub('{securityAssessmentId}', security_assessment_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:severity] = opts[:severity] if opts[:severity]
  query_params[:references] = opts[:references] if opts[:references]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:compartmentIdInSubtree] = opts[:compartment_id_in_subtree] if !opts[:compartment_id_in_subtree].nil?
  query_params[:accessLevel] = opts[:access_level] if opts[:access_level]
  query_params[:findingKey] = opts[:finding_key] if opts[:finding_key]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#list_findings') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'Array<OCI::DataSafe::Models::FindingSummary>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_grants(user_assessment_id, user_key, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_grants API.

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.

Allowed values are: grantName, grantType, privilegeCategory, depthLevel, key

Parameters:

• user_assessment_id (String) —

  The OCID of the user assessment.

• user_key (String) —

  The unique user key. This is a system-generated identifier. ListUsers gets the user key for a user.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :grant_key (String) —

  A filter to return only items that match the specified user grant key.

• :grant_name (String) —

  A filter to return only items that match the specified user grant name.

• :privilege_type (String) —

  A filter to return only items that match the specified privilege grant type.

• :privilege_category (String) —

  A filter to return only items that match the specified user privilege category.

• :depth_level (Integer) —

  A filter to return only items that match the specified user grant depth level.

• :depth_level_greater_than_or_equal_to (Integer) —

  A filter to return only items that are at a level greater than or equal to the specified user grant depth level.

• :depth_level_less_than (Integer) —

  A filter to return only items that are at a level less than the specified user grant depth level.

• :limit (Integer) —

  For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

• :page (String) —

  For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

• :sort_order (String) —

  The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

• :sort_by (String) —

  The field to sort by. You can specify only one sort order (sortOrder). The default order for grantName is ascending. (default to key)

• :opc_request_id (String) —

  Unique identifier for the request.

Returns:

• (Response) —

  A Response object with data of type Array<GrantSummary>

# File 'lib/oci/data_safe/data_safe_client.rb', line 11271

def list_grants(user_assessment_id, user_key, opts = {})
  logger.debug 'Calling operation DataSafeClient#list_grants.' if logger

  raise "Missing the required parameter 'user_assessment_id' when calling list_grants." if user_assessment_id.nil?
  raise "Missing the required parameter 'user_key' when calling list_grants." if user_key.nil?

  if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of ASC, DESC.'
  end

  if opts[:sort_by] && !%w[grantName grantType privilegeCategory depthLevel key].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of grantName, grantType, privilegeCategory, depthLevel, key.'
  end
  raise "Parameter value for 'user_assessment_id' must not be blank" if OCI::Internal::Util.blank_string?(user_assessment_id)
  raise "Parameter value for 'user_key' must not be blank" if OCI::Internal::Util.blank_string?(user_key)

  path = '/userAssessments/{userAssessmentId}/users/{userKey}/grants'.sub('{userAssessmentId}', user_assessment_id.to_s).sub('{userKey}', user_key.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:grantKey] = opts[:grant_key] if opts[:grant_key]
  query_params[:grantName] = opts[:grant_name] if opts[:grant_name]
  query_params[:privilegeType] = opts[:privilege_type] if opts[:privilege_type]
  query_params[:privilegeCategory] = opts[:privilege_category] if opts[:privilege_category]
  query_params[:depthLevel] = opts[:depth_level] if opts[:depth_level]
  query_params[:depthLevelGreaterThanOrEqualTo] = opts[:depth_level_greater_than_or_equal_to] if opts[:depth_level_greater_than_or_equal_to]
  query_params[:depthLevelLessThan] = opts[:depth_level_less_than] if opts[:depth_level_less_than]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#list_grants') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'Array<OCI::DataSafe::Models::GrantSummary>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_library_masking_formats(compartment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_library_masking_formats API.

Gets a list of library masking formats based on the specified query parameters.

Parameters:

• compartment_id (String) —

  A filter to return only resources that match the specified compartment OCID.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :library_masking_format_id (String) —

  A filter to return only the resources that match the specified library masking format OCID.

• :compartment_id_in_subtree (BOOLEAN) —

  Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting. (default to false)

• :access_level (String) —

  Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed. (default to RESTRICTED) Allowed values are: RESTRICTED, ACCESSIBLE

• :display_name (String) —

  A filter to return only resources that match the specified display name.

• :limit (Integer) —

  For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

• :page (String) —

  For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

• :lifecycle_state (String) —

  A filter to return only the resources that match the specified lifecycle states.

• :time_created_greater_than_or_equal_to (DateTime) —

  A filter to return only the resources that were created after the specified date and time, as defined by RFC3339. Using TimeCreatedGreaterThanOrEqualToQueryParam parameter retrieves all resources created after that date.

  Example: 2016-12-19T16:39:57.600Z

• :time_created_less_than (DateTime) —

  Search for resources that were created before a specific date. Specifying this parameter corresponding timeCreatedLessThan parameter will retrieve all resources created before the specified created date, in "YYYY-MM-ddThh:mmZ" format with a Z offset, as defined by RFC 3339.

  Example: 2016-12-19T16:39:57.600Z

• :library_masking_format_source (String) —

  A filter to return the library masking format resources based on the value of their source attribute. (default to USER)

• :sort_order (String) —

  The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

• :sort_by (String) —

  The field to sort by. You can specify only one sorting parameter (sortOrder). The default order for timeCreated is descending. The default order for displayName is ascending. The displayName sort order is case sensitive. (default to timeCreated) Allowed values are: displayName, timeCreated

• :opc_request_id (String) —

  Unique identifier for the request.

Returns:

• (Response) —

  A Response object with data of type LibraryMaskingFormatCollection

# File 'lib/oci/data_safe/data_safe_client.rb', line 11382

def list_library_masking_formats(compartment_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#list_library_masking_formats.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_library_masking_formats." if compartment_id.nil?

  if opts[:access_level] && !%w[RESTRICTED ACCESSIBLE].include?(opts[:access_level])
    raise 'Invalid value for "access_level", must be one of RESTRICTED, ACCESSIBLE.'
  end

  if opts[:lifecycle_state] && !OCI::DataSafe::Models::MASKING_LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::DataSafe::Models::MASKING_LIFECYCLE_STATE_ENUM.'
  end

  if opts[:library_masking_format_source] && !OCI::DataSafe::Models::LIBRARY_MASKING_FORMAT_SOURCE_ENUM.include?(opts[:library_masking_format_source])
    raise 'Invalid value for "library_masking_format_source", must be one of the values in OCI::DataSafe::Models::LIBRARY_MASKING_FORMAT_SOURCE_ENUM.'
  end

  if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of ASC, DESC.'
  end

  if opts[:sort_by] && !%w[displayName timeCreated].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of displayName, timeCreated.'
  end

  path = '/libraryMaskingFormats'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:libraryMaskingFormatId] = opts[:library_masking_format_id] if opts[:library_masking_format_id]
  query_params[:compartmentIdInSubtree] = opts[:compartment_id_in_subtree] if !opts[:compartment_id_in_subtree].nil?
  query_params[:accessLevel] = opts[:access_level] if opts[:access_level]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:timeCreatedGreaterThanOrEqualTo] = opts[:time_created_greater_than_or_equal_to] if opts[:time_created_greater_than_or_equal_to]
  query_params[:timeCreatedLessThan] = opts[:time_created_less_than] if opts[:time_created_less_than]
  query_params[:libraryMaskingFormatSource] = opts[:library_masking_format_source] if opts[:library_masking_format_source]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#list_library_masking_formats') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataSafe::Models::LibraryMaskingFormatCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_masked_columns(masking_report_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_masked_columns API.

Gets a list of masked columns present in the specified masking report and based on the specified query parameters.

Allowed values are: schemaName, objectName

Parameters:

• masking_report_id (String) —

  The OCID of the masking report.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :limit (Integer) —

  For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

• :page (String) —

  For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

• :sort_order (String) —

  The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

• :sort_by (String) —

  The field to sort by. You can specify only one sorting parameter (sortOrder). The default order for all the fields is ascending. (default to schemaName)

• :schema_name (Array<String>) —

  A filter to return only items related to specific schema name.

• :object_name (Array<String>) —

  A filter to return only items related to a specific object name.

• :column_name (Array<String>) —

  A filter to return only a specific column based on column name.

• :object_type (Array<String>) —

  A filter to return only items related to a specific object type. (default to [ALL]) Allowed values are: ALL, TABLE, EDITIONING_VIEW

• :masking_column_group (Array<String>) —

  A filter to return only the resources that match the specified masking column group.

• :sensitive_type_id (String) —

  A filter to return only items related to a specific sensitive type OCID.

• :opc_request_id (String) —

  Unique identifier for the request.

Returns:

• (Response) —

  A Response object with data of type MaskedColumnCollection

# File 'lib/oci/data_safe/data_safe_client.rb', line 11483

def list_masked_columns(masking_report_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#list_masked_columns.' if logger

  raise "Missing the required parameter 'masking_report_id' when calling list_masked_columns." if masking_report_id.nil?

  if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of ASC, DESC.'
  end

  if opts[:sort_by] && !%w[schemaName objectName].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of schemaName, objectName.'
  end


  object_type_allowable_values = %w[ALL TABLE EDITIONING_VIEW]
  if opts[:object_type] && !opts[:object_type].empty?
    opts[:object_type].each do |val_to_check|
      unless object_type_allowable_values.include?(val_to_check)
        raise 'Invalid value for "object_type", must be one of ALL, TABLE, EDITIONING_VIEW.'
      end
    end
  end
  raise "Parameter value for 'masking_report_id' must not be blank" if OCI::Internal::Util.blank_string?(masking_report_id)

  path = '/maskingReports/{maskingReportId}/maskedColumns'.sub('{maskingReportId}', masking_report_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:schemaName] = OCI::ApiClient.build_collection_params(opts[:schema_name], :multi) if opts[:schema_name] && !opts[:schema_name].empty?
  query_params[:objectName] = OCI::ApiClient.build_collection_params(opts[:object_name], :multi) if opts[:object_name] && !opts[:object_name].empty?
  query_params[:columnName] = OCI::ApiClient.build_collection_params(opts[:column_name], :multi) if opts[:column_name] && !opts[:column_name].empty?
  query_params[:objectType] = OCI::ApiClient.build_collection_params(opts[:object_type], :multi) if opts[:object_type] && !opts[:object_type].empty?
  query_params[:maskingColumnGroup] = OCI::ApiClient.build_collection_params(opts[:masking_column_group], :multi) if opts[:masking_column_group] && !opts[:masking_column_group].empty?
  query_params[:sensitiveTypeId] = opts[:sensitive_type_id] if opts[:sensitive_type_id]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#list_masked_columns') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataSafe::Models::MaskedColumnCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_masking_analytics(compartment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_masking_analytics API.

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.

Parameters:

• compartment_id (String) —

  A filter to return only resources that match the specified compartment OCID.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :compartment_id_in_subtree (BOOLEAN) —

  Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting. (default to false)

• :group_by (String) —

  Attribute by which the masking analytics data should be grouped. Allowed values are: targetId, policyId

• :target_id (String) —

  A filter to return only items related to a specific target OCID.

• :masking_policy_id (String) —

  A filter to return only the resources that match the specified masking policy OCID.

• :limit (Integer) —

  For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

• :page (String) —

  For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

• :opc_request_id (String) —

  Unique identifier for the request.

Returns:

• (Response) —

  A Response object with data of type MaskingAnalyticsCollection

# File 'lib/oci/data_safe/data_safe_client.rb', line 11577

def list_masking_analytics(compartment_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#list_masking_analytics.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_masking_analytics." if compartment_id.nil?

  if opts[:group_by] && !%w[targetId policyId].include?(opts[:group_by])
    raise 'Invalid value for "group_by", must be one of targetId, policyId.'
  end

  path = '/maskingAnalytics'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:compartmentIdInSubtree] = opts[:compartment_id_in_subtree] if !opts[:compartment_id_in_subtree].nil?
  query_params[:groupBy] = opts[:group_by] if opts[:group_by]
  query_params[:targetId] = opts[:target_id] if opts[:target_id]
  query_params[:maskingPolicyId] = opts[:masking_policy_id] if opts[:masking_policy_id]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#list_masking_analytics') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataSafe::Models::MaskingAnalyticsCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_masking_columns(masking_policy_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_masking_columns API.

Gets a list of masking columns present in the specified masking policy and based on the specified query parameters.

Parameters:

• masking_policy_id (String) —

  The OCID of the masking policy.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :limit (Integer) —

  For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

• :page (String) —

  For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

• :sort_order (String) —

  The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

• :sort_by (String) —

  The field to sort by. You can specify only one sorting parameter (sortOrder). The default order for timeCreated is descending. The default order for other fields is ascending. (default to timeCreated) Allowed values are: timeCreated, schemaName, objectName, dataType

• :masking_column_lifecycle_state (String) —

  A filter to return only the resources that match the specified lifecycle states.

• :data_type (Array<String>) —

  A filter to return only resources that match the specified data types. Allowed values are: CHARACTER, DATE, LOB, NUMERIC

• :schema_name (Array<String>) —

  A filter to return only items related to specific schema name.

• :object_name (Array<String>) —

  A filter to return only items related to a specific object name.

• :column_name (Array<String>) —

  A filter to return only a specific column based on column name.

• :object_type (Array<String>) —

  A filter to return only items related to a specific object type. (default to [ALL]) Allowed values are: ALL, TABLE, EDITIONING_VIEW

• :masking_column_group (Array<String>) —

  A filter to return only the resources that match the specified masking column group.

• :sensitive_type_id (String) —

  A filter to return only items related to a specific sensitive type OCID.

• :is_masking_enabled (BOOLEAN) —

  A filter to return the masking column resources based on the value of their isMaskingEnabled attribute. A value of true returns only those columns for which masking is enabled. A value of false returns only those columns for which masking is disabled. Omitting this parameter returns all the masking columns in a masking policy.

• :is_seed_required (BOOLEAN) —

  A filter to return masking columns based on whether the assigned masking formats need a seed value for masking. A value of true returns those masking columns that are using Deterministic Encryption or Deterministic Substitution masking format. (default to false)

• :time_created_greater_than_or_equal_to (DateTime) —

  A filter to return only the resources that were created after the specified date and time, as defined by RFC3339. Using TimeCreatedGreaterThanOrEqualToQueryParam parameter retrieves all resources created after that date.

  Example: 2016-12-19T16:39:57.600Z

• :time_created_less_than (DateTime) —

  Search for resources that were created before a specific date. Specifying this parameter corresponding timeCreatedLessThan parameter will retrieve all resources created before the specified created date, in "YYYY-MM-ddThh:mmZ" format with a Z offset, as defined by RFC 3339.

  Example: 2016-12-19T16:39:57.600Z

• :time_updated_greater_than_or_equal_to (DateTime) —

  Search for resources that were updated after a specific date. Specifying this parameter corresponding timeUpdatedGreaterThanOrEqualTo parameter will retrieve all resources updated after the specified created date, in "YYYY-MM-ddThh:mmZ" format with a Z offset, as defined by RFC 3339.

• :time_updated_less_than (DateTime) —

  Search for resources that were updated before a specific date. Specifying this parameter corresponding timeUpdatedLessThan parameter will retrieve all resources updated before the specified created date, in "YYYY-MM-ddThh:mmZ" format with a Z offset, as defined by RFC 3339.

• :opc_request_id (String) —

  Unique identifier for the request.

Returns:

• (Response) —

  A Response object with data of type MaskingColumnCollection

# File 'lib/oci/data_safe/data_safe_client.rb', line 11693

def list_masking_columns(masking_policy_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#list_masking_columns.' if logger

  raise "Missing the required parameter 'masking_policy_id' when calling list_masking_columns." if masking_policy_id.nil?

  if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of ASC, DESC.'
  end

  if opts[:sort_by] && !%w[timeCreated schemaName objectName dataType].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of timeCreated, schemaName, objectName, dataType.'
  end

  if opts[:masking_column_lifecycle_state] && !OCI::DataSafe::Models::MASKING_COLUMN_LIFECYCLE_STATE_ENUM.include?(opts[:masking_column_lifecycle_state])
    raise 'Invalid value for "masking_column_lifecycle_state", must be one of the values in OCI::DataSafe::Models::MASKING_COLUMN_LIFECYCLE_STATE_ENUM.'
  end


  data_type_allowable_values = %w[CHARACTER DATE LOB NUMERIC]
  if opts[:data_type] && !opts[:data_type].empty?
    opts[:data_type].each do |val_to_check|
      unless data_type_allowable_values.include?(val_to_check)
        raise 'Invalid value for "data_type", must be one of CHARACTER, DATE, LOB, NUMERIC.'
      end
    end
  end


  object_type_allowable_values = %w[ALL TABLE EDITIONING_VIEW]
  if opts[:object_type] && !opts[:object_type].empty?
    opts[:object_type].each do |val_to_check|
      unless object_type_allowable_values.include?(val_to_check)
        raise 'Invalid value for "object_type", must be one of ALL, TABLE, EDITIONING_VIEW.'
      end
    end
  end
  raise "Parameter value for 'masking_policy_id' must not be blank" if OCI::Internal::Util.blank_string?(masking_policy_id)

  path = '/maskingPolicies/{maskingPolicyId}/maskingColumns'.sub('{maskingPolicyId}', masking_policy_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:maskingColumnLifecycleState] = opts[:masking_column_lifecycle_state] if opts[:masking_column_lifecycle_state]
  query_params[:dataType] = OCI::ApiClient.build_collection_params(opts[:data_type], :multi) if opts[:data_type] && !opts[:data_type].empty?
  query_params[:schemaName] = OCI::ApiClient.build_collection_params(opts[:schema_name], :multi) if opts[:schema_name] && !opts[:schema_name].empty?
  query_params[:objectName] = OCI::ApiClient.build_collection_params(opts[:object_name], :multi) if opts[:object_name] && !opts[:object_name].empty?
  query_params[:columnName] = OCI::ApiClient.build_collection_params(opts[:column_name], :multi) if opts[:column_name] && !opts[:column_name].empty?
  query_params[:objectType] = OCI::ApiClient.build_collection_params(opts[:object_type], :multi) if opts[:object_type] && !opts[:object_type].empty?
  query_params[:maskingColumnGroup] = OCI::ApiClient.build_collection_params(opts[:masking_column_group], :multi) if opts[:masking_column_group] && !opts[:masking_column_group].empty?
  query_params[:sensitiveTypeId] = opts[:sensitive_type_id] if opts[:sensitive_type_id]
  query_params[:isMaskingEnabled] = opts[:is_masking_enabled] if !opts[:is_masking_enabled].nil?
  query_params[:isSeedRequired] = opts[:is_seed_required] if !opts[:is_seed_required].nil?
  query_params[:timeCreatedGreaterThanOrEqualTo] = opts[:time_created_greater_than_or_equal_to] if opts[:time_created_greater_than_or_equal_to]
  query_params[:timeCreatedLessThan] = opts[:time_created_less_than] if opts[:time_created_less_than]
  query_params[:timeUpdatedGreaterThanOrEqualTo] = opts[:time_updated_greater_than_or_equal_to] if opts[:time_updated_greater_than_or_equal_to]
  query_params[:timeUpdatedLessThan] = opts[:time_updated_less_than] if opts[:time_updated_less_than]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#list_masking_columns') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataSafe::Models::MaskingColumnCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_masking_objects(masking_policy_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_masking_objects API.

Gets a list of masking objects present in the specified masking policy and based on the specified query parameters.

Parameters:

• masking_policy_id (String) —

  The OCID of the masking policy.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :limit (Integer) —

  For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

• :page (String) —

  For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

• :sort_order (String) —

  The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

• :sort_by (String) —

  The field to sort by. You can specify only one sorting parameter (sortOrder). The default order is ascending. (default to schemaName) Allowed values are: schemaName, objectName, objectType

• :schema_name (Array<String>) —

  A filter to return only items related to specific schema name.

• :object_name (Array<String>) —

  A filter to return only items related to a specific object name.

• :object_type (Array<String>) —

  A filter to return only items related to a specific object type. (default to [ALL]) Allowed values are: ALL, TABLE, EDITIONING_VIEW

• :opc_request_id (String) —

  Unique identifier for the request.

Returns:

• (Response) —

  A Response object with data of type MaskingObjectCollection

# File 'lib/oci/data_safe/data_safe_client.rb', line 11810

def list_masking_objects(masking_policy_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#list_masking_objects.' if logger

  raise "Missing the required parameter 'masking_policy_id' when calling list_masking_objects." if masking_policy_id.nil?

  if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of ASC, DESC.'
  end

  if opts[:sort_by] && !%w[schemaName objectName objectType].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of schemaName, objectName, objectType.'
  end


  object_type_allowable_values = %w[ALL TABLE EDITIONING_VIEW]
  if opts[:object_type] && !opts[:object_type].empty?
    opts[:object_type].each do |val_to_check|
      unless object_type_allowable_values.include?(val_to_check)
        raise 'Invalid value for "object_type", must be one of ALL, TABLE, EDITIONING_VIEW.'
      end
    end
  end
  raise "Parameter value for 'masking_policy_id' must not be blank" if OCI::Internal::Util.blank_string?(masking_policy_id)

  path = '/maskingPolicies/{maskingPolicyId}/maskingObjects'.sub('{maskingPolicyId}', masking_policy_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:schemaName] = OCI::ApiClient.build_collection_params(opts[:schema_name], :multi) if opts[:schema_name] && !opts[:schema_name].empty?
  query_params[:objectName] = OCI::ApiClient.build_collection_params(opts[:object_name], :multi) if opts[:object_name] && !opts[:object_name].empty?
  query_params[:objectType] = OCI::ApiClient.build_collection_params(opts[:object_type], :multi) if opts[:object_type] && !opts[:object_type].empty?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#list_masking_objects') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataSafe::Models::MaskingObjectCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_masking_policies(compartment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_masking_policies API.

Gets a list of masking policies based on the specified query parameters.

Parameters:

• compartment_id (String) —

  A filter to return only resources that match the specified compartment OCID.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :masking_policy_id (String) —

  A filter to return only the resources that match the specified masking policy OCID.

• :display_name (String) —

  A filter to return only resources that match the specified display name.

• :limit (Integer) —

  For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

• :page (String) —

  For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

• :lifecycle_state (String) —

  A filter to return only the resources that match the specified lifecycle states.

• :sort_order (String) —

  The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

• :sort_by (String) —

  The field to sort by. You can specify only one sorting parameter (sortOrder). The default order for timeCreated is descending. The default order for displayName is ascending. The displayName sort order is case sensitive. (default to timeCreated) Allowed values are: displayName, timeCreated

• :sensitive_data_model_id (String) —

  A filter to return only the resources that match the specified sensitive data model OCID.

• :target_id (String) —

  A filter to return only items related to a specific target OCID.

• :time_created_greater_than_or_equal_to (DateTime) —

  A filter to return only the resources that were created after the specified date and time, as defined by RFC3339. Using TimeCreatedGreaterThanOrEqualToQueryParam parameter retrieves all resources created after that date.

  Example: 2016-12-19T16:39:57.600Z

• :time_created_less_than (DateTime) —

  Search for resources that were created before a specific date. Specifying this parameter corresponding timeCreatedLessThan parameter will retrieve all resources created before the specified created date, in "YYYY-MM-ddThh:mmZ" format with a Z offset, as defined by RFC 3339.

  Example: 2016-12-19T16:39:57.600Z

• :compartment_id_in_subtree (BOOLEAN) —

  Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting. (default to false)

• :access_level (String) —

  Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed. (default to RESTRICTED) Allowed values are: RESTRICTED, ACCESSIBLE

• :opc_request_id (String) —

  Unique identifier for the request.

Returns:

• (Response) —

  A Response object with data of type MaskingPolicyCollection

# File 'lib/oci/data_safe/data_safe_client.rb', line 11925

def list_masking_policies(compartment_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#list_masking_policies.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_masking_policies." if compartment_id.nil?

  if opts[:lifecycle_state] && !OCI::DataSafe::Models::MASKING_LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::DataSafe::Models::MASKING_LIFECYCLE_STATE_ENUM.'
  end

  if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of ASC, DESC.'
  end

  if opts[:sort_by] && !%w[displayName timeCreated].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of displayName, timeCreated.'
  end

  if opts[:access_level] && !%w[RESTRICTED ACCESSIBLE].include?(opts[:access_level])
    raise 'Invalid value for "access_level", must be one of RESTRICTED, ACCESSIBLE.'
  end

  path = '/maskingPolicies'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:maskingPolicyId] = opts[:masking_policy_id] if opts[:masking_policy_id]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:sensitiveDataModelId] = opts[:sensitive_data_model_id] if opts[:sensitive_data_model_id]
  query_params[:targetId] = opts[:target_id] if opts[:target_id]
  query_params[:timeCreatedGreaterThanOrEqualTo] = opts[:time_created_greater_than_or_equal_to] if opts[:time_created_greater_than_or_equal_to]
  query_params[:timeCreatedLessThan] = opts[:time_created_less_than] if opts[:time_created_less_than]
  query_params[:compartmentIdInSubtree] = opts[:compartment_id_in_subtree] if !opts[:compartment_id_in_subtree].nil?
  query_params[:accessLevel] = opts[:access_level] if opts[:access_level]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#list_masking_policies') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataSafe::Models::MaskingPolicyCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_masking_reports(compartment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_masking_reports API.

Gets a list of masking reports based on the specified query parameters. Allowed values are: timeMaskingFinished

Parameters:

• compartment_id (String) —

  A filter to return only resources that match the specified compartment OCID.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :limit (Integer) —

  For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

• :page (String) —

  For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

• :masking_policy_id (String) —

  A filter to return only the resources that match the specified masking policy OCID.

• :target_id (String) —

  A filter to return only items related to a specific target OCID.

• :sort_order (String) —

  The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

• :sort_by (String) —

  The field to sort by. You can specify only one sorting parameter (sortOrder). The default order for timeMaskingFinished is descending. (default to timeMaskingFinished)

• :opc_request_id (String) —

  Unique identifier for the request.

• :compartment_id_in_subtree (BOOLEAN) —

  Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting. (default to false)

• :access_level (String) —

  Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed. (default to RESTRICTED) Allowed values are: RESTRICTED, ACCESSIBLE

Returns:

• (Response) —

  A Response object with data of type MaskingReportCollection

# File 'lib/oci/data_safe/data_safe_client.rb', line 12026

def list_masking_reports(compartment_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#list_masking_reports.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_masking_reports." if compartment_id.nil?

  if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of ASC, DESC.'
  end

  if opts[:sort_by] && !%w[timeMaskingFinished].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of timeMaskingFinished.'
  end

  if opts[:access_level] && !%w[RESTRICTED ACCESSIBLE].include?(opts[:access_level])
    raise 'Invalid value for "access_level", must be one of RESTRICTED, ACCESSIBLE.'
  end

  path = '/maskingReports'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:maskingPolicyId] = opts[:masking_policy_id] if opts[:masking_policy_id]
  query_params[:targetId] = opts[:target_id] if opts[:target_id]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:compartmentIdInSubtree] = opts[:compartment_id_in_subtree] if !opts[:compartment_id_in_subtree].nil?
  query_params[:accessLevel] = opts[:access_level] if opts[:access_level]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#list_masking_reports') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataSafe::Models::MaskingReportCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_masking_schemas(masking_policy_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_masking_schemas API.

Gets a list of masking schemas present in the specified masking policy and based on the specified query parameters.

Parameters:

• masking_policy_id (String) —

  The OCID of the masking policy.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :limit (Integer) —

  For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

• :page (String) —

  For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

• :sort_order (String) —

  The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

• :sort_by (String) —

  The field to sort by. You can specify only one sorting parameter (sortOrder). The default order is ascending. (default to schemaName) Allowed values are: schemaName

• :schema_name (Array<String>) —

  A filter to return only items related to specific schema name.

• :opc_request_id (String) —

  Unique identifier for the request.

Returns:

• (Response) —

  A Response object with data of type MaskingSchemaCollection

# File 'lib/oci/data_safe/data_safe_client.rb', line 12110

def list_masking_schemas(masking_policy_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#list_masking_schemas.' if logger

  raise "Missing the required parameter 'masking_policy_id' when calling list_masking_schemas." if masking_policy_id.nil?

  if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of ASC, DESC.'
  end

  if opts[:sort_by] && !%w[schemaName].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of schemaName.'
  end
  raise "Parameter value for 'masking_policy_id' must not be blank" if OCI::Internal::Util.blank_string?(masking_policy_id)

  path = '/maskingPolicies/{maskingPolicyId}/maskingSchemas'.sub('{maskingPolicyId}', masking_policy_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:schemaName] = OCI::ApiClient.build_collection_params(opts[:schema_name], :multi) if opts[:schema_name] && !opts[:schema_name].empty?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#list_masking_schemas') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataSafe::Models::MaskingSchemaCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_on_prem_connectors(compartment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_on_prem_connectors API.

Gets a list of on-premises connectors.

Parameters:

• compartment_id (String) —

  A filter to return only resources that match the specified compartment OCID.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :on_prem_connector_id (String) —

  A filter to return only the on-premises connector that matches the specified id.

• :display_name (String) —

  A filter to return only resources that match the specified display name.

• :on_prem_connector_lifecycle_state (String) —

  A filter to return only on-premises connector resources that match the specified lifecycle state.

• :limit (Integer) —

  For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

• :page (String) —

  For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

• :sort_order (String) —

  The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

• :sort_by (String) —

  The field used for sorting. Only one sorting order (sortOrder) can be specified. The default order for TIMECREATED is descending. The default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. (default to TIMECREATED) Allowed values are: TIMECREATED, DISPLAYNAME

• :opc_request_id (String) —

  Unique identifier for the request.

• :compartment_id_in_subtree (BOOLEAN) —

  Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting. (default to false)

• :access_level (String) —

  Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed. (default to RESTRICTED) Allowed values are: RESTRICTED, ACCESSIBLE

Returns:

• (Response) —

  A Response object with data of type Array<OnPremConnectorSummary>

# File 'lib/oci/data_safe/data_safe_client.rb', line 12200

def list_on_prem_connectors(compartment_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#list_on_prem_connectors.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_on_prem_connectors." if compartment_id.nil?

  if opts[:on_prem_connector_lifecycle_state] && !OCI::DataSafe::Models::ON_PREM_CONNECTOR_LIFECYCLE_STATE_ENUM.include?(opts[:on_prem_connector_lifecycle_state])
    raise 'Invalid value for "on_prem_connector_lifecycle_state", must be one of the values in OCI::DataSafe::Models::ON_PREM_CONNECTOR_LIFECYCLE_STATE_ENUM.'
  end

  if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of ASC, DESC.'
  end

  if opts[:sort_by] && !%w[TIMECREATED DISPLAYNAME].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of TIMECREATED, DISPLAYNAME.'
  end

  if opts[:access_level] && !%w[RESTRICTED ACCESSIBLE].include?(opts[:access_level])
    raise 'Invalid value for "access_level", must be one of RESTRICTED, ACCESSIBLE.'
  end

  path = '/onPremConnectors'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:onPremConnectorId] = opts[:on_prem_connector_id] if opts[:on_prem_connector_id]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:onPremConnectorLifecycleState] = opts[:on_prem_connector_lifecycle_state] if opts[:on_prem_connector_lifecycle_state]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:compartmentIdInSubtree] = opts[:compartment_id_in_subtree] if !opts[:compartment_id_in_subtree].nil?
  query_params[:accessLevel] = opts[:access_level] if opts[:access_level]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#list_on_prem_connectors') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'Array<OCI::DataSafe::Models::OnPremConnectorSummary>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_profile_analytics(user_assessment_id, compartment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_profile_analytics API.

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

Parameters:

• user_assessment_id (String) —

  The OCID of the user assessment.

• compartment_id (String) —

  A filter to return only resources that match the specified compartment OCID.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :compartment_id_in_subtree (BOOLEAN) —

  Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting. (default to false)

• :access_level (String) —

  Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed. (default to RESTRICTED) Allowed values are: RESTRICTED, ACCESSIBLE

• :target_id (String) —

  A filter to return only items related to a specific target OCID.

• :limit (Integer) —

  For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

• :page (String) —

  For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

• :profile_name (String) —

  A filter to return only items that match the specified profile name.

• :sort_by (String) —

  The field used for sorting. Only one sorting order (sortOrder) can be specified. The default order for TIMECREATED is descending. The default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. (default to TIMECREATED) Allowed values are: TIMECREATED, DISPLAYNAME

• :sort_order (String) —

  The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

• :opc_request_id (String) —

  Unique identifier for the request.

Returns:

• (Response) —

  A Response object with data of type Array<ProfileAggregation>

# File 'lib/oci/data_safe/data_safe_client.rb', line 12315

def list_profile_analytics(user_assessment_id, compartment_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#list_profile_analytics.' if logger

  raise "Missing the required parameter 'user_assessment_id' when calling list_profile_analytics." if user_assessment_id.nil?
  raise "Missing the required parameter 'compartment_id' when calling list_profile_analytics." if compartment_id.nil?

  if opts[:access_level] && !%w[RESTRICTED ACCESSIBLE].include?(opts[:access_level])
    raise 'Invalid value for "access_level", must be one of RESTRICTED, ACCESSIBLE.'
  end

  if opts[:sort_by] && !%w[TIMECREATED DISPLAYNAME].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of TIMECREATED, DISPLAYNAME.'
  end

  if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of ASC, DESC.'
  end
  raise "Parameter value for 'user_assessment_id' must not be blank" if OCI::Internal::Util.blank_string?(user_assessment_id)

  path = '/userAssessments/{userAssessmentId}/profileAnalytics'.sub('{userAssessmentId}', user_assessment_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:compartmentIdInSubtree] = opts[:compartment_id_in_subtree] if !opts[:compartment_id_in_subtree].nil?
  query_params[:accessLevel] = opts[:access_level] if opts[:access_level]
  query_params[:targetId] = opts[:target_id] if opts[:target_id]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:profileName] = opts[:profile_name] if opts[:profile_name]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#list_profile_analytics') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'Array<OCI::DataSafe::Models::ProfileAggregation>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_profile_summaries(user_assessment_id, compartment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_profile_summaries API.

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.

Allowed values are: profileName, targetId, isUserCreated, passwordVerificationFunction, userCount, sessionsPerUser, inactiveAccountTime, passwordLockTime, failedLoginAttempts

Parameters:

• user_assessment_id (String) —

  The OCID of the user assessment.

• compartment_id (String) —

  A filter to return only resources that match the specified compartment OCID.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :compartment_id_in_subtree (BOOLEAN) —

  Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting. (default to false)

• :access_level (String) —

  Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed. (default to RESTRICTED) Allowed values are: RESTRICTED, ACCESSIBLE

• :target_id (String) —

  A filter to return only items related to a specific target OCID.

• :limit (Integer) —

  For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

• :page (String) —

  For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

• :profile_name (String) —

  A filter to return only items that match the specified profile name.

• :is_user_created (BOOLEAN) —

  An optional filter to return the user created profiles.

• :password_verification_function (String) —

  An optional filter to filter the profiles based on password verification function.

• :user_count_greater_than_or_equal (String) —

  An optional filter to return the profiles having user count greater than or equal to the provided value.

• :user_count_less_than (String) —

  An optional filter to return the profiles having user count less than the provided value.

• :failed_login_attempts_greater_than_or_equal (String) —

  An optional filter to return the profiles having allow failed login attempts number greater than or equal to the provided value. String value is used for accommodating the "UNLIMITED" and "DEFAULT" values.

• :failed_login_attempts_less_than (String) —

  An optional filter to return the profiles having failed login attempts number less than the provided value. String value is used for accommodating the "UNLIMITED" and "DEFAULT" values.

• :sessions_per_user_greater_than_or_equal (String) —

  An optional filter to return the profiles permitting the user to spawn multiple sessions having count. greater than or equal to the provided value. String value is used for accommodating the "UNLIMITED" and "DEFAULT" values.

• :sessions_per_user_less_than (String) —

  An optional filter to return the profiles permitting the user to spawn multiple sessions having count less than the provided value. String value is used for accommodating the "UNLIMITED" and "DEFAULT" values.

• :inactive_account_time_greater_than_or_equal (String) —

  An optional filter to return the profiles allowing inactive account time in days greater than or equal to the provided value. String value is used for accommodating the "UNLIMITED" and "DEFAULT" values.

• :inactive_account_time_less_than (String) —

  An optional filter to return the profiles allowing inactive account time in days less than the provided value. String value is used for accommodating the "UNLIMITED" and "DEFAULT" values.

• :password_lock_time_greater_than_or_equal (String) —

  An optional filter to return the profiles having password lock number greater than or equal to the provided value. String value is used for accommodating the "UNLIMITED" and "DEFAULT" values.

• :password_lock_time_less_than (String) —

  An optional filter to return the profiles having password lock number less than the provided value. String value is used for accommodating the "UNLIMITED" and "DEFAULT" values.

• :sort_by (String) —

  The field to sort by. You can specify only one sort order (sortOrder). The default order is targetId ASC. (default to targetId)

• :sort_order (String) —

  The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

• :opc_request_id (String) —

  Unique identifier for the request.

Returns:

• (Response) —

  A Response object with data of type Array<ProfileSummary>

# File 'lib/oci/data_safe/data_safe_client.rb', line 12455

def list_profile_summaries(user_assessment_id, compartment_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#list_profile_summaries.' if logger

  raise "Missing the required parameter 'user_assessment_id' when calling list_profile_summaries." if user_assessment_id.nil?
  raise "Missing the required parameter 'compartment_id' when calling list_profile_summaries." if compartment_id.nil?

  if opts[:access_level] && !%w[RESTRICTED ACCESSIBLE].include?(opts[:access_level])
    raise 'Invalid value for "access_level", must be one of RESTRICTED, ACCESSIBLE.'
  end

  if opts[:sort_by] && !%w[profileName targetId isUserCreated passwordVerificationFunction userCount sessionsPerUser inactiveAccountTime passwordLockTime failedLoginAttempts].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of profileName, targetId, isUserCreated, passwordVerificationFunction, userCount, sessionsPerUser, inactiveAccountTime, passwordLockTime, failedLoginAttempts.'
  end

  if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of ASC, DESC.'
  end
  raise "Parameter value for 'user_assessment_id' must not be blank" if OCI::Internal::Util.blank_string?(user_assessment_id)

  path = '/userAssessments/{userAssessmentId}/profiles'.sub('{userAssessmentId}', user_assessment_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:compartmentIdInSubtree] = opts[:compartment_id_in_subtree] if !opts[:compartment_id_in_subtree].nil?
  query_params[:accessLevel] = opts[:access_level] if opts[:access_level]
  query_params[:targetId] = opts[:target_id] if opts[:target_id]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:profileName] = opts[:profile_name] if opts[:profile_name]
  query_params[:isUserCreated] = opts[:is_user_created] if !opts[:is_user_created].nil?
  query_params[:passwordVerificationFunction] = opts[:password_verification_function] if opts[:password_verification_function]
  query_params[:userCountGreaterThanOrEqual] = opts[:user_count_greater_than_or_equal] if opts[:user_count_greater_than_or_equal]
  query_params[:userCountLessThan] = opts[:user_count_less_than] if opts[:user_count_less_than]
  query_params[:failedLoginAttemptsGreaterThanOrEqual] = opts[:failed_login_attempts_greater_than_or_equal] if opts[:failed_login_attempts_greater_than_or_equal]
  query_params[:failedLoginAttemptsLessThan] = opts[:failed_login_attempts_less_than] if opts[:failed_login_attempts_less_than]
  query_params[:sessionsPerUserGreaterThanOrEqual] = opts[:sessions_per_user_greater_than_or_equal] if opts[:sessions_per_user_greater_than_or_equal]
  query_params[:sessionsPerUserLessThan] = opts[:sessions_per_user_less_than] if opts[:sessions_per_user_less_than]
  query_params[:inactiveAccountTimeGreaterThanOrEqual] = opts[:inactive_account_time_greater_than_or_equal] if opts[:inactive_account_time_greater_than_or_equal]
  query_params[:inactiveAccountTimeLessThan] = opts[:inactive_account_time_less_than] if opts[:inactive_account_time_less_than]
  query_params[:passwordLockTimeGreaterThanOrEqual] = opts[:password_lock_time_greater_than_or_equal] if opts[:password_lock_time_greater_than_or_equal]
  query_params[:passwordLockTimeLessThan] = opts[:password_lock_time_less_than] if opts[:password_lock_time_less_than]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#list_profile_summaries') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'Array<OCI::DataSafe::Models::ProfileSummary>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_report_definitions(compartment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_report_definitions API.

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.

Parameters:

• compartment_id (String) —

  A filter to return only resources that match the specified compartment OCID.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :compartment_id_in_subtree (BOOLEAN) —

  Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting. (default to false)

• :access_level (String) —

  Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed. (default to RESTRICTED) Allowed values are: RESTRICTED, ACCESSIBLE

• :display_name (String) —

  The name of the report definition to query.

• :limit (Integer) —

  For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

• :page (String) —

  For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

• :sort_order (String) —

  The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

• :sort_by (String) —

  The field used for sorting. Only one sorting parameter order (sortOrder) can be specified. The default order for TIMECREATED is descending. The default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. (default to TIMECREATED) Allowed values are: TIMECREATED, DISPLAYNAME, DISPLAYORDER

• :opc_request_id (String) —

  Unique identifier for the request.

• :is_seeded (BOOLEAN) —

  A boolean flag indicating to list seeded report definitions. Set this parameter to get list of seeded report definitions. (default to false)

• :data_source (String) —

  Specifies the name of a resource that provides data for the report. For example alerts, events.

• :lifecycle_state (String) —

  An optional filter to return only resources that match the specified lifecycle state.

• :category (String) —

  An optional filter to return only resources that match the specified category. Allowed values are: CUSTOM_REPORTS, SUMMARY, ACTIVITY_AUDITING

Returns:

• (Response) —

  A Response object with data of type ReportDefinitionCollection

# File 'lib/oci/data_safe/data_safe_client.rb', line 12570

def list_report_definitions(compartment_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#list_report_definitions.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_report_definitions." if compartment_id.nil?

  if opts[:access_level] && !%w[RESTRICTED ACCESSIBLE].include?(opts[:access_level])
    raise 'Invalid value for "access_level", must be one of RESTRICTED, ACCESSIBLE.'
  end

  if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of ASC, DESC.'
  end

  if opts[:sort_by] && !%w[TIMECREATED DISPLAYNAME DISPLAYORDER].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of TIMECREATED, DISPLAYNAME, DISPLAYORDER.'
  end

  if opts[:data_source] && !OCI::DataSafe::Models::REPORT_DEFINITION_DATA_SOURCE_ENUM.include?(opts[:data_source])
    raise 'Invalid value for "data_source", must be one of the values in OCI::DataSafe::Models::REPORT_DEFINITION_DATA_SOURCE_ENUM.'
  end

  if opts[:lifecycle_state] && !OCI::DataSafe::Models::REPORT_DEFINITION_LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::DataSafe::Models::REPORT_DEFINITION_LIFECYCLE_STATE_ENUM.'
  end

  if opts[:category] && !%w[CUSTOM_REPORTS SUMMARY ACTIVITY_AUDITING].include?(opts[:category])
    raise 'Invalid value for "category", must be one of CUSTOM_REPORTS, SUMMARY, ACTIVITY_AUDITING.'
  end

  path = '/reportDefinitions'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:compartmentIdInSubtree] = opts[:compartment_id_in_subtree] if !opts[:compartment_id_in_subtree].nil?
  query_params[:accessLevel] = opts[:access_level] if opts[:access_level]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:isSeeded] = opts[:is_seeded] if !opts[:is_seeded].nil?
  query_params[:dataSource] = opts[:data_source] if opts[:data_source]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:category] = opts[:category] if opts[:category]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#list_report_definitions') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataSafe::Models::ReportDefinitionCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_reports(compartment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_reports API.

Gets a list of all the reports in the compartment. It contains information such as report generation time. Allowed values are: timeGenerated, displayName

Parameters:

• compartment_id (String) —

  A filter to return only resources that match the specified compartment OCID.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :compartment_id_in_subtree (BOOLEAN) —

  Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting. (default to false)

• :access_level (String) —

  Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed. (default to RESTRICTED) Allowed values are: RESTRICTED, ACCESSIBLE

• :display_name (String) —

  The name of the report definition to query.

• :limit (Integer) —

  For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

• :page (String) —

  For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

• :sort_order (String) —

  The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

• :sort_by (String) —

  The field to sort by. Only one sort order may be provided. Default order for timeGenerated is descending. Default order for displayName is ascending. If no value is specified timeGenerated is default. (default to timeGenerated)

• :report_definition_id (String) —

  The ID of the report definition to filter the list of reports

• :opc_request_id (String) —

  Unique identifier for the request.

• :lifecycle_state (String) —

  An optional filter to return only resources that match the specified lifecycle state.

• :type (String) —

  An optional filter to return only resources that match the specified type.

Returns:

• (Response) —

  A Response object with data of type ReportCollection

# File 'lib/oci/data_safe/data_safe_client.rb', line 12679

def list_reports(compartment_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#list_reports.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_reports." if compartment_id.nil?

  if opts[:access_level] && !%w[RESTRICTED ACCESSIBLE].include?(opts[:access_level])
    raise 'Invalid value for "access_level", must be one of RESTRICTED, ACCESSIBLE.'
  end

  if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of ASC, DESC.'
  end

  if opts[:sort_by] && !%w[timeGenerated displayName].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of timeGenerated, displayName.'
  end

  if opts[:lifecycle_state] && !OCI::DataSafe::Models::REPORT_LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::DataSafe::Models::REPORT_LIFECYCLE_STATE_ENUM.'
  end

  if opts[:type] && !OCI::DataSafe::Models::REPORT_TYPE_ENUM.include?(opts[:type])
    raise 'Invalid value for "type", must be one of the values in OCI::DataSafe::Models::REPORT_TYPE_ENUM.'
  end

  path = '/reports'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:compartmentIdInSubtree] = opts[:compartment_id_in_subtree] if !opts[:compartment_id_in_subtree].nil?
  query_params[:accessLevel] = opts[:access_level] if opts[:access_level]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:reportDefinitionId] = opts[:report_definition_id] if opts[:report_definition_id]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:type] = opts[:type] if opts[:type]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#list_reports') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataSafe::Models::ReportCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_roles(target_database_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_roles API.

Returns a list of role metadata objects.

Allowed values are: ROLENAME

Parameters:

• target_database_id (String) —

  The OCID of the Data Safe target database.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :opc_request_id (String) —

  Unique identifier for the request.

• :limit (Integer) —

  For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

• :page (String) —

  For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

• :role_name (Array<String>) —

  A filter to return only a specific role based on role name.

• :is_oracle_maintained (BOOLEAN) —

  A filter to return roles based on whether they are maintained by oracle or not.

• :authentication_type (String) —

  A filter to return roles based on authentication type.

• :sort_order (String) —

  The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

• :sort_by (String) —

  The field used for sorting. Only one sorting order (sortOrder) can be specified. (default to ROLENAME)

• :role_name_contains (String) —

  A filter to return only items if role name contains a specific string.

Returns:

• (Response) —

  A Response object with data of type Array<RoleSummary>

# File 'lib/oci/data_safe/data_safe_client.rb', line 12775

def list_roles(target_database_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#list_roles.' if logger

  raise "Missing the required parameter 'target_database_id' when calling list_roles." if target_database_id.nil?

  if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of ASC, DESC.'
  end

  if opts[:sort_by] && !%w[ROLENAME].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of ROLENAME.'
  end
  raise "Parameter value for 'target_database_id' must not be blank" if OCI::Internal::Util.blank_string?(target_database_id)

  path = '/targetDatabases/{targetDatabaseId}/roles'.sub('{targetDatabaseId}', target_database_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:roleName] = OCI::ApiClient.build_collection_params(opts[:role_name], :multi) if opts[:role_name] && !opts[:role_name].empty?
  query_params[:isOracleMaintained] = opts[:is_oracle_maintained] if !opts[:is_oracle_maintained].nil?
  query_params[:authenticationType] = opts[:authentication_type] if opts[:authentication_type]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:roleNameContains] = opts[:role_name_contains] if opts[:role_name_contains]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#list_roles') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'Array<OCI::DataSafe::Models::RoleSummary>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_schemas(target_database_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_schemas API.

Returns list of schema.

Allowed values are: SCHEMANAME

Parameters:

• target_database_id (String) —

  The OCID of the Data Safe target database.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :opc_request_id (String) —

  Unique identifier for the request.

• :limit (Integer) —

  For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

• :page (String) —

  For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

• :schema_name (Array<String>) —

  A filter to return only items related to specific schema name.

• :sort_order (String) —

  The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

• :sort_by (String) —

  The field used for sorting. Only one sorting order (sortOrder) can be specified. (default to SCHEMANAME)

• :is_oracle_maintained (BOOLEAN) —

  A filter to return only items related to specific type of schema.

• :schema_name_contains (String) —

  A filter to return only items if schema name contains a specific string.

Returns:

• (Response) —

  A Response object with data of type Array<SchemaSummary>

# File 'lib/oci/data_safe/data_safe_client.rb', line 12856

def list_schemas(target_database_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#list_schemas.' if logger

  raise "Missing the required parameter 'target_database_id' when calling list_schemas." if target_database_id.nil?

  if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of ASC, DESC.'
  end

  if opts[:sort_by] && !%w[SCHEMANAME].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of SCHEMANAME.'
  end
  raise "Parameter value for 'target_database_id' must not be blank" if OCI::Internal::Util.blank_string?(target_database_id)

  path = '/targetDatabases/{targetDatabaseId}/schemas'.sub('{targetDatabaseId}', target_database_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:schemaName] = OCI::ApiClient.build_collection_params(opts[:schema_name], :multi) if opts[:schema_name] && !opts[:schema_name].empty?
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:isOracleMaintained] = opts[:is_oracle_maintained] if !opts[:is_oracle_maintained].nil?
  query_params[:schemaNameContains] = opts[:schema_name_contains] if opts[:schema_name_contains]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#list_schemas') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'Array<OCI::DataSafe::Models::SchemaSummary>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_sdm_masking_policy_differences(compartment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_sdm_masking_policy_differences API.

Gets a list of SDM and masking policy difference resources based on the specified query parameters.

Parameters:

• compartment_id (String) —

  A filter to return only resources that match the specified compartment OCID.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :compartment_id_in_subtree (BOOLEAN) —

  Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting. (default to false)

• :difference_access_level (String) —

  Valid value is ACCESSIBLE. Default is ACCESSIBLE. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). (default to ACCESSIBLE) Allowed values are: ACCESSIBLE

• :display_name (String) —

  A filter to return only resources that match the specified display name.

• :sensitive_data_model_id (String) —

  A filter to return only the resources that match the specified sensitive data model OCID.

• :lifecycle_state (String) —

  A filter to return only the resources that match the specified lifecycle states.

• :masking_policy_id (String) —

  A filter to return only the resources that match the specified masking policy OCID.

• :sort_order (String) —

  The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

• :sort_by (String) —

  The field to sort by. You can specify only one sorting parameter (sortOrder). The default order for timeCreationStarted is descending. The default order for displayName is ascending. (default to timeCreationStarted) Allowed values are: timeCreationStarted, displayName

• :opc_request_id (String) —

  Unique identifier for the request.

• :limit (Integer) —

  For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

• :page (String) —

  For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

Returns:

• (Response) —

  A Response object with data of type SdmMaskingPolicyDifferenceCollection

# File 'lib/oci/data_safe/data_safe_client.rb', line 12947

def list_sdm_masking_policy_differences(compartment_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#list_sdm_masking_policy_differences.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_sdm_masking_policy_differences." if compartment_id.nil?

  if opts[:difference_access_level] && !%w[ACCESSIBLE].include?(opts[:difference_access_level])
    raise 'Invalid value for "difference_access_level", must be one of ACCESSIBLE.'
  end

  if opts[:lifecycle_state] && !OCI::DataSafe::Models::SdmMaskingPolicyDifference::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::DataSafe::Models::SdmMaskingPolicyDifference::LIFECYCLE_STATE_ENUM.'
  end

  if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of ASC, DESC.'
  end

  if opts[:sort_by] && !%w[timeCreationStarted displayName].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of timeCreationStarted, displayName.'
  end

  path = '/sdmMaskingPolicyDifferences'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:compartmentIdInSubtree] = opts[:compartment_id_in_subtree] if !opts[:compartment_id_in_subtree].nil?
  query_params[:differenceAccessLevel] = opts[:difference_access_level] if opts[:difference_access_level]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:sensitiveDataModelId] = opts[:sensitive_data_model_id] if opts[:sensitive_data_model_id]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:maskingPolicyId] = opts[:masking_policy_id] if opts[:masking_policy_id]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#list_sdm_masking_policy_differences') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataSafe::Models::SdmMaskingPolicyDifferenceCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_security_assessments(compartment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_security_assessments API.

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.

Allowed values are: timeCreated, displayName

Parameters:

• compartment_id (String) —

  A filter to return only resources that match the specified compartment OCID.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :compartment_id_in_subtree (BOOLEAN) —

  Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting. (default to false)

• :access_level (String) —

  Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed. (default to RESTRICTED) Allowed values are: RESTRICTED, ACCESSIBLE

• :display_name (String) —

  A filter to return only resources that match the specified display name.

• :type (String) —

  A filter to return only items that match the specified security assessment type. Allowed values are: LATEST, SAVED, SAVE_SCHEDULE, COMPARTMENT

• :schedule_assessment_id (String) —

  The OCID of the security assessment of type SAVE_SCHEDULE.

• :is_schedule_assessment (BOOLEAN) —

  A filter to return only security assessments of type save schedule. (default to false)

• :triggered_by (String) —

  A filter to return only security asessments that were created by either user or system. Allowed values are: USER, SYSTEM

• :target_id (String) —

  A filter to return only items related to a specific target OCID.

• :sort_order (String) —

  The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

• :is_baseline (BOOLEAN) —

  A filter to return only the security assessments that are set as a baseline. (default to false)

• :sort_by (String) —

  The field to sort by. You can specify only one sort order(sortOrder). The default order for timeCreated is descending. (default to timeCreated)

• :time_created_greater_than_or_equal_to (DateTime) —

  A filter to return only the resources that were created after the specified date and time, as defined by RFC3339. Using TimeCreatedGreaterThanOrEqualToQueryParam parameter retrieves all resources created after that date.

  Example: 2016-12-19T16:39:57.600Z

• :time_created_less_than (DateTime) —

  Search for resources that were created before a specific date. Specifying this parameter corresponding timeCreatedLessThan parameter will retrieve all resources created before the specified created date, in "YYYY-MM-ddThh:mmZ" format with a Z offset, as defined by RFC 3339.

  Example: 2016-12-19T16:39:57.600Z

• :opc_request_id (String) —

  Unique identifier for the request.

• :limit (Integer) —

  For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

• :page (String) —

  For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

• :lifecycle_state (String) —

  A filter to return only resources that match the specified lifecycle state.

Returns:

• (Response) —

  A Response object with data of type Array<SecurityAssessmentSummary>

# File 'lib/oci/data_safe/data_safe_client.rb', line 13083

def list_security_assessments(compartment_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#list_security_assessments.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_security_assessments." if compartment_id.nil?

  if opts[:access_level] && !%w[RESTRICTED ACCESSIBLE].include?(opts[:access_level])
    raise 'Invalid value for "access_level", must be one of RESTRICTED, ACCESSIBLE.'
  end

  if opts[:type] && !%w[LATEST SAVED SAVE_SCHEDULE COMPARTMENT].include?(opts[:type])
    raise 'Invalid value for "type", must be one of LATEST, SAVED, SAVE_SCHEDULE, COMPARTMENT.'
  end

  if opts[:triggered_by] && !%w[USER SYSTEM].include?(opts[:triggered_by])
    raise 'Invalid value for "triggered_by", must be one of USER, SYSTEM.'
  end

  if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of ASC, DESC.'
  end

  if opts[:sort_by] && !%w[timeCreated displayName].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of timeCreated, displayName.'
  end

  if opts[:lifecycle_state] && !OCI::DataSafe::Models::SECURITY_ASSESSMENT_LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::DataSafe::Models::SECURITY_ASSESSMENT_LIFECYCLE_STATE_ENUM.'
  end

  path = '/securityAssessments'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:compartmentIdInSubtree] = opts[:compartment_id_in_subtree] if !opts[:compartment_id_in_subtree].nil?
  query_params[:accessLevel] = opts[:access_level] if opts[:access_level]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:type] = opts[:type] if opts[:type]
  query_params[:scheduleAssessmentId] = opts[:schedule_assessment_id] if opts[:schedule_assessment_id]
  query_params[:isScheduleAssessment] = opts[:is_schedule_assessment] if !opts[:is_schedule_assessment].nil?
  query_params[:triggeredBy] = opts[:triggered_by] if opts[:triggered_by]
  query_params[:targetId] = opts[:target_id] if opts[:target_id]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:isBaseline] = opts[:is_baseline] if !opts[:is_baseline].nil?
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:timeCreatedGreaterThanOrEqualTo] = opts[:time_created_greater_than_or_equal_to] if opts[:time_created_greater_than_or_equal_to]
  query_params[:timeCreatedLessThan] = opts[:time_created_less_than] if opts[:time_created_less_than]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#list_security_assessments') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'Array<OCI::DataSafe::Models::SecurityAssessmentSummary>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_security_policies(compartment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_security_policies API.

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.

Parameters:

• compartment_id (String) —

  A filter to return only resources that match the specified compartment OCID.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :compartment_id_in_subtree (BOOLEAN) —

  Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting. (default to false)

• :access_level (String) —

  Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed. (default to RESTRICTED) Allowed values are: RESTRICTED, ACCESSIBLE

• :display_name (String) —

  A filter to return only resources that match the specified display name.

• :limit (Integer) —

  For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

• :page (String) —

  For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

• :lifecycle_state (String) —

  The current state of the security policy.

• :security_policy_id (String) —

  An optional filter to return only resources that match the specified OCID of the security policy resource.

• :sort_order (String) —

  The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

• :sort_by (String) —

  The field used for sorting. Only one sorting order (sortOrder) can be specified. The default order for TIMECREATED is descending. The default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. (default to TIMECREATED) Allowed values are: TIMECREATED, DISPLAYNAME

• :opc_request_id (String) —

  Unique identifier for the request.

Returns:

• (Response) —

  A Response object with data of type SecurityPolicyCollection

# File 'lib/oci/data_safe/data_safe_client.rb', line 13213

def list_security_policies(compartment_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#list_security_policies.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_security_policies." if compartment_id.nil?

  if opts[:access_level] && !%w[RESTRICTED ACCESSIBLE].include?(opts[:access_level])
    raise 'Invalid value for "access_level", must be one of RESTRICTED, ACCESSIBLE.'
  end

  if opts[:lifecycle_state] && !OCI::DataSafe::Models::SECURITY_POLICY_LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::DataSafe::Models::SECURITY_POLICY_LIFECYCLE_STATE_ENUM.'
  end

  if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of ASC, DESC.'
  end

  if opts[:sort_by] && !%w[TIMECREATED DISPLAYNAME].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of TIMECREATED, DISPLAYNAME.'
  end

  path = '/securityPolicies'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:compartmentIdInSubtree] = opts[:compartment_id_in_subtree] if !opts[:compartment_id_in_subtree].nil?
  query_params[:accessLevel] = opts[:access_level] if opts[:access_level]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:securityPolicyId] = opts[:security_policy_id] if opts[:security_policy_id]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#list_security_policies') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataSafe::Models::SecurityPolicyCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_security_policy_deployments(compartment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_security_policy_deployments API.

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.

Parameters:

• compartment_id (String) —

  A filter to return only resources that match the specified compartment OCID.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :compartment_id_in_subtree (BOOLEAN) —

  Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting. (default to false)

• :access_level (String) —

  Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed. (default to RESTRICTED) Allowed values are: RESTRICTED, ACCESSIBLE

• :display_name (String) —

  A filter to return only resources that match the specified display name.

• :limit (Integer) —

  For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

• :page (String) —

  For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

• :lifecycle_state (String) —

  The current state of the security policy deployment.

• :security_policy_deployment_id (String) —

  An optional filter to return only resources that match the specified OCID of the security policy deployment resource.

• :target_id (String) —

  A filter to return only items related to a specific target OCID.

• :security_policy_id (String) —

  An optional filter to return only resources that match the specified OCID of the security policy resource.

• :sort_order (String) —

  The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

• :sort_by (String) —

  The field used for sorting. Only one sorting order (sortOrder) can be specified. The default order for TIMECREATED is descending. The default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. (default to TIMECREATED) Allowed values are: TIMECREATED, DISPLAYNAME

• :opc_request_id (String) —

  Unique identifier for the request.

Returns:

• (Response) —

  A Response object with data of type SecurityPolicyDeploymentCollection

# File 'lib/oci/data_safe/data_safe_client.rb', line 13330

def list_security_policy_deployments(compartment_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#list_security_policy_deployments.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_security_policy_deployments." if compartment_id.nil?

  if opts[:access_level] && !%w[RESTRICTED ACCESSIBLE].include?(opts[:access_level])
    raise 'Invalid value for "access_level", must be one of RESTRICTED, ACCESSIBLE.'
  end

  if opts[:lifecycle_state] && !OCI::DataSafe::Models::SECURITY_POLICY_DEPLOYMENT_LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::DataSafe::Models::SECURITY_POLICY_DEPLOYMENT_LIFECYCLE_STATE_ENUM.'
  end

  if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of ASC, DESC.'
  end

  if opts[:sort_by] && !%w[TIMECREATED DISPLAYNAME].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of TIMECREATED, DISPLAYNAME.'
  end

  path = '/securityPolicyDeployments'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:compartmentIdInSubtree] = opts[:compartment_id_in_subtree] if !opts[:compartment_id_in_subtree].nil?
  query_params[:accessLevel] = opts[:access_level] if opts[:access_level]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:securityPolicyDeploymentId] = opts[:security_policy_deployment_id] if opts[:security_policy_deployment_id]
  query_params[:targetId] = opts[:target_id] if opts[:target_id]
  query_params[:securityPolicyId] = opts[:security_policy_id] if opts[:security_policy_id]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#list_security_policy_deployments') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataSafe::Models::SecurityPolicyDeploymentCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_security_policy_entry_states(security_policy_deployment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_security_policy_entry_states API.

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.

Parameters:

• security_policy_deployment_id (String) —

  The OCID of the security policy deployment resource.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :limit (Integer) —

  For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

• :page (String) —

  For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

• :deployment_status (String) —

  The current state of the security policy deployment.

• :security_policy_entry_id (String) —

  An optional filter to return only resources that match the specified security policy entry OCID.

• :opc_request_id (String) —

  Unique identifier for the request.

Returns:

• (Response) —

  A Response object with data of type SecurityPolicyEntryStateCollection

# File 'lib/oci/data_safe/data_safe_client.rb', line 13418

def list_security_policy_entry_states(security_policy_deployment_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#list_security_policy_entry_states.' if logger

  raise "Missing the required parameter 'security_policy_deployment_id' when calling list_security_policy_entry_states." if security_policy_deployment_id.nil?

  if opts[:deployment_status] && !OCI::DataSafe::Models::SECURITY_POLICY_ENTRY_STATE_DEPLOYMENT_STATUS_ENUM.include?(opts[:deployment_status])
    raise 'Invalid value for "deployment_status", must be one of the values in OCI::DataSafe::Models::SECURITY_POLICY_ENTRY_STATE_DEPLOYMENT_STATUS_ENUM.'
  end
  raise "Parameter value for 'security_policy_deployment_id' must not be blank" if OCI::Internal::Util.blank_string?(security_policy_deployment_id)

  path = '/securityPolicyDeployments/{securityPolicyDeploymentId}/securityPolicyEntryStates'.sub('{securityPolicyDeploymentId}', security_policy_deployment_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:deploymentStatus] = opts[:deployment_status] if opts[:deployment_status]
  query_params[:securityPolicyEntryId] = opts[:security_policy_entry_id] if opts[:security_policy_entry_id]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#list_security_policy_entry_states') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataSafe::Models::SecurityPolicyEntryStateCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_sensitive_columns(sensitive_data_model_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_sensitive_columns API.

Gets a list of sensitive columns present in the specified sensitive data model based on the specified query parameters.

Parameters:

• sensitive_data_model_id (String) —

  The OCID of the sensitive data model.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :time_created_greater_than_or_equal_to (DateTime) —

  A filter to return only the resources that were created after the specified date and time, as defined by RFC3339. Using TimeCreatedGreaterThanOrEqualToQueryParam parameter retrieves all resources created after that date.

  Example: 2016-12-19T16:39:57.600Z

• :time_created_less_than (DateTime) —

  Search for resources that were created before a specific date. Specifying this parameter corresponding timeCreatedLessThan parameter will retrieve all resources created before the specified created date, in "YYYY-MM-ddThh:mmZ" format with a Z offset, as defined by RFC 3339.

  Example: 2016-12-19T16:39:57.600Z

• :time_updated_greater_than_or_equal_to (DateTime) —

  Search for resources that were updated after a specific date. Specifying this parameter corresponding timeUpdatedGreaterThanOrEqualTo parameter will retrieve all resources updated after the specified created date, in "YYYY-MM-ddThh:mmZ" format with a Z offset, as defined by RFC 3339.

• :time_updated_less_than (DateTime) —

  Search for resources that were updated before a specific date. Specifying this parameter corresponding timeUpdatedLessThan parameter will retrieve all resources updated before the specified created date, in "YYYY-MM-ddThh:mmZ" format with a Z offset, as defined by RFC 3339.

• :sensitive_column_lifecycle_state (String) —

  Filters the sensitive column resources with the given lifecycle state values.

• :schema_name (Array<String>) —

  A filter to return only items related to specific schema name.

• :object_name (Array<String>) —

  A filter to return only items related to a specific object name.

• :column_name (Array<String>) —

  A filter to return only a specific column based on column name.

• :object_type (Array<String>) —

  A filter to return only items related to a specific object type. (default to [ALL]) Allowed values are: ALL, TABLE, EDITIONING_VIEW

• :data_type (Array<String>) —

  A filter to return only the resources that match the specified data types.

• :status (Array<String>) —

  A filter to return only the sensitive columns that match the specified status. Allowed values are: VALID, INVALID

• :sensitive_type_id (Array<String>) —

  A filter to return only the sensitive columns that are associated with one of the sensitive types identified by the specified OCIDs.

• :parent_column_key (Array<String>) —

  A filter to return only the sensitive columns that are children of one of the columns identified by the specified keys.

• :relation_type (Array<String>) —

  A filter to return sensitive columns based on their relationship with their parent columns. If set to NONE, it returns the sensitive columns that do not have any parent. The response includes the parent columns as well as the independent columns that are not in any relationship. If set to APP_DEFINED, it returns all the child columns that have application-level (non-dictionary) relationship with their parents. If set to DB_DEFINED, it returns all the child columns that have database-level (dictionary-defined) relationship with their parents.

  Allowed values are: NONE, APP_DEFINED, DB_DEFINED

• :column_group (String) —

  A filter to return only the sensitive columns that belong to the specified column group.

• :limit (Integer) —

  For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

• :page (String) —

  For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

• :sort_order (String) —

  The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

• :sort_by (String) —

  The field to sort by. You can specify only one sorting parameter (sortOrder). The default order for timeCreated is descending. The default order for schemaName, objectName, and columnName is ascending. (default to timeCreated) Allowed values are: timeCreated, schemaName, objectName, columnName, dataType

• :opc_request_id (String) —

  Unique identifier for the request.

• :is_case_in_sensitive (BOOLEAN) —

  A boolean flag indicating whether the search should be case-insensitive. The search is case-sensitive by default. Set this parameter to true to do case-insensitive search.

Returns:

• (Response) —

  A Response object with data of type SensitiveColumnCollection

# File 'lib/oci/data_safe/data_safe_client.rb', line 13536

def list_sensitive_columns(sensitive_data_model_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#list_sensitive_columns.' if logger

  raise "Missing the required parameter 'sensitive_data_model_id' when calling list_sensitive_columns." if sensitive_data_model_id.nil?

  if opts[:sensitive_column_lifecycle_state] && !OCI::DataSafe::Models::SENSITIVE_COLUMN_LIFECYCLE_STATE_ENUM.include?(opts[:sensitive_column_lifecycle_state])
    raise 'Invalid value for "sensitive_column_lifecycle_state", must be one of the values in OCI::DataSafe::Models::SENSITIVE_COLUMN_LIFECYCLE_STATE_ENUM.'
  end


  object_type_allowable_values = %w[ALL TABLE EDITIONING_VIEW]
  if opts[:object_type] && !opts[:object_type].empty?
    opts[:object_type].each do |val_to_check|
      unless object_type_allowable_values.include?(val_to_check)
        raise 'Invalid value for "object_type", must be one of ALL, TABLE, EDITIONING_VIEW.'
      end
    end
  end


  status_allowable_values = %w[VALID INVALID]
  if opts[:status] && !opts[:status].empty?
    opts[:status].each do |val_to_check|
      unless status_allowable_values.include?(val_to_check)
        raise 'Invalid value for "status", must be one of VALID, INVALID.'
      end
    end
  end


  relation_type_allowable_values = %w[NONE APP_DEFINED DB_DEFINED]
  if opts[:relation_type] && !opts[:relation_type].empty?
    opts[:relation_type].each do |val_to_check|
      unless relation_type_allowable_values.include?(val_to_check)
        raise 'Invalid value for "relation_type", must be one of NONE, APP_DEFINED, DB_DEFINED.'
      end
    end
  end

  if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of ASC, DESC.'
  end

  if opts[:sort_by] && !%w[timeCreated schemaName objectName columnName dataType].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of timeCreated, schemaName, objectName, columnName, dataType.'
  end
  raise "Parameter value for 'sensitive_data_model_id' must not be blank" if OCI::Internal::Util.blank_string?(sensitive_data_model_id)

  path = '/sensitiveDataModels/{sensitiveDataModelId}/sensitiveColumns'.sub('{sensitiveDataModelId}', sensitive_data_model_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:timeCreatedGreaterThanOrEqualTo] = opts[:time_created_greater_than_or_equal_to] if opts[:time_created_greater_than_or_equal_to]
  query_params[:timeCreatedLessThan] = opts[:time_created_less_than] if opts[:time_created_less_than]
  query_params[:timeUpdatedGreaterThanOrEqualTo] = opts[:time_updated_greater_than_or_equal_to] if opts[:time_updated_greater_than_or_equal_to]
  query_params[:timeUpdatedLessThan] = opts[:time_updated_less_than] if opts[:time_updated_less_than]
  query_params[:sensitiveColumnLifecycleState] = opts[:sensitive_column_lifecycle_state] if opts[:sensitive_column_lifecycle_state]
  query_params[:schemaName] = OCI::ApiClient.build_collection_params(opts[:schema_name], :multi) if opts[:schema_name] && !opts[:schema_name].empty?
  query_params[:objectName] = OCI::ApiClient.build_collection_params(opts[:object_name], :multi) if opts[:object_name] && !opts[:object_name].empty?
  query_params[:columnName] = OCI::ApiClient.build_collection_params(opts[:column_name], :multi) if opts[:column_name] && !opts[:column_name].empty?
  query_params[:objectType] = OCI::ApiClient.build_collection_params(opts[:object_type], :multi) if opts[:object_type] && !opts[:object_type].empty?
  query_params[:dataType] = OCI::ApiClient.build_collection_params(opts[:data_type], :multi) if opts[:data_type] && !opts[:data_type].empty?
  query_params[:status] = OCI::ApiClient.build_collection_params(opts[:status], :multi) if opts[:status] && !opts[:status].empty?
  query_params[:sensitiveTypeId] = OCI::ApiClient.build_collection_params(opts[:sensitive_type_id], :multi) if opts[:sensitive_type_id] && !opts[:sensitive_type_id].empty?
  query_params[:parentColumnKey] = OCI::ApiClient.build_collection_params(opts[:parent_column_key], :multi) if opts[:parent_column_key] && !opts[:parent_column_key].empty?
  query_params[:relationType] = OCI::ApiClient.build_collection_params(opts[:relation_type], :multi) if opts[:relation_type] && !opts[:relation_type].empty?
  query_params[:columnGroup] = opts[:column_group] if opts[:column_group]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:isCaseInSensitive] = opts[:is_case_in_sensitive] if !opts[:is_case_in_sensitive].nil?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#list_sensitive_columns') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataSafe::Models::SensitiveColumnCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_sensitive_data_models(compartment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_sensitive_data_models API.

Gets a list of sensitive data models based on the specified query parameters.

Parameters:

• compartment_id (String) —

  A filter to return only resources that match the specified compartment OCID.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :compartment_id_in_subtree (BOOLEAN) —

  Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting. (default to false)

• :access_level (String) —

  Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed. (default to RESTRICTED) Allowed values are: RESTRICTED, ACCESSIBLE

• :display_name (String) —

  A filter to return only resources that match the specified display name.

• :sensitive_data_model_id (String) —

  A filter to return only the resources that match the specified sensitive data model OCID.

• :time_created_greater_than_or_equal_to (DateTime) —

  A filter to return only the resources that were created after the specified date and time, as defined by RFC3339. Using TimeCreatedGreaterThanOrEqualToQueryParam parameter retrieves all resources created after that date.

  Example: 2016-12-19T16:39:57.600Z

• :time_created_less_than (DateTime) —

  Search for resources that were created before a specific date. Specifying this parameter corresponding timeCreatedLessThan parameter will retrieve all resources created before the specified created date, in "YYYY-MM-ddThh:mmZ" format with a Z offset, as defined by RFC 3339.

  Example: 2016-12-19T16:39:57.600Z

• :target_id (String) —

  A filter to return only items related to a specific target OCID.

• :sort_order (String) —

  The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

• :sort_by (String) —

  The field to sort by. You can specify only one sorting parameter (sortOrder). The default order for timeCreated is descending. The default order for displayName is ascending. (default to timeCreated) Allowed values are: timeCreated, displayName

• :opc_request_id (String) —

  Unique identifier for the request.

• :limit (Integer) —

  For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

• :page (String) —

  For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

• :lifecycle_state (String) —

  A filter to return only the resources that match the specified lifecycle state.

Returns:

• (Response) —

  A Response object with data of type SensitiveDataModelCollection

# File 'lib/oci/data_safe/data_safe_client.rb', line 13688

def list_sensitive_data_models(compartment_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#list_sensitive_data_models.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_sensitive_data_models." if compartment_id.nil?

  if opts[:access_level] && !%w[RESTRICTED ACCESSIBLE].include?(opts[:access_level])
    raise 'Invalid value for "access_level", must be one of RESTRICTED, ACCESSIBLE.'
  end

  if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of ASC, DESC.'
  end

  if opts[:sort_by] && !%w[timeCreated displayName].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of timeCreated, displayName.'
  end

  if opts[:lifecycle_state] && !OCI::DataSafe::Models::DISCOVERY_LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::DataSafe::Models::DISCOVERY_LIFECYCLE_STATE_ENUM.'
  end

  path = '/sensitiveDataModels'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:compartmentIdInSubtree] = opts[:compartment_id_in_subtree] if !opts[:compartment_id_in_subtree].nil?
  query_params[:accessLevel] = opts[:access_level] if opts[:access_level]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:sensitiveDataModelId] = opts[:sensitive_data_model_id] if opts[:sensitive_data_model_id]
  query_params[:timeCreatedGreaterThanOrEqualTo] = opts[:time_created_greater_than_or_equal_to] if opts[:time_created_greater_than_or_equal_to]
  query_params[:timeCreatedLessThan] = opts[:time_created_less_than] if opts[:time_created_less_than]
  query_params[:targetId] = opts[:target_id] if opts[:target_id]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#list_sensitive_data_models') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataSafe::Models::SensitiveDataModelCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_sensitive_objects(sensitive_data_model_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_sensitive_objects API.

Gets a list of sensitive objects present in the specified sensitive data model based on the specified query parameters.

Parameters:

• sensitive_data_model_id (String) —

  The OCID of the sensitive data model.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :schema_name (Array<String>) —

  A filter to return only items related to specific schema name.

• :object_name (Array<String>) —

  A filter to return only items related to a specific object name.

• :object_type (Array<String>) —

  A filter to return only items related to a specific object type. (default to [ALL]) Allowed values are: ALL, TABLE, EDITIONING_VIEW

• :limit (Integer) —

  For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

• :page (String) —

  For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

• :sort_order (String) —

  The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

• :sort_by (String) —

  The field to sort by. You can specify only one sorting parameter (sortOrder). The default order is ascending. (default to schemaName) Allowed values are: schemaName, objectName, objectType

• :opc_request_id (String) —

  Unique identifier for the request.

Returns:

• (Response) —

  A Response object with data of type SensitiveObjectCollection

# File 'lib/oci/data_safe/data_safe_client.rb', line 13783

def list_sensitive_objects(sensitive_data_model_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#list_sensitive_objects.' if logger

  raise "Missing the required parameter 'sensitive_data_model_id' when calling list_sensitive_objects." if sensitive_data_model_id.nil?


  object_type_allowable_values = %w[ALL TABLE EDITIONING_VIEW]
  if opts[:object_type] && !opts[:object_type].empty?
    opts[:object_type].each do |val_to_check|
      unless object_type_allowable_values.include?(val_to_check)
        raise 'Invalid value for "object_type", must be one of ALL, TABLE, EDITIONING_VIEW.'
      end
    end
  end

  if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of ASC, DESC.'
  end

  if opts[:sort_by] && !%w[schemaName objectName objectType].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of schemaName, objectName, objectType.'
  end
  raise "Parameter value for 'sensitive_data_model_id' must not be blank" if OCI::Internal::Util.blank_string?(sensitive_data_model_id)

  path = '/sensitiveDataModels/{sensitiveDataModelId}/sensitiveObjects'.sub('{sensitiveDataModelId}', sensitive_data_model_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:schemaName] = OCI::ApiClient.build_collection_params(opts[:schema_name], :multi) if opts[:schema_name] && !opts[:schema_name].empty?
  query_params[:objectName] = OCI::ApiClient.build_collection_params(opts[:object_name], :multi) if opts[:object_name] && !opts[:object_name].empty?
  query_params[:objectType] = OCI::ApiClient.build_collection_params(opts[:object_type], :multi) if opts[:object_type] && !opts[:object_type].empty?
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#list_sensitive_objects') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataSafe::Models::SensitiveObjectCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_sensitive_schemas(sensitive_data_model_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_sensitive_schemas API.

Gets a list of sensitive schemas present in the specified sensitive data model based on the specified query parameters.

Parameters:

• sensitive_data_model_id (String) —

  The OCID of the sensitive data model.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :schema_name (Array<String>) —

  A filter to return only items related to specific schema name.

• :limit (Integer) —

  For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

• :page (String) —

  For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

• :sort_order (String) —

  The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

• :sort_by (String) —

  The field to sort by. You can specify only one sorting parameter (sortOrder). The default order is ascending. (default to schemaName) Allowed values are: schemaName

• :opc_request_id (String) —

  Unique identifier for the request.

Returns:

• (Response) —

  A Response object with data of type SensitiveSchemaCollection

# File 'lib/oci/data_safe/data_safe_client.rb', line 13872

def list_sensitive_schemas(sensitive_data_model_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#list_sensitive_schemas.' if logger

  raise "Missing the required parameter 'sensitive_data_model_id' when calling list_sensitive_schemas." if sensitive_data_model_id.nil?

  if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of ASC, DESC.'
  end

  if opts[:sort_by] && !%w[schemaName].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of schemaName.'
  end
  raise "Parameter value for 'sensitive_data_model_id' must not be blank" if OCI::Internal::Util.blank_string?(sensitive_data_model_id)

  path = '/sensitiveDataModels/{sensitiveDataModelId}/sensitiveSchemas'.sub('{sensitiveDataModelId}', sensitive_data_model_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:schemaName] = OCI::ApiClient.build_collection_params(opts[:schema_name], :multi) if opts[:schema_name] && !opts[:schema_name].empty?
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#list_sensitive_schemas') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataSafe::Models::SensitiveSchemaCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_sensitive_types(compartment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_sensitive_types API.

Gets a list of sensitive types based on the specified query parameters.

Parameters:

• compartment_id (String) —

  A filter to return only resources that match the specified compartment OCID.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :compartment_id_in_subtree (BOOLEAN) —

  Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting. (default to false)

• :access_level (String) —

  Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed. (default to RESTRICTED) Allowed values are: RESTRICTED, ACCESSIBLE

• :display_name (String) —

  A filter to return only resources that match the specified display name.

• :sensitive_type_id (String) —

  A filter to return only items related to a specific sensitive type OCID.

• :sensitive_type_source (String) —

  A filter to return the sensitive type resources based on the value of their source attribute. (default to USER)

• :entity_type (String) —

  A filter to return the sensitive type resources based on the value of their entityType attribute.

• :parent_category_id (String) —

  A filter to return only the sensitive types that are children of the sensitive category identified by the specified OCID.

• :default_masking_format_id (String) —

  A filter to return only the sensitive types that have the default masking format identified by the specified OCID.

• :time_created_greater_than_or_equal_to (DateTime) —

  A filter to return only the resources that were created after the specified date and time, as defined by RFC3339. Using TimeCreatedGreaterThanOrEqualToQueryParam parameter retrieves all resources created after that date.

  Example: 2016-12-19T16:39:57.600Z

• :time_created_less_than (DateTime) —

  Search for resources that were created before a specific date. Specifying this parameter corresponding timeCreatedLessThan parameter will retrieve all resources created before the specified created date, in "YYYY-MM-ddThh:mmZ" format with a Z offset, as defined by RFC 3339.

  Example: 2016-12-19T16:39:57.600Z

• :sort_order (String) —

  The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

• :sort_by (String) —

  The field to sort by. You can specify only one sorting parameter (sortOrder). The default order for timeCreated is descending. The default order for displayName is ascending. (default to timeCreated) Allowed values are: timeCreated, displayName

• :opc_request_id (String) —

  Unique identifier for the request.

• :limit (Integer) —

  For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

• :page (String) —

  For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

• :lifecycle_state (String) —

  A filter to return only the resources that match the specified lifecycle state.

Returns:

• (Response) —

  A Response object with data of type SensitiveTypeCollection

# File 'lib/oci/data_safe/data_safe_client.rb', line 13978

def list_sensitive_types(compartment_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#list_sensitive_types.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_sensitive_types." if compartment_id.nil?

  if opts[:access_level] && !%w[RESTRICTED ACCESSIBLE].include?(opts[:access_level])
    raise 'Invalid value for "access_level", must be one of RESTRICTED, ACCESSIBLE.'
  end

  if opts[:sensitive_type_source] && !OCI::DataSafe::Models::SENSITIVE_TYPE_SOURCE_ENUM.include?(opts[:sensitive_type_source])
    raise 'Invalid value for "sensitive_type_source", must be one of the values in OCI::DataSafe::Models::SENSITIVE_TYPE_SOURCE_ENUM.'
  end

  if opts[:entity_type] && !OCI::DataSafe::Models::SENSITIVE_TYPE_ENTITY_ENUM.include?(opts[:entity_type])
    raise 'Invalid value for "entity_type", must be one of the values in OCI::DataSafe::Models::SENSITIVE_TYPE_ENTITY_ENUM.'
  end

  if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of ASC, DESC.'
  end

  if opts[:sort_by] && !%w[timeCreated displayName].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of timeCreated, displayName.'
  end

  if opts[:lifecycle_state] && !OCI::DataSafe::Models::DISCOVERY_LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::DataSafe::Models::DISCOVERY_LIFECYCLE_STATE_ENUM.'
  end

  path = '/sensitiveTypes'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:compartmentIdInSubtree] = opts[:compartment_id_in_subtree] if !opts[:compartment_id_in_subtree].nil?
  query_params[:accessLevel] = opts[:access_level] if opts[:access_level]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:sensitiveTypeId] = opts[:sensitive_type_id] if opts[:sensitive_type_id]
  query_params[:sensitiveTypeSource] = opts[:sensitive_type_source] if opts[:sensitive_type_source]
  query_params[:entityType] = opts[:entity_type] if opts[:entity_type]
  query_params[:parentCategoryId] = opts[:parent_category_id] if opts[:parent_category_id]
  query_params[:defaultMaskingFormatId] = opts[:default_masking_format_id] if opts[:default_masking_format_id]
  query_params[:timeCreatedGreaterThanOrEqualTo] = opts[:time_created_greater_than_or_equal_to] if opts[:time_created_greater_than_or_equal_to]
  query_params[:timeCreatedLessThan] = opts[:time_created_less_than] if opts[:time_created_less_than]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#list_sensitive_types') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataSafe::Models::SensitiveTypeCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_sql_collection_analytics(compartment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_sql_collection_analytics API.

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.

Parameters:

• compartment_id (String) —

  A filter to return only resources that match the specified compartment OCID.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :compartment_id_in_subtree (BOOLEAN) —

  Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting. (default to false)

• :access_level (String) —

  Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed. (default to RESTRICTED) Allowed values are: RESTRICTED, ACCESSIBLE

• :limit (Integer) —

  For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

• :page (String) —

  For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

• :lifecycle_state (String) —

  The current state of the SQL collection.

• :target_id (String) —

  A filter to return only items related to a specific target OCID.

• :opc_request_id (String) —

  Unique identifier for the request.

• :group_by (Array<String>) —

  The group by parameter to summarize SQL collection aggregation. Allowed values are: targetId, lifecycleState

• :time_started (DateTime) —

  An optional filter to return the stats of the SQL collection logs collected after the date-time specified, in the format defined by RFC3339.

• :time_ended (DateTime) —

  An optional filter to return the stats of the SQL collection logs collected before the date-time specified, in the format defined by RFC3339.

Returns:

• (Response) —

  A Response object with data of type SqlCollectionAnalyticsCollection

# File 'lib/oci/data_safe/data_safe_client.rb', line 14106

def list_sql_collection_analytics(compartment_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#list_sql_collection_analytics.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_sql_collection_analytics." if compartment_id.nil?

  if opts[:access_level] && !%w[RESTRICTED ACCESSIBLE].include?(opts[:access_level])
    raise 'Invalid value for "access_level", must be one of RESTRICTED, ACCESSIBLE.'
  end

  if opts[:lifecycle_state] && !OCI::DataSafe::Models::SQL_COLLECTION_LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::DataSafe::Models::SQL_COLLECTION_LIFECYCLE_STATE_ENUM.'
  end


  group_by_allowable_values = %w[targetId lifecycleState]
  if opts[:group_by] && !opts[:group_by].empty?
    opts[:group_by].each do |val_to_check|
      unless group_by_allowable_values.include?(val_to_check)
        raise 'Invalid value for "group_by", must be one of targetId, lifecycleState.'
      end
    end
  end

  path = '/sqlCollectionAnalytics'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:compartmentIdInSubtree] = opts[:compartment_id_in_subtree] if !opts[:compartment_id_in_subtree].nil?
  query_params[:accessLevel] = opts[:access_level] if opts[:access_level]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:targetId] = opts[:target_id] if opts[:target_id]
  query_params[:groupBy] = OCI::ApiClient.build_collection_params(opts[:group_by], :multi) if opts[:group_by] && !opts[:group_by].empty?
  query_params[:timeStarted] = opts[:time_started] if opts[:time_started]
  query_params[:timeEnded] = opts[:time_ended] if opts[:time_ended]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#list_sql_collection_analytics') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataSafe::Models::SqlCollectionAnalyticsCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_sql_collection_log_insights(time_started, time_ended, sql_collection_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_sql_collection_log_insights API.

Retrieves a list of the SQL collection log analytics.

Parameters:

• time_started (DateTime) —

  An optional filter to return the stats of the SQL collection logs collected after the date-time specified, in the format defined by RFC3339.

• time_ended (DateTime) —

  An optional filter to return the stats of the SQL collection logs collected before the date-time specified, in the format defined by RFC3339.

• sql_collection_id (String) —

  The OCID of the SQL collection resource.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :limit (Integer) —

  For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

• :page (String) —

  For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

• :opc_request_id (String) —

  Unique identifier for the request.

• :group_by (String) —

  The group by parameter to summarize SQL collection log insights aggregation. Allowed values are: clientIp, clientProgram, clientOsUserName

Returns:

• (Response) —

  A Response object with data of type SqlCollectionLogInsightsCollection

# File 'lib/oci/data_safe/data_safe_client.rb', line 14198

def list_sql_collection_log_insights(time_started, time_ended, sql_collection_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#list_sql_collection_log_insights.' if logger

  raise "Missing the required parameter 'time_started' when calling list_sql_collection_log_insights." if time_started.nil?
  raise "Missing the required parameter 'time_ended' when calling list_sql_collection_log_insights." if time_ended.nil?
  raise "Missing the required parameter 'sql_collection_id' when calling list_sql_collection_log_insights." if sql_collection_id.nil?

  if opts[:group_by] && !%w[clientIp clientProgram clientOsUserName].include?(opts[:group_by])
    raise 'Invalid value for "group_by", must be one of clientIp, clientProgram, clientOsUserName.'
  end
  raise "Parameter value for 'sql_collection_id' must not be blank" if OCI::Internal::Util.blank_string?(sql_collection_id)

  path = '/sqlCollections/{sqlCollectionId}/logInsights'.sub('{sqlCollectionId}', sql_collection_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:timeStarted] = time_started
  query_params[:timeEnded] = time_ended
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:groupBy] = opts[:group_by] if opts[:group_by]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#list_sql_collection_log_insights') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataSafe::Models::SqlCollectionLogInsightsCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_sql_collections(compartment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_sql_collections API.

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.

Parameters:

• compartment_id (String) —

  A filter to return only resources that match the specified compartment OCID.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :compartment_id_in_subtree (BOOLEAN) —

  Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting. (default to false)

• :access_level (String) —

  Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed. (default to RESTRICTED) Allowed values are: RESTRICTED, ACCESSIBLE

• :display_name (String) —

  A filter to return only resources that match the specified display name.

• :limit (Integer) —

  For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

• :page (String) —

  For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

• :lifecycle_state (String) —

  The current state of the SQL collection.

• :sql_collection_id (String) —

  An optional filter to return only resources that match the specified OCID of the SQL collection resource.

• :time_created_greater_than_or_equal_to (DateTime) —

  A filter to return only the resources that were created after the specified date and time, as defined by RFC3339. Using TimeCreatedGreaterThanOrEqualToQueryParam parameter retrieves all resources created after that date.

  Example: 2016-12-19T16:39:57.600Z

• :time_created_less_than (DateTime) —

  Search for resources that were created before a specific date. Specifying this parameter corresponding timeCreatedLessThan parameter will retrieve all resources created before the specified created date, in "YYYY-MM-ddThh:mmZ" format with a Z offset, as defined by RFC 3339.

  Example: 2016-12-19T16:39:57.600Z

• :target_id (String) —

  A filter to return only items related to a specific target OCID.

• :db_user_name (String) —

  A filter to return only items that match the specified user name.

• :sort_order (String) —

  The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

• :sort_by (String) —

  The field used for sorting. Only one sorting parameter order (sortOrder) can be specified. The DISPLAYNAME sort order is case sensitive. (default to TIMECREATED) Allowed values are: TIMECREATED, DISPLAYNAME, TIMELASTSTARTED

• :opc_request_id (String) —

  Unique identifier for the request.

Returns:

• (Response) —

  A Response object with data of type SqlCollectionCollection

# File 'lib/oci/data_safe/data_safe_client.rb', line 14313

def list_sql_collections(compartment_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#list_sql_collections.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_sql_collections." if compartment_id.nil?

  if opts[:access_level] && !%w[RESTRICTED ACCESSIBLE].include?(opts[:access_level])
    raise 'Invalid value for "access_level", must be one of RESTRICTED, ACCESSIBLE.'
  end

  if opts[:lifecycle_state] && !OCI::DataSafe::Models::SQL_COLLECTION_LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::DataSafe::Models::SQL_COLLECTION_LIFECYCLE_STATE_ENUM.'
  end

  if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of ASC, DESC.'
  end

  if opts[:sort_by] && !%w[TIMECREATED DISPLAYNAME TIMELASTSTARTED].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of TIMECREATED, DISPLAYNAME, TIMELASTSTARTED.'
  end

  path = '/sqlCollections'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:compartmentIdInSubtree] = opts[:compartment_id_in_subtree] if !opts[:compartment_id_in_subtree].nil?
  query_params[:accessLevel] = opts[:access_level] if opts[:access_level]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:sqlCollectionId] = opts[:sql_collection_id] if opts[:sql_collection_id]
  query_params[:timeCreatedGreaterThanOrEqualTo] = opts[:time_created_greater_than_or_equal_to] if opts[:time_created_greater_than_or_equal_to]
  query_params[:timeCreatedLessThan] = opts[:time_created_less_than] if opts[:time_created_less_than]
  query_params[:targetId] = opts[:target_id] if opts[:target_id]
  query_params[:dbUserName] = opts[:db_user_name] if opts[:db_user_name]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#list_sql_collections') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataSafe::Models::SqlCollectionCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_sql_firewall_allowed_sql_analytics(compartment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_sql_firewall_allowed_sql_analytics API.

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.

Parameters:

• compartment_id (String) —

  A filter to return only resources that match the specified compartment OCID.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :compartment_id_in_subtree (BOOLEAN) —

  Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting. (default to false)

• :access_level (String) —

  Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed. (default to RESTRICTED) Allowed values are: RESTRICTED, ACCESSIBLE

• :limit (Integer) —

  For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

• :page (String) —

  For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

• :scim_query (String) —

  The scimQuery query parameter accepts filter expressions that use the syntax described in Section 3.2.2.2 of the System for Cross-Domain Identity Management (SCIM) specification, which is available at RFC3339. In SCIM filtering expressions, text, date, and time values must be enclosed in quotation marks, with date and time values using ISO-8601 format. (Numeric and boolean values should not be quoted.)

  Example: query=(currentUser eq 'SCOTT') and (topLevel eq 'YES')

• :group_by (Array<String>) —

  The group by parameter to summarize the allowed SQL aggregation. Allowed values are: dbUserName, sqlLevel, sqlFirewallPolicyId, lifecycleState

• :opc_request_id (String) —

  Unique identifier for the request.

Returns:

• (Response) —

  A Response object with data of type SqlFirewallAllowedSqlAnalyticsCollection

# File 'lib/oci/data_safe/data_safe_client.rb', line 14431

def list_sql_firewall_allowed_sql_analytics(compartment_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#list_sql_firewall_allowed_sql_analytics.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_sql_firewall_allowed_sql_analytics." if compartment_id.nil?

  if opts[:access_level] && !%w[RESTRICTED ACCESSIBLE].include?(opts[:access_level])
    raise 'Invalid value for "access_level", must be one of RESTRICTED, ACCESSIBLE.'
  end


  group_by_allowable_values = %w[dbUserName sqlLevel sqlFirewallPolicyId lifecycleState]
  if opts[:group_by] && !opts[:group_by].empty?
    opts[:group_by].each do |val_to_check|
      unless group_by_allowable_values.include?(val_to_check)
        raise 'Invalid value for "group_by", must be one of dbUserName, sqlLevel, sqlFirewallPolicyId, lifecycleState.'
      end
    end
  end

  path = '/sqlFirewallAllowedSqlAnalytics'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:compartmentIdInSubtree] = opts[:compartment_id_in_subtree] if !opts[:compartment_id_in_subtree].nil?
  query_params[:accessLevel] = opts[:access_level] if opts[:access_level]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:scimQuery] = opts[:scim_query] if opts[:scim_query]
  query_params[:groupBy] = OCI::ApiClient.build_collection_params(opts[:group_by], :multi) if opts[:group_by] && !opts[:group_by].empty?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#list_sql_firewall_allowed_sql_analytics') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataSafe::Models::SqlFirewallAllowedSqlAnalyticsCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_sql_firewall_allowed_sqls(compartment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_sql_firewall_allowed_sqls API.

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.

Allowed values are: displayName, timeCollected

Parameters:

• compartment_id (String) —

  A filter to return only resources that match the specified compartment OCID.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :compartment_id_in_subtree (BOOLEAN) —

  Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting. (default to false)

• :access_level (String) —

  Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed. (default to RESTRICTED) Allowed values are: RESTRICTED, ACCESSIBLE

• :limit (Integer) —

  For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

• :page (String) —

  For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

• :scim_query (String) —

  The scimQuery query parameter accepts filter expressions that use the syntax described in Section 3.2.2.2 of the System for Cross-Domain Identity Management (SCIM) specification, which is available at RFC3339. In SCIM filtering expressions, text, date, and time values must be enclosed in quotation marks, with date and time values using ISO-8601 format. (Numeric and boolean values should not be quoted.)

  Example: query=(currentUser eq 'SCOTT') and (topLevel eq 'YES')

• :sort_order (String) —

  The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

• :sort_by (String) —

  The field to sort by. Only one sort parameter should be provided. (default to timeCollected)

• :opc_request_id (String) —

  Unique identifier for the request.

Returns:

• (Response) —

  A Response object with data of type SqlFirewallAllowedSqlCollection

# File 'lib/oci/data_safe/data_safe_client.rb', line 14543

def list_sql_firewall_allowed_sqls(compartment_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#list_sql_firewall_allowed_sqls.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_sql_firewall_allowed_sqls." if compartment_id.nil?

  if opts[:access_level] && !%w[RESTRICTED ACCESSIBLE].include?(opts[:access_level])
    raise 'Invalid value for "access_level", must be one of RESTRICTED, ACCESSIBLE.'
  end

  if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of ASC, DESC.'
  end

  if opts[:sort_by] && !%w[displayName timeCollected].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of displayName, timeCollected.'
  end

  path = '/sqlFirewallAllowedSqls'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:compartmentIdInSubtree] = opts[:compartment_id_in_subtree] if !opts[:compartment_id_in_subtree].nil?
  query_params[:accessLevel] = opts[:access_level] if opts[:access_level]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:scimQuery] = opts[:scim_query] if opts[:scim_query]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#list_sql_firewall_allowed_sqls') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataSafe::Models::SqlFirewallAllowedSqlCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_sql_firewall_policies(compartment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_sql_firewall_policies API.

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.

Parameters:

• compartment_id (String) —

  A filter to return only resources that match the specified compartment OCID.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :compartment_id_in_subtree (BOOLEAN) —

  Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting. (default to false)

• :access_level (String) —

  Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed. (default to RESTRICTED) Allowed values are: RESTRICTED, ACCESSIBLE

• :display_name (String) —

  A filter to return only resources that match the specified display name.

• :limit (Integer) —

  For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

• :page (String) —

  For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

• :security_policy_id (String) —

  An optional filter to return only resources that match the specified OCID of the security policy resource.

• :lifecycle_state (String) —

  The current state of the SQL firewall policy.

• :sql_firewall_policy_id (String) —

  An optional filter to return only resources that match the specified OCID of the SQL firewall policy resource.

• :db_user_name (String) —

  A filter to return only items that match the specified user name.

• :violation_action (String) —

  An optional filter to return only resources that match the specified violation action. Allowed values are: block, observe

• :time_created_greater_than_or_equal_to (DateTime) —

  A filter to return only the resources that were created after the specified date and time, as defined by RFC3339. Using TimeCreatedGreaterThanOrEqualToQueryParam parameter retrieves all resources created after that date.

  Example: 2016-12-19T16:39:57.600Z

• :time_created_less_than (DateTime) —

  Search for resources that were created before a specific date. Specifying this parameter corresponding timeCreatedLessThan parameter will retrieve all resources created before the specified created date, in "YYYY-MM-ddThh:mmZ" format with a Z offset, as defined by RFC 3339.

  Example: 2016-12-19T16:39:57.600Z

• :sort_order (String) —

  The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

• :sort_by (String) —

  The field used for sorting. Only one sorting order (sortOrder) can be specified. The default order for TIMECREATED is descending. The default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. (default to TIMECREATED) Allowed values are: TIMECREATED, DISPLAYNAME

• :opc_request_id (String) —

  Unique identifier for the request.

Returns:

• (Response) —

  A Response object with data of type SqlFirewallPolicyCollection

# File 'lib/oci/data_safe/data_safe_client.rb', line 14669

def list_sql_firewall_policies(compartment_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#list_sql_firewall_policies.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_sql_firewall_policies." if compartment_id.nil?

  if opts[:access_level] && !%w[RESTRICTED ACCESSIBLE].include?(opts[:access_level])
    raise 'Invalid value for "access_level", must be one of RESTRICTED, ACCESSIBLE.'
  end

  if opts[:lifecycle_state] && !OCI::DataSafe::Models::SQL_FIREWALL_POLICY_LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::DataSafe::Models::SQL_FIREWALL_POLICY_LIFECYCLE_STATE_ENUM.'
  end

  if opts[:violation_action] && !%w[block observe].include?(opts[:violation_action])
    raise 'Invalid value for "violation_action", must be one of block, observe.'
  end

  if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of ASC, DESC.'
  end

  if opts[:sort_by] && !%w[TIMECREATED DISPLAYNAME].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of TIMECREATED, DISPLAYNAME.'
  end

  path = '/sqlFirewallPolicies'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:compartmentIdInSubtree] = opts[:compartment_id_in_subtree] if !opts[:compartment_id_in_subtree].nil?
  query_params[:accessLevel] = opts[:access_level] if opts[:access_level]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:securityPolicyId] = opts[:security_policy_id] if opts[:security_policy_id]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:sqlFirewallPolicyId] = opts[:sql_firewall_policy_id] if opts[:sql_firewall_policy_id]
  query_params[:dbUserName] = opts[:db_user_name] if opts[:db_user_name]
  query_params[:violationAction] = opts[:violation_action] if opts[:violation_action]
  query_params[:timeCreatedGreaterThanOrEqualTo] = opts[:time_created_greater_than_or_equal_to] if opts[:time_created_greater_than_or_equal_to]
  query_params[:timeCreatedLessThan] = opts[:time_created_less_than] if opts[:time_created_less_than]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#list_sql_firewall_policies') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataSafe::Models::SqlFirewallPolicyCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_sql_firewall_policy_analytics(compartment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_sql_firewall_policy_analytics API.

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.

Parameters:

• compartment_id (String) —

  A filter to return only resources that match the specified compartment OCID.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :compartment_id_in_subtree (BOOLEAN) —

  Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting. (default to false)

• :access_level (String) —

  Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed. (default to RESTRICTED) Allowed values are: RESTRICTED, ACCESSIBLE

• :limit (Integer) —

  For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

• :page (String) —

  For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

• :group_by (Array<String>) —

  The group by parameter to summarize SQL firewall policy aggregation. Allowed values are: violationAction, enforcementScope, securityPolicyId, lifecycleState

• :lifecycle_state (String) —

  The current state of the SQL firewall policy.

• :security_policy_id (String) —

  An optional filter to return only resources that match the specified OCID of the security policy resource.

• :time_started (DateTime) —

  An optional filter to return the summary of the SQL firewall policies created after the date-time specified, in the format defined by RFC3339.

• :time_ended (DateTime) —

  An optional filter to return the summary of the SQL firewall policies created before the date-time specified, in the format defined by RFC3339.

• :opc_request_id (String) —

  Unique identifier for the request.

Returns:

• (Response) —

  A Response object with data of type SqlFirewallPolicyAnalyticsCollection

# File 'lib/oci/data_safe/data_safe_client.rb', line 14790

def list_sql_firewall_policy_analytics(compartment_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#list_sql_firewall_policy_analytics.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_sql_firewall_policy_analytics." if compartment_id.nil?

  if opts[:access_level] && !%w[RESTRICTED ACCESSIBLE].include?(opts[:access_level])
    raise 'Invalid value for "access_level", must be one of RESTRICTED, ACCESSIBLE.'
  end


  group_by_allowable_values = %w[violationAction enforcementScope securityPolicyId lifecycleState]
  if opts[:group_by] && !opts[:group_by].empty?
    opts[:group_by].each do |val_to_check|
      unless group_by_allowable_values.include?(val_to_check)
        raise 'Invalid value for "group_by", must be one of violationAction, enforcementScope, securityPolicyId, lifecycleState.'
      end
    end
  end

  if opts[:lifecycle_state] && !OCI::DataSafe::Models::SQL_FIREWALL_POLICY_LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::DataSafe::Models::SQL_FIREWALL_POLICY_LIFECYCLE_STATE_ENUM.'
  end

  path = '/sqlFirewallPolicyAnalytics'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:compartmentIdInSubtree] = opts[:compartment_id_in_subtree] if !opts[:compartment_id_in_subtree].nil?
  query_params[:accessLevel] = opts[:access_level] if opts[:access_level]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:groupBy] = OCI::ApiClient.build_collection_params(opts[:group_by], :multi) if opts[:group_by] && !opts[:group_by].empty?
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:securityPolicyId] = opts[:security_policy_id] if opts[:security_policy_id]
  query_params[:timeStarted] = opts[:time_started] if opts[:time_started]
  query_params[:timeEnded] = opts[:time_ended] if opts[:time_ended]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#list_sql_firewall_policy_analytics') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataSafe::Models::SqlFirewallPolicyAnalyticsCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_sql_firewall_violation_analytics(compartment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_sql_firewall_violation_analytics API.

Returns the aggregation details of the SQL firewall violations.

Allowed values are: dbUserName, targetId, targetName, operationTime, timeCollected, clientOsUserName, operation, currentDbUserName, sqlLevel, clientIp, clientProgram, violationCause, violationAction, violationCount

Parameters:

• compartment_id (String) —

  A filter to return only resources that match the specified compartment OCID.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :compartment_id_in_subtree (BOOLEAN) —

  Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting. (default to false)

• :access_level (String) —

  Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed. (default to RESTRICTED) Allowed values are: RESTRICTED, ACCESSIBLE

• :limit (Integer) —

  For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

• :page (String) —

  For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

• :opc_request_id (String) —

  Unique identifier for the request.

• :time_started (DateTime) —

  An optional filter to return audit events whose creation time in the database is greater than and equal to the date-time specified, in the format defined by RFC3339.

• :time_ended (DateTime) —

  An optional filter to return audit events whose creation time in the database is less than and equal to the date-time specified, in the format defined by RFC3339.

• :query_time_zone (String) —

  Default time zone is UTC if no time zone provided. The date-time considerations of the resource will be in accordance with the specified time zone. (default to UTC)

• :sort_order (String) —

  The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

• :sort_by (String) —

  If this query parameter is specified, the result is sorted by this query parameter value. (default to operationTime)

• :scim_query (String) —

  The scimQuery query parameter accepts filter expressions that use the syntax described in Section 3.2.2.2 of the System for Cross-Domain Identity Management (SCIM) specification, which is available at RFC3339. In SCIM filtering expressions, text, date, and time values must be enclosed in quotation marks, with date and time values using ISO-8601 format. (Numeric and boolean values should not be quoted.)

  Example: query=(operationTime ge '2021-06-04T01-00-26') and (violationAction eq 'BLOCKED')

• :summary_field (Array<String>) —

  Specifies a subset of summarized fields to be returned in the response. Allowed values are: dbUserName, targetName, clientOsUserName, operation, sqlText, currentDbUserName, sqlLevel, clientIp, clientProgram, violationCause, violationAction, selects, creates, alters, drops, grants, revokes

• :group_by (Array<String>) —

  A groupBy can only be used in combination with summaryField parameter. A groupBy value has to be a subset of the values mentioned in summaryField parameter.

  Allowed values are: dbUserName, targetName, operationTime, timeCollected, clientOsUserName, operation, sqlText, currentDbUserName, sqlLevel, clientIp, clientProgram, violationCause, violationAction

• :opc_retry_token (String) —

  A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

Returns:

• (Response) —

  A Response object with data of type SqlFirewallViolationAnalyticsCollection

# File 'lib/oci/data_safe/data_safe_client.rb', line 14915

def list_sql_firewall_violation_analytics(compartment_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#list_sql_firewall_violation_analytics.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_sql_firewall_violation_analytics." if compartment_id.nil?

  if opts[:access_level] && !%w[RESTRICTED ACCESSIBLE].include?(opts[:access_level])
    raise 'Invalid value for "access_level", must be one of RESTRICTED, ACCESSIBLE.'
  end

  if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of ASC, DESC.'
  end

  if opts[:sort_by] && !%w[dbUserName targetId targetName operationTime timeCollected clientOsUserName operation currentDbUserName sqlLevel clientIp clientProgram violationCause violationAction violationCount].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of dbUserName, targetId, targetName, operationTime, timeCollected, clientOsUserName, operation, currentDbUserName, sqlLevel, clientIp, clientProgram, violationCause, violationAction, violationCount.'
  end


  summary_field_allowable_values = %w[dbUserName targetName clientOsUserName operation sqlText currentDbUserName sqlLevel clientIp clientProgram violationCause violationAction selects creates alters drops grants revokes]
  if opts[:summary_field] && !opts[:summary_field].empty?
    opts[:summary_field].each do |val_to_check|
      unless summary_field_allowable_values.include?(val_to_check)
        raise 'Invalid value for "summary_field", must be one of dbUserName, targetName, clientOsUserName, operation, sqlText, currentDbUserName, sqlLevel, clientIp, clientProgram, violationCause, violationAction, selects, creates, alters, drops, grants, revokes.'
      end
    end
  end


  group_by_allowable_values = %w[dbUserName targetName operationTime timeCollected clientOsUserName operation sqlText currentDbUserName sqlLevel clientIp clientProgram violationCause violationAction]
  if opts[:group_by] && !opts[:group_by].empty?
    opts[:group_by].each do |val_to_check|
      unless group_by_allowable_values.include?(val_to_check)
        raise 'Invalid value for "group_by", must be one of dbUserName, targetName, operationTime, timeCollected, clientOsUserName, operation, sqlText, currentDbUserName, sqlLevel, clientIp, clientProgram, violationCause, violationAction.'
      end
    end
  end

  path = '/sqlFirewallViolationAnalytics'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:compartmentIdInSubtree] = opts[:compartment_id_in_subtree] if !opts[:compartment_id_in_subtree].nil?
  query_params[:accessLevel] = opts[:access_level] if opts[:access_level]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:timeStarted] = opts[:time_started] if opts[:time_started]
  query_params[:timeEnded] = opts[:time_ended] if opts[:time_ended]
  query_params[:queryTimeZone] = opts[:query_time_zone] if opts[:query_time_zone]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:scimQuery] = opts[:scim_query] if opts[:scim_query]
  query_params[:summaryField] = OCI::ApiClient.build_collection_params(opts[:summary_field], :multi) if opts[:summary_field] && !opts[:summary_field].empty?
  query_params[:groupBy] = OCI::ApiClient.build_collection_params(opts[:group_by], :multi) if opts[:group_by] && !opts[:group_by].empty?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#list_sql_firewall_violation_analytics') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataSafe::Models::SqlFirewallViolationAnalyticsCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_sql_firewall_violations(compartment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_sql_firewall_violations API.

Gets a list of all the SQL firewall violations captured by the firewall.

Allowed values are: dbUserName, targetId, targetName, operationTime, timeCollected, clientOsUserName, operation, currentDbUserName, sqlLevel, clientIp, clientProgram, violationCause, violationAction

Parameters:

• compartment_id (String) —

  A filter to return only resources that match the specified compartment OCID.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :compartment_id_in_subtree (BOOLEAN) —

  Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting. (default to false)

• :limit (Integer) —

  For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

• :page (String) —

  For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

• :opc_request_id (String) —

  Unique identifier for the request.

• :access_level (String) —

  Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed. (default to RESTRICTED) Allowed values are: RESTRICTED, ACCESSIBLE

• :sort_order (String) —

  The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

• :sort_by (String) —

  If this query parameter is specified, the result is sorted by this query parameter value. (default to operationTime)

• :scim_query (String) —

  The scimQuery query parameter accepts filter expressions that use the syntax described in Section 3.2.2.2 of the System for Cross-Domain Identity Management (SCIM) specification, which is available at RFC3339. In SCIM filtering expressions, text, date, and time values must be enclosed in quotation marks, with date and time values using ISO-8601 format. (Numeric and boolean values should not be quoted.)

  Example: query=(operationTime ge '2021-06-04T01-00-26') and (violationAction eq 'BLOCKED')

Returns:

• (Response) —

  A Response object with data of type SqlFirewallViolationsCollection

# File 'lib/oci/data_safe/data_safe_client.rb', line 15040

def list_sql_firewall_violations(compartment_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#list_sql_firewall_violations.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_sql_firewall_violations." if compartment_id.nil?

  if opts[:access_level] && !%w[RESTRICTED ACCESSIBLE].include?(opts[:access_level])
    raise 'Invalid value for "access_level", must be one of RESTRICTED, ACCESSIBLE.'
  end

  if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of ASC, DESC.'
  end

  if opts[:sort_by] && !%w[dbUserName targetId targetName operationTime timeCollected clientOsUserName operation currentDbUserName sqlLevel clientIp clientProgram violationCause violationAction].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of dbUserName, targetId, targetName, operationTime, timeCollected, clientOsUserName, operation, currentDbUserName, sqlLevel, clientIp, clientProgram, violationCause, violationAction.'
  end

  path = '/sqlFirewallViolations'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:compartmentIdInSubtree] = opts[:compartment_id_in_subtree] if !opts[:compartment_id_in_subtree].nil?
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:accessLevel] = opts[:access_level] if opts[:access_level]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:scimQuery] = opts[:scim_query] if opts[:scim_query]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json, application/xml'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#list_sql_firewall_violations') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataSafe::Models::SqlFirewallViolationsCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_tables(target_database_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_tables API.

Returns a list of table metadata objects.

Allowed values are: SCHEMANAME, TABLENAME

Parameters:

• target_database_id (String) —

  The OCID of the Data Safe target database.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :opc_request_id (String) —

  Unique identifier for the request.

• :limit (Integer) —

  For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

• :page (String) —

  For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

• :schema_name (Array<String>) —

  A filter to return only items related to specific schema name.

• :table_name (Array<String>) —

  A filter to return only items related to specific table name.

• :sort_order (String) —

  The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

• :sort_by (String) —

  The field used for sorting. Only one sorting order (sortOrder) can be specified. (default to TABLENAME)

• :table_name_contains (String) —

  A filter to return only items if table name contains a specific string.

• :schema_name_contains (String) —

  A filter to return only items if schema name contains a specific string.

Returns:

• (Response) —

  A Response object with data of type Array<TableSummary>

# File 'lib/oci/data_safe/data_safe_client.rb', line 15125

def list_tables(target_database_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#list_tables.' if logger

  raise "Missing the required parameter 'target_database_id' when calling list_tables." if target_database_id.nil?

  if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of ASC, DESC.'
  end

  if opts[:sort_by] && !%w[SCHEMANAME TABLENAME].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of SCHEMANAME, TABLENAME.'
  end
  raise "Parameter value for 'target_database_id' must not be blank" if OCI::Internal::Util.blank_string?(target_database_id)

  path = '/targetDatabases/{targetDatabaseId}/tables'.sub('{targetDatabaseId}', target_database_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:schemaName] = OCI::ApiClient.build_collection_params(opts[:schema_name], :multi) if opts[:schema_name] && !opts[:schema_name].empty?
  query_params[:tableName] = OCI::ApiClient.build_collection_params(opts[:table_name], :multi) if opts[:table_name] && !opts[:table_name].empty?
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:tableNameContains] = opts[:table_name_contains] if opts[:table_name_contains]
  query_params[:schemaNameContains] = opts[:schema_name_contains] if opts[:schema_name_contains]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#list_tables') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'Array<OCI::DataSafe::Models::TableSummary>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_target_alert_policy_associations(compartment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_target_alert_policy_associations API.

Gets a list of all target-alert policy associations.

Allowed values are: DISPLAYNAME, TIMECREATED, TIMEUPDATED

Parameters:

• compartment_id (String) —

  A filter to return only resources that match the specified compartment OCID.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :target_alert_policy_association_id (String) —

  A filter to return only items related to a specific target-alert policy association ID.

• :alert_policy_id (String) —

  A filter to return policy by it's OCID.

• :target_id (String) —

  A filter to return only items related to a specific target OCID.

• :lifecycle_state (String) —

  An optional filter to return only alert policies that have the given life-cycle state.

• :limit (Integer) —

  For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

• :page (String) —

  For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

• :sort_order (String) —

  The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

• :sort_by (String) —

  The field to sort by. Only one sort parameter may be provided. (default to TIMECREATED)

• :opc_request_id (String) —

  Unique identifier for the request.

• :time_created_greater_than_or_equal_to (DateTime) —

  A filter to return only the resources that were created after the specified date and time, as defined by RFC3339. Using TimeCreatedGreaterThanOrEqualToQueryParam parameter retrieves all resources created after that date.

  Example: 2016-12-19T16:39:57.600Z

• :time_created_less_than (DateTime) —

  Search for resources that were created before a specific date. Specifying this parameter corresponding timeCreatedLessThan parameter will retrieve all resources created before the specified created date, in "YYYY-MM-ddThh:mmZ" format with a Z offset, as defined by RFC 3339.

  Example: 2016-12-19T16:39:57.600Z

• :compartment_id_in_subtree (BOOLEAN) —

  Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting. (default to false)

• :access_level (String) —

  Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed. (default to RESTRICTED) Allowed values are: RESTRICTED, ACCESSIBLE

Returns:

• (Response) —

  A Response object with data of type TargetAlertPolicyAssociationCollection

# File 'lib/oci/data_safe/data_safe_client.rb', line 15229

def list_target_alert_policy_associations(compartment_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#list_target_alert_policy_associations.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_target_alert_policy_associations." if compartment_id.nil?

  if opts[:lifecycle_state] && !OCI::DataSafe::Models::ALERT_POLICY_LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::DataSafe::Models::ALERT_POLICY_LIFECYCLE_STATE_ENUM.'
  end

  if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of ASC, DESC.'
  end

  if opts[:sort_by] && !%w[DISPLAYNAME TIMECREATED TIMEUPDATED].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of DISPLAYNAME, TIMECREATED, TIMEUPDATED.'
  end

  if opts[:access_level] && !%w[RESTRICTED ACCESSIBLE].include?(opts[:access_level])
    raise 'Invalid value for "access_level", must be one of RESTRICTED, ACCESSIBLE.'
  end

  path = '/targetAlertPolicyAssociations'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:targetAlertPolicyAssociationId] = opts[:target_alert_policy_association_id] if opts[:target_alert_policy_association_id]
  query_params[:alertPolicyId] = opts[:alert_policy_id] if opts[:alert_policy_id]
  query_params[:targetId] = opts[:target_id] if opts[:target_id]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:timeCreatedGreaterThanOrEqualTo] = opts[:time_created_greater_than_or_equal_to] if opts[:time_created_greater_than_or_equal_to]
  query_params[:timeCreatedLessThan] = opts[:time_created_less_than] if opts[:time_created_less_than]
  query_params[:compartmentIdInSubtree] = opts[:compartment_id_in_subtree] if !opts[:compartment_id_in_subtree].nil?
  query_params[:accessLevel] = opts[:access_level] if opts[:access_level]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#list_target_alert_policy_associations') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataSafe::Models::TargetAlertPolicyAssociationCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_target_databases(compartment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_target_databases API.

Returns the list of registered target databases in Data Safe.

Parameters:

• compartment_id (String) —

  A filter to return only resources that match the specified compartment OCID.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :associated_resource_id (String) —

  A filter to return the target databases that are associated to the resource id passed in as a parameter value.

• :target_database_id (String) —

  A filter to return the target database that matches the specified OCID.

• :display_name (String) —

  A filter to return only resources that match the specified display name.

• :lifecycle_state (String) —

  A filter to return only target databases that match the specified lifecycle state.

• :database_type (String) —

  A filter to return only target databases that match the specified database type.

• :infrastructure_type (String) —

  A filter to return only target databases that match the specified infrastructure type.

• :limit (Integer) —

  For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

• :page (String) —

  For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

• :compartment_id_in_subtree (BOOLEAN) —

  Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting. (default to false)

• :access_level (String) —

  Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed. (default to RESTRICTED) Allowed values are: RESTRICTED, ACCESSIBLE

• :sort_order (String) —

  The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

• :sort_by (String) —

  The field used for sorting. Only one sorting order (sortOrder) can be specified. The default order for TIMECREATED is descending. The default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. (default to TIMECREATED) Allowed values are: TIMECREATED, DISPLAYNAME

• :opc_request_id (String) —

  Unique identifier for the request.

Returns:

• (Response) —

  A Response object with data of type Array<TargetDatabaseSummary>

# File 'lib/oci/data_safe/data_safe_client.rb', line 15337

def list_target_databases(compartment_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#list_target_databases.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_target_databases." if compartment_id.nil?

  if opts[:lifecycle_state] && !OCI::DataSafe::Models::TARGET_DATABASE_LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::DataSafe::Models::TARGET_DATABASE_LIFECYCLE_STATE_ENUM.'
  end

  if opts[:database_type] && !OCI::DataSafe::Models::DATABASE_TYPE_ENUM.include?(opts[:database_type])
    raise 'Invalid value for "database_type", must be one of the values in OCI::DataSafe::Models::DATABASE_TYPE_ENUM.'
  end

  if opts[:infrastructure_type] && !OCI::DataSafe::Models::INFRASTRUCTURE_TYPE_ENUM.include?(opts[:infrastructure_type])
    raise 'Invalid value for "infrastructure_type", must be one of the values in OCI::DataSafe::Models::INFRASTRUCTURE_TYPE_ENUM.'
  end

  if opts[:access_level] && !%w[RESTRICTED ACCESSIBLE].include?(opts[:access_level])
    raise 'Invalid value for "access_level", must be one of RESTRICTED, ACCESSIBLE.'
  end

  if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of ASC, DESC.'
  end

  if opts[:sort_by] && !%w[TIMECREATED DISPLAYNAME].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of TIMECREATED, DISPLAYNAME.'
  end

  path = '/targetDatabases'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:associatedResourceId] = opts[:associated_resource_id] if opts[:associated_resource_id]
  query_params[:targetDatabaseId] = opts[:target_database_id] if opts[:target_database_id]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:databaseType] = opts[:database_type] if opts[:database_type]
  query_params[:infrastructureType] = opts[:infrastructure_type] if opts[:infrastructure_type]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:compartmentIdInSubtree] = opts[:compartment_id_in_subtree] if !opts[:compartment_id_in_subtree].nil?
  query_params[:accessLevel] = opts[:access_level] if opts[:access_level]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#list_target_databases') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'Array<OCI::DataSafe::Models::TargetDatabaseSummary>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_user_analytics(user_assessment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_user_analytics API.

Gets a list of aggregated user details from the specified user assessment. This provides information about the overall state. of database user security. For example, the user details include how many users have the DBA role and how many users are in the critical category. This data is especially useful content for dashboards or to support analytics.

When you perform the ListUserAnalytics operation, if the parameter compartmentIdInSubtree is set to "true," and if the parameter accessLevel is set to ACCESSIBLE, then the operation returns compartments in which the requestor has INSPECT permissions on at least one resource, directly or indirectly (in subcompartments). If the operation is performed at the root compartment. If 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.

Allowed values are: userName, userCategory, accountStatus, timeLastLogin, targetId, timeUserCreated, authenticationType, timePasswordChanged

Parameters:

• user_assessment_id (String) —

  The OCID of the user assessment.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :compartment_id_in_subtree (BOOLEAN) —

  Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting. (default to false)

• :access_level (String) —

  Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed. (default to RESTRICTED) Allowed values are: RESTRICTED, ACCESSIBLE

• :limit (Integer) —

  For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

• :user_category (String) —

  A filter to return only items that match the specified user category.

• :user_key (String) —

  A filter to return only items that match the specified user key.

• :account_status (String) —

  A filter to return only items that match the specified account status.

• :authentication_type (String) —

  A filter to return only items that match the specified authentication type.

• :user_name (String) —

  A filter to return only items that match the specified user name.

• :target_id (String) —

  A filter to return only items related to a specific target OCID.

• :time_last_login_greater_than_or_equal_to (DateTime) —

  A filter to return users whose last login time in the database is greater than or equal to the date and time specified, in the format defined by RFC3339.

  Example: 2016-12-19T16:39:57.600Z

• :time_last_login_less_than (DateTime) —

  A filter to return users whose last login time in the database is less than the date and time specified, in the format defined by RFC3339. Example: 2016-12-19T16:39:57.600Z

• :time_user_created_greater_than_or_equal_to (DateTime) —

  A filter to return users whose creation time in the database is greater than or equal to the date and time specified, in the format defined by RFC3339. Example: 2016-12-19T16:39:57.600Z

• :time_user_created_less_than (DateTime) —

  A filter to return users whose creation time in the database is less than the date and time specified, in the format defined by RFC3339. Example: 2016-12-19T16:39:57.600Z

• :time_password_last_changed_greater_than_or_equal_to (DateTime) —

  A filter to return users whose last password change in the database is greater than or equal to the date and time specified, in the format defined by RFC3339.

  Example: 2016-12-19T16:39:57.600Z

• :time_password_last_changed_less_than (DateTime) —

  A filter to return users whose last password change in the database is less than the date and time specified, in the format defined by RFC3339.

  Example: 2016-12-19T16:39:57.600Z

• :page (String) —

  For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

• :sort_order (String) —

  The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

• :sort_by (String) —

  The field to sort by. You can specify only one sort order (sortOrder). The default order for userName is ascending. (default to userName)

• :opc_request_id (String) —

  Unique identifier for the request.

Returns:

• (Response) —

  A Response object with data of type Array<UserAggregation>

# File 'lib/oci/data_safe/data_safe_client.rb', line 15485

def list_user_analytics(user_assessment_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#list_user_analytics.' if logger

  raise "Missing the required parameter 'user_assessment_id' when calling list_user_analytics." if user_assessment_id.nil?

  if opts[:access_level] && !%w[RESTRICTED ACCESSIBLE].include?(opts[:access_level])
    raise 'Invalid value for "access_level", must be one of RESTRICTED, ACCESSIBLE.'
  end

  if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of ASC, DESC.'
  end

  if opts[:sort_by] && !%w[userName userCategory accountStatus timeLastLogin targetId timeUserCreated authenticationType timePasswordChanged].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of userName, userCategory, accountStatus, timeLastLogin, targetId, timeUserCreated, authenticationType, timePasswordChanged.'
  end
  raise "Parameter value for 'user_assessment_id' must not be blank" if OCI::Internal::Util.blank_string?(user_assessment_id)

  path = '/userAssessments/{userAssessmentId}/userAnalytics'.sub('{userAssessmentId}', user_assessment_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentIdInSubtree] = opts[:compartment_id_in_subtree] if !opts[:compartment_id_in_subtree].nil?
  query_params[:accessLevel] = opts[:access_level] if opts[:access_level]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:userCategory] = opts[:user_category] if opts[:user_category]
  query_params[:userKey] = opts[:user_key] if opts[:user_key]
  query_params[:accountStatus] = opts[:account_status] if opts[:account_status]
  query_params[:authenticationType] = opts[:authentication_type] if opts[:authentication_type]
  query_params[:userName] = opts[:user_name] if opts[:user_name]
  query_params[:targetId] = opts[:target_id] if opts[:target_id]
  query_params[:timeLastLoginGreaterThanOrEqualTo] = opts[:time_last_login_greater_than_or_equal_to] if opts[:time_last_login_greater_than_or_equal_to]
  query_params[:timeLastLoginLessThan] = opts[:time_last_login_less_than] if opts[:time_last_login_less_than]
  query_params[:timeUserCreatedGreaterThanOrEqualTo] = opts[:time_user_created_greater_than_or_equal_to] if opts[:time_user_created_greater_than_or_equal_to]
  query_params[:timeUserCreatedLessThan] = opts[:time_user_created_less_than] if opts[:time_user_created_less_than]
  query_params[:timePasswordLastChangedGreaterThanOrEqualTo] = opts[:time_password_last_changed_greater_than_or_equal_to] if opts[:time_password_last_changed_greater_than_or_equal_to]
  query_params[:timePasswordLastChangedLessThan] = opts[:time_password_last_changed_less_than] if opts[:time_password_last_changed_less_than]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#list_user_analytics') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'Array<OCI::DataSafe::Models::UserAggregation>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_user_assessments(compartment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_user_assessments API.

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.

Allowed values are: timeCreated, displayName

Parameters:

• compartment_id (String) —

  A filter to return only resources that match the specified compartment OCID.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :compartment_id_in_subtree (BOOLEAN) —

  Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting. (default to false)

• :access_level (String) —

  Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed. (default to RESTRICTED) Allowed values are: RESTRICTED, ACCESSIBLE

• :display_name (String) —

  A filter to return only resources that match the specified display name.

• :schedule_user_assessment_id (String) —

  The OCID of the user assessment of type SAVE_SCHEDULE.

• :is_schedule_assessment (BOOLEAN) —

  A filter to return only user assessments of type SAVE_SCHEDULE. (default to false)

• :is_baseline (BOOLEAN) —

  A filter to return only user assessments that are set as baseline. (default to false)

• :target_id (String) —

  A filter to return only items related to a specific target OCID.

• :type (String) —

  A filter to return only items that match the specified assessment type. Allowed values are: LATEST, SAVED, COMPARTMENT, SAVE_SCHEDULE

• :triggered_by (String) —

  A filter to return user assessments that were created by either the system or by a user only. Allowed values are: USER, SYSTEM

• :time_created_greater_than_or_equal_to (DateTime) —

  A filter to return only user assessments that were created after the specified date and time, as defined by RFC3339. Using timeCreatedGreaterThanOrEqualTo parameter retrieves all assessments created after that date.

  Example: 2016-12-19T16:39:57.600Z

• :time_created_less_than (DateTime) —

  Search for resources that were created before a specific date. Specifying this parameter corresponding timeCreatedLessThan parameter will retrieve all resources created before the specified created date, in "YYYY-MM-ddThh:mmZ" format with a Z offset, as defined by RFC 3339.

  Example: 2016-12-19T16:39:57.600Z

• :limit (Integer) —

  For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

• :page (String) —

  For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

• :lifecycle_state (String) —

  The current state of the user assessment.

• :sort_order (String) —

  The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

• :sort_by (String) —

  The field to sort by. You can specify only one sort order (sortOrder). The default order for timeCreated is descending. (default to timeCreated)

• :opc_request_id (String) —

  Unique identifier for the request.

Returns:

• (Response) —

  A Response object with data of type Array<UserAssessmentSummary>

# File 'lib/oci/data_safe/data_safe_client.rb', line 15625

def list_user_assessments(compartment_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#list_user_assessments.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_user_assessments." if compartment_id.nil?

  if opts[:access_level] && !%w[RESTRICTED ACCESSIBLE].include?(opts[:access_level])
    raise 'Invalid value for "access_level", must be one of RESTRICTED, ACCESSIBLE.'
  end

  if opts[:type] && !%w[LATEST SAVED COMPARTMENT SAVE_SCHEDULE].include?(opts[:type])
    raise 'Invalid value for "type", must be one of LATEST, SAVED, COMPARTMENT, SAVE_SCHEDULE.'
  end

  if opts[:triggered_by] && !%w[USER SYSTEM].include?(opts[:triggered_by])
    raise 'Invalid value for "triggered_by", must be one of USER, SYSTEM.'
  end

  if opts[:lifecycle_state] && !OCI::DataSafe::Models::USER_ASSESSMENT_LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::DataSafe::Models::USER_ASSESSMENT_LIFECYCLE_STATE_ENUM.'
  end

  if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of ASC, DESC.'
  end

  if opts[:sort_by] && !%w[timeCreated displayName].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of timeCreated, displayName.'
  end

  path = '/userAssessments'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:compartmentIdInSubtree] = opts[:compartment_id_in_subtree] if !opts[:compartment_id_in_subtree].nil?
  query_params[:accessLevel] = opts[:access_level] if opts[:access_level]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:scheduleUserAssessmentId] = opts[:schedule_user_assessment_id] if opts[:schedule_user_assessment_id]
  query_params[:isScheduleAssessment] = opts[:is_schedule_assessment] if !opts[:is_schedule_assessment].nil?
  query_params[:isBaseline] = opts[:is_baseline] if !opts[:is_baseline].nil?
  query_params[:targetId] = opts[:target_id] if opts[:target_id]
  query_params[:type] = opts[:type] if opts[:type]
  query_params[:triggeredBy] = opts[:triggered_by] if opts[:triggered_by]
  query_params[:timeCreatedGreaterThanOrEqualTo] = opts[:time_created_greater_than_or_equal_to] if opts[:time_created_greater_than_or_equal_to]
  query_params[:timeCreatedLessThan] = opts[:time_created_less_than] if opts[:time_created_less_than]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#list_user_assessments') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'Array<OCI::DataSafe::Models::UserAssessmentSummary>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_users(user_assessment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_users API.

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.

as specified by '#/definitions/userTypes'.

Allowed values are: userName, userCategory, accountStatus, timeLastLogin, targetId, timeUserCreated, authenticationType, timePasswordChanged

Parameters:

• user_assessment_id (String) —

  The OCID of the user assessment.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :limit (Integer) —

  For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

• :compartment_id_in_subtree (BOOLEAN) —

  Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting. (default to false)

• :access_level (String) —

  Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed. (default to RESTRICTED) Allowed values are: RESTRICTED, ACCESSIBLE

• :user_category (String) —

  A filter to return only items that match the specified user category.

• :user_role (String) —

  A filter to return only items that match the specified user role.

• :user_profile (String) —

  A filter to return only items that match the specified user profile.

• :user_type (String) —

  A filter to return only items that match the specified user type. The possible values can be - ADMIN_PRIVILEGED - APPLICATION - PRIVILEGED - SCHEMA - NON_PRIVILEGED

• :user_key (String) —

  A filter to return only items that match the specified user key.

• :account_status (String) —

  A filter to return only items that match the specified account status.

• :authentication_type (String) —

  A filter to return only items that match the specified authentication type.

• :user_name (String) —

  A filter to return only items that match the specified user name.

• :target_id (String) —

  A filter to return only items related to a specific target OCID.

• :time_last_login_greater_than_or_equal_to (DateTime) —

  A filter to return users whose last login time in the database is greater than or equal to the date and time specified, in the format defined by RFC3339.

  Example: 2016-12-19T16:39:57.600Z

• :time_last_login_less_than (DateTime) —

  A filter to return users whose last login time in the database is less than the date and time specified, in the format defined by RFC3339. Example: 2016-12-19T16:39:57.600Z

• :time_user_created_greater_than_or_equal_to (DateTime) —

  A filter to return users whose creation time in the database is greater than or equal to the date and time specified, in the format defined by RFC3339. Example: 2016-12-19T16:39:57.600Z

• :time_user_created_less_than (DateTime) —

  A filter to return users whose creation time in the database is less than the date and time specified, in the format defined by RFC3339. Example: 2016-12-19T16:39:57.600Z

• :time_password_last_changed_greater_than_or_equal_to (DateTime) —

  A filter to return users whose last password change in the database is greater than or equal to the date and time specified, in the format defined by RFC3339.

  Example: 2016-12-19T16:39:57.600Z

• :time_password_last_changed_less_than (DateTime) —

  A filter to return users whose last password change in the database is less than the date and time specified, in the format defined by RFC3339.

  Example: 2016-12-19T16:39:57.600Z

• :page (String) —

  For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

• :sort_order (String) —

  The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

• :sort_by (String) —

  The field to sort by. You can specify only one sort order (sortOrder). The default order for userName is ascending. (default to userName)

• :opc_request_id (String) —

  Unique identifier for the request.

Returns:

• (Response) —

  A Response object with data of type Array<UserSummary>

# File 'lib/oci/data_safe/data_safe_client.rb', line 15776

def list_users(user_assessment_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#list_users.' if logger

  raise "Missing the required parameter 'user_assessment_id' when calling list_users." if user_assessment_id.nil?

  if opts[:access_level] && !%w[RESTRICTED ACCESSIBLE].include?(opts[:access_level])
    raise 'Invalid value for "access_level", must be one of RESTRICTED, ACCESSIBLE.'
  end

  if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of ASC, DESC.'
  end

  if opts[:sort_by] && !%w[userName userCategory accountStatus timeLastLogin targetId timeUserCreated authenticationType timePasswordChanged].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of userName, userCategory, accountStatus, timeLastLogin, targetId, timeUserCreated, authenticationType, timePasswordChanged.'
  end
  raise "Parameter value for 'user_assessment_id' must not be blank" if OCI::Internal::Util.blank_string?(user_assessment_id)

  path = '/userAssessments/{userAssessmentId}/users'.sub('{userAssessmentId}', user_assessment_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:compartmentIdInSubtree] = opts[:compartment_id_in_subtree] if !opts[:compartment_id_in_subtree].nil?
  query_params[:accessLevel] = opts[:access_level] if opts[:access_level]
  query_params[:userCategory] = opts[:user_category] if opts[:user_category]
  query_params[:userRole] = opts[:user_role] if opts[:user_role]
  query_params[:userProfile] = opts[:user_profile] if opts[:user_profile]
  query_params[:userType] = opts[:user_type] if opts[:user_type]
  query_params[:userKey] = opts[:user_key] if opts[:user_key]
  query_params[:accountStatus] = opts[:account_status] if opts[:account_status]
  query_params[:authenticationType] = opts[:authentication_type] if opts[:authentication_type]
  query_params[:userName] = opts[:user_name] if opts[:user_name]
  query_params[:targetId] = opts[:target_id] if opts[:target_id]
  query_params[:timeLastLoginGreaterThanOrEqualTo] = opts[:time_last_login_greater_than_or_equal_to] if opts[:time_last_login_greater_than_or_equal_to]
  query_params[:timeLastLoginLessThan] = opts[:time_last_login_less_than] if opts[:time_last_login_less_than]
  query_params[:timeUserCreatedGreaterThanOrEqualTo] = opts[:time_user_created_greater_than_or_equal_to] if opts[:time_user_created_greater_than_or_equal_to]
  query_params[:timeUserCreatedLessThan] = opts[:time_user_created_less_than] if opts[:time_user_created_less_than]
  query_params[:timePasswordLastChangedGreaterThanOrEqualTo] = opts[:time_password_last_changed_greater_than_or_equal_to] if opts[:time_password_last_changed_greater_than_or_equal_to]
  query_params[:timePasswordLastChangedLessThan] = opts[:time_password_last_changed_less_than] if opts[:time_password_last_changed_less_than]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#list_users') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'Array<OCI::DataSafe::Models::UserSummary>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_work_request_errors(work_request_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_work_request_errors API.

Gets a list of errors for the specified work request.

Parameters:

• work_request_id (String) —

  The OCID of the work request.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :opc_request_id (String) —

  Unique identifier for the request.

• :page (String) —

  For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

• :limit (Integer) —

  For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

Returns:

• (Response) —

  A Response object with data of type Array<WorkRequestError>

# File 'lib/oci/data_safe/data_safe_client.rb', line 15866

def list_work_request_errors(work_request_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#list_work_request_errors.' if logger

  raise "Missing the required parameter 'work_request_id' when calling list_work_request_errors." if work_request_id.nil?
  raise "Parameter value for 'work_request_id' must not be blank" if OCI::Internal::Util.blank_string?(work_request_id)

  path = '/workRequests/{workRequestId}/errors'.sub('{workRequestId}', work_request_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:limit] = opts[:limit] if opts[:limit]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#list_work_request_errors') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'Array<OCI::DataSafe::Models::WorkRequestError>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_work_request_logs(work_request_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_work_request_logs API.

Gets a list of log entries for the specified work request.

Parameters:

• work_request_id (String) —

  The OCID of the work request.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :opc_request_id (String) —

  Unique identifier for the request.

• :page (String) —

  For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

• :limit (Integer) —

  For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

Returns:

• (Response) —

  A Response object with data of type Array<WorkRequestLogEntry>

# File 'lib/oci/data_safe/data_safe_client.rb', line 15925

def list_work_request_logs(work_request_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#list_work_request_logs.' if logger

  raise "Missing the required parameter 'work_request_id' when calling list_work_request_logs." if work_request_id.nil?
  raise "Parameter value for 'work_request_id' must not be blank" if OCI::Internal::Util.blank_string?(work_request_id)

  path = '/workRequests/{workRequestId}/logs'.sub('{workRequestId}', work_request_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:limit] = opts[:limit] if opts[:limit]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#list_work_request_logs') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'Array<OCI::DataSafe::Models::WorkRequestLogEntry>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_work_requests(compartment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_work_requests API.

Gets a list of work requests.

Parameters:

• compartment_id (String) —

  A filter to return only resources that match the specified compartment OCID.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :operation_type (String) —

  A filter to return only work requests that match the specific operation type.

• :sort_by (String) —

  The field used for sorting. Only one sorting parameter can be specified. The default order is descending. (default to STARTTIME) Allowed values are: STARTTIME, FINISHTIME, ACCEPTEDTIME

• :sort_order (String) —

  The sorting order for the work requests, either ascending (ASC) or descending (DESC). (default to DESC) Allowed values are: ASC, DESC

• :resource_id (String) —

  A filter to return only work requests that match the specified resource OCID.

• :target_database_id (String) —

  A filter to return only work requests that are associated to the specified target database OCID.

• :opc_request_id (String) —

  Unique identifier for the request.

• :page (String) —

  For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

• :limit (Integer) —

  For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

• :compartment_id_in_subtree (BOOLEAN) —

  Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting. (default to false)

• :access_level (String) —

  Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed. (default to RESTRICTED) Allowed values are: RESTRICTED, ACCESSIBLE

Returns:

• (Response) —

  A Response object with data of type Array<WorkRequestSummary>

# File 'lib/oci/data_safe/data_safe_client.rb', line 16002

def list_work_requests(compartment_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#list_work_requests.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_work_requests." if compartment_id.nil?

  if opts[:sort_by] && !%w[STARTTIME FINISHTIME ACCEPTEDTIME].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of STARTTIME, FINISHTIME, ACCEPTEDTIME.'
  end

  if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of ASC, DESC.'
  end

  if opts[:access_level] && !%w[RESTRICTED ACCESSIBLE].include?(opts[:access_level])
    raise 'Invalid value for "access_level", must be one of RESTRICTED, ACCESSIBLE.'
  end

  path = '/workRequests'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:operationType] = opts[:operation_type] if opts[:operation_type]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:resourceId] = opts[:resource_id] if opts[:resource_id]
  query_params[:targetDatabaseId] = opts[:target_database_id] if opts[:target_database_id]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:compartmentIdInSubtree] = opts[:compartment_id_in_subtree] if !opts[:compartment_id_in_subtree].nil?
  query_params[:accessLevel] = opts[:access_level] if opts[:access_level]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#list_work_requests') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'Array<OCI::DataSafe::Models::WorkRequestSummary>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#logger ⇒ Logger

Returns The logger for this client. May be nil.

Returns:

• (Logger) —

  The logger for this client. May be nil.

# File 'lib/oci/data_safe/data_safe_client.rb', line 94

def logger
  @api_client.config.logger
end

#mask_data(masking_policy_id, mask_data_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use mask_data API.

Masks data using the specified masking policy.

Parameters:

• masking_policy_id (String) —

  The OCID of the masking policy.

• mask_data_details (OCI::DataSafe::Models::MaskDataDetails) —

  Details to mask data.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :opc_request_id (String) —

  Unique identifier for the request.

Returns:

• (Response) —

  A Response object with data of type nil

# File 'lib/oci/data_safe/data_safe_client.rb', line 16078

def mask_data(masking_policy_id, mask_data_details, opts = {})
  logger.debug 'Calling operation DataSafeClient#mask_data.' if logger

  raise "Missing the required parameter 'masking_policy_id' when calling mask_data." if masking_policy_id.nil?
  raise "Missing the required parameter 'mask_data_details' when calling mask_data." if mask_data_details.nil?
  raise "Parameter value for 'masking_policy_id' must not be blank" if OCI::Internal::Util.blank_string?(masking_policy_id)

  path = '/maskingPolicies/{maskingPolicyId}/actions/mask'.sub('{maskingPolicyId}', masking_policy_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(mask_data_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#mask_data') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#modify_global_settings(modify_global_settings_details, compartment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use modify_global_settings API.

Modifies Global Settings in Data Safe in the tenancy and region.

Parameters:

• modify_global_settings_details (OCI::DataSafe::Models::ModifyGlobalSettingsDetails) —

  The details used to update global settings in Data Safe.

• compartment_id (String) —

  The OCID of the compartment.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :if_match (String) —

  For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

• :opc_request_id (String) —

  Unique identifier for the request.

• :opc_retry_token (String) —

  A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

Returns:

• (Response) —

  A Response object with data of type nil

# File 'lib/oci/data_safe/data_safe_client.rb', line 16145

def modify_global_settings(modify_global_settings_details, compartment_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#modify_global_settings.' if logger

  raise "Missing the required parameter 'modify_global_settings_details' when calling modify_global_settings." if modify_global_settings_details.nil?
  raise "Missing the required parameter 'compartment_id' when calling modify_global_settings." if compartment_id.nil?
  raise "Parameter value for 'compartment_id' must not be blank" if OCI::Internal::Util.blank_string?(compartment_id)

  path = '/configuration/{compartmentId}/actions/modifyGlobalSettings'.sub('{compartmentId}', compartment_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(modify_global_settings_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#modify_global_settings') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#patch_alerts(patch_alerts_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use patch_alerts API.

Updates the status of one or more alert specified by the alert IDs.

Parameters:

• patch_alerts_details (OCI::DataSafe::Models::PatchAlertsDetails) —

  The alert details to update the status of one or more alert specified by the alert IDs.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :opc_request_id (String) —

  Unique identifier for the request.

• :if_match (String) —

  For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

• :compartment_id_in_subtree (BOOLEAN) —

  Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting. (default to false)

• :access_level (String) —

  Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed. (default to RESTRICTED) Allowed values are: RESTRICTED, ACCESSIBLE

Returns:

• (Response) —

  A Response object with data of type nil

# File 'lib/oci/data_safe/data_safe_client.rb', line 16217

def patch_alerts(patch_alerts_details, opts = {})
  logger.debug 'Calling operation DataSafeClient#patch_alerts.' if logger

  raise "Missing the required parameter 'patch_alerts_details' when calling patch_alerts." if patch_alerts_details.nil?

  if opts[:access_level] && !%w[RESTRICTED ACCESSIBLE].include?(opts[:access_level])
    raise 'Invalid value for "access_level", must be one of RESTRICTED, ACCESSIBLE.'
  end

  path = '/alerts'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentIdInSubtree] = opts[:compartment_id_in_subtree] if !opts[:compartment_id_in_subtree].nil?
  query_params[:accessLevel] = opts[:access_level] if opts[:access_level]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(patch_alerts_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#patch_alerts') do
    @api_client.call_api(
      :PATCH,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#patch_discovery_job_results(discovery_job_id, patch_discovery_job_result_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use patch_discovery_job_results API.

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.

Parameters:

• discovery_job_id (String) —

  The OCID of the discovery job.

• patch_discovery_job_result_details (OCI::DataSafe::Models::PatchDiscoveryJobResultDetails) —

  Details to patch discovery results.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :if_match (String) —

  For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

• :opc_request_id (String) —

  Unique identifier for the request.

Returns:

• (Response) —

  A Response object with data of type nil

# File 'lib/oci/data_safe/data_safe_client.rb', line 16285

def patch_discovery_job_results(discovery_job_id, patch_discovery_job_result_details, opts = {})
  logger.debug 'Calling operation DataSafeClient#patch_discovery_job_results.' if logger

  raise "Missing the required parameter 'discovery_job_id' when calling patch_discovery_job_results." if discovery_job_id.nil?
  raise "Missing the required parameter 'patch_discovery_job_result_details' when calling patch_discovery_job_results." if patch_discovery_job_result_details.nil?
  raise "Parameter value for 'discovery_job_id' must not be blank" if OCI::Internal::Util.blank_string?(discovery_job_id)

  path = '/discoveryJobs/{discoveryJobId}/results'.sub('{discoveryJobId}', discovery_job_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(patch_discovery_job_result_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#patch_discovery_job_results') do
    @api_client.call_api(
      :PATCH,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#patch_masking_columns(masking_policy_id, patch_masking_columns_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use patch_masking_columns API.

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.

Parameters:

• masking_policy_id (String) —

  The OCID of the masking policy.

• patch_masking_columns_details (OCI::DataSafe::Models::PatchMaskingColumnsDetails) —

  Details to patch masking columns.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :opc_request_id (String) —

  Unique identifier for the request.

• :if_match (String) —

  For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

Returns:

• (Response) —

  A Response object with data of type nil

# File 'lib/oci/data_safe/data_safe_client.rb', line 16350

def patch_masking_columns(masking_policy_id, patch_masking_columns_details, opts = {})
  logger.debug 'Calling operation DataSafeClient#patch_masking_columns.' if logger

  raise "Missing the required parameter 'masking_policy_id' when calling patch_masking_columns." if masking_policy_id.nil?
  raise "Missing the required parameter 'patch_masking_columns_details' when calling patch_masking_columns." if patch_masking_columns_details.nil?
  raise "Parameter value for 'masking_policy_id' must not be blank" if OCI::Internal::Util.blank_string?(masking_policy_id)

  path = '/maskingPolicies/{maskingPolicyId}/maskingColumns'.sub('{maskingPolicyId}', masking_policy_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(patch_masking_columns_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#patch_masking_columns') do
    @api_client.call_api(
      :PATCH,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#patch_sdm_masking_policy_difference_columns(sdm_masking_policy_difference_id, patch_sdm_masking_policy_difference_columns_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use patch_sdm_masking_policy_difference_columns API.

Patches one or more SDM masking policy difference columns. You can use this operation to set the plannedAction attribute before using ApplySdmMaskingPolicyDifference to process the difference based on this attribute.

Parameters:

• sdm_masking_policy_difference_id (String) —

  The OCID of the SDM masking policy difference.

• patch_sdm_masking_policy_difference_columns_details (OCI::DataSafe::Models::PatchSdmMaskingPolicyDifferenceColumnsDetails) —

  Details to patch difference columns.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :if_match (String) —

  For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

• :opc_request_id (String) —

  Unique identifier for the request.

Returns:

• (Response) —

  A Response object with data of type nil

# File 'lib/oci/data_safe/data_safe_client.rb', line 16414

def patch_sdm_masking_policy_difference_columns(sdm_masking_policy_difference_id, patch_sdm_masking_policy_difference_columns_details, opts = {})
  logger.debug 'Calling operation DataSafeClient#patch_sdm_masking_policy_difference_columns.' if logger

  raise "Missing the required parameter 'sdm_masking_policy_difference_id' when calling patch_sdm_masking_policy_difference_columns." if sdm_masking_policy_difference_id.nil?
  raise "Missing the required parameter 'patch_sdm_masking_policy_difference_columns_details' when calling patch_sdm_masking_policy_difference_columns." if patch_sdm_masking_policy_difference_columns_details.nil?
  raise "Parameter value for 'sdm_masking_policy_difference_id' must not be blank" if OCI::Internal::Util.blank_string?(sdm_masking_policy_difference_id)

  path = '/sdmMaskingPolicyDifferences/{sdmMaskingPolicyDifferenceId}/differenceColumns'.sub('{sdmMaskingPolicyDifferenceId}', sdm_masking_policy_difference_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(patch_sdm_masking_policy_difference_columns_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#patch_sdm_masking_policy_difference_columns') do
    @api_client.call_api(
      :PATCH,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#patch_sensitive_columns(sensitive_data_model_id, patch_sensitive_column_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use patch_sensitive_columns API.

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.

Parameters:

• sensitive_data_model_id (String) —

  The OCID of the sensitive data model.

• patch_sensitive_column_details (OCI::DataSafe::Models::PatchSensitiveColumnDetails) —

  Details to patch sensitive columns.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :if_match (String) —

  For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

• :opc_request_id (String) —

  Unique identifier for the request.

Returns:

• (Response) —

  A Response object with data of type nil

# File 'lib/oci/data_safe/data_safe_client.rb', line 16479

def patch_sensitive_columns(sensitive_data_model_id, patch_sensitive_column_details, opts = {})
  logger.debug 'Calling operation DataSafeClient#patch_sensitive_columns.' if logger

  raise "Missing the required parameter 'sensitive_data_model_id' when calling patch_sensitive_columns." if sensitive_data_model_id.nil?
  raise "Missing the required parameter 'patch_sensitive_column_details' when calling patch_sensitive_columns." if patch_sensitive_column_details.nil?
  raise "Parameter value for 'sensitive_data_model_id' must not be blank" if OCI::Internal::Util.blank_string?(sensitive_data_model_id)

  path = '/sensitiveDataModels/{sensitiveDataModelId}/sensitiveColumns'.sub('{sensitiveDataModelId}', sensitive_data_model_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(patch_sensitive_column_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#patch_sensitive_columns') do
    @api_client.call_api(
      :PATCH,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#patch_target_alert_policy_association(patch_target_alert_policy_association_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use patch_target_alert_policy_association API.

Creates new target-alert policy associations that will be applied on the target database.

Parameters:

• patch_target_alert_policy_association_details (OCI::DataSafe::Models::PatchTargetAlertPolicyAssociationDetails) —

  The details used to patch the target-alert policy associations.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :opc_request_id (String) —

  Unique identifier for the request.

• :if_match (String) —

  For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

Returns:

• (Response) —

  A Response object with data of type nil

# File 'lib/oci/data_safe/data_safe_client.rb', line 16541

def patch_target_alert_policy_association(patch_target_alert_policy_association_details, opts = {})
  logger.debug 'Calling operation DataSafeClient#patch_target_alert_policy_association.' if logger

  raise "Missing the required parameter 'patch_target_alert_policy_association_details' when calling patch_target_alert_policy_association." if patch_target_alert_policy_association_details.nil?

  path = '/targetAlertPolicyAssociations'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(patch_target_alert_policy_association_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#patch_target_alert_policy_association') do
    @api_client.call_api(
      :PATCH,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#provision_audit_policy(provision_audit_policy_details, audit_policy_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use provision_audit_policy API.

Provision audit policy.

Parameters:

• provision_audit_policy_details (OCI::DataSafe::Models::ProvisionAuditPolicyDetails) —

  Details for provisioning the given policies on the source target database.

• audit_policy_id (String) —

  Unique audit policy identifier.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :if_match (String) —

  For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

• :opc_request_id (String) —

  Unique identifier for the request.

• :opc_retry_token (String) —

  A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

Returns:

• (Response) —

  A Response object with data of type nil

# File 'lib/oci/data_safe/data_safe_client.rb', line 16606

def provision_audit_policy(provision_audit_policy_details, audit_policy_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#provision_audit_policy.' if logger

  raise "Missing the required parameter 'provision_audit_policy_details' when calling provision_audit_policy." if provision_audit_policy_details.nil?
  raise "Missing the required parameter 'audit_policy_id' when calling provision_audit_policy." if audit_policy_id.nil?
  raise "Parameter value for 'audit_policy_id' must not be blank" if OCI::Internal::Util.blank_string?(audit_policy_id)

  path = '/auditPolicies/{auditPolicyId}/actions/provision'.sub('{auditPolicyId}', audit_policy_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(provision_audit_policy_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#provision_audit_policy') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#purge_sql_collection_logs(sql_collection_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use purge_sql_collection_logs API.

Purge the SQL collection logs for the specified SqlCollection.

Parameters:

• sql_collection_id (String) —

  The OCID of the SQL collection resource.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :if_match (String) —

  For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

• :opc_request_id (String) —

  Unique identifier for the request.

• :opc_retry_token (String) —

  A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

Returns:

• (Response) —

  A Response object with data of type nil

# File 'lib/oci/data_safe/data_safe_client.rb', line 16674

def purge_sql_collection_logs(sql_collection_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#purge_sql_collection_logs.' if logger

  raise "Missing the required parameter 'sql_collection_id' when calling purge_sql_collection_logs." if sql_collection_id.nil?
  raise "Parameter value for 'sql_collection_id' must not be blank" if OCI::Internal::Util.blank_string?(sql_collection_id)

  path = '/sqlCollections/{sqlCollectionId}/actions/purgeLogs'.sub('{sqlCollectionId}', sql_collection_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#purge_sql_collection_logs') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#refresh_database_security_configuration(database_security_config_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use refresh_database_security_configuration API.

Refreshes the specified database security configuration.

Parameters:

• database_security_config_id (String) —

  The OCID of the database security configuration resource.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :if_match (String) —

  For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

• :opc_request_id (String) —

  Unique identifier for the request.

• :opc_retry_token (String) —

  A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

Returns:

• (Response) —

  A Response object with data of type nil

# File 'lib/oci/data_safe/data_safe_client.rb', line 16741

def refresh_database_security_configuration(database_security_config_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#refresh_database_security_configuration.' if logger

  raise "Missing the required parameter 'database_security_config_id' when calling refresh_database_security_configuration." if database_security_config_id.nil?
  raise "Parameter value for 'database_security_config_id' must not be blank" if OCI::Internal::Util.blank_string?(database_security_config_id)

  path = '/databaseSecurityConfigs/{databaseSecurityConfigId}/actions/refresh'.sub('{databaseSecurityConfigId}', database_security_config_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#refresh_database_security_configuration') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#refresh_security_assessment(security_assessment_id, run_security_assessment_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use refresh_security_assessment API.

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.

Parameters:

• security_assessment_id (String) —

  The OCID of the security assessment.

• run_security_assessment_details (OCI::DataSafe::Models::RunSecurityAssessmentDetails) —

  Details to create an on-demand saved security assessment.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :opc_retry_token (String) —

  A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

• :opc_request_id (String) —

  Unique identifier for the request.

• :if_match (String) —

  For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

Returns:

• (Response) —

  A Response object with data of type nil

# File 'lib/oci/data_safe/data_safe_client.rb', line 16811

def refresh_security_assessment(security_assessment_id, run_security_assessment_details, opts = {})
  logger.debug 'Calling operation DataSafeClient#refresh_security_assessment.' if logger

  raise "Missing the required parameter 'security_assessment_id' when calling refresh_security_assessment." if security_assessment_id.nil?
  raise "Missing the required parameter 'run_security_assessment_details' when calling refresh_security_assessment." if run_security_assessment_details.nil?
  raise "Parameter value for 'security_assessment_id' must not be blank" if OCI::Internal::Util.blank_string?(security_assessment_id)

  path = '/securityAssessments/{securityAssessmentId}/actions/refresh'.sub('{securityAssessmentId}', security_assessment_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(run_security_assessment_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#refresh_security_assessment') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#refresh_sql_collection_log_insights(sql_collection_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use refresh_sql_collection_log_insights API.

Refresh the specified SQL collection Log Insights.

Parameters:

• sql_collection_id (String) —

  The OCID of the SQL collection resource.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :if_match (String) —

  For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

• :opc_request_id (String) —

  Unique identifier for the request.

• :opc_retry_token (String) —

  A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

Returns:

• (Response) —

  A Response object with data of type nil

# File 'lib/oci/data_safe/data_safe_client.rb', line 16879

def refresh_sql_collection_log_insights(sql_collection_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#refresh_sql_collection_log_insights.' if logger

  raise "Missing the required parameter 'sql_collection_id' when calling refresh_sql_collection_log_insights." if sql_collection_id.nil?
  raise "Parameter value for 'sql_collection_id' must not be blank" if OCI::Internal::Util.blank_string?(sql_collection_id)

  path = '/sqlCollections/{sqlCollectionId}/actions/refreshLogInsights'.sub('{sqlCollectionId}', sql_collection_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#refresh_sql_collection_log_insights') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#refresh_user_assessment(user_assessment_id, run_user_assessment_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use refresh_user_assessment API.

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.

Parameters:

• user_assessment_id (String) —

  The OCID of the user assessment.

• run_user_assessment_details (OCI::DataSafe::Models::RunUserAssessmentDetails) —

  The details required to create an on-demand saved user assessment.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :opc_retry_token (String) —

  A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

• :opc_request_id (String) —

  Unique identifier for the request.

• :if_match (String) —

  For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

Returns:

• (Response) —

  A Response object with data of type nil

# File 'lib/oci/data_safe/data_safe_client.rb', line 16950

def refresh_user_assessment(user_assessment_id, run_user_assessment_details, opts = {})
  logger.debug 'Calling operation DataSafeClient#refresh_user_assessment.' if logger

  raise "Missing the required parameter 'user_assessment_id' when calling refresh_user_assessment." if user_assessment_id.nil?
  raise "Missing the required parameter 'run_user_assessment_details' when calling refresh_user_assessment." if run_user_assessment_details.nil?
  raise "Parameter value for 'user_assessment_id' must not be blank" if OCI::Internal::Util.blank_string?(user_assessment_id)

  path = '/userAssessments/{userAssessmentId}/actions/refresh'.sub('{userAssessmentId}', user_assessment_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(run_user_assessment_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#refresh_user_assessment') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#remove_schedule_report(report_definition_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use remove_schedule_report API.

Deletes the schedule of a PDF or XLS report.

Parameters:

• report_definition_id (String) —

  Unique report definition identifier

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :if_match (String) —

  For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

• :opc_request_id (String) —

  Unique identifier for the request.

• :opc_retry_token (String) —

  A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

Returns:

• (Response) —

  A Response object with data of type nil

# File 'lib/oci/data_safe/data_safe_client.rb', line 17018

def remove_schedule_report(report_definition_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#remove_schedule_report.' if logger

  raise "Missing the required parameter 'report_definition_id' when calling remove_schedule_report." if report_definition_id.nil?
  raise "Parameter value for 'report_definition_id' must not be blank" if OCI::Internal::Util.blank_string?(report_definition_id)

  path = '/reportDefinitions/{reportDefinitionId}/actions/removeScheduleReport'.sub('{reportDefinitionId}', report_definition_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#remove_schedule_report') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#resume_audit_trail(audit_trail_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use resume_audit_trail API.

Resumes the specified audit trail once it got stopped.

Parameters:

• audit_trail_id (String) —

  The OCID of the audit trail.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :if_match (String) —

  For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

• :opc_request_id (String) —

  Unique identifier for the request.

Returns:

• (Response) —

  A Response object with data of type nil

# File 'lib/oci/data_safe/data_safe_client.rb', line 17080

def resume_audit_trail(audit_trail_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#resume_audit_trail.' if logger

  raise "Missing the required parameter 'audit_trail_id' when calling resume_audit_trail." if audit_trail_id.nil?
  raise "Parameter value for 'audit_trail_id' must not be blank" if OCI::Internal::Util.blank_string?(audit_trail_id)

  path = '/auditTrails/{auditTrailId}/actions/resume'.sub('{auditTrailId}', audit_trail_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#resume_audit_trail') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#resume_work_request(work_request_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use resume_work_request API.

Resume the given work request. Issuing a resume does not guarantee of immediate resume of the work request.

Parameters:

• work_request_id (String) —

  The OCID of the work request.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :opc_retry_token (String) —

  A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

• :opc_request_id (String) —

  Unique identifier for the request.

• :if_match (String) —

  For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

Returns:

• (Response) —

  A Response object with data of type nil

# File 'lib/oci/data_safe/data_safe_client.rb', line 17146

def resume_work_request(work_request_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#resume_work_request.' if logger

  raise "Missing the required parameter 'work_request_id' when calling resume_work_request." if work_request_id.nil?
  raise "Parameter value for 'work_request_id' must not be blank" if OCI::Internal::Util.blank_string?(work_request_id)

  path = '/workRequests/{workRequestId}/actions/resume'.sub('{workRequestId}', work_request_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#resume_work_request') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#retrieve_audit_policies(audit_policy_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use retrieve_audit_policies API.

Retrieves the audit policy details from the source target database.

Parameters:

• audit_policy_id (String) —

  Unique audit policy identifier.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :if_match (String) —

  For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

• :opc_request_id (String) —

  Unique identifier for the request.

• :opc_retry_token (String) —

  A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

Returns:

• (Response) —

  A Response object with data of type nil

# File 'lib/oci/data_safe/data_safe_client.rb', line 17213

def retrieve_audit_policies(audit_policy_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#retrieve_audit_policies.' if logger

  raise "Missing the required parameter 'audit_policy_id' when calling retrieve_audit_policies." if audit_policy_id.nil?
  raise "Parameter value for 'audit_policy_id' must not be blank" if OCI::Internal::Util.blank_string?(audit_policy_id)

  path = '/auditPolicies/{auditPolicyId}/actions/retrieveFromTarget'.sub('{auditPolicyId}', audit_policy_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#retrieve_audit_policies') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#schedule_report(report_definition_id, schedule_report_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use schedule_report API.

Schedules a PDF or XLS report based on parameters and report definition.

Parameters:

• report_definition_id (String) —

  Unique report definition identifier

• schedule_report_details (OCI::DataSafe::Models::ScheduleReportDetails) —

  The details for the audit report schedule. It contains details such as schedule, PDF/XLS and number of rows.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :if_match (String) —

  For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

• :opc_request_id (String) —

  Unique identifier for the request.

• :opc_retry_token (String) —

  A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

Returns:

• (Response) —

  A Response object with data of type nil

# File 'lib/oci/data_safe/data_safe_client.rb', line 17281

def schedule_report(report_definition_id, schedule_report_details, opts = {})
  logger.debug 'Calling operation DataSafeClient#schedule_report.' if logger

  raise "Missing the required parameter 'report_definition_id' when calling schedule_report." if report_definition_id.nil?
  raise "Missing the required parameter 'schedule_report_details' when calling schedule_report." if schedule_report_details.nil?
  raise "Parameter value for 'report_definition_id' must not be blank" if OCI::Internal::Util.blank_string?(report_definition_id)

  path = '/reportDefinitions/{reportDefinitionId}/actions/scheduleReport'.sub('{reportDefinitionId}', report_definition_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(schedule_report_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#schedule_report') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#set_security_assessment_baseline(security_assessment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use set_security_assessment_baseline API.

Sets the saved security assessment as the baseline in the compartment where the the specified assessment resides. The security assessment needs to be of type 'SAVED'.

Parameters:

• security_assessment_id (String) —

  The OCID of the security assessment.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :if_match (String) —

  For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

• :opc_retry_token (String) —

  A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

• :opc_request_id (String) —

  Unique identifier for the request.

• :base_line_details (OCI::DataSafe::Models::SecurityAssessmentBaseLineDetails) —

  Details of security assessment that need to be updated while setting the baseline.

Returns:

• (Response) —

  A Response object with data of type nil

# File 'lib/oci/data_safe/data_safe_client.rb', line 17350

def set_security_assessment_baseline(security_assessment_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#set_security_assessment_baseline.' if logger

  raise "Missing the required parameter 'security_assessment_id' when calling set_security_assessment_baseline." if security_assessment_id.nil?
  raise "Parameter value for 'security_assessment_id' must not be blank" if OCI::Internal::Util.blank_string?(security_assessment_id)

  path = '/securityAssessments/{securityAssessmentId}/actions/setBaseline'.sub('{securityAssessmentId}', security_assessment_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(opts[:base_line_details])

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#set_security_assessment_baseline') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#set_user_assessment_baseline(user_assessment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use set_user_assessment_baseline API.

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

Parameters:

• user_assessment_id (String) —

  The OCID of the user assessment.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :if_match (String) —

  For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

• :opc_retry_token (String) —

  A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

• :opc_request_id (String) —

  Unique identifier for the request.

• :base_line_details (OCI::DataSafe::Models::UserAssessmentBaseLineDetails) —

  Details of user assessment that need to be updated while setting the baseline.

Returns:

• (Response) —

  A Response object with data of type nil

# File 'lib/oci/data_safe/data_safe_client.rb', line 17418

def set_user_assessment_baseline(user_assessment_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#set_user_assessment_baseline.' if logger

  raise "Missing the required parameter 'user_assessment_id' when calling set_user_assessment_baseline." if user_assessment_id.nil?
  raise "Parameter value for 'user_assessment_id' must not be blank" if OCI::Internal::Util.blank_string?(user_assessment_id)

  path = '/userAssessments/{userAssessmentId}/actions/setBaseline'.sub('{userAssessmentId}', user_assessment_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(opts[:base_line_details])

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#set_user_assessment_baseline') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#start_audit_trail(start_audit_trail_details, audit_trail_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use start_audit_trail API.

Starts collection of audit records on the specified audit trail.

Parameters:

• start_audit_trail_details (OCI::DataSafe::Models::StartAuditTrailDetails) —

  Details for the starting audit.

• audit_trail_id (String) —

  The OCID of the audit trail.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :if_match (String) —

  For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

• :opc_request_id (String) —

  Unique identifier for the request.

• :opc_retry_token (String) —

  A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

Returns:

• (Response) —

  A Response object with data of type nil

# File 'lib/oci/data_safe/data_safe_client.rb', line 17486

def start_audit_trail(start_audit_trail_details, audit_trail_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#start_audit_trail.' if logger

  raise "Missing the required parameter 'start_audit_trail_details' when calling start_audit_trail." if start_audit_trail_details.nil?
  raise "Missing the required parameter 'audit_trail_id' when calling start_audit_trail." if audit_trail_id.nil?
  raise "Parameter value for 'audit_trail_id' must not be blank" if OCI::Internal::Util.blank_string?(audit_trail_id)

  path = '/auditTrails/{auditTrailId}/actions/start'.sub('{auditTrailId}', audit_trail_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(start_audit_trail_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#start_audit_trail') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#start_sql_collection(sql_collection_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use start_sql_collection API.

Start the specified SQL collection.

Parameters:

• sql_collection_id (String) —

  The OCID of the SQL collection resource.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :if_match (String) —

  For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

• :opc_request_id (String) —

  Unique identifier for the request.

• :opc_retry_token (String) —

  A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

Returns:

• (Response) —

  A Response object with data of type nil

# File 'lib/oci/data_safe/data_safe_client.rb', line 17554

def start_sql_collection(sql_collection_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#start_sql_collection.' if logger

  raise "Missing the required parameter 'sql_collection_id' when calling start_sql_collection." if sql_collection_id.nil?
  raise "Parameter value for 'sql_collection_id' must not be blank" if OCI::Internal::Util.blank_string?(sql_collection_id)

  path = '/sqlCollections/{sqlCollectionId}/actions/start'.sub('{sqlCollectionId}', sql_collection_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#start_sql_collection') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#stop_audit_trail(audit_trail_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use stop_audit_trail API.

Stops the specified audit trail.

Parameters:

• audit_trail_id (String) —

  The OCID of the audit trail.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :if_match (String) —

  For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

• :opc_request_id (String) —

  Unique identifier for the request.

Returns:

• (Response) —

  A Response object with data of type nil

# File 'lib/oci/data_safe/data_safe_client.rb', line 17616

def stop_audit_trail(audit_trail_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#stop_audit_trail.' if logger

  raise "Missing the required parameter 'audit_trail_id' when calling stop_audit_trail." if audit_trail_id.nil?
  raise "Parameter value for 'audit_trail_id' must not be blank" if OCI::Internal::Util.blank_string?(audit_trail_id)

  path = '/auditTrails/{auditTrailId}/actions/stop'.sub('{auditTrailId}', audit_trail_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#stop_audit_trail') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#stop_sql_collection(sql_collection_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use stop_sql_collection API.

Stops the specified SQL collection.

Parameters:

• sql_collection_id (String) —

  The OCID of the SQL collection resource.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :if_match (String) —

  For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

• :opc_request_id (String) —

  Unique identifier for the request.

• :opc_retry_token (String) —

  A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

Returns:

• (Response) —

  A Response object with data of type nil

# File 'lib/oci/data_safe/data_safe_client.rb', line 17681

def stop_sql_collection(sql_collection_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#stop_sql_collection.' if logger

  raise "Missing the required parameter 'sql_collection_id' when calling stop_sql_collection." if sql_collection_id.nil?
  raise "Parameter value for 'sql_collection_id' must not be blank" if OCI::Internal::Util.blank_string?(sql_collection_id)

  path = '/sqlCollections/{sqlCollectionId}/actions/stop'.sub('{sqlCollectionId}', sql_collection_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#stop_sql_collection') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#suspend_work_request(work_request_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use suspend_work_request API.

Suspend the given work request. Issuing a suspend does not guarantee of a immediate suspend of the work request.

Parameters:

• work_request_id (String) —

  The OCID of the work request.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :opc_retry_token (String) —

  A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

• :opc_request_id (String) —

  Unique identifier for the request.

• :if_match (String) —

  For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

Returns:

• (Response) —

  A Response object with data of type nil

# File 'lib/oci/data_safe/data_safe_client.rb', line 17749

def suspend_work_request(work_request_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#suspend_work_request.' if logger

  raise "Missing the required parameter 'work_request_id' when calling suspend_work_request." if work_request_id.nil?
  raise "Parameter value for 'work_request_id' must not be blank" if OCI::Internal::Util.blank_string?(work_request_id)

  path = '/workRequests/{workRequestId}/actions/suspend'.sub('{workRequestId}', work_request_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#suspend_work_request') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#unset_security_assessment_baseline(security_assessment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use unset_security_assessment_baseline API.

Removes the baseline setting for the saved security assessment. The saved security assessment is no longer considered a baseline. Sets the if-match parameter to the value of the etag from a previous GET or POST response for that resource.

Parameters:

• security_assessment_id (String) —

  The OCID of the security assessment.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :if_match (String) —

  For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

• :opc_retry_token (String) —

  A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

• :opc_request_id (String) —

  Unique identifier for the request.

Returns:

• (Response) —

  A Response object with data of type nil

# File 'lib/oci/data_safe/data_safe_client.rb', line 17818

def unset_security_assessment_baseline(security_assessment_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#unset_security_assessment_baseline.' if logger

  raise "Missing the required parameter 'security_assessment_id' when calling unset_security_assessment_baseline." if security_assessment_id.nil?
  raise "Parameter value for 'security_assessment_id' must not be blank" if OCI::Internal::Util.blank_string?(security_assessment_id)

  path = '/securityAssessments/{securityAssessmentId}/actions/unsetBaseline'.sub('{securityAssessmentId}', security_assessment_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#unset_security_assessment_baseline') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#unset_user_assessment_baseline(user_assessment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use unset_user_assessment_baseline API.

Removes the baseline setting for the saved user assessment. The saved user assessment is no longer considered a baseline. Sets the if-match parameter to the value of the etag from a previous GET or POST response for that resource.

Parameters:

• user_assessment_id (String) —

  The OCID of the user assessment.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :if_match (String) —

  For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

• :opc_retry_token (String) —

  A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

• :opc_request_id (String) —

  Unique identifier for the request.

Returns:

• (Response) —

  A Response object with data of type nil

# File 'lib/oci/data_safe/data_safe_client.rb', line 17887

def unset_user_assessment_baseline(user_assessment_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#unset_user_assessment_baseline.' if logger

  raise "Missing the required parameter 'user_assessment_id' when calling unset_user_assessment_baseline." if user_assessment_id.nil?
  raise "Parameter value for 'user_assessment_id' must not be blank" if OCI::Internal::Util.blank_string?(user_assessment_id)

  path = '/userAssessments/{userAssessmentId}/actions/unsetBaseline'.sub('{userAssessmentId}', user_assessment_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#unset_user_assessment_baseline') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_alert(alert_id, update_alert_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use update_alert API.

Updates the status of the specified alert.

Parameters:

• alert_id (String) —

  The OCID of alert.

• update_alert_details (OCI::DataSafe::Models::UpdateAlertDetails) —

  The details used to update alert status.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :if_match (String) —

  For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

• :opc_request_id (String) —

  Unique identifier for the request.

Returns:

• (Response) —

  A Response object with data of type Alert

# File 'lib/oci/data_safe/data_safe_client.rb', line 17950

def update_alert(alert_id, update_alert_details, opts = {})
  logger.debug 'Calling operation DataSafeClient#update_alert.' if logger

  raise "Missing the required parameter 'alert_id' when calling update_alert." if alert_id.nil?
  raise "Missing the required parameter 'update_alert_details' when calling update_alert." if update_alert_details.nil?
  raise "Parameter value for 'alert_id' must not be blank" if OCI::Internal::Util.blank_string?(alert_id)

  path = '/alerts/{alertId}'.sub('{alertId}', alert_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(update_alert_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#update_alert') do
    @api_client.call_api(
      :PUT,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataSafe::Models::Alert'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_audit_archive_retrieval(audit_archive_retrieval_id, update_audit_archive_retrieval_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use update_audit_archive_retrieval API.

Updates the audit archive retrieval.

Parameters:

• audit_archive_retrieval_id (String) —

  OCID of the archive retrieval.

• update_audit_archive_retrieval_details (OCI::DataSafe::Models::UpdateAuditArchiveRetrievalDetails) —

  Details to update the audit archive retrieval.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :if_match (String) —

  For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

• :opc_request_id (String) —

  Unique identifier for the request.

Returns:

• (Response) —

  A Response object with data of type nil

# File 'lib/oci/data_safe/data_safe_client.rb', line 18013

def update_audit_archive_retrieval(audit_archive_retrieval_id, update_audit_archive_retrieval_details, opts = {})
  logger.debug 'Calling operation DataSafeClient#update_audit_archive_retrieval.' if logger

  raise "Missing the required parameter 'audit_archive_retrieval_id' when calling update_audit_archive_retrieval." if audit_archive_retrieval_id.nil?
  raise "Missing the required parameter 'update_audit_archive_retrieval_details' when calling update_audit_archive_retrieval." if update_audit_archive_retrieval_details.nil?
  raise "Parameter value for 'audit_archive_retrieval_id' must not be blank" if OCI::Internal::Util.blank_string?(audit_archive_retrieval_id)

  path = '/auditArchiveRetrievals/{auditArchiveRetrievalId}'.sub('{auditArchiveRetrievalId}', audit_archive_retrieval_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(update_audit_archive_retrieval_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#update_audit_archive_retrieval') do
    @api_client.call_api(
      :PUT,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_audit_policy(audit_policy_id, update_audit_policy_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use update_audit_policy API.

Updates the audit policy.

Parameters:

• audit_policy_id (String) —

  Unique audit policy identifier.

• update_audit_policy_details (OCI::DataSafe::Models::UpdateAuditPolicyDetails) —

  Details to update the audit policy.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :if_match (String) —

  For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

• :opc_request_id (String) —

  Unique identifier for the request.

Returns:

• (Response) —

  A Response object with data of type nil

# File 'lib/oci/data_safe/data_safe_client.rb', line 18075

def update_audit_policy(audit_policy_id, update_audit_policy_details, opts = {})
  logger.debug 'Calling operation DataSafeClient#update_audit_policy.' if logger

  raise "Missing the required parameter 'audit_policy_id' when calling update_audit_policy." if audit_policy_id.nil?
  raise "Missing the required parameter 'update_audit_policy_details' when calling update_audit_policy." if update_audit_policy_details.nil?
  raise "Parameter value for 'audit_policy_id' must not be blank" if OCI::Internal::Util.blank_string?(audit_policy_id)

  path = '/auditPolicies/{auditPolicyId}'.sub('{auditPolicyId}', audit_policy_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(update_audit_policy_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#update_audit_policy') do
    @api_client.call_api(
      :PUT,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_audit_profile(audit_profile_id, update_audit_profile_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use update_audit_profile API.

Updates one or more attributes of the specified audit profile.

Parameters:

• audit_profile_id (String) —

  The OCID of the audit.

• update_audit_profile_details (OCI::DataSafe::Models::UpdateAuditProfileDetails) —

  The information to be updated.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :if_match (String) —

  For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

• :opc_request_id (String) —

  Unique identifier for the request.

Returns:

• (Response) —

  A Response object with data of type nil

# File 'lib/oci/data_safe/data_safe_client.rb', line 18137

def update_audit_profile(audit_profile_id, update_audit_profile_details, opts = {})
  logger.debug 'Calling operation DataSafeClient#update_audit_profile.' if logger

  raise "Missing the required parameter 'audit_profile_id' when calling update_audit_profile." if audit_profile_id.nil?
  raise "Missing the required parameter 'update_audit_profile_details' when calling update_audit_profile." if update_audit_profile_details.nil?
  raise "Parameter value for 'audit_profile_id' must not be blank" if OCI::Internal::Util.blank_string?(audit_profile_id)

  path = '/auditProfiles/{auditProfileId}'.sub('{auditProfileId}', audit_profile_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(update_audit_profile_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#update_audit_profile') do
    @api_client.call_api(
      :PUT,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_audit_trail(audit_trail_id, update_audit_trail_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use update_audit_trail API.

Updates one or more attributes of the specified audit trail.

Parameters:

• audit_trail_id (String) —

  The OCID of the audit trail.

• update_audit_trail_details (OCI::DataSafe::Models::UpdateAuditTrailDetails) —

  The information to be updated.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :if_match (String) —

  For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

• :opc_request_id (String) —

  Unique identifier for the request.

Returns:

• (Response) —

  A Response object with data of type nil

# File 'lib/oci/data_safe/data_safe_client.rb', line 18199

def update_audit_trail(audit_trail_id, update_audit_trail_details, opts = {})
  logger.debug 'Calling operation DataSafeClient#update_audit_trail.' if logger

  raise "Missing the required parameter 'audit_trail_id' when calling update_audit_trail." if audit_trail_id.nil?
  raise "Missing the required parameter 'update_audit_trail_details' when calling update_audit_trail." if update_audit_trail_details.nil?
  raise "Parameter value for 'audit_trail_id' must not be blank" if OCI::Internal::Util.blank_string?(audit_trail_id)

  path = '/auditTrails/{auditTrailId}'.sub('{auditTrailId}', audit_trail_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(update_audit_trail_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#update_audit_trail') do
    @api_client.call_api(
      :PUT,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_data_safe_private_endpoint(data_safe_private_endpoint_id, update_data_safe_private_endpoint_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use update_data_safe_private_endpoint API.

Updates one or more attributes of the specified Data Safe private endpoint.

Parameters:

• data_safe_private_endpoint_id (String) —

  The OCID of the private endpoint.

• update_data_safe_private_endpoint_details (OCI::DataSafe::Models::UpdateDataSafePrivateEndpointDetails) —

  The details used to update a Data Safe private endpoint.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :if_match (String) —

  For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

• :opc_request_id (String) —

  Unique identifier for the request.

Returns:

• (Response) —

  A Response object with data of type nil

# File 'lib/oci/data_safe/data_safe_client.rb', line 18261

def update_data_safe_private_endpoint(data_safe_private_endpoint_id, update_data_safe_private_endpoint_details, opts = {})
  logger.debug 'Calling operation DataSafeClient#update_data_safe_private_endpoint.' if logger

  raise "Missing the required parameter 'data_safe_private_endpoint_id' when calling update_data_safe_private_endpoint." if data_safe_private_endpoint_id.nil?
  raise "Missing the required parameter 'update_data_safe_private_endpoint_details' when calling update_data_safe_private_endpoint." if update_data_safe_private_endpoint_details.nil?
  raise "Parameter value for 'data_safe_private_endpoint_id' must not be blank" if OCI::Internal::Util.blank_string?(data_safe_private_endpoint_id)

  path = '/dataSafePrivateEndpoints/{dataSafePrivateEndpointId}'.sub('{dataSafePrivateEndpointId}', data_safe_private_endpoint_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(update_data_safe_private_endpoint_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#update_data_safe_private_endpoint') do
    @api_client.call_api(
      :PUT,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_database_security_config(database_security_config_id, update_database_security_config_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use update_database_security_config API.

Updates the database security configuration.

Parameters:

• database_security_config_id (String) —

  The OCID of the database security configuration resource.

• update_database_security_config_details (OCI::DataSafe::Models::UpdateDatabaseSecurityConfigDetails) —

  Details to update the database security configuration.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :if_match (String) —

  For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

• :opc_request_id (String) —

  Unique identifier for the request.

Returns:

• (Response) —

  A Response object with data of type nil

# File 'lib/oci/data_safe/data_safe_client.rb', line 18323

def update_database_security_config(database_security_config_id, update_database_security_config_details, opts = {})
  logger.debug 'Calling operation DataSafeClient#update_database_security_config.' if logger

  raise "Missing the required parameter 'database_security_config_id' when calling update_database_security_config." if database_security_config_id.nil?
  raise "Missing the required parameter 'update_database_security_config_details' when calling update_database_security_config." if update_database_security_config_details.nil?
  raise "Parameter value for 'database_security_config_id' must not be blank" if OCI::Internal::Util.blank_string?(database_security_config_id)

  path = '/databaseSecurityConfigs/{databaseSecurityConfigId}'.sub('{databaseSecurityConfigId}', database_security_config_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(update_database_security_config_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#update_database_security_config') do
    @api_client.call_api(
      :PUT,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_library_masking_format(library_masking_format_id, update_library_masking_format_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use update_library_masking_format API.

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.

Parameters:

• library_masking_format_id (String) —

  The OCID of the library masking format.

• update_library_masking_format_details (OCI::DataSafe::Models::UpdateLibraryMaskingFormatDetails) —

  Details to update a library masking format.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :if_match (String) —

  For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

• :opc_request_id (String) —

  Unique identifier for the request.

Returns:

• (Response) —

  A Response object with data of type nil

# File 'lib/oci/data_safe/data_safe_client.rb', line 18385

def update_library_masking_format(library_masking_format_id, update_library_masking_format_details, opts = {})
  logger.debug 'Calling operation DataSafeClient#update_library_masking_format.' if logger

  raise "Missing the required parameter 'library_masking_format_id' when calling update_library_masking_format." if library_masking_format_id.nil?
  raise "Missing the required parameter 'update_library_masking_format_details' when calling update_library_masking_format." if update_library_masking_format_details.nil?
  raise "Parameter value for 'library_masking_format_id' must not be blank" if OCI::Internal::Util.blank_string?(library_masking_format_id)

  path = '/libraryMaskingFormats/{libraryMaskingFormatId}'.sub('{libraryMaskingFormatId}', library_masking_format_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(update_library_masking_format_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#update_library_masking_format') do
    @api_client.call_api(
      :PUT,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_masking_column(masking_column_key, masking_policy_id, update_masking_column_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use update_masking_column API.

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.

Parameters:

• masking_column_key (String) —

  The unique key that identifies the masking column. It's numeric and unique within a masking policy.

• masking_policy_id (String) —

  The OCID of the masking policy.

• update_masking_column_details (OCI::DataSafe::Models::UpdateMaskingColumnDetails) —

  Details to update a masking column.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :if_match (String) —

  For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

• :opc_request_id (String) —

  Unique identifier for the request.

Returns:

• (Response) —

  A Response object with data of type nil

# File 'lib/oci/data_safe/data_safe_client.rb', line 18450

def update_masking_column(masking_column_key, masking_policy_id, update_masking_column_details, opts = {})
  logger.debug 'Calling operation DataSafeClient#update_masking_column.' if logger

  raise "Missing the required parameter 'masking_column_key' when calling update_masking_column." if masking_column_key.nil?
  raise "Missing the required parameter 'masking_policy_id' when calling update_masking_column." if masking_policy_id.nil?
  raise "Missing the required parameter 'update_masking_column_details' when calling update_masking_column." if update_masking_column_details.nil?
  raise "Parameter value for 'masking_column_key' must not be blank" if OCI::Internal::Util.blank_string?(masking_column_key)
  raise "Parameter value for 'masking_policy_id' must not be blank" if OCI::Internal::Util.blank_string?(masking_policy_id)

  path = '/maskingPolicies/{maskingPolicyId}/maskingColumns/{maskingColumnKey}'.sub('{maskingColumnKey}', masking_column_key.to_s).sub('{maskingPolicyId}', masking_policy_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(update_masking_column_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#update_masking_column') do
    @api_client.call_api(
      :PUT,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_masking_policy(masking_policy_id, update_masking_policy_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use update_masking_policy API.

Updates one or more attributes of the specified masking policy.

Parameters:

• masking_policy_id (String) —

  The OCID of the masking policy.

• update_masking_policy_details (OCI::DataSafe::Models::UpdateMaskingPolicyDetails) —

  Details to update a masking policy.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :if_match (String) —

  For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

• :opc_request_id (String) —

  Unique identifier for the request.

Returns:

• (Response) —

  A Response object with data of type nil

# File 'lib/oci/data_safe/data_safe_client.rb', line 18514

def update_masking_policy(masking_policy_id, update_masking_policy_details, opts = {})
  logger.debug 'Calling operation DataSafeClient#update_masking_policy.' if logger

  raise "Missing the required parameter 'masking_policy_id' when calling update_masking_policy." if masking_policy_id.nil?
  raise "Missing the required parameter 'update_masking_policy_details' when calling update_masking_policy." if update_masking_policy_details.nil?
  raise "Parameter value for 'masking_policy_id' must not be blank" if OCI::Internal::Util.blank_string?(masking_policy_id)

  path = '/maskingPolicies/{maskingPolicyId}'.sub('{maskingPolicyId}', masking_policy_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(update_masking_policy_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#update_masking_policy') do
    @api_client.call_api(
      :PUT,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_on_prem_connector(on_prem_connector_id, update_on_prem_connector_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use update_on_prem_connector API.

Updates one or more attributes of the specified on-premises connector.

Parameters:

• on_prem_connector_id (String) —

  The OCID of the on-premises connector.

• update_on_prem_connector_details (OCI::DataSafe::Models::UpdateOnPremConnectorDetails) —

  The details used to update a on-premises connector.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :if_match (String) —

  For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

• :opc_request_id (String) —

  Unique identifier for the request.

Returns:

• (Response) —

  A Response object with data of type nil

# File 'lib/oci/data_safe/data_safe_client.rb', line 18576

def update_on_prem_connector(on_prem_connector_id, update_on_prem_connector_details, opts = {})
  logger.debug 'Calling operation DataSafeClient#update_on_prem_connector.' if logger

  raise "Missing the required parameter 'on_prem_connector_id' when calling update_on_prem_connector." if on_prem_connector_id.nil?
  raise "Missing the required parameter 'update_on_prem_connector_details' when calling update_on_prem_connector." if update_on_prem_connector_details.nil?
  raise "Parameter value for 'on_prem_connector_id' must not be blank" if OCI::Internal::Util.blank_string?(on_prem_connector_id)

  path = '/onPremConnectors/{onPremConnectorId}'.sub('{onPremConnectorId}', on_prem_connector_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(update_on_prem_connector_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#update_on_prem_connector') do
    @api_client.call_api(
      :PUT,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_on_prem_connector_wallet(update_on_prem_connector_wallet_details, on_prem_connector_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use update_on_prem_connector_wallet API.

Updates the wallet for the specified on-premises connector to a new version.

Parameters:

• update_on_prem_connector_wallet_details (OCI::DataSafe::Models::UpdateOnPremConnectorWalletDetails) —

  The details used to update an on-premises connector's wallet.

• on_prem_connector_id (String) —

  The OCID of the on-premises connector.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :opc_retry_token (String) —

  A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

• :if_match (String) —

  For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

• :opc_request_id (String) —

  Unique identifier for the request.

Returns:

• (Response) —

  A Response object with data of type nil

# File 'lib/oci/data_safe/data_safe_client.rb', line 18644

def update_on_prem_connector_wallet(update_on_prem_connector_wallet_details, on_prem_connector_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#update_on_prem_connector_wallet.' if logger

  raise "Missing the required parameter 'update_on_prem_connector_wallet_details' when calling update_on_prem_connector_wallet." if update_on_prem_connector_wallet_details.nil?
  raise "Missing the required parameter 'on_prem_connector_id' when calling update_on_prem_connector_wallet." if on_prem_connector_id.nil?
  raise "Parameter value for 'on_prem_connector_id' must not be blank" if OCI::Internal::Util.blank_string?(on_prem_connector_id)

  path = '/onPremConnectors/{onPremConnectorId}/wallet'.sub('{onPremConnectorId}', on_prem_connector_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(update_on_prem_connector_wallet_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#update_on_prem_connector_wallet') do
    @api_client.call_api(
      :PUT,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_report_definition(report_definition_id, update_report_definition_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use update_report_definition API.

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.

Parameters:

• report_definition_id (String) —

  Unique report definition identifier

• update_report_definition_details (OCI::DataSafe::Models::UpdateReportDefinitionDetails) —

  Details for the modified report definition.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :if_match (String) —

  For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

• :opc_request_id (String) —

  Unique identifier for the request.

• :opc_retry_token (String) —

  A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

Returns:

• (Response) —

  A Response object with data of type nil

# File 'lib/oci/data_safe/data_safe_client.rb', line 18713

def update_report_definition(report_definition_id, update_report_definition_details, opts = {})
  logger.debug 'Calling operation DataSafeClient#update_report_definition.' if logger

  raise "Missing the required parameter 'report_definition_id' when calling update_report_definition." if report_definition_id.nil?
  raise "Missing the required parameter 'update_report_definition_details' when calling update_report_definition." if update_report_definition_details.nil?
  raise "Parameter value for 'report_definition_id' must not be blank" if OCI::Internal::Util.blank_string?(report_definition_id)

  path = '/reportDefinitions/{reportDefinitionId}'.sub('{reportDefinitionId}', report_definition_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(update_report_definition_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#update_report_definition') do
    @api_client.call_api(
      :PUT,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_sdm_masking_policy_difference(sdm_masking_policy_difference_id, update_sdm_masking_policy_difference_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use update_sdm_masking_policy_difference API.

Updates one or more attributes of the specified sdm masking policy difference.

Parameters:

• sdm_masking_policy_difference_id (String) —

  The OCID of the SDM masking policy difference.

• update_sdm_masking_policy_difference_details (OCI::DataSafe::Models::UpdateSdmMaskingPolicyDifferenceDetails) —

  Details to update a sdm masking policy difference.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :if_match (String) —

  For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

• :opc_request_id (String) —

  Unique identifier for the request.

Returns:

• (Response) —

  A Response object with data of type nil

# File 'lib/oci/data_safe/data_safe_client.rb', line 18777

def update_sdm_masking_policy_difference(sdm_masking_policy_difference_id, update_sdm_masking_policy_difference_details, opts = {})
  logger.debug 'Calling operation DataSafeClient#update_sdm_masking_policy_difference.' if logger

  raise "Missing the required parameter 'sdm_masking_policy_difference_id' when calling update_sdm_masking_policy_difference." if sdm_masking_policy_difference_id.nil?
  raise "Missing the required parameter 'update_sdm_masking_policy_difference_details' when calling update_sdm_masking_policy_difference." if update_sdm_masking_policy_difference_details.nil?
  raise "Parameter value for 'sdm_masking_policy_difference_id' must not be blank" if OCI::Internal::Util.blank_string?(sdm_masking_policy_difference_id)

  path = '/sdmMaskingPolicyDifferences/{sdmMaskingPolicyDifferenceId}'.sub('{sdmMaskingPolicyDifferenceId}', sdm_masking_policy_difference_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(update_sdm_masking_policy_difference_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#update_sdm_masking_policy_difference') do
    @api_client.call_api(
      :PUT,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_security_assessment(security_assessment_id, update_security_assessment_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use update_security_assessment API.

Updates one or more attributes of the specified security assessment. This operation allows to update the security assessment displayName, description, or schedule.

Parameters:

• security_assessment_id (String) —

  The OCID of the security assessment.

• update_security_assessment_details (OCI::DataSafe::Models::UpdateSecurityAssessmentDetails) —

  The information to be updated.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :opc_request_id (String) —

  Unique identifier for the request.

• :if_match (String) —

  For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

Returns:

• (Response) —

  A Response object with data of type nil

# File 'lib/oci/data_safe/data_safe_client.rb', line 18840

def update_security_assessment(security_assessment_id, update_security_assessment_details, opts = {})
  logger.debug 'Calling operation DataSafeClient#update_security_assessment.' if logger

  raise "Missing the required parameter 'security_assessment_id' when calling update_security_assessment." if security_assessment_id.nil?
  raise "Missing the required parameter 'update_security_assessment_details' when calling update_security_assessment." if update_security_assessment_details.nil?
  raise "Parameter value for 'security_assessment_id' must not be blank" if OCI::Internal::Util.blank_string?(security_assessment_id)

  path = '/securityAssessments/{securityAssessmentId}'.sub('{securityAssessmentId}', security_assessment_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(update_security_assessment_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#update_security_assessment') do
    @api_client.call_api(
      :PUT,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_security_policy(security_policy_id, update_security_policy_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use update_security_policy API.

Updates the security policy.

Parameters:

• security_policy_id (String) —

  The OCID of the security policy resource.

• update_security_policy_details (OCI::DataSafe::Models::UpdateSecurityPolicyDetails) —

  Details to update the security policy.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :if_match (String) —

  For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

• :opc_request_id (String) —

  Unique identifier for the request.

Returns:

• (Response) —

  A Response object with data of type nil

# File 'lib/oci/data_safe/data_safe_client.rb', line 18902

def update_security_policy(security_policy_id, update_security_policy_details, opts = {})
  logger.debug 'Calling operation DataSafeClient#update_security_policy.' if logger

  raise "Missing the required parameter 'security_policy_id' when calling update_security_policy." if security_policy_id.nil?
  raise "Missing the required parameter 'update_security_policy_details' when calling update_security_policy." if update_security_policy_details.nil?
  raise "Parameter value for 'security_policy_id' must not be blank" if OCI::Internal::Util.blank_string?(security_policy_id)

  path = '/securityPolicies/{securityPolicyId}'.sub('{securityPolicyId}', security_policy_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(update_security_policy_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#update_security_policy') do
    @api_client.call_api(
      :PUT,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_security_policy_deployment(security_policy_deployment_id, update_security_policy_deployment_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use update_security_policy_deployment API.

Updates the security policy deployment.

Parameters:

• security_policy_deployment_id (String) —

  The OCID of the security policy deployment resource.

• update_security_policy_deployment_details (OCI::DataSafe::Models::UpdateSecurityPolicyDeploymentDetails) —

  Details to update the security policy deployment.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :if_match (String) —

  For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

• :opc_request_id (String) —

  Unique identifier for the request.

Returns:

• (Response) —

  A Response object with data of type nil

# File 'lib/oci/data_safe/data_safe_client.rb', line 18964

def update_security_policy_deployment(security_policy_deployment_id, update_security_policy_deployment_details, opts = {})
  logger.debug 'Calling operation DataSafeClient#update_security_policy_deployment.' if logger

  raise "Missing the required parameter 'security_policy_deployment_id' when calling update_security_policy_deployment." if security_policy_deployment_id.nil?
  raise "Missing the required parameter 'update_security_policy_deployment_details' when calling update_security_policy_deployment." if update_security_policy_deployment_details.nil?
  raise "Parameter value for 'security_policy_deployment_id' must not be blank" if OCI::Internal::Util.blank_string?(security_policy_deployment_id)

  path = '/securityPolicyDeployments/{securityPolicyDeploymentId}'.sub('{securityPolicyDeploymentId}', security_policy_deployment_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(update_security_policy_deployment_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#update_security_policy_deployment') do
    @api_client.call_api(
      :PUT,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_sensitive_column(sensitive_data_model_id, sensitive_column_key, update_sensitive_column_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use update_sensitive_column API.

Updates one or more attributes of the specified sensitive column.

Parameters:

• sensitive_data_model_id (String) —

  The OCID of the sensitive data model.

• sensitive_column_key (String) —

  The unique key that identifies the sensitive column. It's numeric and unique within a sensitive data model.

• update_sensitive_column_details (OCI::DataSafe::Models::UpdateSensitiveColumnDetails) —

  Details to update a sensitive column.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :if_match (String) —

  For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

• :opc_request_id (String) —

  Unique identifier for the request.

Returns:

• (Response) —

  A Response object with data of type nil

# File 'lib/oci/data_safe/data_safe_client.rb', line 19027

def update_sensitive_column(sensitive_data_model_id, sensitive_column_key, update_sensitive_column_details, opts = {})
  logger.debug 'Calling operation DataSafeClient#update_sensitive_column.' if logger

  raise "Missing the required parameter 'sensitive_data_model_id' when calling update_sensitive_column." if sensitive_data_model_id.nil?
  raise "Missing the required parameter 'sensitive_column_key' when calling update_sensitive_column." if sensitive_column_key.nil?
  raise "Missing the required parameter 'update_sensitive_column_details' when calling update_sensitive_column." if update_sensitive_column_details.nil?
  raise "Parameter value for 'sensitive_data_model_id' must not be blank" if OCI::Internal::Util.blank_string?(sensitive_data_model_id)
  raise "Parameter value for 'sensitive_column_key' must not be blank" if OCI::Internal::Util.blank_string?(sensitive_column_key)

  path = '/sensitiveDataModels/{sensitiveDataModelId}/sensitiveColumns/{sensitiveColumnKey}'.sub('{sensitiveDataModelId}', sensitive_data_model_id.to_s).sub('{sensitiveColumnKey}', sensitive_column_key.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(update_sensitive_column_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#update_sensitive_column') do
    @api_client.call_api(
      :PUT,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_sensitive_data_model(sensitive_data_model_id, update_sensitive_data_model_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use update_sensitive_data_model API.

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.

Parameters:

• sensitive_data_model_id (String) —

  The OCID of the sensitive data model.

• update_sensitive_data_model_details (OCI::DataSafe::Models::UpdateSensitiveDataModelDetails) —

  Details to update a sensitive data model.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :if_match (String) —

  For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

• :opc_request_id (String) —

  Unique identifier for the request.

Returns:

• (Response) —

  A Response object with data of type nil

# File 'lib/oci/data_safe/data_safe_client.rb', line 19093

def update_sensitive_data_model(sensitive_data_model_id, update_sensitive_data_model_details, opts = {})
  logger.debug 'Calling operation DataSafeClient#update_sensitive_data_model.' if logger

  raise "Missing the required parameter 'sensitive_data_model_id' when calling update_sensitive_data_model." if sensitive_data_model_id.nil?
  raise "Missing the required parameter 'update_sensitive_data_model_details' when calling update_sensitive_data_model." if update_sensitive_data_model_details.nil?
  raise "Parameter value for 'sensitive_data_model_id' must not be blank" if OCI::Internal::Util.blank_string?(sensitive_data_model_id)

  path = '/sensitiveDataModels/{sensitiveDataModelId}'.sub('{sensitiveDataModelId}', sensitive_data_model_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(update_sensitive_data_model_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#update_sensitive_data_model') do
    @api_client.call_api(
      :PUT,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_sensitive_type(sensitive_type_id, update_sensitive_type_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use update_sensitive_type API.

Updates one or more attributes of the specified sensitive type.

Parameters:

• sensitive_type_id (String) —

  The OCID of the sensitive type.

• update_sensitive_type_details (OCI::DataSafe::Models::UpdateSensitiveTypeDetails) —

  Details to update a sensitive type.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :if_match (String) —

  For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

• :opc_request_id (String) —

  Unique identifier for the request.

Returns:

• (Response) —

  A Response object with data of type nil

# File 'lib/oci/data_safe/data_safe_client.rb', line 19155

def update_sensitive_type(sensitive_type_id, update_sensitive_type_details, opts = {})
  logger.debug 'Calling operation DataSafeClient#update_sensitive_type.' if logger

  raise "Missing the required parameter 'sensitive_type_id' when calling update_sensitive_type." if sensitive_type_id.nil?
  raise "Missing the required parameter 'update_sensitive_type_details' when calling update_sensitive_type." if update_sensitive_type_details.nil?
  raise "Parameter value for 'sensitive_type_id' must not be blank" if OCI::Internal::Util.blank_string?(sensitive_type_id)

  path = '/sensitiveTypes/{sensitiveTypeId}'.sub('{sensitiveTypeId}', sensitive_type_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(update_sensitive_type_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#update_sensitive_type') do
    @api_client.call_api(
      :PUT,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_sql_collection(sql_collection_id, update_sql_collection_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use update_sql_collection API.

Updates the SQL collection.

Parameters:

• sql_collection_id (String) —

  The OCID of the SQL collection resource.

• update_sql_collection_details (OCI::DataSafe::Models::UpdateSqlCollectionDetails) —

  Details to update the SQL collection.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :if_match (String) —

  For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

• :opc_request_id (String) —

  Unique identifier for the request.

Returns:

• (Response) —

  A Response object with data of type nil

# File 'lib/oci/data_safe/data_safe_client.rb', line 19217

def update_sql_collection(sql_collection_id, update_sql_collection_details, opts = {})
  logger.debug 'Calling operation DataSafeClient#update_sql_collection.' if logger

  raise "Missing the required parameter 'sql_collection_id' when calling update_sql_collection." if sql_collection_id.nil?
  raise "Missing the required parameter 'update_sql_collection_details' when calling update_sql_collection." if update_sql_collection_details.nil?
  raise "Parameter value for 'sql_collection_id' must not be blank" if OCI::Internal::Util.blank_string?(sql_collection_id)

  path = '/sqlCollections/{sqlCollectionId}'.sub('{sqlCollectionId}', sql_collection_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(update_sql_collection_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#update_sql_collection') do
    @api_client.call_api(
      :PUT,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_sql_firewall_policy(sql_firewall_policy_id, update_sql_firewall_policy_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use update_sql_firewall_policy API.

Updates the SQL firewall policy.

Parameters:

• sql_firewall_policy_id (String) —

  The OCID of the SQL firewall policy resource.

• update_sql_firewall_policy_details (OCI::DataSafe::Models::UpdateSqlFirewallPolicyDetails) —

  Details to update the SQL firewall policy.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :if_match (String) —

  For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

• :opc_request_id (String) —

  Unique identifier for the request.

Returns:

• (Response) —

  A Response object with data of type nil

# File 'lib/oci/data_safe/data_safe_client.rb', line 19279

def update_sql_firewall_policy(sql_firewall_policy_id, update_sql_firewall_policy_details, opts = {})
  logger.debug 'Calling operation DataSafeClient#update_sql_firewall_policy.' if logger

  raise "Missing the required parameter 'sql_firewall_policy_id' when calling update_sql_firewall_policy." if sql_firewall_policy_id.nil?
  raise "Missing the required parameter 'update_sql_firewall_policy_details' when calling update_sql_firewall_policy." if update_sql_firewall_policy_details.nil?
  raise "Parameter value for 'sql_firewall_policy_id' must not be blank" if OCI::Internal::Util.blank_string?(sql_firewall_policy_id)

  path = '/sqlFirewallPolicies/{sqlFirewallPolicyId}'.sub('{sqlFirewallPolicyId}', sql_firewall_policy_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(update_sql_firewall_policy_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#update_sql_firewall_policy') do
    @api_client.call_api(
      :PUT,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_target_alert_policy_association(target_alert_policy_association_id, update_target_alert_policy_association_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use update_target_alert_policy_association API.

Updates the specified target-alert policy association.

Parameters:

• target_alert_policy_association_id (String) —

  The OCID of the target-alert policy association.

• update_target_alert_policy_association_details (OCI::DataSafe::Models::UpdateTargetAlertPolicyAssociationDetails) —

  The details used to update the target-alert policy association.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :if_match (String) —

  For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

• :opc_request_id (String) —

  Unique identifier for the request.

Returns:

• (Response) —

  A Response object with data of type nil

# File 'lib/oci/data_safe/data_safe_client.rb', line 19341

def update_target_alert_policy_association(target_alert_policy_association_id, update_target_alert_policy_association_details, opts = {})
  logger.debug 'Calling operation DataSafeClient#update_target_alert_policy_association.' if logger

  raise "Missing the required parameter 'target_alert_policy_association_id' when calling update_target_alert_policy_association." if target_alert_policy_association_id.nil?
  raise "Missing the required parameter 'update_target_alert_policy_association_details' when calling update_target_alert_policy_association." if update_target_alert_policy_association_details.nil?
  raise "Parameter value for 'target_alert_policy_association_id' must not be blank" if OCI::Internal::Util.blank_string?(target_alert_policy_association_id)

  path = '/targetAlertPolicyAssociations/{targetAlertPolicyAssociationId}'.sub('{targetAlertPolicyAssociationId}', target_alert_policy_association_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(update_target_alert_policy_association_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#update_target_alert_policy_association') do
    @api_client.call_api(
      :PUT,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_target_database(target_database_id, update_target_database_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use update_target_database API.

Updates one or more attributes of the specified Data Safe target database.

Parameters:

• target_database_id (String) —

  The OCID of the Data Safe target database.

• update_target_database_details (OCI::DataSafe::Models::UpdateTargetDatabaseDetails) —

  Details used to update the target database in Data Safe.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :opc_request_id (String) —

  Unique identifier for the request.

• :if_match (String) —

  For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

• :opc_retry_token (String) —

  A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

Returns:

• (Response) —

  A Response object with data of type nil

# File 'lib/oci/data_safe/data_safe_client.rb', line 19408

def update_target_database(target_database_id, update_target_database_details, opts = {})
  logger.debug 'Calling operation DataSafeClient#update_target_database.' if logger

  raise "Missing the required parameter 'target_database_id' when calling update_target_database." if target_database_id.nil?
  raise "Missing the required parameter 'update_target_database_details' when calling update_target_database." if update_target_database_details.nil?
  raise "Parameter value for 'target_database_id' must not be blank" if OCI::Internal::Util.blank_string?(target_database_id)

  path = '/targetDatabases/{targetDatabaseId}'.sub('{targetDatabaseId}', target_database_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(update_target_database_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#update_target_database') do
    @api_client.call_api(
      :PUT,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_user_assessment(user_assessment_id, update_user_assessment_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use update_user_assessment API.

Updates one or more attributes of the specified user assessment. This operation allows to update the user assessment displayName, description, or schedule.

Parameters:

• user_assessment_id (String) —

  The OCID of the user assessment.

• update_user_assessment_details (OCI::DataSafe::Models::UpdateUserAssessmentDetails) —

  The information to be updated.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :opc_request_id (String) —

  Unique identifier for the request.

• :if_match (String) —

  For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

Returns:

• (Response) —

  A Response object with data of type nil

# File 'lib/oci/data_safe/data_safe_client.rb', line 19473

def update_user_assessment(user_assessment_id, update_user_assessment_details, opts = {})
  logger.debug 'Calling operation DataSafeClient#update_user_assessment.' if logger

  raise "Missing the required parameter 'user_assessment_id' when calling update_user_assessment." if user_assessment_id.nil?
  raise "Missing the required parameter 'update_user_assessment_details' when calling update_user_assessment." if update_user_assessment_details.nil?
  raise "Parameter value for 'user_assessment_id' must not be blank" if OCI::Internal::Util.blank_string?(user_assessment_id)

  path = '/userAssessments/{userAssessmentId}'.sub('{userAssessmentId}', user_assessment_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(update_user_assessment_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#update_user_assessment') do
    @api_client.call_api(
      :PUT,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#upload_masking_policy(upload_masking_policy_details, masking_policy_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use upload_masking_policy API.

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.

Parameters:

• upload_masking_policy_details (String, IO) —

  Details to upload a masking policy file.

• masking_policy_id (String) —

  The OCID of the masking policy.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :if_match (String) —

  For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

• :opc_request_id (String) —

  Unique identifier for the request.

Returns:

• (Response) —

  A Response object with data of type nil

# File 'lib/oci/data_safe/data_safe_client.rb', line 19540

def upload_masking_policy(upload_masking_policy_details, masking_policy_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#upload_masking_policy.' if logger

  raise "Missing the required parameter 'upload_masking_policy_details' when calling upload_masking_policy." if upload_masking_policy_details.nil?
  raise "Missing the required parameter 'masking_policy_id' when calling upload_masking_policy." if masking_policy_id.nil?
  raise "Parameter value for 'masking_policy_id' must not be blank" if OCI::Internal::Util.blank_string?(masking_policy_id)

  path = '/maskingPolicies/{maskingPolicyId}/actions/upload'.sub('{maskingPolicyId}', masking_policy_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf
  header_params[:'content-type'] ||= 'application/octet-stream'

  post_body = @api_client.object_to_http_body(upload_masking_policy_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#upload_masking_policy') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#upload_sensitive_data_model(sensitive_data_model_id, upload_sensitive_data_model_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use upload_sensitive_data_model API.

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.

Parameters:

• sensitive_data_model_id (String) —

  The OCID of the sensitive data model.

• upload_sensitive_data_model_details (String, IO) —

  Details to upload a sensitive data model file.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :if_match (String) —

  For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

• :opc_request_id (String) —

  Unique identifier for the request.

Returns:

• (Response) —

  A Response object with data of type nil

# File 'lib/oci/data_safe/data_safe_client.rb', line 19606

def upload_sensitive_data_model(sensitive_data_model_id, upload_sensitive_data_model_details, opts = {})
  logger.debug 'Calling operation DataSafeClient#upload_sensitive_data_model.' if logger

  raise "Missing the required parameter 'sensitive_data_model_id' when calling upload_sensitive_data_model." if sensitive_data_model_id.nil?
  raise "Missing the required parameter 'upload_sensitive_data_model_details' when calling upload_sensitive_data_model." if upload_sensitive_data_model_details.nil?
  raise "Parameter value for 'sensitive_data_model_id' must not be blank" if OCI::Internal::Util.blank_string?(sensitive_data_model_id)

  path = '/sensitiveDataModels/{sensitiveDataModelId}/actions/upload'.sub('{sensitiveDataModelId}', sensitive_data_model_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf
  header_params[:'content-type'] ||= 'application/octet-stream'

  post_body = @api_client.object_to_http_body(upload_sensitive_data_model_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#upload_sensitive_data_model') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end