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 collapse
-
#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 collapse
-
#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.
55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 |
# 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.
15 16 17 |
# File 'lib/oci/data_safe/data_safe_client.rb', line 15 def api_client @api_client end |
#endpoint ⇒ String (readonly)
Fully qualified endpoint URL
19 20 21 |
# 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.
29 30 31 |
# 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
25 26 27 |
# 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
Click here to see an example of how to use activate_target_database API.
Reactivates a previously deactivated Data Safe target database.
124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 |
# 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.(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
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.
191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 |
# 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.(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
Click here to see an example of how to use alerts_update API.
Updates alerts in the specified compartment.
265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 |
# 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.(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
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.
337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 |
# 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.(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
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.
410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 |
# 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.(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
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.
479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 |
# 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.(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
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.
548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 |
# 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.(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
Click here to see an example of how to use cancel_work_request API.
Cancel the specified work request.
617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 |
# 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.(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
Click here to see an example of how to use change_alert_compartment API.
Moves the specified alert into a different compartment.
685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 |
# 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.(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
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.
755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 |
# 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.(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
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.
824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 |
# 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.(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
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.
893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 |
# 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.(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
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.
957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 |
# 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.(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
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.
1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 |
# 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.(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
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.
1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 |
# 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.(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
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.
1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 |
# 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.(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
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.
1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 |
# 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.(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
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.
1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 |
# 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.(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
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.
1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 |
# 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.(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
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.
1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 |
# 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.(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
Click here to see an example of how to use change_retention API.
Change the online and offline months .
1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 |
# 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.(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
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.
1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 |
# 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.(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
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.
1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 |
# 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.(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
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.
1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 |
# 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.(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
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.
1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 |
# 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.(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
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.
1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 |
# 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.(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
Click here to see an example of how to use change_sensitive_type_compartment API.
Moves the specified sensitive type into a different compartment.
1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 |
# 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.(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
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.
1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 |
# 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.(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
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.
2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 |
# 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.(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
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.
2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 |
# 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.(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
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.
2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 |
# 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.(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
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.
2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 |
# 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.(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
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.
2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 |
# 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.(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
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.
2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 |
# 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.(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
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.
2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 |
# 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.(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
Click here to see an example of how to use create_data_safe_private_endpoint API.
Creates a new Data Safe private endpoint.
2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 |
# 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.(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
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.
2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640 2641 2642 2643 2644 2645 2646 |
# 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.(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
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.
2674 2675 2676 2677 2678 2679 2680 2681 2682 2683 2684 2685 2686 2687 2688 2689 2690 2691 2692 2693 2694 2695 2696 2697 2698 2699 2700 2701 2702 2703 2704 2705 2706 2707 2708 2709 2710 2711 |
# 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.(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
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.
2755 2756 2757 2758 2759 2760 2761 2762 2763 2764 2765 2766 2767 2768 2769 2770 2771 2772 2773 2774 2775 2776 2777 2778 2779 2780 2781 2782 2783 2784 2785 2786 2787 2788 2789 2790 2791 2792 2793 |
# 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.(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
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.
2833 2834 2835 2836 2837 2838 2839 2840 2841 2842 2843 2844 2845 2846 2847 2848 2849 2850 2851 2852 2853 2854 2855 2856 2857 2858 2859 2860 2861 2862 2863 2864 2865 2866 2867 2868 2869 2870 |
# 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.(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
Click here to see an example of how to use create_on_prem_connector API.
Creates a new on-premises connector.
2894 2895 2896 2897 2898 2899 2900 2901 2902 2903 2904 2905 2906 2907 2908 2909 2910 2911 2912 2913 2914 2915 2916 2917 2918 2919 2920 2921 2922 2923 2924 2925 2926 2927 2928 2929 2930 2931 |
# 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.(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
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.
2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 2972 2973 2974 2975 2976 2977 2978 2979 2980 2981 2982 2983 2984 2985 2986 2987 2988 2989 2990 2991 2992 |
# 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.(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
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.
3020 3021 3022 3023 3024 3025 3026 3027 3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 3038 3039 3040 3041 3042 3043 3044 3045 3046 3047 3048 3049 3050 3051 3052 3053 3054 3055 3056 3057 |
# 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.(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
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.
3083 3084 3085 3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 3107 3108 3109 3110 3111 3112 3113 3114 3115 3116 3117 3118 3119 3120 |
# 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.(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
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.
3145 3146 3147 3148 3149 3150 3151 3152 3153 3154 3155 3156 3157 3158 3159 3160 3161 3162 3163 3164 3165 3166 3167 3168 3169 3170 3171 3172 3173 3174 3175 3176 3177 3178 3179 3180 3181 3182 3183 |
# 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.(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
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.
3209 3210 3211 3212 3213 3214 3215 3216 3217 3218 3219 3220 3221 3222 3223 3224 3225 3226 3227 3228 3229 3230 3231 3232 3233 3234 3235 3236 3237 3238 3239 3240 3241 3242 3243 3244 3245 3246 |
# 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.(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
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.
3272 3273 3274 3275 3276 3277 3278 3279 3280 3281 3282 3283 3284 3285 3286 3287 3288 3289 3290 3291 3292 3293 3294 3295 3296 3297 3298 3299 3300 3301 3302 3303 3304 3305 3306 3307 3308 3309 |
# 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.(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
Click here to see an example of how to use create_sql_collection API.
Creates a new SQL collection resource.
3333 3334 3335 3336 3337 3338 3339 3340 3341 3342 3343 3344 3345 3346 3347 3348 3349 3350 3351 3352 3353 3354 3355 3356 3357 3358 3359 3360 3361 3362 3363 3364 3365 3366 3367 3368 3369 3370 |
# 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.(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
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.
3394 3395 3396 3397 3398 3399 3400 3401 3402 3403 3404 3405 3406 3407 3408 3409 3410 3411 3412 3413 3414 3415 3416 3417 3418 3419 3420 3421 3422 3423 3424 3425 3426 3427 3428 3429 3430 3431 |
# 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.(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
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.
3455 3456 3457 3458 3459 3460 3461 3462 3463 3464 3465 3466 3467 3468 3469 3470 3471 3472 3473 3474 3475 3476 3477 3478 3479 3480 3481 3482 3483 3484 3485 3486 3487 3488 3489 3490 3491 3492 |
# 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.(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
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.
3518 3519 3520 3521 3522 3523 3524 3525 3526 3527 3528 3529 3530 3531 3532 3533 3534 3535 3536 3537 3538 3539 3540 3541 3542 3543 3544 3545 3546 3547 3548 3549 3550 3551 3552 3553 3554 3555 |
# 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.(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
Click here to see an example of how to use deactivate_target_database API.
Deactivates a target database in Data Safe.
3585 3586 3587 3588 3589 3590 3591 3592 3593 3594 3595 3596 3597 3598 3599 3600 3601 3602 3603 3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 3614 3615 3616 3617 3618 3619 3620 3621 3622 3623 |
# 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.(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
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.
3649 3650 3651 3652 3653 3654 3655 3656 3657 3658 3659 3660 3661 3662 3663 3664 3665 3666 3667 3668 3669 3670 3671 3672 3673 3674 3675 3676 3677 3678 3679 3680 3681 3682 3683 3684 3685 |
# 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.(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
Click here to see an example of how to use delete_audit_trail API.
Deletes the specified audit trail.
3709 3710 3711 3712 3713 3714 3715 3716 3717 3718 3719 3720 3721 3722 3723 3724 3725 3726 3727 3728 3729 3730 3731 3732 3733 3734 3735 3736 3737 3738 3739 3740 3741 3742 3743 3744 3745 |
# 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.(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
Click here to see an example of how to use delete_data_safe_private_endpoint API.
Deletes the specified Data Safe private endpoint.
3769 3770 3771 3772 3773 3774 3775 3776 3777 3778 3779 3780 3781 3782 3783 3784 3785 3786 3787 3788 3789 3790 3791 3792 3793 3794 3795 3796 3797 3798 3799 3800 3801 3802 3803 3804 3805 |
# 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.(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
Click here to see an example of how to use delete_discovery_job API.
Deletes the specified discovery job.
3829 3830 3831 3832 3833 3834 3835 3836 3837 3838 3839 3840 3841 3842 3843 3844 3845 3846 3847 3848 3849 3850 3851 3852 3853 3854 3855 3856 3857 3858 3859 3860 3861 3862 3863 3864 3865 |
# 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.(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
Click here to see an example of how to use delete_discovery_job_result API.
Deletes the specified discovery result.
3890 3891 3892 3893 3894 3895 3896 3897 3898 3899 3900 3901 3902 3903 3904 3905 3906 3907 3908 3909 3910 3911 3912 3913 3914 3915 3916 3917 3918 3919 3920 3921 3922 3923 3924 3925 3926 3927 3928 |
# 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.(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
Click here to see an example of how to use delete_library_masking_format API.
Deletes the specified library masking format.
3952 3953 3954 3955 3956 3957 3958 3959 3960 3961 3962 3963 3964 3965 3966 3967 3968 3969 3970 3971 3972 3973 3974 3975 3976 3977 3978 3979 3980 3981 3982 3983 3984 3985 3986 3987 3988 |
# 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.(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
Click here to see an example of how to use delete_masking_column API.
Deletes the specified masking column.
4013 4014 4015 4016 4017 4018 4019 4020 4021 4022 4023 4024 4025 4026 4027 4028 4029 4030 4031 4032 4033 4034 4035 4036 4037 4038 4039 4040 4041 4042 4043 4044 4045 4046 4047 4048 4049 4050 4051 |
# 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.(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
Click here to see an example of how to use delete_masking_policy API.
Deletes the specified masking policy.
4075 4076 4077 4078 4079 4080 4081 4082 4083 4084 4085 4086 4087 4088 4089 4090 4091 4092 4093 4094 4095 4096 4097 4098 4099 4100 4101 4102 4103 4104 4105 4106 4107 4108 4109 4110 4111 |
# 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.(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
Click here to see an example of how to use delete_on_prem_connector API.
Deletes the specified on-premises connector.
4135 4136 4137 4138 4139 4140 4141 4142 4143 4144 4145 4146 4147 4148 4149 4150 4151 4152 4153 4154 4155 4156 4157 4158 4159 4160 4161 4162 4163 4164 4165 4166 4167 4168 4169 4170 4171 |
# 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.(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
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.
4195 4196 4197 4198 4199 4200 4201 4202 4203 4204 4205 4206 4207 4208 4209 4210 4211 4212 4213 4214 4215 4216 4217 4218 4219 4220 4221 4222 4223 4224 4225 4226 4227 4228 4229 4230 4231 |
# 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.(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
Click here to see an example of how to use delete_sdm_masking_policy_difference API.
Deletes the specified SDM Masking policy difference.
4255 4256 4257 4258 4259 4260 4261 4262 4263 4264 4265 4266 4267 4268 4269 4270 4271 4272 4273 4274 4275 4276 4277 4278 4279 4280 4281 4282 4283 4284 4285 4286 4287 4288 4289 4290 4291 |
# 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.(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
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.
4319 4320 4321 4322 4323 4324 4325 4326 4327 4328 4329 4330 4331 4332 4333 4334 4335 4336 4337 4338 4339 4340 4341 4342 4343 4344 4345 4346 4347 4348 4349 4350 4351 4352 4353 4354 4355 |
# 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.(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
Click here to see an example of how to use delete_sensitive_column API.
Deletes the specified sensitive column.
4380 4381 4382 4383 4384 4385 4386 4387 4388 4389 4390 4391 4392 4393 4394 4395 4396 4397 4398 4399 4400 4401 4402 4403 4404 4405 4406 4407 4408 4409 4410 4411 4412 4413 4414 4415 4416 4417 4418 |
# 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.(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
Click here to see an example of how to use delete_sensitive_data_model API.
Deletes the specified sensitive data model.
4442 4443 4444 4445 4446 4447 4448 4449 4450 4451 4452 4453 4454 4455 4456 4457 4458 4459 4460 4461 4462 4463 4464 4465 4466 4467 4468 4469 4470 4471 4472 4473 4474 4475 4476 4477 4478 |
# 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.(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
Click here to see an example of how to use delete_sensitive_type API.
Deletes the specified sensitive type.
4502 4503 4504 4505 4506 4507 4508 4509 4510 4511 4512 4513 4514 4515 4516 4517 4518 4519 4520 4521 4522 4523 4524 4525 4526 4527 4528 4529 4530 4531 4532 4533 4534 4535 4536 4537 4538 |
# 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.(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
Click here to see an example of how to use delete_sql_collection API.
Deletes the specified SQL collection.
4562 4563 4564 4565 4566 4567 4568 4569 4570 4571 4572 4573 4574 4575 4576 4577 4578 4579 4580 4581 4582 4583 4584 4585 4586 4587 4588 4589 4590 4591 4592 4593 4594 4595 4596 4597 4598 |
# 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.(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
Click here to see an example of how to use delete_sql_firewall_policy API.
Deletes the SQL firewall policy resource.
4623 4624 4625 4626 4627 4628 4629 4630 4631 4632 4633 4634 4635 4636 4637 4638 4639 4640 4641 4642 4643 4644 4645 4646 4647 4648 4649 4650 4651 4652 4653 4654 4655 4656 4657 4658 4659 |
# 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.(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
Click here to see an example of how to use delete_target_alert_policy_association API.
Deletes the specified target-alert policy Association.
4683 4684 4685 4686 4687 4688 4689 4690 4691 4692 4693 4694 4695 4696 4697 4698 4699 4700 4701 4702 4703 4704 4705 4706 4707 4708 4709 4710 4711 4712 4713 4714 4715 4716 4717 4718 4719 |
# 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.(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
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.
4743 4744 4745 4746 4747 4748 4749 4750 4751 4752 4753 4754 4755 4756 4757 4758 4759 4760 4761 4762 4763 4764 4765 4766 4767 4768 4769 4770 4771 4772 4773 4774 4775 4776 4777 4778 4779 |
# 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.(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
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.
4807 4808 4809 4810 4811 4812 4813 4814 4815 4816 4817 4818 4819 4820 4821 4822 4823 4824 4825 4826 4827 4828 4829 4830 4831 4832 4833 4834 4835 4836 4837 4838 4839 4840 4841 4842 4843 |
# 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.(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
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.
4876 4877 4878 4879 4880 4881 4882 4883 4884 4885 4886 4887 4888 4889 4890 4891 4892 4893 4894 4895 4896 4897 4898 4899 4900 4901 4902 4903 4904 4905 4906 4907 4908 4909 4910 4911 4912 4913 4914 |
# 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.(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
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.
4939 4940 4941 4942 4943 4944 4945 4946 4947 4948 4949 4950 4951 4952 4953 4954 4955 4956 4957 4958 4959 4960 4961 4962 4963 4964 4965 4966 4967 4968 4969 4970 4971 4972 4973 4974 4975 4976 4977 4978 4979 4980 4981 4982 4983 4984 4985 4986 4987 4988 4989 4990 4991 4992 4993 4994 4995 4996 4997 4998 4999 5000 5001 5002 5003 5004 5005 5006 5007 5008 5009 5010 5011 5012 5013 5014 5015 5016 5017 5018 5019 5020 |
# 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.(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
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.
5041 5042 5043 5044 5045 5046 5047 5048 5049 5050 5051 5052 5053 5054 5055 5056 5057 5058 5059 5060 5061 5062 5063 5064 5065 5066 5067 5068 5069 5070 5071 5072 5073 5074 5075 5076 5077 5078 5079 5080 5081 5082 5083 5084 5085 5086 5087 5088 5089 5090 5091 5092 5093 5094 5095 5096 5097 5098 5099 5100 5101 5102 5103 5104 5105 5106 5107 5108 5109 5110 5111 5112 5113 5114 5115 5116 5117 5118 5119 5120 5121 5122 |
# 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.(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
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.
5147 5148 5149 5150 5151 5152 5153 5154 5155 5156 5157 5158 5159 5160 5161 5162 5163 5164 5165 5166 5167 5168 5169 5170 5171 5172 5173 5174 5175 5176 5177 5178 5179 5180 5181 5182 5183 5184 5185 5186 5187 5188 5189 5190 5191 5192 5193 5194 5195 5196 5197 5198 5199 5200 5201 5202 5203 5204 5205 5206 5207 5208 5209 5210 5211 5212 5213 5214 5215 5216 5217 5218 5219 5220 5221 5222 5223 5224 5225 5226 5227 5228 |
# 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.(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
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.
5252 5253 5254 5255 5256 5257 5258 5259 5260 5261 5262 5263 5264 5265 5266 5267 5268 5269 5270 5271 5272 5273 5274 5275 5276 5277 5278 5279 5280 5281 5282 5283 5284 5285 5286 5287 5288 5289 5290 5291 5292 5293 5294 5295 5296 5297 5298 5299 5300 5301 5302 5303 5304 5305 5306 5307 5308 5309 5310 5311 5312 5313 5314 5315 5316 5317 5318 5319 5320 5321 5322 5323 5324 5325 5326 5327 5328 5329 5330 5331 5332 5333 |
# 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.(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
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.
5364 5365 5366 5367 5368 5369 5370 5371 5372 5373 5374 5375 5376 5377 5378 5379 5380 5381 5382 5383 5384 5385 5386 5387 5388 5389 5390 5391 5392 5393 5394 5395 5396 5397 5398 5399 5400 5401 5402 5403 5404 5405 5406 5407 5408 5409 5410 5411 5412 5413 5414 5415 5416 5417 5418 5419 5420 5421 5422 5423 5424 5425 5426 5427 5428 5429 5430 5431 5432 5433 5434 5435 5436 5437 5438 5439 5440 5441 5442 5443 5444 5445 |
# 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.(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
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).
5479 5480 5481 5482 5483 5484 5485 5486 5487 5488 5489 5490 5491 5492 5493 5494 5495 5496 5497 5498 5499 5500 5501 5502 5503 5504 5505 5506 5507 5508 5509 5510 5511 5512 5513 5514 5515 5516 5517 5518 5519 5520 5521 5522 5523 5524 5525 5526 5527 5528 5529 5530 5531 5532 5533 5534 5535 5536 5537 5538 5539 5540 5541 5542 5543 5544 5545 5546 5547 5548 5549 5550 5551 5552 5553 5554 5555 5556 5557 5558 5559 5560 5561 5562 5563 |
# 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.(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
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.
5588 5589 5590 5591 5592 5593 5594 5595 5596 5597 5598 5599 5600 5601 5602 5603 5604 5605 5606 5607 5608 5609 5610 5611 5612 5613 5614 5615 5616 5617 5618 5619 5620 5621 5622 5623 5624 5625 5626 5627 5628 5629 5630 5631 5632 5633 5634 5635 5636 5637 5638 5639 5640 5641 5642 5643 5644 5645 5646 5647 5648 5649 5650 5651 5652 5653 5654 5655 5656 5657 5658 5659 5660 5661 5662 5663 5664 5665 5666 5667 5668 5669 |
# 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.(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
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).
5703 5704 5705 5706 5707 5708 5709 5710 5711 5712 5713 5714 5715 5716 5717 5718 5719 5720 5721 5722 5723 5724 5725 5726 5727 5728 5729 5730 5731 5732 5733 5734 5735 5736 5737 5738 5739 5740 5741 5742 5743 5744 5745 5746 5747 5748 5749 5750 5751 5752 5753 5754 5755 5756 5757 5758 5759 5760 5761 5762 5763 5764 5765 5766 5767 5768 5769 5770 5771 5772 5773 5774 5775 5776 5777 5778 5779 5780 5781 5782 5783 5784 5785 5786 5787 |
# 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.(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
Click here to see an example of how to use enable_data_safe_configuration API.
Enables Data Safe in the tenancy and region.
5813 5814 5815 5816 5817 5818 5819 5820 5821 5822 5823 5824 5825 5826 5827 5828 5829 5830 5831 5832 5833 5834 5835 5836 5837 5838 5839 5840 5841 5842 5843 5844 5845 5846 5847 5848 5849 |
# 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.(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
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.
5872 5873 5874 5875 5876 5877 5878 5879 5880 5881 5882 5883 5884 5885 5886 5887 5888 5889 5890 5891 5892 5893 5894 5895 5896 5897 5898 5899 5900 5901 5902 5903 5904 5905 5906 5907 5908 |
# 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.(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
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.
5932 5933 5934 5935 5936 5937 5938 5939 5940 5941 5942 5943 5944 5945 5946 5947 5948 5949 5950 5951 5952 5953 5954 5955 5956 5957 5958 5959 5960 5961 5962 5963 5964 5965 5966 5967 5968 |
# 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.(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
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.
5991 5992 5993 5994 5995 5996 5997 5998 5999 6000 6001 6002 6003 6004 6005 6006 6007 6008 6009 6010 6011 6012 6013 6014 6015 6016 6017 6018 6019 6020 6021 6022 6023 6024 6025 6026 6027 |
# 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.(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
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.
6060 6061 6062 6063 6064 6065 6066 6067 6068 6069 6070 6071 6072 6073 6074 6075 6076 6077 6078 6079 6080 6081 6082 6083 6084 6085 6086 6087 6088 6089 6090 6091 6092 6093 6094 6095 6096 6097 6098 6099 6100 6101 6102 6103 6104 6105 6106 6107 6108 6109 6110 6111 6112 6113 6114 6115 6116 6117 6118 6119 6120 6121 6122 6123 6124 6125 6126 6127 6128 6129 6130 6131 6132 6133 6134 6135 6136 6137 6138 6139 6140 6141 6142 6143 6144 |
# 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.(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
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.
6182 6183 6184 6185 6186 6187 6188 6189 6190 6191 6192 6193 6194 6195 6196 6197 6198 6199 6200 6201 6202 6203 6204 6205 6206 6207 6208 6209 6210 6211 6212 6213 6214 6215 6216 6217 6218 6219 6220 6221 6222 |
# 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.(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
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.
6254 6255 6256 6257 6258 6259 6260 6261 6262 6263 6264 6265 6266 6267 6268 6269 6270 6271 6272 6273 6274 6275 6276 6277 6278 6279 6280 6281 6282 6283 6284 6285 6286 6287 6288 6289 6290 6291 6292 6293 |
# 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.(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
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.
6316 6317 6318 6319 6320 6321 6322 6323 6324 6325 6326 6327 6328 6329 6330 6331 6332 6333 6334 6335 6336 6337 6338 6339 6340 6341 6342 6343 6344 6345 6346 6347 6348 6349 6350 6351 6352 |
# 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.(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
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.
6381 6382 6383 6384 6385 6386 6387 6388 6389 6390 6391 6392 6393 6394 6395 6396 6397 6398 6399 6400 6401 6402 6403 6404 6405 6406 6407 6408 6409 6410 6411 6412 6413 6414 6415 6416 6417 6418 6419 |
# 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.(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
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.
6451 6452 6453 6454 6455 6456 6457 6458 6459 6460 6461 6462 6463 6464 6465 6466 6467 6468 6469 6470 6471 6472 6473 6474 6475 6476 6477 6478 6479 6480 6481 6482 6483 6484 6485 6486 6487 6488 6489 6490 |
# 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.(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
Click here to see an example of how to use get_alert API.
Gets the details of the specified alerts.
6508 6509 6510 6511 6512 6513 6514 6515 6516 6517 6518 6519 6520 6521 6522 6523 6524 6525 6526 6527 6528 6529 6530 6531 6532 6533 6534 6535 6536 6537 6538 6539 6540 6541 6542 6543 6544 |
# 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.(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
Click here to see an example of how to use get_alert_policy API.
Gets the details of alert policy by its ID.
6562 6563 6564 6565 6566 6567 6568 6569 6570 6571 6572 6573 6574 6575 6576 6577 6578 6579 6580 6581 6582 6583 6584 6585 6586 6587 6588 6589 6590 6591 6592 6593 6594 6595 6596 6597 6598 |
# 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.(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
Click here to see an example of how to use get_audit_archive_retrieval API.
Gets the details of the specified archive retreival.
6622 6623 6624 6625 6626 6627 6628 6629 6630 6631 6632 6633 6634 6635 6636 6637 6638 6639 6640 6641 6642 6643 6644 6645 6646 6647 6648 6649 6650 6651 6652 6653 6654 6655 6656 6657 6658 6659 |
# 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.(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
Click here to see an example of how to use get_audit_policy API.
Gets a audit policy by identifier.
6677 6678 6679 6680 6681 6682 6683 6684 6685 6686 6687 6688 6689 6690 6691 6692 6693 6694 6695 6696 6697 6698 6699 6700 6701 6702 6703 6704 6705 6706 6707 6708 6709 6710 6711 6712 6713 |
# 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.(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
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.
6731 6732 6733 6734 6735 6736 6737 6738 6739 6740 6741 6742 6743 6744 6745 6746 6747 6748 6749 6750 6751 6752 6753 6754 6755 6756 6757 6758 6759 6760 6761 6762 6763 6764 6765 6766 6767 |
# 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.(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
Click here to see an example of how to use get_audit_trail API.
Gets the details of audit trail.
6785 6786 6787 6788 6789 6790 6791 6792 6793 6794 6795 6796 6797 6798 6799 6800 6801 6802 6803 6804 6805 6806 6807 6808 6809 6810 6811 6812 6813 6814 6815 6816 6817 6818 6819 6820 6821 |
# 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.(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
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
6847 6848 6849 6850 6851 6852 6853 6854 6855 6856 6857 6858 6859 6860 6861 6862 6863 6864 6865 6866 6867 6868 6869 6870 6871 6872 6873 6874 6875 6876 6877 6878 6879 6880 6881 6882 6883 |
# 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.(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
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.
6916 6917 6918 6919 6920 6921 6922 6923 6924 6925 6926 6927 6928 6929 6930 6931 6932 6933 6934 6935 6936 6937 6938 6939 6940 6941 6942 6943 6944 6945 6946 6947 6948 6949 6950 6951 6952 6953 6954 6955 6956 6957 6958 6959 6960 |
# 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.(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
Click here to see an example of how to use get_data_safe_configuration API.
Gets the details of the Data Safe configuration.
6978 6979 6980 6981 6982 6983 6984 6985 6986 6987 6988 6989 6990 6991 6992 6993 6994 6995 6996 6997 6998 6999 7000 7001 7002 7003 7004 7005 7006 7007 7008 7009 7010 7011 7012 7013 |
# 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.(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
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.
7031 7032 7033 7034 7035 7036 7037 7038 7039 7040 7041 7042 7043 7044 7045 7046 7047 7048 7049 7050 7051 7052 7053 7054 7055 7056 7057 7058 7059 7060 7061 7062 7063 7064 7065 7066 7067 |
# 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.(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
Click here to see an example of how to use get_database_security_config API.
Gets a database security configuration by identifier.
7085 7086 7087 7088 7089 7090 7091 7092 7093 7094 7095 7096 7097 7098 7099 7100 7101 7102 7103 7104 7105 7106 7107 7108 7109 7110 7111 7112 7113 7114 7115 7116 7117 7118 7119 7120 7121 |
# 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.(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
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.
7140 7141 7142 7143 7144 7145 7146 7147 7148 7149 7150 7151 7152 7153 7154 7155 7156 7157 7158 7159 7160 7161 7162 7163 7164 7165 7166 7167 7168 7169 7170 7171 7172 7173 7174 7175 7176 7177 7178 |
# 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.(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
Click here to see an example of how to use get_discovery_job API.
Gets the details of the specified discovery job.
7196 7197 7198 7199 7200 7201 7202 7203 7204 7205 7206 7207 7208 7209 7210 7211 7212 7213 7214 7215 7216 7217 7218 7219 7220 7221 7222 7223 7224 7225 7226 7227 7228 7229 7230 7231 7232 |
# 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.(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
Click here to see an example of how to use get_discovery_job_result API.
Gets the details of the specified discovery result.
7251 7252 7253 7254 7255 7256 7257 7258 7259 7260 7261 7262 7263 7264 7265 7266 7267 7268 7269 7270 7271 7272 7273 7274 7275 7276 7277 7278 7279 7280 7281 7282 7283 7284 7285 7286 7287 7288 7289 |
# 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.(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
Click here to see an example of how to use get_library_masking_format API.
Gets the details of the specified library masking format.
7307 7308 7309 7310 7311 7312 7313 7314 7315 7316 7317 7318 7319 7320 7321 7322 7323 7324 7325 7326 7327 7328 7329 7330 7331 7332 7333 7334 7335 7336 7337 7338 7339 7340 7341 7342 7343 |
# 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.(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
Click here to see an example of how to use get_masking_column API.
Gets the details of the specified masking column.
7362 7363 7364 7365 7366 7367 7368 7369 7370 7371 7372 7373 7374 7375 7376 7377 7378 7379 7380 7381 7382 7383 7384 7385 7386 7387 7388 7389 7390 7391 7392 7393 7394 7395 7396 7397 7398 7399 7400 |
# 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.(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
Click here to see an example of how to use get_masking_policy API.
Gets the details of the specified masking policy.
7418 7419 7420 7421 7422 7423 7424 7425 7426 7427 7428 7429 7430 7431 7432 7433 7434 7435 7436 7437 7438 7439 7440 7441 7442 7443 7444 7445 7446 7447 7448 7449 7450 7451 7452 7453 7454 |
# 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.(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
Click here to see an example of how to use get_masking_report API.
Gets the details of the specified masking report.
7472 7473 7474 7475 7476 7477 7478 7479 7480 7481 7482 7483 7484 7485 7486 7487 7488 7489 7490 7491 7492 7493 7494 7495 7496 7497 7498 7499 7500 7501 7502 7503 7504 7505 7506 7507 7508 |
# 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.(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
Click here to see an example of how to use get_on_prem_connector API.
Gets the details of the specified on-premises connector.
7526 7527 7528 7529 7530 7531 7532 7533 7534 7535 7536 7537 7538 7539 7540 7541 7542 7543 7544 7545 7546 7547 7548 7549 7550 7551 7552 7553 7554 7555 7556 7557 7558 7559 7560 7561 7562 |
# 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.(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
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.
7585 7586 7587 7588 7589 7590 7591 7592 7593 7594 7595 7596 7597 7598 7599 7600 7601 7602 7603 7604 7605 7606 7607 7608 7609 7610 7611 7612 7613 7614 7615 7616 7617 7618 7619 7620 7621 7622 7623 |
# 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.(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
Click here to see an example of how to use get_report API.
Gets a report by identifier
7641 7642 7643 7644 7645 7646 7647 7648 7649 7650 7651 7652 7653 7654 7655 7656 7657 7658 7659 7660 7661 7662 7663 7664 7665 7666 7667 7668 7669 7670 7671 7672 7673 7674 7675 7676 7677 |
# 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.(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
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.
7697 7698 7699 7700 7701 7702 7703 7704 7705 7706 7707 7708 7709 7710 7711 7712 7713 7714 7715 7716 7717 7718 7719 7720 7721 7722 7723 7724 7725 7726 7727 7728 7729 7730 7731 7732 7733 7734 7735 7736 7737 7738 7739 7740 7741 7742 7743 7744 7745 7746 7747 7748 7749 7750 7751 7752 7753 7754 7755 7756 7757 7758 7759 7760 7761 7762 7763 7764 7765 7766 7767 7768 7769 7770 7771 7772 7773 7774 7775 7776 7777 |
# 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.(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
Click here to see an example of how to use get_report_definition API.
Gets the details of report definition specified by the identifier
7795 7796 7797 7798 7799 7800 7801 7802 7803 7804 7805 7806 7807 7808 7809 7810 7811 7812 7813 7814 7815 7816 7817 7818 7819 7820 7821 7822 7823 7824 7825 7826 7827 7828 7829 7830 7831 |
# 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.(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
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.
7849 7850 7851 7852 7853 7854 7855 7856 7857 7858 7859 7860 7861 7862 7863 7864 7865 7866 7867 7868 7869 7870 7871 7872 7873 7874 7875 7876 7877 7878 7879 7880 7881 7882 7883 7884 7885 |
# 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.(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
Click here to see an example of how to use get_security_assessment API.
Gets the details of the specified security assessment.
7903 7904 7905 7906 7907 7908 7909 7910 7911 7912 7913 7914 7915 7916 7917 7918 7919 7920 7921 7922 7923 7924 7925 7926 7927 7928 7929 7930 7931 7932 7933 7934 7935 7936 7937 7938 7939 |
# 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.(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
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.
7958 7959 7960 7961 7962 7963 7964 7965 7966 7967 7968 7969 7970 7971 7972 7973 7974 7975 7976 7977 7978 7979 7980 7981 7982 7983 7984 7985 7986 7987 7988 7989 7990 7991 7992 7993 7994 7995 7996 |
# 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.(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
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.
8014 8015 8016 8017 8018 8019 8020 8021 8022 8023 8024 8025 8026 8027 8028 8029 8030 8031 8032 8033 8034 8035 8036 8037 8038 8039 8040 8041 8042 8043 8044 8045 8046 8047 8048 8049 8050 |
# 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.(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
Click here to see an example of how to use get_security_policy_deployment API.
Gets a security policy deployment by identifier.
8068 8069 8070 8071 8072 8073 8074 8075 8076 8077 8078 8079 8080 8081 8082 8083 8084 8085 8086 8087 8088 8089 8090 8091 8092 8093 8094 8095 8096 8097 8098 8099 8100 8101 8102 8103 8104 |
# 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.(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
Click here to see an example of how to use get_security_policy_entry_state API.
Gets a security policy entity states by identifier.
8127 8128 8129 8130 8131 8132 8133 8134 8135 8136 8137 8138 8139 8140 8141 8142 8143 8144 8145 8146 8147 8148 8149 8150 8151 8152 8153 8154 8155 8156 8157 8158 8159 8160 8161 8162 8163 8164 8165 |
# 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.(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
Click here to see an example of how to use get_sensitive_column API.
Gets the details of the specified sensitive column.
8184 8185 8186 8187 8188 8189 8190 8191 8192 8193 8194 8195 8196 8197 8198 8199 8200 8201 8202 8203 8204 8205 8206 8207 8208 8209 8210 8211 8212 8213 8214 8215 8216 8217 8218 8219 8220 8221 8222 |
# 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.(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
Click here to see an example of how to use get_sensitive_data_model API.
Gets the details of the specified sensitive data model.
8240 8241 8242 8243 8244 8245 8246 8247 8248 8249 8250 8251 8252 8253 8254 8255 8256 8257 8258 8259 8260 8261 8262 8263 8264 8265 8266 8267 8268 8269 8270 8271 8272 8273 8274 8275 8276 |
# 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.(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
Click here to see an example of how to use get_sensitive_type API.
Gets the details of the specified sensitive type.
8294 8295 8296 8297 8298 8299 8300 8301 8302 8303 8304 8305 8306 8307 8308 8309 8310 8311 8312 8313 8314 8315 8316 8317 8318 8319 8320 8321 8322 8323 8324 8325 8326 8327 8328 8329 8330 |
# 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.(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
Click here to see an example of how to use get_sql_collection API.
Gets a SQL collection by identifier.
8348 8349 8350 8351 8352 8353 8354 8355 8356 8357 8358 8359 8360 8361 8362 8363 8364 8365 8366 8367 8368 8369 8370 8371 8372 8373 8374 8375 8376 8377 8378 8379 8380 8381 8382 8383 8384 |
# 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.(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
Click here to see an example of how to use get_sql_firewall_policy API.
Gets a SQL firewall policy by identifier.
8402 8403 8404 8405 8406 8407 8408 8409 8410 8411 8412 8413 8414 8415 8416 8417 8418 8419 8420 8421 8422 8423 8424 8425 8426 8427 8428 8429 8430 8431 8432 8433 8434 8435 8436 8437 8438 |
# 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.(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
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.
8456 8457 8458 8459 8460 8461 8462 8463 8464 8465 8466 8467 8468 8469 8470 8471 8472 8473 8474 8475 8476 8477 8478 8479 8480 8481 8482 8483 8484 8485 8486 8487 8488 8489 8490 8491 8492 |
# 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.(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
Click here to see an example of how to use get_target_database API.
Returns the details of the specified Data Safe target database.
8511 8512 8513 8514 8515 8516 8517 8518 8519 8520 8521 8522 8523 8524 8525 8526 8527 8528 8529 8530 8531 8532 8533 8534 8535 8536 8537 8538 8539 8540 8541 8542 8543 8544 8545 8546 8547 |
# 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.(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
Click here to see an example of how to use get_user_assessment API.
Gets a user assessment by identifier.
8565 8566 8567 8568 8569 8570 8571 8572 8573 8574 8575 8576 8577 8578 8579 8580 8581 8582 8583 8584 8585 8586 8587 8588 8589 8590 8591 8592 8593 8594 8595 8596 8597 8598 8599 8600 8601 |
# 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.(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
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.
8620 8621 8622 8623 8624 8625 8626 8627 8628 8629 8630 8631 8632 8633 8634 8635 8636 8637 8638 8639 8640 8641 8642 8643 8644 8645 8646 8647 8648 8649 8650 8651 8652 8653 8654 8655 8656 8657 8658 |
# 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.(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
Click here to see an example of how to use get_work_request API.
Gets the details of the specified work request.
8676 8677 8678 8679 8680 8681 8682 8683 8684 8685 8686 8687 8688 8689 8690 8691 8692 8693 8694 8695 8696 8697 8698 8699 8700 8701 8702 8703 8704 8705 8706 8707 8708 8709 8710 8711 8712 |
# 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.(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
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
8795 8796 8797 8798 8799 8800 8801 8802 8803 8804 8805 8806 8807 8808 8809 8810 8811 8812 8813 8814 8815 8816 8817 8818 8819 8820 8821 8822 8823 8824 8825 8826 8827 8828 8829 8830 8831 8832 8833 8834 8835 8836 8837 8838 8839 8840 8841 8842 8843 8844 8845 8846 8847 8848 8849 8850 8851 8852 8853 8854 8855 8856 8857 8858 8859 8860 8861 8862 8863 8864 8865 8866 8867 8868 8869 8870 8871 8872 8873 8874 8875 8876 8877 8878 |
# 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.(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
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
8932 8933 8934 8935 8936 8937 8938 8939 8940 8941 8942 8943 8944 8945 8946 8947 8948 8949 8950 8951 8952 8953 8954 8955 8956 8957 8958 8959 8960 8961 8962 8963 8964 8965 8966 8967 8968 8969 8970 8971 8972 8973 8974 8975 8976 8977 8978 8979 8980 8981 8982 8983 8984 8985 8986 8987 8988 8989 8990 8991 8992 8993 8994 8995 8996 8997 8998 8999 9000 9001 |
# 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.(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
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.
9023 9024 9025 9026 9027 9028 9029 9030 9031 9032 9033 9034 9035 9036 9037 9038 9039 9040 9041 9042 9043 9044 9045 9046 9047 9048 9049 9050 9051 9052 9053 9054 9055 9056 9057 9058 9059 9060 9061 |
# 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.(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
Click here to see an example of how to use list_alerts API.
Gets a list of all alerts.
Allowed values are: displayName, timeCreated
9122 9123 9124 9125 9126 9127 9128 9129 9130 9131 9132 9133 9134 9135 9136 9137 9138 9139 9140 9141 9142 9143 9144 9145 9146 9147 9148 9149 9150 9151 9152 9153 9154 9155 9156 9157 9158 9159 9160 9161 9162 9163 9164 9165 9166 9167 9168 9169 9170 9171 9172 9173 9174 9175 9176 9177 9178 9179 9180 9181 9182 9183 9184 9185 9186 9187 9188 9189 |
# 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.(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
Click here to see an example of how to use list_audit_archive_retrievals API.
Returns the list of audit archive retrieval.
9232 9233 9234 9235 9236 9237 9238 9239 9240 9241 9242 9243 9244 9245 9246 9247 9248 9249 9250 9251 9252 9253 9254 9255 9256 9257 9258 9259 9260 9261 9262 9263 9264 9265 9266 9267 9268 9269 9270 9271 9272 9273 9274 9275 9276 9277 9278 9279 9280 9281 9282 9283 9284 9285 9286 9287 9288 9289 9290 9291 9292 9293 9294 9295 |
# 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.(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
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.
9377 9378 9379 9380 9381 9382 9383 9384 9385 9386 9387 9388 9389 9390 9391 9392 9393 9394 9395 9396 9397 9398 9399 9400 9401 9402 9403 9404 9405 9406 9407 9408 9409 9410 9411 9412 9413 9414 9415 9416 9417 9418 9419 9420 9421 9422 9423 9424 9425 9426 9427 9428 9429 9430 9431 9432 9433 9434 9435 9436 9437 9438 9439 9440 9441 9442 9443 9444 9445 9446 9447 9448 9449 9450 9451 9452 9453 9454 9455 9456 9457 9458 9459 9460 |
# 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.(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
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
9518 9519 9520 9521 9522 9523 9524 9525 9526 9527 9528 9529 9530 9531 9532 9533 9534 9535 9536 9537 9538 9539 9540 9541 9542 9543 9544 9545 9546 9547 9548 9549 9550 9551 9552 9553 9554 9555 9556 9557 9558 9559 9560 9561 9562 9563 9564 9565 9566 9567 9568 9569 9570 9571 9572 9573 |
# 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.(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
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.
9629 9630 9631 9632 9633 9634 9635 9636 9637 9638 9639 9640 9641 9642 9643 9644 9645 9646 9647 9648 9649 9650 9651 9652 9653 9654 9655 9656 9657 9658 9659 9660 9661 9662 9663 9664 9665 9666 9667 9668 9669 9670 9671 9672 9673 9674 9675 9676 9677 9678 9679 9680 9681 9682 9683 9684 9685 9686 9687 9688 9689 9690 9691 |
# 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.(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
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
9745 9746 9747 9748 9749 9750 9751 9752 9753 9754 9755 9756 9757 9758 9759 9760 9761 9762 9763 9764 9765 9766 9767 9768 9769 9770 9771 9772 9773 9774 9775 9776 9777 9778 9779 9780 9781 9782 9783 9784 9785 9786 9787 9788 9789 9790 9791 9792 9793 9794 9795 9796 9797 9798 9799 9800 9801 9802 9803 9804 9805 9806 9807 9808 9809 9810 9811 9812 |
# 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.(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
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.
9856 9857 9858 9859 9860 9861 9862 9863 9864 9865 9866 9867 9868 9869 9870 9871 9872 9873 9874 9875 9876 9877 9878 9879 9880 9881 9882 9883 9884 9885 9886 9887 9888 9889 9890 9891 9892 9893 9894 9895 9896 9897 9898 9899 9900 9901 9902 9903 9904 9905 9906 9907 9908 9909 9910 9911 |
# 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.(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
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.
9974 9975 9976 9977 9978 9979 9980 9981 9982 9983 9984 9985 9986 9987 9988 9989 9990 9991 9992 9993 9994 9995 9996 9997 9998 9999 10000 10001 10002 10003 10004 10005 10006 10007 10008 10009 10010 10011 10012 10013 10014 10015 10016 10017 10018 10019 10020 10021 10022 10023 10024 10025 10026 10027 10028 10029 10030 10031 10032 10033 10034 10035 10036 10037 10038 10039 |
# 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.(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
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.
10084 10085 10086 10087 10088 10089 10090 10091 10092 10093 10094 10095 10096 10097 10098 10099 10100 10101 10102 10103 10104 10105 10106 10107 10108 10109 10110 10111 10112 10113 10114 10115 10116 10117 10118 10119 10120 10121 10122 10123 10124 10125 10126 10127 10128 10129 10130 10131 10132 10133 10134 10135 10136 10137 10138 10139 10140 |
# 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.(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
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.
10196 10197 10198 10199 10200 10201 10202 10203 10204 10205 10206 10207 10208 10209 10210 10211 10212 10213 10214 10215 10216 10217 10218 10219 10220 10221 10222 10223 10224 10225 10226 10227 10228 10229 10230 10231 10232 10233 10234 10235 10236 10237 10238 10239 10240 10241 10242 10243 10244 10245 10246 10247 10248 10249 10250 10251 10252 10253 10254 10255 10256 10257 10258 10259 10260 10261 10262 10263 |
# 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.(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
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
10304 10305 10306 10307 10308 10309 10310 10311 10312 10313 10314 10315 10316 10317 10318 10319 10320 10321 10322 10323 10324 10325 10326 10327 10328 10329 10330 10331 10332 10333 10334 10335 10336 10337 10338 10339 10340 10341 10342 10343 10344 10345 10346 10347 10348 10349 10350 10351 10352 10353 10354 10355 10356 10357 |
# 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.(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
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
10397 10398 10399 10400 10401 10402 10403 10404 10405 10406 10407 10408 10409 10410 10411 10412 10413 10414 10415 10416 10417 10418 10419 10420 10421 10422 10423 10424 10425 10426 10427 10428 10429 10430 10431 10432 10433 10434 10435 10436 10437 10438 10439 10440 10441 10442 10443 10444 10445 10446 10447 10448 10449 |
# 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.(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
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
10482 10483 10484 10485 10486 10487 10488 10489 10490 10491 10492 10493 10494 10495 10496 10497 10498 10499 10500 10501 10502 10503 10504 10505 10506 10507 10508 10509 10510 10511 10512 10513 10514 10515 10516 10517 10518 10519 10520 10521 10522 10523 10524 10525 10526 10527 10528 10529 10530 10531 10532 10533 10534 10535 10536 10537 |
# 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.(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
Click here to see an example of how to use list_data_safe_private_endpoints API.
Gets a list of Data Safe private endpoints.
10578 10579 10580 10581 10582 10583 10584 10585 10586 10587 10588 10589 10590 10591 10592 10593 10594 10595 10596 10597 10598 10599 10600 10601 10602 10603 10604 10605 10606 10607 10608 10609 10610 10611 10612 10613 10614 10615 10616 10617 10618 10619 10620 10621 10622 10623 10624 10625 10626 10627 10628 10629 10630 10631 10632 10633 10634 10635 10636 10637 10638 10639 |
# 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.(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
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.
10707 10708 10709 10710 10711 10712 10713 10714 10715 10716 10717 10718 10719 10720 10721 10722 10723 10724 10725 10726 10727 10728 10729 10730 10731 10732 10733 10734 10735 10736 10737 10738 10739 10740 10741 10742 10743 10744 10745 10746 10747 10748 10749 10750 10751 10752 10753 10754 10755 10756 10757 10758 10759 10760 10761 10762 10763 10764 10765 10766 10767 10768 10769 10770 10771 |
# 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.(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
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.
10803 10804 10805 10806 10807 10808 10809 10810 10811 10812 10813 10814 10815 10816 10817 10818 10819 10820 10821 10822 10823 10824 10825 10826 10827 10828 10829 10830 10831 10832 10833 10834 10835 10836 10837 10838 10839 10840 10841 10842 10843 10844 10845 10846 10847 10848 10849 10850 10851 10852 10853 10854 10855 10856 10857 10858 10859 10860 10861 10862 10863 10864 10865 10866 10867 10868 10869 |
# 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.(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
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.
10899 10900 10901 10902 10903 10904 10905 10906 10907 10908 10909 10910 10911 10912 10913 10914 10915 10916 10917 10918 10919 10920 10921 10922 10923 10924 10925 10926 10927 10928 10929 10930 10931 10932 10933 10934 10935 10936 10937 10938 10939 10940 10941 10942 10943 10944 10945 |
# 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.(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
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.
10977 10978 10979 10980 10981 10982 10983 10984 10985 10986 10987 10988 10989 10990 10991 10992 10993 10994 10995 10996 10997 10998 10999 11000 11001 11002 11003 11004 11005 11006 11007 11008 11009 11010 11011 11012 11013 11014 11015 11016 11017 11018 11019 11020 11021 11022 11023 11024 11025 11026 11027 11028 11029 11030 11031 11032 11033 11034 11035 11036 11037 11038 11039 |
# 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.(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
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.
11080 11081 11082 11083 11084 11085 11086 11087 11088 11089 11090 11091 11092 11093 11094 11095 11096 11097 11098 11099 11100 11101 11102 11103 11104 11105 11106 11107 11108 11109 11110 11111 11112 11113 11114 11115 11116 11117 11118 11119 11120 11121 11122 11123 11124 11125 11126 11127 11128 11129 11130 11131 11132 11133 11134 11135 11136 11137 11138 11139 11140 11141 11142 11143 |
# 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.(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
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.
11179 11180 11181 11182 11183 11184 11185 11186 11187 11188 11189 11190 11191 11192 11193 11194 11195 11196 11197 11198 11199 11200 11201 11202 11203 11204 11205 11206 11207 11208 11209 11210 11211 11212 11213 11214 11215 11216 11217 11218 11219 11220 11221 11222 11223 11224 11225 11226 11227 11228 11229 11230 11231 11232 11233 11234 |
# 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.(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
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
11271 11272 11273 11274 11275 11276 11277 11278 11279 11280 11281 11282 11283 11284 11285 11286 11287 11288 11289 11290 11291 11292 11293 11294 11295 11296 11297 11298 11299 11300 11301 11302 11303 11304 11305 11306 11307 11308 11309 11310 11311 11312 11313 11314 11315 11316 11317 11318 11319 11320 11321 11322 11323 11324 11325 11326 11327 11328 |
# 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.(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
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.
11382 11383 11384 11385 11386 11387 11388 11389 11390 11391 11392 11393 11394 11395 11396 11397 11398 11399 11400 11401 11402 11403 11404 11405 11406 11407 11408 11409 11410 11411 11412 11413 11414 11415 11416 11417 11418 11419 11420 11421 11422 11423 11424 11425 11426 11427 11428 11429 11430 11431 11432 11433 11434 11435 11436 11437 11438 11439 11440 11441 11442 11443 11444 11445 11446 11447 11448 11449 11450 |
# 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.(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
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
11483 11484 11485 11486 11487 11488 11489 11490 11491 11492 11493 11494 11495 11496 11497 11498 11499 11500 11501 11502 11503 11504 11505 11506 11507 11508 11509 11510 11511 11512 11513 11514 11515 11516 11517 11518 11519 11520 11521 11522 11523 11524 11525 11526 11527 11528 11529 11530 11531 11532 11533 11534 11535 11536 11537 11538 11539 11540 11541 11542 11543 11544 11545 11546 11547 |
# 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.(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
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.
11577 11578 11579 11580 11581 11582 11583 11584 11585 11586 11587 11588 11589 11590 11591 11592 11593 11594 11595 11596 11597 11598 11599 11600 11601 11602 11603 11604 11605 11606 11607 11608 11609 11610 11611 11612 11613 11614 11615 11616 11617 11618 11619 11620 11621 11622 11623 |
# 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.(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
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.
11693 11694 11695 11696 11697 11698 11699 11700 11701 11702 11703 11704 11705 11706 11707 11708 11709 11710 11711 11712 11713 11714 11715 11716 11717 11718 11719 11720 11721 11722 11723 11724 11725 11726 11727 11728 11729 11730 11731 11732 11733 11734 11735 11736 11737 11738 11739 11740 11741 11742 11743 11744 11745 11746 11747 11748 11749 11750 11751 11752 11753 11754 11755 11756 11757 11758 11759 11760 11761 11762 11763 11764 11765 11766 11767 11768 11769 11770 11771 11772 11773 11774 11775 11776 11777 11778 11779 |
# 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.(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
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.
11810 11811 11812 11813 11814 11815 11816 11817 11818 11819 11820 11821 11822 11823 11824 11825 11826 11827 11828 11829 11830 11831 11832 11833 11834 11835 11836 11837 11838 11839 11840 11841 11842 11843 11844 11845 11846 11847 11848 11849 11850 11851 11852 11853 11854 11855 11856 11857 11858 11859 11860 11861 11862 11863 11864 11865 11866 11867 11868 11869 11870 11871 |
# 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.(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
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.
11925 11926 11927 11928 11929 11930 11931 11932 11933 11934 11935 11936 11937 11938 11939 11940 11941 11942 11943 11944 11945 11946 11947 11948 11949 11950 11951 11952 11953 11954 11955 11956 11957 11958 11959 11960 11961 11962 11963 11964 11965 11966 11967 11968 11969 11970 11971 11972 11973 11974 11975 11976 11977 11978 11979 11980 11981 11982 11983 11984 11985 11986 11987 11988 11989 11990 |
# 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.(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
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
12026 12027 12028 12029 12030 12031 12032 12033 12034 12035 12036 12037 12038 12039 12040 12041 12042 12043 12044 12045 12046 12047 12048 12049 12050 12051 12052 12053 12054 12055 12056 12057 12058 12059 12060 12061 12062 12063 12064 12065 12066 12067 12068 12069 12070 12071 12072 12073 12074 12075 12076 12077 12078 12079 12080 12081 12082 |
# 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.(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
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.
12110 12111 12112 12113 12114 12115 12116 12117 12118 12119 12120 12121 12122 12123 12124 12125 12126 12127 12128 12129 12130 12131 12132 12133 12134 12135 12136 12137 12138 12139 12140 12141 12142 12143 12144 12145 12146 12147 12148 12149 12150 12151 12152 12153 12154 12155 12156 12157 12158 12159 |
# 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.(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
Click here to see an example of how to use list_on_prem_connectors API.
Gets a list of on-premises connectors.
12200 12201 12202 12203 12204 12205 12206 12207 12208 12209 12210 12211 12212 12213 12214 12215 12216 12217 12218 12219 12220 12221 12222 12223 12224 12225 12226 12227 12228 12229 12230 12231 12232 12233 12234 12235 12236 12237 12238 12239 12240 12241 12242 12243 12244 12245 12246 12247 12248 12249 12250 12251 12252 12253 12254 12255 12256 12257 12258 12259 12260 12261 |
# 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.(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
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.
12315 12316 12317 12318 12319 12320 12321 12322 12323 12324 12325 12326 12327 12328 12329 12330 12331 12332 12333 12334 12335 12336 12337 12338 12339 12340 12341 12342 12343 12344 12345 12346 12347 12348 12349 12350 12351 12352 12353 12354 12355 12356 12357 12358 12359 12360 12361 12362 12363 12364 12365 12366 12367 12368 12369 12370 12371 12372 12373 |
# 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.(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
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
12455 12456 12457 12458 12459 12460 12461 12462 12463 12464 12465 12466 12467 12468 12469 12470 12471 12472 12473 12474 12475 12476 12477 12478 12479 12480 12481 12482 12483 12484 12485 12486 12487 12488 12489 12490 12491 12492 12493 12494 12495 12496 12497 12498 12499 12500 12501 12502 12503 12504 12505 12506 12507 12508 12509 12510 12511 12512 12513 12514 12515 12516 12517 12518 12519 12520 12521 12522 12523 12524 12525 |
# 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.(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
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.
12570 12571 12572 12573 12574 12575 12576 12577 12578 12579 12580 12581 12582 12583 12584 12585 12586 12587 12588 12589 12590 12591 12592 12593 12594 12595 12596 12597 12598 12599 12600 12601 12602 12603 12604 12605 12606 12607 12608 12609 12610 12611 12612 12613 12614 12615 12616 12617 12618 12619 12620 12621 12622 12623 12624 12625 12626 12627 12628 12629 12630 12631 12632 12633 12634 12635 12636 12637 12638 12639 12640 12641 |
# 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.(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
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
12679 12680 12681 12682 12683 12684 12685 12686 12687 12688 12689 12690 12691 12692 12693 12694 12695 12696 12697 12698 12699 12700 12701 12702 12703 12704 12705 12706 12707 12708 12709 12710 12711 12712 12713 12714 12715 12716 12717 12718 12719 12720 12721 12722 12723 12724 12725 12726 12727 12728 12729 12730 12731 12732 12733 12734 12735 12736 12737 12738 12739 12740 12741 12742 12743 12744 12745 |
# 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.(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
Click here to see an example of how to use list_roles API.
Returns a list of role metadata objects.
Allowed values are: ROLENAME
12775 12776 12777 12778 12779 12780 12781 12782 12783 12784 12785 12786 12787 12788 12789 12790 12791 12792 12793 12794 12795 12796 12797 12798 12799 12800 12801 12802 12803 12804 12805 12806 12807 12808 12809 12810 12811 12812 12813 12814 12815 12816 12817 12818 12819 12820 12821 12822 12823 12824 12825 12826 12827 |
# 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.(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
Click here to see an example of how to use list_schemas API.
Returns list of schema.
Allowed values are: SCHEMANAME
12856 12857 12858 12859 12860 12861 12862 12863 12864 12865 12866 12867 12868 12869 12870 12871 12872 12873 12874 12875 12876 12877 12878 12879 12880 12881 12882 12883 12884 12885 12886 12887 12888 12889 12890 12891 12892 12893 12894 12895 12896 12897 12898 12899 12900 12901 12902 12903 12904 12905 12906 12907 |
# 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.(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
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.
12947 12948 12949 12950 12951 12952 12953 12954 12955 12956 12957 12958 12959 12960 12961 12962 12963 12964 12965 12966 12967 12968 12969 12970 12971 12972 12973 12974 12975 12976 12977 12978 12979 12980 12981 12982 12983 12984 12985 12986 12987 12988 12989 12990 12991 12992 12993 12994 12995 12996 12997 12998 12999 13000 13001 13002 13003 13004 13005 13006 13007 13008 13009 |
# 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.(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
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
13083 13084 13085 13086 13087 13088 13089 13090 13091 13092 13093 13094 13095 13096 13097 13098 13099 13100 13101 13102 13103 13104 13105 13106 13107 13108 13109 13110 13111 13112 13113 13114 13115 13116 13117 13118 13119 13120 13121 13122 13123 13124 13125 13126 13127 13128 13129 13130 13131 13132 13133 13134 13135 13136 13137 13138 13139 13140 13141 13142 13143 13144 13145 13146 13147 13148 13149 13150 13151 13152 13153 13154 13155 13156 13157 13158 13159 |
# 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.(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
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.
13213 13214 13215 13216 13217 13218 13219 13220 13221 13222 13223 13224 13225 13226 13227 13228 13229 13230 13231 13232 13233 13234 13235 13236 13237 13238 13239 13240 13241 13242 13243 13244 13245 13246 13247 13248 13249 13250 13251 13252 13253 13254 13255 13256 13257 13258 13259 13260 13261 13262 13263 13264 13265 13266 13267 13268 13269 13270 13271 13272 13273 13274 |
# 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.(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
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.
13330 13331 13332 13333 13334 13335 13336 13337 13338 13339 13340 13341 13342 13343 13344 13345 13346 13347 13348 13349 13350 13351 13352 13353 13354 13355 13356 13357 13358 13359 13360 13361 13362 13363 13364 13365 13366 13367 13368 13369 13370 13371 13372 13373 13374 13375 13376 13377 13378 13379 13380 13381 13382 13383 13384 13385 13386 13387 13388 13389 13390 13391 13392 13393 |
# 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.(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
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.
13418 13419 13420 13421 13422 13423 13424 13425 13426 13427 13428 13429 13430 13431 13432 13433 13434 13435 13436 13437 13438 13439 13440 13441 13442 13443 13444 13445 13446 13447 13448 13449 13450 13451 13452 13453 13454 13455 13456 13457 13458 13459 13460 13461 13462 |
# 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.(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
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.
13536 13537 13538 13539 13540 13541 13542 13543 13544 13545 13546 13547 13548 13549 13550 13551 13552 13553 13554 13555 13556 13557 13558 13559 13560 13561 13562 13563 13564 13565 13566 13567 13568 13569 13570 13571 13572 13573 13574 13575 13576 13577 13578 13579 13580 13581 13582 13583 13584 13585 13586 13587 13588 13589 13590 13591 13592 13593 13594 13595 13596 13597 13598 13599 13600 13601 13602 13603 13604 13605 13606 13607 13608 13609 13610 13611 13612 13613 13614 13615 13616 13617 13618 13619 13620 13621 13622 13623 13624 13625 13626 13627 13628 13629 13630 13631 13632 13633 13634 |
# 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.(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
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.
13688 13689 13690 13691 13692 13693 13694 13695 13696 13697 13698 13699 13700 13701 13702 13703 13704 13705 13706 13707 13708 13709 13710 13711 13712 13713 13714 13715 13716 13717 13718 13719 13720 13721 13722 13723 13724 13725 13726 13727 13728 13729 13730 13731 13732 13733 13734 13735 13736 13737 13738 13739 13740 13741 13742 13743 13744 13745 13746 13747 13748 13749 13750 13751 13752 |
# 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.(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
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.
13783 13784 13785 13786 13787 13788 13789 13790 13791 13792 13793 13794 13795 13796 13797 13798 13799 13800 13801 13802 13803 13804 13805 13806 13807 13808 13809 13810 13811 13812 13813 13814 13815 13816 13817 13818 13819 13820 13821 13822 13823 13824 13825 13826 13827 13828 13829 13830 13831 13832 13833 13834 13835 13836 13837 13838 13839 13840 13841 13842 13843 13844 |
# 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.(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
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.
13872 13873 13874 13875 13876 13877 13878 13879 13880 13881 13882 13883 13884 13885 13886 13887 13888 13889 13890 13891 13892 13893 13894 13895 13896 13897 13898 13899 13900 13901 13902 13903 13904 13905 13906 13907 13908 13909 13910 13911 13912 13913 13914 13915 13916 13917 13918 13919 13920 13921 |
# 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.(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
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.
13978 13979 13980 13981 13982 13983 13984 13985 13986 13987 13988 13989 13990 13991 13992 13993 13994 13995 13996 13997 13998 13999 14000 14001 14002 14003 14004 14005 14006 14007 14008 14009 14010 14011 14012 14013 14014 14015 14016 14017 14018 14019 14020 14021 14022 14023 14024 14025 14026 14027 14028 14029 14030 14031 14032 14033 14034 14035 14036 14037 14038 14039 14040 14041 14042 14043 14044 14045 14046 14047 14048 14049 14050 14051 14052 14053 |
# 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.(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
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.
14106 14107 14108 14109 14110 14111 14112 14113 14114 14115 14116 14117 14118 14119 14120 14121 14122 14123 14124 14125 14126 14127 14128 14129 14130 14131 14132 14133 14134 14135 14136 14137 14138 14139 14140 14141 14142 14143 14144 14145 14146 14147 14148 14149 14150 14151 14152 14153 14154 14155 14156 14157 14158 14159 14160 14161 14162 14163 14164 14165 14166 14167 14168 14169 |
# 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.(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
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.
14198 14199 14200 14201 14202 14203 14204 14205 14206 14207 14208 14209 14210 14211 14212 14213 14214 14215 14216 14217 14218 14219 14220 14221 14222 14223 14224 14225 14226 14227 14228 14229 14230 14231 14232 14233 14234 14235 14236 14237 14238 14239 14240 14241 14242 14243 14244 14245 |
# 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.(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
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.
14313 14314 14315 14316 14317 14318 14319 14320 14321 14322 14323 14324 14325 14326 14327 14328 14329 14330 14331 14332 14333 14334 14335 14336 14337 14338 14339 14340 14341 14342 14343 14344 14345 14346 14347 14348 14349 14350 14351 14352 14353 14354 14355 14356 14357 14358 14359 14360 14361 14362 14363 14364 14365 14366 14367 14368 14369 14370 14371 14372 14373 14374 14375 14376 14377 14378 |
# 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.(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
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.
14431 14432 14433 14434 14435 14436 14437 14438 14439 14440 14441 14442 14443 14444 14445 14446 14447 14448 14449 14450 14451 14452 14453 14454 14455 14456 14457 14458 14459 14460 14461 14462 14463 14464 14465 14466 14467 14468 14469 14470 14471 14472 14473 14474 14475 14476 14477 14478 14479 14480 14481 14482 14483 14484 14485 14486 14487 |
# 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.(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
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
14543 14544 14545 14546 14547 14548 14549 14550 14551 14552 14553 14554 14555 14556 14557 14558 14559 14560 14561 14562 14563 14564 14565 14566 14567 14568 14569 14570 14571 14572 14573 14574 14575 14576 14577 14578 14579 14580 14581 14582 14583 14584 14585 14586 14587 14588 14589 14590 14591 14592 14593 14594 14595 14596 14597 14598 |
# 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.(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
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.
14669 14670 14671 14672 14673 14674 14675 14676 14677 14678 14679 14680 14681 14682 14683 14684 14685 14686 14687 14688 14689 14690 14691 14692 14693 14694 14695 14696 14697 14698 14699 14700 14701 14702 14703 14704 14705 14706 14707 14708 14709 14710 14711 14712 14713 14714 14715 14716 14717 14718 14719 14720 14721 14722 14723 14724 14725 14726 14727 14728 14729 14730 14731 14732 14733 14734 14735 14736 14737 14738 14739 |
# 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.(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
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.
14790 14791 14792 14793 14794 14795 14796 14797 14798 14799 14800 14801 14802 14803 14804 14805 14806 14807 14808 14809 14810 14811 14812 14813 14814 14815 14816 14817 14818 14819 14820 14821 14822 14823 14824 14825 14826 14827 14828 14829 14830 14831 14832 14833 14834 14835 14836 14837 14838 14839 14840 14841 14842 14843 14844 14845 14846 14847 14848 14849 14850 14851 14852 14853 |
# 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.(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
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
14915 14916 14917 14918 14919 14920 14921 14922 14923 14924 14925 14926 14927 14928 14929 14930 14931 14932 14933 14934 14935 14936 14937 14938 14939 14940 14941 14942 14943 14944 14945 14946 14947 14948 14949 14950 14951 14952 14953 14954 14955 14956 14957 14958 14959 14960 14961 14962 14963 14964 14965 14966 14967 14968 14969 14970 14971 14972 14973 14974 14975 14976 14977 14978 14979 14980 14981 14982 14983 14984 14985 14986 14987 14988 14989 14990 14991 14992 14993 14994 14995 14996 14997 |
# 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.(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
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
15040 15041 15042 15043 15044 15045 15046 15047 15048 15049 15050 15051 15052 15053 15054 15055 15056 15057 15058 15059 15060 15061 15062 15063 15064 15065 15066 15067 15068 15069 15070 15071 15072 15073 15074 15075 15076 15077 15078 15079 15080 15081 15082 15083 15084 15085 15086 15087 15088 15089 15090 15091 15092 15093 15094 15095 |
# 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.(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
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
15125 15126 15127 15128 15129 15130 15131 15132 15133 15134 15135 15136 15137 15138 15139 15140 15141 15142 15143 15144 15145 15146 15147 15148 15149 15150 15151 15152 15153 15154 15155 15156 15157 15158 15159 15160 15161 15162 15163 15164 15165 15166 15167 15168 15169 15170 15171 15172 15173 15174 15175 15176 15177 |
# 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.(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
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
15229 15230 15231 15232 15233 15234 15235 15236 15237 15238 15239 15240 15241 15242 15243 15244 15245 15246 15247 15248 15249 15250 15251 15252 15253 15254 15255 15256 15257 15258 15259 15260 15261 15262 15263 15264 15265 15266 15267 15268 15269 15270 15271 15272 15273 15274 15275 15276 15277 15278 15279 15280 15281 15282 15283 15284 15285 15286 15287 15288 15289 15290 15291 15292 15293 |
# 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.(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
Click here to see an example of how to use list_target_databases API.
Returns the list of registered target databases in Data Safe.
15337 15338 15339 15340 15341 15342 15343 15344 15345 15346 15347 15348 15349 15350 15351 15352 15353 15354 15355 15356 15357 15358 15359 15360 15361 15362 15363 15364 15365 15366 15367 15368 15369 15370 15371 15372 15373 15374 15375 15376 15377 15378 15379 15380 15381 15382 15383 15384 15385 15386 15387 15388 15389 15390 15391 15392 15393 15394 15395 15396 15397 15398 15399 15400 15401 15402 15403 15404 15405 15406 15407 15408 15409 |
# 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.(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
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
15485 15486 15487 15488 15489 15490 15491 15492 15493 15494 15495 15496 15497 15498 15499 15500 15501 15502 15503 15504 15505 15506 15507 15508 15509 15510 15511 15512 15513 15514 15515 15516 15517 15518 15519 15520 15521 15522 15523 15524 15525 15526 15527 15528 15529 15530 15531 15532 15533 15534 15535 15536 15537 15538 15539 15540 15541 15542 15543 15544 15545 15546 15547 15548 15549 15550 15551 |
# 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.(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
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
15625 15626 15627 15628 15629 15630 15631 15632 15633 15634 15635 15636 15637 15638 15639 15640 15641 15642 15643 15644 15645 15646 15647 15648 15649 15650 15651 15652 15653 15654 15655 15656 15657 15658 15659 15660 15661 15662 15663 15664 15665 15666 15667 15668 15669 15670 15671 15672 15673 15674 15675 15676 15677 15678 15679 15680 15681 15682 15683 15684 15685 15686 15687 15688 15689 15690 15691 15692 15693 15694 15695 15696 15697 15698 15699 15700 15701 |
# 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.(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
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
15776 15777 15778 15779 15780 15781 15782 15783 15784 15785 15786 15787 15788 15789 15790 15791 15792 15793 15794 15795 15796 15797 15798 15799 15800 15801 15802 15803 15804 15805 15806 15807 15808 15809 15810 15811 15812 15813 15814 15815 15816 15817 15818 15819 15820 15821 15822 15823 15824 15825 15826 15827 15828 15829 15830 15831 15832 15833 15834 15835 15836 15837 15838 15839 15840 15841 15842 15843 15844 15845 |
# 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.(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
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.
15866 15867 15868 15869 15870 15871 15872 15873 15874 15875 15876 15877 15878 15879 15880 15881 15882 15883 15884 15885 15886 15887 15888 15889 15890 15891 15892 15893 15894 15895 15896 15897 15898 15899 15900 15901 15902 15903 15904 |
# 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.(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
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.
15925 15926 15927 15928 15929 15930 15931 15932 15933 15934 15935 15936 15937 15938 15939 15940 15941 15942 15943 15944 15945 15946 15947 15948 15949 15950 15951 15952 15953 15954 15955 15956 15957 15958 15959 15960 15961 15962 15963 |
# 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.(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
Click here to see an example of how to use list_work_requests API.
Gets a list of work requests.
16002 16003 16004 16005 16006 16007 16008 16009 16010 16011 16012 16013 16014 16015 16016 16017 16018 16019 16020 16021 16022 16023 16024 16025 16026 16027 16028 16029 16030 16031 16032 16033 16034 16035 16036 16037 16038 16039 16040 16041 16042 16043 16044 16045 16046 16047 16048 16049 16050 16051 16052 16053 16054 16055 16056 16057 16058 16059 |
# 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.(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.
94 95 96 |
# 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
Click here to see an example of how to use mask_data API.
Masks data using the specified masking policy.
16078 16079 16080 16081 16082 16083 16084 16085 16086 16087 16088 16089 16090 16091 16092 16093 16094 16095 16096 16097 16098 16099 16100 16101 16102 16103 16104 16105 16106 16107 16108 16109 16110 16111 16112 16113 16114 |
# 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.(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
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.
16145 16146 16147 16148 16149 16150 16151 16152 16153 16154 16155 16156 16157 16158 16159 16160 16161 16162 16163 16164 16165 16166 16167 16168 16169 16170 16171 16172 16173 16174 16175 16176 16177 16178 16179 16180 16181 16182 16183 16184 |
# 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.(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
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.
16217 16218 16219 16220 16221 16222 16223 16224 16225 16226 16227 16228 16229 16230 16231 16232 16233 16234 16235 16236 16237 16238 16239 16240 16241 16242 16243 16244 16245 16246 16247 16248 16249 16250 16251 16252 16253 16254 16255 16256 16257 16258 |
# 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.(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
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.
16285 16286 16287 16288 16289 16290 16291 16292 16293 16294 16295 16296 16297 16298 16299 16300 16301 16302 16303 16304 16305 16306 16307 16308 16309 16310 16311 16312 16313 16314 16315 16316 16317 16318 16319 16320 16321 16322 |
# 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.(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
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.
16350 16351 16352 16353 16354 16355 16356 16357 16358 16359 16360 16361 16362 16363 16364 16365 16366 16367 16368 16369 16370 16371 16372 16373 16374 16375 16376 16377 16378 16379 16380 16381 16382 16383 16384 16385 16386 16387 |
# 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.(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
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.
16414 16415 16416 16417 16418 16419 16420 16421 16422 16423 16424 16425 16426 16427 16428 16429 16430 16431 16432 16433 16434 16435 16436 16437 16438 16439 16440 16441 16442 16443 16444 16445 16446 16447 16448 16449 16450 16451 |
# 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.(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
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.
16479 16480 16481 16482 16483 16484 16485 16486 16487 16488 16489 16490 16491 16492 16493 16494 16495 16496 16497 16498 16499 16500 16501 16502 16503 16504 16505 16506 16507 16508 16509 16510 16511 16512 16513 16514 16515 16516 |
# 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.(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
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.
16541 16542 16543 16544 16545 16546 16547 16548 16549 16550 16551 16552 16553 16554 16555 16556 16557 16558 16559 16560 16561 16562 16563 16564 16565 16566 16567 16568 16569 16570 16571 16572 16573 16574 16575 16576 |
# 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.(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
Click here to see an example of how to use provision_audit_policy API.
Provision audit policy.
16606 16607 16608 16609 16610 16611 16612 16613 16614 16615 16616 16617 16618 16619 16620 16621 16622 16623 16624 16625 16626 16627 16628 16629 16630 16631 16632 16633 16634 16635 16636 16637 16638 16639 16640 16641 16642 16643 16644 16645 |
# 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.(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
Click here to see an example of how to use purge_sql_collection_logs API.
Purge the SQL collection logs for the specified SqlCollection.
16674 16675 16676 16677 16678 16679 16680 16681 16682 16683 16684 16685 16686 16687 16688 16689 16690 16691 16692 16693 16694 16695 16696 16697 16698 16699 16700 16701 16702 16703 16704 16705 16706 16707 16708 16709 16710 16711 16712 |
# 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.(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
Click here to see an example of how to use refresh_database_security_configuration API.
Refreshes the specified database security configuration.
16741 16742 16743 16744 16745 16746 16747 16748 16749 16750 16751 16752 16753 16754 16755 16756 16757 16758 16759 16760 16761 16762 16763 16764 16765 16766 16767 16768 16769 16770 16771 16772 16773 16774 16775 16776 16777 16778 16779 |
# 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.(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
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.
16811 16812 16813 16814 16815 16816 16817 16818 16819 16820 16821 16822 16823 16824 16825 16826 16827 16828 16829 16830 16831 16832 16833 16834 16835 16836 16837 16838 16839 16840 16841 16842 16843 16844 16845 16846 16847 16848 16849 16850 |
# 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.(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
Click here to see an example of how to use refresh_sql_collection_log_insights API.
Refresh the specified SQL collection Log Insights.
16879 16880 16881 16882 16883 16884 16885 16886 16887 16888 16889 16890 16891 16892 16893 16894 16895 16896 16897 16898 16899 16900 16901 16902 16903 16904 16905 16906 16907 16908 16909 16910 16911 16912 16913 16914 16915 16916 16917 |
# 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.(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
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.
16950 16951 16952 16953 16954 16955 16956 16957 16958 16959 16960 16961 16962 16963 16964 16965 16966 16967 16968 16969 16970 16971 16972 16973 16974 16975 16976 16977 16978 16979 16980 16981 16982 16983 16984 16985 16986 16987 16988 16989 |
# 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.(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
Click here to see an example of how to use remove_schedule_report API.
Deletes the schedule of a PDF or XLS report.
17018 17019 17020 17021 17022 17023 17024 17025 17026 17027 17028 17029 17030 17031 17032 17033 17034 17035 17036 17037 17038 17039 17040 17041 17042 17043 17044 17045 17046 17047 17048 17049 17050 17051 17052 17053 17054 17055 17056 |
# 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.(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
Click here to see an example of how to use resume_audit_trail API.
Resumes the specified audit trail once it got stopped.
17080 17081 17082 17083 17084 17085 17086 17087 17088 17089 17090 17091 17092 17093 17094 17095 17096 17097 17098 17099 17100 17101 17102 17103 17104 17105 17106 17107 17108 17109 17110 17111 17112 17113 17114 17115 17116 |
# 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.(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
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.
17146 17147 17148 17149 17150 17151 17152 17153 17154 17155 17156 17157 17158 17159 17160 17161 17162 17163 17164 17165 17166 17167 17168 17169 17170 17171 17172 17173 17174 17175 17176 17177 17178 17179 17180 17181 17182 17183 17184 |
# 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.(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
Click here to see an example of how to use retrieve_audit_policies API.
Retrieves the audit policy details from the source target database.
17213 17214 17215 17216 17217 17218 17219 17220 17221 17222 17223 17224 17225 17226 17227 17228 17229 17230 17231 17232 17233 17234 17235 17236 17237 17238 17239 17240 17241 17242 17243 17244 17245 17246 17247 17248 17249 17250 17251 |
# 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.(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
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.
17281 17282 17283 17284 17285 17286 17287 17288 17289 17290 17291 17292 17293 17294 17295 17296 17297 17298 17299 17300 17301 17302 17303 17304 17305 17306 17307 17308 17309 17310 17311 17312 17313 17314 17315 17316 17317 17318 17319 17320 |
# 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.(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
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'.
17350 17351 17352 17353 17354 17355 17356 17357 17358 17359 17360 17361 17362 17363 17364 17365 17366 17367 17368 17369 17370 17371 17372 17373 17374 17375 17376 17377 17378 17379 17380 17381 17382 17383 17384 17385 17386 17387 17388 |
# 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.(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
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'.
17418 17419 17420 17421 17422 17423 17424 17425 17426 17427 17428 17429 17430 17431 17432 17433 17434 17435 17436 17437 17438 17439 17440 17441 17442 17443 17444 17445 17446 17447 17448 17449 17450 17451 17452 17453 17454 17455 17456 |
# 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.(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
Click here to see an example of how to use start_audit_trail API.
Starts collection of audit records on the specified audit trail.
17486 17487 17488 17489 17490 17491 17492 17493 17494 17495 17496 17497 17498 17499 17500 17501 17502 17503 17504 17505 17506 17507 17508 17509 17510 17511 17512 17513 17514 17515 17516 17517 17518 17519 17520 17521 17522 17523 17524 17525 |
# 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.(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
Click here to see an example of how to use start_sql_collection API.
Start the specified SQL collection.
17554 17555 17556 17557 17558 17559 17560 17561 17562 17563 17564 17565 17566 17567 17568 17569 17570 17571 17572 17573 17574 17575 17576 17577 17578 17579 17580 17581 17582 17583 17584 17585 17586 17587 17588 17589 17590 17591 17592 |
# 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.(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
Click here to see an example of how to use stop_audit_trail API.
Stops the specified audit trail.
17616 17617 17618 17619 17620 17621 17622 17623 17624 17625 17626 17627 17628 17629 17630 17631 17632 17633 17634 17635 17636 17637 17638 17639 17640 17641 17642 17643 17644 17645 17646 17647 17648 17649 17650 17651 17652 |
# 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.(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
Click here to see an example of how to use stop_sql_collection API.
Stops the specified SQL collection.
17681 17682 17683 17684 17685 17686 17687 17688 17689 17690 17691 17692 17693 17694 17695 17696 17697 17698 17699 17700 17701 17702 17703 17704 17705 17706 17707 17708 17709 17710 17711 17712 17713 17714 17715 17716 17717 17718 17719 |
# 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.(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
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.
17749 17750 17751 17752 17753 17754 17755 17756 17757 17758 17759 17760 17761 17762 17763 17764 17765 17766 17767 17768 17769 17770 17771 17772 17773 17774 17775 17776 17777 17778 17779 17780 17781 17782 17783 17784 17785 17786 17787 |
# 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.(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
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.
17818 17819 17820 17821 17822 17823 17824 17825 17826 17827 17828 17829 17830 17831 17832 17833 17834 17835 17836 17837 17838 17839 17840 17841 17842 17843 17844 17845 17846 17847 17848 17849 17850 17851 17852 17853 17854 17855 17856 |
# 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.(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
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.
17887 17888 17889 17890 17891 17892 17893 17894 17895 17896 17897 17898 17899 17900 17901 17902 17903 17904 17905 17906 17907 17908 17909 17910 17911 17912 17913 17914 17915 17916 17917 17918 17919 17920 17921 17922 17923 17924 17925 |
# 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.(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
Click here to see an example of how to use update_alert API.
Updates the status of the specified alert.
17950 17951 17952 17953 17954 17955 17956 17957 17958 17959 17960 17961 17962 17963 17964 17965 17966 17967 17968 17969 17970 17971 17972 17973 17974 17975 17976 17977 17978 17979 17980 17981 17982 17983 17984 17985 17986 17987 17988 |
# 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.(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
Click here to see an example of how to use update_audit_archive_retrieval API.
Updates the audit archive retrieval.
18013 18014 18015 18016 18017 18018 18019 18020 18021 18022 18023 18024 18025 18026 18027 18028 18029 18030 18031 18032 18033 18034 18035 18036 18037 18038 18039 18040 18041 18042 18043 18044 18045 18046 18047 18048 18049 18050 |
# 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.(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
Click here to see an example of how to use update_audit_policy API.
Updates the audit policy.
18075 18076 18077 18078 18079 18080 18081 18082 18083 18084 18085 18086 18087 18088 18089 18090 18091 18092 18093 18094 18095 18096 18097 18098 18099 18100 18101 18102 18103 18104 18105 18106 18107 18108 18109 18110 18111 18112 |
# 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.(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
Click here to see an example of how to use update_audit_profile API.
Updates one or more attributes of the specified audit profile.
18137 18138 18139 18140 18141 18142 18143 18144 18145 18146 18147 18148 18149 18150 18151 18152 18153 18154 18155 18156 18157 18158 18159 18160 18161 18162 18163 18164 18165 18166 18167 18168 18169 18170 18171 18172 18173 18174 |
# 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.(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
Click here to see an example of how to use update_audit_trail API.
Updates one or more attributes of the specified audit trail.
18199 18200 18201 18202 18203 18204 18205 18206 18207 18208 18209 18210 18211 18212 18213 18214 18215 18216 18217 18218 18219 18220 18221 18222 18223 18224 18225 18226 18227 18228 18229 18230 18231 18232 18233 18234 18235 18236 |
# 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.(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
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.
18261 18262 18263 18264 18265 18266 18267 18268 18269 18270 18271 18272 18273 18274 18275 18276 18277 18278 18279 18280 18281 18282 18283 18284 18285 18286 18287 18288 18289 18290 18291 18292 18293 18294 18295 18296 18297 18298 |
# 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.(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
Click here to see an example of how to use update_database_security_config API.
Updates the database security configuration.
18323 18324 18325 18326 18327 18328 18329 18330 18331 18332 18333 18334 18335 18336 18337 18338 18339 18340 18341 18342 18343 18344 18345 18346 18347 18348 18349 18350 18351 18352 18353 18354 18355 18356 18357 18358 18359 18360 |
# 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.(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
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.
18385 18386 18387 18388 18389 18390 18391 18392 18393 18394 18395 18396 18397 18398 18399 18400 18401 18402 18403 18404 18405 18406 18407 18408 18409 18410 18411 18412 18413 18414 18415 18416 18417 18418 18419 18420 18421 18422 |
# 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.(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
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.
18450 18451 18452 18453 18454 18455 18456 18457 18458 18459 18460 18461 18462 18463 18464 18465 18466 18467 18468 18469 18470 18471 18472 18473 18474 18475 18476 18477 18478 18479 18480 18481 18482 18483 18484 18485 18486 18487 18488 18489 |
# 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.(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
Click here to see an example of how to use update_masking_policy API.
Updates one or more attributes of the specified masking policy.
18514 18515 18516 18517 18518 18519 18520 18521 18522 18523 18524 18525 18526 18527 18528 18529 18530 18531 18532 18533 18534 18535 18536 18537 18538 18539 18540 18541 18542 18543 18544 18545 18546 18547 18548 18549 18550 18551 |
# 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.(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
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.
18576 18577 18578 18579 18580 18581 18582 18583 18584 18585 18586 18587 18588 18589 18590 18591 18592 18593 18594 18595 18596 18597 18598 18599 18600 18601 18602 18603 18604 18605 18606 18607 18608 18609 18610 18611 18612 18613 |
# 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.(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
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.
18644 18645 18646 18647 18648 18649 18650 18651 18652 18653 18654 18655 18656 18657 18658 18659 18660 18661 18662 18663 18664 18665 18666 18667 18668 18669 18670 18671 18672 18673 18674 18675 18676 18677 18678 18679 18680 18681 18682 18683 |
# 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.(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
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.
18713 18714 18715 18716 18717 18718 18719 18720 18721 18722 18723 18724 18725 18726 18727 18728 18729 18730 18731 18732 18733 18734 18735 18736 18737 18738 18739 18740 18741 18742 18743 18744 18745 18746 18747 18748 18749 18750 18751 18752 |
# 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.(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
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.
18777 18778 18779 18780 18781 18782 18783 18784 18785 18786 18787 18788 18789 18790 18791 18792 18793 18794 18795 18796 18797 18798 18799 18800 18801 18802 18803 18804 18805 18806 18807 18808 18809 18810 18811 18812 18813 18814 |
# 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.(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
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.
18840 18841 18842 18843 18844 18845 18846 18847 18848 18849 18850 18851 18852 18853 18854 18855 18856 18857 18858 18859 18860 18861 18862 18863 18864 18865 18866 18867 18868 18869 18870 18871 18872 18873 18874 18875 18876 18877 |
# 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.(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
Click here to see an example of how to use update_security_policy API.
Updates the security policy.
18902 18903 18904 18905 18906 18907 18908 18909 18910 18911 18912 18913 18914 18915 18916 18917 18918 18919 18920 18921 18922 18923 18924 18925 18926 18927 18928 18929 18930 18931 18932 18933 18934 18935 18936 18937 18938 18939 |
# 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.(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
Click here to see an example of how to use update_security_policy_deployment API.
Updates the security policy deployment.
18964 18965 18966 18967 18968 18969 18970 18971 18972 18973 18974 18975 18976 18977 18978 18979 18980 18981 18982 18983 18984 18985 18986 18987 18988 18989 18990 18991 18992 18993 18994 18995 18996 18997 18998 18999 19000 19001 |
# 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.(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
Click here to see an example of how to use update_sensitive_column API.
Updates one or more attributes of the specified sensitive column.
19027 19028 19029 19030 19031 19032 19033 19034 19035 19036 19037 19038 19039 19040 19041 19042 19043 19044 19045 19046 19047 19048 19049 19050 19051 19052 19053 19054 19055 19056 19057 19058 19059 19060 19061 19062 19063 19064 19065 19066 |
# 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.(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
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.
19093 19094 19095 19096 19097 19098 19099 19100 19101 19102 19103 19104 19105 19106 19107 19108 19109 19110 19111 19112 19113 19114 19115 19116 19117 19118 19119 19120 19121 19122 19123 19124 19125 19126 19127 19128 19129 19130 |
# 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.(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
Click here to see an example of how to use update_sensitive_type API.
Updates one or more attributes of the specified sensitive type.
19155 19156 19157 19158 19159 19160 19161 19162 19163 19164 19165 19166 19167 19168 19169 19170 19171 19172 19173 19174 19175 19176 19177 19178 19179 19180 19181 19182 19183 19184 19185 19186 19187 19188 19189 19190 19191 19192 |
# 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.(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
Click here to see an example of how to use update_sql_collection API.
Updates the SQL collection.
19217 19218 19219 19220 19221 19222 19223 19224 19225 19226 19227 19228 19229 19230 19231 19232 19233 19234 19235 19236 19237 19238 19239 19240 19241 19242 19243 19244 19245 19246 19247 19248 19249 19250 19251 19252 19253 19254 |
# 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.(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
Click here to see an example of how to use update_sql_firewall_policy API.
Updates the SQL firewall policy.
19279 19280 19281 19282 19283 19284 19285 19286 19287 19288 19289 19290 19291 19292 19293 19294 19295 19296 19297 19298 19299 19300 19301 19302 19303 19304 19305 19306 19307 19308 19309 19310 19311 19312 19313 19314 19315 19316 |
# 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.(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
Click here to see an example of how to use update_target_alert_policy_association API.
Updates the specified target-alert policy association.
19341 19342 19343 19344 19345 19346 19347 19348 19349 19350 19351 19352 19353 19354 19355 19356 19357 19358 19359 19360 19361 19362 19363 19364 19365 19366 19367 19368 19369 19370 19371 19372 19373 19374 19375 19376 19377 19378 |
# 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.(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
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.
19408 19409 19410 19411 19412 19413 19414 19415 19416 19417 19418 19419 19420 19421 19422 19423 19424 19425 19426 19427 19428 19429 19430 19431 19432 19433 19434 19435 19436 19437 19438 19439 19440 19441 19442 19443 19444 19445 19446 19447 |
# 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.(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
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.
19473 19474 19475 19476 19477 19478 19479 19480 19481 19482 19483 19484 19485 19486 19487 19488 19489 19490 19491 19492 19493 19494 19495 19496 19497 19498 19499 19500 19501 19502 19503 19504 19505 19506 19507 19508 19509 19510 |
# 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.(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
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.
19540 19541 19542 19543 19544 19545 19546 19547 19548 19549 19550 19551 19552 19553 19554 19555 19556 19557 19558 19559 19560 19561 19562 19563 19564 19565 19566 19567 19568 19569 19570 19571 19572 19573 19574 19575 19576 19577 |
# 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.(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
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.
19606 19607 19608 19609 19610 19611 19612 19613 19614 19615 19616 19617 19618 19619 19620 19621 19622 19623 19624 19625 19626 19627 19628 19629 19630 19631 19632 19633 19634 19635 19636 19637 19638 19639 19640 19641 19642 19643 |
# 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.(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 |