Class: OCI::DataSafe::DataSafeClient

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/data_safe/data_safe_client.rb

Overview

APIs for using Oracle Data Safe.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

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

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

This client is not thread-safe

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

Parameters:

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

    A Config object.

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

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

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

    The fully qualified endpoint URL

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

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

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

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

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

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



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.

Returns:



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

Returns:

  • (String) 


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.

Returns:

  • (String) 


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

Returns:



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

Note:

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

Reactivates a previously deactivated Data Safe target database.

Parameters:

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

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

  • target_database_id (String) —

    The OCID of the Data Safe target database.

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

    the optional parameters

Options Hash (opts):

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

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

  • :opc_retry_token (String) —

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

  • :if_match (String) —

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

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:

  • (Response) —

    A Response object with data of type nil



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.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#activate_target_database') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

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

Note:

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

Adds columns to the specified masking policy from the associated sensitive data model. It automatically pulls all the sensitive columns and their relationships from the sensitive data model and uses this information to create columns in the masking policy. It also assigns default masking formats to these columns based on the associated sensitive types.

Parameters:

  • masking_policy_id (String) —

    The OCID of the masking policy.

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

    the optional parameters

Options Hash (opts):

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

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

  • :if_match (String) —

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

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:

  • (Response) —

    A Response object with data of type nil



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.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#add_masking_columns_from_sdm') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

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

Note:

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

Updates alerts in the specified compartment.

Parameters:

Options Hash (opts):

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

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

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :if_match (String) —

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

  • :opc_retry_token (String) —

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

  • :compartment_id_in_subtree (BOOLEAN) —

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

  • :access_level (String) —

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

Returns:

  • (Response) —

    A Response object with data of type nil



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.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#alerts_update') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

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

Note:

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

Applies the results of a discovery job to the specified sensitive data model. Note that the plannedAction attribute of discovery results is used for processing them. You should first use PatchDiscoveryJobResults to set the plannedAction attribute of the discovery results you want to process. ApplyDiscoveryJobResults automatically reads the plannedAction attribute and updates the sensitive data model to reflect the actions you planned.

Parameters:

  • sensitive_data_model_id (String) —

    The OCID of the sensitive data model.

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

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

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

    the optional parameters

Options Hash (opts):

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

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

  • :if_match (String) —

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

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:

  • (Response) —

    A Response object with data of type nil



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.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#apply_discovery_job_results') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

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

Note:

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

Applies the difference of a SDM Masking policy difference resource to the specified masking policy. Note that the plannedAction attribute of difference columns is used for processing. You should first use PatchSdmMaskingPolicyDifferenceColumns to set the plannedAction attribute of the difference columns you want to process. ApplySdmMaskingPolicyDifference automatically reads the plannedAction attribute and updates the masking policy to reflect the actions you planned. If the sdmMaskingPolicydifferenceId is not passed, the latest sdmMaskingPolicydifference is used. Note that if the masking policy associated with the SdmMaskingPolicyDifference used for this operation is not associated with the original SDM anymore, this operation won't be allowed.

Parameters:

  • masking_policy_id (String) —

    The OCID of the masking policy.

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

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

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

    the optional parameters

Options Hash (opts):

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

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

  • :if_match (String) —

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

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :opc_retry_token (String) —

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

Returns:

  • (Response) —

    A Response object with data of type nil



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.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#apply_sdm_masking_policy_difference') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#apply_security_assessment_template(security_assessment_id, security_assessment_template_details, opts = {}) ⇒ Response

Note:

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

Apply the checks from the template to the specified security assessment.The security assessment provided in the path needs to be of type 'LATEST'.

Parameters:

  • security_assessment_id (String) —

    The OCID of the security assessment.

  • security_assessment_template_details (OCI::DataSafe::Models::SecurityAssessmentTemplateDetails) —

    Details of template that need to be applied to specified security assessment.

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

    the optional parameters

Options Hash (opts):

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

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

  • :if_match (String) —

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

  • :opc_retry_token (String) —

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

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:

  • (Response) —

    A Response object with data of type nil



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 apply_security_assessment_template(security_assessment_id, security_assessment_template_details, opts = {})
  logger.debug 'Calling operation DataSafeClient#apply_security_assessment_template.' if logger

  raise "Missing the required parameter 'security_assessment_id' when calling apply_security_assessment_template." if security_assessment_id.nil?
  raise "Missing the required parameter 'security_assessment_template_details' when calling apply_security_assessment_template." if security_assessment_template_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/applyTemplate'.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(security_assessment_template_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#apply_security_assessment_template') 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

#bulk_create_sensitive_types(bulk_create_sensitive_types_details, opc_compartment_id, opts = {}) ⇒ Response

Note:

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

Uploads a sensitive types xml file (also called template) to create new sensitive types.

Parameters:

  • bulk_create_sensitive_types_details (String, IO) —

    Details to upload a sensitive types file and create all.

  • opc_compartment_id (String) —

    A header param to create bulk resources in the specified compartment OCID.

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

    the optional parameters

Options Hash (opts):

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

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

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:

  • (Response) —

    A Response object with data of type nil



538
539
540
541
542
543
544
545
546
547
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
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 538

def bulk_create_sensitive_types(bulk_create_sensitive_types_details, opc_compartment_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#bulk_create_sensitive_types.' if logger

  raise "Missing the required parameter 'bulk_create_sensitive_types_details' when calling bulk_create_sensitive_types." if bulk_create_sensitive_types_details.nil?
  raise "Missing the required parameter 'opc_compartment_id' when calling bulk_create_sensitive_types." if opc_compartment_id.nil?

  path = '/sensitiveTypes/actions/bulkCreateSensitiveTypes'
  operation_signing_strategy = :standard

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

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'opc-compartment-id'] = opc_compartment_id
  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(bulk_create_sensitive_types_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#bulk_create_sensitive_types') 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

#bulk_create_sql_firewall_allowed_sqls(bulk_create_sql_firewall_allowed_sqls_details, opts = {}) ⇒ Response

Note:

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

Appends the allowedSqls with entries from the logs.

Parameters:

Options Hash (opts):

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

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

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :opc_retry_token (String) —

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

Returns:

  • (Response) —

    A Response object with data of type nil



597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 597

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

  raise "Missing the required parameter 'bulk_create_sql_firewall_allowed_sqls_details' when calling bulk_create_sql_firewall_allowed_sqls." if bulk_create_sql_firewall_allowed_sqls_details.nil?

  path = '/sqlFirewallAllowedSqls/actions/bulkCreate'
  operation_signing_strategy = :standard

  # rubocop: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[:'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(bulk_create_sql_firewall_allowed_sqls_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#bulk_create_sql_firewall_allowed_sqls') 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

#bulk_create_unified_audit_policy(bulk_create_unified_audit_policy_details, opts = {}) ⇒ Response

Note:

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

Bulk create unified audit policies.

Parameters:

Options Hash (opts):

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

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

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :opc_retry_token (String) —

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

Returns:

  • (Response) —

    A Response object with data of type nil



656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 656

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

  raise "Missing the required parameter 'bulk_create_unified_audit_policy_details' when calling bulk_create_unified_audit_policy." if bulk_create_unified_audit_policy_details.nil?

  path = '/unifiedAuditPolicies/actions/bulkCreate'
  operation_signing_strategy = :standard

  # rubocop: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[:'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(bulk_create_unified_audit_policy_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#bulk_create_unified_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

#bulk_delete_sql_firewall_allowed_sqls(bulk_delete_sql_firewall_allowed_sqls_details, opts = {}) ⇒ Response

Note:

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

Delete multiple allowed sqls from the SQL firewall policy.

Parameters:

Options Hash (opts):

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

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

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:

  • (Response) —

    A Response object with data of type nil



710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 710

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

  raise "Missing the required parameter 'bulk_delete_sql_firewall_allowed_sqls_details' when calling bulk_delete_sql_firewall_allowed_sqls." if bulk_delete_sql_firewall_allowed_sqls_details.nil?

  path = '/sqlFirewallAllowedSqls/actions/bulkDelete'
  operation_signing_strategy = :standard

  # rubocop: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(bulk_delete_sql_firewall_allowed_sqls_details)

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

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

Note:

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

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

Parameters:

Options Hash (opts):

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

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

  • :if_match (String) —

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

  • :opc_retry_token (String) —

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

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:

  • (Response) —

    A Response object with data of type nil



774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 774

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

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

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

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

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

  post_body = @api_client.object_to_http_body(calculate_audit_volume_available_details)

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

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

Note:

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

Calculates the volume of audit events collected by data safe.

Parameters:

Options Hash (opts):

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

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

  • :if_match (String) —

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

  • :opc_retry_token (String) —

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

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:

  • (Response) —

    A Response object with data of type nil



843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 843

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

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

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

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

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

  post_body = @api_client.object_to_http_body(calculate_audit_volume_collected_details)

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

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

Note:

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

Cancel the specified work request.

Parameters:

  • work_request_id (String) —

    The OCID of the work request.

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

    the optional parameters

Options Hash (opts):

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

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

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :if_match (String) —

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

Returns:

  • (Response) —

    A Response object with data of type nil



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
933
934
935
936
937
938
939
940
941
942
943
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 907

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-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf

  post_body = nil

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

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

Note:

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

Moves the specified alert into a different compartment.

Parameters:

Options Hash (opts):

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

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

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :if_match (String) —

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

  • :opc_retry_token (String) —

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

Returns:

  • (Response) —

    A Response object with data of type nil



973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 973

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

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

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

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

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

  post_body = @api_client.object_to_http_body(change_alert_compartment_details)

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

#change_alert_policy_compartment(alert_policy_id, change_alert_policy_compartment_details, opts = {}) ⇒ Response

Note:

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

Moves the specified alert policy into a different compartment.

Parameters:

Options Hash (opts):

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

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

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :if_match (String) —

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

  • :opc_retry_token (String) —

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

Returns:

  • (Response) —

    A Response object with data of type nil



1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 1042

def change_alert_policy_compartment(alert_policy_id, change_alert_policy_compartment_details, opts = {})
  logger.debug 'Calling operation DataSafeClient#change_alert_policy_compartment.' if logger

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

  path = '/alertPolicies/{alertPolicyId}/actions/changeCompartment'.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]
  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_policy_compartment_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#change_alert_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_attribute_set_compartment(attribute_set_id, change_attribute_set_compartment_details, opts = {}) ⇒ Response

Note:

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

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

Parameters:

Options Hash (opts):

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

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

  • :if_match (String) —

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

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :opc_retry_token (String) —

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

Returns:

  • (Response) —

    A Response object with data of type nil



1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 1112

def change_attribute_set_compartment(attribute_set_id, change_attribute_set_compartment_details, opts = {})
  logger.debug 'Calling operation DataSafeClient#change_attribute_set_compartment.' if logger

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

  path = '/attributeSets/{attributeSetId}/actions/changeCompartment'.sub('{attributeSetId}', attribute_set_id.to_s)
  operation_signing_strategy = :standard

  # rubocop: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_attribute_set_compartment_details)

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

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

Note:

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

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

Parameters:

Options Hash (opts):

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

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

  • :if_match (String) —

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

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :opc_retry_token (String) —

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

Returns:

  • (Response) —

    A Response object with data of type nil



1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 1182

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

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

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

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

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

  post_body = @api_client.object_to_http_body(change_audit_archive_retrieval_compartment_details)

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

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

Note:

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

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

Parameters:

Options Hash (opts):

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

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

  • :if_match (String) —

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

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :opc_retry_token (String) —

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

Returns:

  • (Response) —

    A Response object with data of type nil



1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 1251

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

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

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

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

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

  post_body = @api_client.object_to_http_body(change_audit_policy_compartment_details)

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

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

Note:

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

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

Parameters:

Options Hash (opts):

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

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

  • :if_match (String) —

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

  • :opc_retry_token (String) —

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

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:

  • (Response) —

    A Response object with data of type nil



1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 1320

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

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

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

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

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

  post_body = @api_client.object_to_http_body(change_audit_profile_compartment_details)

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

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

Note:

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

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

Parameters:

Options Hash (opts):

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

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

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :if_match (String) —

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

Returns:

  • (Response) —

    A Response object with data of type nil



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
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 1384

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

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

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

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

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

  post_body = @api_client.object_to_http_body(change_data_safe_private_endpoint_compartment_details)

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

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

Note:

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

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

Parameters:

Options Hash (opts):

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

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

  • :if_match (String) —

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

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :opc_retry_token (String) —

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

Returns:

  • (Response) —

    A Response object with data of type nil



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
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 1451

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

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

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

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

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

  post_body = @api_client.object_to_http_body(change_database_security_config_compartment_details)

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

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

Note:

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

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

Parameters:

Options Hash (opts):

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

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

  • :if_match (String) —

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

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :opc_retry_token (String) —

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

Returns:

  • (Response) —

    A Response object with data of type nil



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
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 1520

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

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

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

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

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

  post_body = @api_client.object_to_http_body(change_discovery_job_compartment_details)

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

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

Note:

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

Moves the specified library masking format into a different compartment.

Parameters:

Options Hash (opts):

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

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

  • :if_match (String) —

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

  • :opc_retry_token (String) —

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

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:

  • (Response) —

    A Response object with data of type nil



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
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 1589

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

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

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

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

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

  post_body = @api_client.object_to_http_body(change_library_masking_format_compartment_details)

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

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

Note:

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

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

Parameters:

Options Hash (opts):

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

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

  • :if_match (String) —

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

  • :opc_retry_token (String) —

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

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:

  • (Response) —

    A Response object with data of type nil



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
1690
1691
1692
1693
1694
1695
1696
1697
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 1658

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

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

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

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

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

  post_body = @api_client.object_to_http_body(change_masking_policy_compartment_details)

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

#change_masking_policy_health_report_compartment(masking_policy_health_report_id, change_masking_policy_health_report_compartment_details, opts = {}) ⇒ Response

Note:

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

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

Parameters:

Options Hash (opts):

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

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

  • :if_match (String) —

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

  • :opc_retry_token (String) —

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

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:

  • (Response) —

    A Response object with data of type nil



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
1759
1760
1761
1762
1763
1764
1765
1766
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 1727

def change_masking_policy_health_report_compartment(masking_policy_health_report_id, change_masking_policy_health_report_compartment_details, opts = {})
  logger.debug 'Calling operation DataSafeClient#change_masking_policy_health_report_compartment.' if logger

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

  path = '/maskingPolicyHealthReports/{maskingPolicyHealthReportId}/actions/changeCompartment'.sub('{maskingPolicyHealthReportId}', masking_policy_health_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-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_health_report_compartment_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#change_masking_policy_health_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_on_prem_connector_compartment(on_prem_connector_id, change_on_prem_connector_compartment_details, opts = {}) ⇒ Response

Note:

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

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

Parameters:

  • on_prem_connector_id (String) —

    The OCID of the on-premises connector.

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

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

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

    the optional parameters

Options Hash (opts):

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

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

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :if_match (String) —

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

  • :opc_retry_token (String) —

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

Returns:

  • (Response) —

    A Response object with data of type nil



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
1828
1829
1830
1831
1832
1833
1834
1835
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 1796

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

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

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

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

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

  post_body = @api_client.object_to_http_body(change_on_prem_connector_compartment_details)

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

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

Note:

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

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

Parameters:

Options Hash (opts):

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

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

  • :if_match (String) —

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

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :opc_retry_token (String) —

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

Returns:

  • (Response) —

    A Response object with data of type nil



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
1897
1898
1899
1900
1901
1902
1903
1904
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 1865

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

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

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

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

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

  post_body = @api_client.object_to_http_body(change_report_compartment_details)

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

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

Note:

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

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

Parameters:

Options Hash (opts):

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

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

  • :if_match (String) —

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

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :opc_retry_token (String) —

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

Returns:

  • (Response) —

    A Response object with data of type nil



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
1966
1967
1968
1969
1970
1971
1972
1973
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 1934

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

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

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

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

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

  post_body = @api_client.object_to_http_body(change_report_definition_compartment_details)

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

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

Note:

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

Change the online and offline months .

Parameters:

  • audit_profile_id (String) —

    The OCID of the audit.

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

    Details for the audit retention months to be modified.

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

    the optional parameters

Options Hash (opts):

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

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

  • :if_match (String) —

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

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :opc_retry_token (String) —

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

Returns:

  • (Response) —

    A Response object with data of type nil



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
2035
2036
2037
2038
2039
2040
2041
2042
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 2003

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

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

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

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

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

  post_body = @api_client.object_to_http_body(change_retention_details)

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

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

Note:

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

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

Parameters:

Options Hash (opts):

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

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

  • :if_match (String) —

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

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :opc_retry_token (String) —

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

Returns:

  • (Response) —

    A Response object with data of type nil



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
2104
2105
2106
2107
2108
2109
2110
2111
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 2072

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

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

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

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

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

  post_body = @api_client.object_to_http_body(change_sdm_masking_policy_difference_compartment_details)

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

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

Note:

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

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

To start, call first the operation ListSecurityAssessments with filters "type = save_schedule". This returns the scheduleAssessmentId. Then, call this changeCompartment with the scheduleAssessmentId.

The existing saved security assessments created due to the schedule are not moved. However, all new saves will be associated with the new compartment.

Parameters:

Options Hash (opts):

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

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

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :if_match (String) —

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

  • :opc_retry_token (String) —

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

Returns:

  • (Response) —

    A Response object with data of type nil



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
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 2146

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

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

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

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

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

  post_body = @api_client.object_to_http_body(change_security_assessment_compartment_details)

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

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

Note:

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

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

Parameters:

Options Hash (opts):

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

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

  • :if_match (String) —

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

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :opc_retry_token (String) —

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

Returns:

  • (Response) —

    A Response object with data of type nil



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
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 2215

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

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

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

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

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

  post_body = @api_client.object_to_http_body(change_security_policy_compartment_details)

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

#change_security_policy_config_compartment(security_policy_config_id, change_security_policy_config_compartment_details, opts = {}) ⇒ Response

Note:

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

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

Parameters:

Options Hash (opts):

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

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

  • :if_match (String) —

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

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :opc_retry_token (String) —

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

Returns:

  • (Response) —

    A Response object with data of type nil



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
2316
2317
2318
2319
2320
2321
2322
2323
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 2284

def change_security_policy_config_compartment(security_policy_config_id, change_security_policy_config_compartment_details, opts = {})
  logger.debug 'Calling operation DataSafeClient#change_security_policy_config_compartment.' if logger

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

  path = '/securityPolicyConfigs/{securityPolicyConfigId}/actions/changeCompartment'.sub('{securityPolicyConfigId}', security_policy_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_security_policy_config_compartment_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#change_security_policy_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_security_policy_deployment_compartment(security_policy_deployment_id, change_security_policy_deployment_compartment_details, opts = {}) ⇒ Response

Note:

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

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

Parameters:

Options Hash (opts):

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

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

  • :if_match (String) —

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

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :opc_retry_token (String) —

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

Returns:

  • (Response) —

    A Response object with data of type nil



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
2387
2388
2389
2390
2391
2392
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 2353

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

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

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

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

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

  post_body = @api_client.object_to_http_body(change_security_policy_deployment_compartment_details)

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

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

Note:

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

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

Parameters:

Options Hash (opts):

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

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

  • :if_match (String) —

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

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :opc_retry_token (String) —

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

Returns:

  • (Response) —

    A Response object with data of type nil



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
2458
2459
2460
2461
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 2422

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

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

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

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

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

  post_body = @api_client.object_to_http_body(change_sensitive_data_model_compartment_details)

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

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

Note:

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

Moves the specified sensitive type into a different compartment.

Parameters:

Options Hash (opts):

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

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

  • :if_match (String) —

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

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :opc_retry_token (String) —

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

Returns:

  • (Response) —

    A Response object with data of type nil



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
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 2491

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

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

  path = '/sensitiveTypes/{sensitiveTypeId}/actions/changeCompartment'.sub('{sensitiveTypeId}', sensitive_type_id.to_s)
  operation_signing_strategy = :standard

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

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

  post_body = @api_client.object_to_http_body(change_sensitive_type_compartment_details)

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

#change_sensitive_type_group_compartment(sensitive_type_group_id, change_sensitive_type_group_compartment_details, opts = {}) ⇒ Response

Note:

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

Moves the sensitive type group to the specified compartment.

Parameters:

Options Hash (opts):

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

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

  • :if_match (String) —

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

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :opc_retry_token (String) —

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

Returns:

  • (Response) —

    A Response object with data of type nil



2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 2560

def change_sensitive_type_group_compartment(sensitive_type_group_id, change_sensitive_type_group_compartment_details, opts = {})
  logger.debug 'Calling operation DataSafeClient#change_sensitive_type_group_compartment.' if logger

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

  path = '/sensitiveTypeGroups/{sensitiveTypeGroupId}/actions/changeCompartment'.sub('{sensitiveTypeGroupId}', sensitive_type_group_id.to_s)
  operation_signing_strategy = :standard

  # rubocop: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_group_compartment_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#change_sensitive_type_group_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_types_export_compartment(sensitive_types_export_id, change_sensitive_types_export_compartment_details, opts = {}) ⇒ Response

Note:

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

Moves the specified sensitive types export into a different compartment.

Parameters:

Options Hash (opts):

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

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

  • :if_match (String) —

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

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :opc_retry_token (String) —

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

Returns:

  • (Response) —

    A Response object with data of type nil



2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 2629

def change_sensitive_types_export_compartment(sensitive_types_export_id, change_sensitive_types_export_compartment_details, opts = {})
  logger.debug 'Calling operation DataSafeClient#change_sensitive_types_export_compartment.' if logger

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

  path = '/sensitiveTypesExports/{sensitiveTypesExportId}/actions/changeCompartment'.sub('{sensitiveTypesExportId}', sensitive_types_export_id.to_s)
  operation_signing_strategy = :standard

  # rubocop: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_types_export_compartment_details)

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

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

Note:

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

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

Parameters:

Options Hash (opts):

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

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

  • :if_match (String) —

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

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :opc_retry_token (String) —

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

Returns:

  • (Response) —

    A Response object with data of type nil



2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 2698

def change_sql_collection_compartment(sql_collection_id, change_sql_collection_compartment_details, opts = {})
  logger.debug 'Calling operation DataSafeClient#change_sql_collection_compartment.' if logger

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

  path = '/sqlCollections/{sqlCollectionId}/actions/changeCompartment'.sub('{sqlCollectionId}', sql_collection_id.to_s)
  operation_signing_strategy = :standard

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

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

  post_body = @api_client.object_to_http_body(change_sql_collection_compartment_details)

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

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

Note:

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

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

Parameters:

Options Hash (opts):

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

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

  • :if_match (String) —

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

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :opc_retry_token (String) —

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

Returns:

  • (Response) —

    A Response object with data of type nil



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
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 2767

def change_sql_firewall_policy_compartment(sql_firewall_policy_id, change_sql_firewall_policy_compartment_details, opts = {})
  logger.debug 'Calling operation DataSafeClient#change_sql_firewall_policy_compartment.' if logger

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

  path = '/sqlFirewallPolicies/{sqlFirewallPolicyId}/actions/changeCompartment'.sub('{sqlFirewallPolicyId}', sql_firewall_policy_id.to_s)
  operation_signing_strategy = :standard

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

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

  post_body = @api_client.object_to_http_body(change_sql_firewall_policy_compartment_details)

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

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

Note:

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

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

Parameters:

  • target_alert_policy_association_id (String) —

    The OCID of the target-alert policy association.

  • change_target_alert_policy_association_compartment_details (OCI::DataSafe::Models::ChangeTargetAlertPolicyAssociationCompartmentDetails) —

    The details used to change the compartment of a target-alert policy association.

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

    the optional parameters

Options Hash (opts):

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

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

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :if_match (String) —

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

  • :opc_retry_token (String) —

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

Returns:

  • (Response) —

    A Response object with data of type nil



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
2871
2872
2873
2874
2875
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 2836

def change_target_alert_policy_association_compartment(target_alert_policy_association_id, change_target_alert_policy_association_compartment_details, opts = {})
  logger.debug 'Calling operation DataSafeClient#change_target_alert_policy_association_compartment.' if logger

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

  path = '/targetAlertPolicyAssociations/{targetAlertPolicyAssociationId}/actions/changeCompartment'.sub('{targetAlertPolicyAssociationId}', target_alert_policy_association_id.to_s)
  operation_signing_strategy = :standard

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

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

  post_body = @api_client.object_to_http_body(change_target_alert_policy_association_compartment_details)

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

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

Note:

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

Moves the Data Safe target database to the specified compartment.

Parameters:

Options Hash (opts):

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

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

  • :if_match (String) —

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

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :opc_retry_token (String) —

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

Returns:

  • (Response) —

    A Response object with data of type nil



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
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 2905

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

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

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

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

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

  post_body = @api_client.object_to_http_body(change_target_database_compartment_details)

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

#change_target_database_group_compartment(target_database_group_id, change_target_database_group_compartment_details, opts = {}) ⇒ Response

Note:

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

Moves the target database group to the specified compartment.

Parameters:

Options Hash (opts):

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

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

  • :if_match (String) —

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

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :opc_retry_token (String) —

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

Returns:

  • (Response) —

    A Response object with data of type nil



2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 2974

def change_target_database_group_compartment(target_database_group_id, change_target_database_group_compartment_details, opts = {})
  logger.debug 'Calling operation DataSafeClient#change_target_database_group_compartment.' if logger

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

  path = '/targetDatabaseGroups/{targetDatabaseGroupId}/actions/changeCompartment'.sub('{targetDatabaseGroupId}', target_database_group_id.to_s)
  operation_signing_strategy = :standard

  # rubocop: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_group_compartment_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#change_target_database_group_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_unified_audit_policy_compartment(unified_audit_policy_id, change_unified_audit_policy_compartment_details, opts = {}) ⇒ Response

Note:

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

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

Parameters:

Options Hash (opts):

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

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

  • :if_match (String) —

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

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :opc_retry_token (String) —

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

Returns:

  • (Response) —

    A Response object with data of type nil



3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 3043

def change_unified_audit_policy_compartment(unified_audit_policy_id, change_unified_audit_policy_compartment_details, opts = {})
  logger.debug 'Calling operation DataSafeClient#change_unified_audit_policy_compartment.' if logger

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

  path = '/unifiedAuditPolicies/{unifiedAuditPolicyId}/actions/changeCompartment'.sub('{unifiedAuditPolicyId}', unified_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_unified_audit_policy_compartment_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#change_unified_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_unified_audit_policy_definition_compartment(unified_audit_policy_definition_id, change_unified_audit_policy_definition_compartment_details, opts = {}) ⇒ Response

Note:

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

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

Parameters:

Options Hash (opts):

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

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

  • :if_match (String) —

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

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :opc_retry_token (String) —

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

Returns:

  • (Response) —

    A Response object with data of type nil



3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 3112

def change_unified_audit_policy_definition_compartment(unified_audit_policy_definition_id, change_unified_audit_policy_definition_compartment_details, opts = {})
  logger.debug 'Calling operation DataSafeClient#change_unified_audit_policy_definition_compartment.' if logger

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

  path = '/unifiedAuditPolicyDefinitions/{unifiedAuditPolicyDefinitionId}/actions/changeCompartment'.sub('{unifiedAuditPolicyDefinitionId}', unified_audit_policy_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_unified_audit_policy_definition_compartment_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#change_unified_audit_policy_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_user_assessment_compartment(user_assessment_id, change_user_assessment_compartment_details, opts = {}) ⇒ Response

Note:

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

Moves the specified saved user assessment or future scheduled assessments into a different compartment. To start storing scheduled user assessments on a different compartment, first call the operation ListUserAssessments with the filters "type = save_schedule". That call returns the scheduleAssessmentId. Then call ChangeUserAssessmentCompartment with the scheduleAssessmentId. The existing saved user assessments created per the schedule are not be moved. However, all new saves will be associated with the new compartment.

Parameters:

Options Hash (opts):

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

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

  • :if_match (String) —

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

  • :opc_retry_token (String) —

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

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:

  • (Response) —

    A Response object with data of type nil



3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 3186

def change_user_assessment_compartment(user_assessment_id, change_user_assessment_compartment_details, opts = {})
  logger.debug 'Calling operation DataSafeClient#change_user_assessment_compartment.' if logger

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

  path = '/userAssessments/{userAssessmentId}/actions/changeCompartment'.sub('{userAssessmentId}', user_assessment_id.to_s)
  operation_signing_strategy = :standard

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

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

  post_body = @api_client.object_to_http_body(change_user_assessment_compartment_details)

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

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

Note:

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

Compares two security assessments. For this comparison, a security assessment can be a saved assessment, a latest assessment, or a baseline assessment. For example, you can compare saved assessment or a latest assessment against a baseline.

Parameters:

  • security_assessment_id (String) —

    The OCID of the security assessment.

  • compare_security_assessment_details (OCI::DataSafe::Models::CompareSecurityAssessmentDetails) —

    Details of the security assessment comparison.

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

    the optional parameters

Options Hash (opts):

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

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

  • :opc_retry_token (String) —

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

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :if_match (String) —

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

Returns:

  • (Response) —

    A Response object with data of type nil



3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
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
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 3257

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

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

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

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

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

  post_body = @api_client.object_to_http_body(compare_security_assessment_details)

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

#compare_to_template_baseline(security_assessment_id, compare_to_template_baseline_details, opts = {}) ⇒ Response

Note:

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

Compares two security assessments. For this comparison, the security assessment in the path needs to be a latest assessment of a target group.

Parameters:

  • security_assessment_id (String) —

    The OCID of the security assessment.

  • compare_to_template_baseline_details (OCI::DataSafe::Models::CompareToTemplateBaselineDetails) —

    Details of the security assessment comparison which pass the template baseline assessment ocid.

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

    the optional parameters

Options Hash (opts):

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

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

  • :opc_retry_token (String) —

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

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :if_match (String) —

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

Returns:

  • (Response) —

    A Response object with data of type nil



3327
3328
3329
3330
3331
3332
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
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 3327

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

  raise "Missing the required parameter 'security_assessment_id' when calling compare_to_template_baseline." if security_assessment_id.nil?
  raise "Missing the required parameter 'compare_to_template_baseline_details' when calling compare_to_template_baseline." if compare_to_template_baseline_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/compareToTemplateBaseline'.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_to_template_baseline_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#compare_to_template_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

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

Note:

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

Compares two user assessments. For this comparison, a user assessment can be a saved, a latest assessment, or a baseline. As an example, it can be used to compare a user assessment saved or a latest assessment with a baseline.

Parameters:

  • user_assessment_id (String) —

    The OCID of the user assessment.

  • compare_user_assessment_details (OCI::DataSafe::Models::CompareUserAssessmentDetails) —

    Details of the user assessment comparison.

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

    the optional parameters

Options Hash (opts):

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

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

  • :opc_retry_token (String) —

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

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :if_match (String) —

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

Returns:

  • (Response) —

    A Response object with data of type nil



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
3432
3433
3434
3435
3436
3437
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 3398

def compare_user_assessment(user_assessment_id, compare_user_assessment_details, opts = {})
  logger.debug 'Calling operation DataSafeClient#compare_user_assessment.' if logger

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

  path = '/userAssessments/{userAssessmentId}/actions/compare'.sub('{userAssessmentId}', user_assessment_id.to_s)
  operation_signing_strategy = :standard

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

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

  post_body = @api_client.object_to_http_body(compare_user_assessment_details)

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

#create_alert_policy(create_alert_policy_details, opts = {}) ⇒ Response

Note:

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

Creates a new user-defined alert policy.

Parameters:

Options Hash (opts):

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

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

  • :opc_retry_token (String) —

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

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:



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
3493
3494
3495
3496
3497
3498
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 3461

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

  raise "Missing the required parameter 'create_alert_policy_details' when calling create_alert_policy." if create_alert_policy_details.nil?

  path = '/alertPolicies'
  operation_signing_strategy = :standard

  # rubocop: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_alert_policy_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#create_alert_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::AlertPolicy'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_alert_policy_rule(create_alert_policy_rule_details, alert_policy_id, opts = {}) ⇒ Response

Note:

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

Creates a new rule for the alert policy.

Parameters:

  • create_alert_policy_rule_details (OCI::DataSafe::Models::CreateAlertPolicyRuleDetails) —

    The details used to create a new alert policy rule.

  • alert_policy_id (String) —

    The OCID of the alert policy.

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

    the optional parameters

Options Hash (opts):

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

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

  • :opc_retry_token (String) —

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

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:



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
3556
3557
3558
3559
3560
3561
3562
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 3523

def create_alert_policy_rule(create_alert_policy_rule_details, alert_policy_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#create_alert_policy_rule.' if logger

  raise "Missing the required parameter 'create_alert_policy_rule_details' when calling create_alert_policy_rule." if create_alert_policy_rule_details.nil?
  raise "Missing the required parameter 'alert_policy_id' when calling create_alert_policy_rule." 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 = {}

  # 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_alert_policy_rule_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#create_alert_policy_rule') 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::AlertPolicyRule'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_attribute_set(create_attribute_set_details, opts = {}) ⇒ Response

Note:

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

Creates an attribute set.

Parameters:

Options Hash (opts):

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

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

  • :opc_retry_token (String) —

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

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:



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 3586

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

  raise "Missing the required parameter 'create_attribute_set_details' when calling create_attribute_set." if create_attribute_set_details.nil?

  path = '/attributeSets'
  operation_signing_strategy = :standard

  # rubocop: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_attribute_set_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#create_attribute_set') 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::AttributeSet'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

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

Note:

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

Creates a work request to retrieve archived audit data. This asynchronous process will usually take over an hour to complete. Save the id from the response of this operation. Call GetAuditArchiveRetrieval operation after an hour, passing the id to know the status of this operation.

Parameters:

Options Hash (opts):

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

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

  • :opc_retry_token (String) —

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

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:



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
3686
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 3649

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

  raise "Missing the required parameter 'create_audit_archive_retrieval_details' when calling create_audit_archive_retrieval." if create_audit_archive_retrieval_details.nil?

  path = '/auditArchiveRetrievals'
  operation_signing_strategy = :standard

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

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

  post_body = @api_client.object_to_http_body(create_audit_archive_retrieval_details)

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

#create_audit_profile(create_audit_profile_details, opts = {}) ⇒ Response

Note:

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

Create a new audit profile resource.

Parameters:

Options Hash (opts):

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

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

  • :opc_retry_token (String) —

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

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:



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
3746
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 3709

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

  raise "Missing the required parameter 'create_audit_profile_details' when calling create_audit_profile." if create_audit_profile_details.nil?

  path = '/auditProfiles'
  operation_signing_strategy = :standard

  # rubocop: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_profile_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#create_audit_profile') 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::AuditProfile'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

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

Note:

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

Creates a new Data Safe private endpoint.

Parameters:

Options Hash (opts):

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

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

  • :opc_retry_token (String) —

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

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:



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
3806
3807
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 3770

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

  raise "Missing the required parameter 'create_data_safe_private_endpoint_details' when calling create_data_safe_private_endpoint." if create_data_safe_private_endpoint_details.nil?

  path = '/dataSafePrivateEndpoints'
  operation_signing_strategy = :standard

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

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

  post_body = @api_client.object_to_http_body(create_data_safe_private_endpoint_details)

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

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

Note:

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

Performs incremental data discovery for the specified sensitive data model. It uses the target database associated with the sensitive data model. After performing data discovery, you can use ListDiscoveryJobResults to view the discovery results, PatchDiscoveryJobResults to specify the action you want perform on these results, and then ApplyDiscoveryJobResults to process the results and apply them to the sensitive data model.

Parameters:

Options Hash (opts):

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

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

  • :opc_retry_token (String) —

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

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:



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
3866
3867
3868
3869
3870
3871
3872
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 3835

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

  raise "Missing the required parameter 'create_discovery_job_details' when calling create_discovery_job." if create_discovery_job_details.nil?

  path = '/discoveryJobs'
  operation_signing_strategy = :standard

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

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

  post_body = @api_client.object_to_http_body(create_discovery_job_details)

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

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

Note:

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

Creates a new library masking format. A masking format can have one or more format entries. The combined output of all the format entries is used for masking. It provides the flexibility to define a masking format that can generate different parts of a data value separately and then combine them to get the final data value for masking. Note that you cannot define masking condition in a library masking format.

Parameters:

Options Hash (opts):

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

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

  • :opc_retry_token (String) —

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

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:



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
3929
3930
3931
3932
3933
3934
3935
3936
3937
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 3900

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

  raise "Missing the required parameter 'create_library_masking_format_details' when calling create_library_masking_format." if create_library_masking_format_details.nil?

  path = '/libraryMaskingFormats'
  operation_signing_strategy = :standard

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

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

  post_body = @api_client.object_to_http_body(create_library_masking_format_details)

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

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

Note:

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

Creates a new masking column in the specified masking policy. Use this operation to add parent columns only. It automatically adds the child columns from the associated sensitive data model or target database. If you provide the sensitiveTypeId attribute but not the maskingFormats attribute, it automatically assigns the default masking format associated with the specified sensitive type. Alternatively, if you provide the maskingFormats attribute, the specified masking formats are assigned to the column.

Using the maskingFormats attribute, you can assign one or more masking formats to a column. You need to specify a condition as part of each masking format. It enables you to do <a href="conditional“>docs.oracle.com/en/cloud/paas/data-safe/udscs/conditional-masking.html">conditional masking</a> so that you can mask the column data values differently using different masking conditions. A masking format can have one or more format entries. The combined output of all the format entries is used for masking. It provides the flexibility to define a masking format that can generate different parts of a data value separately and then combine them to get the final data value for masking.

You can use the maskingColumnGroup attribute to group the columns that you would like to mask together. It enables you to do <a href="group“>docs.oracle.com/en/cloud/paas/data-safe/udscs/group-masking1.html#GUID-755056B9-9540-48C0-9491-262A44A85037">group or compound masking</a> that ensures that the masked data across the columns in a group continue to retain the same logical relationship.

Parameters:

  • create_masking_column_details (OCI::DataSafe::Models::CreateMaskingColumnDetails) —

    Details to create a new masking column.

  • masking_policy_id (String) —

    The OCID of the masking policy.

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

    the optional parameters

Options Hash (opts):

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

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

  • :opc_retry_token (String) —

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

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:

  • (Response) —

    A Response object with data of type nil



3981
3982
3983
3984
3985
3986
3987
3988
3989
3990
3991
3992
3993
3994
3995
3996
3997
3998
3999
4000
4001
4002
4003
4004
4005
4006
4007
4008
4009
4010
4011
4012
4013
4014
4015
4016
4017
4018
4019
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 3981

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

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

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

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

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

  post_body = @api_client.object_to_http_body(create_masking_column_details)

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

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

Note:

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

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

To use a sensitive data model as the source of masking columns, set the columnSource attribute to SENSITIVE_DATA_MODEL and provide the sensitiveDataModelId attribute. After creating a masking policy, you can use the AddMaskingColumnsFromSdm operation to automatically add all the columns from the associated sensitive data model. In this case, the target database associated with the sensitive data model is used for column and masking format validations.

You can also create a masking policy without using a sensitive data model. In this case, you need to associate your masking policy with a target database by setting the columnSource attribute to TARGET and providing the targetId attribute. The specified target database is used for column and masking format validations.

After creating a masking policy, you can use the CreateMaskingColumn or PatchMaskingColumns operation to manually add columns to the policy. You need to add the parent columns only, and it automatically adds the child columns (in referential relationship with the parent columns) from the associated sensitive data model or target database.

Parameters:

Options Hash (opts):

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

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

  • :opc_retry_token (String) —

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

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:



4059
4060
4061
4062
4063
4064
4065
4066
4067
4068
4069
4070
4071
4072
4073
4074
4075
4076
4077
4078
4079
4080
4081
4082
4083
4084
4085
4086
4087
4088
4089
4090
4091
4092
4093
4094
4095
4096
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 4059

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

  raise "Missing the required parameter 'create_masking_policy_details' when calling create_masking_policy." if create_masking_policy_details.nil?

  path = '/maskingPolicies'
  operation_signing_strategy = :standard

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

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

  post_body = @api_client.object_to_http_body(create_masking_policy_details)

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

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

Note:

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

Creates a new on-premises connector.

Parameters:

Options Hash (opts):

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

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

  • :opc_retry_token (String) —

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

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:



4120
4121
4122
4123
4124
4125
4126
4127
4128
4129
4130
4131
4132
4133
4134
4135
4136
4137
4138
4139
4140
4141
4142
4143
4144
4145
4146
4147
4148
4149
4150
4151
4152
4153
4154
4155
4156
4157
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 4120

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

  raise "Missing the required parameter 'create_on_prem_connector_details' when calling create_on_prem_connector." if create_on_prem_connector_details.nil?

  path = '/onPremConnectors'
  operation_signing_strategy = :standard

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

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

  post_body = @api_client.object_to_http_body(create_on_prem_connector_details)

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

#create_peer_target_database(target_database_id, create_peer_target_database_details, opts = {}) ⇒ Response

Note:

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

Creates the peer target database under the primary target database in Data Safe.

Parameters:

  • target_database_id (String) —

    The OCID of the Data Safe target database.

  • create_peer_target_database_details (OCI::DataSafe::Models::CreatePeerTargetDatabaseDetails) —

    Database details used to create the peer target database under the primary target database.

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

    the optional parameters

Options Hash (opts):

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

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

  • :if_match (String) —

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

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :opc_retry_token (String) —

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

Returns:



4187
4188
4189
4190
4191
4192
4193
4194
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
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 4187

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

  raise "Missing the required parameter 'target_database_id' when calling create_peer_target_database." if target_database_id.nil?
  raise "Missing the required parameter 'create_peer_target_database_details' when calling create_peer_target_database." if create_peer_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}/peerTargetDatabases'.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(create_peer_target_database_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#create_peer_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::PeerTargetDatabase'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_referential_relation(sensitive_data_model_id, create_referential_relation_details, opts = {}) ⇒ Response

Note:

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

Creates a new referential relation in the specified sensitive data model.

Parameters:

  • sensitive_data_model_id (String) —

    The OCID of the sensitive data model.

  • create_referential_relation_details (OCI::DataSafe::Models::CreateReferentialRelationDetails) —

    Details to create a new referential relation.

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

    the optional parameters

Options Hash (opts):

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

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

  • :opc_retry_token (String) —

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

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:

  • (Response) —

    A Response object with data of type nil



4252
4253
4254
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
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 4252

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

  raise "Missing the required parameter 'sensitive_data_model_id' when calling create_referential_relation." if sensitive_data_model_id.nil?
  raise "Missing the required parameter 'create_referential_relation_details' when calling create_referential_relation." if create_referential_relation_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}/referentialRelations'.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_referential_relation_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#create_referential_relation') 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_report_definition(create_report_definition_details, opts = {}) ⇒ Response

Note:

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

Creates a new report definition with parameters specified in the body. The report definition is stored in the specified compartment.

Parameters:

Options Hash (opts):

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

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

  • :opc_retry_token (String) —

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

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:



4314
4315
4316
4317
4318
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
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 4314

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

  raise "Missing the required parameter 'create_report_definition_details' when calling create_report_definition." if create_report_definition_details.nil?

  path = '/reportDefinitions'
  operation_signing_strategy = :standard

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

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

  post_body = @api_client.object_to_http_body(create_report_definition_details)

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

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

Note:

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

Creates SDM masking policy difference for the specified masking policy. It finds the difference between masking columns of the masking policy and sensitive columns of the SDM. After performing this operation, you can use ListDifferenceColumns to view the difference columns, PatchSdmMaskingPolicyDifferenceColumns to specify the action you want perform on these columns, and then ApplySdmMaskingPolicyDifference to process the difference columns and apply them to the masking policy.

Parameters:

Options Hash (opts):

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

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

  • :opc_retry_token (String) —

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

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:



4379
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
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 4379

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

  raise "Missing the required parameter 'create_sdm_masking_policy_difference_details' when calling create_sdm_masking_policy_difference." if create_sdm_masking_policy_difference_details.nil?

  path = '/sdmMaskingPolicyDifferences'
  operation_signing_strategy = :standard

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

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

  post_body = @api_client.object_to_http_body(create_sdm_masking_policy_difference_details)

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

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

Note:

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

Creates a new saved security assessment for a target database or target database group in a compartment. When this operation is performed, it will save the latest assessment in the specified compartment. If a schedule is passed, it will persist the latest assessment, at the defined date and time, in the format defined by RFC3339.

Parameters:

Options Hash (opts):

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

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

  • :opc_retry_token (String) —

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

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:



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
4479
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 4442

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

  raise "Missing the required parameter 'create_security_assessment_details' when calling create_security_assessment." if create_security_assessment_details.nil?

  path = '/securityAssessments'
  operation_signing_strategy = :standard

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

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

  post_body = @api_client.object_to_http_body(create_security_assessment_details)

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

#create_security_policy(create_security_policy_details, opts = {}) ⇒ Response

Note:

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

Creates a Data Safe security policy.

Parameters:

Options Hash (opts):

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

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

  • :opc_retry_token (String) —

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

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:



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
4539
4540
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 4503

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

  raise "Missing the required parameter 'create_security_policy_details' when calling create_security_policy." if create_security_policy_details.nil?

  path = '/securityPolicies'
  operation_signing_strategy = :standard

  # rubocop: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_policy_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#create_security_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::SecurityPolicy'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_security_policy_config(create_security_policy_config_details, opts = {}) ⇒ Response

Note:

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

Creates a new security policy configuration resource.

Parameters:

Options Hash (opts):

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

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

  • :opc_retry_token (String) —

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

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:



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
4599
4600
4601
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 4564

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

  raise "Missing the required parameter 'create_security_policy_config_details' when calling create_security_policy_config." if create_security_policy_config_details.nil?

  path = '/securityPolicyConfigs'
  operation_signing_strategy = :standard

  # rubocop: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_policy_config_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#create_security_policy_config') 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::SecurityPolicyConfig'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_security_policy_deployment(create_security_policy_deployment_details, opts = {}) ⇒ Response

Note:

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

Creates a Data Safe security policy deployment in the Data Safe Console.

Parameters:

Options Hash (opts):

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

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

  • :opc_retry_token (String) —

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

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:



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
4660
4661
4662
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 4625

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

  raise "Missing the required parameter 'create_security_policy_deployment_details' when calling create_security_policy_deployment." if create_security_policy_deployment_details.nil?

  path = '/securityPolicyDeployments'
  operation_signing_strategy = :standard

  # rubocop: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_policy_deployment_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#create_security_policy_deployment') 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::SecurityPolicyDeployment'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

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

Note:

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

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

Parameters:

  • sensitive_data_model_id (String) —

    The OCID of the sensitive data model.

  • create_sensitive_column_details (OCI::DataSafe::Models::CreateSensitiveColumnDetails) —

    Details to create a new sensitive column.

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

    the optional parameters

Options Hash (opts):

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

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

  • :opc_retry_token (String) —

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

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:

  • (Response) —

    A Response object with data of type nil



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
4720
4721
4722
4723
4724
4725
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 4687

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

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

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

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

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

  post_body = @api_client.object_to_http_body(create_sensitive_column_details)

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

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

Note:

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

Creates a new sensitive data model. If schemas and sensitive types are provided, it automatically runs data discovery and adds the discovered columns to the sensitive data model. Otherwise, it creates an empty sensitive data model that can be updated later.

Parameters:

Options Hash (opts):

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

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

  • :opc_retry_token (String) —

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

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:



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
4780
4781
4782
4783
4784
4785
4786
4787
4788
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 4751

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

  raise "Missing the required parameter 'create_sensitive_data_model_details' when calling create_sensitive_data_model." if create_sensitive_data_model_details.nil?

  path = '/sensitiveDataModels'
  operation_signing_strategy = :standard

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

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

  post_body = @api_client.object_to_http_body(create_sensitive_data_model_details)

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

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

Note:

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

Creates a new sensitive type, which can be a basic sensitive type with regular expressions or a sensitive category. While sensitive types are used for data discovery, sensitive categories are used for logically grouping the related or similar sensitive types.

Parameters:

Options Hash (opts):

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

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

  • :opc_retry_token (String) —

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

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:



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
4844
4845
4846
4847
4848
4849
4850
4851
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 4814

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

  raise "Missing the required parameter 'create_sensitive_type_details' when calling create_sensitive_type." if create_sensitive_type_details.nil?

  path = '/sensitiveTypes'
  operation_signing_strategy = :standard

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

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

  post_body = @api_client.object_to_http_body(create_sensitive_type_details)

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

#create_sensitive_type_group(create_sensitive_type_group_details, opts = {}) ⇒ Response

Note:

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

Creates a new sensitive type group.

Parameters:

Options Hash (opts):

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

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

  • :opc_retry_token (String) —

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

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:



4875
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
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 4875

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

  raise "Missing the required parameter 'create_sensitive_type_group_details' when calling create_sensitive_type_group." if create_sensitive_type_group_details.nil?

  path = '/sensitiveTypeGroups'
  operation_signing_strategy = :standard

  # rubocop: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_group_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#create_sensitive_type_group') 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::SensitiveTypeGroup'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_sensitive_types_export(create_sensitive_types_export_details, opts = {}) ⇒ Response

Note:

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

Generates a downloadable file corresponding to the specified list of sensitive types. It's a prerequisite for the DownloadSensitiveTypesExport operation. Use this endpoint to generate a sensitive Types Export file and then use DownloadSensitiveTypesExport to download the generated file.

Parameters:

Options Hash (opts):

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

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

  • :opc_retry_token (String) —

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

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:



4938
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
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 4938

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

  raise "Missing the required parameter 'create_sensitive_types_export_details' when calling create_sensitive_types_export." if create_sensitive_types_export_details.nil?

  path = '/sensitiveTypesExports'
  operation_signing_strategy = :standard

  # rubocop: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_types_export_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#create_sensitive_types_export') 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::SensitiveTypesExport'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

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

Note:

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

Creates a new SQL collection resource.

Parameters:

Options Hash (opts):

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

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

  • :opc_retry_token (String) —

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

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:



4999
5000
5001
5002
5003
5004
5005
5006
5007
5008
5009
5010
5011
5012
5013
5014
5015
5016
5017
5018
5019
5020
5021
5022
5023
5024
5025
5026
5027
5028
5029
5030
5031
5032
5033
5034
5035
5036
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 4999

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

  raise "Missing the required parameter 'create_sql_collection_details' when calling create_sql_collection." if create_sql_collection_details.nil?

  path = '/sqlCollections'
  operation_signing_strategy = :standard

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

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

  post_body = @api_client.object_to_http_body(create_sql_collection_details)

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

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

Note:

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

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

Parameters:

Options Hash (opts):

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

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

  • :opc_retry_token (String) —

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

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:



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
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 5060

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

  raise "Missing the required parameter 'create_target_alert_policy_association_details' when calling create_target_alert_policy_association." if create_target_alert_policy_association_details.nil?

  path = '/targetAlertPolicyAssociations'
  operation_signing_strategy = :standard

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

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

  post_body = @api_client.object_to_http_body(create_target_alert_policy_association_details)

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

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

Note:

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

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

Parameters:

Options Hash (opts):

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

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

  • :opc_retry_token (String) —

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

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:



5121
5122
5123
5124
5125
5126
5127
5128
5129
5130
5131
5132
5133
5134
5135
5136
5137
5138
5139
5140
5141
5142
5143
5144
5145
5146
5147
5148
5149
5150
5151
5152
5153
5154
5155
5156
5157
5158
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 5121

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

  raise "Missing the required parameter 'create_target_database_details' when calling create_target_database." if create_target_database_details.nil?

  path = '/targetDatabases'
  operation_signing_strategy = :standard

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

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

  post_body = @api_client.object_to_http_body(create_target_database_details)

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

#create_target_database_group(create_target_database_group_details, opts = {}) ⇒ Response

Note:

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

Creates a new target database group.

Parameters:

Options Hash (opts):

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

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

  • :opc_retry_token (String) —

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

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:



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
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 5182

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

  raise "Missing the required parameter 'create_target_database_group_details' when calling create_target_database_group." if create_target_database_group_details.nil?

  path = '/targetDatabaseGroups'
  operation_signing_strategy = :standard

  # rubocop: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_group_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#create_target_database_group') 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::TargetDatabaseGroup'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_unified_audit_policy(create_unified_audit_policy_details, opts = {}) ⇒ Response

Note:

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

Creates the specified unified audit policy.

Parameters:

Options Hash (opts):

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

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

  • :opc_retry_token (String) —

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

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:



5243
5244
5245
5246
5247
5248
5249
5250
5251
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
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 5243

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

  raise "Missing the required parameter 'create_unified_audit_policy_details' when calling create_unified_audit_policy." if create_unified_audit_policy_details.nil?

  path = '/unifiedAuditPolicies'
  operation_signing_strategy = :standard

  # rubocop: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_unified_audit_policy_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#create_unified_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,
      return_type: 'OCI::DataSafe::Models::UnifiedAuditPolicy'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

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

Note:

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

Creates a new saved user assessment for a target database or target database group in a compartment. It saves the latest assessment in the specified compartment. If a schedule is passed in, this operation persists the latest assessment that exists at the defined date and time, in the format defined by RFC3339.

Parameters:

Options Hash (opts):

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

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

  • :opc_retry_token (String) —

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

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:



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
5334
5335
5336
5337
5338
5339
5340
5341
5342
5343
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 5306

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

  raise "Missing the required parameter 'create_user_assessment_details' when calling create_user_assessment." if create_user_assessment_details.nil?

  path = '/userAssessments'
  operation_signing_strategy = :standard

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

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

  post_body = @api_client.object_to_http_body(create_user_assessment_details)

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

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

Note:

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

Deactivates a target database in Data Safe.

Parameters:

  • target_database_id (String) —

    The OCID of the Data Safe target database.

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

    the optional parameters

Options Hash (opts):

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

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

  • :opc_retry_token (String) —

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

  • :if_match (String) —

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

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:

  • (Response) —

    A Response object with data of type nil



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
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 5373

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

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

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

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

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

  post_body = nil

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

#delete_alert_policy(alert_policy_id, opts = {}) ⇒ Response

Note:

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

Deletes the specified user-defined alert policy.

Parameters:

  • alert_policy_id (String) —

    The OCID of the alert policy.

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

    the optional parameters

Options Hash (opts):

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

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

  • :if_match (String) —

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

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:

  • (Response) —

    A Response object with data of type nil



5435
5436
5437
5438
5439
5440
5441
5442
5443
5444
5445
5446
5447
5448
5449
5450
5451
5452
5453
5454
5455
5456
5457
5458
5459
5460
5461
5462
5463
5464
5465
5466
5467
5468
5469
5470
5471
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 5435

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

  raise "Missing the required parameter 'alert_policy_id' when calling delete_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[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#delete_alert_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_alert_policy_rule(alert_policy_id, rule_key, opts = {}) ⇒ Response

Note:

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

Deletes the specified user-defined alert policy rule.

Parameters:

  • alert_policy_id (String) —

    The OCID of the alert policy.

  • rule_key (String) —

    The key of the alert policy rule.

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

    the optional parameters

Options Hash (opts):

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

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

  • :if_match (String) —

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

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:

  • (Response) —

    A Response object with data of type nil



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
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 5496

def delete_alert_policy_rule(alert_policy_id, rule_key, opts = {})
  logger.debug 'Calling operation DataSafeClient#delete_alert_policy_rule.' if logger

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

  path = '/alertPolicies/{alertPolicyId}/rules/{ruleKey}'.sub('{alertPolicyId}', alert_policy_id.to_s).sub('{ruleKey}', rule_key.to_s)
  operation_signing_strategy = :standard

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

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

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#delete_alert_policy_rule') 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_attribute_set(attribute_set_id, opts = {}) ⇒ Response

Note:

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

Submits a work request to delete an attribute set.

Parameters:

  • attribute_set_id (String) —

    OCID of an attribute set.

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

    the optional parameters

Options Hash (opts):

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

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

  • :if_match (String) —

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

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:

  • (Response) —

    A Response object with data of type nil



5559
5560
5561
5562
5563
5564
5565
5566
5567
5568
5569
5570
5571
5572
5573
5574
5575
5576
5577
5578
5579
5580
5581
5582
5583
5584
5585
5586
5587
5588
5589
5590
5591
5592
5593
5594
5595
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 5559

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

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

  path = '/attributeSets/{attributeSetId}'.sub('{attributeSetId}', attribute_set_id.to_s)
  operation_signing_strategy = :standard

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

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

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#delete_attribute_set') 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_archive_retrieval(audit_archive_retrieval_id, opts = {}) ⇒ Response

Note:

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

To unload retrieved archive data, call the operation ListAuditArchiveRetrieval first. This will return the auditArchiveRetrievalId. Then call this operation with auditArchiveRetrievalId.

Parameters:

  • audit_archive_retrieval_id (String) —

    OCID of the archive retrieval.

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

    the optional parameters

Options Hash (opts):

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

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

  • :if_match (String) —

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

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:

  • (Response) —

    A Response object with data of type nil



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
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 5621

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

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

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

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

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

  post_body = nil

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

#delete_audit_profile(audit_profile_id, opts = {}) ⇒ Response

Note:

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

Deletes the specified audit profile. The audit profile delete operation is only supported for audit profiles with target type as TARGET_DATABASE_GROUP.

Parameters:

  • audit_profile_id (String) —

    The OCID of the audit.

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

    the optional parameters

Options Hash (opts):

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

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

  • :if_match (String) —

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

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:

  • (Response) —

    A Response object with data of type nil



5683
5684
5685
5686
5687
5688
5689
5690
5691
5692
5693
5694
5695
5696
5697
5698
5699
5700
5701
5702
5703
5704
5705
5706
5707
5708
5709
5710
5711
5712
5713
5714
5715
5716
5717
5718
5719
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 5683

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

  raise "Missing the required parameter 'audit_profile_id' when calling delete_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[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

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

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

Note:

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

Deletes the specified audit trail.

Parameters:

  • audit_trail_id (String) —

    The OCID of the audit trail.

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

    the optional parameters

Options Hash (opts):

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

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

  • :if_match (String) —

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

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:

  • (Response) —

    A Response object with data of type nil



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
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 5743

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

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

  path = '/auditTrails/{auditTrailId}'.sub('{auditTrailId}', audit_trail_id.to_s)
  operation_signing_strategy = :standard

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

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

  post_body = nil

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

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

Note:

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

Deletes the specified Data Safe private endpoint.

Parameters:

  • data_safe_private_endpoint_id (String) —

    The OCID of the private endpoint.

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

    the optional parameters

Options Hash (opts):

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

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:

  • (Response) —

    A Response object with data of type nil



5803
5804
5805
5806
5807
5808
5809
5810
5811
5812
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
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 5803

def delete_data_safe_private_endpoint(data_safe_private_endpoint_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#delete_data_safe_private_endpoint.' if logger

  raise "Missing the required parameter 'data_safe_private_endpoint_id' when calling delete_data_safe_private_endpoint." if data_safe_private_endpoint_id.nil?
  raise "Parameter value for 'data_safe_private_endpoint_id' must not be blank" if OCI::Internal::Util.blank_string?(data_safe_private_endpoint_id)

  path = '/dataSafePrivateEndpoints/{dataSafePrivateEndpointId}'.sub('{dataSafePrivateEndpointId}', data_safe_private_endpoint_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#delete_data_safe_private_endpoint') do
    @api_client.call_api(
      :DELETE,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#delete_discovery_job(discovery_job_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use delete_discovery_job API.

Deletes the specified discovery job.

Parameters:

  • discovery_job_id (String) —

    The OCID of the discovery job.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:

  • (Response) —

    A Response object with data of type nil



5863
5864
5865
5866
5867
5868
5869
5870
5871
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
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 5863

def delete_discovery_job(discovery_job_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#delete_discovery_job.' if logger

  raise "Missing the required parameter 'discovery_job_id' when calling delete_discovery_job." if discovery_job_id.nil?
  raise "Parameter value for 'discovery_job_id' must not be blank" if OCI::Internal::Util.blank_string?(discovery_job_id)

  path = '/discoveryJobs/{discoveryJobId}'.sub('{discoveryJobId}', discovery_job_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#delete_discovery_job') do
    @api_client.call_api(
      :DELETE,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#delete_discovery_job_result(discovery_job_id, result_key, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use delete_discovery_job_result API.

Deletes the specified discovery result.

Parameters:

  • discovery_job_id (String) —

    The OCID of the discovery job.

  • result_key (String) —

    The unique key that identifies the discovery result.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:

  • (Response) —

    A Response object with data of type nil



5924
5925
5926
5927
5928
5929
5930
5931
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
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 5924

def delete_discovery_job_result(discovery_job_id, result_key, opts = {})
  logger.debug 'Calling operation DataSafeClient#delete_discovery_job_result.' if logger

  raise "Missing the required parameter 'discovery_job_id' when calling delete_discovery_job_result." if discovery_job_id.nil?
  raise "Missing the required parameter 'result_key' when calling delete_discovery_job_result." if result_key.nil?
  raise "Parameter value for 'discovery_job_id' must not be blank" if OCI::Internal::Util.blank_string?(discovery_job_id)
  raise "Parameter value for 'result_key' must not be blank" if OCI::Internal::Util.blank_string?(result_key)

  path = '/discoveryJobs/{discoveryJobId}/results/{resultKey}'.sub('{discoveryJobId}', discovery_job_id.to_s).sub('{resultKey}', result_key.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#delete_discovery_job_result') do
    @api_client.call_api(
      :DELETE,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#delete_library_masking_format(library_masking_format_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use delete_library_masking_format API.

Deletes the specified library masking format.

Parameters:

  • library_masking_format_id (String) —

    The OCID of the library masking format.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:

  • (Response) —

    A Response object with data of type nil



5986
5987
5988
5989
5990
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
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 5986

def delete_library_masking_format(library_masking_format_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#delete_library_masking_format.' if logger

  raise "Missing the required parameter 'library_masking_format_id' when calling delete_library_masking_format." if library_masking_format_id.nil?
  raise "Parameter value for 'library_masking_format_id' must not be blank" if OCI::Internal::Util.blank_string?(library_masking_format_id)

  path = '/libraryMaskingFormats/{libraryMaskingFormatId}'.sub('{libraryMaskingFormatId}', library_masking_format_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#delete_library_masking_format') do
    @api_client.call_api(
      :DELETE,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#delete_masking_column(masking_column_key, masking_policy_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use delete_masking_column API.

Deletes the specified masking column.

Parameters:

  • masking_column_key (String) —

    The unique key that identifies the masking column. It's numeric and unique within a masking policy.

  • masking_policy_id (String) —

    The OCID of the masking policy.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:

  • (Response) —

    A Response object with data of type nil



6047
6048
6049
6050
6051
6052
6053
6054
6055
6056
6057
6058
6059
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
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 6047

def delete_masking_column(masking_column_key, masking_policy_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#delete_masking_column.' if logger

  raise "Missing the required parameter 'masking_column_key' when calling delete_masking_column." if masking_column_key.nil?
  raise "Missing the required parameter 'masking_policy_id' when calling delete_masking_column." if masking_policy_id.nil?
  raise "Parameter value for 'masking_column_key' must not be blank" if OCI::Internal::Util.blank_string?(masking_column_key)
  raise "Parameter value for 'masking_policy_id' must not be blank" if OCI::Internal::Util.blank_string?(masking_policy_id)

  path = '/maskingPolicies/{maskingPolicyId}/maskingColumns/{maskingColumnKey}'.sub('{maskingColumnKey}', masking_column_key.to_s).sub('{maskingPolicyId}', masking_policy_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#delete_masking_column') do
    @api_client.call_api(
      :DELETE,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#delete_masking_policy(masking_policy_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use delete_masking_policy API.

Deletes the specified masking policy.

Parameters:

  • masking_policy_id (String) —

    The OCID of the masking policy.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:

  • (Response) —

    A Response object with data of type nil



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
6145
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 6109

def delete_masking_policy(masking_policy_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#delete_masking_policy.' if logger

  raise "Missing the required parameter 'masking_policy_id' when calling delete_masking_policy." if masking_policy_id.nil?
  raise "Parameter value for 'masking_policy_id' must not be blank" if OCI::Internal::Util.blank_string?(masking_policy_id)

  path = '/maskingPolicies/{maskingPolicyId}'.sub('{maskingPolicyId}', masking_policy_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#delete_masking_policy') do
    @api_client.call_api(
      :DELETE,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#delete_masking_policy_health_report(masking_policy_health_report_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use delete_masking_policy_health_report API.

Deletes the specified masking policy health report.

Parameters:

  • masking_policy_health_report_id (String) —

    The OCID of the masking health report.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:

  • (Response) —

    A Response object with data of type nil



6169
6170
6171
6172
6173
6174
6175
6176
6177
6178
6179
6180
6181
6182
6183
6184
6185
6186
6187
6188
6189
6190
6191
6192
6193
6194
6195
6196
6197
6198
6199
6200
6201
6202
6203
6204
6205
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 6169

def delete_masking_policy_health_report(masking_policy_health_report_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#delete_masking_policy_health_report.' if logger

  raise "Missing the required parameter 'masking_policy_health_report_id' when calling delete_masking_policy_health_report." if masking_policy_health_report_id.nil?
  raise "Parameter value for 'masking_policy_health_report_id' must not be blank" if OCI::Internal::Util.blank_string?(masking_policy_health_report_id)

  path = '/maskingPolicyHealthReports/{maskingPolicyHealthReportId}'.sub('{maskingPolicyHealthReportId}', masking_policy_health_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]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#delete_masking_policy_health_report') 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_report(masking_report_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use delete_masking_report API.

Deletes the specified masking report.

Parameters:

  • masking_report_id (String) —

    The OCID of the masking report.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:

  • (Response) —

    A Response object with data of type nil



6229
6230
6231
6232
6233
6234
6235
6236
6237
6238
6239
6240
6241
6242
6243
6244
6245
6246
6247
6248
6249
6250
6251
6252
6253
6254
6255
6256
6257
6258
6259
6260
6261
6262
6263
6264
6265
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 6229

def delete_masking_report(masking_report_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#delete_masking_report.' if logger

  raise "Missing the required parameter 'masking_report_id' when calling delete_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[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#delete_masking_report') do
    @api_client.call_api(
      :DELETE,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#delete_on_prem_connector(on_prem_connector_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use delete_on_prem_connector API.

Deletes the specified on-premises connector.

Parameters:

  • on_prem_connector_id (String) —

    The OCID of the on-premises connector.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:

  • (Response) —

    A Response object with data of type nil



6289
6290
6291
6292
6293
6294
6295
6296
6297
6298
6299
6300
6301
6302
6303
6304
6305
6306
6307
6308
6309
6310
6311
6312
6313
6314
6315
6316
6317
6318
6319
6320
6321
6322
6323
6324
6325
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 6289

def delete_on_prem_connector(on_prem_connector_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#delete_on_prem_connector.' if logger

  raise "Missing the required parameter 'on_prem_connector_id' when calling delete_on_prem_connector." if on_prem_connector_id.nil?
  raise "Parameter value for 'on_prem_connector_id' must not be blank" if OCI::Internal::Util.blank_string?(on_prem_connector_id)

  path = '/onPremConnectors/{onPremConnectorId}'.sub('{onPremConnectorId}', on_prem_connector_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#delete_on_prem_connector') do
    @api_client.call_api(
      :DELETE,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#delete_peer_target_database(target_database_id, peer_target_database_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use delete_peer_target_database API.

Removes the specified peer target database from Data Safe.

Parameters:

  • target_database_id (String) —

    The OCID of the Data Safe target database.

  • peer_target_database_id (Integer) —

    The unique id of the peer target database.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:

  • (Response) —

    A Response object with data of type nil



6350
6351
6352
6353
6354
6355
6356
6357
6358
6359
6360
6361
6362
6363
6364
6365
6366
6367
6368
6369
6370
6371
6372
6373
6374
6375
6376
6377
6378
6379
6380
6381
6382
6383
6384
6385
6386
6387
6388
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 6350

def delete_peer_target_database(target_database_id, peer_target_database_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#delete_peer_target_database.' if logger

  raise "Missing the required parameter 'target_database_id' when calling delete_peer_target_database." if target_database_id.nil?
  raise "Missing the required parameter 'peer_target_database_id' when calling delete_peer_target_database." if peer_target_database_id.nil?
  raise "Parameter value for 'target_database_id' must not be blank" if OCI::Internal::Util.blank_string?(target_database_id)
  raise "Parameter value for 'peer_target_database_id' must not be blank" if OCI::Internal::Util.blank_string?(peer_target_database_id)

  path = '/targetDatabases/{targetDatabaseId}/peerTargetDatabases/{peerTargetDatabaseId}'.sub('{targetDatabaseId}', target_database_id.to_s).sub('{peerTargetDatabaseId}', peer_target_database_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#delete_peer_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_referential_relation(sensitive_data_model_id, referential_relation_key, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use delete_referential_relation API.

Deletes the specified referential relation.

Parameters:

  • sensitive_data_model_id (String) —

    The OCID of the sensitive data model.

  • referential_relation_key (String) —

    The unique key that identifies the referential relation. It's numeric and unique within a sensitive data model.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:

  • (Response) —

    A Response object with data of type nil



6414
6415
6416
6417
6418
6419
6420
6421
6422
6423
6424
6425
6426
6427
6428
6429
6430
6431
6432
6433
6434
6435
6436
6437
6438
6439
6440
6441
6442
6443
6444
6445
6446
6447
6448
6449
6450
6451
6452
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 6414

def delete_referential_relation(sensitive_data_model_id, referential_relation_key, opts = {})
  logger.debug 'Calling operation DataSafeClient#delete_referential_relation.' if logger

  raise "Missing the required parameter 'sensitive_data_model_id' when calling delete_referential_relation." if sensitive_data_model_id.nil?
  raise "Missing the required parameter 'referential_relation_key' when calling delete_referential_relation." if referential_relation_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 'referential_relation_key' must not be blank" if OCI::Internal::Util.blank_string?(referential_relation_key)

  path = '/sensitiveDataModels/{sensitiveDataModelId}/referentialRelations/{referentialRelationKey}'.sub('{sensitiveDataModelId}', sensitive_data_model_id.to_s).sub('{referentialRelationKey}', referential_relation_key.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#delete_referential_relation') do
    @api_client.call_api(
      :DELETE,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#delete_report_definition(report_definition_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use delete_report_definition API.

Deletes the specified report definition. Only the user created report definition can be deleted. The seeded report definitions cannot be deleted.

Parameters:

  • report_definition_id (String) —

    Unique report definition identifier

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:

  • (Response) —

    A Response object with data of type nil



6476
6477
6478
6479
6480
6481
6482
6483
6484
6485
6486
6487
6488
6489
6490
6491
6492
6493
6494
6495
6496
6497
6498
6499
6500
6501
6502
6503
6504
6505
6506
6507
6508
6509
6510
6511
6512
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 6476

def delete_report_definition(report_definition_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#delete_report_definition.' if logger

  raise "Missing the required parameter 'report_definition_id' when calling delete_report_definition." if report_definition_id.nil?
  raise "Parameter value for 'report_definition_id' must not be blank" if OCI::Internal::Util.blank_string?(report_definition_id)

  path = '/reportDefinitions/{reportDefinitionId}'.sub('{reportDefinitionId}', report_definition_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#delete_report_definition') do
    @api_client.call_api(
      :DELETE,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#delete_sdm_masking_policy_difference(sdm_masking_policy_difference_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use delete_sdm_masking_policy_difference API.

Deletes the specified SDM Masking policy difference.

Parameters:

  • sdm_masking_policy_difference_id (String) —

    The OCID of the SDM masking policy difference.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:

  • (Response) —

    A Response object with data of type nil



6536
6537
6538
6539
6540
6541
6542
6543
6544
6545
6546
6547
6548
6549
6550
6551
6552
6553
6554
6555
6556
6557
6558
6559
6560
6561
6562
6563
6564
6565
6566
6567
6568
6569
6570
6571
6572
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 6536

def delete_sdm_masking_policy_difference(sdm_masking_policy_difference_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#delete_sdm_masking_policy_difference.' if logger

  raise "Missing the required parameter 'sdm_masking_policy_difference_id' when calling delete_sdm_masking_policy_difference." if sdm_masking_policy_difference_id.nil?
  raise "Parameter value for 'sdm_masking_policy_difference_id' must not be blank" if OCI::Internal::Util.blank_string?(sdm_masking_policy_difference_id)

  path = '/sdmMaskingPolicyDifferences/{sdmMaskingPolicyDifferenceId}'.sub('{sdmMaskingPolicyDifferenceId}', sdm_masking_policy_difference_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#delete_sdm_masking_policy_difference') do
    @api_client.call_api(
      :DELETE,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#delete_security_assessment(security_assessment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use delete_security_assessment API.

Deletes the specified saved security assessment or schedule. To delete a security assessment schedule, first call the operation ListSecurityAssessments with filters "type = save_schedule". That operation returns the scheduleAssessmentId. Then, call DeleteSecurityAssessment with the scheduleAssessmentId. If the assessment being deleted is the baseline for that compartment, then it will impact all baselines in the compartment.

Parameters:

  • security_assessment_id (String) —

    The OCID of the security assessment.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

Returns:

  • (Response) —

    A Response object with data of type nil



6600
6601
6602
6603
6604
6605
6606
6607
6608
6609
6610
6611
6612
6613
6614
6615
6616
6617
6618
6619
6620
6621
6622
6623
6624
6625
6626
6627
6628
6629
6630
6631
6632
6633
6634
6635
6636
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 6600

def delete_security_assessment(security_assessment_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#delete_security_assessment.' if logger

  raise "Missing the required parameter 'security_assessment_id' when calling delete_security_assessment." if security_assessment_id.nil?
  raise "Parameter value for 'security_assessment_id' must not be blank" if OCI::Internal::Util.blank_string?(security_assessment_id)

  path = '/securityAssessments/{securityAssessmentId}'.sub('{securityAssessmentId}', security_assessment_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#delete_security_assessment') do
    @api_client.call_api(
      :DELETE,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#delete_security_policy(security_policy_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use delete_security_policy API.

Deletes the specified security policy.

Parameters:

  • security_policy_id (String) —

    The OCID of the security policy resource.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:

  • (Response) —

    A Response object with data of type nil



6660
6661
6662
6663
6664
6665
6666
6667
6668
6669
6670
6671
6672
6673
6674
6675
6676
6677
6678
6679
6680
6681
6682
6683
6684
6685
6686
6687
6688
6689
6690
6691
6692
6693
6694
6695
6696
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 6660

def delete_security_policy(security_policy_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#delete_security_policy.' if logger

  raise "Missing the required parameter 'security_policy_id' when calling delete_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[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#delete_security_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_security_policy_config(security_policy_config_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use delete_security_policy_config API.

Deletes the specified Security policy configuration.

Parameters:

  • security_policy_config_id (String) —

    The OCID of the security policy configuration resource.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:

  • (Response) —

    A Response object with data of type nil



6720
6721
6722
6723
6724
6725
6726
6727
6728
6729
6730
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
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 6720

def delete_security_policy_config(security_policy_config_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#delete_security_policy_config.' if logger

  raise "Missing the required parameter 'security_policy_config_id' when calling delete_security_policy_config." if security_policy_config_id.nil?
  raise "Parameter value for 'security_policy_config_id' must not be blank" if OCI::Internal::Util.blank_string?(security_policy_config_id)

  path = '/securityPolicyConfigs/{securityPolicyConfigId}'.sub('{securityPolicyConfigId}', security_policy_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 = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#delete_security_policy_config') 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_policy_deployment(security_policy_deployment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use delete_security_policy_deployment API.

Deletes the specified Security policy deployment.

Parameters:

  • security_policy_deployment_id (String) —

    The OCID of the security policy deployment resource.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:

  • (Response) —

    A Response object with data of type nil



6780
6781
6782
6783
6784
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
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 6780

def delete_security_policy_deployment(security_policy_deployment_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#delete_security_policy_deployment.' if logger

  raise "Missing the required parameter 'security_policy_deployment_id' when calling delete_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[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#delete_security_policy_deployment') do
    @api_client.call_api(
      :DELETE,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#delete_sensitive_column(sensitive_data_model_id, sensitive_column_key, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use delete_sensitive_column API.

Deletes the specified sensitive column.

Parameters:

  • sensitive_data_model_id (String) —

    The OCID of the sensitive data model.

  • sensitive_column_key (String) —

    The unique key that identifies the sensitive column. It's numeric and unique within a sensitive data model.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:

  • (Response) —

    A Response object with data of type nil



6841
6842
6843
6844
6845
6846
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
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 6841

def delete_sensitive_column(sensitive_data_model_id, sensitive_column_key, opts = {})
  logger.debug 'Calling operation DataSafeClient#delete_sensitive_column.' if logger

  raise "Missing the required parameter 'sensitive_data_model_id' when calling delete_sensitive_column." if sensitive_data_model_id.nil?
  raise "Missing the required parameter 'sensitive_column_key' when calling delete_sensitive_column." if sensitive_column_key.nil?
  raise "Parameter value for 'sensitive_data_model_id' must not be blank" if OCI::Internal::Util.blank_string?(sensitive_data_model_id)
  raise "Parameter value for 'sensitive_column_key' must not be blank" if OCI::Internal::Util.blank_string?(sensitive_column_key)

  path = '/sensitiveDataModels/{sensitiveDataModelId}/sensitiveColumns/{sensitiveColumnKey}'.sub('{sensitiveDataModelId}', sensitive_data_model_id.to_s).sub('{sensitiveColumnKey}', sensitive_column_key.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#delete_sensitive_column') do
    @api_client.call_api(
      :DELETE,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#delete_sensitive_data_model(sensitive_data_model_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use delete_sensitive_data_model API.

Deletes the specified sensitive data model.

Parameters:

  • sensitive_data_model_id (String) —

    The OCID of the sensitive data model.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:

  • (Response) —

    A Response object with data of type nil



6903
6904
6905
6906
6907
6908
6909
6910
6911
6912
6913
6914
6915
6916
6917
6918
6919
6920
6921
6922
6923
6924
6925
6926
6927
6928
6929
6930
6931
6932
6933
6934
6935
6936
6937
6938
6939
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 6903

def delete_sensitive_data_model(sensitive_data_model_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#delete_sensitive_data_model.' if logger

  raise "Missing the required parameter 'sensitive_data_model_id' when calling delete_sensitive_data_model." if sensitive_data_model_id.nil?
  raise "Parameter value for 'sensitive_data_model_id' must not be blank" if OCI::Internal::Util.blank_string?(sensitive_data_model_id)

  path = '/sensitiveDataModels/{sensitiveDataModelId}'.sub('{sensitiveDataModelId}', sensitive_data_model_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#delete_sensitive_data_model') do
    @api_client.call_api(
      :DELETE,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#delete_sensitive_type(sensitive_type_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use delete_sensitive_type API.

Deletes the specified sensitive type.

Parameters:

  • sensitive_type_id (String) —

    The OCID of the sensitive type.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:

  • (Response) —

    A Response object with data of type nil



6963
6964
6965
6966
6967
6968
6969
6970
6971
6972
6973
6974
6975
6976
6977
6978
6979
6980
6981
6982
6983
6984
6985
6986
6987
6988
6989
6990
6991
6992
6993
6994
6995
6996
6997
6998
6999
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 6963

def delete_sensitive_type(sensitive_type_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#delete_sensitive_type.' if logger

  raise "Missing the required parameter 'sensitive_type_id' when calling delete_sensitive_type." if sensitive_type_id.nil?
  raise "Parameter value for 'sensitive_type_id' must not be blank" if OCI::Internal::Util.blank_string?(sensitive_type_id)

  path = '/sensitiveTypes/{sensitiveTypeId}'.sub('{sensitiveTypeId}', sensitive_type_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#delete_sensitive_type') do
    @api_client.call_api(
      :DELETE,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#delete_sensitive_type_group(sensitive_type_group_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use delete_sensitive_type_group API.

Deletes the specified sensitive type group.

Parameters:

  • sensitive_type_group_id (String) —

    The OCID of the sensitive type group.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:

  • (Response) —

    A Response object with data of type nil



7023
7024
7025
7026
7027
7028
7029
7030
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
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 7023

def delete_sensitive_type_group(sensitive_type_group_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#delete_sensitive_type_group.' if logger

  raise "Missing the required parameter 'sensitive_type_group_id' when calling delete_sensitive_type_group." if sensitive_type_group_id.nil?
  raise "Parameter value for 'sensitive_type_group_id' must not be blank" if OCI::Internal::Util.blank_string?(sensitive_type_group_id)

  path = '/sensitiveTypeGroups/{sensitiveTypeGroupId}'.sub('{sensitiveTypeGroupId}', sensitive_type_group_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#delete_sensitive_type_group') 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_types_export(sensitive_types_export_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use delete_sensitive_types_export API.

Deletes the specified sensitive types export.

Parameters:

  • sensitive_types_export_id (String) —

    The OCID of the sensitive types export.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:

  • (Response) —

    A Response object with data of type nil



7083
7084
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
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 7083

def delete_sensitive_types_export(sensitive_types_export_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#delete_sensitive_types_export.' if logger

  raise "Missing the required parameter 'sensitive_types_export_id' when calling delete_sensitive_types_export." if sensitive_types_export_id.nil?
  raise "Parameter value for 'sensitive_types_export_id' must not be blank" if OCI::Internal::Util.blank_string?(sensitive_types_export_id)

  path = '/sensitiveTypesExports/{sensitiveTypesExportId}'.sub('{sensitiveTypesExportId}', sensitive_types_export_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#delete_sensitive_types_export') do
    @api_client.call_api(
      :DELETE,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#delete_sql_collection(sql_collection_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use delete_sql_collection API.

Deletes the specified SQL collection.

Parameters:

  • sql_collection_id (String) —

    The OCID of the SQL collection resource.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:

  • (Response) —

    A Response object with data of type nil



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
7179
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 7143

def delete_sql_collection(sql_collection_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#delete_sql_collection.' if logger

  raise "Missing the required parameter 'sql_collection_id' when calling delete_sql_collection." if sql_collection_id.nil?
  raise "Parameter value for 'sql_collection_id' must not be blank" if OCI::Internal::Util.blank_string?(sql_collection_id)

  path = '/sqlCollections/{sqlCollectionId}'.sub('{sqlCollectionId}', sql_collection_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#delete_sql_collection') do
    @api_client.call_api(
      :DELETE,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#delete_sql_firewall_allowed_sql(sql_firewall_allowed_sql_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use delete_sql_firewall_allowed_sql API.

Deletes the specified allowed sql.

Parameters:

  • sql_firewall_allowed_sql_id (String) —

    The OCID of the sqlFirewallAllowedSql resource.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:

  • (Response) —

    A Response object with data of type nil



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
7233
7234
7235
7236
7237
7238
7239
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 7203

def delete_sql_firewall_allowed_sql(sql_firewall_allowed_sql_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#delete_sql_firewall_allowed_sql.' if logger

  raise "Missing the required parameter 'sql_firewall_allowed_sql_id' when calling delete_sql_firewall_allowed_sql." if sql_firewall_allowed_sql_id.nil?
  raise "Parameter value for 'sql_firewall_allowed_sql_id' must not be blank" if OCI::Internal::Util.blank_string?(sql_firewall_allowed_sql_id)

  path = '/sqlFirewallAllowedSqls/{sqlFirewallAllowedSqlId}'.sub('{sqlFirewallAllowedSqlId}', sql_firewall_allowed_sql_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#delete_sql_firewall_allowed_sql') do
    @api_client.call_api(
      :DELETE,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#delete_sql_firewall_policy(sql_firewall_policy_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use delete_sql_firewall_policy API.

Deletes the SQL Firewall policy resource.

Parameters:

  • sql_firewall_policy_id (String) —

    The OCID of the SQL Firewall policy resource.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:

  • (Response) —

    A Response object with data of type nil



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
7290
7291
7292
7293
7294
7295
7296
7297
7298
7299
7300
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 7264

def delete_sql_firewall_policy(sql_firewall_policy_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#delete_sql_firewall_policy.' if logger

  raise "Missing the required parameter 'sql_firewall_policy_id' when calling delete_sql_firewall_policy." if sql_firewall_policy_id.nil?
  raise "Parameter value for 'sql_firewall_policy_id' must not be blank" if OCI::Internal::Util.blank_string?(sql_firewall_policy_id)

  path = '/sqlFirewallPolicies/{sqlFirewallPolicyId}'.sub('{sqlFirewallPolicyId}', sql_firewall_policy_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#delete_sql_firewall_policy') do
    @api_client.call_api(
      :DELETE,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#delete_target_alert_policy_association(target_alert_policy_association_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use delete_target_alert_policy_association API.

Deletes the specified target-alert policy Association.

Parameters:

  • target_alert_policy_association_id (String) —

    The OCID of the target-alert policy association.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:

  • (Response) —

    A Response object with data of type nil



7324
7325
7326
7327
7328
7329
7330
7331
7332
7333
7334
7335
7336
7337
7338
7339
7340
7341
7342
7343
7344
7345
7346
7347
7348
7349
7350
7351
7352
7353
7354
7355
7356
7357
7358
7359
7360
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 7324

def delete_target_alert_policy_association(target_alert_policy_association_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#delete_target_alert_policy_association.' if logger

  raise "Missing the required parameter 'target_alert_policy_association_id' when calling delete_target_alert_policy_association." if target_alert_policy_association_id.nil?
  raise "Parameter value for 'target_alert_policy_association_id' must not be blank" if OCI::Internal::Util.blank_string?(target_alert_policy_association_id)

  path = '/targetAlertPolicyAssociations/{targetAlertPolicyAssociationId}'.sub('{targetAlertPolicyAssociationId}', target_alert_policy_association_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#delete_target_alert_policy_association') do
    @api_client.call_api(
      :DELETE,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#delete_target_database(target_database_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use delete_target_database API.

Deregisters the specified database from Data Safe and removes the target database from the Data Safe Console.

Parameters:

  • target_database_id (String) —

    The OCID of the Data Safe target database.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:

  • (Response) —

    A Response object with data of type nil



7384
7385
7386
7387
7388
7389
7390
7391
7392
7393
7394
7395
7396
7397
7398
7399
7400
7401
7402
7403
7404
7405
7406
7407
7408
7409
7410
7411
7412
7413
7414
7415
7416
7417
7418
7419
7420
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 7384

def delete_target_database(target_database_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#delete_target_database.' if logger

  raise "Missing the required parameter 'target_database_id' when calling delete_target_database." if target_database_id.nil?
  raise "Parameter value for 'target_database_id' must not be blank" if OCI::Internal::Util.blank_string?(target_database_id)

  path = '/targetDatabases/{targetDatabaseId}'.sub('{targetDatabaseId}', target_database_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#delete_target_database') do
    @api_client.call_api(
      :DELETE,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#delete_target_database_group(target_database_group_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use delete_target_database_group API.

Deletes the specified target database group.

Parameters:

  • target_database_group_id (String) —

    The OCID of the specified target database group.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:

  • (Response) —

    A Response object with data of type nil



7444
7445
7446
7447
7448
7449
7450
7451
7452
7453
7454
7455
7456
7457
7458
7459
7460
7461
7462
7463
7464
7465
7466
7467
7468
7469
7470
7471
7472
7473
7474
7475
7476
7477
7478
7479
7480
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 7444

def delete_target_database_group(target_database_group_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#delete_target_database_group.' if logger

  raise "Missing the required parameter 'target_database_group_id' when calling delete_target_database_group." if target_database_group_id.nil?
  raise "Parameter value for 'target_database_group_id' must not be blank" if OCI::Internal::Util.blank_string?(target_database_group_id)

  path = '/targetDatabaseGroups/{targetDatabaseGroupId}'.sub('{targetDatabaseGroupId}', target_database_group_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#delete_target_database_group') 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_unified_audit_policy(unified_audit_policy_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use delete_unified_audit_policy API.

Deletes the Unified Audit policy resource.

Parameters:

  • unified_audit_policy_id (String) —

    The OCID of the Unified Audit policy resource.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:

  • (Response) —

    A Response object with data of type nil



7505
7506
7507
7508
7509
7510
7511
7512
7513
7514
7515
7516
7517
7518
7519
7520
7521
7522
7523
7524
7525
7526
7527
7528
7529
7530
7531
7532
7533
7534
7535
7536
7537
7538
7539
7540
7541
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 7505

def delete_unified_audit_policy(unified_audit_policy_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#delete_unified_audit_policy.' if logger

  raise "Missing the required parameter 'unified_audit_policy_id' when calling delete_unified_audit_policy." if unified_audit_policy_id.nil?
  raise "Parameter value for 'unified_audit_policy_id' must not be blank" if OCI::Internal::Util.blank_string?(unified_audit_policy_id)

  path = '/unifiedAuditPolicies/{unifiedAuditPolicyId}'.sub('{unifiedAuditPolicyId}', unified_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 = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#delete_unified_audit_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_unified_audit_policy_definition(unified_audit_policy_definition_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use delete_unified_audit_policy_definition API.

Deletes the specified Unified audit policy definition.

Parameters:

  • unified_audit_policy_definition_id (String) —

    The OCID of the unified audit policy definition resource.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:

  • (Response) —

    A Response object with data of type nil



7565
7566
7567
7568
7569
7570
7571
7572
7573
7574
7575
7576
7577
7578
7579
7580
7581
7582
7583
7584
7585
7586
7587
7588
7589
7590
7591
7592
7593
7594
7595
7596
7597
7598
7599
7600
7601
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 7565

def delete_unified_audit_policy_definition(unified_audit_policy_definition_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#delete_unified_audit_policy_definition.' if logger

  raise "Missing the required parameter 'unified_audit_policy_definition_id' when calling delete_unified_audit_policy_definition." if unified_audit_policy_definition_id.nil?
  raise "Parameter value for 'unified_audit_policy_definition_id' must not be blank" if OCI::Internal::Util.blank_string?(unified_audit_policy_definition_id)

  path = '/unifiedAuditPolicyDefinitions/{unifiedAuditPolicyDefinitionId}'.sub('{unifiedAuditPolicyDefinitionId}', unified_audit_policy_definition_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#delete_unified_audit_policy_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_user_assessment(user_assessment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use delete_user_assessment API.

Deletes the specified saved user assessment or schedule. To delete a user assessment schedule, first call the operation ListUserAssessments with filters "type = save_schedule". That call returns the scheduleAssessmentId. Then call DeleteUserAssessment with the scheduleAssessmentId. If the assessment being deleted is the baseline for that compartment, then it will impact all baselines in the compartment.

Parameters:

  • user_assessment_id (String) —

    The OCID of the user assessment.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:

  • (Response) —

    A Response object with data of type nil



7629
7630
7631
7632
7633
7634
7635
7636
7637
7638
7639
7640
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
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 7629

def delete_user_assessment(user_assessment_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#delete_user_assessment.' if logger

  raise "Missing the required parameter 'user_assessment_id' when calling delete_user_assessment." if user_assessment_id.nil?
  raise "Parameter value for 'user_assessment_id' must not be blank" if OCI::Internal::Util.blank_string?(user_assessment_id)

  path = '/userAssessments/{userAssessmentId}'.sub('{userAssessmentId}', user_assessment_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#delete_user_assessment') do
    @api_client.call_api(
      :DELETE,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#deploy_security_policy_deployment(security_policy_deployment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use deploy_security_policy_deployment API.

Deploy the security policy to the specified target or target groups.

Parameters:

  • security_policy_deployment_id (String) —

    The OCID of the security policy deployment resource.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

Returns:

  • (Response) —

    A Response object with data of type nil



7694
7695
7696
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
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 7694

def deploy_security_policy_deployment(security_policy_deployment_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#deploy_security_policy_deployment.' if logger

  raise "Missing the required parameter 'security_policy_deployment_id' when calling deploy_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}/actions/deploy'.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 = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#deploy_security_policy_deployment') 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

#discover_audit_trails(audit_profile_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use discover_audit_trails API.

Updates the list of audit trails created under audit profile.The operation can be used to create new audit trails for target database when they become available for audit collection because of change of database version or change of database unified mode or change of data base edition or being deleted previously etc.

Parameters:

  • audit_profile_id (String) —

    The OCID of the audit.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

Returns:

  • (Response) —

    A Response object with data of type nil



7765
7766
7767
7768
7769
7770
7771
7772
7773
7774
7775
7776
7777
7778
7779
7780
7781
7782
7783
7784
7785
7786
7787
7788
7789
7790
7791
7792
7793
7794
7795
7796
7797
7798
7799
7800
7801
7802
7803
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 7765

def discover_audit_trails(audit_profile_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#discover_audit_trails.' if logger

  raise "Missing the required parameter 'audit_profile_id' when calling discover_audit_trails." if audit_profile_id.nil?
  raise "Parameter value for 'audit_profile_id' must not be blank" if OCI::Internal::Util.blank_string?(audit_profile_id)

  path = '/auditProfiles/{auditProfileId}/actions/discoverAuditTrails'.sub('{auditProfileId}', audit_profile_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#discover_audit_trails') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#download_discovery_report(sensitive_data_model_id, download_discovery_report_details, opts = {}, &block) ⇒ Response

Note:

Click here to see an example of how to use download_discovery_report API.

Downloads an already-generated discovery report. Note that the GenerateDiscoveryReportForDownload operation is a prerequisite for the DownloadDiscoveryReport operation. Use GenerateDiscoveryReportForDownload to generate a discovery report file and then use DownloadDiscoveryReport to download the generated file. By default, it downloads report for all the columns in a sensitive data model. Use the discoveryJobId attribute to download report for a specific discovery job.

Parameters:

  • sensitive_data_model_id (String) —

    The OCID of the sensitive data model.

  • download_discovery_report_details (OCI::DataSafe::Models::DownloadDiscoveryReportDetails) —

    Details to download a discovery report.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

  • [Block] (Hash) —

    a customizable set of options

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :response_target (String, IO) —

    Streaming http body into a file (specified by file name or File object) or IO object if the block is not given

Returns:

  • (Response) —

    A Response object with data of type String if response_target and block are not given, otherwise with nil data



7828
7829
7830
7831
7832
7833
7834
7835
7836
7837
7838
7839
7840
7841
7842
7843
7844
7845
7846
7847
7848
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
7886
7887
7888
7889
7890
7891
7892
7893
7894
7895
7896
7897
7898
7899
7900
7901
7902
7903
7904
7905
7906
7907
7908
7909
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 7828

def download_discovery_report(sensitive_data_model_id, download_discovery_report_details, opts = {}, &block)
  logger.debug 'Calling operation DataSafeClient#download_discovery_report.' if logger

  raise "Missing the required parameter 'sensitive_data_model_id' when calling download_discovery_report." if sensitive_data_model_id.nil?
  raise "Missing the required parameter 'download_discovery_report_details' when calling download_discovery_report." if download_discovery_report_details.nil?
  raise "Parameter value for 'sensitive_data_model_id' must not be blank" if OCI::Internal::Util.blank_string?(sensitive_data_model_id)

  path = '/sensitiveDataModels/{sensitiveDataModelId}/actions/downloadReport'.sub('{sensitiveDataModelId}', sensitive_data_model_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = opts[:accept] if opts[:accept]
  header_params[:accept] ||= 'application/json'
  header_params[:'accept-encoding'] = opts[:accept_encoding] if opts[:accept_encoding]
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(download_discovery_report_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#download_discovery_report') do
    if !block.nil?
      @api_client.call_api(
        :POST,
        path,
        endpoint,
        header_params: header_params,
        query_params: query_params,
        operation_signing_strategy: operation_signing_strategy,
        body: post_body,
        return_type: 'Stream',
        &block
      )
    elsif opts[:response_target]
      if opts[:response_target].respond_to? :write
        @api_client.call_api(
          :POST,
          path,
          endpoint,
          header_params: header_params,
          query_params: query_params,
          operation_signing_strategy: operation_signing_strategy,
          body: post_body,
          return_type: 'Stream',
          &proc { |chunk, _response| opts[:response_target].write(chunk) }
        )
      elsif opts[:response_target].is_a?(String)
        File.open(opts[:response_target], 'wb') do |output|
          return @api_client.call_api(
            :POST,
            path,
            endpoint,
            header_params: header_params,
            query_params: query_params,
            operation_signing_strategy: operation_signing_strategy,
            body: post_body,
            return_type: 'Stream',
            &proc { |chunk, _response| output.write(chunk) }
          )
        end
      end
    else
      @api_client.call_api(
        :POST,
        path,
        endpoint,
        header_params: header_params,
        query_params: query_params,
        operation_signing_strategy: operation_signing_strategy,
        body: post_body,
        return_type: 'String'
      )
    end
  end
  # rubocop:enable Metrics/BlockLength
end

#download_masking_log(masking_policy_id, download_masking_log_details, opts = {}, &block) ⇒ Response

Note:

Click here to see an example of how to use download_masking_log API.

Downloads the masking log generated by the last masking operation on a target database using the specified masking policy.

Parameters:

  • masking_policy_id (String) —

    The OCID of the masking policy.

  • download_masking_log_details (OCI::DataSafe::Models::DownloadMaskingLogDetails) —

    Details to download masking log.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

  • [Block] (Hash) —

    a customizable set of options

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :response_target (String, IO) —

    Streaming http body into a file (specified by file name or File object) or IO object if the block is not given

Returns:

  • (Response) —

    A Response object with data of type String if response_target and block are not given, otherwise with nil data



7930
7931
7932
7933
7934
7935
7936
7937
7938
7939
7940
7941
7942
7943
7944
7945
7946
7947
7948
7949
7950
7951
7952
7953
7954
7955
7956
7957
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
7997
7998
7999
8000
8001
8002
8003
8004
8005
8006
8007
8008
8009
8010
8011
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 7930

def download_masking_log(masking_policy_id, download_masking_log_details, opts = {}, &block)
  logger.debug 'Calling operation DataSafeClient#download_masking_log.' if logger

  raise "Missing the required parameter 'masking_policy_id' when calling download_masking_log." if masking_policy_id.nil?
  raise "Missing the required parameter 'download_masking_log_details' when calling download_masking_log." if download_masking_log_details.nil?
  raise "Parameter value for 'masking_policy_id' must not be blank" if OCI::Internal::Util.blank_string?(masking_policy_id)

  path = '/maskingPolicies/{maskingPolicyId}/actions/downloadLog'.sub('{maskingPolicyId}', masking_policy_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = opts[:accept] if opts[:accept]
  header_params[:accept] ||= 'application/octet-stream'
  header_params[:'accept-encoding'] = opts[:accept_encoding] if opts[:accept_encoding]
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(download_masking_log_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#download_masking_log') do
    if !block.nil?
      @api_client.call_api(
        :POST,
        path,
        endpoint,
        header_params: header_params,
        query_params: query_params,
        operation_signing_strategy: operation_signing_strategy,
        body: post_body,
        return_type: 'Stream',
        &block
      )
    elsif opts[:response_target]
      if opts[:response_target].respond_to? :write
        @api_client.call_api(
          :POST,
          path,
          endpoint,
          header_params: header_params,
          query_params: query_params,
          operation_signing_strategy: operation_signing_strategy,
          body: post_body,
          return_type: 'Stream',
          &proc { |chunk, _response| opts[:response_target].write(chunk) }
        )
      elsif opts[:response_target].is_a?(String)
        File.open(opts[:response_target], 'wb') do |output|
          return @api_client.call_api(
            :POST,
            path,
            endpoint,
            header_params: header_params,
            query_params: query_params,
            operation_signing_strategy: operation_signing_strategy,
            body: post_body,
            return_type: 'Stream',
            &proc { |chunk, _response| output.write(chunk) }
          )
        end
      end
    else
      @api_client.call_api(
        :POST,
        path,
        endpoint,
        header_params: header_params,
        query_params: query_params,
        operation_signing_strategy: operation_signing_strategy,
        body: post_body,
        return_type: 'String'
      )
    end
  end
  # rubocop:enable Metrics/BlockLength
end

#download_masking_policy(masking_policy_id, download_masking_policy_details, opts = {}, &block) ⇒ Response

Note:

Click here to see an example of how to use download_masking_policy API.

Downloads an already-generated file corresponding to the specified masking policy. Note that the GenerateMaskingPolicyForDownload operation is a prerequisite for the DownloadMaskingPolicy operation. Use GenerateMaskingPolicyForDownload to generate a masking policy file and then use DownloadMaskingPolicy to download the generated file.

Parameters:

  • masking_policy_id (String) —

    The OCID of the masking policy.

  • download_masking_policy_details (OCI::DataSafe::Models::DownloadMaskingPolicyDetails) —

    Details to download a masking policy file.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

  • [Block] (Hash) —

    a customizable set of options

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :response_target (String, IO) —

    Streaming http body into a file (specified by file name or File object) or IO object if the block is not given

Returns:

  • (Response) —

    A Response object with data of type String if response_target and block are not given, otherwise with nil data



8036
8037
8038
8039
8040
8041
8042
8043
8044
8045
8046
8047
8048
8049
8050
8051
8052
8053
8054
8055
8056
8057
8058
8059
8060
8061
8062
8063
8064
8065
8066
8067
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
8105
8106
8107
8108
8109
8110
8111
8112
8113
8114
8115
8116
8117
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 8036

def download_masking_policy(masking_policy_id, download_masking_policy_details, opts = {}, &block)
  logger.debug 'Calling operation DataSafeClient#download_masking_policy.' if logger

  raise "Missing the required parameter 'masking_policy_id' when calling download_masking_policy." if masking_policy_id.nil?
  raise "Missing the required parameter 'download_masking_policy_details' when calling download_masking_policy." if download_masking_policy_details.nil?
  raise "Parameter value for 'masking_policy_id' must not be blank" if OCI::Internal::Util.blank_string?(masking_policy_id)

  path = '/maskingPolicies/{maskingPolicyId}/actions/download'.sub('{maskingPolicyId}', masking_policy_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = opts[:accept] if opts[:accept]
  header_params[:accept] ||= 'application/octet-stream'
  header_params[:'accept-encoding'] = opts[:accept_encoding] if opts[:accept_encoding]
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(download_masking_policy_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#download_masking_policy') do
    if !block.nil?
      @api_client.call_api(
        :POST,
        path,
        endpoint,
        header_params: header_params,
        query_params: query_params,
        operation_signing_strategy: operation_signing_strategy,
        body: post_body,
        return_type: 'Stream',
        &block
      )
    elsif opts[:response_target]
      if opts[:response_target].respond_to? :write
        @api_client.call_api(
          :POST,
          path,
          endpoint,
          header_params: header_params,
          query_params: query_params,
          operation_signing_strategy: operation_signing_strategy,
          body: post_body,
          return_type: 'Stream',
          &proc { |chunk, _response| opts[:response_target].write(chunk) }
        )
      elsif opts[:response_target].is_a?(String)
        File.open(opts[:response_target], 'wb') do |output|
          return @api_client.call_api(
            :POST,
            path,
            endpoint,
            header_params: header_params,
            query_params: query_params,
            operation_signing_strategy: operation_signing_strategy,
            body: post_body,
            return_type: 'Stream',
            &proc { |chunk, _response| output.write(chunk) }
          )
        end
      end
    else
      @api_client.call_api(
        :POST,
        path,
        endpoint,
        header_params: header_params,
        query_params: query_params,
        operation_signing_strategy: operation_signing_strategy,
        body: post_body,
        return_type: 'String'
      )
    end
  end
  # rubocop:enable Metrics/BlockLength
end

#download_masking_report(masking_policy_id, download_masking_report_details, opts = {}, &block) ⇒ Response

Note:

Click here to see an example of how to use download_masking_report API.

Downloads an already-generated masking report. Note that the GenerateMaskingReportForDownload operation is a prerequisite for the DownloadMaskingReport operation. Use GenerateMaskingReportForDownload to generate a masking report file and then use DownloadMaskingReport to download the generated file.

Parameters:

  • masking_policy_id (String) —

    The OCID of the masking policy.

  • download_masking_report_details (OCI::DataSafe::Models::DownloadMaskingReportDetails) —

    Details to download a masking report.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

  • [Block] (Hash) —

    a customizable set of options

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :response_target (String, IO) —

    Streaming http body into a file (specified by file name or File object) or IO object if the block is not given

Returns:

  • (Response) —

    A Response object with data of type String if response_target and block are not given, otherwise with nil data



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
8166
8167
8168
8169
8170
8171
8172
8173
8174
8175
8176
8177
8178
8179
8180
8181
8182
8183
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 8141

def download_masking_report(masking_policy_id, download_masking_report_details, opts = {}, &block)
  logger.debug 'Calling operation DataSafeClient#download_masking_report.' if logger

  raise "Missing the required parameter 'masking_policy_id' when calling download_masking_report." if masking_policy_id.nil?
  raise "Missing the required parameter 'download_masking_report_details' when calling download_masking_report." if download_masking_report_details.nil?
  raise "Parameter value for 'masking_policy_id' must not be blank" if OCI::Internal::Util.blank_string?(masking_policy_id)

  path = '/maskingPolicies/{maskingPolicyId}/actions/downloadReport'.sub('{maskingPolicyId}', masking_policy_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = opts[:accept] if opts[:accept]
  header_params[:accept] ||= 'application/json'
  header_params[:'accept-encoding'] = opts[:accept_encoding] if opts[:accept_encoding]
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(download_masking_report_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#download_masking_report') do
    if !block.nil?
      @api_client.call_api(
        :POST,
        path,
        endpoint,
        header_params: header_params,
        query_params: query_params,
        operation_signing_strategy: operation_signing_strategy,
        body: post_body,
        return_type: 'Stream',
        &block
      )
    elsif opts[:response_target]
      if opts[:response_target].respond_to? :write
        @api_client.call_api(
          :POST,
          path,
          endpoint,
          header_params: header_params,
          query_params: query_params,
          operation_signing_strategy: operation_signing_strategy,
          body: post_body,
          return_type: 'Stream',
          &proc { |chunk, _response| opts[:response_target].write(chunk) }
        )
      elsif opts[:response_target].is_a?(String)
        File.open(opts[:response_target], 'wb') do |output|
          return @api_client.call_api(
            :POST,
            path,
            endpoint,
            header_params: header_params,
            query_params: query_params,
            operation_signing_strategy: operation_signing_strategy,
            body: post_body,
            return_type: 'Stream',
            &proc { |chunk, _response| output.write(chunk) }
          )
        end
      end
    else
      @api_client.call_api(
        :POST,
        path,
        endpoint,
        header_params: header_params,
        query_params: query_params,
        operation_signing_strategy: operation_signing_strategy,
        body: post_body,
        return_type: 'String'
      )
    end
  end
  # rubocop:enable Metrics/BlockLength
end

#download_privilege_script(opts = {}, &block) ⇒ Response

Note:

Click here to see an example of how to use download_privilege_script API.

Downloads the privilege script to grant/revoke required roles from the Data Safe account on the target database.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

  • [Block] (Hash) —

    a customizable set of options

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :response_target (String, IO) —

    Streaming http body into a file (specified by file name or File object) or IO object if the block is not given

Returns:

  • (Response) —

    A Response object with data of type String if response_target and block are not given, otherwise with nil data



8253
8254
8255
8256
8257
8258
8259
8260
8261
8262
8263
8264
8265
8266
8267
8268
8269
8270
8271
8272
8273
8274
8275
8276
8277
8278
8279
8280
8281
8282
8283
8284
8285
8286
8287
8288
8289
8290
8291
8292
8293
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
8331
8332
8333
8334
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 8253

def download_privilege_script(opts = {}, &block)
  logger.debug 'Calling operation DataSafeClient#download_privilege_script.' if logger


  path = '/actions/downloadPrivilegeScript'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = opts[:accept] if opts[:accept]
  header_params[:accept] ||= 'application/octet-stream'
  header_params[:'accept-encoding'] = opts[:accept_encoding] if opts[:accept_encoding]
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#download_privilege_script') do
    if !block.nil?
      @api_client.call_api(
        :POST,
        path,
        endpoint,
        header_params: header_params,
        query_params: query_params,
        operation_signing_strategy: operation_signing_strategy,
        body: post_body,
        return_type: 'Stream',
        &block
      )
    elsif opts[:response_target]
      if opts[:response_target].respond_to? :write
        @api_client.call_api(
          :POST,
          path,
          endpoint,
          header_params: header_params,
          query_params: query_params,
          operation_signing_strategy: operation_signing_strategy,
          body: post_body,
          return_type: 'Stream',
          &proc { |chunk, _response| opts[:response_target].write(chunk) }
        )
      elsif opts[:response_target].is_a?(String)
        File.open(opts[:response_target], 'wb') do |output|
          return @api_client.call_api(
            :POST,
            path,
            endpoint,
            header_params: header_params,
            query_params: query_params,
            operation_signing_strategy: operation_signing_strategy,
            body: post_body,
            return_type: 'Stream',
            &proc { |chunk, _response| output.write(chunk) }
          )
        end
      end
    else
      @api_client.call_api(
        :POST,
        path,
        endpoint,
        header_params: header_params,
        query_params: query_params,
        operation_signing_strategy: operation_signing_strategy,
        body: post_body,
        return_type: 'String'
      )
    end
  end
  # rubocop:enable Metrics/BlockLength
end

#download_security_assessment_report(security_assessment_id, download_security_assessment_report_details, opts = {}, &block) ⇒ Response

Note:

Click here to see an example of how to use download_security_assessment_report API.

Downloads the report of the specified security assessment. To download the security assessment report, it needs to be generated first. Please use GenerateSecurityAssessmentReport to generate a downloadable report in the preferred format (PDF, XLS).

Parameters:

  • security_assessment_id (String) —

    The OCID of the security assessment.

  • download_security_assessment_report_details (OCI::DataSafe::Models::DownloadSecurityAssessmentReportDetails) —

    Details of the report.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

  • [Block] (Hash) —

    a customizable set of options

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :response_target (String, IO) —

    Streaming http body into a file (specified by file name or File object) or IO object if the block is not given

Returns:

  • (Response) —

    A Response object with data of type String if response_target and block are not given, otherwise with nil data



8368
8369
8370
8371
8372
8373
8374
8375
8376
8377
8378
8379
8380
8381
8382
8383
8384
8385
8386
8387
8388
8389
8390
8391
8392
8393
8394
8395
8396
8397
8398
8399
8400
8401
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
8439
8440
8441
8442
8443
8444
8445
8446
8447
8448
8449
8450
8451
8452
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 8368

def download_security_assessment_report(security_assessment_id, download_security_assessment_report_details, opts = {}, &block)
  logger.debug 'Calling operation DataSafeClient#download_security_assessment_report.' if logger

  raise "Missing the required parameter 'security_assessment_id' when calling download_security_assessment_report." if security_assessment_id.nil?
  raise "Missing the required parameter 'download_security_assessment_report_details' when calling download_security_assessment_report." if download_security_assessment_report_details.nil?
  raise "Parameter value for 'security_assessment_id' must not be blank" if OCI::Internal::Util.blank_string?(security_assessment_id)

  path = '/securityAssessments/{securityAssessmentId}/actions/downloadReport'.sub('{securityAssessmentId}', security_assessment_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = opts[:accept] if opts[:accept]
  header_params[:accept] ||= 'application/json'
  header_params[:'accept-encoding'] = opts[:accept_encoding] if opts[:accept_encoding]
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(download_security_assessment_report_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#download_security_assessment_report') do
    if !block.nil?
      @api_client.call_api(
        :POST,
        path,
        endpoint,
        header_params: header_params,
        query_params: query_params,
        operation_signing_strategy: operation_signing_strategy,
        body: post_body,
        return_type: 'Stream',
        &block
      )
    elsif opts[:response_target]
      if opts[:response_target].respond_to? :write
        @api_client.call_api(
          :POST,
          path,
          endpoint,
          header_params: header_params,
          query_params: query_params,
          operation_signing_strategy: operation_signing_strategy,
          body: post_body,
          return_type: 'Stream',
          &proc { |chunk, _response| opts[:response_target].write(chunk) }
        )
      elsif opts[:response_target].is_a?(String)
        File.open(opts[:response_target], 'wb') do |output|
          return @api_client.call_api(
            :POST,
            path,
            endpoint,
            header_params: header_params,
            query_params: query_params,
            operation_signing_strategy: operation_signing_strategy,
            body: post_body,
            return_type: 'Stream',
            &proc { |chunk, _response| output.write(chunk) }
          )
        end
      end
    else
      @api_client.call_api(
        :POST,
        path,
        endpoint,
        header_params: header_params,
        query_params: query_params,
        operation_signing_strategy: operation_signing_strategy,
        body: post_body,
        return_type: 'String'
      )
    end
  end
  # rubocop:enable Metrics/BlockLength
end

#download_sensitive_data_model(sensitive_data_model_id, download_sensitive_data_model_details, opts = {}, &block) ⇒ Response

Note:

Click here to see an example of how to use download_sensitive_data_model API.

Downloads an already-generated file corresponding to the specified sensitive data model. Note that the GenerateSensitiveDataModelForDownload operation is a prerequisite for the DownloadSensitiveDataModel operation. Use GenerateSensitiveDataModelForDownload to generate a data model file and then use DownloadSensitiveDataModel to download the generated file.

Parameters:

  • sensitive_data_model_id (String) —

    The OCID of the sensitive data model.

  • download_sensitive_data_model_details (OCI::DataSafe::Models::DownloadSensitiveDataModelDetails) —

    Details to download a sensitive data model file.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

  • [Block] (Hash) —

    a customizable set of options

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :response_target (String, IO) —

    Streaming http body into a file (specified by file name or File object) or IO object if the block is not given

Returns:

  • (Response) —

    A Response object with data of type String if response_target and block are not given, otherwise with nil data



8477
8478
8479
8480
8481
8482
8483
8484
8485
8486
8487
8488
8489
8490
8491
8492
8493
8494
8495
8496
8497
8498
8499
8500
8501
8502
8503
8504
8505
8506
8507
8508
8509
8510
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
8548
8549
8550
8551
8552
8553
8554
8555
8556
8557
8558
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 8477

def download_sensitive_data_model(sensitive_data_model_id, download_sensitive_data_model_details, opts = {}, &block)
  logger.debug 'Calling operation DataSafeClient#download_sensitive_data_model.' if logger

  raise "Missing the required parameter 'sensitive_data_model_id' when calling download_sensitive_data_model." if sensitive_data_model_id.nil?
  raise "Missing the required parameter 'download_sensitive_data_model_details' when calling download_sensitive_data_model." if download_sensitive_data_model_details.nil?
  raise "Parameter value for 'sensitive_data_model_id' must not be blank" if OCI::Internal::Util.blank_string?(sensitive_data_model_id)

  path = '/sensitiveDataModels/{sensitiveDataModelId}/actions/download'.sub('{sensitiveDataModelId}', sensitive_data_model_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = opts[:accept] if opts[:accept]
  header_params[:accept] ||= 'application/octet-stream'
  header_params[:'accept-encoding'] = opts[:accept_encoding] if opts[:accept_encoding]
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(download_sensitive_data_model_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#download_sensitive_data_model') do
    if !block.nil?
      @api_client.call_api(
        :POST,
        path,
        endpoint,
        header_params: header_params,
        query_params: query_params,
        operation_signing_strategy: operation_signing_strategy,
        body: post_body,
        return_type: 'Stream',
        &block
      )
    elsif opts[:response_target]
      if opts[:response_target].respond_to? :write
        @api_client.call_api(
          :POST,
          path,
          endpoint,
          header_params: header_params,
          query_params: query_params,
          operation_signing_strategy: operation_signing_strategy,
          body: post_body,
          return_type: 'Stream',
          &proc { |chunk, _response| opts[:response_target].write(chunk) }
        )
      elsif opts[:response_target].is_a?(String)
        File.open(opts[:response_target], 'wb') do |output|
          return @api_client.call_api(
            :POST,
            path,
            endpoint,
            header_params: header_params,
            query_params: query_params,
            operation_signing_strategy: operation_signing_strategy,
            body: post_body,
            return_type: 'Stream',
            &proc { |chunk, _response| output.write(chunk) }
          )
        end
      end
    else
      @api_client.call_api(
        :POST,
        path,
        endpoint,
        header_params: header_params,
        query_params: query_params,
        operation_signing_strategy: operation_signing_strategy,
        body: post_body,
        return_type: 'String'
      )
    end
  end
  # rubocop:enable Metrics/BlockLength
end

#download_sensitive_types_export(sensitive_types_export_id, download_sensitive_types_export_details, opts = {}, &block) ⇒ Response

Note:

Click here to see an example of how to use download_sensitive_types_export API.

Downloads an already-generated file corresponding to the specified sensitive types export. Use CreateSensitiveTypesExport to generate an XML file and then use DownloadSensitiveTypesExport to download the generated file.

Parameters:

  • sensitive_types_export_id (String) —

    The OCID of the sensitive types export.

  • download_sensitive_types_export_details (OCI::DataSafe::Models::DownloadSensitiveTypesExportDetails) —

    Details to download a sensitive types export file.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

  • [Block] (Hash) —

    a customizable set of options

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :response_target (String, IO) —

    Streaming http body into a file (specified by file name or File object) or IO object if the block is not given

Returns:

  • (Response) —

    A Response object with data of type String if response_target and block are not given, otherwise with nil data



8582
8583
8584
8585
8586
8587
8588
8589
8590
8591
8592
8593
8594
8595
8596
8597
8598
8599
8600
8601
8602
8603
8604
8605
8606
8607
8608
8609
8610
8611
8612
8613
8614
8615
8616
8617
8618
8619
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
8659
8660
8661
8662
8663
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 8582

def download_sensitive_types_export(sensitive_types_export_id, download_sensitive_types_export_details, opts = {}, &block)
  logger.debug 'Calling operation DataSafeClient#download_sensitive_types_export.' if logger

  raise "Missing the required parameter 'sensitive_types_export_id' when calling download_sensitive_types_export." if sensitive_types_export_id.nil?
  raise "Missing the required parameter 'download_sensitive_types_export_details' when calling download_sensitive_types_export." if download_sensitive_types_export_details.nil?
  raise "Parameter value for 'sensitive_types_export_id' must not be blank" if OCI::Internal::Util.blank_string?(sensitive_types_export_id)

  path = '/sensitiveTypesExports/{sensitiveTypesExportId}/actions/download'.sub('{sensitiveTypesExportId}', sensitive_types_export_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_types_export_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#download_sensitive_types_export') do
    if !block.nil?
      @api_client.call_api(
        :POST,
        path,
        endpoint,
        header_params: header_params,
        query_params: query_params,
        operation_signing_strategy: operation_signing_strategy,
        body: post_body,
        return_type: 'Stream',
        &block
      )
    elsif opts[:response_target]
      if opts[:response_target].respond_to? :write
        @api_client.call_api(
          :POST,
          path,
          endpoint,
          header_params: header_params,
          query_params: query_params,
          operation_signing_strategy: operation_signing_strategy,
          body: post_body,
          return_type: 'Stream',
          &proc { |chunk, _response| opts[:response_target].write(chunk) }
        )
      elsif opts[:response_target].is_a?(String)
        File.open(opts[:response_target], 'wb') do |output|
          return @api_client.call_api(
            :POST,
            path,
            endpoint,
            header_params: header_params,
            query_params: query_params,
            operation_signing_strategy: operation_signing_strategy,
            body: post_body,
            return_type: 'Stream',
            &proc { |chunk, _response| output.write(chunk) }
          )
        end
      end
    else
      @api_client.call_api(
        :POST,
        path,
        endpoint,
        header_params: header_params,
        query_params: query_params,
        operation_signing_strategy: operation_signing_strategy,
        body: post_body,
        return_type: 'String'
      )
    end
  end
  # rubocop:enable Metrics/BlockLength
end

#download_user_assessment_report(user_assessment_id, download_user_assessment_report_details, opts = {}, &block) ⇒ Response

Note:

Click here to see an example of how to use download_user_assessment_report API.

Downloads the report of the specified user assessment. To download the user assessment report, it needs to be generated first. Please use GenerateUserAssessmentReport to generate a downloadable report in the preferred format (PDF, XLS).

Parameters:

  • user_assessment_id (String) —

    The OCID of the user assessment.

  • download_user_assessment_report_details (OCI::DataSafe::Models::DownloadUserAssessmentReportDetails) —

    Details of the report.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

  • [Block] (Hash) —

    a customizable set of options

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :response_target (String, IO) —

    Streaming http body into a file (specified by file name or File object) or IO object if the block is not given

Returns:

  • (Response) —

    A Response object with data of type String if response_target and block are not given, otherwise with nil data



8697
8698
8699
8700
8701
8702
8703
8704
8705
8706
8707
8708
8709
8710
8711
8712
8713
8714
8715
8716
8717
8718
8719
8720
8721
8722
8723
8724
8725
8726
8727
8728
8729
8730
8731
8732
8733
8734
8735
8736
8737
8738
8739
8740
8741
8742
8743
8744
8745
8746
8747
8748
8749
8750
8751
8752
8753
8754
8755
8756
8757
8758
8759
8760
8761
8762
8763
8764
8765
8766
8767
8768
8769
8770
8771
8772
8773
8774
8775
8776
8777
8778
8779
8780
8781
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 8697

def download_user_assessment_report(user_assessment_id, download_user_assessment_report_details, opts = {}, &block)
  logger.debug 'Calling operation DataSafeClient#download_user_assessment_report.' if logger

  raise "Missing the required parameter 'user_assessment_id' when calling download_user_assessment_report." if user_assessment_id.nil?
  raise "Missing the required parameter 'download_user_assessment_report_details' when calling download_user_assessment_report." if download_user_assessment_report_details.nil?
  raise "Parameter value for 'user_assessment_id' must not be blank" if OCI::Internal::Util.blank_string?(user_assessment_id)

  path = '/userAssessments/{userAssessmentId}/actions/downloadReport'.sub('{userAssessmentId}', user_assessment_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = opts[:accept] if opts[:accept]
  header_params[:accept] ||= 'application/json'
  header_params[:'accept-encoding'] = opts[:accept_encoding] if opts[:accept_encoding]
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(download_user_assessment_report_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#download_user_assessment_report') do
    if !block.nil?
      @api_client.call_api(
        :POST,
        path,
        endpoint,
        header_params: header_params,
        query_params: query_params,
        operation_signing_strategy: operation_signing_strategy,
        body: post_body,
        return_type: 'Stream',
        &block
      )
    elsif opts[:response_target]
      if opts[:response_target].respond_to? :write
        @api_client.call_api(
          :POST,
          path,
          endpoint,
          header_params: header_params,
          query_params: query_params,
          operation_signing_strategy: operation_signing_strategy,
          body: post_body,
          return_type: 'Stream',
          &proc { |chunk, _response| opts[:response_target].write(chunk) }
        )
      elsif opts[:response_target].is_a?(String)
        File.open(opts[:response_target], 'wb') do |output|
          return @api_client.call_api(
            :POST,
            path,
            endpoint,
            header_params: header_params,
            query_params: query_params,
            operation_signing_strategy: operation_signing_strategy,
            body: post_body,
            return_type: 'Stream',
            &proc { |chunk, _response| output.write(chunk) }
          )
        end
      end
    else
      @api_client.call_api(
        :POST,
        path,
        endpoint,
        header_params: header_params,
        query_params: query_params,
        operation_signing_strategy: operation_signing_strategy,
        body: post_body,
        return_type: 'String'
      )
    end
  end
  # rubocop:enable Metrics/BlockLength
end

#enable_data_safe_configuration(enable_data_safe_configuration_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use enable_data_safe_configuration API.

Enables Data Safe in the tenancy and region.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :compartment_id (String) —

    A filter to return only resources that match the specified compartment OCID.

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:

  • (Response) —

    A Response object with data of type nil



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
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 8807

def enable_data_safe_configuration(enable_data_safe_configuration_details, opts = {})
  logger.debug 'Calling operation DataSafeClient#enable_data_safe_configuration.' if logger

  raise "Missing the required parameter 'enable_data_safe_configuration_details' when calling enable_data_safe_configuration." if enable_data_safe_configuration_details.nil?

  path = '/configuration'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = opts[:compartment_id] if opts[:compartment_id]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(enable_data_safe_configuration_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#enable_data_safe_configuration') do
    @api_client.call_api(
      :PUT,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#generate_discovery_report_for_download(sensitive_data_model_id, generate_discovery_report_for_download_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use generate_discovery_report_for_download API.

Generates a downloadable discovery report. It's a prerequisite for the DownloadDiscoveryReport operation. Use this endpoint to generate a discovery report file and then use DownloadDiscoveryReport to download the generated file. By default, it generates report for all the columns in a sensitive data model. Use the discoveryJobId attribute to generate report for a specific discovery job.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:

  • (Response) —

    A Response object with data of type nil



8866
8867
8868
8869
8870
8871
8872
8873
8874
8875
8876
8877
8878
8879
8880
8881
8882
8883
8884
8885
8886
8887
8888
8889
8890
8891
8892
8893
8894
8895
8896
8897
8898
8899
8900
8901
8902
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 8866

def generate_discovery_report_for_download(sensitive_data_model_id, generate_discovery_report_for_download_details, opts = {})
  logger.debug 'Calling operation DataSafeClient#generate_discovery_report_for_download.' if logger

  raise "Missing the required parameter 'sensitive_data_model_id' when calling generate_discovery_report_for_download." if sensitive_data_model_id.nil?
  raise "Missing the required parameter 'generate_discovery_report_for_download_details' when calling generate_discovery_report_for_download." if generate_discovery_report_for_download_details.nil?
  raise "Parameter value for 'sensitive_data_model_id' must not be blank" if OCI::Internal::Util.blank_string?(sensitive_data_model_id)

  path = '/sensitiveDataModels/{sensitiveDataModelId}/actions/generateReportForDownload'.sub('{sensitiveDataModelId}', sensitive_data_model_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(generate_discovery_report_for_download_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#generate_discovery_report_for_download') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#generate_health_report(masking_policy_id, generate_health_report_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use generate_health_report API.

Performs health check on the masking policy.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

Returns:

  • (Response) —

    A Response object with data of type nil



8926
8927
8928
8929
8930
8931
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
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 8926

def generate_health_report(masking_policy_id, generate_health_report_details, opts = {})
  logger.debug 'Calling operation DataSafeClient#generate_health_report.' if logger

  raise "Missing the required parameter 'masking_policy_id' when calling generate_health_report." if masking_policy_id.nil?
  raise "Missing the required parameter 'generate_health_report_details' when calling generate_health_report." if generate_health_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/generateHealthReport'.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[:'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_health_report_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#generate_health_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_masking_policy_for_download(masking_policy_id, generate_masking_policy_for_download_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use generate_masking_policy_for_download API.

Generates a downloadable file corresponding to the specified masking policy. It's a prerequisite for the DownloadMaskingPolicy operation. Use this endpoint to generate a masking policy file and then use DownloadMaskingPolicy to download the generated file. Note that file generation and download are serial operations. The download operation can't be invoked while the generate operation is in progress.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:

  • (Response) —

    A Response object with data of type nil



8988
8989
8990
8991
8992
8993
8994
8995
8996
8997
8998
8999
9000
9001
9002
9003
9004
9005
9006
9007
9008
9009
9010
9011
9012
9013
9014
9015
9016
9017
9018
9019
9020
9021
9022
9023
9024
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 8988

def generate_masking_policy_for_download(masking_policy_id, generate_masking_policy_for_download_details, opts = {})
  logger.debug 'Calling operation DataSafeClient#generate_masking_policy_for_download.' if logger

  raise "Missing the required parameter 'masking_policy_id' when calling generate_masking_policy_for_download." if masking_policy_id.nil?
  raise "Missing the required parameter 'generate_masking_policy_for_download_details' when calling generate_masking_policy_for_download." if generate_masking_policy_for_download_details.nil?
  raise "Parameter value for 'masking_policy_id' must not be blank" if OCI::Internal::Util.blank_string?(masking_policy_id)

  path = '/maskingPolicies/{maskingPolicyId}/actions/generatePolicyForDownload'.sub('{maskingPolicyId}', masking_policy_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(generate_masking_policy_for_download_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#generate_masking_policy_for_download') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#generate_masking_report_for_download(masking_policy_id, generate_masking_report_for_download_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use generate_masking_report_for_download API.

Generates a downloadable masking report. It's a prerequisite for the DownloadMaskingReport operation. Use this endpoint to generate a masking report file and then use DownloadMaskingReport to download the generated file.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:

  • (Response) —

    A Response object with data of type nil



9047
9048
9049
9050
9051
9052
9053
9054
9055
9056
9057
9058
9059
9060
9061
9062
9063
9064
9065
9066
9067
9068
9069
9070
9071
9072
9073
9074
9075
9076
9077
9078
9079
9080
9081
9082
9083
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 9047

def generate_masking_report_for_download(masking_policy_id, generate_masking_report_for_download_details, opts = {})
  logger.debug 'Calling operation DataSafeClient#generate_masking_report_for_download.' if logger

  raise "Missing the required parameter 'masking_policy_id' when calling generate_masking_report_for_download." if masking_policy_id.nil?
  raise "Missing the required parameter 'generate_masking_report_for_download_details' when calling generate_masking_report_for_download." if generate_masking_report_for_download_details.nil?
  raise "Parameter value for 'masking_policy_id' must not be blank" if OCI::Internal::Util.blank_string?(masking_policy_id)

  path = '/maskingPolicies/{maskingPolicyId}/actions/generateReportForDownload'.sub('{maskingPolicyId}', masking_policy_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(generate_masking_report_for_download_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#generate_masking_report_for_download') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#generate_on_prem_connector_configuration(generate_on_prem_connector_configuration_details, on_prem_connector_id, opts = {}, &block) ⇒ Response

Note:

Click here to see an example of how to use generate_on_prem_connector_configuration API.

Creates and downloads the configuration of the specified on-premises connector.

Parameters:

  • generate_on_prem_connector_configuration_details (OCI::DataSafe::Models::GenerateOnPremConnectorConfigurationDetails) —

    The details used to create and download on-premises connector's configuration.

  • on_prem_connector_id (String) —

    The OCID of the on-premises connector.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

  • [Block] (Hash) —

    a customizable set of options

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :response_target (String, IO) —

    Streaming http body into a file (specified by file name or File object) or IO object if the block is not given

Returns:

  • (Response) —

    A Response object with data of type String if response_target and block are not given, otherwise with nil data



9116
9117
9118
9119
9120
9121
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
9190
9191
9192
9193
9194
9195
9196
9197
9198
9199
9200
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 9116

def generate_on_prem_connector_configuration(generate_on_prem_connector_configuration_details, on_prem_connector_id, opts = {}, &block)
  logger.debug 'Calling operation DataSafeClient#generate_on_prem_connector_configuration.' if logger

  raise "Missing the required parameter 'generate_on_prem_connector_configuration_details' when calling generate_on_prem_connector_configuration." if generate_on_prem_connector_configuration_details.nil?
  raise "Missing the required parameter 'on_prem_connector_id' when calling generate_on_prem_connector_configuration." if on_prem_connector_id.nil?
  raise "Parameter value for 'on_prem_connector_id' must not be blank" if OCI::Internal::Util.blank_string?(on_prem_connector_id)

  path = '/onPremConnectors/{onPremConnectorId}/actions/generateConfiguration'.sub('{onPremConnectorId}', on_prem_connector_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = opts[:accept] if opts[:accept]
  header_params[:accept] ||= 'application/octet-stream'
  header_params[:'accept-encoding'] = opts[:accept_encoding] if opts[:accept_encoding]
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(generate_on_prem_connector_configuration_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#generate_on_prem_connector_configuration') do
    if !block.nil?
      @api_client.call_api(
        :POST,
        path,
        endpoint,
        header_params: header_params,
        query_params: query_params,
        operation_signing_strategy: operation_signing_strategy,
        body: post_body,
        return_type: 'Stream',
        &block
      )
    elsif opts[:response_target]
      if opts[:response_target].respond_to? :write
        @api_client.call_api(
          :POST,
          path,
          endpoint,
          header_params: header_params,
          query_params: query_params,
          operation_signing_strategy: operation_signing_strategy,
          body: post_body,
          return_type: 'Stream',
          &proc { |chunk, _response| opts[:response_target].write(chunk) }
        )
      elsif opts[:response_target].is_a?(String)
        File.open(opts[:response_target], 'wb') do |output|
          return @api_client.call_api(
            :POST,
            path,
            endpoint,
            header_params: header_params,
            query_params: query_params,
            operation_signing_strategy: operation_signing_strategy,
            body: post_body,
            return_type: 'Stream',
            &proc { |chunk, _response| output.write(chunk) }
          )
        end
      end
    else
      @api_client.call_api(
        :POST,
        path,
        endpoint,
        header_params: header_params,
        query_params: query_params,
        operation_signing_strategy: operation_signing_strategy,
        body: post_body,
        return_type: 'String'
      )
    end
  end
  # rubocop:enable Metrics/BlockLength
end

#generate_report(report_definition_id, generate_report_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use generate_report API.

Generates a .xls or .pdf report based on parameters and report definition.

Parameters:

  • report_definition_id (String) —

    Unique report definition identifier

  • generate_report_details (OCI::DataSafe::Models::GenerateReportDetails) —

    Details for report generation. It contains details such as PDF/XLS and filter parameters like audit event time limits, number of rows and target databases etc

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

  • :scim_query (String) —

    The scimQuery query parameter accepts filter expressions that use the syntax described in Section 3.2.2.2 of the System for Cross-Domain Identity Management (SCIM) specification, which is available at RFC3339. In SCIM filtering expressions, text, date, and time values must be enclosed in quotation marks, with date and time values using ISO-8601 format. (Numeric and boolean values should not be quoted.)

    Example: query=(auditEventTime ge "2021-06-04T01:00:26.000Z") and (eventName eq "LOGON")

Returns:

  • (Response) —

    A Response object with data of type nil



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
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 9238

def generate_report(report_definition_id, generate_report_details, opts = {})
  logger.debug 'Calling operation DataSafeClient#generate_report.' if logger

  raise "Missing the required parameter 'report_definition_id' when calling generate_report." if report_definition_id.nil?
  raise "Missing the required parameter 'generate_report_details' when calling generate_report." if generate_report_details.nil?
  raise "Parameter value for 'report_definition_id' must not be blank" if OCI::Internal::Util.blank_string?(report_definition_id)

  path = '/reportDefinitions/{reportDefinitionId}/actions/generateReport'.sub('{reportDefinitionId}', report_definition_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:scimQuery] = opts[:scim_query] if opts[:scim_query]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(generate_report_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#generate_report') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#generate_security_assessment_report(security_assessment_id, generate_security_assessment_report_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use generate_security_assessment_report API.

Generates the report of the specified security assessment. You can get the report in PDF or XLS format. After generating the report, use DownloadSecurityAssessmentReport to download it in the preferred format.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:

  • (Response) —

    A Response object with data of type nil



9310
9311
9312
9313
9314
9315
9316
9317
9318
9319
9320
9321
9322
9323
9324
9325
9326
9327
9328
9329
9330
9331
9332
9333
9334
9335
9336
9337
9338
9339
9340
9341
9342
9343
9344
9345
9346
9347
9348
9349
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 9310

def generate_security_assessment_report(security_assessment_id, generate_security_assessment_report_details, opts = {})
  logger.debug 'Calling operation DataSafeClient#generate_security_assessment_report.' if logger

  raise "Missing the required parameter 'security_assessment_id' when calling generate_security_assessment_report." if security_assessment_id.nil?
  raise "Missing the required parameter 'generate_security_assessment_report_details' when calling generate_security_assessment_report." if generate_security_assessment_report_details.nil?
  raise "Parameter value for 'security_assessment_id' must not be blank" if OCI::Internal::Util.blank_string?(security_assessment_id)

  path = '/securityAssessments/{securityAssessmentId}/actions/generateReport'.sub('{securityAssessmentId}', security_assessment_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(generate_security_assessment_report_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#generate_security_assessment_report') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#generate_sensitive_data_model_for_download(sensitive_data_model_id, generate_sensitive_data_model_for_download_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use generate_sensitive_data_model_for_download API.

Generates a downloadable file corresponding to the specified sensitive data model. It's a prerequisite for the DownloadSensitiveDataModel operation. Use this endpoint to generate a data model file and then use DownloadSensitiveDataModel to download the generated file. Note that file generation and download are serial operations. The download operation can't be invoked while the generate operation is in progress.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:

  • (Response) —

    A Response object with data of type nil



9372
9373
9374
9375
9376
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
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 9372

def generate_sensitive_data_model_for_download(sensitive_data_model_id, generate_sensitive_data_model_for_download_details, opts = {})
  logger.debug 'Calling operation DataSafeClient#generate_sensitive_data_model_for_download.' if logger

  raise "Missing the required parameter 'sensitive_data_model_id' when calling generate_sensitive_data_model_for_download." if sensitive_data_model_id.nil?
  raise "Missing the required parameter 'generate_sensitive_data_model_for_download_details' when calling generate_sensitive_data_model_for_download." if generate_sensitive_data_model_for_download_details.nil?
  raise "Parameter value for 'sensitive_data_model_id' must not be blank" if OCI::Internal::Util.blank_string?(sensitive_data_model_id)

  path = '/sensitiveDataModels/{sensitiveDataModelId}/actions/generateDataModelForDownload'.sub('{sensitiveDataModelId}', sensitive_data_model_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(generate_sensitive_data_model_for_download_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#generate_sensitive_data_model_for_download') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#generate_sql_firewall_policy(sql_collection_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use generate_sql_firewall_policy API.

Generates or appends to the SQL Firewall policy using the specified SQL collection.

Parameters:

  • sql_collection_id (String) —

    The OCID of the SQL collection resource.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

Returns:

  • (Response) —

    A Response object with data of type nil



9437
9438
9439
9440
9441
9442
9443
9444
9445
9446
9447
9448
9449
9450
9451
9452
9453
9454
9455
9456
9457
9458
9459
9460
9461
9462
9463
9464
9465
9466
9467
9468
9469
9470
9471
9472
9473
9474
9475
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 9437

def generate_sql_firewall_policy(sql_collection_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#generate_sql_firewall_policy.' if logger

  raise "Missing the required parameter 'sql_collection_id' when calling generate_sql_firewall_policy." if sql_collection_id.nil?
  raise "Parameter value for 'sql_collection_id' must not be blank" if OCI::Internal::Util.blank_string?(sql_collection_id)

  path = '/sqlCollections/{sqlCollectionId}/actions/generateSqlFirewallPolicy'.sub('{sqlCollectionId}', sql_collection_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#generate_sql_firewall_policy') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#generate_user_assessment_report(user_assessment_id, generate_user_assessment_report_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use generate_user_assessment_report API.

Generates the report of the specified user assessment. The report is available in PDF or XLS format. After generating the report, use DownloadUserAssessmentReport to download it in the preferred format.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:

  • (Response) —

    A Response object with data of type nil



9507
9508
9509
9510
9511
9512
9513
9514
9515
9516
9517
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
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 9507

def generate_user_assessment_report(user_assessment_id, generate_user_assessment_report_details, opts = {})
  logger.debug 'Calling operation DataSafeClient#generate_user_assessment_report.' if logger

  raise "Missing the required parameter 'user_assessment_id' when calling generate_user_assessment_report." if user_assessment_id.nil?
  raise "Missing the required parameter 'generate_user_assessment_report_details' when calling generate_user_assessment_report." if generate_user_assessment_report_details.nil?
  raise "Parameter value for 'user_assessment_id' must not be blank" if OCI::Internal::Util.blank_string?(user_assessment_id)

  path = '/userAssessments/{userAssessmentId}/actions/generateReport'.sub('{userAssessmentId}', user_assessment_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(generate_user_assessment_report_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#generate_user_assessment_report') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_alert(alert_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_alert API.

Gets the details of the specified alerts.

Parameters:

  • alert_id (String) —

    The OCID of alert.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:



9564
9565
9566
9567
9568
9569
9570
9571
9572
9573
9574
9575
9576
9577
9578
9579
9580
9581
9582
9583
9584
9585
9586
9587
9588
9589
9590
9591
9592
9593
9594
9595
9596
9597
9598
9599
9600
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 9564

def get_alert(alert_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#get_alert.' if logger

  raise "Missing the required parameter 'alert_id' when calling get_alert." if alert_id.nil?
  raise "Parameter value for 'alert_id' must not be blank" if OCI::Internal::Util.blank_string?(alert_id)

  path = '/alerts/{alertId}'.sub('{alertId}', alert_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#get_alert') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataSafe::Models::Alert'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_alert_policy(alert_policy_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_alert_policy API.

Gets the details of alert policy by its ID.

Parameters:

  • alert_policy_id (String) —

    The OCID of the alert policy.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:



9618
9619
9620
9621
9622
9623
9624
9625
9626
9627
9628
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
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 9618

def get_alert_policy(alert_policy_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#get_alert_policy.' if logger

  raise "Missing the required parameter 'alert_policy_id' when calling get_alert_policy." if alert_policy_id.nil?
  raise "Parameter value for 'alert_policy_id' must not be blank" if OCI::Internal::Util.blank_string?(alert_policy_id)

  path = '/alertPolicies/{alertPolicyId}'.sub('{alertPolicyId}', alert_policy_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#get_alert_policy') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataSafe::Models::AlertPolicy'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_alert_policy_rule(alert_policy_id, rule_key, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_alert_policy_rule API.

Gets the details of a policy rule by its key.

Parameters:

  • alert_policy_id (String) —

    The OCID of the alert policy.

  • rule_key (String) —

    The key of the alert policy rule.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:



9673
9674
9675
9676
9677
9678
9679
9680
9681
9682
9683
9684
9685
9686
9687
9688
9689
9690
9691
9692
9693
9694
9695
9696
9697
9698
9699
9700
9701
9702
9703
9704
9705
9706
9707
9708
9709
9710
9711
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 9673

def get_alert_policy_rule(alert_policy_id, rule_key, opts = {})
  logger.debug 'Calling operation DataSafeClient#get_alert_policy_rule.' if logger

  raise "Missing the required parameter 'alert_policy_id' when calling get_alert_policy_rule." if alert_policy_id.nil?
  raise "Missing the required parameter 'rule_key' when calling get_alert_policy_rule." if rule_key.nil?
  raise "Parameter value for 'alert_policy_id' must not be blank" if OCI::Internal::Util.blank_string?(alert_policy_id)
  raise "Parameter value for 'rule_key' must not be blank" if OCI::Internal::Util.blank_string?(rule_key)

  path = '/alertPolicies/{alertPolicyId}/rules/{ruleKey}'.sub('{alertPolicyId}', alert_policy_id.to_s).sub('{ruleKey}', rule_key.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#get_alert_policy_rule') 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::AlertPolicyRule'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_attribute_set(attribute_set_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_attribute_set API.

Gets the details of the specified attribute set.

Parameters:

  • attribute_set_id (String) —

    OCID of an attribute set.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:



9735
9736
9737
9738
9739
9740
9741
9742
9743
9744
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
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 9735

def get_attribute_set(attribute_set_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#get_attribute_set.' if logger

  raise "Missing the required parameter 'attribute_set_id' when calling get_attribute_set." if attribute_set_id.nil?
  raise "Parameter value for 'attribute_set_id' must not be blank" if OCI::Internal::Util.blank_string?(attribute_set_id)

  path = '/attributeSets/{attributeSetId}'.sub('{attributeSetId}', attribute_set_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#get_attribute_set') 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::AttributeSet'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_audit_archive_retrieval(audit_archive_retrieval_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_audit_archive_retrieval API.

Gets the details of the specified archive retreival.

Parameters:

  • audit_archive_retrieval_id (String) —

    OCID of the archive retrieval.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:



9796
9797
9798
9799
9800
9801
9802
9803
9804
9805
9806
9807
9808
9809
9810
9811
9812
9813
9814
9815
9816
9817
9818
9819
9820
9821
9822
9823
9824
9825
9826
9827
9828
9829
9830
9831
9832
9833
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 9796

def get_audit_archive_retrieval(audit_archive_retrieval_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#get_audit_archive_retrieval.' if logger

  raise "Missing the required parameter 'audit_archive_retrieval_id' when calling get_audit_archive_retrieval." if audit_archive_retrieval_id.nil?
  raise "Parameter value for 'audit_archive_retrieval_id' must not be blank" if OCI::Internal::Util.blank_string?(audit_archive_retrieval_id)

  path = '/auditArchiveRetrievals/{auditArchiveRetrievalId}'.sub('{auditArchiveRetrievalId}', audit_archive_retrieval_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#get_audit_archive_retrieval') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataSafe::Models::AuditArchiveRetrieval'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_audit_policy(audit_policy_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_audit_policy API.

Gets a audit policy by identifier.

Parameters:

  • audit_policy_id (String) —

    Unique audit policy identifier.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:



9851
9852
9853
9854
9855
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
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 9851

def get_audit_policy(audit_policy_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#get_audit_policy.' if logger

  raise "Missing the required parameter 'audit_policy_id' when calling get_audit_policy." if audit_policy_id.nil?
  raise "Parameter value for 'audit_policy_id' must not be blank" if OCI::Internal::Util.blank_string?(audit_policy_id)

  path = '/auditPolicies/{auditPolicyId}'.sub('{auditPolicyId}', audit_policy_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#get_audit_policy') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataSafe::Models::AuditPolicy'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_audit_profile(audit_profile_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_audit_profile API.

Gets the details of audit profile resource and associated audit trails of the audit profile.

Parameters:

  • audit_profile_id (String) —

    The OCID of the audit.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:



9905
9906
9907
9908
9909
9910
9911
9912
9913
9914
9915
9916
9917
9918
9919
9920
9921
9922
9923
9924
9925
9926
9927
9928
9929
9930
9931
9932
9933
9934
9935
9936
9937
9938
9939
9940
9941
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 9905

def get_audit_profile(audit_profile_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#get_audit_profile.' if logger

  raise "Missing the required parameter 'audit_profile_id' when calling get_audit_profile." if audit_profile_id.nil?
  raise "Parameter value for 'audit_profile_id' must not be blank" if OCI::Internal::Util.blank_string?(audit_profile_id)

  path = '/auditProfiles/{auditProfileId}'.sub('{auditProfileId}', audit_profile_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#get_audit_profile') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataSafe::Models::AuditProfile'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_audit_trail(audit_trail_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_audit_trail API.

Gets the details of audit trail.

Parameters:

  • audit_trail_id (String) —

    The OCID of the audit trail.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:



9959
9960
9961
9962
9963
9964
9965
9966
9967
9968
9969
9970
9971
9972
9973
9974
9975
9976
9977
9978
9979
9980
9981
9982
9983
9984
9985
9986
9987
9988
9989
9990
9991
9992
9993
9994
9995
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 9959

def get_audit_trail(audit_trail_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#get_audit_trail.' if logger

  raise "Missing the required parameter 'audit_trail_id' when calling get_audit_trail." if audit_trail_id.nil?
  raise "Parameter value for 'audit_trail_id' must not be blank" if OCI::Internal::Util.blank_string?(audit_trail_id)

  path = '/auditTrails/{auditTrailId}'.sub('{auditTrailId}', audit_trail_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#get_audit_trail') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataSafe::Models::AuditTrail'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_compatible_formats_for_data_types(opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_compatible_formats_for_data_types API.

Gets a list of basic masking formats compatible with the supported data types. The data types are grouped into the following categories - Character - Includes CHAR, NCHAR, VARCHAR2, and NVARCHAR2 Numeric - Includes NUMBER, FLOAT, RAW, BINARY_FLOAT, and BINARY_DOUBLE Date - Includes DATE and TIMESTAMP LOB - Includes BLOB, CLOB, and NCLOB All - Includes all the supported data types

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :limit (Integer) —

    For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

  • :page (String) —

    For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:



10021
10022
10023
10024
10025
10026
10027
10028
10029
10030
10031
10032
10033
10034
10035
10036
10037
10038
10039
10040
10041
10042
10043
10044
10045
10046
10047
10048
10049
10050
10051
10052
10053
10054
10055
10056
10057
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 10021

def get_compatible_formats_for_data_types(opts = {})
  logger.debug 'Calling operation DataSafeClient#get_compatible_formats_for_data_types.' if logger


  path = '/compatibleFormatsForDataTypes'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#get_compatible_formats_for_data_types') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataSafe::Models::CompatibleFormatsForDataTypes'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_compatible_formats_for_sensitive_types(compartment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_compatible_formats_for_sensitive_types API.

Gets a list of library masking formats compatible with the existing sensitive types. For each sensitive type, it returns the assigned default masking format as well as the other library masking formats that have the sensitiveTypeIds attribute containing the OCID of the sensitive type.

Parameters:

  • compartment_id (String) —

    A filter to return only resources that match the specified compartment OCID.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :compartment_id_in_subtree (BOOLEAN) —

    Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting. (default to false)

  • :access_level (String) —

    Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed. (default to RESTRICTED) Allowed values are: RESTRICTED, ACCESSIBLE

  • :limit (Integer) —

    For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

  • :page (String) —

    For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:



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
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 10090

def get_compatible_formats_for_sensitive_types(compartment_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#get_compatible_formats_for_sensitive_types.' if logger

  raise "Missing the required parameter 'compartment_id' when calling get_compatible_formats_for_sensitive_types." if compartment_id.nil?

  if opts[:access_level] && !%w[RESTRICTED ACCESSIBLE].include?(opts[:access_level])
    raise 'Invalid value for "access_level", must be one of RESTRICTED, ACCESSIBLE.'
  end

  path = '/compatibleFormatsForSensitiveTypes'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:compartmentIdInSubtree] = opts[:compartment_id_in_subtree] if !opts[:compartment_id_in_subtree].nil?
  query_params[:accessLevel] = opts[:access_level] if opts[:access_level]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#get_compatible_formats_for_sensitive_types') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataSafe::Models::CompatibleFormatsForSensitiveTypes'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_data_safe_configuration(opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_data_safe_configuration API.

Gets the details of the Data Safe configuration.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :compartment_id (String) —

    A filter to return the Data Safe configuration for the specified tenancy OCID.

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:



10152
10153
10154
10155
10156
10157
10158
10159
10160
10161
10162
10163
10164
10165
10166
10167
10168
10169
10170
10171
10172
10173
10174
10175
10176
10177
10178
10179
10180
10181
10182
10183
10184
10185
10186
10187
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 10152

def get_data_safe_configuration(opts = {})
  logger.debug 'Calling operation DataSafeClient#get_data_safe_configuration.' if logger


  path = '/configuration'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = opts[:compartment_id] if opts[:compartment_id]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#get_data_safe_configuration') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataSafe::Models::DataSafeConfiguration'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_data_safe_private_endpoint(data_safe_private_endpoint_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_data_safe_private_endpoint API.

Gets the details of the specified Data Safe private endpoint.

Parameters:

  • data_safe_private_endpoint_id (String) —

    The OCID of the private endpoint.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:



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
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 10205

def get_data_safe_private_endpoint(data_safe_private_endpoint_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#get_data_safe_private_endpoint.' if logger

  raise "Missing the required parameter 'data_safe_private_endpoint_id' when calling get_data_safe_private_endpoint." if data_safe_private_endpoint_id.nil?
  raise "Parameter value for 'data_safe_private_endpoint_id' must not be blank" if OCI::Internal::Util.blank_string?(data_safe_private_endpoint_id)

  path = '/dataSafePrivateEndpoints/{dataSafePrivateEndpointId}'.sub('{dataSafePrivateEndpointId}', data_safe_private_endpoint_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#get_data_safe_private_endpoint') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataSafe::Models::DataSafePrivateEndpoint'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_database_security_config(database_security_config_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_database_security_config API.

Gets a database security configuration by identifier.

Parameters:

  • database_security_config_id (String) —

    The OCID of the database security configuration resource.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:



10259
10260
10261
10262
10263
10264
10265
10266
10267
10268
10269
10270
10271
10272
10273
10274
10275
10276
10277
10278
10279
10280
10281
10282
10283
10284
10285
10286
10287
10288
10289
10290
10291
10292
10293
10294
10295
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 10259

def get_database_security_config(database_security_config_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#get_database_security_config.' if logger

  raise "Missing the required parameter 'database_security_config_id' when calling get_database_security_config." if database_security_config_id.nil?
  raise "Parameter value for 'database_security_config_id' must not be blank" if OCI::Internal::Util.blank_string?(database_security_config_id)

  path = '/databaseSecurityConfigs/{databaseSecurityConfigId}'.sub('{databaseSecurityConfigId}', database_security_config_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#get_database_security_config') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataSafe::Models::DatabaseSecurityConfig'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_database_table_access_entry(security_policy_report_id, database_table_access_entry_key, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_database_table_access_entry API.

Gets a database table access entry object by identifier.

Parameters:

  • security_policy_report_id (String) —

    The OCID of the security policy report resource.

  • database_table_access_entry_key (String) —

    The unique key that identifies the table access object. This is a system-generated identifier.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:



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
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 10314

def get_database_table_access_entry(security_policy_report_id, database_table_access_entry_key, opts = {})
  logger.debug 'Calling operation DataSafeClient#get_database_table_access_entry.' if logger

  raise "Missing the required parameter 'security_policy_report_id' when calling get_database_table_access_entry." if security_policy_report_id.nil?
  raise "Missing the required parameter 'database_table_access_entry_key' when calling get_database_table_access_entry." if database_table_access_entry_key.nil?
  raise "Parameter value for 'security_policy_report_id' must not be blank" if OCI::Internal::Util.blank_string?(security_policy_report_id)
  raise "Parameter value for 'database_table_access_entry_key' must not be blank" if OCI::Internal::Util.blank_string?(database_table_access_entry_key)

  path = '/securityPolicyReports/{securityPolicyReportId}/databaseTableAccessEntries/{databaseTableAccessEntryKey}'.sub('{securityPolicyReportId}', security_policy_report_id.to_s).sub('{databaseTableAccessEntryKey}', database_table_access_entry_key.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#get_database_table_access_entry') 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::DatabaseTableAccessEntry'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_database_view_access_entry(security_policy_report_id, database_view_access_entry_key, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_database_view_access_entry API.

Gets a database view access object by identifier.

Parameters:

  • security_policy_report_id (String) —

    The OCID of the security policy report resource.

  • database_view_access_entry_key (String) —

    The unique key that identifies the view access object. This is a system-generated identifier.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:



10371
10372
10373
10374
10375
10376
10377
10378
10379
10380
10381
10382
10383
10384
10385
10386
10387
10388
10389
10390
10391
10392
10393
10394
10395
10396
10397
10398
10399
10400
10401
10402
10403
10404
10405
10406
10407
10408
10409
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 10371

def get_database_view_access_entry(security_policy_report_id, database_view_access_entry_key, opts = {})
  logger.debug 'Calling operation DataSafeClient#get_database_view_access_entry.' if logger

  raise "Missing the required parameter 'security_policy_report_id' when calling get_database_view_access_entry." if security_policy_report_id.nil?
  raise "Missing the required parameter 'database_view_access_entry_key' when calling get_database_view_access_entry." if database_view_access_entry_key.nil?
  raise "Parameter value for 'security_policy_report_id' must not be blank" if OCI::Internal::Util.blank_string?(security_policy_report_id)
  raise "Parameter value for 'database_view_access_entry_key' must not be blank" if OCI::Internal::Util.blank_string?(database_view_access_entry_key)

  path = '/securityPolicyReports/{securityPolicyReportId}/databaseViewAccessEntries/{databaseViewAccessEntryKey}'.sub('{securityPolicyReportId}', security_policy_report_id.to_s).sub('{databaseViewAccessEntryKey}', database_view_access_entry_key.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#get_database_view_access_entry') 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::DatabaseViewAccessEntry'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_difference_column(sdm_masking_policy_difference_id, difference_column_key, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_difference_column API.

Gets the details of the specified SDM Masking policy difference column.

Parameters:

  • sdm_masking_policy_difference_id (String) —

    The OCID of the SDM masking policy difference.

  • difference_column_key (String) —

    The unique key that identifies the difference column.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:



10428
10429
10430
10431
10432
10433
10434
10435
10436
10437
10438
10439
10440
10441
10442
10443
10444
10445
10446
10447
10448
10449
10450
10451
10452
10453
10454
10455
10456
10457
10458
10459
10460
10461
10462
10463
10464
10465
10466
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 10428

def get_difference_column(sdm_masking_policy_difference_id, difference_column_key, opts = {})
  logger.debug 'Calling operation DataSafeClient#get_difference_column.' if logger

  raise "Missing the required parameter 'sdm_masking_policy_difference_id' when calling get_difference_column." if sdm_masking_policy_difference_id.nil?
  raise "Missing the required parameter 'difference_column_key' when calling get_difference_column." if difference_column_key.nil?
  raise "Parameter value for 'sdm_masking_policy_difference_id' must not be blank" if OCI::Internal::Util.blank_string?(sdm_masking_policy_difference_id)
  raise "Parameter value for 'difference_column_key' must not be blank" if OCI::Internal::Util.blank_string?(difference_column_key)

  path = '/sdmMaskingPolicyDifferences/{sdmMaskingPolicyDifferenceId}/differenceColumns/{differenceColumnKey}'.sub('{sdmMaskingPolicyDifferenceId}', sdm_masking_policy_difference_id.to_s).sub('{differenceColumnKey}', difference_column_key.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#get_difference_column') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataSafe::Models::DifferenceColumn'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_discovery_job(discovery_job_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_discovery_job API.

Gets the details of the specified discovery job.

Parameters:

  • discovery_job_id (String) —

    The OCID of the discovery job.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:



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
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 10484

def get_discovery_job(discovery_job_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#get_discovery_job.' if logger

  raise "Missing the required parameter 'discovery_job_id' when calling get_discovery_job." if discovery_job_id.nil?
  raise "Parameter value for 'discovery_job_id' must not be blank" if OCI::Internal::Util.blank_string?(discovery_job_id)

  path = '/discoveryJobs/{discoveryJobId}'.sub('{discoveryJobId}', discovery_job_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#get_discovery_job') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataSafe::Models::DiscoveryJob'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_discovery_job_result(discovery_job_id, result_key, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_discovery_job_result API.

Gets the details of the specified discovery result.

Parameters:

  • discovery_job_id (String) —

    The OCID of the discovery job.

  • result_key (String) —

    The unique key that identifies the discovery result.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:



10539
10540
10541
10542
10543
10544
10545
10546
10547
10548
10549
10550
10551
10552
10553
10554
10555
10556
10557
10558
10559
10560
10561
10562
10563
10564
10565
10566
10567
10568
10569
10570
10571
10572
10573
10574
10575
10576
10577
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 10539

def get_discovery_job_result(discovery_job_id, result_key, opts = {})
  logger.debug 'Calling operation DataSafeClient#get_discovery_job_result.' if logger

  raise "Missing the required parameter 'discovery_job_id' when calling get_discovery_job_result." if discovery_job_id.nil?
  raise "Missing the required parameter 'result_key' when calling get_discovery_job_result." if result_key.nil?
  raise "Parameter value for 'discovery_job_id' must not be blank" if OCI::Internal::Util.blank_string?(discovery_job_id)
  raise "Parameter value for 'result_key' must not be blank" if OCI::Internal::Util.blank_string?(result_key)

  path = '/discoveryJobs/{discoveryJobId}/results/{resultKey}'.sub('{discoveryJobId}', discovery_job_id.to_s).sub('{resultKey}', result_key.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#get_discovery_job_result') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataSafe::Models::DiscoveryJobResult'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_group_members(target_database_group_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_group_members API.

Retrieves the members of the target database group with the specified OCID.

Parameters:

  • target_database_group_id (String) —

    The OCID of the specified target database group.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :target_database_id (String) —

    A filter to return the target database only if it is a member of the target database group.

  • :limit (Integer) —

    For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

  • :page (String) —

    For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

Returns:



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
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 10599

def get_group_members(target_database_group_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#get_group_members.' if logger

  raise "Missing the required parameter 'target_database_group_id' when calling get_group_members." if target_database_group_id.nil?
  raise "Parameter value for 'target_database_group_id' must not be blank" if OCI::Internal::Util.blank_string?(target_database_group_id)

  path = '/targetDatabaseGroups/{targetDatabaseGroupId}/groupMembers'.sub('{targetDatabaseGroupId}', target_database_group_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:targetDatabaseId] = opts[:target_database_id] if opts[:target_database_id]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#get_group_members') 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::GroupMembersCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_library_masking_format(library_masking_format_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_library_masking_format API.

Gets the details of the specified library masking format.

Parameters:

  • library_masking_format_id (String) —

    The OCID of the library masking format.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:



10656
10657
10658
10659
10660
10661
10662
10663
10664
10665
10666
10667
10668
10669
10670
10671
10672
10673
10674
10675
10676
10677
10678
10679
10680
10681
10682
10683
10684
10685
10686
10687
10688
10689
10690
10691
10692
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 10656

def get_library_masking_format(library_masking_format_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#get_library_masking_format.' if logger

  raise "Missing the required parameter 'library_masking_format_id' when calling get_library_masking_format." if library_masking_format_id.nil?
  raise "Parameter value for 'library_masking_format_id' must not be blank" if OCI::Internal::Util.blank_string?(library_masking_format_id)

  path = '/libraryMaskingFormats/{libraryMaskingFormatId}'.sub('{libraryMaskingFormatId}', library_masking_format_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#get_library_masking_format') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataSafe::Models::LibraryMaskingFormat'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_masking_column(masking_policy_id, masking_column_key, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_masking_column API.

Gets the details of the specified masking column.

Parameters:

  • masking_policy_id (String) —

    The OCID of the masking policy.

  • masking_column_key (String) —

    The unique key that identifies the masking column. It's numeric and unique within a masking policy.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:



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
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 10711

def get_masking_column(masking_policy_id, masking_column_key, opts = {})
  logger.debug 'Calling operation DataSafeClient#get_masking_column.' if logger

  raise "Missing the required parameter 'masking_policy_id' when calling get_masking_column." if masking_policy_id.nil?
  raise "Missing the required parameter 'masking_column_key' when calling get_masking_column." if masking_column_key.nil?
  raise "Parameter value for 'masking_policy_id' must not be blank" if OCI::Internal::Util.blank_string?(masking_policy_id)
  raise "Parameter value for 'masking_column_key' must not be blank" if OCI::Internal::Util.blank_string?(masking_column_key)

  path = '/maskingPolicies/{maskingPolicyId}/maskingColumns/{maskingColumnKey}'.sub('{maskingPolicyId}', masking_policy_id.to_s).sub('{maskingColumnKey}', masking_column_key.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#get_masking_column') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataSafe::Models::MaskingColumn'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_masking_policy(masking_policy_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_masking_policy API.

Gets the details of the specified masking policy.

Parameters:

  • masking_policy_id (String) —

    The OCID of the masking policy.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:



10767
10768
10769
10770
10771
10772
10773
10774
10775
10776
10777
10778
10779
10780
10781
10782
10783
10784
10785
10786
10787
10788
10789
10790
10791
10792
10793
10794
10795
10796
10797
10798
10799
10800
10801
10802
10803
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 10767

def get_masking_policy(masking_policy_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#get_masking_policy.' if logger

  raise "Missing the required parameter 'masking_policy_id' when calling get_masking_policy." if masking_policy_id.nil?
  raise "Parameter value for 'masking_policy_id' must not be blank" if OCI::Internal::Util.blank_string?(masking_policy_id)

  path = '/maskingPolicies/{maskingPolicyId}'.sub('{maskingPolicyId}', masking_policy_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#get_masking_policy') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataSafe::Models::MaskingPolicy'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_masking_policy_health_report(masking_policy_health_report_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_masking_policy_health_report API.

Gets the details of the specified masking policy health report.

Parameters:

  • masking_policy_health_report_id (String) —

    The OCID of the masking health report.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:



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
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 10821

def get_masking_policy_health_report(masking_policy_health_report_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#get_masking_policy_health_report.' if logger

  raise "Missing the required parameter 'masking_policy_health_report_id' when calling get_masking_policy_health_report." if masking_policy_health_report_id.nil?
  raise "Parameter value for 'masking_policy_health_report_id' must not be blank" if OCI::Internal::Util.blank_string?(masking_policy_health_report_id)

  path = '/maskingPolicyHealthReports/{maskingPolicyHealthReportId}'.sub('{maskingPolicyHealthReportId}', masking_policy_health_report_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#get_masking_policy_health_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::MaskingPolicyHealthReport'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_masking_report(masking_report_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_masking_report API.

Gets the details of the specified masking report.

Parameters:

  • masking_report_id (String) —

    The OCID of the masking report.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:



10875
10876
10877
10878
10879
10880
10881
10882
10883
10884
10885
10886
10887
10888
10889
10890
10891
10892
10893
10894
10895
10896
10897
10898
10899
10900
10901
10902
10903
10904
10905
10906
10907
10908
10909
10910
10911
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 10875

def get_masking_report(masking_report_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#get_masking_report.' if logger

  raise "Missing the required parameter 'masking_report_id' when calling get_masking_report." if masking_report_id.nil?
  raise "Parameter value for 'masking_report_id' must not be blank" if OCI::Internal::Util.blank_string?(masking_report_id)

  path = '/maskingReports/{maskingReportId}'.sub('{maskingReportId}', masking_report_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#get_masking_report') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataSafe::Models::MaskingReport'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_on_prem_connector(on_prem_connector_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_on_prem_connector API.

Gets the details of the specified on-premises connector.

Parameters:

  • on_prem_connector_id (String) —

    The OCID of the on-premises connector.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:



10929
10930
10931
10932
10933
10934
10935
10936
10937
10938
10939
10940
10941
10942
10943
10944
10945
10946
10947
10948
10949
10950
10951
10952
10953
10954
10955
10956
10957
10958
10959
10960
10961
10962
10963
10964
10965
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 10929

def get_on_prem_connector(on_prem_connector_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#get_on_prem_connector.' if logger

  raise "Missing the required parameter 'on_prem_connector_id' when calling get_on_prem_connector." if on_prem_connector_id.nil?
  raise "Parameter value for 'on_prem_connector_id' must not be blank" if OCI::Internal::Util.blank_string?(on_prem_connector_id)

  path = '/onPremConnectors/{onPremConnectorId}'.sub('{onPremConnectorId}', on_prem_connector_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#get_on_prem_connector') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataSafe::Models::OnPremConnector'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_peer_target_database(target_database_id, peer_target_database_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_peer_target_database API.

Returns the details of the specified Data Safe peer target database.

Parameters:

  • target_database_id (String) —

    The OCID of the Data Safe target database.

  • peer_target_database_id (Integer) —

    The unique id of the peer target database.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:



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
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 10985

def get_peer_target_database(target_database_id, peer_target_database_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#get_peer_target_database.' if logger

  raise "Missing the required parameter 'target_database_id' when calling get_peer_target_database." if target_database_id.nil?
  raise "Missing the required parameter 'peer_target_database_id' when calling get_peer_target_database." if peer_target_database_id.nil?
  raise "Parameter value for 'target_database_id' must not be blank" if OCI::Internal::Util.blank_string?(target_database_id)
  raise "Parameter value for 'peer_target_database_id' must not be blank" if OCI::Internal::Util.blank_string?(peer_target_database_id)

  path = '/targetDatabases/{targetDatabaseId}/peerTargetDatabases/{peerTargetDatabaseId}'.sub('{targetDatabaseId}', target_database_id.to_s).sub('{peerTargetDatabaseId}', peer_target_database_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#get_peer_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::PeerTargetDatabase'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_profile(user_assessment_id, profile_name, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_profile API.

Lists the details of given profile available on the target.

The GetProfile operation returns only the profiles in the specified 'userAssessmentId'. This does not include any subcompartments of the current compartment.

Parameters:

  • user_assessment_id (String) —

    The OCID of the user assessment.

  • profile_name (String) —

    Profile name to get detailed information .

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:



11046
11047
11048
11049
11050
11051
11052
11053
11054
11055
11056
11057
11058
11059
11060
11061
11062
11063
11064
11065
11066
11067
11068
11069
11070
11071
11072
11073
11074
11075
11076
11077
11078
11079
11080
11081
11082
11083
11084
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 11046

def get_profile(user_assessment_id, profile_name, opts = {})
  logger.debug 'Calling operation DataSafeClient#get_profile.' if logger

  raise "Missing the required parameter 'user_assessment_id' when calling get_profile." if user_assessment_id.nil?
  raise "Missing the required parameter 'profile_name' when calling get_profile." if profile_name.nil?
  raise "Parameter value for 'user_assessment_id' must not be blank" if OCI::Internal::Util.blank_string?(user_assessment_id)
  raise "Parameter value for 'profile_name' must not be blank" if OCI::Internal::Util.blank_string?(profile_name)

  path = '/userAssessments/{userAssessmentId}/profiles/{profileName}'.sub('{userAssessmentId}', user_assessment_id.to_s).sub('{profileName}', profile_name.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#get_profile') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'Array<OCI::DataSafe::Models::Profile>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_referential_relation(sensitive_data_model_id, referential_relation_key, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_referential_relation API.

Gets the details of the specified referential relation.

Parameters:

  • sensitive_data_model_id (String) —

    The OCID of the sensitive data model.

  • referential_relation_key (String) —

    The unique key that identifies the referential relation. It's numeric and unique within a sensitive data model.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:



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
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 11104

def get_referential_relation(sensitive_data_model_id, referential_relation_key, opts = {})
  logger.debug 'Calling operation DataSafeClient#get_referential_relation.' if logger

  raise "Missing the required parameter 'sensitive_data_model_id' when calling get_referential_relation." if sensitive_data_model_id.nil?
  raise "Missing the required parameter 'referential_relation_key' when calling get_referential_relation." if referential_relation_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 'referential_relation_key' must not be blank" if OCI::Internal::Util.blank_string?(referential_relation_key)

  path = '/sensitiveDataModels/{sensitiveDataModelId}/referentialRelations/{referentialRelationKey}'.sub('{sensitiveDataModelId}', sensitive_data_model_id.to_s).sub('{referentialRelationKey}', referential_relation_key.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#get_referential_relation') 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::ReferentialRelation'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_report(report_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_report API.

Gets a report by identifier

Parameters:

  • report_id (String) —

    Unique report identifier

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:



11160
11161
11162
11163
11164
11165
11166
11167
11168
11169
11170
11171
11172
11173
11174
11175
11176
11177
11178
11179
11180
11181
11182
11183
11184
11185
11186
11187
11188
11189
11190
11191
11192
11193
11194
11195
11196
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 11160

def get_report(report_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#get_report.' if logger

  raise "Missing the required parameter 'report_id' when calling get_report." if report_id.nil?
  raise "Parameter value for 'report_id' must not be blank" if OCI::Internal::Util.blank_string?(report_id)

  path = '/reports/{reportId}'.sub('{reportId}', report_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#get_report') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataSafe::Models::Report'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_report_content(report_id, opts = {}, &block) ⇒ Response

Note:

Click here to see an example of how to use get_report_content API.

Downloads the specified report in the form of .xls or .pdf.

Parameters:

  • report_id (String) —

    Unique report identifier

  • opts (Hash) (defaults to: {}) —

    the optional parameters

  • [Block] (Hash) —

    a customizable set of options

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :response_target (String, IO) —

    Streaming http body into a file (specified by file name or File object) or IO object if the block is not given

Returns:

  • (Response) —

    A Response object with data of type String if response_target and block are not given, otherwise with nil data



11216
11217
11218
11219
11220
11221
11222
11223
11224
11225
11226
11227
11228
11229
11230
11231
11232
11233
11234
11235
11236
11237
11238
11239
11240
11241
11242
11243
11244
11245
11246
11247
11248
11249
11250
11251
11252
11253
11254
11255
11256
11257
11258
11259
11260
11261
11262
11263
11264
11265
11266
11267
11268
11269
11270
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
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 11216

def get_report_content(report_id, opts = {}, &block)
  logger.debug 'Calling operation DataSafeClient#get_report_content.' if logger

  raise "Missing the required parameter 'report_id' when calling get_report_content." if report_id.nil?
  raise "Parameter value for 'report_id' must not be blank" if OCI::Internal::Util.blank_string?(report_id)

  path = '/reports/{reportId}/content'.sub('{reportId}', report_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = opts[:accept] if opts[:accept]
  header_params[:accept] ||= 'application/json'
  header_params[:'accept-encoding'] = opts[:accept_encoding] if opts[:accept_encoding]
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#get_report_content') do
    if !block.nil?
      @api_client.call_api(
        :GET,
        path,
        endpoint,
        header_params: header_params,
        query_params: query_params,
        operation_signing_strategy: operation_signing_strategy,
        body: post_body,
        return_type: 'Stream',
        &block
      )
    elsif opts[:response_target]
      if opts[:response_target].respond_to? :write
        @api_client.call_api(
          :GET,
          path,
          endpoint,
          header_params: header_params,
          query_params: query_params,
          operation_signing_strategy: operation_signing_strategy,
          body: post_body,
          return_type: 'Stream',
          &proc { |chunk, _response| opts[:response_target].write(chunk) }
        )
      elsif opts[:response_target].is_a?(String)
        File.open(opts[:response_target], 'wb') do |output|
          return @api_client.call_api(
            :GET,
            path,
            endpoint,
            header_params: header_params,
            query_params: query_params,
            operation_signing_strategy: operation_signing_strategy,
            body: post_body,
            return_type: 'Stream',
            &proc { |chunk, _response| output.write(chunk) }
          )
        end
      end
    else
      @api_client.call_api(
        :GET,
        path,
        endpoint,
        header_params: header_params,
        query_params: query_params,
        operation_signing_strategy: operation_signing_strategy,
        body: post_body,
        return_type: 'String'
      )
    end
  end
  # rubocop:enable Metrics/BlockLength
end

#get_report_definition(report_definition_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_report_definition API.

Gets the details of report definition specified by the identifier

Parameters:

  • report_definition_id (String) —

    Unique report definition identifier

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:



11314
11315
11316
11317
11318
11319
11320
11321
11322
11323
11324
11325
11326
11327
11328
11329
11330
11331
11332
11333
11334
11335
11336
11337
11338
11339
11340
11341
11342
11343
11344
11345
11346
11347
11348
11349
11350
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 11314

def get_report_definition(report_definition_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#get_report_definition.' if logger

  raise "Missing the required parameter 'report_definition_id' when calling get_report_definition." if report_definition_id.nil?
  raise "Parameter value for 'report_definition_id' must not be blank" if OCI::Internal::Util.blank_string?(report_definition_id)

  path = '/reportDefinitions/{reportDefinitionId}'.sub('{reportDefinitionId}', report_definition_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#get_report_definition') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataSafe::Models::ReportDefinition'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_sdm_masking_policy_difference(sdm_masking_policy_difference_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_sdm_masking_policy_difference API.

Gets the details of the specified SDM Masking policy difference.

Parameters:

  • sdm_masking_policy_difference_id (String) —

    The OCID of the SDM masking policy difference.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:



11368
11369
11370
11371
11372
11373
11374
11375
11376
11377
11378
11379
11380
11381
11382
11383
11384
11385
11386
11387
11388
11389
11390
11391
11392
11393
11394
11395
11396
11397
11398
11399
11400
11401
11402
11403
11404
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 11368

def get_sdm_masking_policy_difference(sdm_masking_policy_difference_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#get_sdm_masking_policy_difference.' if logger

  raise "Missing the required parameter 'sdm_masking_policy_difference_id' when calling get_sdm_masking_policy_difference." if sdm_masking_policy_difference_id.nil?
  raise "Parameter value for 'sdm_masking_policy_difference_id' must not be blank" if OCI::Internal::Util.blank_string?(sdm_masking_policy_difference_id)

  path = '/sdmMaskingPolicyDifferences/{sdmMaskingPolicyDifferenceId}'.sub('{sdmMaskingPolicyDifferenceId}', sdm_masking_policy_difference_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#get_sdm_masking_policy_difference') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataSafe::Models::SdmMaskingPolicyDifference'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_security_assessment(security_assessment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_security_assessment API.

Gets the details of the specified security assessment.

Parameters:

  • security_assessment_id (String) —

    The OCID of the security assessment.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:



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
11451
11452
11453
11454
11455
11456
11457
11458
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 11422

def get_security_assessment(security_assessment_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#get_security_assessment.' if logger

  raise "Missing the required parameter 'security_assessment_id' when calling get_security_assessment." if security_assessment_id.nil?
  raise "Parameter value for 'security_assessment_id' must not be blank" if OCI::Internal::Util.blank_string?(security_assessment_id)

  path = '/securityAssessments/{securityAssessmentId}'.sub('{securityAssessmentId}', security_assessment_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#get_security_assessment') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataSafe::Models::SecurityAssessment'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_security_assessment_comparison(security_assessment_id, comparison_security_assessment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_security_assessment_comparison API.

Gets the details of the comparison report for the security assessments submitted for comparison.

Parameters:

  • security_assessment_id (String) —

    The OCID of the security assessment.

  • comparison_security_assessment_id (String) —

    The OCID of the security assessment baseline.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:



11477
11478
11479
11480
11481
11482
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
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 11477

def get_security_assessment_comparison(security_assessment_id, comparison_security_assessment_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#get_security_assessment_comparison.' if logger

  raise "Missing the required parameter 'security_assessment_id' when calling get_security_assessment_comparison." if security_assessment_id.nil?
  raise "Missing the required parameter 'comparison_security_assessment_id' when calling get_security_assessment_comparison." if comparison_security_assessment_id.nil?
  raise "Parameter value for 'security_assessment_id' must not be blank" if OCI::Internal::Util.blank_string?(security_assessment_id)
  raise "Parameter value for 'comparison_security_assessment_id' must not be blank" if OCI::Internal::Util.blank_string?(comparison_security_assessment_id)

  path = '/securityAssessments/{securityAssessmentId}/comparison/{comparisonSecurityAssessmentId}'.sub('{securityAssessmentId}', security_assessment_id.to_s).sub('{comparisonSecurityAssessmentId}', comparison_security_assessment_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#get_security_assessment_comparison') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataSafe::Models::SecurityAssessmentComparison'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_security_policy(security_policy_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_security_policy API.

Gets a security policy by the specified OCID of the security policy resource.

Parameters:

  • security_policy_id (String) —

    The OCID of the security policy resource.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:



11533
11534
11535
11536
11537
11538
11539
11540
11541
11542
11543
11544
11545
11546
11547
11548
11549
11550
11551
11552
11553
11554
11555
11556
11557
11558
11559
11560
11561
11562
11563
11564
11565
11566
11567
11568
11569
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 11533

def get_security_policy(security_policy_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#get_security_policy.' if logger

  raise "Missing the required parameter 'security_policy_id' when calling get_security_policy." if security_policy_id.nil?
  raise "Parameter value for 'security_policy_id' must not be blank" if OCI::Internal::Util.blank_string?(security_policy_id)

  path = '/securityPolicies/{securityPolicyId}'.sub('{securityPolicyId}', security_policy_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#get_security_policy') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataSafe::Models::SecurityPolicy'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_security_policy_config(security_policy_config_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_security_policy_config API.

Gets a security policy configuration by identifier.

Parameters:

  • security_policy_config_id (String) —

    The OCID of the security policy configuration resource.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:



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 11587

def get_security_policy_config(security_policy_config_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#get_security_policy_config.' if logger

  raise "Missing the required parameter 'security_policy_config_id' when calling get_security_policy_config." if security_policy_config_id.nil?
  raise "Parameter value for 'security_policy_config_id' must not be blank" if OCI::Internal::Util.blank_string?(security_policy_config_id)

  path = '/securityPolicyConfigs/{securityPolicyConfigId}'.sub('{securityPolicyConfigId}', security_policy_config_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#get_security_policy_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::SecurityPolicyConfig'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_security_policy_deployment(security_policy_deployment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_security_policy_deployment API.

Gets a security policy deployment by identifier.

Parameters:

  • security_policy_deployment_id (String) —

    The OCID of the security policy deployment resource.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:



11641
11642
11643
11644
11645
11646
11647
11648
11649
11650
11651
11652
11653
11654
11655
11656
11657
11658
11659
11660
11661
11662
11663
11664
11665
11666
11667
11668
11669
11670
11671
11672
11673
11674
11675
11676
11677
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 11641

def get_security_policy_deployment(security_policy_deployment_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#get_security_policy_deployment.' if logger

  raise "Missing the required parameter 'security_policy_deployment_id' when calling get_security_policy_deployment." if security_policy_deployment_id.nil?
  raise "Parameter value for 'security_policy_deployment_id' must not be blank" if OCI::Internal::Util.blank_string?(security_policy_deployment_id)

  path = '/securityPolicyDeployments/{securityPolicyDeploymentId}'.sub('{securityPolicyDeploymentId}', security_policy_deployment_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#get_security_policy_deployment') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataSafe::Models::SecurityPolicyDeployment'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_security_policy_entry_state(security_policy_deployment_id, security_policy_entry_state_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_security_policy_entry_state API.

Gets a security policy entity states by identifier.

Parameters:

  • security_policy_deployment_id (String) —

    The OCID of the security policy deployment resource.

  • security_policy_entry_state_id (String) —

    Unique security policy entry state identifier. The unique id for a given security policy entry state can be obtained from the list api by passing the OCID of the corresponding security policy deployment resource as the query parameter.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:



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
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 11700

def get_security_policy_entry_state(security_policy_deployment_id, security_policy_entry_state_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#get_security_policy_entry_state.' if logger

  raise "Missing the required parameter 'security_policy_deployment_id' when calling get_security_policy_entry_state." if security_policy_deployment_id.nil?
  raise "Missing the required parameter 'security_policy_entry_state_id' when calling get_security_policy_entry_state." if security_policy_entry_state_id.nil?
  raise "Parameter value for 'security_policy_deployment_id' must not be blank" if OCI::Internal::Util.blank_string?(security_policy_deployment_id)
  raise "Parameter value for 'security_policy_entry_state_id' must not be blank" if OCI::Internal::Util.blank_string?(security_policy_entry_state_id)

  path = '/securityPolicyDeployments/{securityPolicyDeploymentId}/securityPolicyEntryStates/{securityPolicyEntryStateId}'.sub('{securityPolicyDeploymentId}', security_policy_deployment_id.to_s).sub('{securityPolicyEntryStateId}', security_policy_entry_state_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#get_security_policy_entry_state') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataSafe::Models::SecurityPolicyEntryState'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_security_policy_report(security_policy_report_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_security_policy_report API.

Gets a security policy report by the specified OCID of the security policy report resource.

Parameters:

  • security_policy_report_id (String) —

    The OCID of the security policy report resource.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:



11756
11757
11758
11759
11760
11761
11762
11763
11764
11765
11766
11767
11768
11769
11770
11771
11772
11773
11774
11775
11776
11777
11778
11779
11780
11781
11782
11783
11784
11785
11786
11787
11788
11789
11790
11791
11792
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 11756

def get_security_policy_report(security_policy_report_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#get_security_policy_report.' if logger

  raise "Missing the required parameter 'security_policy_report_id' when calling get_security_policy_report." if security_policy_report_id.nil?
  raise "Parameter value for 'security_policy_report_id' must not be blank" if OCI::Internal::Util.blank_string?(security_policy_report_id)

  path = '/securityPolicyReports/{securityPolicyReportId}'.sub('{securityPolicyReportId}', security_policy_report_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#get_security_policy_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::SecurityPolicyReport'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_sensitive_column(sensitive_data_model_id, sensitive_column_key, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_sensitive_column API.

Gets the details of the specified sensitive column.

Parameters:

  • sensitive_data_model_id (String) —

    The OCID of the sensitive data model.

  • sensitive_column_key (String) —

    The unique key that identifies the sensitive column. It's numeric and unique within a sensitive data model.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:



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
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 11811

def get_sensitive_column(sensitive_data_model_id, sensitive_column_key, opts = {})
  logger.debug 'Calling operation DataSafeClient#get_sensitive_column.' if logger

  raise "Missing the required parameter 'sensitive_data_model_id' when calling get_sensitive_column." if sensitive_data_model_id.nil?
  raise "Missing the required parameter 'sensitive_column_key' when calling get_sensitive_column." if sensitive_column_key.nil?
  raise "Parameter value for 'sensitive_data_model_id' must not be blank" if OCI::Internal::Util.blank_string?(sensitive_data_model_id)
  raise "Parameter value for 'sensitive_column_key' must not be blank" if OCI::Internal::Util.blank_string?(sensitive_column_key)

  path = '/sensitiveDataModels/{sensitiveDataModelId}/sensitiveColumns/{sensitiveColumnKey}'.sub('{sensitiveDataModelId}', sensitive_data_model_id.to_s).sub('{sensitiveColumnKey}', sensitive_column_key.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#get_sensitive_column') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataSafe::Models::SensitiveColumn'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_sensitive_data_model(sensitive_data_model_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_sensitive_data_model API.

Gets the details of the specified sensitive data model.

Parameters:

  • sensitive_data_model_id (String) —

    The OCID of the sensitive data model.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:



11867
11868
11869
11870
11871
11872
11873
11874
11875
11876
11877
11878
11879
11880
11881
11882
11883
11884
11885
11886
11887
11888
11889
11890
11891
11892
11893
11894
11895
11896
11897
11898
11899
11900
11901
11902
11903
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 11867

def get_sensitive_data_model(sensitive_data_model_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#get_sensitive_data_model.' if logger

  raise "Missing the required parameter 'sensitive_data_model_id' when calling get_sensitive_data_model." if sensitive_data_model_id.nil?
  raise "Parameter value for 'sensitive_data_model_id' must not be blank" if OCI::Internal::Util.blank_string?(sensitive_data_model_id)

  path = '/sensitiveDataModels/{sensitiveDataModelId}'.sub('{sensitiveDataModelId}', sensitive_data_model_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#get_sensitive_data_model') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataSafe::Models::SensitiveDataModel'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_sensitive_type(sensitive_type_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_sensitive_type API.

Gets the details of the specified sensitive type.

Parameters:

  • sensitive_type_id (String) —

    The OCID of the sensitive type.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:



11921
11922
11923
11924
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
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 11921

def get_sensitive_type(sensitive_type_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#get_sensitive_type.' if logger

  raise "Missing the required parameter 'sensitive_type_id' when calling get_sensitive_type." if sensitive_type_id.nil?
  raise "Parameter value for 'sensitive_type_id' must not be blank" if OCI::Internal::Util.blank_string?(sensitive_type_id)

  path = '/sensitiveTypes/{sensitiveTypeId}'.sub('{sensitiveTypeId}', sensitive_type_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#get_sensitive_type') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataSafe::Models::SensitiveType'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_sensitive_type_group(sensitive_type_group_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_sensitive_type_group API.

Gets the details of the specified sensitive type group.

Parameters:

  • sensitive_type_group_id (String) —

    The OCID of the sensitive type group.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:



11976
11977
11978
11979
11980
11981
11982
11983
11984
11985
11986
11987
11988
11989
11990
11991
11992
11993
11994
11995
11996
11997
11998
11999
12000
12001
12002
12003
12004
12005
12006
12007
12008
12009
12010
12011
12012
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 11976

def get_sensitive_type_group(sensitive_type_group_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#get_sensitive_type_group.' if logger

  raise "Missing the required parameter 'sensitive_type_group_id' when calling get_sensitive_type_group." if sensitive_type_group_id.nil?
  raise "Parameter value for 'sensitive_type_group_id' must not be blank" if OCI::Internal::Util.blank_string?(sensitive_type_group_id)

  path = '/sensitiveTypeGroups/{sensitiveTypeGroupId}'.sub('{sensitiveTypeGroupId}', sensitive_type_group_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#get_sensitive_type_group') 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::SensitiveTypeGroup'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_sensitive_types_export(sensitive_types_export_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_sensitive_types_export API.

Gets the details of the specified sensitive types export by identifier.

Parameters:

  • sensitive_types_export_id (String) —

    The OCID of the sensitive types export.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:



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
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 12030

def get_sensitive_types_export(sensitive_types_export_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#get_sensitive_types_export.' if logger

  raise "Missing the required parameter 'sensitive_types_export_id' when calling get_sensitive_types_export." if sensitive_types_export_id.nil?
  raise "Parameter value for 'sensitive_types_export_id' must not be blank" if OCI::Internal::Util.blank_string?(sensitive_types_export_id)

  path = '/sensitiveTypesExports/{sensitiveTypesExportId}'.sub('{sensitiveTypesExportId}', sensitive_types_export_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#get_sensitive_types_export') 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::SensitiveTypesExport'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_sql_collection(sql_collection_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_sql_collection API.

Gets a SQL collection by identifier.

Parameters:

  • sql_collection_id (String) —

    The OCID of the SQL collection resource.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:



12084
12085
12086
12087
12088
12089
12090
12091
12092
12093
12094
12095
12096
12097
12098
12099
12100
12101
12102
12103
12104
12105
12106
12107
12108
12109
12110
12111
12112
12113
12114
12115
12116
12117
12118
12119
12120
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 12084

def get_sql_collection(sql_collection_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#get_sql_collection.' if logger

  raise "Missing the required parameter 'sql_collection_id' when calling get_sql_collection." if sql_collection_id.nil?
  raise "Parameter value for 'sql_collection_id' must not be blank" if OCI::Internal::Util.blank_string?(sql_collection_id)

  path = '/sqlCollections/{sqlCollectionId}'.sub('{sqlCollectionId}', sql_collection_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#get_sql_collection') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataSafe::Models::SqlCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_sql_firewall_allowed_sql(sql_firewall_allowed_sql_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_sql_firewall_allowed_sql API.

Gets a SQL firewall allowed SQL by identifier.

Parameters:

  • sql_firewall_allowed_sql_id (String) —

    The OCID of the sqlFirewallAllowedSql resource.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:



12138
12139
12140
12141
12142
12143
12144
12145
12146
12147
12148
12149
12150
12151
12152
12153
12154
12155
12156
12157
12158
12159
12160
12161
12162
12163
12164
12165
12166
12167
12168
12169
12170
12171
12172
12173
12174
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 12138

def get_sql_firewall_allowed_sql(sql_firewall_allowed_sql_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#get_sql_firewall_allowed_sql.' if logger

  raise "Missing the required parameter 'sql_firewall_allowed_sql_id' when calling get_sql_firewall_allowed_sql." if sql_firewall_allowed_sql_id.nil?
  raise "Parameter value for 'sql_firewall_allowed_sql_id' must not be blank" if OCI::Internal::Util.blank_string?(sql_firewall_allowed_sql_id)

  path = '/sqlFirewallAllowedSqls/{sqlFirewallAllowedSqlId}'.sub('{sqlFirewallAllowedSqlId}', sql_firewall_allowed_sql_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#get_sql_firewall_allowed_sql') 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::SqlFirewallAllowedSql'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_sql_firewall_policy(sql_firewall_policy_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_sql_firewall_policy API.

Gets a SQL Firewall policy by identifier.

Parameters:

  • sql_firewall_policy_id (String) —

    The OCID of the SQL Firewall policy resource.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:



12192
12193
12194
12195
12196
12197
12198
12199
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
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 12192

def get_sql_firewall_policy(sql_firewall_policy_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#get_sql_firewall_policy.' if logger

  raise "Missing the required parameter 'sql_firewall_policy_id' when calling get_sql_firewall_policy." if sql_firewall_policy_id.nil?
  raise "Parameter value for 'sql_firewall_policy_id' must not be blank" if OCI::Internal::Util.blank_string?(sql_firewall_policy_id)

  path = '/sqlFirewallPolicies/{sqlFirewallPolicyId}'.sub('{sqlFirewallPolicyId}', sql_firewall_policy_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#get_sql_firewall_policy') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataSafe::Models::SqlFirewallPolicy'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_target_alert_policy_association(target_alert_policy_association_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_target_alert_policy_association API.

Gets the details of target-alert policy association by its ID.

Parameters:

  • target_alert_policy_association_id (String) —

    The OCID of the target-alert policy association.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:



12246
12247
12248
12249
12250
12251
12252
12253
12254
12255
12256
12257
12258
12259
12260
12261
12262
12263
12264
12265
12266
12267
12268
12269
12270
12271
12272
12273
12274
12275
12276
12277
12278
12279
12280
12281
12282
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 12246

def get_target_alert_policy_association(target_alert_policy_association_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#get_target_alert_policy_association.' if logger

  raise "Missing the required parameter 'target_alert_policy_association_id' when calling get_target_alert_policy_association." if target_alert_policy_association_id.nil?
  raise "Parameter value for 'target_alert_policy_association_id' must not be blank" if OCI::Internal::Util.blank_string?(target_alert_policy_association_id)

  path = '/targetAlertPolicyAssociations/{targetAlertPolicyAssociationId}'.sub('{targetAlertPolicyAssociationId}', target_alert_policy_association_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#get_target_alert_policy_association') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataSafe::Models::TargetAlertPolicyAssociation'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_target_database(target_database_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_target_database API.

Returns the details of the specified Data Safe target database.

Parameters:

  • target_database_id (String) —

    The OCID of the Data Safe target database.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:



12301
12302
12303
12304
12305
12306
12307
12308
12309
12310
12311
12312
12313
12314
12315
12316
12317
12318
12319
12320
12321
12322
12323
12324
12325
12326
12327
12328
12329
12330
12331
12332
12333
12334
12335
12336
12337
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 12301

def get_target_database(target_database_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#get_target_database.' if logger

  raise "Missing the required parameter 'target_database_id' when calling get_target_database." if target_database_id.nil?
  raise "Parameter value for 'target_database_id' must not be blank" if OCI::Internal::Util.blank_string?(target_database_id)

  path = '/targetDatabases/{targetDatabaseId}'.sub('{targetDatabaseId}', target_database_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#get_target_database') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataSafe::Models::TargetDatabase'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_target_database_group(target_database_group_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_target_database_group API.

Returns the details of the specified target database group.

Parameters:

  • target_database_group_id (String) —

    The OCID of the specified target database group.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:



12356
12357
12358
12359
12360
12361
12362
12363
12364
12365
12366
12367
12368
12369
12370
12371
12372
12373
12374
12375
12376
12377
12378
12379
12380
12381
12382
12383
12384
12385
12386
12387
12388
12389
12390
12391
12392
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 12356

def get_target_database_group(target_database_group_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#get_target_database_group.' if logger

  raise "Missing the required parameter 'target_database_group_id' when calling get_target_database_group." if target_database_group_id.nil?
  raise "Parameter value for 'target_database_group_id' must not be blank" if OCI::Internal::Util.blank_string?(target_database_group_id)

  path = '/targetDatabaseGroups/{targetDatabaseGroupId}'.sub('{targetDatabaseGroupId}', target_database_group_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#get_target_database_group') 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::TargetDatabaseGroup'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_template_baseline_comparison(security_assessment_id, comparison_security_assessment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_template_baseline_comparison API.

Gets the details of the comparison report for the security assessments submitted for comparison.

Parameters:

  • security_assessment_id (String) —

    The OCID of the security assessment.

  • comparison_security_assessment_id (String) —

    The OCID of the security assessment baseline.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :target_id (String) —

    A filter to return only items related to a specific target OCID.

  • :category (String) —

    The category of the finding.

  • :finding_key (String) —

    The unique key that identifies the finding. It is a string and unique within a security assessment.

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:



12414
12415
12416
12417
12418
12419
12420
12421
12422
12423
12424
12425
12426
12427
12428
12429
12430
12431
12432
12433
12434
12435
12436
12437
12438
12439
12440
12441
12442
12443
12444
12445
12446
12447
12448
12449
12450
12451
12452
12453
12454
12455
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 12414

def get_template_baseline_comparison(security_assessment_id, comparison_security_assessment_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#get_template_baseline_comparison.' if logger

  raise "Missing the required parameter 'security_assessment_id' when calling get_template_baseline_comparison." if security_assessment_id.nil?
  raise "Missing the required parameter 'comparison_security_assessment_id' when calling get_template_baseline_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}/templateBaselineComparison/{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 = {}
  query_params[:targetId] = opts[:target_id] if opts[:target_id]
  query_params[:category] = opts[:category] if opts[:category]
  query_params[:findingKey] = opts[:finding_key] if opts[:finding_key]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#get_template_baseline_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::SecurityAssessmentTemplateBaselineComparison'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_unified_audit_policy(unified_audit_policy_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_unified_audit_policy API.

Gets a Unified Audit policy by identifier.

Parameters:

  • unified_audit_policy_id (String) —

    The OCID of the Unified Audit policy resource.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:



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
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 12473

def get_unified_audit_policy(unified_audit_policy_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#get_unified_audit_policy.' if logger

  raise "Missing the required parameter 'unified_audit_policy_id' when calling get_unified_audit_policy." if unified_audit_policy_id.nil?
  raise "Parameter value for 'unified_audit_policy_id' must not be blank" if OCI::Internal::Util.blank_string?(unified_audit_policy_id)

  path = '/unifiedAuditPolicies/{unifiedAuditPolicyId}'.sub('{unifiedAuditPolicyId}', unified_audit_policy_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#get_unified_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::UnifiedAuditPolicy'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_unified_audit_policy_definition(unified_audit_policy_definition_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_unified_audit_policy_definition API.

Gets a unified audit policy definition by the specified OCID of the unified audit policy definition resource.

Parameters:

  • unified_audit_policy_definition_id (String) —

    The OCID of the unified audit policy definition resource.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:



12527
12528
12529
12530
12531
12532
12533
12534
12535
12536
12537
12538
12539
12540
12541
12542
12543
12544
12545
12546
12547
12548
12549
12550
12551
12552
12553
12554
12555
12556
12557
12558
12559
12560
12561
12562
12563
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 12527

def get_unified_audit_policy_definition(unified_audit_policy_definition_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#get_unified_audit_policy_definition.' if logger

  raise "Missing the required parameter 'unified_audit_policy_definition_id' when calling get_unified_audit_policy_definition." if unified_audit_policy_definition_id.nil?
  raise "Parameter value for 'unified_audit_policy_definition_id' must not be blank" if OCI::Internal::Util.blank_string?(unified_audit_policy_definition_id)

  path = '/unifiedAuditPolicyDefinitions/{unifiedAuditPolicyDefinitionId}'.sub('{unifiedAuditPolicyDefinitionId}', unified_audit_policy_definition_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#get_unified_audit_policy_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::UnifiedAuditPolicyDefinition'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_user_assessment(user_assessment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_user_assessment API.

Gets a user assessment by identifier.

Parameters:

  • user_assessment_id (String) —

    The OCID of the user assessment.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:



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
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 12581

def get_user_assessment(user_assessment_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#get_user_assessment.' if logger

  raise "Missing the required parameter 'user_assessment_id' when calling get_user_assessment." if user_assessment_id.nil?
  raise "Parameter value for 'user_assessment_id' must not be blank" if OCI::Internal::Util.blank_string?(user_assessment_id)

  path = '/userAssessments/{userAssessmentId}'.sub('{userAssessmentId}', user_assessment_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#get_user_assessment') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataSafe::Models::UserAssessment'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_user_assessment_comparison(user_assessment_id, comparison_user_assessment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_user_assessment_comparison API.

Gets the details of the comparison report for the user assessments submitted for comparison.

Parameters:

  • user_assessment_id (String) —

    The OCID of the user assessment.

  • comparison_user_assessment_id (String) —

    The OCID of the baseline user assessment.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:



12636
12637
12638
12639
12640
12641
12642
12643
12644
12645
12646
12647
12648
12649
12650
12651
12652
12653
12654
12655
12656
12657
12658
12659
12660
12661
12662
12663
12664
12665
12666
12667
12668
12669
12670
12671
12672
12673
12674
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 12636

def get_user_assessment_comparison(user_assessment_id, comparison_user_assessment_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#get_user_assessment_comparison.' if logger

  raise "Missing the required parameter 'user_assessment_id' when calling get_user_assessment_comparison." if user_assessment_id.nil?
  raise "Missing the required parameter 'comparison_user_assessment_id' when calling get_user_assessment_comparison." if comparison_user_assessment_id.nil?
  raise "Parameter value for 'user_assessment_id' must not be blank" if OCI::Internal::Util.blank_string?(user_assessment_id)
  raise "Parameter value for 'comparison_user_assessment_id' must not be blank" if OCI::Internal::Util.blank_string?(comparison_user_assessment_id)

  path = '/userAssessments/{userAssessmentId}/comparison/{comparisonUserAssessmentId}'.sub('{userAssessmentId}', user_assessment_id.to_s).sub('{comparisonUserAssessmentId}', comparison_user_assessment_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#get_user_assessment_comparison') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataSafe::Models::UserAssessmentComparison'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_work_request(work_request_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_work_request API.

Gets the details of the specified work request.

Parameters:

  • work_request_id (String) —

    The OCID of the work request.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:



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
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 12692

def get_work_request(work_request_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#get_work_request.' if logger

  raise "Missing the required parameter 'work_request_id' when calling get_work_request." if work_request_id.nil?
  raise "Parameter value for 'work_request_id' must not be blank" if OCI::Internal::Util.blank_string?(work_request_id)

  path = '/workRequests/{workRequestId}'.sub('{workRequestId}', work_request_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#get_work_request') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataSafe::Models::WorkRequest'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_alert_analytics(compartment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_alert_analytics API.

Returns the aggregation details of the alerts.

Allowed values are: displayName, timeCreated

Parameters:

  • compartment_id (String) —

    A filter to return only resources that match the specified compartment OCID.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :compartment_id_in_subtree (BOOLEAN) —

    Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting. (default to false)

  • :limit (Integer) —

    For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

  • :page (String) —

    For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :time_started (DateTime) —

    An optional filter to return audit events whose creation time in the database is greater than and equal to the date-time specified, in the format defined by RFC3339.

  • :time_ended (DateTime) —

    An optional filter to return audit events whose creation time in the database is less than and equal to the date-time specified, in the format defined by RFC3339.

  • :query_time_zone (String) —

    Default time zone is UTC if no time zone provided. The date-time considerations of the resource will be in accordance with the specified time zone. (default to UTC)

  • :sort_order (String) —

    The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

  • :sort_by (String) —

    The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. If no value is specified timeCreated is default. (default to timeCreated)

  • :access_level (String) —

    Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed. (default to RESTRICTED) Allowed values are: RESTRICTED, ACCESSIBLE

  • :scim_query (String) —

    The scimQuery query parameter accepts filter expressions that use the syntax described in Section 3.2.2.2 of the System for Cross-Domain Identity Management (SCIM) specification, which is available at RFC3339. In SCIM filtering expressions, text, date, and time values must be enclosed in quotation marks, with date and time values using ISO-8601 format. (Numeric and boolean values should not be quoted.)

    Example: | query=(timeCreated ge "2021-06-04T01:00:26.000Z") and (targetNames eq "target_1") query=(featureDetails.userName eq "user") and (targetNames eq "target_1") Supported fields: severity status alertType targetIds targetNames operationTime lifecycleState displayName timeCreated timeUpdated featureDetails.* (* can be any field in nestedStrMap in Feature Attributes in Alert Summary. For example - userName,object,clientHostname,osUserName,clientIPs,clientId,commandText,commandParam,clientProgram,objectType,targetOwner)

  • :summary_field (Array<String>) —

    Specifies a subset of summarized fields to be returned in the response. Allowed values are: alertType, targetIds, targetNames, alertSeverity, alertStatus, timeCreated, policyId, open, closed, critical, high, medium, low, alertcount, alertPolicyRuleKey, alertPolicyRuleName, throttled

  • :group_by (Array<String>) —

    A groupBy can only be used in combination with summaryField parameter. A groupBy value has to be a subset of the values mentioned in summaryField parameter.

    Allowed values are: alertType, targetIds, targetNames, alertSeverity, alertStatus, timeCreated, policyId, alertPolicyRuleKey, alertPolicyRuleName

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

Returns:



12811
12812
12813
12814
12815
12816
12817
12818
12819
12820
12821
12822
12823
12824
12825
12826
12827
12828
12829
12830
12831
12832
12833
12834
12835
12836
12837
12838
12839
12840
12841
12842
12843
12844
12845
12846
12847
12848
12849
12850
12851
12852
12853
12854
12855
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
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 12811

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 alertPolicyRuleKey alertPolicyRuleName throttled]
  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, alertPolicyRuleKey, alertPolicyRuleName, throttled.'
      end
    end
  end


  group_by_allowable_values = %w[alertType targetIds targetNames alertSeverity alertStatus timeCreated policyId alertPolicyRuleKey alertPolicyRuleName]
  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, alertPolicyRuleKey, alertPolicyRuleName.'
      end
    end
  end

  path = '/alertAnalytics'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:compartmentIdInSubtree] = opts[:compartment_id_in_subtree] if !opts[:compartment_id_in_subtree].nil?
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:timeStarted] = opts[:time_started] if opts[:time_started]
  query_params[:timeEnded] = opts[:time_ended] if opts[:time_ended]
  query_params[:queryTimeZone] = opts[:query_time_zone] if opts[:query_time_zone]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:accessLevel] = opts[:access_level] if opts[:access_level]
  query_params[:scimQuery] = opts[:scim_query] if opts[:scim_query]
  query_params[:summaryField] = OCI::ApiClient.build_collection_params(opts[:summary_field], :multi) if opts[:summary_field] && !opts[:summary_field].empty?
  query_params[:groupBy] = OCI::ApiClient.build_collection_params(opts[:group_by], :multi) if opts[:group_by] && !opts[:group_by].empty?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#list_alert_analytics') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataSafe::Models::AlertAnalyticsCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_alert_policies(compartment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_alert_policies API.

Gets a list of all alert policies.

Allowed values are: displayName, timeCreated

Parameters:

  • compartment_id (String) —

    A filter to return only resources that match the specified compartment OCID.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :alert_policy_id (String) —

    A filter to return policy by it's OCID.

  • :type (String) —

    An optional filter to return only alert policies of a certain type.

  • :is_user_defined (BOOLEAN) —

    An optional filter to return only alert policies that are user-defined or not. (default to false)

  • :display_name (String) —

    A filter to return only resources that match the specified display name.

  • :lifecycle_state (String) —

    An optional filter to return only alert policies that have the given life-cycle state.

  • :limit (Integer) —

    For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

  • :page (String) —

    For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

  • :sort_order (String) —

    The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

  • :sort_by (String) —

    The field to sort by. Only one sort parameter may be provided. (default to timeCreated)

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :time_created_greater_than_or_equal_to (DateTime) —

    A filter to return only the resources that were created after the specified date and time, as defined by RFC3339. Using TimeCreatedGreaterThanOrEqualToQueryParam parameter retrieves all resources created after that date.

    Example: 2016-12-19T16:39:57.600Z

  • :time_created_less_than (DateTime) —

    Search for resources that were created before a specific date. Specifying this parameter corresponding timeCreatedLessThan parameter will retrieve all resources created before the specified created date, in "YYYY-MM-ddThh:mmZ" format with a Z offset, as defined by RFC 3339.

    Example: 2016-12-19T16:39:57.600Z

  • :compartment_id_in_subtree (BOOLEAN) —

    Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting. (default to false)

  • :access_level (String) —

    Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed. (default to RESTRICTED) Allowed values are: RESTRICTED, ACCESSIBLE

Returns:



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
13010
13011
13012
13013
13014
13015
13016
13017
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 12948

def list_alert_policies(compartment_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#list_alert_policies.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_alert_policies." if compartment_id.nil?

  if opts[:type] && !OCI::DataSafe::Models::ALERT_POLICY_TYPE_ENUM.include?(opts[:type])
    raise 'Invalid value for "type", must be one of the values in OCI::DataSafe::Models::ALERT_POLICY_TYPE_ENUM.'
  end

  if opts[:lifecycle_state] && !OCI::DataSafe::Models::ALERT_POLICY_LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::DataSafe::Models::ALERT_POLICY_LIFECYCLE_STATE_ENUM.'
  end

  if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of ASC, DESC.'
  end

  if opts[:sort_by] && !%w[displayName timeCreated].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of displayName, timeCreated.'
  end

  if opts[:access_level] && !%w[RESTRICTED ACCESSIBLE].include?(opts[:access_level])
    raise 'Invalid value for "access_level", must be one of RESTRICTED, ACCESSIBLE.'
  end

  path = '/alertPolicies'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:alertPolicyId] = opts[:alert_policy_id] if opts[:alert_policy_id]
  query_params[:type] = opts[:type] if opts[:type]
  query_params[:isUserDefined] = opts[:is_user_defined] if !opts[:is_user_defined].nil?
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:timeCreatedGreaterThanOrEqualTo] = opts[:time_created_greater_than_or_equal_to] if opts[:time_created_greater_than_or_equal_to]
  query_params[:timeCreatedLessThan] = opts[:time_created_less_than] if opts[:time_created_less_than]
  query_params[:compartmentIdInSubtree] = opts[:compartment_id_in_subtree] if !opts[:compartment_id_in_subtree].nil?
  query_params[:accessLevel] = opts[:access_level] if opts[:access_level]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#list_alert_policies') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataSafe::Models::AlertPolicyCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_alert_policy_rules(alert_policy_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_alert_policy_rules API.

Lists the rules of the specified alert policy. The alert policy is said to be satisfied when all rules in the policy evaulate to true. If there are three rules: rule1,rule2 and rule3, the policy is satisfied if rule1 AND rule2 AND rule3 is True.

Parameters:

  • alert_policy_id (String) —

    The OCID of the alert policy.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :limit (Integer) —

    For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

  • :page (String) —

    For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

Returns:



13039
13040
13041
13042
13043
13044
13045
13046
13047
13048
13049
13050
13051
13052
13053
13054
13055
13056
13057
13058
13059
13060
13061
13062
13063
13064
13065
13066
13067
13068
13069
13070
13071
13072
13073
13074
13075
13076
13077
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 13039

def list_alert_policy_rules(alert_policy_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#list_alert_policy_rules.' if logger

  raise "Missing the required parameter 'alert_policy_id' when calling list_alert_policy_rules." if alert_policy_id.nil?
  raise "Parameter value for 'alert_policy_id' must not be blank" if OCI::Internal::Util.blank_string?(alert_policy_id)

  path = '/alertPolicies/{alertPolicyId}/rules'.sub('{alertPolicyId}', alert_policy_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#list_alert_policy_rules') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataSafe::Models::AlertPolicyRuleCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_alerts(compartment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_alerts API.

Gets a list of all alerts.

Allowed values are: displayName, timeCreated

Parameters:

  • compartment_id (String) —

    A filter to return only resources that match the specified compartment OCID.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :id (String) —

    A filter to return alert by it's OCID.

  • :compartment_id_in_subtree (BOOLEAN) —

    Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting. (default to false)

  • :limit (Integer) —

    For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

  • :page (String) —

    For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :access_level (String) —

    Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed. (default to RESTRICTED) Allowed values are: RESTRICTED, ACCESSIBLE

  • :sort_order (String) —

    The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

  • :sort_by (String) —

    The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. If no value is specified timeCreated is default. (default to timeCreated)

  • :scim_query (String) —

    The scimQuery query parameter accepts filter expressions that use the syntax described in Section 3.2.2.2 of the System for Cross-Domain Identity Management (SCIM) specification, which is available at RFC3339. In SCIM filtering expressions, text, date, and time values must be enclosed in quotation marks, with date and time values using ISO-8601 format. (Numeric and boolean values should not be quoted.)

    Example: | query=(timeCreated ge "2021-06-04T01:00:26.000Z") and (targetNames eq "target_1") query=(featureDetails.userName eq "user") and (targetNames eq "target_1") Supported fields: severity status alertType targetIds targetNames operationTime lifecycleState displayName timeCreated timeUpdated featureDetails.* (* can be any field in nestedStrMap in Feature Attributes in Alert Summary. For example - userName,object,clientHostname,osUserName,clientIPs,clientId,commandText,commandParam,clientProgram,objectType,targetOwner)

  • :field (Array<String>) —

    Specifies a subset of fields to be returned in the response. Allowed values are: id, displayName, alertType, targetIds, targetNames, severity, status, operationTime, operation, operationStatus, timeCreated, timeUpdated, policyId, lifecycleState

Returns:



13138
13139
13140
13141
13142
13143
13144
13145
13146
13147
13148
13149
13150
13151
13152
13153
13154
13155
13156
13157
13158
13159
13160
13161
13162
13163
13164
13165
13166
13167
13168
13169
13170
13171
13172
13173
13174
13175
13176
13177
13178
13179
13180
13181
13182
13183
13184
13185
13186
13187
13188
13189
13190
13191
13192
13193
13194
13195
13196
13197
13198
13199
13200
13201
13202
13203
13204
13205
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 13138

def list_alerts(compartment_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#list_alerts.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_alerts." if compartment_id.nil?

  if opts[:access_level] && !%w[RESTRICTED ACCESSIBLE].include?(opts[:access_level])
    raise 'Invalid value for "access_level", must be one of RESTRICTED, ACCESSIBLE.'
  end

  if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of ASC, DESC.'
  end

  if opts[:sort_by] && !%w[displayName timeCreated].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of displayName, timeCreated.'
  end


  field_allowable_values = %w[id displayName alertType targetIds targetNames severity status operationTime operation operationStatus timeCreated timeUpdated policyId lifecycleState]
  if opts[:field] && !opts[:field].empty?
    opts[:field].each do |val_to_check|
      unless field_allowable_values.include?(val_to_check)
        raise 'Invalid value for "field", must be one of id, displayName, alertType, targetIds, targetNames, severity, status, operationTime, operation, operationStatus, timeCreated, timeUpdated, policyId, lifecycleState.'
      end
    end
  end

  path = '/alerts'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:id] = opts[:id] if opts[:id]
  query_params[:compartmentIdInSubtree] = opts[:compartment_id_in_subtree] if !opts[:compartment_id_in_subtree].nil?
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:accessLevel] = opts[:access_level] if opts[:access_level]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:scimQuery] = opts[:scim_query] if opts[:scim_query]
  query_params[:field] = OCI::ApiClient.build_collection_params(opts[:field], :multi) if opts[:field] && !opts[:field].empty?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#list_alerts') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataSafe::Models::AlertCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_associated_resources(attribute_set_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_associated_resources API.

Returns list of all associated resources.

Parameters:

  • attribute_set_id (String) —

    OCID of an attribute set.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

  • :limit (Integer) —

    For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

  • :page (String) —

    For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

  • :associated_resource_type (String) —

    A filter to return attribute set associated resources that matches the specified resource type query param.

  • :associated_resource_id (String) —

    A filter to return attribute set associated resource that matches the specified associated resource id query param.

Returns:



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
13275
13276
13277
13278
13279
13280
13281
13282
13283
13284
13285
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 13238

def list_associated_resources(attribute_set_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#list_associated_resources.' if logger

  raise "Missing the required parameter 'attribute_set_id' when calling list_associated_resources." if attribute_set_id.nil?

  if opts[:associated_resource_type] && !OCI::DataSafe::Models::AssociatedResourceSummary::ASSOCIATED_RESOURCE_TYPE_ENUM.include?(opts[:associated_resource_type])
    raise 'Invalid value for "associated_resource_type", must be one of the values in OCI::DataSafe::Models::AssociatedResourceSummary::ASSOCIATED_RESOURCE_TYPE_ENUM.'
  end
  raise "Parameter value for 'attribute_set_id' must not be blank" if OCI::Internal::Util.blank_string?(attribute_set_id)

  path = '/attributeSets/{attributeSetId}/associatedResources'.sub('{attributeSetId}', attribute_set_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[:associatedResourceType] = opts[:associated_resource_type] if opts[:associated_resource_type]
  query_params[:associatedResourceId] = opts[:associated_resource_id] if opts[:associated_resource_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]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#list_associated_resources') 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::AssociatedResourceCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_attribute_sets(compartment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_attribute_sets API.

Retrieves the list of attribute sets.

The ListAttributeSets operation returns only the attribute sets in the specified compartmentId.

The parameter accessLevel specifies whether to return only those compartments for which the requester 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 ListAttributeSet on the compartmentId passed and when it is set to true, the entire hierarchy of compartments can be returned. To get a full list of all compartments and subcompartments in the tenancy (root compartment), set the parameter compartmentIdInSubtree to true and accessLevel to ACCESSIBLE.

Parameters:

  • compartment_id (String) —

    A filter to return only resources that match the specified compartment OCID.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :compartment_id_in_subtree (BOOLEAN) —

    Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting. (default to false)

  • :access_level (String) —

    Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed. (default to RESTRICTED) Allowed values are: RESTRICTED, ACCESSIBLE

  • :limit (Integer) —

    For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

  • :page (String) —

    For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

  • :display_name (String) —

    A filter to return only resources that match the specified display name.

  • :attribute_set_id (String) —

    A filter to return only attribute set resources that matches the specified attribute set OCID query param.

  • :attribute_set_type (String) —

    A filter to return only attribute set resources that matches the specified attribute set type query param.

  • :lifecycle_state (String) —

    The current state of an attribute set.

  • :sort_order (String) —

    The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

  • :sort_by (String) —

    The field used for sorting. Only one sorting order (sortOrder) can be specified. The default order for TIMECREATED is descending. The default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. (default to TIMECREATED) Allowed values are: TIMECREATED, DISPLAYNAME

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :is_user_defined (BOOLEAN) —

    A filter to return user defined or seeded attribute set resources that matches the specified is user defined query param. A true value indicates user defined attribute set. (default to true)

  • :in_use (String) —

    A filter to return attribute set resources that are in use by other associated resources. Allowed values are: YES, NO

Returns:



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
13394
13395
13396
13397
13398
13399
13400
13401
13402
13403
13404
13405
13406
13407
13408
13409
13410
13411
13412
13413
13414
13415
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 13343

def list_attribute_sets(compartment_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#list_attribute_sets.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_attribute_sets." 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[:attribute_set_type] && !OCI::DataSafe::Models::AttributeSet::ATTRIBUTE_SET_TYPE_ENUM.include?(opts[:attribute_set_type])
    raise 'Invalid value for "attribute_set_type", must be one of the values in OCI::DataSafe::Models::AttributeSet::ATTRIBUTE_SET_TYPE_ENUM.'
  end

  if opts[:lifecycle_state] && !OCI::DataSafe::Models::AttributeSet::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::DataSafe::Models::AttributeSet::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[:in_use] && !%w[YES NO].include?(opts[:in_use])
    raise 'Invalid value for "in_use", must be one of YES, NO.'
  end

  path = '/attributeSets'
  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[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:attributeSetId] = opts[:attribute_set_id] if opts[:attribute_set_id]
  query_params[:attributeSetType] = opts[:attribute_set_type] if opts[:attribute_set_type]
  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[:isUserDefined] = opts[:is_user_defined] if !opts[:is_user_defined].nil?
  query_params[:inUse] = opts[:in_use] if opts[:in_use]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#list_attribute_sets') 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::AttributeSetCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_audit_archive_retrievals(compartment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_audit_archive_retrievals API.

Returns the list of audit archive retrieval.

Parameters:

  • compartment_id (String) —

    A filter to return only resources that match the specified compartment OCID.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :display_name (String) —

    A filter to return only resources that match the specified display name.

  • :compartment_id_in_subtree (BOOLEAN) —

    Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting. (default to false)

  • :access_level (String) —

    Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed. (default to RESTRICTED) Allowed values are: RESTRICTED, ACCESSIBLE

  • :audit_archive_retrieval_id (String) —

    OCID of the archive retrieval.

  • :target_id (String) —

    The OCID of the target associated with the archive retrieval.

  • :target_database_group_id (String) —

    A filter to return the target database group that matches the specified OCID.

  • :limit (Integer) —

    For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

  • :page (String) —

    For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

  • :lifecycle_state (String) —

    A filter to return only resources that matches the specified lifecycle state.

  • :time_of_expiry (DateTime) —

    The date time when retrieved archive data will be deleted from Data Safe and unloaded back into archival.

  • :sort_order (String) —

    The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

  • :sort_by (String) —

    The field used for sorting. Only one sorting order (sortOrder) can be specified. The default order for TIMECREATED is descending. The default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. (default to TIMECREATED) Allowed values are: TIMECREATED, DISPLAYNAME

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:



13459
13460
13461
13462
13463
13464
13465
13466
13467
13468
13469
13470
13471
13472
13473
13474
13475
13476
13477
13478
13479
13480
13481
13482
13483
13484
13485
13486
13487
13488
13489
13490
13491
13492
13493
13494
13495
13496
13497
13498
13499
13500
13501
13502
13503
13504
13505
13506
13507
13508
13509
13510
13511
13512
13513
13514
13515
13516
13517
13518
13519
13520
13521
13522
13523
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 13459

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[:targetDatabaseGroupId] = opts[:target_database_group_id] if opts[:target_database_group_id]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:timeOfExpiry] = opts[:time_of_expiry] if opts[:time_of_expiry]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#list_audit_archive_retrievals') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataSafe::Models::AuditArchiveRetrievalCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_audit_event_analytics(compartment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_audit_event_analytics API.

By default the ListAuditEventAnalytics operation will return all of the summary columns. To filter for a specific summary column, specify it in the summaryField query parameter.

Example: /auditEventAnalytics?summaryField=targetName&summaryField=userName&summaryField=clientHostname &summaryField=dmls&summaryField=privilegeChanges&summaryField=ddls&summaryField=loginFailure&summaryField=loginSuccess &summaryField=allRecord&scimQuery=(auditEventTime ge "2021-06-13T23:49:14")

/auditEventAnalytics?timeStarted=2022-08-18T11:02:26.000Z&timeEnded=2022-08-24T11:02:26.000Z This will give number of events grouped by periods. Period can be 1 day, 1 week, etc.

/auditEventAnalytics?summaryField=targetName&groupBy=targetName This will give the number of events group by targetName. Only targetName summary column would be returned.

Parameters:

  • compartment_id (String) —

    A filter to return only resources that match the specified compartment OCID.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :limit (Integer) —

    For details about how pagination works, see List Pagination.

  • :page (String) —

    It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

  • :compartment_id_in_subtree (BOOLEAN) —

    Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting. (default to false)

  • :access_level (String) —

    Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed. (default to RESTRICTED) Allowed values are: RESTRICTED, ACCESSIBLE

  • :scim_query (String) —

    The scimQuery query parameter accepts filter expressions that use the syntax described in Section 3.2.2.2 of the System for Cross-Domain Identity Management (SCIM) specification, which is available at RFC3339. In SCIM filtering expressions, text, date, and time values must be enclosed in quotation marks, with date and time values using ISO-8601 format. (Numeric and boolean values should not be quoted.)

    Example: (auditEventTime ge "2021-06-04T01:00:26.000Z") and (eventName eq "LOGON") The attrExp or the field (for example, operationTime and eventName in above example) which is used to filter can be any of the fields returned by AuditEventSummary. adminUser, commonUser, sensitiveActivity, dsActivity can only have eq operation and value 1. These define admin user activity, common user activity, sensitive data activity and data safe activity Example: (adminUser eq 1)

  • :summary_field (Array<String>) —

    Specifies a subset of summarized fields to be returned in the response. Allowed values are: auditEventTime, dbUserName, targetId, targetName, targetClass, objectType, clientHostname, clientProgram, clientId, auditType, eventName, allRecord, auditSettingsChange, dbSchemaChange, entitlementChange, loginFailure, loginSuccess, allViolations, realmViolations, ruleViolations, dvconfigActivities, ddls, dmls, privilegeChanges, auditSettingsEnables, auditSettingsDisables, selects, creates, alters, drops, grants, revokes, objectOwner, auditPolicies, objectName, osUserName, errorCode, clientIp, externalUserId

  • :time_started (DateTime) —

    An optional filter to return audit events whose creation time in the database is greater than and equal to the date-time specified, in the format defined by RFC3339.

  • :time_ended (DateTime) —

    An optional filter to return audit events whose creation time in the database is less than and equal to the date-time specified, in the format defined by RFC3339.

  • :query_time_zone (String) —

    Default time zone is UTC if no time zone provided. The date-time considerations of the resource will be in accordance with the specified time zone. (default to UTC)

  • :group_by (Array<String>) —

    A groupBy can only be used in combination with summaryField parameter. A groupBy value has to be a subset of the values mentioned in summaryField parameter.

    Allowed values are: auditEventTime, dbUserName, targetId, targetName, targetClass, objectType, clientHostname, clientProgram, clientId, auditType, eventName, objectOwner, auditPolicies, objectName, osUserName, errorCode, clientIp, externalUserId

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

  • :sort_order (String) —

    The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

  • :sort_by (String) —

    If this query parameter is specified, the result is ordered based on this query parameter value. Allowed values are: targetId, targetClass, targetName, objectType, dbUserName, eventName, auditEventTime, clientHostname, clientProgram, clientId, auditType, objectOwner, auditPolicies, objectName, osUserName, errorCode, clientIp, externalUserId

Returns:



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
13635
13636
13637
13638
13639
13640
13641
13642
13643
13644
13645
13646
13647
13648
13649
13650
13651
13652
13653
13654
13655
13656
13657
13658
13659
13660
13661
13662
13663
13664
13665
13666
13667
13668
13669
13670
13671
13672
13673
13674
13675
13676
13677
13678
13679
13680
13681
13682
13683
13684
13685
13686
13687
13688
13689
13690
13691
13692
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 13609

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 objectOwner auditPolicies objectName osUserName errorCode clientIp externalUserId]
  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, objectOwner, auditPolicies, objectName, osUserName, errorCode, clientIp, externalUserId.'
      end
    end
  end


  group_by_allowable_values = %w[auditEventTime dbUserName targetId targetName targetClass objectType clientHostname clientProgram clientId auditType eventName objectOwner auditPolicies objectName osUserName errorCode clientIp externalUserId]
  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, objectOwner, auditPolicies, objectName, osUserName, errorCode, clientIp, externalUserId.'
      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 objectOwner auditPolicies objectName osUserName errorCode clientIp externalUserId].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, objectOwner, auditPolicies, objectName, osUserName, errorCode, clientIp, externalUserId.'
  end

  path = '/auditEventAnalytics'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:compartmentIdInSubtree] = opts[:compartment_id_in_subtree] if !opts[:compartment_id_in_subtree].nil?
  query_params[:accessLevel] = opts[:access_level] if opts[:access_level]
  query_params[:scimQuery] = opts[:scim_query] if opts[:scim_query]
  query_params[:summaryField] = OCI::ApiClient.build_collection_params(opts[:summary_field], :multi) if opts[:summary_field] && !opts[:summary_field].empty?
  query_params[:timeStarted] = opts[:time_started] if opts[:time_started]
  query_params[:timeEnded] = opts[:time_ended] if opts[:time_ended]
  query_params[:queryTimeZone] = opts[:query_time_zone] if opts[:query_time_zone]
  query_params[:groupBy] = OCI::ApiClient.build_collection_params(opts[:group_by], :multi) if opts[:group_by] && !opts[:group_by].empty?
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#list_audit_event_analytics') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataSafe::Models::AuditEventAnalyticsCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_audit_events(compartment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_audit_events API.

The ListAuditEvents operation returns specified compartmentId audit Events only. The list does not include any audit Events associated with the subcompartments of the specified compartmentId.

The parameter accessLevel specifies whether to return only those compartments for which the requestor has INSPECT permissions on at least one resource directly or indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if Principal doesn't have access to even one of the child compartments. This is valid only when compartmentIdInSubtree is set to true.

The parameter compartmentIdInSubtree applies when you perform ListAuditEvents on the compartmentId passed and when it is set to true, the entire hierarchy of compartments can be returned. To get a full list of all compartments and subcompartments in the tenancy (root compartment), set the parameter compartmentIdInSubtree to true and accessLevel to ACCESSIBLE.

Allowed values are: dbUserName, targetName, databaseType, targetClass, auditEventTime, timeCollected, osUserName, operation, operationStatus, eventName, errorCode, errorMessage, objectType, objectName, objectOwner, clientHostname, clientIp, isAlerted, actionTaken, clientProgram, commandText, commandParam, extendedEventAttributes, auditLocation, osTerminal, clientId, auditPolicies, auditType, externalUserId

Parameters:

  • compartment_id (String) —

    A filter to return only resources that match the specified compartment OCID.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :compartment_id_in_subtree (BOOLEAN) —

    Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting. (default to false)

  • :access_level (String) —

    Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed. (default to RESTRICTED) Allowed values are: RESTRICTED, ACCESSIBLE

  • :limit (Integer) —

    For details about how pagination works, see List Pagination.

  • :page (String) —

    It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

  • :scim_query (String) —

    The scimQuery query parameter accepts filter expressions that use the syntax described in Section 3.2.2.2 of the System for Cross-Domain Identity Management (SCIM) specification, which is available at RFC3339. In SCIM filtering expressions, text, date, and time values must be enclosed in quotation marks, with date and time values using ISO-8601 format. (Numeric and boolean values should not be quoted.)

    Example: (auditEventTime ge "2021-06-04T01:00:26.000Z") and (eventName eq "LOGON") The attrExp or the field (for example, operationTime and eventName in above example) which is used to filter can be any of the fields returned by AuditEventSummary. adminUser, commonUser, sensitiveActivity, dsActivity can only have eq operation and value 1. These define admin user activity, common user activity, sensitive data activity and data safe activity Example: (adminUser eq 1)

  • :sort_order (String) —

    The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

  • :sort_by (String) —

    If this query parameter is specified, the result is sorted by this query parameter value. (default to auditEventTime)

Returns:



13754
13755
13756
13757
13758
13759
13760
13761
13762
13763
13764
13765
13766
13767
13768
13769
13770
13771
13772
13773
13774
13775
13776
13777
13778
13779
13780
13781
13782
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
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 13754

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 externalUserId].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, externalUserId.'
  end

  path = '/auditEvents'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:compartmentIdInSubtree] = opts[:compartment_id_in_subtree] if !opts[:compartment_id_in_subtree].nil?
  query_params[:accessLevel] = opts[:access_level] if opts[:access_level]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:scimQuery] = opts[:scim_query] if opts[:scim_query]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json, application/xml'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#list_audit_events') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataSafe::Models::AuditEventCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_audit_policies(compartment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_audit_policies API.

Retrieves a list of all audited targets with their corresponding provisioned audit policies, and their provisioning conditions.

The ListAuditPolicies operation returns only the audit policies in the specified compartmentId. The list does not include any subcompartments of the compartmentId passed.

The parameter accessLevel specifies whether to return only those compartments for which the requestor has INSPECT permissions on at least one resource directly or indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if Principal doesn't have access to even one of the child compartments. This is valid only when compartmentIdInSubtree is set to true.

The parameter compartmentIdInSubtree applies when you perform ListAuditPolicies on the compartmentId passed and when it is set to true, the entire hierarchy of compartments can be returned. To get a full list of all compartments and subcompartments in the tenancy (root compartment), set the parameter compartmentIdInSubtree to true and accessLevel to ACCESSIBLE.

Parameters:

  • compartment_id (String) —

    A filter to return only resources that match the specified compartment OCID.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :compartment_id_in_subtree (BOOLEAN) —

    Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting. (default to false)

  • :access_level (String) —

    Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed. (default to RESTRICTED) Allowed values are: RESTRICTED, ACCESSIBLE

  • :display_name (String) —

    A filter to return only resources that match the specified display name.

  • :limit (Integer) —

    For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

  • :page (String) —

    For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

  • :target_id (String) —

    A filter to return only items related to a specific target OCID.

  • :target_database_group_id (String) —

    A filter to return the target database group that matches the specified OCID.

  • :lifecycle_state (String) —

    The current state of the audit policy.

  • :audit_policy_id (String) —

    An optional filter to return only resources that match the specified id.

  • :sort_order (String) —

    The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

  • :sort_by (String) —

    The field used for sorting. Only one sorting order (sortOrder) can be specified. The default order for TIMECREATED is descending. The default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. (default to TIMECREATED) Allowed values are: TIMECREATED, DISPLAYNAME

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:



13866
13867
13868
13869
13870
13871
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
13922
13923
13924
13925
13926
13927
13928
13929
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 13866

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[:targetDatabaseGroupId] = opts[:target_database_group_id] if opts[:target_database_group_id]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:auditPolicyId] = opts[:audit_policy_id] if opts[:audit_policy_id]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#list_audit_policies') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataSafe::Models::AuditPolicyCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_audit_policy_analytics(compartment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_audit_policy_analytics API.

Gets a list of aggregated audit policy details on the target databases. A audit policy aggregation helps understand the overall state of policies provisioned on targets. It is especially useful to create dashboards or to support analytics.

The parameter accessLevel specifies whether to return only those compartments for which the requestor has INSPECT permissions on at least one resource directly or indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if principal doesn't have access to even one of the child compartments. This is valid only when compartmentIdInSubtree is set to true.

The parameter compartmentIdInSubtree applies when you perform SummarizedAuditPolicyInfo on the specified compartmentId and when it is set to true, the entire hierarchy of compartments can be returned. To get a full list of all compartments and subcompartments in the tenancy (root compartment), set the parameter compartmentIdInSubtree to true and accessLevel to ACCESSIBLE.

Example: ListAuditPolicyAnalytics?groupBy=auditPolicyCategory

Parameters:

  • compartment_id (String) —

    A filter to return only resources that match the specified compartment OCID.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :compartment_id_in_subtree (BOOLEAN) —

    Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting. (default to false)

  • :access_level (String) —

    Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed. (default to RESTRICTED) Allowed values are: RESTRICTED, ACCESSIBLE

  • :limit (Integer) —

    For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

  • :page (String) —

    For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

  • :group_by (Array<String>) —

    The group by parameter to summarize audit policy aggregation. Allowed values are: auditPolicyCategory, auditPolicyName, targetId

  • :audit_policy_category (String) —

    The category to which the audit policy belongs to.

  • :audit_policy_name (String) —

    In case of seeded policies, it is the policy name defined by Data Safe. In case of custom Policies, it is the policy name that is used to create the policies on the target database. In case of Oracle Pre-seeded policies, it is the default policy name of the same.

  • :target_id (String) —

    A filter to return only items related to a specific target OCID.

  • :target_database_group_id (String) —

    A filter to return the target database group that matches the specified OCID.

  • :lifecycle_state (String) —

    The current state of the audit policy.

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:



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
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 13984

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[:targetDatabaseGroupId] = opts[:target_database_group_id] if opts[:target_database_group_id]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#list_audit_policy_analytics') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataSafe::Models::AuditPolicyAnalyticCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_audit_profile_analytics(compartment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_audit_profile_analytics API.

Gets a list of audit profile aggregated details . A audit profile aggregation helps understand the overall state of audit profile profiles. As an example, it helps understand how many audit profiles have paid usage. It is especially useful to create dashboards or to support analytics.

The parameter accessLevel specifies whether to return only those compartments for which the requestor has INSPECT permissions on at least one resource directly or indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if Principal doesn't have access to even one of the child compartments. This is valid only when compartmentIdInSubtree is set to true.

The parameter compartmentIdInSubtree applies when you perform AuditProfileAnalytics on the compartmentId passed and when it is set to true, the entire hierarchy of compartments can be returned. To get a full list of all compartments and subcompartments in the tenancy (root compartment), set the parameter compartmentIdInSubtree to true and accessLevel to ACCESSIBLE.

Parameters:

  • compartment_id (String) —

    A filter to return only resources that match the specified compartment OCID.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :compartment_id_in_subtree (BOOLEAN) —

    Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting. (default to false)

  • :access_level (String) —

    Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed. (default to RESTRICTED) Allowed values are: RESTRICTED, ACCESSIBLE

  • :limit (Integer) —

    For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

  • :page (String) —

    For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

  • :group_by (Array<String>) —

    The group by parameter for summarize operation on audit. Allowed values are: isPaidUsageEnabled, targetType, paidUsageSource, onlineMonthsSource, offlineMonthsSource

  • :target_type (String) —

    A optional filter to return only resources that belong to the specified audit profile type.

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:



14097
14098
14099
14100
14101
14102
14103
14104
14105
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
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 14097

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 targetType paidUsageSource onlineMonthsSource offlineMonthsSource]
  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, targetType, paidUsageSource, onlineMonthsSource, offlineMonthsSource.'
      end
    end
  end

  if opts[:target_type] && !OCI::DataSafe::Models::AUDIT_PROFILE_TARGET_TYPE_ENUM.include?(opts[:target_type])
    raise 'Invalid value for "target_type", must be one of the values in OCI::DataSafe::Models::AUDIT_PROFILE_TARGET_TYPE_ENUM.'
  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?
  query_params[:targetType] = opts[:target_type] if opts[:target_type]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#list_audit_profile_analytics') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataSafe::Models::AuditProfileAnalyticCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_audit_profiles(compartment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_audit_profiles API.

Gets a list of all audit profiles.

The ListAuditProfiles operation returns only the audit profiles in the specified compartmentId. The list does not include any subcompartments of the compartmentId passed.

The parameter accessLevel specifies whether to return only those compartments for which the requestor has INSPECT permissions on at least one resource directly or indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if Principal doesn't have access to even one of the child compartments. This is valid only when compartmentIdInSubtree is set to true.

The parameter compartmentIdInSubtree applies when you perform ListAuditProfiles on the compartmentId passed and when it is set to true, the entire hierarchy of compartments can be returned. To get a full list of all compartments and subcompartments in the tenancy (root compartment), set the parameter compartmentIdInSubtree to true and accessLevel to ACCESSIBLE.

Parameters:

  • compartment_id (String) —

    A filter to return only resources that match the specified compartment OCID.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :compartment_id_in_subtree (BOOLEAN) —

    Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting. (default to false)

  • :access_level (String) —

    Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed. (default to RESTRICTED) Allowed values are: RESTRICTED, ACCESSIBLE

  • :audit_profile_id (String) —

    A optional filter to return only resources that match the specified id.

  • :target_id (String) —

    A filter to return only items related to a specific target OCID.

  • :target_database_group_id (String) —

    A filter to return the target database group that matches the specified OCID.

  • :target_type (String) —

    A optional filter to return only resources that belong to the specified audit profile type.

  • :display_name (String) —

    A filter to return only resources that match the specified display name.

  • :limit (Integer) —

    For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

  • :page (String) —

    For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

  • :lifecycle_state (String) —

    A optional filter to return only resources that match the specified lifecycle state.

  • :is_override_global_retention_setting (BOOLEAN) —

    A optional filter to return only resources that match the specified retention configured value.

  • :is_paid_usage_enabled (BOOLEAN) —

    Indicates if you want to continue audit record collection beyond the free limit of one million audit records per month per target database, incurring additional charges. The default value is inherited from the global settings. You can change at the global level or at the target level.

  • :audit_collected_volume_greater_than_or_equal_to (Integer) —

    A filter to return only items that have count of audit records collected greater than or equal to the specified value.

  • :sort_order (String) —

    The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

  • :sort_by (String) —

    The field used for sorting. Only one sorting order (sortOrder) can be specified. The default order for TIMECREATED is descending. The default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. (default to TIMECREATED) Allowed values are: TIMECREATED, DISPLAYNAME

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:



14222
14223
14224
14225
14226
14227
14228
14229
14230
14231
14232
14233
14234
14235
14236
14237
14238
14239
14240
14241
14242
14243
14244
14245
14246
14247
14248
14249
14250
14251
14252
14253
14254
14255
14256
14257
14258
14259
14260
14261
14262
14263
14264
14265
14266
14267
14268
14269
14270
14271
14272
14273
14274
14275
14276
14277
14278
14279
14280
14281
14282
14283
14284
14285
14286
14287
14288
14289
14290
14291
14292
14293
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 14222

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[:target_type] && !OCI::DataSafe::Models::AUDIT_PROFILE_TARGET_TYPE_ENUM.include?(opts[:target_type])
    raise 'Invalid value for "target_type", must be one of the values in OCI::DataSafe::Models::AUDIT_PROFILE_TARGET_TYPE_ENUM.'
  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[:targetDatabaseGroupId] = opts[:target_database_group_id] if opts[:target_database_group_id]
  query_params[:targetType] = opts[:target_type] if opts[:target_type]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:isOverrideGlobalRetentionSetting] = opts[:is_override_global_retention_setting] if !opts[:is_override_global_retention_setting].nil?
  query_params[:isPaidUsageEnabled] = opts[:is_paid_usage_enabled] if !opts[:is_paid_usage_enabled].nil?
  query_params[:auditCollectedVolumeGreaterThanOrEqualTo] = opts[:audit_collected_volume_greater_than_or_equal_to] if opts[:audit_collected_volume_greater_than_or_equal_to]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#list_audit_profiles') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataSafe::Models::AuditProfileCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_audit_trail_analytics(compartment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_audit_trail_analytics API.

Gets a list of audit trail aggregated details . A audit trail aggregation helps understand the overall state of trails. As an example, it helps understand how many trails are running or stopped. It is especially useful to create dashboards or to support analytics.

The parameter accessLevel specifies whether to return only those compartments for which the requestor has INSPECT permissions on at least one resource directly or indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if Principal doesn't have access to even one of the child compartments. This is valid only when compartmentIdInSubtree is set to true.

The parameter compartmentIdInSubtree applies when you perform AuditTrailAnalytics on the compartmentId passed and when it is set to true, the entire hierarchy of compartments can be returned. To get a full list of all compartments and subcompartments in the tenancy (root compartment), set the parameter compartmentIdInSubtree to true and accessLevel to ACCESSIBLE.

Parameters:

  • compartment_id (String) —

    A filter to return only resources that match the specified compartment OCID.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :compartment_id_in_subtree (BOOLEAN) —

    Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting. (default to false)

  • :access_level (String) —

    Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed. (default to RESTRICTED) Allowed values are: RESTRICTED, ACCESSIBLE

  • :limit (Integer) —

    For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

  • :page (String) —

    For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

  • :group_by (Array<String>) —

    The group by parameter for summarize operation on audit trail. Allowed values are: location, lifecycleState, status, targetId

  • :target_id (String) —

    A filter to return only items related to a specific target OCID.

  • :time_started (DateTime) —

    An optional filter to return audit events whose creation time in the database is greater than and equal to the date-time specified, in the format defined by RFC3339.

  • :time_ended (DateTime) —

    An optional filter to return audit events whose creation time in the database is less than and equal to the date-time specified, in the format defined by RFC3339.

  • :query_time_zone (String) —

    Default time zone is UTC if no time zone provided. The date-time considerations of the resource will be in accordance with the specified time zone. (default to UTC)

  • :target_database_group_id (String) —

    A filter to return the target database group that matches the specified OCID.

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:



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
14379
14380
14381
14382
14383
14384
14385
14386
14387
14388
14389
14390
14391
14392
14393
14394
14395
14396
14397
14398
14399
14400
14401
14402
14403
14404
14405
14406
14407
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 14347

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]
  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[:targetDatabaseGroupId] = opts[:target_database_group_id] if opts[:target_database_group_id]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#list_audit_trail_analytics') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataSafe::Models::AuditTrailAnalyticCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_audit_trails(compartment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_audit_trails API.

Gets a list of all audit trails. The ListAuditTrails operation returns only the audit trails in the specified compartmentId. The list does not include any subcompartments of the compartmentId passed.

The parameter accessLevel specifies whether to return only those compartments for which the requestor has INSPECT permissions on at least one resource directly or indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if Principal doesn't have access to even one of the child compartments. This is valid only when compartmentIdInSubtree is set to true.

The parameter compartmentIdInSubtree applies when you perform ListAuditTrails on the compartmentId passed and when it is set to true, the entire hierarchy of compartments can be returned. To get a full list of all compartments and subcompartments in the tenancy (root compartment), set the parameter compartmentIdInSubtree to true and accessLevel to ACCESSIBLE.

Parameters:

  • compartment_id (String) —

    A filter to return only resources that match the specified compartment OCID.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :compartment_id_in_subtree (BOOLEAN) —

    Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting. (default to false)

  • :access_level (String) —

    Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed. (default to RESTRICTED) Allowed values are: RESTRICTED, ACCESSIBLE

  • :audit_trail_id (String) —

    A optional filter to return only resources that match the specified id.

  • :display_name (String) —

    A filter to return only resources that match the specified display name.

  • :target_id (String) —

    A filter to return only items related to a specific target OCID.

  • :target_database_group_id (String) —

    A filter to return the target database group that matches the specified OCID.

  • :limit (Integer) —

    For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

  • :page (String) —

    For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

  • :lifecycle_state (String) —

    A optional filter to return only resources that match the specified lifecycle state.

  • :status (String) —

    A optional filter to return only resources that match the specified sub-state of audit trail.

  • :sort_order (String) —

    The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

  • :sort_by (String) —

    The field used for sorting. Only one sorting order (sortOrder) can be specified. The default order for TIMECREATED is descending. The default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. (default to TIMECREATED) Allowed values are: TIMECREATED, DISPLAYNAME

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:



14464
14465
14466
14467
14468
14469
14470
14471
14472
14473
14474
14475
14476
14477
14478
14479
14480
14481
14482
14483
14484
14485
14486
14487
14488
14489
14490
14491
14492
14493
14494
14495
14496
14497
14498
14499
14500
14501
14502
14503
14504
14505
14506
14507
14508
14509
14510
14511
14512
14513
14514
14515
14516
14517
14518
14519
14520
14521
14522
14523
14524
14525
14526
14527
14528
14529
14530
14531
14532
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 14464

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[:targetDatabaseGroupId] = opts[:target_database_group_id] if opts[:target_database_group_id]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:status] = opts[:status] if opts[:status]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#list_audit_trails') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataSafe::Models::AuditTrailCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_available_audit_volumes(audit_profile_id, work_request_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_available_audit_volumes API.

Retrieves a list of audit trails, and associated audit event volume for each trail up to defined start date. Allowed values are: monthInConsideration, volume, trailLocation

Parameters:

  • audit_profile_id (String) —

    The OCID of the audit.

  • work_request_id (String) —

    The OCID of the work request.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :trail_location (String) —

    The audit trail location.

  • :month_in_consideration_greater_than (DateTime) —

    Specifying monthInConsiderationGreaterThan parameter will retrieve all items for which the event month is greater than the date and time specified, in the format defined by RFC3339.

    Example: 2016-12-19T00:00:00.000Z

  • :month_in_consideration_less_than (DateTime) —

    Specifying monthInConsiderationLessThan parameter will retrieve all items for which the event month is less than the date and time specified, in the format defined by RFC3339.

    Example: 2016-12-19T00:00:00.000Z

  • :limit (Integer) —

    For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

  • :page (String) —

    For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

  • :sort_order (String) —

    The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

  • :sort_by (String) —

    The field to sort by. You can specify only one sort order(sortOrder). The default order for all fields is ascending. (default to monthInConsideration)

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:



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
14599
14600
14601
14602
14603
14604
14605
14606
14607
14608
14609
14610
14611
14612
14613
14614
14615
14616
14617
14618
14619
14620
14621
14622
14623
14624
14625
14626
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 14573

def list_available_audit_volumes(audit_profile_id, work_request_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#list_available_audit_volumes.' if logger

  raise "Missing the required parameter 'audit_profile_id' when calling list_available_audit_volumes." if audit_profile_id.nil?
  raise "Missing the required parameter 'work_request_id' when calling list_available_audit_volumes." if work_request_id.nil?

  if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of ASC, DESC.'
  end

  if opts[:sort_by] && !%w[monthInConsideration volume trailLocation].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of monthInConsideration, volume, trailLocation.'
  end
  raise "Parameter value for 'audit_profile_id' must not be blank" if OCI::Internal::Util.blank_string?(audit_profile_id)

  path = '/auditProfiles/{auditProfileId}/availableAuditVolumes'.sub('{auditProfileId}', audit_profile_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:workRequestId] = work_request_id
  query_params[:trailLocation] = opts[:trail_location] if opts[:trail_location]
  query_params[:monthInConsiderationGreaterThan] = opts[:month_in_consideration_greater_than] if opts[:month_in_consideration_greater_than]
  query_params[:monthInConsiderationLessThan] = opts[:month_in_consideration_less_than] if opts[:month_in_consideration_less_than]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#list_available_audit_volumes') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataSafe::Models::AvailableAuditVolumeCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_checks(security_assessment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_checks API.

Lists all the security checks in the specified compartment for security assessment of type TEMPLATE.

Allowed values are: title, category, key

Parameters:

  • security_assessment_id (String) —

    The OCID of the security assessment.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :limit (Integer) —

    For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

  • :page (String) —

    For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

  • :sort_order (String) —

    The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

  • :sort_by (String) —

    The field to sort by. You can specify only one sort order(sortOrder). The default order for title is ascending. (default to title)

  • :suggested_severity (String) —

    A filter to return only checks of a particular risk level. Allowed values are: HIGH, MEDIUM, LOW, EVALUATE, ADVISORY, PASS, DEFERRED

  • :contains_severity (Array<String>) —

    A filter to return only findings that match the specified risk level(s). Use containsSeverity parameter if need to filter by multiple risk levels. Allowed values are: HIGH, MEDIUM, LOW, EVALUATE, ADVISORY, PASS, DEFERRED

  • :contains_references (Array<String>) —

    An optional filter to return only findings that match the specified references. Use containsReferences param if need to filter by multiple references. Allowed values are: STIG, CIS, GDPR

  • :compartment_id_in_subtree (BOOLEAN) —

    Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting. (default to false)

  • :access_level (String) —

    Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed. (default to RESTRICTED) Allowed values are: RESTRICTED, ACCESSIBLE

  • :key (String) —

    Each check in security assessment has an associated key (think of key as a check's name). For a given check, the key will be the same across targets. The user can use these keys to filter the checks.

Returns:



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
14740
14741
14742
14743
14744
14745
14746
14747
14748
14749
14750
14751
14752
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 14670

def list_checks(security_assessment_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#list_checks.' if logger

  raise "Missing the required parameter 'security_assessment_id' when calling list_checks." if security_assessment_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[title category key].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of title, category, key.'
  end

  if opts[:suggested_severity] && !%w[HIGH MEDIUM LOW EVALUATE ADVISORY PASS DEFERRED].include?(opts[:suggested_severity])
    raise 'Invalid value for "suggested_severity", must be one of HIGH, MEDIUM, LOW, EVALUATE, ADVISORY, PASS, DEFERRED.'
  end


  contains_severity_allowable_values = %w[HIGH MEDIUM LOW EVALUATE ADVISORY PASS DEFERRED]
  if opts[:contains_severity] && !opts[:contains_severity].empty?
    opts[:contains_severity].each do |val_to_check|
      unless contains_severity_allowable_values.include?(val_to_check)
        raise 'Invalid value for "contains_severity", must be one of HIGH, MEDIUM, LOW, EVALUATE, ADVISORY, PASS, DEFERRED.'
      end
    end
  end


  contains_references_allowable_values = %w[STIG CIS GDPR]
  if opts[:contains_references] && !opts[:contains_references].empty?
    opts[:contains_references].each do |val_to_check|
      unless contains_references_allowable_values.include?(val_to_check)
        raise 'Invalid value for "contains_references", must be one of STIG, CIS, GDPR.'
      end
    end
  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}/checks'.sub('{securityAssessmentId}', security_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[: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[:suggestedSeverity] = opts[:suggested_severity] if opts[:suggested_severity]
  query_params[:containsSeverity] = OCI::ApiClient.build_collection_params(opts[:contains_severity], :multi) if opts[:contains_severity] && !opts[:contains_severity].empty?
  query_params[:containsReferences] = OCI::ApiClient.build_collection_params(opts[:contains_references], :multi) if opts[:contains_references] && !opts[:contains_references].empty?
  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[:key] = opts[:key] if opts[:key]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#list_checks') 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::CheckSummary>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_collected_audit_volumes(audit_profile_id, work_request_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_collected_audit_volumes API.

Gets a list of all collected audit volume data points. Allowed values are: monthInConsideration, onlineVolume, archivedVolume

Parameters:

  • audit_profile_id (String) —

    The OCID of the audit.

  • work_request_id (String) —

    The OCID of the work request.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :month_in_consideration_greater_than (DateTime) —

    Specifying monthInConsiderationGreaterThan parameter will retrieve all items for which the event month is greater than the date and time specified, in the format defined by RFC3339.

    Example: 2016-12-19T00:00:00.000Z

  • :month_in_consideration_less_than (DateTime) —

    Specifying monthInConsiderationLessThan parameter will retrieve all items for which the event month is less than the date and time specified, in the format defined by RFC3339.

    Example: 2016-12-19T00:00:00.000Z

  • :limit (Integer) —

    For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

  • :page (String) —

    For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

  • :sort_order (String) —

    The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

  • :sort_by (String) —

    The field to sort by. You can specify only one sort order(sortOrder). The default order for all fields is ascending. (default to monthInConsideration)

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:



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
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 14792

def list_collected_audit_volumes(audit_profile_id, work_request_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#list_collected_audit_volumes.' if logger

  raise "Missing the required parameter 'audit_profile_id' when calling list_collected_audit_volumes." if audit_profile_id.nil?
  raise "Missing the required parameter 'work_request_id' when calling list_collected_audit_volumes." if work_request_id.nil?

  if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of ASC, DESC.'
  end

  if opts[:sort_by] && !%w[monthInConsideration onlineVolume archivedVolume].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of monthInConsideration, onlineVolume, archivedVolume.'
  end
  raise "Parameter value for 'audit_profile_id' must not be blank" if OCI::Internal::Util.blank_string?(audit_profile_id)

  path = '/auditProfiles/{auditProfileId}/collectedAuditVolumes'.sub('{auditProfileId}', audit_profile_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:workRequestId] = work_request_id
  query_params[:monthInConsiderationGreaterThan] = opts[:month_in_consideration_greater_than] if opts[:month_in_consideration_greater_than]
  query_params[:monthInConsiderationLessThan] = opts[:month_in_consideration_less_than] if opts[:month_in_consideration_less_than]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#list_collected_audit_volumes') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataSafe::Models::CollectedAuditVolumeCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_columns(target_database_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_columns API.

Returns a list of column metadata objects.

Allowed values are: SCHEMANAME, TABLENAME, COLUMNNAME, DATATYPE

Parameters:

  • target_database_id (String) —

    The OCID of the Data Safe target database.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :limit (Integer) —

    For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

  • :page (String) —

    For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

  • :schema_name (Array<String>) —

    A filter to return only items related to specific schema name.

  • :table_name (Array<String>) —

    A filter to return only items related to specific table name.

  • :column_name (Array<String>) —

    A filter to return only a specific column based on column name.

  • :datatype (Array<String>) —

    A filter to return only items related to specific datatype.

  • :sort_order (String) —

    The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

  • :sort_by (String) —

    The field used for sorting. Only one sorting order (sortOrder) can be specified. (default to COLUMNNAME)

  • :schema_name_contains (String) —

    A filter to return only items if schema name contains a specific string.

  • :table_name_contains (String) —

    A filter to return only items if table name contains a specific string.

  • :column_name_contains (String) —

    A filter to return only items if column name contains a specific string.

Returns:



14877
14878
14879
14880
14881
14882
14883
14884
14885
14886
14887
14888
14889
14890
14891
14892
14893
14894
14895
14896
14897
14898
14899
14900
14901
14902
14903
14904
14905
14906
14907
14908
14909
14910
14911
14912
14913
14914
14915
14916
14917
14918
14919
14920
14921
14922
14923
14924
14925
14926
14927
14928
14929
14930
14931
14932
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 14877

def list_columns(target_database_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#list_columns.' if logger

  raise "Missing the required parameter 'target_database_id' when calling list_columns." if target_database_id.nil?

  if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of ASC, DESC.'
  end

  if opts[:sort_by] && !%w[SCHEMANAME TABLENAME COLUMNNAME DATATYPE].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of SCHEMANAME, TABLENAME, COLUMNNAME, DATATYPE.'
  end
  raise "Parameter value for 'target_database_id' must not be blank" if OCI::Internal::Util.blank_string?(target_database_id)

  path = '/targetDatabases/{targetDatabaseId}/columns'.sub('{targetDatabaseId}', target_database_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:schemaName] = OCI::ApiClient.build_collection_params(opts[:schema_name], :multi) if opts[:schema_name] && !opts[:schema_name].empty?
  query_params[:tableName] = OCI::ApiClient.build_collection_params(opts[:table_name], :multi) if opts[:table_name] && !opts[:table_name].empty?
  query_params[:columnName] = OCI::ApiClient.build_collection_params(opts[:column_name], :multi) if opts[:column_name] && !opts[:column_name].empty?
  query_params[:datatype] = OCI::ApiClient.build_collection_params(opts[:datatype], :multi) if opts[:datatype] && !opts[:datatype].empty?
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:schemaNameContains] = opts[:schema_name_contains] if opts[:schema_name_contains]
  query_params[:tableNameContains] = opts[:table_name_contains] if opts[:table_name_contains]
  query_params[:columnNameContains] = opts[:column_name_contains] if opts[:column_name_contains]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#list_columns') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'Array<OCI::DataSafe::Models::ColumnSummary>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_data_safe_private_endpoints(compartment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_data_safe_private_endpoints API.

Gets a list of Data Safe private endpoints.

Parameters:

  • compartment_id (String) —

    A filter to return only resources that match the specified compartment OCID.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :display_name (String) —

    A filter to return only resources that match the specified display name.

  • :vcn_id (String) —

    A filter to return only resources that match the specified VCN OCID.

  • :lifecycle_state (String) —

    A filter to return only resources that match the specified lifecycle state.

  • :limit (Integer) —

    For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

  • :page (String) —

    For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

  • :sort_order (String) —

    The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

  • :sort_by (String) —

    The field used for sorting. Only one sorting order (sortOrder) can be specified. The default order for TIMECREATED is descending. The default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. (default to TIMECREATED) Allowed values are: TIMECREATED, DISPLAYNAME

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :compartment_id_in_subtree (BOOLEAN) —

    Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting. (default to false)

  • :access_level (String) —

    Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed. (default to RESTRICTED) Allowed values are: RESTRICTED, ACCESSIBLE

Returns:



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
14998
14999
15000
15001
15002
15003
15004
15005
15006
15007
15008
15009
15010
15011
15012
15013
15014
15015
15016
15017
15018
15019
15020
15021
15022
15023
15024
15025
15026
15027
15028
15029
15030
15031
15032
15033
15034
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 14973

def list_data_safe_private_endpoints(compartment_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#list_data_safe_private_endpoints.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_data_safe_private_endpoints." if compartment_id.nil?

  if opts[:lifecycle_state] && !OCI::DataSafe::Models::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::DataSafe::Models::LIFECYCLE_STATE_ENUM.'
  end

  if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of ASC, DESC.'
  end

  if opts[:sort_by] && !%w[TIMECREATED DISPLAYNAME].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of TIMECREATED, DISPLAYNAME.'
  end

  if opts[:access_level] && !%w[RESTRICTED ACCESSIBLE].include?(opts[:access_level])
    raise 'Invalid value for "access_level", must be one of RESTRICTED, ACCESSIBLE.'
  end

  path = '/dataSafePrivateEndpoints'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:vcnId] = opts[:vcn_id] if opts[:vcn_id]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:compartmentIdInSubtree] = opts[:compartment_id_in_subtree] if !opts[:compartment_id_in_subtree].nil?
  query_params[:accessLevel] = opts[:access_level] if opts[:access_level]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#list_data_safe_private_endpoints') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'Array<OCI::DataSafe::Models::DataSafePrivateEndpointSummary>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_database_security_configs(compartment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_database_security_configs API.

Retrieves a list of all database security configurations in Data Safe.

The ListDatabaseSecurityConfigs operation returns only the database security configurations in the specified compartmentId.

The parameter accessLevel specifies whether to return only those compartments for which the requestor has INSPECT permissions on at least one resource directly or indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if Principal doesn't have access to even one of the child compartments. This is valid only when compartmentIdInSubtree is set to true.

The parameter compartmentIdInSubtree applies when you perform ListDatabaseSecurityConfigs on the compartmentId passed and when it is set to true, the entire hierarchy of compartments can be returned. To get a full list of all compartments and subcompartments in the tenancy (root compartment), set the parameter compartmentIdInSubtree to true and accessLevel to ACCESSIBLE.

Parameters:

  • compartment_id (String) —

    A filter to return only resources that match the specified compartment OCID.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :compartment_id_in_subtree (BOOLEAN) —

    Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting. (default to false)

  • :access_level (String) —

    Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed. (default to RESTRICTED) Allowed values are: RESTRICTED, ACCESSIBLE

  • :display_name (String) —

    A filter to return only resources that match the specified display name.

  • :limit (Integer) —

    For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

  • :page (String) —

    For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

  • :lifecycle_state (String) —

    The current state of the database security configuration.

  • :database_security_config_id (String) —

    An optional filter to return only resources that match the specified OCID of the database security configuration resource.

  • :time_created_greater_than_or_equal_to (DateTime) —

    A filter to return only the resources that were created after the specified date and time, as defined by RFC3339. Using TimeCreatedGreaterThanOrEqualToQueryParam parameter retrieves all resources created after that date.

    Example: 2016-12-19T16:39:57.600Z

  • :time_created_less_than (DateTime) —

    Search for resources that were created before a specific date. Specifying this parameter corresponding timeCreatedLessThan parameter will retrieve all resources created before the specified created date, in "YYYY-MM-ddThh:mmZ" format with a Z offset, as defined by RFC 3339.

    Example: 2016-12-19T16:39:57.600Z

  • :target_id (String) —

    A filter to return only items related to a specific target OCID.

  • :target_database_group_id (String) —

    A filter to return the target database group that matches the specified OCID.

  • :sort_order (String) —

    The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

  • :sort_by (String) —

    The field used for sorting. Only one sorting order (sortOrder) can be specified. The default order for TIMECREATED is descending. The default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. (default to TIMECREATED) Allowed values are: TIMECREATED, DISPLAYNAME

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:



15103
15104
15105
15106
15107
15108
15109
15110
15111
15112
15113
15114
15115
15116
15117
15118
15119
15120
15121
15122
15123
15124
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
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 15103

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[:targetDatabaseGroupId] = opts[:target_database_group_id] if opts[:target_database_group_id]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#list_database_security_configs') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataSafe::Models::DatabaseSecurityConfigCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_database_table_access_entries(security_policy_report_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_database_table_access_entries API.

Retrieves a list of all database table access entries in Data Safe.

The ListDatabaseTableAccessEntries operation returns only the database table access reports for the specified security policy report.

Allowed values are: key, grantee, accessType, tableSchema, tableName, privilegeType, privilege, privilegeGrantable, grantFromRole, accessThroughObject, columnName, grantor, areAllTablesAccessible, isAccessConstrainedByView, isAccessConstrainedByLabelSecurity, isAccessConstrainedByDatabaseVault, isAccessConstrainedByVirtualPrivateDatabase, isAccessConstrainedByRedaction, isAccessConstrainedByRealApplicationSecurity, isAccessConstrainedBySqlFirewall, isSensitive

Parameters:

  • security_policy_report_id (String) —

    The OCID of the security policy report resource.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :limit (Integer) —

    For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

  • :page (String) —

    For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

  • :scim_query (String) —

    The scimQuery query parameter accepts filter expressions that use the syntax described in Section 3.2.2.2 of the System for Cross-Domain Identity Management (SCIM) specification, which is available at RFC3339. In SCIM filtering expressions, text, date, and time values must be enclosed in quotation marks, with date and time values using ISO-8601 format. (Numeric and boolean values should not be quoted.)

    Example: query=(accessType eq "SELECT") and (grantee eq "ADMIN")

  • :sort_by (String) —

    The field to sort by. Only one sort parameter should be provided. (default to key)

  • :sort_order (String) —

    The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:



15204
15205
15206
15207
15208
15209
15210
15211
15212
15213
15214
15215
15216
15217
15218
15219
15220
15221
15222
15223
15224
15225
15226
15227
15228
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
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 15204

def list_database_table_access_entries(security_policy_report_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#list_database_table_access_entries.' if logger

  raise "Missing the required parameter 'security_policy_report_id' when calling list_database_table_access_entries." if security_policy_report_id.nil?

  if opts[:sort_by] && !%w[key grantee accessType tableSchema tableName privilegeType privilege privilegeGrantable grantFromRole accessThroughObject columnName grantor areAllTablesAccessible isAccessConstrainedByView isAccessConstrainedByLabelSecurity isAccessConstrainedByDatabaseVault isAccessConstrainedByVirtualPrivateDatabase isAccessConstrainedByRedaction isAccessConstrainedByRealApplicationSecurity isAccessConstrainedBySqlFirewall isSensitive].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of key, grantee, accessType, tableSchema, tableName, privilegeType, privilege, privilegeGrantable, grantFromRole, accessThroughObject, columnName, grantor, areAllTablesAccessible, isAccessConstrainedByView, isAccessConstrainedByLabelSecurity, isAccessConstrainedByDatabaseVault, isAccessConstrainedByVirtualPrivateDatabase, isAccessConstrainedByRedaction, isAccessConstrainedByRealApplicationSecurity, isAccessConstrainedBySqlFirewall, isSensitive.'
  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 'security_policy_report_id' must not be blank" if OCI::Internal::Util.blank_string?(security_policy_report_id)

  path = '/securityPolicyReports/{securityPolicyReportId}/databaseTableAccessEntries'.sub('{securityPolicyReportId}', security_policy_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[:scimQuery] = opts[:scim_query] if opts[:scim_query]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#list_database_table_access_entries') 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::DatabaseTableAccessEntryCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_database_view_access_entries(security_policy_report_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_database_view_access_entries API.

Retrieves a list of all database view access entries in Data Safe.

The ListDatabaseViewAccessEntries operation returns only the database view access objects for the specified security policy report. If targetId is specified, it must match the target associated with the securityPolicyReportId path parameter; otherwise, the request is rejected.

Allowed values are: key, grantee, accessType, tableSchema, tableName, viewSchema, viewName, privilegeType, privilege, privilegeGrantable, grantFromRole, accessThroughObject, columnName, grantor, isAccessConstrainedByDatabaseVault, isAccessConstrainedByVirtualPrivateDatabase, isAccessConstrainedByRedaction, isAccessConstrainedByRealApplicationSecurity, isAccessConstrainedBySqlFirewall

Parameters:

  • security_policy_report_id (String) —

    The OCID of the security policy report resource.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :limit (Integer) —

    For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

  • :page (String) —

    For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

  • :scim_query (String) —

    The scimQuery query parameter accepts filter expressions that use the syntax described in Section 3.2.2.2 of the System for Cross-Domain Identity Management (SCIM) specification, which is available at RFC3339. In SCIM filtering expressions, text, date, and time values must be enclosed in quotation marks, with date and time values using ISO-8601 format. (Numeric and boolean values should not be quoted.)

    Example: query=(accessType eq "SELECT") and (grantee eq "ADMIN")

  • :target_id (String) —

    A filter to return only items related to a specific target OCID.

  • :sort_by (String) —

    The field to sort by. Only one sort parameter should be provided. (default to key)

  • :sort_order (String) —

    The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:



15291
15292
15293
15294
15295
15296
15297
15298
15299
15300
15301
15302
15303
15304
15305
15306
15307
15308
15309
15310
15311
15312
15313
15314
15315
15316
15317
15318
15319
15320
15321
15322
15323
15324
15325
15326
15327
15328
15329
15330
15331
15332
15333
15334
15335
15336
15337
15338
15339
15340
15341
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 15291

def list_database_view_access_entries(security_policy_report_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#list_database_view_access_entries.' if logger

  raise "Missing the required parameter 'security_policy_report_id' when calling list_database_view_access_entries." if security_policy_report_id.nil?

  if opts[:sort_by] && !%w[key grantee accessType tableSchema tableName viewSchema viewName privilegeType privilege privilegeGrantable grantFromRole accessThroughObject columnName grantor isAccessConstrainedByDatabaseVault isAccessConstrainedByVirtualPrivateDatabase isAccessConstrainedByRedaction isAccessConstrainedByRealApplicationSecurity isAccessConstrainedBySqlFirewall].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of key, grantee, accessType, tableSchema, tableName, viewSchema, viewName, privilegeType, privilege, privilegeGrantable, grantFromRole, accessThroughObject, columnName, grantor, isAccessConstrainedByDatabaseVault, isAccessConstrainedByVirtualPrivateDatabase, isAccessConstrainedByRedaction, isAccessConstrainedByRealApplicationSecurity, isAccessConstrainedBySqlFirewall.'
  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 'security_policy_report_id' must not be blank" if OCI::Internal::Util.blank_string?(security_policy_report_id)

  path = '/securityPolicyReports/{securityPolicyReportId}/databaseViewAccessEntries'.sub('{securityPolicyReportId}', security_policy_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[:scimQuery] = opts[:scim_query] if opts[:scim_query]
  query_params[:targetId] = opts[:target_id] if opts[:target_id]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#list_database_view_access_entries') 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::DatabaseViewAccessEntryCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_difference_columns(sdm_masking_policy_difference_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_difference_columns API.

Gets a list of columns of a SDM masking policy difference resource based on the specified query parameters.

Parameters:

  • sdm_masking_policy_difference_id (String) —

    The OCID of the SDM masking policy difference.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :difference_type (String) —

    A filter to return only the SDM masking policy difference columns that match the specified difference type

  • :planned_action (String) —

    A filter to return only the SDM masking policy difference columns that match the specified planned action.

  • :sync_status (String) —

    A filter to return the SDM masking policy difference columns based on the value of their syncStatus attribute.

  • :schema_name (Array<String>) —

    A filter to return only items related to specific schema name.

  • :object_name (Array<String>) —

    A filter to return only items related to a specific object name.

  • :column_name (Array<String>) —

    A filter to return only a specific column based on column name.

  • :sort_order (String) —

    The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

  • :sort_by (String) —

    The field to sort by. You can specify only one sorting parameter (sortOrder). The default order for schemaName is descending. The default order for differenceType, schemaName, objectName, columnName and plannedAction is ascending. (default to schemaName) Allowed values are: differenceType, schemaName, objectName, columnName, plannedAction

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :limit (Integer) —

    For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

  • :page (String) —

    For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

Returns:



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
15410
15411
15412
15413
15414
15415
15416
15417
15418
15419
15420
15421
15422
15423
15424
15425
15426
15427
15428
15429
15430
15431
15432
15433
15434
15435
15436
15437
15438
15439
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 15373

def list_difference_columns(sdm_masking_policy_difference_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#list_difference_columns.' if logger

  raise "Missing the required parameter 'sdm_masking_policy_difference_id' when calling list_difference_columns." if sdm_masking_policy_difference_id.nil?

  if opts[:difference_type] && !OCI::DataSafe::Models::SdmMaskingPolicyDifference::DIFFERENCE_TYPE_ENUM.include?(opts[:difference_type])
    raise 'Invalid value for "difference_type", must be one of the values in OCI::DataSafe::Models::SdmMaskingPolicyDifference::DIFFERENCE_TYPE_ENUM.'
  end

  if opts[:planned_action] && !OCI::DataSafe::Models::DifferenceColumn::PLANNED_ACTION_ENUM.include?(opts[:planned_action])
    raise 'Invalid value for "planned_action", must be one of the values in OCI::DataSafe::Models::DifferenceColumn::PLANNED_ACTION_ENUM.'
  end

  if opts[:sync_status] && !OCI::DataSafe::Models::DifferenceColumn::SYNC_STATUS_ENUM.include?(opts[:sync_status])
    raise 'Invalid value for "sync_status", must be one of the values in OCI::DataSafe::Models::DifferenceColumn::SYNC_STATUS_ENUM.'
  end

  if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of ASC, DESC.'
  end

  if opts[:sort_by] && !%w[differenceType schemaName objectName columnName plannedAction].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of differenceType, schemaName, objectName, columnName, plannedAction.'
  end
  raise "Parameter value for 'sdm_masking_policy_difference_id' must not be blank" if OCI::Internal::Util.blank_string?(sdm_masking_policy_difference_id)

  path = '/sdmMaskingPolicyDifferences/{sdmMaskingPolicyDifferenceId}/differenceColumns'.sub('{sdmMaskingPolicyDifferenceId}', sdm_masking_policy_difference_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:differenceType] = opts[:difference_type] if opts[:difference_type]
  query_params[:plannedAction] = opts[:planned_action] if opts[:planned_action]
  query_params[:syncStatus] = opts[:sync_status] if opts[:sync_status]
  query_params[:schemaName] = OCI::ApiClient.build_collection_params(opts[:schema_name], :multi) if opts[:schema_name] && !opts[:schema_name].empty?
  query_params[:objectName] = OCI::ApiClient.build_collection_params(opts[:object_name], :multi) if opts[:object_name] && !opts[:object_name].empty?
  query_params[:columnName] = OCI::ApiClient.build_collection_params(opts[:column_name], :multi) if opts[:column_name] && !opts[:column_name].empty?
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#list_difference_columns') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataSafe::Models::SdmMaskingPolicyDifferenceColumnCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_discovery_analytics(compartment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_discovery_analytics API.

Gets consolidated discovery analytics data based on the specified query parameters. If CompartmentIdInSubtreeQueryParam is specified as true, the behaviour is equivalent to accessLevel "ACCESSIBLE" by default.

Parameters:

  • compartment_id (String) —

    A filter to return only resources that match the specified compartment OCID.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :compartment_id_in_subtree (BOOLEAN) —

    Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting. (default to false)

  • :group_by (String) —

    Attribute by which the discovery analytics data should be grouped. Allowed values are: targetId, sensitiveDataModelId, sensitiveTypeId, targetIdAndSensitiveDataModelId, sensitiveTypeIdAndTargetId, sensitiveTypeIdAndSensitiveDataModelId

  • :target_id (String) —

    A filter to return only items related to a specific target OCID.

  • :target_database_group_id (String) —

    A filter to return the target database group that matches the specified OCID.

  • :sort_by (String) —

    The field to sort by. You can specify only one sorting parameter (sortOrder). The default order for all the fields is ascending.

    Allowed values are: timeLastDiscovered

  • :sort_order (String) —

    The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

  • :sensitive_data_model_id (String) —

    A filter to return only the resources that match the specified sensitive data model OCID.

  • :sensitive_type_id (String) —

    A filter to return only items related to a specific sensitive type OCID.

  • :limit (Integer) —

    For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

  • :page (String) —

    For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :is_common (BOOLEAN) —

    A filter to return only the common sensitive type resources. Common sensitive types belong to library sensitive types which are frequently used to perform sensitive data discovery.

  • :sensitive_type_group_id (String) —

    An optional filter to return only resources that match the specified OCID of the sensitive type group resource.

Returns:



15480
15481
15482
15483
15484
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
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 15480

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 sensitiveTypeId targetIdAndSensitiveDataModelId sensitiveTypeIdAndTargetId sensitiveTypeIdAndSensitiveDataModelId].include?(opts[:group_by])
    raise 'Invalid value for "group_by", must be one of targetId, sensitiveDataModelId, sensitiveTypeId, targetIdAndSensitiveDataModelId, sensitiveTypeIdAndTargetId, sensitiveTypeIdAndSensitiveDataModelId.'
  end

  if opts[:sort_by] && !%w[timeLastDiscovered].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of timeLastDiscovered.'
  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

  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[:targetDatabaseGroupId] = opts[:target_database_group_id] if opts[:target_database_group_id]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sensitiveDataModelId] = opts[:sensitive_data_model_id] if opts[:sensitive_data_model_id]
  query_params[:sensitiveTypeId] = opts[:sensitive_type_id] if opts[:sensitive_type_id]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:isCommon] = opts[:is_common] if !opts[:is_common].nil?
  query_params[:sensitiveTypeGroupId] = opts[:sensitive_type_group_id] if opts[:sensitive_type_group_id]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#list_discovery_analytics') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataSafe::Models::DiscoveryAnalyticsCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_discovery_job_results(discovery_job_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_discovery_job_results API.

Gets a list of discovery results based on the specified query parameters.

Parameters:

  • discovery_job_id (String) —

    The OCID of the discovery job.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :discovery_type (String) —

    A filter to return only the resources that match the specified discovery type.

  • :planned_action (String) —

    A filter to return only the resources that match the specified planned action.

  • :is_result_applied (BOOLEAN) —

    A filter to return the discovery result resources based on the value of their isResultApplied attribute.

  • :schema_name (Array<String>) —

    A filter to return only items related to specific schema name.

  • :object_name (Array<String>) —

    A filter to return only items related to a specific object name.

  • :column_name (Array<String>) —

    A filter to return only a specific column based on column name.

  • :sort_order (String) —

    The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

  • :confidence_level (Array<String>) —

    A filter to return the discovery job results with the specified confidence level. Confidence level of discovery job result associated with a seeded sensitive type can either be HIGH or LOW. While the confidence level of discovery job result associated with a user defined sensitive will be NONE.

    Allowed values are: NONE, HIGH, MEDIUM, LOW

  • :sort_by (String) —

    The field to sort by. You can specify only one sorting parameter (sortOrder). The default order for timeFinished is descending. The default order for discoveryType, schemaName, objectName, columnName and plannedAction is ascending. (default to timeFinished) Allowed values are: discoveryType, timeFinished, schemaName, objectName, columnName, plannedAction, confidenceLevel

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :limit (Integer) —

    For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

  • :page (String) —

    For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

Returns:



15577
15578
15579
15580
15581
15582
15583
15584
15585
15586
15587
15588
15589
15590
15591
15592
15593
15594
15595
15596
15597
15598
15599
15600
15601
15602
15603
15604
15605
15606
15607
15608
15609
15610
15611
15612
15613
15614
15615
15616
15617
15618
15619
15620
15621
15622
15623
15624
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
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 15577

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


  confidence_level_allowable_values = %w[NONE HIGH MEDIUM LOW]
  if opts[:confidence_level] && !opts[:confidence_level].empty?
    opts[:confidence_level].each do |val_to_check|
      unless confidence_level_allowable_values.include?(val_to_check)
        raise 'Invalid value for "confidence_level", must be one of NONE, HIGH, MEDIUM, LOW.'
      end
    end
  end

  if opts[:sort_by] && !%w[discoveryType timeFinished schemaName objectName columnName plannedAction confidenceLevel].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of discoveryType, timeFinished, schemaName, objectName, columnName, plannedAction, confidenceLevel.'
  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[:confidenceLevel] = OCI::ApiClient.build_collection_params(opts[:confidence_level], :multi) if opts[:confidence_level] && !opts[:confidence_level].empty?
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#list_discovery_job_results') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataSafe::Models::DiscoveryJobResultCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_discovery_jobs(compartment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_discovery_jobs API.

Gets a list of incremental discovery jobs based on the specified query parameters.

Parameters:

  • compartment_id (String) —

    A filter to return only resources that match the specified compartment OCID.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :compartment_id_in_subtree (BOOLEAN) —

    Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting. (default to false)

  • :access_level (String) —

    Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed. (default to RESTRICTED) Allowed values are: RESTRICTED, ACCESSIBLE

  • :display_name (String) —

    A filter to return only resources that match the specified display name.

  • :discovery_job_id (String) —

    A filter to return only the resources that match the specified discovery job OCID.

  • :target_id (String) —

    A filter to return only items related to a specific target OCID.

  • :lifecycle_state (String) —

    A filter to return only the resources that match the specified lifecycle state.

  • :sensitive_data_model_id (String) —

    A filter to return only the resources that match the specified sensitive data model OCID.

  • :sort_order (String) —

    The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

  • :sort_by (String) —

    The field to sort by. You can specify only one sorting parameter (sortOrder). The default order for timeFinished is descending. The default order for displayName is ascending. (default to timeStarted) Allowed values are: timeStarted, displayName

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :limit (Integer) —

    For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

  • :page (String) —

    For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

Returns:



15691
15692
15693
15694
15695
15696
15697
15698
15699
15700
15701
15702
15703
15704
15705
15706
15707
15708
15709
15710
15711
15712
15713
15714
15715
15716
15717
15718
15719
15720
15721
15722
15723
15724
15725
15726
15727
15728
15729
15730
15731
15732
15733
15734
15735
15736
15737
15738
15739
15740
15741
15742
15743
15744
15745
15746
15747
15748
15749
15750
15751
15752
15753
15754
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 15691

def list_discovery_jobs(compartment_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#list_discovery_jobs.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_discovery_jobs." if compartment_id.nil?

  if opts[:access_level] && !%w[RESTRICTED ACCESSIBLE].include?(opts[:access_level])
    raise 'Invalid value for "access_level", must be one of RESTRICTED, ACCESSIBLE.'
  end

  if opts[:lifecycle_state] && !OCI::DataSafe::Models::DISCOVERY_LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::DataSafe::Models::DISCOVERY_LIFECYCLE_STATE_ENUM.'
  end

  if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of ASC, DESC.'
  end

  if opts[:sort_by] && !%w[timeStarted displayName].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of timeStarted, displayName.'
  end

  path = '/discoveryJobs'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:compartmentIdInSubtree] = opts[:compartment_id_in_subtree] if !opts[:compartment_id_in_subtree].nil?
  query_params[:accessLevel] = opts[:access_level] if opts[:access_level]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:discoveryJobId] = opts[:discovery_job_id] if opts[:discovery_job_id]
  query_params[:targetId] = opts[:target_id] if opts[:target_id]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:sensitiveDataModelId] = opts[:sensitive_data_model_id] if opts[:sensitive_data_model_id]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#list_discovery_jobs') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataSafe::Models::DiscoveryJobCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_finding_analytics(compartment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_finding_analytics API.

Gets a list of findings aggregated details in the specified compartment. This provides information about the overall state of security assessment findings. You can use groupBy to get the count of findings under a certain risk level and with a certain findingKey, and as well as get the list of the targets that match the condition. This data is especially useful content for the statistic chart or to support analytics.

When you perform the ListFindingAnalytics operation, if the parameter compartmentIdInSubtree is set to "true," and if the parameter accessLevel is set to ACCESSIBLE, then the operation returns statistics from the compartments in which the requestor has INSPECT permissions on at least one resource, directly or indirectly (in subcompartments). If the operation is performed at the root compartment and the requestor does not have access to at least one subcompartment of the compartment specified by compartmentId, then "Not Authorized" is returned.

Parameters:

  • compartment_id (String) —

    A filter to return only resources that match the specified compartment OCID.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :compartment_id_in_subtree (BOOLEAN) —

    Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting. (default to false)

  • :access_level (String) —

    Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed. (default to RESTRICTED) Allowed values are: RESTRICTED, ACCESSIBLE

  • :is_top_finding (BOOLEAN) —

    A filter to return only the findings that are marked as top findings.

  • :group_by (String) —

    Attribute by which the finding analytics data should be grouped. Allowed values are: findingKeyAndTopFindingStatus, findingKeyAndSeverity, severity

  • :top_finding_status (String) —

    An optional filter to return only the top finding that match the specified status.

  • :severity (String) —

    A filter to return only findings of a particular risk level. Allowed values are: HIGH, MEDIUM, LOW, EVALUATE, ADVISORY, PASS, DEFERRED

  • :finding_key (String) —

    The unique key that identifies the finding. It is a string and unique within a security assessment.

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :limit (Integer) —

    For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

  • :page (String) —

    For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

  • :target_database_group_id (String) —

    A filter to return the target database group that matches the specified OCID.

  • :contains_references (Array<String>) —

    An optional filter to return only findings that match the specified references. Use containsReferences param if need to filter by multiple references. Allowed values are: STIG, CIS, GDPR

  • :target_ids (Array<String>) —

    An optional filter to return only findings that match the specified target ids. Use this parameter to filter by multiple target ids.

  • :category (String) —

    The category of the finding.

  • :contains_severity (Array<String>) —

    A filter to return only findings that match the specified risk level(s). Use containsSeverity parameter if need to filter by multiple risk levels. Allowed values are: HIGH, MEDIUM, LOW, EVALUATE, ADVISORY, PASS, DEFERRED

  • :scim_query (String) —

    The scimQuery query parameter accepts filter expressions that use the syntax described in Section 3.2.2.2 of the System for Cross-Domain Identity Management (SCIM) specification, which is available at RFC3339. In SCIM filtering expressions, text, date, and time values must be enclosed in quotation marks, with date and time values using ISO-8601 format. (Numeric and boolean values should not be quoted.)

    Example: | scimQuery=(severity eq 'high') scimQuery=(category eq "Users") and (reference eq 'CIS')

    Supported fields: severity reference title category

Returns:



15823
15824
15825
15826
15827
15828
15829
15830
15831
15832
15833
15834
15835
15836
15837
15838
15839
15840
15841
15842
15843
15844
15845
15846
15847
15848
15849
15850
15851
15852
15853
15854
15855
15856
15857
15858
15859
15860
15861
15862
15863
15864
15865
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
15905
15906
15907
15908
15909
15910
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 15823

def list_finding_analytics(compartment_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#list_finding_analytics.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_finding_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[:group_by] && !%w[findingKeyAndTopFindingStatus findingKeyAndSeverity severity].include?(opts[:group_by])
    raise 'Invalid value for "group_by", must be one of findingKeyAndTopFindingStatus, findingKeyAndSeverity, severity.'
  end

  if opts[:top_finding_status] && !OCI::DataSafe::Models::FindingAnalyticsDimensions::TOP_FINDING_STATUS_ENUM.include?(opts[:top_finding_status])
    raise 'Invalid value for "top_finding_status", must be one of the values in OCI::DataSafe::Models::FindingAnalyticsDimensions::TOP_FINDING_STATUS_ENUM.'
  end

  if opts[:severity] && !%w[HIGH MEDIUM LOW EVALUATE ADVISORY PASS DEFERRED].include?(opts[:severity])
    raise 'Invalid value for "severity", must be one of HIGH, MEDIUM, LOW, EVALUATE, ADVISORY, PASS, DEFERRED.'
  end


  contains_references_allowable_values = %w[STIG CIS GDPR]
  if opts[:contains_references] && !opts[:contains_references].empty?
    opts[:contains_references].each do |val_to_check|
      unless contains_references_allowable_values.include?(val_to_check)
        raise 'Invalid value for "contains_references", must be one of STIG, CIS, GDPR.'
      end
    end
  end


  contains_severity_allowable_values = %w[HIGH MEDIUM LOW EVALUATE ADVISORY PASS DEFERRED]
  if opts[:contains_severity] && !opts[:contains_severity].empty?
    opts[:contains_severity].each do |val_to_check|
      unless contains_severity_allowable_values.include?(val_to_check)
        raise 'Invalid value for "contains_severity", must be one of HIGH, MEDIUM, LOW, EVALUATE, ADVISORY, PASS, DEFERRED.'
      end
    end
  end

  path = '/securityAssessments/findingAnalytics'
  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[:isTopFinding] = opts[:is_top_finding] if !opts[:is_top_finding].nil?
  query_params[:groupBy] = opts[:group_by] if opts[:group_by]
  query_params[:topFindingStatus] = opts[:top_finding_status] if opts[:top_finding_status]
  query_params[:severity] = opts[:severity] if opts[:severity]
  query_params[:findingKey] = opts[:finding_key] if opts[:finding_key]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:targetDatabaseGroupId] = opts[:target_database_group_id] if opts[:target_database_group_id]
  query_params[:containsReferences] = OCI::ApiClient.build_collection_params(opts[:contains_references], :multi) if opts[:contains_references] && !opts[:contains_references].empty?
  query_params[:targetIds] = OCI::ApiClient.build_collection_params(opts[:target_ids], :multi) if opts[:target_ids] && !opts[:target_ids].empty?
  query_params[:category] = opts[:category] if opts[:category]
  query_params[:containsSeverity] = OCI::ApiClient.build_collection_params(opts[:contains_severity], :multi) if opts[:contains_severity] && !opts[:contains_severity].empty?
  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[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#list_finding_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::FindingAnalyticsCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_findings(security_assessment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_findings API.

Lists all the findings for the specified assessment except for type TEMPLATE. If the assessment is of type TEMPLATE_BASELINE, the findings returned are the security checks with the user-defined severity from the template.

Allowed values are: category, findingKey, severity

Parameters:

  • security_assessment_id (String) —

    The OCID of the security assessment.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :is_top_finding (BOOLEAN) —

    A filter to return only the findings that are marked as top findings.

  • :severity (String) —

    A filter to return only findings of a particular risk level. Allowed values are: HIGH, MEDIUM, LOW, EVALUATE, ADVISORY, PASS, DEFERRED

  • :contains_severity (Array<String>) —

    A filter to return only findings that match the specified risk level(s). Use containsSeverity parameter if need to filter by multiple risk levels. Allowed values are: HIGH, MEDIUM, LOW, EVALUATE, ADVISORY, PASS, DEFERRED

  • :category (String) —

    The category of the finding.

  • :contains_oracle_defined_severity (Array<String>) —

    A filter to return only findings that match the specified risk level(s). Use containsOracleDefinedSeverity parameter if need to filter by one or multiple risk levels. Allowed values are: HIGH, MEDIUM, LOW, EVALUATE, ADVISORY, PASS, DEFERRED

  • :lifecycle_state (String) —

    A filter to return only the findings that match the specified lifecycle states.

  • :references (String) —

    An optional filter to return only findings that match the specified reference.

  • :contains_references (Array<String>) —

    An optional filter to return only findings that match the specified references. Use containsReferences param if need to filter by multiple references. Allowed values are: STIG, CIS, GDPR

  • :limit (Integer) —

    For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

  • :page (String) —

    For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

  • :compartment_id (String) —

    A filter to return only resources that match the specified compartment OCID.

  • :compartment_id_in_subtree (BOOLEAN) —

    Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting. (default to false)

  • :access_level (String) —

    Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed. (default to RESTRICTED) Allowed values are: RESTRICTED, ACCESSIBLE

  • :target_id (String) —

    A filter to return only items related to a specific target OCID.

  • :target_ids (Array<String>) —

    An optional filter to return only findings that match the specified target ids. Use this parameter to filter by multiple target ids.

  • :scim_query (String) —

    The scimQuery query parameter accepts filter expressions that use the syntax described in Section 3.2.2.2 of the System for Cross-Domain Identity Management (SCIM) specification, which is available at RFC3339. In SCIM filtering expressions, text, date, and time values must be enclosed in quotation marks, with date and time values using ISO-8601 format. (Numeric and boolean values should not be quoted.)

    Example: | scimQuery=(severity eq 'high') and (targetId eq 'target_1') scimQuery=(category eq "Users") and (targetId eq "target_1") scimQuery=(reference eq 'CIS') and (targetId eq 'target_1')

    Supported fields: severity findingKey reference targetId isTopFinding title category remarks details summary isRiskModified

  • :field (Array<String>) —

    Specifies a subset of fields to be returned in the response. Allowed values are: severity, findingKey, reference, targetId, isTopFinding, title, category, remarks, details, summary, isRiskModified

  • :sort_by (String) —

    The field to sort by. You can specify only one sort order(sortOrder). The default order for category is alphabetical. (default to category)

  • :sort_order (String) —

    The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

  • :finding_key (String) —

    Each finding in security assessment has an associated key (think of key as a finding's name). For a given finding, the key will be the same across targets. The user can use these keys to filter the findings.

Returns:



15989
15990
15991
15992
15993
15994
15995
15996
15997
15998
15999
16000
16001
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
16060
16061
16062
16063
16064
16065
16066
16067
16068
16069
16070
16071
16072
16073
16074
16075
16076
16077
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
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 15989

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 DEFERRED].include?(opts[:severity])
    raise 'Invalid value for "severity", must be one of HIGH, MEDIUM, LOW, EVALUATE, ADVISORY, PASS, DEFERRED.'
  end


  contains_severity_allowable_values = %w[HIGH MEDIUM LOW EVALUATE ADVISORY PASS DEFERRED]
  if opts[:contains_severity] && !opts[:contains_severity].empty?
    opts[:contains_severity].each do |val_to_check|
      unless contains_severity_allowable_values.include?(val_to_check)
        raise 'Invalid value for "contains_severity", must be one of HIGH, MEDIUM, LOW, EVALUATE, ADVISORY, PASS, DEFERRED.'
      end
    end
  end


  contains_oracle_defined_severity_allowable_values = %w[HIGH MEDIUM LOW EVALUATE ADVISORY PASS DEFERRED]
  if opts[:contains_oracle_defined_severity] && !opts[:contains_oracle_defined_severity].empty?
    opts[:contains_oracle_defined_severity].each do |val_to_check|
      unless contains_oracle_defined_severity_allowable_values.include?(val_to_check)
        raise 'Invalid value for "contains_oracle_defined_severity", must be one of HIGH, MEDIUM, LOW, EVALUATE, ADVISORY, PASS, DEFERRED.'
      end
    end
  end

  if opts[:lifecycle_state] && !OCI::DataSafe::Models::FINDING_LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::DataSafe::Models::FINDING_LIFECYCLE_STATE_ENUM.'
  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


  contains_references_allowable_values = %w[STIG CIS GDPR]
  if opts[:contains_references] && !opts[:contains_references].empty?
    opts[:contains_references].each do |val_to_check|
      unless contains_references_allowable_values.include?(val_to_check)
        raise 'Invalid value for "contains_references", must be one of STIG, CIS, GDPR.'
      end
    end
  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


  field_allowable_values = %w[severity findingKey reference targetId isTopFinding title category remarks details summary isRiskModified]
  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 severity, findingKey, reference, targetId, isTopFinding, title, category, remarks, details, summary, isRiskModified.'
      end
    end
  end

  if opts[:sort_by] && !%w[category findingKey severity].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of category, findingKey, severity.'
  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 '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[:isTopFinding] = opts[:is_top_finding] if !opts[:is_top_finding].nil?
  query_params[:severity] = opts[:severity] if opts[:severity]
  query_params[:containsSeverity] = OCI::ApiClient.build_collection_params(opts[:contains_severity], :multi) if opts[:contains_severity] && !opts[:contains_severity].empty?
  query_params[:category] = opts[:category] if opts[:category]
  query_params[:containsOracleDefinedSeverity] = OCI::ApiClient.build_collection_params(opts[:contains_oracle_defined_severity], :multi) if opts[:contains_oracle_defined_severity] && !opts[:contains_oracle_defined_severity].empty?
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:references] = opts[:references] if opts[:references]
  query_params[:containsReferences] = OCI::ApiClient.build_collection_params(opts[:contains_references], :multi) if opts[:contains_references] && !opts[:contains_references].empty?
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:compartmentId] = opts[:compartment_id] if opts[: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[:targetIds] = OCI::ApiClient.build_collection_params(opts[:target_ids], :multi) if opts[:target_ids] && !opts[:target_ids].empty?
  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?
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:findingKey] = opts[:finding_key] if opts[:finding_key]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#list_findings') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'Array<OCI::DataSafe::Models::FindingSummary>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_findings_change_audit_logs(security_assessment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_findings_change_audit_logs API.

List all changes made by user to risk level of findings of the specified assessment.

Allowed values are: timeUpdated, modifiedBy, isRiskDeferred, timeValidUntil

Parameters:

  • security_assessment_id (String) —

    The OCID of the security assessment.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :severity (String) —

    A filter to return only findings of a particular risk level. Allowed values are: HIGH, MEDIUM, LOW, EVALUATE, ADVISORY, PASS, DEFERRED

  • :finding_key (String) —

    The unique key that identifies the finding. It is a string and unique within a security assessment.

  • :finding_title (String) —

    The unique title that identifies the finding. It is a string and unique within a security assessment.

  • :is_risk_deferred (BOOLEAN) —

    A filter to check findings whose risks were deferred by the user.

  • :modified_by (String) —

    A filter to check which user modified the risk level of the finding.

  • :limit (Integer) —

    For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

  • :page (String) —

    For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

  • :sort_order (String) —

    The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

  • :sort_by (String) —

    The field to sort by. You can specify only one sort order(sortOrder). The default order for timeUpdated is descending. (default to timeUpdated)

  • :time_valid_until_greater_than_or_equal_to (DateTime) —

    Specifying TimeValidUntilGreaterThanOrEqualToQueryParam parameter will retrieve all items for which the risk level modification by user will no longer be valid greater than the date and time specified, in the format defined by RFC3339.

    Example: 2016-12-19T00:00:00.000Z

  • :time_valid_until_less_than (DateTime) —

    Specifying TimeValidUntilLessThanQueryParam parameter will retrieve all items for which the risk level modification by user will be valid until less than the date and time specified, in the format defined by RFC3339.

    Example: 2016-12-19T00:00:00.000Z

  • :time_updated_greater_than_or_equal_to (DateTime) —

    Search for resources that were updated after a specific date. Specifying this parameter corresponding timeUpdatedGreaterThanOrEqualTo parameter will retrieve all resources updated after the specified created date, in "YYYY-MM-ddThh:mmZ" format with a Z offset, as defined by RFC 3339.

  • :time_updated_less_than (DateTime) —

    Search for resources that were updated before a specific date. Specifying this parameter corresponding timeUpdatedLessThan parameter will retrieve all resources updated before the specified created date, in "YYYY-MM-ddThh:mmZ" format with a Z offset, as defined by RFC 3339.

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:



16167
16168
16169
16170
16171
16172
16173
16174
16175
16176
16177
16178
16179
16180
16181
16182
16183
16184
16185
16186
16187
16188
16189
16190
16191
16192
16193
16194
16195
16196
16197
16198
16199
16200
16201
16202
16203
16204
16205
16206
16207
16208
16209
16210
16211
16212
16213
16214
16215
16216
16217
16218
16219
16220
16221
16222
16223
16224
16225
16226
16227
16228
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 16167

def list_findings_change_audit_logs(security_assessment_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#list_findings_change_audit_logs.' if logger

  raise "Missing the required parameter 'security_assessment_id' when calling list_findings_change_audit_logs." if security_assessment_id.nil?

  if opts[:severity] && !%w[HIGH MEDIUM LOW EVALUATE ADVISORY PASS DEFERRED].include?(opts[:severity])
    raise 'Invalid value for "severity", must be one of HIGH, MEDIUM, LOW, EVALUATE, ADVISORY, PASS, DEFERRED.'
  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[timeUpdated modifiedBy isRiskDeferred timeValidUntil].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of timeUpdated, modifiedBy, isRiskDeferred, timeValidUntil.'
  end
  raise "Parameter value for 'security_assessment_id' must not be blank" if OCI::Internal::Util.blank_string?(security_assessment_id)

  path = '/securityAssessments/{securityAssessmentId}/findingsChangeAuditLogs'.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[:findingKey] = opts[:finding_key] if opts[:finding_key]
  query_params[:findingTitle] = opts[:finding_title] if opts[:finding_title]
  query_params[:isRiskDeferred] = opts[:is_risk_deferred] if !opts[:is_risk_deferred].nil?
  query_params[:modifiedBy] = opts[:modified_by] if opts[:modified_by]
  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[:timeValidUntilGreaterThanOrEqualTo] = opts[:time_valid_until_greater_than_or_equal_to] if opts[:time_valid_until_greater_than_or_equal_to]
  query_params[:timeValidUntilLessThan] = opts[:time_valid_until_less_than] if opts[:time_valid_until_less_than]
  query_params[:timeUpdatedGreaterThanOrEqualTo] = opts[:time_updated_greater_than_or_equal_to] if opts[:time_updated_greater_than_or_equal_to]
  query_params[:timeUpdatedLessThan] = opts[:time_updated_less_than] if opts[:time_updated_less_than]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#list_findings_change_audit_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: 'OCI::DataSafe::Models::FindingsChangeAuditLogCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_grants(user_assessment_id, user_key, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_grants API.

Gets a list of grants for a particular user in the specified user assessment. A user grant contains details such as the privilege name, type, category, and depth level. The depth level indicates how deep in the hierarchy of roles granted to roles a privilege grant is. The userKey in this operation is a system-generated identifier. Perform the operation ListUsers to get the userKey for a particular user.

Allowed values are: grantName, grantType, privilegeCategory, depthLevel, key

Parameters:

  • user_assessment_id (String) —

    The OCID of the user assessment.

  • user_key (String) —

    The unique user key. This is a system-generated identifier. ListUsers gets the user key for a user.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :grant_key (String) —

    A filter to return only items that match the specified user grant key.

  • :grant_name (String) —

    A filter to return only items that match the specified user grant name.

  • :privilege_type (String) —

    A filter to return only items that match the specified privilege grant type.

  • :privilege_category (String) —

    A filter to return only items that match the specified user privilege category.

  • :depth_level (Integer) —

    A filter to return only items that match the specified user grant depth level.

  • :depth_level_greater_than_or_equal_to (Integer) —

    A filter to return only items that are at a level greater than or equal to the specified user grant depth level.

  • :depth_level_less_than (Integer) —

    A filter to return only items that are at a level less than the specified user grant depth level.

  • :limit (Integer) —

    For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

  • :page (String) —

    For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

  • :sort_order (String) —

    The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

  • :sort_by (String) —

    The field to sort by. You can specify only one sort order (sortOrder). The default order for grantName is ascending. (default to key)

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:



16265
16266
16267
16268
16269
16270
16271
16272
16273
16274
16275
16276
16277
16278
16279
16280
16281
16282
16283
16284
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 16265

def list_grants(user_assessment_id, user_key, opts = {})
  logger.debug 'Calling operation DataSafeClient#list_grants.' if logger

  raise "Missing the required parameter 'user_assessment_id' when calling list_grants." if user_assessment_id.nil?
  raise "Missing the required parameter 'user_key' when calling list_grants." if user_key.nil?

  if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of ASC, DESC.'
  end

  if opts[:sort_by] && !%w[grantName grantType privilegeCategory depthLevel key].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of grantName, grantType, privilegeCategory, depthLevel, key.'
  end
  raise "Parameter value for 'user_assessment_id' must not be blank" if OCI::Internal::Util.blank_string?(user_assessment_id)
  raise "Parameter value for 'user_key' must not be blank" if OCI::Internal::Util.blank_string?(user_key)

  path = '/userAssessments/{userAssessmentId}/users/{userKey}/grants'.sub('{userAssessmentId}', user_assessment_id.to_s).sub('{userKey}', user_key.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:grantKey] = opts[:grant_key] if opts[:grant_key]
  query_params[:grantName] = opts[:grant_name] if opts[:grant_name]
  query_params[:privilegeType] = opts[:privilege_type] if opts[:privilege_type]
  query_params[:privilegeCategory] = opts[:privilege_category] if opts[:privilege_category]
  query_params[:depthLevel] = opts[:depth_level] if opts[:depth_level]
  query_params[:depthLevelGreaterThanOrEqualTo] = opts[:depth_level_greater_than_or_equal_to] if opts[:depth_level_greater_than_or_equal_to]
  query_params[:depthLevelLessThan] = opts[:depth_level_less_than] if opts[:depth_level_less_than]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#list_grants') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'Array<OCI::DataSafe::Models::GrantSummary>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_grouped_sensitive_types(sensitive_type_group_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_grouped_sensitive_types API.

Gets the list of sensitive type Ids present in the specified sensitive type group.

Parameters:

  • sensitive_type_group_id (String) —

    The OCID of the sensitive type group.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :sensitive_type_id (String) —

    A filter to return only items related to a specific sensitive type OCID.

  • :limit (Integer) —

    For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

  • :page (String) —

    For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

Returns:



16344
16345
16346
16347
16348
16349
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
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 16344

def list_grouped_sensitive_types(sensitive_type_group_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#list_grouped_sensitive_types.' if logger

  raise "Missing the required parameter 'sensitive_type_group_id' when calling list_grouped_sensitive_types." if sensitive_type_group_id.nil?
  raise "Parameter value for 'sensitive_type_group_id' must not be blank" if OCI::Internal::Util.blank_string?(sensitive_type_group_id)

  path = '/sensitiveTypeGroups/{sensitiveTypeGroupId}/groupedSensitiveTypes'.sub('{sensitiveTypeGroupId}', sensitive_type_group_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:sensitiveTypeId] = opts[:sensitive_type_id] if opts[:sensitive_type_id]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#list_grouped_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::GroupedSensitiveTypeCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_library_masking_formats(compartment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_library_masking_formats API.

Gets a list of library masking formats based on the specified query parameters.

Parameters:

  • compartment_id (String) —

    A filter to return only resources that match the specified compartment OCID.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :library_masking_format_id (String) —

    A filter to return only the resources that match the specified library masking format OCID.

  • :compartment_id_in_subtree (BOOLEAN) —

    Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting. (default to false)

  • :access_level (String) —

    Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed. (default to RESTRICTED) Allowed values are: RESTRICTED, ACCESSIBLE

  • :display_name (String) —

    A filter to return only resources that match the specified display name.

  • :limit (Integer) —

    For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

  • :page (String) —

    For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

  • :lifecycle_state (String) —

    A filter to return only the resources that match the specified lifecycle states.

  • :time_created_greater_than_or_equal_to (DateTime) —

    A filter to return only the resources that were created after the specified date and time, as defined by RFC3339. Using TimeCreatedGreaterThanOrEqualToQueryParam parameter retrieves all resources created after that date.

    Example: 2016-12-19T16:39:57.600Z

  • :time_created_less_than (DateTime) —

    Search for resources that were created before a specific date. Specifying this parameter corresponding timeCreatedLessThan parameter will retrieve all resources created before the specified created date, in "YYYY-MM-ddThh:mmZ" format with a Z offset, as defined by RFC 3339.

    Example: 2016-12-19T16:39:57.600Z

  • :library_masking_format_source (String) —

    A filter to return the library masking format resources based on the value of their source attribute. (default to USER)

  • :sort_order (String) —

    The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

  • :sort_by (String) —

    The field to sort by. You can specify only one sorting parameter (sortOrder). The default order for timeCreated is descending. The default order for displayName is ascending. The displayName sort order is case sensitive. (default to timeCreated) Allowed values are: displayName, timeCreated, timeUpdated, lifecycleState

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:



16437
16438
16439
16440
16441
16442
16443
16444
16445
16446
16447
16448
16449
16450
16451
16452
16453
16454
16455
16456
16457
16458
16459
16460
16461
16462
16463
16464
16465
16466
16467
16468
16469
16470
16471
16472
16473
16474
16475
16476
16477
16478
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
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 16437

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 timeUpdated lifecycleState].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of displayName, timeCreated, timeUpdated, lifecycleState.'
  end

  path = '/libraryMaskingFormats'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:libraryMaskingFormatId] = opts[:library_masking_format_id] if opts[:library_masking_format_id]
  query_params[:compartmentIdInSubtree] = opts[:compartment_id_in_subtree] if !opts[:compartment_id_in_subtree].nil?
  query_params[:accessLevel] = opts[:access_level] if opts[:access_level]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:timeCreatedGreaterThanOrEqualTo] = opts[:time_created_greater_than_or_equal_to] if opts[:time_created_greater_than_or_equal_to]
  query_params[:timeCreatedLessThan] = opts[:time_created_less_than] if opts[:time_created_less_than]
  query_params[:libraryMaskingFormatSource] = opts[:library_masking_format_source] if opts[:library_masking_format_source]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#list_library_masking_formats') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataSafe::Models::LibraryMaskingFormatCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_masked_columns(masking_report_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_masked_columns API.

Gets a list of masked columns present in the specified masking report and based on the specified query parameters.

Allowed values are: schemaName, objectName, sensitiveTypeId, maskingColumnGroupId

Parameters:

  • masking_report_id (String) —

    The OCID of the masking report.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :limit (Integer) —

    For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

  • :page (String) —

    For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

  • :sort_order (String) —

    The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

  • :sort_by (String) —

    The field to sort by. You can specify only one sorting parameter (sortOrder). The default order for all the fields is ascending. (default to schemaName)

  • :schema_name (Array<String>) —

    A filter to return only items related to specific schema name.

  • :object_name (Array<String>) —

    A filter to return only items related to a specific object name.

  • :column_name (Array<String>) —

    A filter to return only a specific column based on column name.

  • :object_type (Array<String>) —

    A filter to return only items related to a specific object type. (default to [ALL]) Allowed values are: ALL, TABLE, EDITIONING_VIEW

  • :masking_column_group (Array<String>) —

    A filter to return only the resources that match the specified masking column group.

  • :sensitive_type_id (String) —

    A filter to return only items related to a specific sensitive type OCID.

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:



16538
16539
16540
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
16577
16578
16579
16580
16581
16582
16583
16584
16585
16586
16587
16588
16589
16590
16591
16592
16593
16594
16595
16596
16597
16598
16599
16600
16601
16602
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 16538

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 sensitiveTypeId maskingColumnGroupId].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of schemaName, objectName, sensitiveTypeId, maskingColumnGroupId.'
  end


  object_type_allowable_values = %w[ALL TABLE EDITIONING_VIEW]
  if opts[:object_type] && !opts[:object_type].empty?
    opts[:object_type].each do |val_to_check|
      unless object_type_allowable_values.include?(val_to_check)
        raise 'Invalid value for "object_type", must be one of ALL, TABLE, EDITIONING_VIEW.'
      end
    end
  end
  raise "Parameter value for 'masking_report_id' must not be blank" if OCI::Internal::Util.blank_string?(masking_report_id)

  path = '/maskingReports/{maskingReportId}/maskedColumns'.sub('{maskingReportId}', masking_report_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:schemaName] = OCI::ApiClient.build_collection_params(opts[:schema_name], :multi) if opts[:schema_name] && !opts[:schema_name].empty?
  query_params[:objectName] = OCI::ApiClient.build_collection_params(opts[:object_name], :multi) if opts[:object_name] && !opts[:object_name].empty?
  query_params[:columnName] = OCI::ApiClient.build_collection_params(opts[:column_name], :multi) if opts[:column_name] && !opts[:column_name].empty?
  query_params[:objectType] = OCI::ApiClient.build_collection_params(opts[:object_type], :multi) if opts[:object_type] && !opts[:object_type].empty?
  query_params[:maskingColumnGroup] = OCI::ApiClient.build_collection_params(opts[:masking_column_group], :multi) if opts[:masking_column_group] && !opts[:masking_column_group].empty?
  query_params[:sensitiveTypeId] = opts[:sensitive_type_id] if opts[:sensitive_type_id]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#list_masked_columns') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataSafe::Models::MaskedColumnCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_masking_analytics(compartment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_masking_analytics API.

Gets consolidated masking analytics data based on the specified query parameters. If CompartmentIdInSubtreeQueryParam is specified as true, the behaviour is equivalent to accessLevel "ACCESSIBLE" by default.

Parameters:

  • compartment_id (String) —

    A filter to return only resources that match the specified compartment OCID.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :compartment_id_in_subtree (BOOLEAN) —

    Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting. (default to false)

  • :group_by (String) —

    Attribute by which the masking analytics data should be grouped. Allowed values are: targetId, policyId, targetIdAndPolicyId, sensitiveTypeId

  • :target_id (String) —

    A filter to return only items related to a specific target OCID.

  • :masking_policy_id (String) —

    A filter to return only the resources that match the specified masking policy OCID.

  • :sensitive_type_id (String) —

    A filter to return only items related to a specific sensitive type OCID.

  • :target_database_group_id (String) —

    A filter to return the target database group that matches the specified OCID.

  • :sort_by (String) —

    The field to sort by. You can specify only one sorting parameter (sortOrder). The default order for all the fields is ascending.

    Allowed values are: timeLastMasked

  • :sort_order (String) —

    The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

  • :limit (Integer) —

    For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

  • :page (String) —

    For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:



16639
16640
16641
16642
16643
16644
16645
16646
16647
16648
16649
16650
16651
16652
16653
16654
16655
16656
16657
16658
16659
16660
16661
16662
16663
16664
16665
16666
16667
16668
16669
16670
16671
16672
16673
16674
16675
16676
16677
16678
16679
16680
16681
16682
16683
16684
16685
16686
16687
16688
16689
16690
16691
16692
16693
16694
16695
16696
16697
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 16639

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 targetIdAndPolicyId sensitiveTypeId].include?(opts[:group_by])
    raise 'Invalid value for "group_by", must be one of targetId, policyId, targetIdAndPolicyId, sensitiveTypeId.'
  end

  if opts[:sort_by] && !%w[timeLastMasked].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of timeLastMasked.'
  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

  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[:sensitiveTypeId] = opts[:sensitive_type_id] if opts[:sensitive_type_id]
  query_params[:targetDatabaseGroupId] = opts[:target_database_group_id] if opts[:target_database_group_id]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#list_masking_analytics') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataSafe::Models::MaskingAnalyticsCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_masking_columns(masking_policy_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_masking_columns API.

Gets a list of masking columns present in the specified masking policy and based on the specified query parameters.

Parameters:

  • masking_policy_id (String) —

    The OCID of the masking policy.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :limit (Integer) —

    For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

  • :page (String) —

    For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

  • :sort_order (String) —

    The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

  • :sort_by (String) —

    The field to sort by. You can specify only one sorting parameter (sortOrder). The default order for timeCreated is descending. The default order for other fields is ascending. (default to timeCreated) Allowed values are: timeCreated, schemaName, objectName, columnName, dataType

  • :masking_column_lifecycle_state (String) —

    A filter to return only the resources that match the specified lifecycle states.

  • :data_type (Array<String>) —

    A filter to return only resources that match the specified data types. Allowed values are: CHARACTER, DATE, LOB, NUMERIC

  • :schema_name (Array<String>) —

    A filter to return only items related to specific schema name.

  • :object_name (Array<String>) —

    A filter to return only items related to a specific object name.

  • :column_name (Array<String>) —

    A filter to return only a specific column based on column name.

  • :object_type (Array<String>) —

    A filter to return only items related to a specific object type. (default to [ALL]) Allowed values are: ALL, TABLE, EDITIONING_VIEW

  • :masking_column_group (Array<String>) —

    A filter to return only the resources that match the specified masking column group.

  • :sensitive_type_id (String) —

    A filter to return only items related to a specific sensitive type OCID.

  • :is_masking_enabled (BOOLEAN) —

    A filter to return the masking column resources based on the value of their isMaskingEnabled attribute. A value of true returns only those columns for which masking is enabled. A value of false returns only those columns for which masking is disabled. Omitting this parameter returns all the masking columns in a masking policy.

  • :is_seed_required (BOOLEAN) —

    A filter to return masking columns based on whether the assigned masking formats need a seed value for masking. A value of true returns those masking columns that are using Deterministic Encryption or Deterministic Substitution masking format. (default to false)

  • :time_created_greater_than_or_equal_to (DateTime) —

    A filter to return only the resources that were created after the specified date and time, as defined by RFC3339. Using TimeCreatedGreaterThanOrEqualToQueryParam parameter retrieves all resources created after that date.

    Example: 2016-12-19T16:39:57.600Z

  • :time_created_less_than (DateTime) —

    Search for resources that were created before a specific date. Specifying this parameter corresponding timeCreatedLessThan parameter will retrieve all resources created before the specified created date, in "YYYY-MM-ddThh:mmZ" format with a Z offset, as defined by RFC 3339.

    Example: 2016-12-19T16:39:57.600Z

  • :time_updated_greater_than_or_equal_to (DateTime) —

    Search for resources that were updated after a specific date. Specifying this parameter corresponding timeUpdatedGreaterThanOrEqualTo parameter will retrieve all resources updated after the specified created date, in "YYYY-MM-ddThh:mmZ" format with a Z offset, as defined by RFC 3339.

  • :time_updated_less_than (DateTime) —

    Search for resources that were updated before a specific date. Specifying this parameter corresponding timeUpdatedLessThan parameter will retrieve all resources updated before the specified created date, in "YYYY-MM-ddThh:mmZ" format with a Z offset, as defined by RFC 3339.

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:



16767
16768
16769
16770
16771
16772
16773
16774
16775
16776
16777
16778
16779
16780
16781
16782
16783
16784
16785
16786
16787
16788
16789
16790
16791
16792
16793
16794
16795
16796
16797
16798
16799
16800
16801
16802
16803
16804
16805
16806
16807
16808
16809
16810
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
16851
16852
16853
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 16767

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 columnName dataType].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of timeCreated, schemaName, objectName, columnName, dataType.'
  end

  if opts[:masking_column_lifecycle_state] && !OCI::DataSafe::Models::MASKING_COLUMN_LIFECYCLE_STATE_ENUM.include?(opts[:masking_column_lifecycle_state])
    raise 'Invalid value for "masking_column_lifecycle_state", must be one of the values in OCI::DataSafe::Models::MASKING_COLUMN_LIFECYCLE_STATE_ENUM.'
  end


  data_type_allowable_values = %w[CHARACTER DATE LOB NUMERIC]
  if opts[:data_type] && !opts[:data_type].empty?
    opts[:data_type].each do |val_to_check|
      unless data_type_allowable_values.include?(val_to_check)
        raise 'Invalid value for "data_type", must be one of CHARACTER, DATE, LOB, NUMERIC.'
      end
    end
  end


  object_type_allowable_values = %w[ALL TABLE EDITIONING_VIEW]
  if opts[:object_type] && !opts[:object_type].empty?
    opts[:object_type].each do |val_to_check|
      unless object_type_allowable_values.include?(val_to_check)
        raise 'Invalid value for "object_type", must be one of ALL, TABLE, EDITIONING_VIEW.'
      end
    end
  end
  raise "Parameter value for 'masking_policy_id' must not be blank" if OCI::Internal::Util.blank_string?(masking_policy_id)

  path = '/maskingPolicies/{maskingPolicyId}/maskingColumns'.sub('{maskingPolicyId}', masking_policy_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:maskingColumnLifecycleState] = opts[:masking_column_lifecycle_state] if opts[:masking_column_lifecycle_state]
  query_params[:dataType] = OCI::ApiClient.build_collection_params(opts[:data_type], :multi) if opts[:data_type] && !opts[:data_type].empty?
  query_params[:schemaName] = OCI::ApiClient.build_collection_params(opts[:schema_name], :multi) if opts[:schema_name] && !opts[:schema_name].empty?
  query_params[:objectName] = OCI::ApiClient.build_collection_params(opts[:object_name], :multi) if opts[:object_name] && !opts[:object_name].empty?
  query_params[:columnName] = OCI::ApiClient.build_collection_params(opts[:column_name], :multi) if opts[:column_name] && !opts[:column_name].empty?
  query_params[:objectType] = OCI::ApiClient.build_collection_params(opts[:object_type], :multi) if opts[:object_type] && !opts[:object_type].empty?
  query_params[:maskingColumnGroup] = OCI::ApiClient.build_collection_params(opts[:masking_column_group], :multi) if opts[:masking_column_group] && !opts[:masking_column_group].empty?
  query_params[:sensitiveTypeId] = opts[:sensitive_type_id] if opts[:sensitive_type_id]
  query_params[:isMaskingEnabled] = opts[:is_masking_enabled] if !opts[:is_masking_enabled].nil?
  query_params[:isSeedRequired] = opts[:is_seed_required] if !opts[:is_seed_required].nil?
  query_params[:timeCreatedGreaterThanOrEqualTo] = opts[:time_created_greater_than_or_equal_to] if opts[:time_created_greater_than_or_equal_to]
  query_params[:timeCreatedLessThan] = opts[:time_created_less_than] if opts[:time_created_less_than]
  query_params[:timeUpdatedGreaterThanOrEqualTo] = opts[:time_updated_greater_than_or_equal_to] if opts[:time_updated_greater_than_or_equal_to]
  query_params[:timeUpdatedLessThan] = opts[:time_updated_less_than] if opts[:time_updated_less_than]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#list_masking_columns') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataSafe::Models::MaskingColumnCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_masking_errors(masking_report_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_masking_errors API.

Gets a list of masking errors in a masking run based on the specified query parameters.

Parameters:

  • masking_report_id (String) —

    The OCID of the masking report.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :step_name (String) —

    A filter to return only masking errors that match the specified step name. Allowed values are: VALIDATE, GENERATE_SCRIPT, EXECUTE_MASKING, PRE_MASKING, POST_MASKING

  • :sort_by (String) —

    The field to sort by. The default order will be ascending. (default to stepName) Allowed values are: stepName, timeCreated

  • :limit (Integer) —

    For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

  • :page (String) —

    For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

  • :sort_order (String) —

    The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:



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
16918
16919
16920
16921
16922
16923
16924
16925
16926
16927
16928
16929
16930
16931
16932
16933
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 16880

def list_masking_errors(masking_report_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#list_masking_errors.' if logger

  raise "Missing the required parameter 'masking_report_id' when calling list_masking_errors." if masking_report_id.nil?

  if opts[:step_name] && !%w[VALIDATE GENERATE_SCRIPT EXECUTE_MASKING PRE_MASKING POST_MASKING].include?(opts[:step_name])
    raise 'Invalid value for "step_name", must be one of VALIDATE, GENERATE_SCRIPT, EXECUTE_MASKING, PRE_MASKING, POST_MASKING.'
  end

  if opts[:sort_by] && !%w[stepName timeCreated].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of stepName, timeCreated.'
  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 'masking_report_id' must not be blank" if OCI::Internal::Util.blank_string?(masking_report_id)

  path = '/maskingReports/{maskingReportId}/maskingErrors'.sub('{maskingReportId}', masking_report_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:stepName] = opts[:step_name] if opts[:step_name]
  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[:sortOrder] = opts[:sort_order] if opts[:sort_order]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#list_masking_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: 'OCI::DataSafe::Models::MaskingErrorCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_masking_objects(masking_policy_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_masking_objects API.

Gets a list of masking objects present in the specified masking policy and based on the specified query parameters.

Parameters:

  • masking_policy_id (String) —

    The OCID of the masking policy.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :limit (Integer) —

    For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

  • :page (String) —

    For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

  • :sort_order (String) —

    The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

  • :sort_by (String) —

    The field to sort by. You can specify only one sorting parameter (sortOrder). The default order is ascending. (default to schemaName) Allowed values are: schemaName, objectName, objectType

  • :schema_name (Array<String>) —

    A filter to return only items related to specific schema name.

  • :object_name (Array<String>) —

    A filter to return only items related to a specific object name.

  • :object_type (Array<String>) —

    A filter to return only items related to a specific object type. (default to [ALL]) Allowed values are: ALL, TABLE, EDITIONING_VIEW

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:



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
16990
16991
16992
16993
16994
16995
16996
16997
16998
16999
17000
17001
17002
17003
17004
17005
17006
17007
17008
17009
17010
17011
17012
17013
17014
17015
17016
17017
17018
17019
17020
17021
17022
17023
17024
17025
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 16964

def list_masking_objects(masking_policy_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#list_masking_objects.' if logger

  raise "Missing the required parameter 'masking_policy_id' when calling list_masking_objects." if masking_policy_id.nil?

  if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of ASC, DESC.'
  end

  if opts[:sort_by] && !%w[schemaName objectName objectType].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of schemaName, objectName, objectType.'
  end


  object_type_allowable_values = %w[ALL TABLE EDITIONING_VIEW]
  if opts[:object_type] && !opts[:object_type].empty?
    opts[:object_type].each do |val_to_check|
      unless object_type_allowable_values.include?(val_to_check)
        raise 'Invalid value for "object_type", must be one of ALL, TABLE, EDITIONING_VIEW.'
      end
    end
  end
  raise "Parameter value for 'masking_policy_id' must not be blank" if OCI::Internal::Util.blank_string?(masking_policy_id)

  path = '/maskingPolicies/{maskingPolicyId}/maskingObjects'.sub('{maskingPolicyId}', masking_policy_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:schemaName] = OCI::ApiClient.build_collection_params(opts[:schema_name], :multi) if opts[:schema_name] && !opts[:schema_name].empty?
  query_params[:objectName] = OCI::ApiClient.build_collection_params(opts[:object_name], :multi) if opts[:object_name] && !opts[:object_name].empty?
  query_params[:objectType] = OCI::ApiClient.build_collection_params(opts[:object_type], :multi) if opts[:object_type] && !opts[:object_type].empty?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#list_masking_objects') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataSafe::Models::MaskingObjectCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_masking_policies(compartment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_masking_policies API.

Gets a list of masking policies based on the specified query parameters.

Parameters:

  • compartment_id (String) —

    A filter to return only resources that match the specified compartment OCID.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :masking_policy_id (String) —

    A filter to return only the resources that match the specified masking policy OCID.

  • :display_name (String) —

    A filter to return only resources that match the specified display name.

  • :limit (Integer) —

    For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

  • :page (String) —

    For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

  • :lifecycle_state (String) —

    A filter to return only the resources that match the specified lifecycle states.

  • :sort_order (String) —

    The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

  • :sort_by (String) —

    The field to sort by. You can specify only one sorting parameter (sortOrder). The default order for timeCreated is descending. The default order for displayName is ascending. The displayName sort order is case sensitive. (default to timeCreated) Allowed values are: displayName, timeCreated

  • :sensitive_data_model_id (String) —

    A filter to return only the resources that match the specified sensitive data model OCID.

  • :target_id (String) —

    A filter to return only items related to a specific target OCID.

  • :time_created_greater_than_or_equal_to (DateTime) —

    A filter to return only the resources that were created after the specified date and time, as defined by RFC3339. Using TimeCreatedGreaterThanOrEqualToQueryParam parameter retrieves all resources created after that date.

    Example: 2016-12-19T16:39:57.600Z

  • :time_created_less_than (DateTime) —

    Search for resources that were created before a specific date. Specifying this parameter corresponding timeCreatedLessThan parameter will retrieve all resources created before the specified created date, in "YYYY-MM-ddThh:mmZ" format with a Z offset, as defined by RFC 3339.

    Example: 2016-12-19T16:39:57.600Z

  • :compartment_id_in_subtree (BOOLEAN) —

    Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting. (default to false)

  • :access_level (String) —

    Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed. (default to RESTRICTED) Allowed values are: RESTRICTED, ACCESSIBLE

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:



17079
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
17117
17118
17119
17120
17121
17122
17123
17124
17125
17126
17127
17128
17129
17130
17131
17132
17133
17134
17135
17136
17137
17138
17139
17140
17141
17142
17143
17144
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 17079

def list_masking_policies(compartment_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#list_masking_policies.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_masking_policies." if compartment_id.nil?

  if opts[:lifecycle_state] && !OCI::DataSafe::Models::MASKING_LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::DataSafe::Models::MASKING_LIFECYCLE_STATE_ENUM.'
  end

  if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of ASC, DESC.'
  end

  if opts[:sort_by] && !%w[displayName timeCreated].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of displayName, timeCreated.'
  end

  if opts[:access_level] && !%w[RESTRICTED ACCESSIBLE].include?(opts[:access_level])
    raise 'Invalid value for "access_level", must be one of RESTRICTED, ACCESSIBLE.'
  end

  path = '/maskingPolicies'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:maskingPolicyId] = opts[:masking_policy_id] if opts[:masking_policy_id]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:sensitiveDataModelId] = opts[:sensitive_data_model_id] if opts[:sensitive_data_model_id]
  query_params[:targetId] = opts[:target_id] if opts[:target_id]
  query_params[:timeCreatedGreaterThanOrEqualTo] = opts[:time_created_greater_than_or_equal_to] if opts[:time_created_greater_than_or_equal_to]
  query_params[:timeCreatedLessThan] = opts[:time_created_less_than] if opts[:time_created_less_than]
  query_params[:compartmentIdInSubtree] = opts[:compartment_id_in_subtree] if !opts[:compartment_id_in_subtree].nil?
  query_params[:accessLevel] = opts[:access_level] if opts[:access_level]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#list_masking_policies') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataSafe::Models::MaskingPolicyCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_masking_policy_health_report_logs(masking_policy_health_report_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_masking_policy_health_report_logs API.

Gets a list of errors and warnings from a masking policy health check.

Parameters:

  • masking_policy_health_report_id (String) —

    The OCID of the masking health report.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :limit (Integer) —

    For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

  • :page (String) —

    For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

  • :sort_order (String) —

    The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :sort_by (String) —

    sort by (default to logType) Allowed values are: logType

  • :message_type (String) —

    A filter to return only the resources that match the specified log message type. Allowed values are: PASS, WARNING, ERROR

Returns:



17171
17172
17173
17174
17175
17176
17177
17178
17179
17180
17181
17182
17183
17184
17185
17186
17187
17188
17189
17190
17191
17192
17193
17194
17195
17196
17197
17198
17199
17200
17201
17202
17203
17204
17205
17206
17207
17208
17209
17210
17211
17212
17213
17214
17215
17216
17217
17218
17219
17220
17221
17222
17223
17224
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 17171

def list_masking_policy_health_report_logs(masking_policy_health_report_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#list_masking_policy_health_report_logs.' if logger

  raise "Missing the required parameter 'masking_policy_health_report_id' when calling list_masking_policy_health_report_logs." if masking_policy_health_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[logType].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of logType.'
  end

  if opts[:message_type] && !%w[PASS WARNING ERROR].include?(opts[:message_type])
    raise 'Invalid value for "message_type", must be one of PASS, WARNING, ERROR.'
  end
  raise "Parameter value for 'masking_policy_health_report_id' must not be blank" if OCI::Internal::Util.blank_string?(masking_policy_health_report_id)

  path = '/maskingPolicyHealthReports/{maskingPolicyHealthReportId}/logs'.sub('{maskingPolicyHealthReportId}', masking_policy_health_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[:messageType] = opts[:message_type] if opts[:message_type]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#list_masking_policy_health_report_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: 'OCI::DataSafe::Models::MaskingPolicyHealthReportLogCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_masking_policy_health_reports(compartment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_masking_policy_health_reports API.

Gets a list of masking policy health reports based on the specified query parameters.

Parameters:

  • compartment_id (String) —

    A filter to return only resources that match the specified compartment OCID.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :masking_policy_health_report_id (String) —

    A filter to return only the resources that match the specified masking policy health report OCID.

  • :limit (Integer) —

    For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

  • :page (String) —

    For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :compartment_id_in_subtree (BOOLEAN) —

    Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting. (default to false)

  • :access_level (String) —

    Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed. (default to RESTRICTED) Allowed values are: RESTRICTED, ACCESSIBLE

  • :sort_by (String) —

    sort by (default to timeCreated) Allowed values are: displayName, timeCreated

  • :sort_order (String) —

    The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

  • :display_name (String) —

    A filter to return only resources that match the specified display name.

  • :target_id (String) —

    A filter to return only items related to a specific target OCID.

  • :masking_policy_id (String) —

    A filter to return only the resources that match the specified masking policy OCID.

  • :lifecycle_state (String) —

    A filter to return only the resources that match the specified lifecycle states.

Returns:



17263
17264
17265
17266
17267
17268
17269
17270
17271
17272
17273
17274
17275
17276
17277
17278
17279
17280
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
17321
17322
17323
17324
17325
17326
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 17263

def list_masking_policy_health_reports(compartment_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#list_masking_policy_health_reports.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_masking_policy_health_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_by] && !%w[displayName timeCreated].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of displayName, timeCreated.'
  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[: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

  path = '/maskingPolicyHealthReports'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:maskingPolicyHealthReportId] = opts[:masking_policy_health_report_id] if opts[:masking_policy_health_report_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[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:targetId] = opts[:target_id] if opts[:target_id]
  query_params[:maskingPolicyId] = opts[:masking_policy_id] if opts[:masking_policy_id]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#list_masking_policy_health_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::MaskingPolicyHealthReportCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_masking_policy_referential_relations(masking_policy_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_masking_policy_referential_relations API.

Gets a list of referential relations present in the specified masking policy based on the specified query parameters.

Allowed values are: relationType, schemaName, objectName

Parameters:

  • masking_policy_id (String) —

    The OCID of the masking policy.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :schema_name (Array<String>) —

    A filter to return only items related to specific schema name.

  • :object_name (Array<String>) —

    A filter to return only items related to a specific object name.

  • :column_name (Array<String>) —

    A filter to return only a specific column based on column name.

  • :relation_type (Array<String>) —

    A filter to return columns based on their relationship with their parent columns. If set to NONE, it returns the columns that do not have any parent. The response includes the parent columns as well as the independent columns that are not in any relationship. If set to APP_DEFINED, it returns all the child columns that have application-level (non-dictionary) relationship with their parents. If set to DB_DEFINED, it returns all the child columns that have database-level (dictionary-defined) relationship with their parents.

    Allowed values are: NONE, APP_DEFINED, DB_DEFINED

  • :limit (Integer) —

    For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

  • :page (String) —

    For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

  • :sort_order (String) —

    The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

  • :sort_by (String) —

    The field to sort by. You can specify only one sorting parameter (sortOrder). (default to schemaName)

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:



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
17389
17390
17391
17392
17393
17394
17395
17396
17397
17398
17399
17400
17401
17402
17403
17404
17405
17406
17407
17408
17409
17410
17411
17412
17413
17414
17415
17416
17417
17418
17419
17420
17421
17422
17423
17424
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 17362

def list_masking_policy_referential_relations(masking_policy_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#list_masking_policy_referential_relations.' if logger

  raise "Missing the required parameter 'masking_policy_id' when calling list_masking_policy_referential_relations." if masking_policy_id.nil?


  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[relationType schemaName objectName].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of relationType, schemaName, objectName.'
  end
  raise "Parameter value for 'masking_policy_id' must not be blank" if OCI::Internal::Util.blank_string?(masking_policy_id)

  path = '/maskingPolicies/{maskingPolicyId}/referentialRelations'.sub('{maskingPolicyId}', masking_policy_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[:columnName] = OCI::ApiClient.build_collection_params(opts[:column_name], :multi) if opts[:column_name] && !opts[:column_name].empty?
  query_params[:relationType] = OCI::ApiClient.build_collection_params(opts[:relation_type], :multi) if opts[:relation_type] && !opts[:relation_type].empty?
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#list_masking_policy_referential_relations') 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::MaskingPolicyReferentialRelationCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_masking_reports(compartment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_masking_reports API.

Gets a list of masking reports based on the specified query parameters. Allowed values are: timeMaskingFinished

Parameters:

  • compartment_id (String) —

    A filter to return only resources that match the specified compartment OCID.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :limit (Integer) —

    For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

  • :page (String) —

    For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

  • :masking_policy_id (String) —

    A filter to return only the resources that match the specified masking policy OCID.

  • :target_id (String) —

    A filter to return only items related to a specific target OCID.

  • :target_database_group_id (String) —

    A filter to return the target database group that matches the specified OCID.

  • :sort_order (String) —

    The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

  • :sort_by (String) —

    The field to sort by. You can specify only one sorting parameter (sortOrder). The default order for timeMaskingFinished is descending. (default to timeMaskingFinished)

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :compartment_id_in_subtree (BOOLEAN) —

    Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting. (default to false)

  • :access_level (String) —

    Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed. (default to RESTRICTED) Allowed values are: RESTRICTED, ACCESSIBLE

Returns:



17461
17462
17463
17464
17465
17466
17467
17468
17469
17470
17471
17472
17473
17474
17475
17476
17477
17478
17479
17480
17481
17482
17483
17484
17485
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
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 17461

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[:targetDatabaseGroupId] = opts[:target_database_group_id] if opts[:target_database_group_id]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:compartmentIdInSubtree] = opts[:compartment_id_in_subtree] if !opts[:compartment_id_in_subtree].nil?
  query_params[:accessLevel] = opts[:access_level] if opts[:access_level]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#list_masking_reports') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataSafe::Models::MaskingReportCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_masking_schemas(masking_policy_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_masking_schemas API.

Gets a list of masking schemas present in the specified masking policy and based on the specified query parameters.

Parameters:

  • masking_policy_id (String) —

    The OCID of the masking policy.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :limit (Integer) —

    For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

  • :page (String) —

    For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

  • :sort_order (String) —

    The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

  • :sort_by (String) —

    The field to sort by. You can specify only one sorting parameter (sortOrder). The default order is ascending. (default to schemaName) Allowed values are: schemaName

  • :schema_name (Array<String>) —

    A filter to return only items related to specific schema name.

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:



17546
17547
17548
17549
17550
17551
17552
17553
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
17593
17594
17595
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 17546

def list_masking_schemas(masking_policy_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#list_masking_schemas.' if logger

  raise "Missing the required parameter 'masking_policy_id' when calling list_masking_schemas." if masking_policy_id.nil?

  if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of ASC, DESC.'
  end

  if opts[:sort_by] && !%w[schemaName].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of schemaName.'
  end
  raise "Parameter value for 'masking_policy_id' must not be blank" if OCI::Internal::Util.blank_string?(masking_policy_id)

  path = '/maskingPolicies/{maskingPolicyId}/maskingSchemas'.sub('{maskingPolicyId}', masking_policy_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:schemaName] = OCI::ApiClient.build_collection_params(opts[:schema_name], :multi) if opts[:schema_name] && !opts[:schema_name].empty?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#list_masking_schemas') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataSafe::Models::MaskingSchemaCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_on_prem_connectors(compartment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_on_prem_connectors API.

Gets a list of on-premises connectors.

Parameters:

  • compartment_id (String) —

    A filter to return only resources that match the specified compartment OCID.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :on_prem_connector_id (String) —

    A filter to return only the on-premises connector that matches the specified id.

  • :display_name (String) —

    A filter to return only resources that match the specified display name.

  • :lifecycle_state (String) —

    A filter to return only on-premises connector resources that match the specified lifecycle state.

  • :limit (Integer) —

    For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

  • :page (String) —

    For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

  • :sort_order (String) —

    The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

  • :sort_by (String) —

    The field used for sorting. Only one sorting order (sortOrder) can be specified. The default order for TIMECREATED is descending. The default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. (default to TIMECREATED) Allowed values are: TIMECREATED, DISPLAYNAME

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :compartment_id_in_subtree (BOOLEAN) —

    Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting. (default to false)

  • :access_level (String) —

    Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed. (default to RESTRICTED) Allowed values are: RESTRICTED, ACCESSIBLE

Returns:



17636
17637
17638
17639
17640
17641
17642
17643
17644
17645
17646
17647
17648
17649
17650
17651
17652
17653
17654
17655
17656
17657
17658
17659
17660
17661
17662
17663
17664
17665
17666
17667
17668
17669
17670
17671
17672
17673
17674
17675
17676
17677
17678
17679
17680
17681
17682
17683
17684
17685
17686
17687
17688
17689
17690
17691
17692
17693
17694
17695
17696
17697
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 17636

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[:lifecycle_state] && !OCI::DataSafe::Models::ON_PREM_CONNECTOR_LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "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[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:compartmentIdInSubtree] = opts[:compartment_id_in_subtree] if !opts[:compartment_id_in_subtree].nil?
  query_params[:accessLevel] = opts[:access_level] if opts[:access_level]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#list_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_password_expiry_date_analytics(user_assessment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_password_expiry_date_analytics API.

Gets a list of count of the users with password expiry dates in next 30 days, between next 30-90 days, and beyond 90 days based on specified user assessment. It internally uses the aforementioned userAnalytics api.

When you perform the ListPasswordExpiryDateAnalytics operation, if the parameter compartmentIdInSubtree is set to "true," and if the parameter accessLevel is set to ACCESSIBLE, then the operation returns compartments in which the requestor has READ permissions on at least one resource, directly or indirectly (in subcompartments). If the operation is performed at the root compartment and the requestor does not have access to at least one subcompartment of the compartment specified by compartmentId, then "Not Authorized" is returned.

To use ListPasswordExpiryDateAnalytics to get a full list of all compartments and subcompartments in the tenancy from the root compartment, set the parameter compartmentIdInSubtree to true and accessLevel to ACCESSIBLE.

Parameters:

  • user_assessment_id (String) —

    The OCID of the user assessment.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :compartment_id_in_subtree (BOOLEAN) —

    Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting. (default to false)

  • :access_level (String) —

    Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed. (default to RESTRICTED) Allowed values are: RESTRICTED, ACCESSIBLE

  • :user_category (String) —

    A filter to return only items that match the specified user category.

  • :time_password_expiry_less_than (DateTime) —

    A filter to return users whose password expiry date in the database is less than the date and time specified, in the format defined by RFC3339. Example: 2016-12-19T16:39:57.600Z

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:



17739
17740
17741
17742
17743
17744
17745
17746
17747
17748
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
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 17739

def list_password_expiry_date_analytics(user_assessment_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#list_password_expiry_date_analytics.' if logger

  raise "Missing the required parameter 'user_assessment_id' when calling list_password_expiry_date_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
  raise "Parameter value for 'user_assessment_id' must not be blank" if OCI::Internal::Util.blank_string?(user_assessment_id)

  path = '/userAssessments/{userAssessmentId}/passwordExpiryDateAnalytics'.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[:userCategory] = opts[:user_category] if opts[:user_category]
  query_params[:timePasswordExpiryLessThan] = opts[:time_password_expiry_less_than] if opts[:time_password_expiry_less_than]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#list_password_expiry_date_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_peer_target_databases(target_database_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_peer_target_databases API.

Lists all the peer target databases under the primary target database identified by the OCID passed as path parameter.

Parameters:

  • target_database_id (String) —

    The OCID of the Data Safe target database.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

  • :limit (Integer) —

    For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

  • :page (String) —

    For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

Returns:



17814
17815
17816
17817
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
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 17814

def list_peer_target_databases(target_database_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#list_peer_target_databases.' if logger

  raise "Missing the required parameter 'target_database_id' when calling list_peer_target_databases." 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}/peerTargetDatabases'.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]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#list_peer_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: 'OCI::DataSafe::Models::PeerTargetDatabaseCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_profile_analytics(user_assessment_id, compartment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_profile_analytics API.

Gets a list of aggregated user profile details in the specified compartment. This provides information about the overall profiles available. For example, the user profile details include how many users have the profile assigned and do how many use password verification function. This data is especially useful content for dashboards or to support analytics.

When you perform the ListProfileAnalytics operation, if the parameter compartmentIdInSubtree is set to "true," and if the parameter accessLevel is set to ACCESSIBLE, then the operation returns compartments in which the requestor has INSPECT permissions on at least one resource, directly or indirectly (in subcompartments). If the operation is performed at the root compartment and the requestor does not have access to at least one subcompartment of the compartment specified by compartmentId, then "Not Authorized" is returned.

The parameter compartmentIdInSubtree applies when you perform ListProfileAnalytics on the compartmentId passed and when it is set to true, the entire hierarchy of compartments can be returned.

To use ListProfileAnalytics to get a full list of all compartments and subcompartments in the tenancy from the root compartment, set the parameter compartmentIdInSubtree to true and accessLevel to ACCESSIBLE.

Parameters:

  • user_assessment_id (String) —

    The OCID of the user assessment.

  • compartment_id (String) —

    A filter to return only resources that match the specified compartment OCID.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :compartment_id_in_subtree (BOOLEAN) —

    Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting. (default to false)

  • :access_level (String) —

    Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed. (default to RESTRICTED) Allowed values are: RESTRICTED, ACCESSIBLE

  • :target_id (String) —

    A filter to return only items related to a specific target OCID.

  • :limit (Integer) —

    For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

  • :page (String) —

    For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

  • :profile_name (String) —

    A filter to return only items that match the specified profile name.

  • :sort_by (String) —

    The field used for sorting. Only one sorting order (sortOrder) can be specified. The default order for TIMECREATED is descending. The default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. (default to TIMECREATED) Allowed values are: TIMECREATED, DISPLAYNAME

  • :sort_order (String) —

    The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:



17909
17910
17911
17912
17913
17914
17915
17916
17917
17918
17919
17920
17921
17922
17923
17924
17925
17926
17927
17928
17929
17930
17931
17932
17933
17934
17935
17936
17937
17938
17939
17940
17941
17942
17943
17944
17945
17946
17947
17948
17949
17950
17951
17952
17953
17954
17955
17956
17957
17958
17959
17960
17961
17962
17963
17964
17965
17966
17967
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 17909

def list_profile_analytics(user_assessment_id, compartment_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#list_profile_analytics.' if logger

  raise "Missing the required parameter 'user_assessment_id' when calling list_profile_analytics." if user_assessment_id.nil?
  raise "Missing the required parameter 'compartment_id' when calling list_profile_analytics." if compartment_id.nil?

  if opts[:access_level] && !%w[RESTRICTED ACCESSIBLE].include?(opts[:access_level])
    raise 'Invalid value for "access_level", must be one of RESTRICTED, ACCESSIBLE.'
  end

  if opts[:sort_by] && !%w[TIMECREATED DISPLAYNAME].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of TIMECREATED, DISPLAYNAME.'
  end

  if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of ASC, DESC.'
  end
  raise "Parameter value for 'user_assessment_id' must not be blank" if OCI::Internal::Util.blank_string?(user_assessment_id)

  path = '/userAssessments/{userAssessmentId}/profileAnalytics'.sub('{userAssessmentId}', user_assessment_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:compartmentIdInSubtree] = opts[:compartment_id_in_subtree] if !opts[:compartment_id_in_subtree].nil?
  query_params[:accessLevel] = opts[:access_level] if opts[:access_level]
  query_params[:targetId] = opts[:target_id] if opts[:target_id]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:profileName] = opts[:profile_name] if opts[:profile_name]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#list_profile_analytics') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'Array<OCI::DataSafe::Models::ProfileAggregation>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_profile_summaries(user_assessment_id, compartment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_profile_summaries API.

Gets a list of user profiles containing the profile details along with the target id and user counts.

The ListProfiles operation returns only the profiles belonging to a certain target. If compartment type user assessment id is provided, then profile information for all the targets belonging to the pertaining compartment is returned. The list does not include any subcompartments of the compartment under consideration.

The parameter 'accessLevel' specifies whether to return only those compartments for which the requestor has INSPECT permissions on at least one resource directly or indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if Principal doesn't have access to even one of the child compartments. This is valid only when 'compartmentIdInSubtree' is set to 'true'.

The parameter 'compartmentIdInSubtree' applies when you perform ListUserProfiles on the 'compartmentId' belonging to the assessmentId passed and when it is set to true, the entire hierarchy of compartments can be returned. To get a full list of all compartments and subcompartments in the tenancy (root compartment), set the parameter 'compartmentIdInSubtree' to true and 'accessLevel' to ACCESSIBLE.

Allowed values are: profileName, targetId, isUserCreated, passwordVerificationFunction, userCount, sessionsPerUser, inactiveAccountTime, passwordLockTime, failedLoginAttempts

Parameters:

  • user_assessment_id (String) —

    The OCID of the user assessment.

  • compartment_id (String) —

    A filter to return only resources that match the specified compartment OCID.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :compartment_id_in_subtree (BOOLEAN) —

    Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting. (default to false)

  • :access_level (String) —

    Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed. (default to RESTRICTED) Allowed values are: RESTRICTED, ACCESSIBLE

  • :target_id (String) —

    A filter to return only items related to a specific target OCID.

  • :limit (Integer) —

    For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

  • :page (String) —

    For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

  • :profile_name (String) —

    A filter to return only items that match the specified profile name.

  • :is_user_created (BOOLEAN) —

    An optional filter to return the user created profiles.

  • :password_verification_function (String) —

    An optional filter to filter the profiles based on password verification function.

  • :user_count_greater_than_or_equal (String) —

    An optional filter to return the profiles having user count greater than or equal to the provided value.

  • :user_count_less_than (String) —

    An optional filter to return the profiles having user count less than the provided value.

  • :failed_login_attempts_greater_than_or_equal (String) —

    An optional filter to return the profiles having allow failed login attempts number greater than or equal to the provided value. String value is used for accommodating the "UNLIMITED" and "DEFAULT" values.

  • :failed_login_attempts_less_than (String) —

    An optional filter to return the profiles having failed login attempts number less than the provided value. String value is used for accommodating the "UNLIMITED" and "DEFAULT" values.

  • :sessions_per_user_greater_than_or_equal (String) —

    An optional filter to return the profiles permitting the user to spawn multiple sessions having count. greater than or equal to the provided value. String value is used for accommodating the "UNLIMITED" and "DEFAULT" values.

  • :sessions_per_user_less_than (String) —

    An optional filter to return the profiles permitting the user to spawn multiple sessions having count less than the provided value. String value is used for accommodating the "UNLIMITED" and "DEFAULT" values.

  • :inactive_account_time_greater_than_or_equal (String) —

    An optional filter to return the profiles allowing inactive account time in days greater than or equal to the provided value. String value is used for accommodating the "UNLIMITED" and "DEFAULT" values.

  • :inactive_account_time_less_than (String) —

    An optional filter to return the profiles allowing inactive account time in days less than the provided value. String value is used for accommodating the "UNLIMITED" and "DEFAULT" values.

  • :password_lock_time_greater_than_or_equal (String) —

    An optional filter to return the profiles having password lock number greater than or equal to the provided value. String value is used for accommodating the "UNLIMITED" and "DEFAULT" values.

  • :password_lock_time_less_than (String) —

    An optional filter to return the profiles having password lock number less than the provided value. String value is used for accommodating the "UNLIMITED" and "DEFAULT" values.

  • :sort_by (String) —

    The field to sort by. You can specify only one sort order (sortOrder). The default order is targetId ASC. (default to targetId)

  • :sort_order (String) —

    The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:



18049
18050
18051
18052
18053
18054
18055
18056
18057
18058
18059
18060
18061
18062
18063
18064
18065
18066
18067
18068
18069
18070
18071
18072
18073
18074
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
18113
18114
18115
18116
18117
18118
18119
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 18049

def list_profile_summaries(user_assessment_id, compartment_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#list_profile_summaries.' if logger

  raise "Missing the required parameter 'user_assessment_id' when calling list_profile_summaries." if user_assessment_id.nil?
  raise "Missing the required parameter 'compartment_id' when calling list_profile_summaries." if compartment_id.nil?

  if opts[:access_level] && !%w[RESTRICTED ACCESSIBLE].include?(opts[:access_level])
    raise 'Invalid value for "access_level", must be one of RESTRICTED, ACCESSIBLE.'
  end

  if opts[:sort_by] && !%w[profileName targetId isUserCreated passwordVerificationFunction userCount sessionsPerUser inactiveAccountTime passwordLockTime failedLoginAttempts].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of profileName, targetId, isUserCreated, passwordVerificationFunction, userCount, sessionsPerUser, inactiveAccountTime, passwordLockTime, failedLoginAttempts.'
  end

  if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of ASC, DESC.'
  end
  raise "Parameter value for 'user_assessment_id' must not be blank" if OCI::Internal::Util.blank_string?(user_assessment_id)

  path = '/userAssessments/{userAssessmentId}/profiles'.sub('{userAssessmentId}', user_assessment_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:compartmentIdInSubtree] = opts[:compartment_id_in_subtree] if !opts[:compartment_id_in_subtree].nil?
  query_params[:accessLevel] = opts[:access_level] if opts[:access_level]
  query_params[:targetId] = opts[:target_id] if opts[:target_id]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:profileName] = opts[:profile_name] if opts[:profile_name]
  query_params[:isUserCreated] = opts[:is_user_created] if !opts[:is_user_created].nil?
  query_params[:passwordVerificationFunction] = opts[:password_verification_function] if opts[:password_verification_function]
  query_params[:userCountGreaterThanOrEqual] = opts[:user_count_greater_than_or_equal] if opts[:user_count_greater_than_or_equal]
  query_params[:userCountLessThan] = opts[:user_count_less_than] if opts[:user_count_less_than]
  query_params[:failedLoginAttemptsGreaterThanOrEqual] = opts[:failed_login_attempts_greater_than_or_equal] if opts[:failed_login_attempts_greater_than_or_equal]
  query_params[:failedLoginAttemptsLessThan] = opts[:failed_login_attempts_less_than] if opts[:failed_login_attempts_less_than]
  query_params[:sessionsPerUserGreaterThanOrEqual] = opts[:sessions_per_user_greater_than_or_equal] if opts[:sessions_per_user_greater_than_or_equal]
  query_params[:sessionsPerUserLessThan] = opts[:sessions_per_user_less_than] if opts[:sessions_per_user_less_than]
  query_params[:inactiveAccountTimeGreaterThanOrEqual] = opts[:inactive_account_time_greater_than_or_equal] if opts[:inactive_account_time_greater_than_or_equal]
  query_params[:inactiveAccountTimeLessThan] = opts[:inactive_account_time_less_than] if opts[:inactive_account_time_less_than]
  query_params[:passwordLockTimeGreaterThanOrEqual] = opts[:password_lock_time_greater_than_or_equal] if opts[:password_lock_time_greater_than_or_equal]
  query_params[:passwordLockTimeLessThan] = opts[:password_lock_time_less_than] if opts[:password_lock_time_less_than]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#list_profile_summaries') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'Array<OCI::DataSafe::Models::ProfileSummary>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_referential_relations(sensitive_data_model_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_referential_relations API.

Gets a list of referential relations present in the specified sensitive data model based on the specified query parameters.

Allowed values are: key, relationType, schemaName, tableName

Parameters:

  • sensitive_data_model_id (String) —

    The OCID of the sensitive data model.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :schema_name (Array<String>) —

    A filter to return only items related to specific schema name.

  • :object_name (Array<String>) —

    A filter to return only items related to a specific object name.

  • :column_name (Array<String>) —

    A filter to return only a specific column based on column name.

  • :is_sensitive (BOOLEAN) —

    Returns referential relations containing sensitive columns when true. Returns referential relations containing non sensitive columns when false.

  • :relation_type (Array<String>) —

    A filter to return sensitive columns based on their relationship with their parent columns. If set to NONE, it returns the sensitive columns that do not have any parent. The response includes the parent columns as well as the independent columns that are not in any relationship. If set to APP_DEFINED, it returns all the child columns that have application-level (non-dictionary) relationship with their parents. If set to DB_DEFINED, it returns all the child columns that have database-level (dictionary-defined) relationship with their parents.

    Allowed values are: NONE, APP_DEFINED, DB_DEFINED

  • :limit (Integer) —

    For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

  • :page (String) —

    For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

  • :sort_order (String) —

    The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

  • :sort_by (String) —

    The field to sort by. You can specify only one sorting parameter (sortOrder). The default order for key is descending. (default to key)

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:



18158
18159
18160
18161
18162
18163
18164
18165
18166
18167
18168
18169
18170
18171
18172
18173
18174
18175
18176
18177
18178
18179
18180
18181
18182
18183
18184
18185
18186
18187
18188
18189
18190
18191
18192
18193
18194
18195
18196
18197
18198
18199
18200
18201
18202
18203
18204
18205
18206
18207
18208
18209
18210
18211
18212
18213
18214
18215
18216
18217
18218
18219
18220
18221
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 18158

def list_referential_relations(sensitive_data_model_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#list_referential_relations.' if logger

  raise "Missing the required parameter 'sensitive_data_model_id' when calling list_referential_relations." if sensitive_data_model_id.nil?


  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[key relationType schemaName tableName].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of key, relationType, schemaName, tableName.'
  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}/referentialRelations'.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[:columnName] = OCI::ApiClient.build_collection_params(opts[:column_name], :multi) if opts[:column_name] && !opts[:column_name].empty?
  query_params[:isSensitive] = opts[:is_sensitive] if !opts[:is_sensitive].nil?
  query_params[:relationType] = OCI::ApiClient.build_collection_params(opts[:relation_type], :multi) if opts[:relation_type] && !opts[:relation_type].empty?
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#list_referential_relations') 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::ReferentialRelationCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_report_definitions(compartment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_report_definitions API.

Gets a list of report definitions. The ListReportDefinitions operation returns only the report definitions in the specified compartmentId. It also returns the seeded report definitions which are available to all the compartments.

Parameters:

  • compartment_id (String) —

    A filter to return only resources that match the specified compartment OCID.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :compartment_id_in_subtree (BOOLEAN) —

    Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting. (default to false)

  • :access_level (String) —

    Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed. (default to RESTRICTED) Allowed values are: RESTRICTED, ACCESSIBLE

  • :display_name (String) —

    The name of the report definition to query.

  • :limit (Integer) —

    For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

  • :page (String) —

    For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

  • :sort_order (String) —

    The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

  • :sort_by (String) —

    The field used for sorting. Only one sorting parameter order (sortOrder) can be specified. The default order for TIMECREATED is descending. The default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. (default to TIMECREATED) Allowed values are: TIMECREATED, DISPLAYNAME, DISPLAYORDER

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :is_seeded (BOOLEAN) —

    A boolean flag indicating to list seeded report definitions. Set this parameter to get list of seeded report definitions. (default to false)

  • :data_source (String) —

    Specifies the name of a resource that provides data for the report. For example alerts, events.

  • :lifecycle_state (String) —

    An optional filter to return only resources that match the specified lifecycle state.

  • :category (String) —

    An optional filter to return only resources that match the specified category. Allowed values are: CUSTOM_REPORTS, SUMMARY, ACTIVITY_AUDITING

Returns:



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
18299
18300
18301
18302
18303
18304
18305
18306
18307
18308
18309
18310
18311
18312
18313
18314
18315
18316
18317
18318
18319
18320
18321
18322
18323
18324
18325
18326
18327
18328
18329
18330
18331
18332
18333
18334
18335
18336
18337
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 18266

def list_report_definitions(compartment_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#list_report_definitions.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_report_definitions." if compartment_id.nil?

  if opts[:access_level] && !%w[RESTRICTED ACCESSIBLE].include?(opts[:access_level])
    raise 'Invalid value for "access_level", must be one of RESTRICTED, ACCESSIBLE.'
  end

  if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of ASC, DESC.'
  end

  if opts[:sort_by] && !%w[TIMECREATED DISPLAYNAME DISPLAYORDER].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of TIMECREATED, DISPLAYNAME, DISPLAYORDER.'
  end

  if opts[:data_source] && !OCI::DataSafe::Models::REPORT_DEFINITION_DATA_SOURCE_ENUM.include?(opts[:data_source])
    raise 'Invalid value for "data_source", must be one of the values in OCI::DataSafe::Models::REPORT_DEFINITION_DATA_SOURCE_ENUM.'
  end

  if opts[:lifecycle_state] && !OCI::DataSafe::Models::REPORT_DEFINITION_LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::DataSafe::Models::REPORT_DEFINITION_LIFECYCLE_STATE_ENUM.'
  end

  if opts[:category] && !%w[CUSTOM_REPORTS SUMMARY ACTIVITY_AUDITING].include?(opts[:category])
    raise 'Invalid value for "category", must be one of CUSTOM_REPORTS, SUMMARY, ACTIVITY_AUDITING.'
  end

  path = '/reportDefinitions'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:compartmentIdInSubtree] = opts[:compartment_id_in_subtree] if !opts[:compartment_id_in_subtree].nil?
  query_params[:accessLevel] = opts[:access_level] if opts[:access_level]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:isSeeded] = opts[:is_seeded] if !opts[:is_seeded].nil?
  query_params[:dataSource] = opts[:data_source] if opts[:data_source]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:category] = opts[:category] if opts[:category]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#list_report_definitions') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataSafe::Models::ReportDefinitionCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_reports(compartment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_reports API.

Gets a list of all the reports in the compartment. It contains information such as report generation time. Allowed values are: timeGenerated, displayName

Parameters:

  • compartment_id (String) —

    A filter to return only resources that match the specified compartment OCID.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :compartment_id_in_subtree (BOOLEAN) —

    Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting. (default to false)

  • :access_level (String) —

    Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed. (default to RESTRICTED) Allowed values are: RESTRICTED, ACCESSIBLE

  • :display_name (String) —

    The name of the report definition to query.

  • :limit (Integer) —

    For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

  • :page (String) —

    For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

  • :sort_order (String) —

    The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

  • :sort_by (String) —

    The field to sort by. Only one sort order may be provided. Default order for timeGenerated is descending. Default order for displayName is ascending. If no value is specified timeGenerated is default. (default to timeGenerated)

  • :mime_type (String) —

    An optional filter to return only resources that match the specified mime type. Allowed values are: PDF, XLS, JSON

  • :report_definition_id (String) —

    The ID of the report definition to filter the list of reports

  • :time_generated_greater_than_or_equal_to (DateTime) —

    A filter to return only the resources that were generated after the specified date and time, as defined by RFC3339. Using TimeGeneratedGreaterThanOrEqualToQueryParam parameter retrieves all resources generated after that date.

    Example: 2016-12-19T16:39:57.600Z

  • :time_generated_less_than (DateTime) —

    Search for resources that were generated before a specific date. Specifying this parameter corresponding timeGeneratedLessThan parameter will retrieve all resources generated before the specified generated date, in "YYYY-MM-ddThh:mmZ" format with a Z offset, as defined by RFC 3339.

    Example: 2016-12-19T16:39:57.600Z

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :lifecycle_state (String) —

    An optional filter to return only resources that match the specified lifecycle state.

  • :type (String) —

    An optional filter to return only resources that match the specified type.

  • :data_source (String) —

    Specifies the name of a resource that provides data for the report. For example alerts, events.

Returns:



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
18423
18424
18425
18426
18427
18428
18429
18430
18431
18432
18433
18434
18435
18436
18437
18438
18439
18440
18441
18442
18443
18444
18445
18446
18447
18448
18449
18450
18451
18452
18453
18454
18455
18456
18457
18458
18459
18460
18461
18462
18463
18464
18465
18466
18467
18468
18469
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 18391

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[:mime_type] && !%w[PDF XLS JSON].include?(opts[:mime_type])
    raise 'Invalid value for "mime_type", must be one of PDF, XLS, JSON.'
  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

  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

  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[:mimeType] = opts[:mime_type] if opts[:mime_type]
  query_params[:reportDefinitionId] = opts[:report_definition_id] if opts[:report_definition_id]
  query_params[:timeGeneratedGreaterThanOrEqualTo] = opts[:time_generated_greater_than_or_equal_to] if opts[:time_generated_greater_than_or_equal_to]
  query_params[:timeGeneratedLessThan] = opts[:time_generated_less_than] if opts[:time_generated_less_than]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:type] = opts[:type] if opts[:type]
  query_params[:dataSource] = opts[:data_source] if opts[:data_source]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#list_reports') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataSafe::Models::ReportCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_role_grant_paths(security_policy_report_id, grantee, granted_role, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_role_grant_paths API.

Retrieves a list of all role grant paths for a particular user.

The ListRoleGrantPaths operation returns only the role grant paths for the specified security policy report.

Parameters:

  • security_policy_report_id (String) —

    The OCID of the security policy report resource.

  • grantee (String) —

    A filter to return only items that match the specified grantee.

  • granted_role (String) —

    A filter to return only items that match the specified role.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :limit (Integer) —

    For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

  • :page (String) —

    For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:



18494
18495
18496
18497
18498
18499
18500
18501
18502
18503
18504
18505
18506
18507
18508
18509
18510
18511
18512
18513
18514
18515
18516
18517
18518
18519
18520
18521
18522
18523
18524
18525
18526
18527
18528
18529
18530
18531
18532
18533
18534
18535
18536
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 18494

def list_role_grant_paths(security_policy_report_id, grantee, granted_role, opts = {})
  logger.debug 'Calling operation DataSafeClient#list_role_grant_paths.' if logger

  raise "Missing the required parameter 'security_policy_report_id' when calling list_role_grant_paths." if security_policy_report_id.nil?
  raise "Missing the required parameter 'grantee' when calling list_role_grant_paths." if grantee.nil?
  raise "Missing the required parameter 'granted_role' when calling list_role_grant_paths." if granted_role.nil?
  raise "Parameter value for 'security_policy_report_id' must not be blank" if OCI::Internal::Util.blank_string?(security_policy_report_id)

  path = '/securityPolicyReports/{securityPolicyReportId}/roleGrantPaths'.sub('{securityPolicyReportId}', security_policy_report_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:grantee] = grantee
  query_params[:grantedRole] = granted_role
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#list_role_grant_paths') 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::RoleGrantPathCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_roles(target_database_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_roles API.

Returns a list of role metadata objects.

Allowed values are: ROLENAME

Parameters:

  • target_database_id (String) —

    The OCID of the Data Safe target database.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :limit (Integer) —

    For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

  • :page (String) —

    For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

  • :role_name (Array<String>) —

    A filter to return only a specific role based on role name.

  • :is_oracle_maintained (BOOLEAN) —

    A filter to return roles based on whether they are maintained by oracle or not.

  • :authentication_type (String) —

    A filter to return roles based on authentication type.

  • :sort_order (String) —

    The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

  • :sort_by (String) —

    The field used for sorting. Only one sorting order (sortOrder) can be specified. (default to ROLENAME)

  • :role_name_contains (String) —

    A filter to return only items if role name contains a specific string.

Returns:



18566
18567
18568
18569
18570
18571
18572
18573
18574
18575
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
18614
18615
18616
18617
18618
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 18566

def list_roles(target_database_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#list_roles.' if logger

  raise "Missing the required parameter 'target_database_id' when calling list_roles." if target_database_id.nil?

  if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of ASC, DESC.'
  end

  if opts[:sort_by] && !%w[ROLENAME].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of ROLENAME.'
  end
  raise "Parameter value for 'target_database_id' must not be blank" if OCI::Internal::Util.blank_string?(target_database_id)

  path = '/targetDatabases/{targetDatabaseId}/roles'.sub('{targetDatabaseId}', target_database_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:roleName] = OCI::ApiClient.build_collection_params(opts[:role_name], :multi) if opts[:role_name] && !opts[:role_name].empty?
  query_params[:isOracleMaintained] = opts[:is_oracle_maintained] if !opts[:is_oracle_maintained].nil?
  query_params[:authenticationType] = opts[:authentication_type] if opts[:authentication_type]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:roleNameContains] = opts[:role_name_contains] if opts[:role_name_contains]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#list_roles') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'Array<OCI::DataSafe::Models::RoleSummary>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_schemas(target_database_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_schemas API.

Returns list of schema.

Allowed values are: SCHEMANAME

Parameters:

  • target_database_id (String) —

    The OCID of the Data Safe target database.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :limit (Integer) —

    For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

  • :page (String) —

    For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

  • :schema_name (Array<String>) —

    A filter to return only items related to specific schema name.

  • :sort_order (String) —

    The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

  • :sort_by (String) —

    The field used for sorting. Only one sorting order (sortOrder) can be specified. (default to SCHEMANAME)

  • :is_oracle_maintained (BOOLEAN) —

    A filter to return only items related to specific type of schema.

  • :schema_name_contains (String) —

    A filter to return only items if schema name contains a specific string.

Returns:



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
18684
18685
18686
18687
18688
18689
18690
18691
18692
18693
18694
18695
18696
18697
18698
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 18647

def list_schemas(target_database_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#list_schemas.' if logger

  raise "Missing the required parameter 'target_database_id' when calling list_schemas." if target_database_id.nil?

  if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of ASC, DESC.'
  end

  if opts[:sort_by] && !%w[SCHEMANAME].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of SCHEMANAME.'
  end
  raise "Parameter value for 'target_database_id' must not be blank" if OCI::Internal::Util.blank_string?(target_database_id)

  path = '/targetDatabases/{targetDatabaseId}/schemas'.sub('{targetDatabaseId}', target_database_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:schemaName] = OCI::ApiClient.build_collection_params(opts[:schema_name], :multi) if opts[:schema_name] && !opts[:schema_name].empty?
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:isOracleMaintained] = opts[:is_oracle_maintained] if !opts[:is_oracle_maintained].nil?
  query_params[:schemaNameContains] = opts[:schema_name_contains] if opts[:schema_name_contains]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#list_schemas') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'Array<OCI::DataSafe::Models::SchemaSummary>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_sdm_masking_policy_differences(compartment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_sdm_masking_policy_differences API.

Gets a list of SDM and masking policy difference resources based on the specified query parameters.

Parameters:

  • compartment_id (String) —

    A filter to return only resources that match the specified compartment OCID.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :compartment_id_in_subtree (BOOLEAN) —

    Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting. (default to false)

  • :difference_access_level (String) —

    Valid value is ACCESSIBLE. Default is ACCESSIBLE. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). (default to ACCESSIBLE) Allowed values are: ACCESSIBLE

  • :display_name (String) —

    A filter to return only resources that match the specified display name.

  • :sensitive_data_model_id (String) —

    A filter to return only the resources that match the specified sensitive data model OCID.

  • :lifecycle_state (String) —

    A filter to return only the resources that match the specified lifecycle states.

  • :masking_policy_id (String) —

    A filter to return only the resources that match the specified masking policy OCID.

  • :sort_order (String) —

    The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

  • :sort_by (String) —

    The field to sort by. You can specify only one sorting parameter (sortOrder). The default order for timeCreationStarted is descending. The default order for displayName is ascending. (default to timeCreationStarted) Allowed values are: timeCreationStarted, displayName

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :limit (Integer) —

    For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

  • :page (String) —

    For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

Returns:



18738
18739
18740
18741
18742
18743
18744
18745
18746
18747
18748
18749
18750
18751
18752
18753
18754
18755
18756
18757
18758
18759
18760
18761
18762
18763
18764
18765
18766
18767
18768
18769
18770
18771
18772
18773
18774
18775
18776
18777
18778
18779
18780
18781
18782
18783
18784
18785
18786
18787
18788
18789
18790
18791
18792
18793
18794
18795
18796
18797
18798
18799
18800
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 18738

def list_sdm_masking_policy_differences(compartment_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#list_sdm_masking_policy_differences.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_sdm_masking_policy_differences." if compartment_id.nil?

  if opts[:difference_access_level] && !%w[ACCESSIBLE].include?(opts[:difference_access_level])
    raise 'Invalid value for "difference_access_level", must be one of ACCESSIBLE.'
  end

  if opts[:lifecycle_state] && !OCI::DataSafe::Models::SdmMaskingPolicyDifference::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::DataSafe::Models::SdmMaskingPolicyDifference::LIFECYCLE_STATE_ENUM.'
  end

  if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of ASC, DESC.'
  end

  if opts[:sort_by] && !%w[timeCreationStarted displayName].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of timeCreationStarted, displayName.'
  end

  path = '/sdmMaskingPolicyDifferences'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:compartmentIdInSubtree] = opts[:compartment_id_in_subtree] if !opts[:compartment_id_in_subtree].nil?
  query_params[:differenceAccessLevel] = opts[:difference_access_level] if opts[:difference_access_level]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:sensitiveDataModelId] = opts[:sensitive_data_model_id] if opts[:sensitive_data_model_id]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:maskingPolicyId] = opts[:masking_policy_id] if opts[:masking_policy_id]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#list_sdm_masking_policy_differences') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataSafe::Models::SdmMaskingPolicyDifferenceCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_security_assessments(compartment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_security_assessments API.

Gets a list of security assessments.

The ListSecurityAssessments operation returns only the assessments in the specified compartmentId. The list does not include any subcompartments of the compartmentId passed.

The parameter accessLevel specifies whether to return only those compartments for which the requestor has INSPECT permissions on at least one resource directly or indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if Principal doesn't have access to even one of the child compartments. This is valid only when compartmentIdInSubtree is set to true.

The parameter compartmentIdInSubtree applies when you perform ListSecurityAssessments on the compartmentId passed and when it is set to true, the entire hierarchy of compartments can be returned. To get a full list of all compartments and subcompartments in the tenancy (root compartment), set the parameter compartmentIdInSubtree to true and accessLevel to ACCESSIBLE.

Allowed values are: timeCreated, displayName, timeLastAssessed, timeUpdated

Parameters:

  • compartment_id (String) —

    A filter to return only resources that match the specified compartment OCID.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :compartment_id_in_subtree (BOOLEAN) —

    Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting. (default to false)

  • :access_level (String) —

    Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed. (default to RESTRICTED) Allowed values are: RESTRICTED, ACCESSIBLE

  • :display_name (String) —

    A filter to return only resources that match the specified display name.

  • :type (String) —

    A filter to return only items that match the specified security assessment type. Allowed values are: LATEST, SAVED, SAVE_SCHEDULE, COMPARTMENT, TEMPLATE, TEMPLATE_BASELINE

  • :schedule_assessment_id (String) —

    The OCID of the security assessment of type SAVE_SCHEDULE.

  • :is_schedule_assessment (BOOLEAN) —

    A filter to return only security assessments of type save schedule. (default to false)

  • :triggered_by (String) —

    A filter to return only security assessments that were created by either user or system. Allowed values are: USER, SYSTEM

  • :target_id (String) —

    A filter to return only items related to a specific target OCID.

  • :sort_order (String) —

    The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

  • :is_baseline (BOOLEAN) —

    A filter to return only the security assessments that are set as a baseline. (default to false)

  • :sort_by (String) —

    The field to sort by. You can specify only one sort order(sortOrder). The default order for timeCreated is descending. (default to timeCreated)

  • :time_created_greater_than_or_equal_to (DateTime) —

    A filter to return only the resources that were created after the specified date and time, as defined by RFC3339. Using TimeCreatedGreaterThanOrEqualToQueryParam parameter retrieves all resources created after that date.

    Example: 2016-12-19T16:39:57.600Z

  • :time_created_less_than (DateTime) —

    Search for resources that were created before a specific date. Specifying this parameter corresponding timeCreatedLessThan parameter will retrieve all resources created before the specified created date, in "YYYY-MM-ddThh:mmZ" format with a Z offset, as defined by RFC 3339.

    Example: 2016-12-19T16:39:57.600Z

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :limit (Integer) —

    For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

  • :page (String) —

    For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

  • :lifecycle_state (String) —

    A filter to return only resources that match the specified lifecycle state.

  • :target_type (String) —

    A filter to return only only target database resources or target database group resources.

  • :target_database_group_id (String) —

    A filter to return the target database group that matches the specified OCID.

  • :template_assessment_id (String) —

    The OCID of the security assessment of type TEMPLATE.

Returns:



18877
18878
18879
18880
18881
18882
18883
18884
18885
18886
18887
18888
18889
18890
18891
18892
18893
18894
18895
18896
18897
18898
18899
18900
18901
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
18940
18941
18942
18943
18944
18945
18946
18947
18948
18949
18950
18951
18952
18953
18954
18955
18956
18957
18958
18959
18960
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 18877

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 TEMPLATE TEMPLATE_BASELINE].include?(opts[:type])
    raise 'Invalid value for "type", must be one of LATEST, SAVED, SAVE_SCHEDULE, COMPARTMENT, TEMPLATE, TEMPLATE_BASELINE.'
  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 timeLastAssessed timeUpdated].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of timeCreated, displayName, timeLastAssessed, timeUpdated.'
  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

  if opts[:target_type] && !OCI::DataSafe::Models::SECURITY_ASSESSMENT_TARGET_TYPE_ENUM.include?(opts[:target_type])
    raise 'Invalid value for "target_type", must be one of the values in OCI::DataSafe::Models::SECURITY_ASSESSMENT_TARGET_TYPE_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]
  query_params[:targetType] = opts[:target_type] if opts[:target_type]
  query_params[:targetDatabaseGroupId] = opts[:target_database_group_id] if opts[:target_database_group_id]
  query_params[:templateAssessmentId] = opts[:template_assessment_id] if opts[:template_assessment_id]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#list_security_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_feature_analytics(compartment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_security_feature_analytics API.

Gets a list of Database security feature usage aggregated details in the specified compartment. This provides information about the overall security controls, by returning the counting number of the target databases using the security features.

When you perform the ListSecurityFeatureAnalytics operation, if the parameter compartmentIdInSubtree is set to "true," and if the parameter accessLevel is set to ACCESSIBLE, then the operation returns statistics from the compartments in which the requestor has INSPECT permissions on at least one resource, directly or indirectly (in subcompartments). If the operation is performed at the root compartment and the requestor does not have access to at least one subcompartment of the compartment specified by compartmentId, then "Not Authorized" is returned.

Parameters:

  • compartment_id (String) —

    A filter to return only resources that match the specified compartment OCID.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :compartment_id_in_subtree (BOOLEAN) —

    Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting. (default to false)

  • :access_level (String) —

    Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed. (default to RESTRICTED) Allowed values are: RESTRICTED, ACCESSIBLE

  • :target_id (String) —

    A filter to return only items related to a specific target OCID.

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :target_database_group_id (String) —

    A filter to return the target database group that matches the specified OCID.

Returns:



18997
18998
18999
19000
19001
19002
19003
19004
19005
19006
19007
19008
19009
19010
19011
19012
19013
19014
19015
19016
19017
19018
19019
19020
19021
19022
19023
19024
19025
19026
19027
19028
19029
19030
19031
19032
19033
19034
19035
19036
19037
19038
19039
19040
19041
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 18997

def list_security_feature_analytics(compartment_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#list_security_feature_analytics.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_security_feature_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

  path = '/securityAssessments/securityFeatureAnalytics'
  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[:targetDatabaseGroupId] = opts[:target_database_group_id] if opts[:target_database_group_id]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#list_security_feature_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::SecurityFeatureAnalyticsCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_security_features(compartment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_security_features API.

Lists the usage of Database security features for a given compartment or a target level, based on the filters provided.

Parameters:

  • compartment_id (String) —

    A filter to return only resources that match the specified compartment OCID.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :compartment_id_in_subtree (BOOLEAN) —

    Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting. (default to false)

  • :access_level (String) —

    Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed. (default to RESTRICTED) Allowed values are: RESTRICTED, ACCESSIBLE

  • :target_id (String) —

    A filter to return only items related to a specific target OCID.

  • :targets_with_unified_audit (String) —

    A filter to return only the targets with the DB security feature - Unified Audit enabled/disabled. Allowed values are: ENABLED, DISABLED, NONE

  • :targets_with_fine_grained_audit (String) —

    A filter to return only the targets with the DB security feature - Fine Grained Audit enabled/disabled. Allowed values are: ENABLED, DISABLED, NONE

  • :targets_with_traditional_audit (String) —

    A filter to return only the targets with the DB security feature - Traditional Audit enabled/disabled. Allowed values are: ENABLED, DISABLED, NONE

  • :targets_with_database_vault (String) —

    A filter to return only the targets with the DB security feature - Database Vault enabled/disabled. Allowed values are: ENABLED, DISABLED, NONE

  • :targets_with_privilege_analysis (String) —

    A filter to return only the targets with the DB security feature - Privilege Analysis enabled/disabled. Allowed values are: ENABLED, DISABLED, NONE

  • :targets_with_tablespace_encryption (String) —

    A filter to return only the targets with the DB security feature - Tablespace Encryption enabled/disabled. Allowed values are: ENABLED, DISABLED, NONE

  • :targets_with_column_encryption (String) —

    A filter to return only the targets that enable the DB security feature - Column Encryption enabled/disabled. Allowed values are: ENABLED, DISABLED, NONE

  • :targets_with_network_encryption (String) —

    A filter to return only the targets with the DB security feature - Network Encryption enabled/disabled. Allowed values are: ENABLED, DISABLED, NONE

  • :targets_with_password_authentication (String) —

    A filter to return only the targets with the DB security feature - Password Authentication enabled/disabled. Allowed values are: ENABLED, DISABLED, NONE

  • :targets_with_global_authentication (String) —

    A filter to return only the targets with the DB security feature - Global Authentication enabled/disabled. Allowed values are: ENABLED, DISABLED, NONE

  • :targets_with_external_authentication (String) —

    A filter to return only the targets with the DB security feature - External Authentication enabled/disabled. Allowed values are: ENABLED, DISABLED, NONE

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :limit (Integer) —

    For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

  • :page (String) —

    For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

  • :target_database_group_id (String) —

    A filter to return the target database group that matches the specified OCID.

Returns:



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
19131
19132
19133
19134
19135
19136
19137
19138
19139
19140
19141
19142
19143
19144
19145
19146
19147
19148
19149
19150
19151
19152
19153
19154
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
19193
19194
19195
19196
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 19095

def list_security_features(compartment_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#list_security_features.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_security_features." 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[:targets_with_unified_audit] && !%w[ENABLED DISABLED NONE].include?(opts[:targets_with_unified_audit])
    raise 'Invalid value for "targets_with_unified_audit", must be one of ENABLED, DISABLED, NONE.'
  end

  if opts[:targets_with_fine_grained_audit] && !%w[ENABLED DISABLED NONE].include?(opts[:targets_with_fine_grained_audit])
    raise 'Invalid value for "targets_with_fine_grained_audit", must be one of ENABLED, DISABLED, NONE.'
  end

  if opts[:targets_with_traditional_audit] && !%w[ENABLED DISABLED NONE].include?(opts[:targets_with_traditional_audit])
    raise 'Invalid value for "targets_with_traditional_audit", must be one of ENABLED, DISABLED, NONE.'
  end

  if opts[:targets_with_database_vault] && !%w[ENABLED DISABLED NONE].include?(opts[:targets_with_database_vault])
    raise 'Invalid value for "targets_with_database_vault", must be one of ENABLED, DISABLED, NONE.'
  end

  if opts[:targets_with_privilege_analysis] && !%w[ENABLED DISABLED NONE].include?(opts[:targets_with_privilege_analysis])
    raise 'Invalid value for "targets_with_privilege_analysis", must be one of ENABLED, DISABLED, NONE.'
  end

  if opts[:targets_with_tablespace_encryption] && !%w[ENABLED DISABLED NONE].include?(opts[:targets_with_tablespace_encryption])
    raise 'Invalid value for "targets_with_tablespace_encryption", must be one of ENABLED, DISABLED, NONE.'
  end

  if opts[:targets_with_column_encryption] && !%w[ENABLED DISABLED NONE].include?(opts[:targets_with_column_encryption])
    raise 'Invalid value for "targets_with_column_encryption", must be one of ENABLED, DISABLED, NONE.'
  end

  if opts[:targets_with_network_encryption] && !%w[ENABLED DISABLED NONE].include?(opts[:targets_with_network_encryption])
    raise 'Invalid value for "targets_with_network_encryption", must be one of ENABLED, DISABLED, NONE.'
  end

  if opts[:targets_with_password_authentication] && !%w[ENABLED DISABLED NONE].include?(opts[:targets_with_password_authentication])
    raise 'Invalid value for "targets_with_password_authentication", must be one of ENABLED, DISABLED, NONE.'
  end

  if opts[:targets_with_global_authentication] && !%w[ENABLED DISABLED NONE].include?(opts[:targets_with_global_authentication])
    raise 'Invalid value for "targets_with_global_authentication", must be one of ENABLED, DISABLED, NONE.'
  end

  if opts[:targets_with_external_authentication] && !%w[ENABLED DISABLED NONE].include?(opts[:targets_with_external_authentication])
    raise 'Invalid value for "targets_with_external_authentication", must be one of ENABLED, DISABLED, NONE.'
  end

  path = '/securityAssessments/securityFeatures'
  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[:targetsWithUnifiedAudit] = opts[:targets_with_unified_audit] if opts[:targets_with_unified_audit]
  query_params[:targetsWithFineGrainedAudit] = opts[:targets_with_fine_grained_audit] if opts[:targets_with_fine_grained_audit]
  query_params[:targetsWithTraditionalAudit] = opts[:targets_with_traditional_audit] if opts[:targets_with_traditional_audit]
  query_params[:targetsWithDatabaseVault] = opts[:targets_with_database_vault] if opts[:targets_with_database_vault]
  query_params[:targetsWithPrivilegeAnalysis] = opts[:targets_with_privilege_analysis] if opts[:targets_with_privilege_analysis]
  query_params[:targetsWithTablespaceEncryption] = opts[:targets_with_tablespace_encryption] if opts[:targets_with_tablespace_encryption]
  query_params[:targetsWithColumnEncryption] = opts[:targets_with_column_encryption] if opts[:targets_with_column_encryption]
  query_params[:targetsWithNetworkEncryption] = opts[:targets_with_network_encryption] if opts[:targets_with_network_encryption]
  query_params[:targetsWithPasswordAuthentication] = opts[:targets_with_password_authentication] if opts[:targets_with_password_authentication]
  query_params[:targetsWithGlobalAuthentication] = opts[:targets_with_global_authentication] if opts[:targets_with_global_authentication]
  query_params[:targetsWithExternalAuthentication] = opts[:targets_with_external_authentication] if opts[:targets_with_external_authentication]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:targetDatabaseGroupId] = opts[:target_database_group_id] if opts[:target_database_group_id]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#list_security_features') 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::SecurityFeatureCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_security_policies(compartment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_security_policies API.

Retrieves a list of all security policies in Data Safe.

The ListSecurityPolicies operation returns only the security policies in the specified compartmentId.

The parameter accessLevel specifies whether to return only those compartments for which the requestor has INSPECT permissions on at least one resource directly or indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if Principal doesn't have access to even one of the child compartments. This is valid only when compartmentIdInSubtree is set to true.

The parameter compartmentIdInSubtree applies when you perform ListSecurityPolicies on the compartmentId passed and when it is set to true, the entire hierarchy of compartments can be returned. To get a full list of all compartments and subcompartments in the tenancy (root compartment), set the parameter compartmentIdInSubtree to true and accessLevel to ACCESSIBLE.

Parameters:

  • compartment_id (String) —

    A filter to return only resources that match the specified compartment OCID.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :compartment_id_in_subtree (BOOLEAN) —

    Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting. (default to false)

  • :access_level (String) —

    Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed. (default to RESTRICTED) Allowed values are: RESTRICTED, ACCESSIBLE

  • :display_name (String) —

    A filter to return only resources that match the specified display name.

  • :limit (Integer) —

    For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

  • :page (String) —

    For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

  • :lifecycle_state (String) —

    The current state of the security policy.

  • :security_policy_type (String) —

    The type of the security policy. (default to DATASAFE_MANAGED)

  • :security_policy_id (String) —

    An optional filter to return only resources that match the specified OCID of the security policy resource.

  • :sort_order (String) —

    The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

  • :sort_by (String) —

    The field used for sorting. Only one sorting order (sortOrder) can be specified. The default order for TIMECREATED is descending. The default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. (default to TIMECREATED) Allowed values are: TIMECREATED, DISPLAYNAME

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:



19251
19252
19253
19254
19255
19256
19257
19258
19259
19260
19261
19262
19263
19264
19265
19266
19267
19268
19269
19270
19271
19272
19273
19274
19275
19276
19277
19278
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
19317
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 19251

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[:security_policy_type] && !OCI::DataSafe::Models::SecurityPolicy::SECURITY_POLICY_TYPE_ENUM.include?(opts[:security_policy_type])
    raise 'Invalid value for "security_policy_type", must be one of the values in OCI::DataSafe::Models::SecurityPolicy::SECURITY_POLICY_TYPE_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[:securityPolicyType] = opts[:security_policy_type] if opts[:security_policy_type]
  query_params[:securityPolicyId] = opts[:security_policy_id] if opts[:security_policy_id]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#list_security_policies') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataSafe::Models::SecurityPolicyCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_security_policy_configs(compartment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_security_policy_configs API.

Retrieves a list of all security policy configurations in Data Safe.

The ListSecurityPolicyConfigs operation returns only the security policy 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 ListSecurityPolicyConfigs on the compartmentId passed and when it is set to true, the entire hierarchy of compartments can be returned. To get a full list of all compartments and subcompartments in the tenancy (root compartment), set the parameter compartmentIdInSubtree to true and accessLevel to ACCESSIBLE.

Parameters:

  • compartment_id (String) —

    A filter to return only resources that match the specified compartment OCID.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :security_policy_config_id (String) —

    An optional filter to return only resources that match the specified OCID of the security policy configuration resource.

  • :security_policy_id (String) —

    An optional filter to return only resources that match the specified OCID of the security policy resource.

  • :compartment_id_in_subtree (BOOLEAN) —

    Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting. (default to false)

  • :access_level (String) —

    Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed. (default to RESTRICTED) Allowed values are: RESTRICTED, ACCESSIBLE

  • :display_name (String) —

    A filter to return only resources that match the specified display name.

  • :lifecycle_state (String) —

    The current state of the security policy configuration resource.

  • :time_created_greater_than_or_equal_to (DateTime) —

    A filter to return only the resources that were created after the specified date and time, as defined by RFC3339. Using TimeCreatedGreaterThanOrEqualToQueryParam parameter retrieves all resources created after that date.

    Example: 2016-12-19T16:39:57.600Z

  • :time_created_less_than (DateTime) —

    Search for resources that were created before a specific date. Specifying this parameter corresponding timeCreatedLessThan parameter will retrieve all resources created before the specified created date, in "YYYY-MM-ddThh:mmZ" format with a Z offset, as defined by RFC 3339.

    Example: 2016-12-19T16:39:57.600Z

  • :limit (Integer) —

    For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

  • :page (String) —

    For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

  • :sort_order (String) —

    The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

  • :sort_by (String) —

    The field used for sorting. Only one sorting order (sortOrder) can be specified. The default order for TIMECREATED is descending. The default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. (default to TIMECREATED) Allowed values are: TIMECREATED, DISPLAYNAME

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:



19385
19386
19387
19388
19389
19390
19391
19392
19393
19394
19395
19396
19397
19398
19399
19400
19401
19402
19403
19404
19405
19406
19407
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
19448
19449
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 19385

def list_security_policy_configs(compartment_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#list_security_policy_configs.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_security_policy_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::SECURITY_POLICY_CONFIG_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_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 = '/securityPolicyConfigs'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:securityPolicyConfigId] = opts[:security_policy_config_id] if opts[:security_policy_config_id]
  query_params[:securityPolicyId] = opts[:security_policy_id] if opts[:security_policy_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[: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[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#list_security_policy_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::SecurityPolicyConfigCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_security_policy_deployments(compartment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_security_policy_deployments API.

Retrieves a list of all security policy deployments in Data Safe.

The ListSecurityPolicyDeployments operation returns only the security policy deployments in the specified compartmentId.

The parameter accessLevel specifies whether to return only those compartments for which the requestor has INSPECT permissions on at least one resource directly or indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if Principal doesn't have access to even one of the child compartments. This is valid only when compartmentIdInSubtree is set to true.

The parameter compartmentIdInSubtree applies when you perform ListSecurityPolicyDeployments on the compartmentId passed and when it is set to true, the entire hierarchy of compartments can be returned. To get a full list of all compartments and subcompartments in the tenancy (root compartment), set the parameter compartmentIdInSubtree to true and accessLevel to ACCESSIBLE.

Parameters:

  • compartment_id (String) —

    A filter to return only resources that match the specified compartment OCID.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :compartment_id_in_subtree (BOOLEAN) —

    Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting. (default to false)

  • :access_level (String) —

    Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed. (default to RESTRICTED) Allowed values are: RESTRICTED, ACCESSIBLE

  • :display_name (String) —

    A filter to return only resources that match the specified display name.

  • :limit (Integer) —

    For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

  • :page (String) —

    For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

  • :lifecycle_state (String) —

    The current state of the security policy deployment.

  • :security_policy_deployment_id (String) —

    An optional filter to return only resources that match the specified OCID of the security policy deployment resource.

  • :target_id (String) —

    A filter to return only items related to a specific target OCID.

  • :target_type (String) —

    A optional filter to return only resources that belong to the specified target type.

  • :security_policy_id (String) —

    An optional filter to return only resources that match the specified OCID of the security policy resource.

  • :sort_order (String) —

    The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

  • :sort_by (String) —

    The field used for sorting. Only one sorting order (sortOrder) can be specified. The default order for TIMECREATED is descending. The default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. (default to TIMECREATED) Allowed values are: TIMECREATED, DISPLAYNAME

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:



19506
19507
19508
19509
19510
19511
19512
19513
19514
19515
19516
19517
19518
19519
19520
19521
19522
19523
19524
19525
19526
19527
19528
19529
19530
19531
19532
19533
19534
19535
19536
19537
19538
19539
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
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 19506

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[:target_type] && !OCI::DataSafe::Models::SecurityPolicyDeployment::TARGET_TYPE_ENUM.include?(opts[:target_type])
    raise 'Invalid value for "target_type", must be one of the values in OCI::DataSafe::Models::SecurityPolicyDeployment::TARGET_TYPE_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[:targetType] = opts[:target_type] if opts[:target_type]
  query_params[:securityPolicyId] = opts[:security_policy_id] if opts[:security_policy_id]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#list_security_policy_deployments') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataSafe::Models::SecurityPolicyDeploymentCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_security_policy_entry_states(security_policy_deployment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_security_policy_entry_states API.

Retrieves a list of all security policy entry states in Data Safe.

The ListSecurityPolicyEntryStates operation returns only the security policy entry states for the specified security policy entry.

Parameters:

  • security_policy_deployment_id (String) —

    The OCID of the security policy deployment resource.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :limit (Integer) —

    For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

  • :page (String) —

    For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

  • :deployment_status (String) —

    The current state of the security policy deployment.

  • :security_policy_entry_id (String) —

    An optional filter to return only resources that match the specified security policy entry OCID.

  • :security_policy_entry_type (String) —

    The type of the security policy deployment.

  • :target_id (String) —

    An optional filter to return only resources that match the specified target id.

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:



19601
19602
19603
19604
19605
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
19644
19645
19646
19647
19648
19649
19650
19651
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 19601

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

  if opts[:security_policy_entry_type] && !OCI::DataSafe::Models::SecurityPolicyEntryStateSummary::ENTRY_TYPE_ENUM.include?(opts[:security_policy_entry_type])
    raise 'Invalid value for "security_policy_entry_type", must be one of the values in OCI::DataSafe::Models::SecurityPolicyEntryStateSummary::ENTRY_TYPE_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]
  query_params[:securityPolicyEntryType] = opts[:security_policy_entry_type] if opts[:security_policy_entry_type]
  query_params[:targetId] = opts[:target_id] if opts[:target_id]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#list_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_security_policy_reports(compartment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_security_policy_reports API.

Retrieves a list of all security policy reports in Data Safe.

The ListSecurityPolicyReports operation returns only the security policy reports in the specified compartmentId.

The parameter accessLevel specifies whether to return only those compartments for which the requestor has INSPECT permissions on at least one resource directly or indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if Principal doesn't have access to even one of the child compartments. This is valid only when compartmentIdInSubtree is set to true.

The parameter compartmentIdInSubtree applies when you perform ListSecurityPolicyReports on the compartmentId passed and when it is set to true, the entire hierarchy of compartments can be returned. To get a full list of all compartments and subcompartments in the tenancy (root compartment), set the parameter compartmentIdInSubtree to true and accessLevel to ACCESSIBLE.

Parameters:

  • compartment_id (String) —

    A filter to return only resources that match the specified compartment OCID.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :compartment_id_in_subtree (BOOLEAN) —

    Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting. (default to false)

  • :access_level (String) —

    Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed. (default to RESTRICTED) Allowed values are: RESTRICTED, ACCESSIBLE

  • :display_name (String) —

    A filter to return only resources that match the specified display name.

  • :limit (Integer) —

    For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

  • :page (String) —

    For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

  • :lifecycle_state (String) —

    The current state of the security policy report.

  • :security_policy_report_id (String) —

    An optional filter to return only resources that match the specified OCID of the security policy report resource.

  • :target_id (String) —

    A filter to return only items related to a specific target OCID.

  • :sort_order (String) —

    The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

  • :sort_by (String) —

    The field used for sorting. Only one sorting order (sortOrder) can be specified. The default order for TIMECREATED is descending. The default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. (default to TIMECREATED) Allowed values are: TIMECREATED, DISPLAYNAME

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:



19706
19707
19708
19709
19710
19711
19712
19713
19714
19715
19716
19717
19718
19719
19720
19721
19722
19723
19724
19725
19726
19727
19728
19729
19730
19731
19732
19733
19734
19735
19736
19737
19738
19739
19740
19741
19742
19743
19744
19745
19746
19747
19748
19749
19750
19751
19752
19753
19754
19755
19756
19757
19758
19759
19760
19761
19762
19763
19764
19765
19766
19767
19768
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 19706

def list_security_policy_reports(compartment_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#list_security_policy_reports.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_security_policy_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[:lifecycle_state] && !OCI::DataSafe::Models::SECURITY_POLICY_REPORT_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_REPORT_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 = '/securityPolicyReports'
  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[:securityPolicyReportId] = opts[:security_policy_report_id] if opts[:security_policy_report_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]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#list_security_policy_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::SecurityPolicyReportCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_sensitive_column_analytics(compartment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_sensitive_column_analytics API.

Gets consolidated sensitive columns analytics data based on the specified query parameters.

When you perform the ListSensitiveColumnAnalytics operation, if the parameter compartmentIdInSubtree is set to "true," and if the parameter accessLevel is set to ACCESSIBLE, then the operation returns compartments in which the requestor has INSPECT permissions on at least one resource, directly or indirectly (in subcompartments). If the operation is performed at the root compartment and the requestor does not have access to at least one subcompartment of the compartment specified by compartmentId, then "Not Authorized" is returned.

To use ListSensitiveColumnAnalytics to get a full list of all compartments and subcompartments in the tenancy from the root compartment, set the parameter compartmentIdInSubtree to true and accessLevel to ACCESSIBLE.

Parameters:

  • compartment_id (String) —

    A filter to return only resources that match the specified compartment OCID.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :compartment_id_in_subtree (BOOLEAN) —

    Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting. (default to false)

  • :access_level (String) —

    Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed. (default to RESTRICTED) Allowed values are: RESTRICTED, ACCESSIBLE

  • :target_id (String) —

    A filter to return only items related to a specific target OCID.

  • :target_database_group_id (String) —

    A filter to return the target database group that matches the specified OCID.

  • :sensitive_type_id (Array<String>) —

    A filter to return only the sensitive columns that are associated with one of the sensitive types identified by the specified OCIDs.

  • :sensitive_type_group_id (String) —

    An optional filter to return only resources that match the specified OCID of the sensitive type group resource.

  • :sensitive_data_model_id (String) —

    A filter to return only the resources that match the specified sensitive data model OCID.

  • :group_by (Array<String>) —

    The group by parameter to summarize the sensitive columns. Allowed values are: targetId, sensitiveTypeId, sensitiveDataModelId

  • :schema_name (Array<String>) —

    A filter to return only items related to specific schema name.

  • :object_name (Array<String>) —

    A filter to return only items related to a specific object name.

  • :column_name (Array<String>) —

    A filter to return only a specific column based on column name.

  • :limit (Integer) —

    For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

  • :page (String) —

    For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:



19817
19818
19819
19820
19821
19822
19823
19824
19825
19826
19827
19828
19829
19830
19831
19832
19833
19834
19835
19836
19837
19838
19839
19840
19841
19842
19843
19844
19845
19846
19847
19848
19849
19850
19851
19852
19853
19854
19855
19856
19857
19858
19859
19860
19861
19862
19863
19864
19865
19866
19867
19868
19869
19870
19871
19872
19873
19874
19875
19876
19877
19878
19879
19880
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 19817

def list_sensitive_column_analytics(compartment_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#list_sensitive_column_analytics.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_sensitive_column_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[targetId sensitiveTypeId sensitiveDataModelId]
  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, sensitiveTypeId, sensitiveDataModelId.'
      end
    end
  end

  path = '/sensitiveColumnAnalytics'
  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[:targetDatabaseGroupId] = opts[:target_database_group_id] if opts[:target_database_group_id]
  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[:sensitiveTypeGroupId] = opts[:sensitive_type_group_id] if opts[:sensitive_type_group_id]
  query_params[:sensitiveDataModelId] = opts[:sensitive_data_model_id] if opts[:sensitive_data_model_id]
  query_params[:groupBy] = OCI::ApiClient.build_collection_params(opts[:group_by], :multi) if opts[:group_by] && !opts[:group_by].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[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#list_sensitive_column_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::SensitiveColumnAnalyticsCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_sensitive_columns(sensitive_data_model_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_sensitive_columns API.

Gets a list of sensitive columns present in the specified sensitive data model based on the specified query parameters.

Allowed values are: SHOW_ALL_COLUMNS, SHOW_COLUMNS_WITH_DATA, SHOW_COLUMNS_WITHOUT_DATA

Parameters:

  • sensitive_data_model_id (String) —

    The OCID of the sensitive data model.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :time_created_greater_than_or_equal_to (DateTime) —

    A filter to return only the resources that were created after the specified date and time, as defined by RFC3339. Using TimeCreatedGreaterThanOrEqualToQueryParam parameter retrieves all resources created after that date.

    Example: 2016-12-19T16:39:57.600Z

  • :time_created_less_than (DateTime) —

    Search for resources that were created before a specific date. Specifying this parameter corresponding timeCreatedLessThan parameter will retrieve all resources created before the specified created date, in "YYYY-MM-ddThh:mmZ" format with a Z offset, as defined by RFC 3339.

    Example: 2016-12-19T16:39:57.600Z

  • :time_updated_greater_than_or_equal_to (DateTime) —

    Search for resources that were updated after a specific date. Specifying this parameter corresponding timeUpdatedGreaterThanOrEqualTo parameter will retrieve all resources updated after the specified created date, in "YYYY-MM-ddThh:mmZ" format with a Z offset, as defined by RFC 3339.

  • :time_updated_less_than (DateTime) —

    Search for resources that were updated before a specific date. Specifying this parameter corresponding timeUpdatedLessThan parameter will retrieve all resources updated before the specified created date, in "YYYY-MM-ddThh:mmZ" format with a Z offset, as defined by RFC 3339.

  • :sensitive_column_lifecycle_state (String) —

    Filters the sensitive column resources with the given lifecycle state values.

  • :column_data_count_filter (String) —

    Filters the sensitive columns with respect to the estimated row count. (default to SHOW_ALL_COLUMNS)

  • :confidence_level (Array<String>) —

    A filter to return the sensitive columns with the specified confidence level. Confidence level of sensitive column associated with a seeded sensitive type can either be HIGH or LOW. While the confidence level of sensitive column associated with a user defined sensitive will be NONE. For sensitive columns added manually the confidence level will also be NONE.

    Allowed values are: NONE, HIGH, MEDIUM, LOW

  • :schema_name (Array<String>) —

    A filter to return only items related to specific schema name.

  • :object_name (Array<String>) —

    A filter to return only items related to a specific object name.

  • :column_name (Array<String>) —

    A filter to return only a specific column based on column name.

  • :object_type (Array<String>) —

    A filter to return only items related to a specific object type. (default to [ALL]) Allowed values are: ALL, TABLE, EDITIONING_VIEW

  • :data_type (Array<String>) —

    A filter to return only the resources that match the specified data types.

  • :status (Array<String>) —

    A filter to return only the sensitive columns that match the specified status. Allowed values are: VALID, INVALID

  • :sensitive_type_id (Array<String>) —

    A filter to return only the sensitive columns that are associated with one of the sensitive types identified by the specified OCIDs.

  • :parent_column_key (Array<String>) —

    A filter to return only the sensitive columns that are children of one of the columns identified by the specified keys.

  • :relation_type (Array<String>) —

    A filter to return sensitive columns based on their relationship with their parent columns. If set to NONE, it returns the sensitive columns that do not have any parent. The response includes the parent columns as well as the independent columns that are not in any relationship. If set to APP_DEFINED, it returns all the child columns that have application-level (non-dictionary) relationship with their parents. If set to DB_DEFINED, it returns all the child columns that have database-level (dictionary-defined) relationship with their parents.

    Allowed values are: NONE, APP_DEFINED, DB_DEFINED

  • :column_group (String) —

    A filter to return only the sensitive columns that belong to the specified column group.

  • :limit (Integer) —

    For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

  • :page (String) —

    For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

  • :sort_order (String) —

    The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

  • :sort_by (String) —

    The field to sort by. You can specify only one sorting parameter (sortOrder). The default order for timeCreated is descending. The default order for schemaName, objectName, and columnName is ascending. (default to timeCreated) Allowed values are: timeCreated, schemaName, objectName, columnName, dataType, confidenceLevel

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :is_case_in_sensitive (BOOLEAN) —

    A boolean flag indicating whether the search should be case-insensitive. The search is case-sensitive by default. Set this parameter to true to do case-insensitive search.

Returns:



19963
19964
19965
19966
19967
19968
19969
19970
19971
19972
19973
19974
19975
19976
19977
19978
19979
19980
19981
19982
19983
19984
19985
19986
19987
19988
19989
19990
19991
19992
19993
19994
19995
19996
19997
19998
19999
20000
20001
20002
20003
20004
20005
20006
20007
20008
20009
20010
20011
20012
20013
20014
20015
20016
20017
20018
20019
20020
20021
20022
20023
20024
20025
20026
20027
20028
20029
20030
20031
20032
20033
20034
20035
20036
20037
20038
20039
20040
20041
20042
20043
20044
20045
20046
20047
20048
20049
20050
20051
20052
20053
20054
20055
20056
20057
20058
20059
20060
20061
20062
20063
20064
20065
20066
20067
20068
20069
20070
20071
20072
20073
20074
20075
20076
20077
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 19963

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

  if opts[:column_data_count_filter] && !%w[SHOW_ALL_COLUMNS SHOW_COLUMNS_WITH_DATA SHOW_COLUMNS_WITHOUT_DATA].include?(opts[:column_data_count_filter])
    raise 'Invalid value for "column_data_count_filter", must be one of SHOW_ALL_COLUMNS, SHOW_COLUMNS_WITH_DATA, SHOW_COLUMNS_WITHOUT_DATA.'
  end


  confidence_level_allowable_values = %w[NONE HIGH MEDIUM LOW]
  if opts[:confidence_level] && !opts[:confidence_level].empty?
    opts[:confidence_level].each do |val_to_check|
      unless confidence_level_allowable_values.include?(val_to_check)
        raise 'Invalid value for "confidence_level", must be one of NONE, HIGH, MEDIUM, LOW.'
      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


  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 confidenceLevel].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of timeCreated, schemaName, objectName, columnName, dataType, confidenceLevel.'
  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[:columnDataCountFilter] = opts[:column_data_count_filter] if opts[:column_data_count_filter]
  query_params[:confidenceLevel] = OCI::ApiClient.build_collection_params(opts[:confidence_level], :multi) if opts[:confidence_level] && !opts[:confidence_level].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[:dataType] = OCI::ApiClient.build_collection_params(opts[:data_type], :multi) if opts[:data_type] && !opts[:data_type].empty?
  query_params[:status] = OCI::ApiClient.build_collection_params(opts[:status], :multi) if opts[:status] && !opts[:status].empty?
  query_params[:sensitiveTypeId] = OCI::ApiClient.build_collection_params(opts[:sensitive_type_id], :multi) if opts[:sensitive_type_id] && !opts[:sensitive_type_id].empty?
  query_params[:parentColumnKey] = OCI::ApiClient.build_collection_params(opts[:parent_column_key], :multi) if opts[:parent_column_key] && !opts[:parent_column_key].empty?
  query_params[:relationType] = OCI::ApiClient.build_collection_params(opts[:relation_type], :multi) if opts[:relation_type] && !opts[:relation_type].empty?
  query_params[:columnGroup] = opts[:column_group] if opts[:column_group]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:isCaseInSensitive] = opts[:is_case_in_sensitive] if !opts[:is_case_in_sensitive].nil?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#list_sensitive_columns') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataSafe::Models::SensitiveColumnCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_sensitive_data_model_sensitive_types(sensitive_data_model_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_sensitive_data_model_sensitive_types API.

Gets a list of sensitive type Ids present in the specified sensitive data model.

Parameters:

  • sensitive_data_model_id (String) —

    The OCID of the sensitive data model.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :sensitive_type_id (String) —

    A filter to return only items related to a specific sensitive type OCID.

  • :sort_by (String) —

    • The field to sort by. You can specify only one sorting parameter (sortorder). The default order is descending. (default to count) Allowed values are: count

  • :sort_order (String) —

    The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

  • :limit (Integer) —

    For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

  • :page (String) —

    For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:



20105
20106
20107
20108
20109
20110
20111
20112
20113
20114
20115
20116
20117
20118
20119
20120
20121
20122
20123
20124
20125
20126
20127
20128
20129
20130
20131
20132
20133
20134
20135
20136
20137
20138
20139
20140
20141
20142
20143
20144
20145
20146
20147
20148
20149
20150
20151
20152
20153
20154
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 20105

def list_sensitive_data_model_sensitive_types(sensitive_data_model_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#list_sensitive_data_model_sensitive_types.' if logger

  raise "Missing the required parameter 'sensitive_data_model_id' when calling list_sensitive_data_model_sensitive_types." if sensitive_data_model_id.nil?

  if opts[:sort_by] && !%w[count].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of count.'
  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 'sensitive_data_model_id' must not be blank" if OCI::Internal::Util.blank_string?(sensitive_data_model_id)

  path = '/sensitiveDataModels/{sensitiveDataModelId}/sensitiveTypes'.sub('{sensitiveDataModelId}', sensitive_data_model_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:sensitiveTypeId] = opts[:sensitive_type_id] if opts[:sensitive_type_id]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#list_sensitive_data_model_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::SensitiveDataModelSensitiveTypeCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_sensitive_data_models(compartment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_sensitive_data_models API.

Gets a list of sensitive data models based on the specified query parameters.

Parameters:

  • compartment_id (String) —

    A filter to return only resources that match the specified compartment OCID.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :compartment_id_in_subtree (BOOLEAN) —

    Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting. (default to false)

  • :access_level (String) —

    Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed. (default to RESTRICTED) Allowed values are: RESTRICTED, ACCESSIBLE

  • :display_name (String) —

    A filter to return only resources that match the specified display name.

  • :sensitive_data_model_id (String) —

    A filter to return only the resources that match the specified sensitive data model OCID.

  • :time_created_greater_than_or_equal_to (DateTime) —

    A filter to return only the resources that were created after the specified date and time, as defined by RFC3339. Using TimeCreatedGreaterThanOrEqualToQueryParam parameter retrieves all resources created after that date.

    Example: 2016-12-19T16:39:57.600Z

  • :time_created_less_than (DateTime) —

    Search for resources that were created before a specific date. Specifying this parameter corresponding timeCreatedLessThan parameter will retrieve all resources created before the specified created date, in "YYYY-MM-ddThh:mmZ" format with a Z offset, as defined by RFC 3339.

    Example: 2016-12-19T16:39:57.600Z

  • :target_id (String) —

    A filter to return only items related to a specific target OCID.

  • :sort_order (String) —

    The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

  • :sort_by (String) —

    The field to sort by. You can specify only one sorting parameter (sortOrder). The default order for timeCreated is descending. The default order for displayName is ascending. (default to timeCreated) Allowed values are: timeCreated, displayName

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :limit (Integer) —

    For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

  • :page (String) —

    For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

  • :lifecycle_state (String) —

    A filter to return only the resources that match the specified lifecycle state.

Returns:



20208
20209
20210
20211
20212
20213
20214
20215
20216
20217
20218
20219
20220
20221
20222
20223
20224
20225
20226
20227
20228
20229
20230
20231
20232
20233
20234
20235
20236
20237
20238
20239
20240
20241
20242
20243
20244
20245
20246
20247
20248
20249
20250
20251
20252
20253
20254
20255
20256
20257
20258
20259
20260
20261
20262
20263
20264
20265
20266
20267
20268
20269
20270
20271
20272
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 20208

def list_sensitive_data_models(compartment_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#list_sensitive_data_models.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_sensitive_data_models." if compartment_id.nil?

  if opts[:access_level] && !%w[RESTRICTED ACCESSIBLE].include?(opts[:access_level])
    raise 'Invalid value for "access_level", must be one of RESTRICTED, ACCESSIBLE.'
  end

  if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of ASC, DESC.'
  end

  if opts[:sort_by] && !%w[timeCreated displayName].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of timeCreated, displayName.'
  end

  if opts[:lifecycle_state] && !OCI::DataSafe::Models::DISCOVERY_LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::DataSafe::Models::DISCOVERY_LIFECYCLE_STATE_ENUM.'
  end

  path = '/sensitiveDataModels'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:compartmentIdInSubtree] = opts[:compartment_id_in_subtree] if !opts[:compartment_id_in_subtree].nil?
  query_params[:accessLevel] = opts[:access_level] if opts[:access_level]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:sensitiveDataModelId] = opts[:sensitive_data_model_id] if opts[:sensitive_data_model_id]
  query_params[:timeCreatedGreaterThanOrEqualTo] = opts[:time_created_greater_than_or_equal_to] if opts[:time_created_greater_than_or_equal_to]
  query_params[:timeCreatedLessThan] = opts[:time_created_less_than] if opts[:time_created_less_than]
  query_params[:targetId] = opts[:target_id] if opts[:target_id]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#list_sensitive_data_models') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataSafe::Models::SensitiveDataModelCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_sensitive_objects(sensitive_data_model_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_sensitive_objects API.

Gets a list of sensitive objects present in the specified sensitive data model based on the specified query parameters.

Parameters:

  • sensitive_data_model_id (String) —

    The OCID of the sensitive data model.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :schema_name (Array<String>) —

    A filter to return only items related to specific schema name.

  • :object_name (Array<String>) —

    A filter to return only items related to a specific object name.

  • :object_type (Array<String>) —

    A filter to return only items related to a specific object type. (default to [ALL]) Allowed values are: ALL, TABLE, EDITIONING_VIEW

  • :limit (Integer) —

    For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

  • :page (String) —

    For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

  • :sort_order (String) —

    The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

  • :sort_by (String) —

    The field to sort by. You can specify only one sorting parameter (sortOrder). The default order is ascending. (default to schemaName) Allowed values are: schemaName, objectName, objectType

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:



20303
20304
20305
20306
20307
20308
20309
20310
20311
20312
20313
20314
20315
20316
20317
20318
20319
20320
20321
20322
20323
20324
20325
20326
20327
20328
20329
20330
20331
20332
20333
20334
20335
20336
20337
20338
20339
20340
20341
20342
20343
20344
20345
20346
20347
20348
20349
20350
20351
20352
20353
20354
20355
20356
20357
20358
20359
20360
20361
20362
20363
20364
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 20303

def list_sensitive_objects(sensitive_data_model_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#list_sensitive_objects.' if logger

  raise "Missing the required parameter 'sensitive_data_model_id' when calling list_sensitive_objects." if sensitive_data_model_id.nil?


  object_type_allowable_values = %w[ALL TABLE EDITIONING_VIEW]
  if opts[:object_type] && !opts[:object_type].empty?
    opts[:object_type].each do |val_to_check|
      unless object_type_allowable_values.include?(val_to_check)
        raise 'Invalid value for "object_type", must be one of ALL, TABLE, EDITIONING_VIEW.'
      end
    end
  end

  if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of ASC, DESC.'
  end

  if opts[:sort_by] && !%w[schemaName objectName objectType].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of schemaName, objectName, objectType.'
  end
  raise "Parameter value for 'sensitive_data_model_id' must not be blank" if OCI::Internal::Util.blank_string?(sensitive_data_model_id)

  path = '/sensitiveDataModels/{sensitiveDataModelId}/sensitiveObjects'.sub('{sensitiveDataModelId}', sensitive_data_model_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:schemaName] = OCI::ApiClient.build_collection_params(opts[:schema_name], :multi) if opts[:schema_name] && !opts[:schema_name].empty?
  query_params[:objectName] = OCI::ApiClient.build_collection_params(opts[:object_name], :multi) if opts[:object_name] && !opts[:object_name].empty?
  query_params[:objectType] = OCI::ApiClient.build_collection_params(opts[:object_type], :multi) if opts[:object_type] && !opts[:object_type].empty?
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#list_sensitive_objects') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataSafe::Models::SensitiveObjectCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_sensitive_schemas(sensitive_data_model_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_sensitive_schemas API.

Gets a list of sensitive schemas present in the specified sensitive data model based on the specified query parameters.

Parameters:

  • sensitive_data_model_id (String) —

    The OCID of the sensitive data model.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :schema_name (Array<String>) —

    A filter to return only items related to specific schema name.

  • :limit (Integer) —

    For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

  • :page (String) —

    For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

  • :sort_order (String) —

    The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

  • :sort_by (String) —

    The field to sort by. You can specify only one sorting parameter (sortOrder). The default order is ascending. (default to schemaName) Allowed values are: schemaName

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:



20392
20393
20394
20395
20396
20397
20398
20399
20400
20401
20402
20403
20404
20405
20406
20407
20408
20409
20410
20411
20412
20413
20414
20415
20416
20417
20418
20419
20420
20421
20422
20423
20424
20425
20426
20427
20428
20429
20430
20431
20432
20433
20434
20435
20436
20437
20438
20439
20440
20441
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 20392

def list_sensitive_schemas(sensitive_data_model_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#list_sensitive_schemas.' if logger

  raise "Missing the required parameter 'sensitive_data_model_id' when calling list_sensitive_schemas." if sensitive_data_model_id.nil?

  if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of ASC, DESC.'
  end

  if opts[:sort_by] && !%w[schemaName].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of schemaName.'
  end
  raise "Parameter value for 'sensitive_data_model_id' must not be blank" if OCI::Internal::Util.blank_string?(sensitive_data_model_id)

  path = '/sensitiveDataModels/{sensitiveDataModelId}/sensitiveSchemas'.sub('{sensitiveDataModelId}', sensitive_data_model_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:schemaName] = OCI::ApiClient.build_collection_params(opts[:schema_name], :multi) if opts[:schema_name] && !opts[:schema_name].empty?
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#list_sensitive_schemas') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataSafe::Models::SensitiveSchemaCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_sensitive_type_groups(compartment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_sensitive_type_groups API.

Gets a list of sensitive type groups based on the specified query parameters.

Parameters:

  • compartment_id (String) —

    A filter to return only resources that match the specified compartment OCID.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :compartment_id_in_subtree (BOOLEAN) —

    Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting. (default to false)

  • :access_level (String) —

    Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed. (default to RESTRICTED) Allowed values are: RESTRICTED, ACCESSIBLE

  • :display_name (String) —

    A filter to return only resources that match the specified display name.

  • :limit (Integer) —

    For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

  • :page (String) —

    For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

  • :lifecycle_state (String) —

    A filter to return only the resources that match the specified lifecycle state.

  • :sensitive_type_group_id (String) —

    An optional filter to return only resources that match the specified OCID of the sensitive type group resource.

  • :time_created_greater_than_or_equal_to (DateTime) —

    A filter to return only the resources that were created after the specified date and time, as defined by RFC3339. Using TimeCreatedGreaterThanOrEqualToQueryParam parameter retrieves all resources created after that date.

    Example: 2016-12-19T16:39:57.600Z

  • :time_created_less_than (DateTime) —

    Search for resources that were created before a specific date. Specifying this parameter corresponding timeCreatedLessThan parameter will retrieve all resources created before the specified created date, in "YYYY-MM-ddThh:mmZ" format with a Z offset, as defined by RFC 3339.

    Example: 2016-12-19T16:39:57.600Z

  • :sort_order (String) —

    The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

  • :sort_by (String) —

    The field to sort by. You can specify only one sorting parameter (sortOrder). The default order for timeCreated is descending. The default order for displayName is ascending. (default to timeCreated) Allowed values are: timeCreated, displayName

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:



20494
20495
20496
20497
20498
20499
20500
20501
20502
20503
20504
20505
20506
20507
20508
20509
20510
20511
20512
20513
20514
20515
20516
20517
20518
20519
20520
20521
20522
20523
20524
20525
20526
20527
20528
20529
20530
20531
20532
20533
20534
20535
20536
20537
20538
20539
20540
20541
20542
20543
20544
20545
20546
20547
20548
20549
20550
20551
20552
20553
20554
20555
20556
20557
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 20494

def list_sensitive_type_groups(compartment_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#list_sensitive_type_groups.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_sensitive_type_groups." 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::SENSITIVE_TYPE_GROUP_LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::DataSafe::Models::SENSITIVE_TYPE_GROUP_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 = '/sensitiveTypeGroups'
  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[:sensitiveTypeGroupId] = opts[:sensitive_type_group_id] if opts[:sensitive_type_group_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]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#list_sensitive_type_groups') 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::SensitiveTypeGroupCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_sensitive_types(compartment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_sensitive_types API.

Gets a list of sensitive types based on the specified query parameters.

Parameters:

  • compartment_id (String) —

    A filter to return only resources that match the specified compartment OCID.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :compartment_id_in_subtree (BOOLEAN) —

    Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting. (default to false)

  • :access_level (String) —

    Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed. (default to RESTRICTED) Allowed values are: RESTRICTED, ACCESSIBLE

  • :display_name (String) —

    A filter to return only resources that match the specified display name.

  • :sensitive_type_id (String) —

    A filter to return only items related to a specific sensitive type OCID.

  • :sensitive_type_source (String) —

    A filter to return the sensitive type resources based on the value of their source attribute. (default to USER)

  • :entity_type (String) —

    A filter to return the sensitive type resources based on the value of their entityType attribute.

  • :parent_category_id (String) —

    A filter to return only the sensitive types that are children of the sensitive category identified by the specified OCID.

  • :default_masking_format_id (String) —

    A filter to return only the sensitive types that have the default masking format identified by the specified OCID.

  • :time_created_greater_than_or_equal_to (DateTime) —

    A filter to return only the resources that were created after the specified date and time, as defined by RFC3339. Using TimeCreatedGreaterThanOrEqualToQueryParam parameter retrieves all resources created after that date.

    Example: 2016-12-19T16:39:57.600Z

  • :time_created_less_than (DateTime) —

    Search for resources that were created before a specific date. Specifying this parameter corresponding timeCreatedLessThan parameter will retrieve all resources created before the specified created date, in "YYYY-MM-ddThh:mmZ" format with a Z offset, as defined by RFC 3339.

    Example: 2016-12-19T16:39:57.600Z

  • :sort_order (String) —

    The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

  • :sort_by (String) —

    The field to sort by. You can specify only one sorting parameter (sortOrder). The default order for timeCreated is descending. The default order for displayName is ascending. (default to timeCreated) Allowed values are: timeCreated, displayName

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :limit (Integer) —

    For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

  • :page (String) —

    For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

  • :lifecycle_state (String) —

    A filter to return only the resources that match the specified lifecycle state.

  • :is_common (BOOLEAN) —

    A filter to return only the common sensitive type resources. Common sensitive types belong to library sensitive types which are frequently used to perform sensitive data discovery.

Returns:



20617
20618
20619
20620
20621
20622
20623
20624
20625
20626
20627
20628
20629
20630
20631
20632
20633
20634
20635
20636
20637
20638
20639
20640
20641
20642
20643
20644
20645
20646
20647
20648
20649
20650
20651
20652
20653
20654
20655
20656
20657
20658
20659
20660
20661
20662
20663
20664
20665
20666
20667
20668
20669
20670
20671
20672
20673
20674
20675
20676
20677
20678
20679
20680
20681
20682
20683
20684
20685
20686
20687
20688
20689
20690
20691
20692
20693
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 20617

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]
  query_params[:isCommon] = opts[:is_common] if !opts[:is_common].nil?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#list_sensitive_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_sensitive_types_exports(compartment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_sensitive_types_exports API.

Retrieves a list of all sensitive types export in Data Safe based on the specified query parameters. The ListSensitiveTypesExports operation returns only the sensitive types export in the specified compartmentId.

Parameters:

  • compartment_id (String) —

    A filter to return only resources that match the specified compartment OCID.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :compartment_id_in_subtree (BOOLEAN) —

    Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting. (default to false)

  • :access_level (String) —

    Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed. (default to RESTRICTED) Allowed values are: RESTRICTED, ACCESSIBLE

  • :display_name (String) —

    A filter to return only resources that match the specified display name.

  • :limit (Integer) —

    For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

  • :page (String) —

    For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

  • :lifecycle_state (String) —

    A filter to return only the resources that match the specified lifecycle state.

  • :sensitive_types_export_id (String) —

    An optional filter to return only resources that match the specified OCID of the sensitive types export resource.

  • :time_created_greater_than_or_equal_to (DateTime) —

    A filter to return only the resources that were created after the specified date and time, as defined by RFC3339. Using TimeCreatedGreaterThanOrEqualToQueryParam parameter retrieves all resources created after that date.

    Example: 2016-12-19T16:39:57.600Z

  • :time_created_less_than (DateTime) —

    Search for resources that were created before a specific date. Specifying this parameter corresponding timeCreatedLessThan parameter will retrieve all resources created before the specified created date, in "YYYY-MM-ddThh:mmZ" format with a Z offset, as defined by RFC 3339.

    Example: 2016-12-19T16:39:57.600Z

  • :sort_order (String) —

    The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

  • :sort_by (String) —

    The field used for sorting. Only one sorting order (sortOrder) can be specified. The default order for TIMECREATED is descending. The default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. (default to TIMECREATED) Allowed values are: TIMECREATED, DISPLAYNAME

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:



20748
20749
20750
20751
20752
20753
20754
20755
20756
20757
20758
20759
20760
20761
20762
20763
20764
20765
20766
20767
20768
20769
20770
20771
20772
20773
20774
20775
20776
20777
20778
20779
20780
20781
20782
20783
20784
20785
20786
20787
20788
20789
20790
20791
20792
20793
20794
20795
20796
20797
20798
20799
20800
20801
20802
20803
20804
20805
20806
20807
20808
20809
20810
20811
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 20748

def list_sensitive_types_exports(compartment_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#list_sensitive_types_exports.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_sensitive_types_exports." 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::SENSITIVE_TYPES_EXPORT_LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::DataSafe::Models::SENSITIVE_TYPES_EXPORT_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 = '/sensitiveTypesExports'
  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[:sensitiveTypesExportId] = opts[:sensitive_types_export_id] if opts[:sensitive_types_export_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]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#list_sensitive_types_exports') 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::SensitiveTypesExportCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_sql_collection_analytics(compartment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_sql_collection_analytics API.

Retrieves a list of all SQL collection analytics in Data Safe.

The ListSqlCollectionAnalytics operation returns only the analytics for the SQL collections in the specified compartmentId.

The parameter accessLevel specifies whether to return only those compartments for which the requestor has INSPECT permissions on at least one resource directly or indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if Principal doesn't have access to even one of the child compartments. This is valid only when compartmentIdInSubtree is set to true.

The parameter compartmentIdInSubtree applies when you perform ListSqlCollections on the compartmentId passed and when it is set to true, the entire hierarchy of compartments can be returned. To get a full list of all compartments and subcompartments in the tenancy (root compartment), set the parameter compartmentIdInSubtree to true and accessLevel to ACCESSIBLE.

Parameters:

  • compartment_id (String) —

    A filter to return only resources that match the specified compartment OCID.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :compartment_id_in_subtree (BOOLEAN) —

    Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting. (default to false)

  • :access_level (String) —

    Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed. (default to RESTRICTED) Allowed values are: RESTRICTED, ACCESSIBLE

  • :limit (Integer) —

    For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

  • :page (String) —

    For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

  • :lifecycle_state (String) —

    The current state of the SQL collection.

  • :target_id (String) —

    A filter to return only items related to a specific target OCID.

  • :target_database_group_id (String) —

    A filter to return the target database group that matches the specified OCID.

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :group_by (Array<String>) —

    The group by parameter to summarize SQL collection aggregation. Allowed values are: targetId, lifecycleState

  • :time_started (DateTime) —

    An optional filter to return the stats of the SQL collection logs collected after the date-time specified, in the format defined by RFC3339.

  • :time_ended (DateTime) —

    An optional filter to return the stats of the SQL collection logs collected before the date-time specified, in the format defined by RFC3339.

Returns:



20865
20866
20867
20868
20869
20870
20871
20872
20873
20874
20875
20876
20877
20878
20879
20880
20881
20882
20883
20884
20885
20886
20887
20888
20889
20890
20891
20892
20893
20894
20895
20896
20897
20898
20899
20900
20901
20902
20903
20904
20905
20906
20907
20908
20909
20910
20911
20912
20913
20914
20915
20916
20917
20918
20919
20920
20921
20922
20923
20924
20925
20926
20927
20928
20929
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 20865

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[:targetDatabaseGroupId] = opts[:target_database_group_id] if opts[:target_database_group_id]
  query_params[:groupBy] = OCI::ApiClient.build_collection_params(opts[:group_by], :multi) if opts[:group_by] && !opts[:group_by].empty?
  query_params[:timeStarted] = opts[:time_started] if opts[:time_started]
  query_params[:timeEnded] = opts[:time_ended] if opts[:time_ended]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#list_sql_collection_analytics') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataSafe::Models::SqlCollectionAnalyticsCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_sql_collection_log_insights(time_started, time_ended, sql_collection_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_sql_collection_log_insights API.

Retrieves a list of the SQL collection log analytics.

Parameters:

  • time_started (DateTime) —

    An optional filter to return the stats of the SQL collection logs collected after the date-time specified, in the format defined by RFC3339.

  • time_ended (DateTime) —

    An optional filter to return the stats of the SQL collection logs collected before the date-time specified, in the format defined by RFC3339.

  • sql_collection_id (String) —

    The OCID of the SQL collection resource.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :limit (Integer) —

    For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

  • :page (String) —

    For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :group_by (String) —

    The group by parameter to summarize SQL collection log insights aggregation. Allowed values are: clientIp, clientProgram, clientOsUserName

Returns:



20958
20959
20960
20961
20962
20963
20964
20965
20966
20967
20968
20969
20970
20971
20972
20973
20974
20975
20976
20977
20978
20979
20980
20981
20982
20983
20984
20985
20986
20987
20988
20989
20990
20991
20992
20993
20994
20995
20996
20997
20998
20999
21000
21001
21002
21003
21004
21005
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 20958

def list_sql_collection_log_insights(time_started, time_ended, sql_collection_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#list_sql_collection_log_insights.' if logger

  raise "Missing the required parameter 'time_started' when calling list_sql_collection_log_insights." if time_started.nil?
  raise "Missing the required parameter 'time_ended' when calling list_sql_collection_log_insights." if time_ended.nil?
  raise "Missing the required parameter 'sql_collection_id' when calling list_sql_collection_log_insights." if sql_collection_id.nil?

  if opts[:group_by] && !%w[clientIp clientProgram clientOsUserName].include?(opts[:group_by])
    raise 'Invalid value for "group_by", must be one of clientIp, clientProgram, clientOsUserName.'
  end
  raise "Parameter value for 'sql_collection_id' must not be blank" if OCI::Internal::Util.blank_string?(sql_collection_id)

  path = '/sqlCollections/{sqlCollectionId}/logInsights'.sub('{sqlCollectionId}', sql_collection_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:timeStarted] = time_started
  query_params[:timeEnded] = time_ended
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:groupBy] = opts[:group_by] if opts[:group_by]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#list_sql_collection_log_insights') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataSafe::Models::SqlCollectionLogInsightsCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_sql_collections(compartment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_sql_collections API.

Retrieves a list of all SQL collections in Data Safe.

The ListSqlCollections operation returns only the SQL collections in the specified compartmentId.

The parameter accessLevel specifies whether to return only those compartments for which the requestor has INSPECT permissions on at least one resource directly or indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if Principal doesn't have access to even one of the child compartments. This is valid only when compartmentIdInSubtree is set to true.

The parameter compartmentIdInSubtree applies when you perform ListSqlCollections on the compartmentId passed and when it is set to true, the entire hierarchy of compartments can be returned. To get a full list of all compartments and subcompartments in the tenancy (root compartment), set the parameter compartmentIdInSubtree to true and accessLevel to ACCESSIBLE.

Parameters:

  • compartment_id (String) —

    A filter to return only resources that match the specified compartment OCID.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :compartment_id_in_subtree (BOOLEAN) —

    Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting. (default to false)

  • :access_level (String) —

    Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed. (default to RESTRICTED) Allowed values are: RESTRICTED, ACCESSIBLE

  • :display_name (String) —

    A filter to return only resources that match the specified display name.

  • :limit (Integer) —

    For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

  • :page (String) —

    For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

  • :lifecycle_state (String) —

    The current state of the SQL collection.

  • :sql_collection_id (String) —

    An optional filter to return only resources that match the specified OCID of the SQL collection resource.

  • :time_created_greater_than_or_equal_to (DateTime) —

    A filter to return only the resources that were created after the specified date and time, as defined by RFC3339. Using TimeCreatedGreaterThanOrEqualToQueryParam parameter retrieves all resources created after that date.

    Example: 2016-12-19T16:39:57.600Z

  • :time_created_less_than (DateTime) —

    Search for resources that were created before a specific date. Specifying this parameter corresponding timeCreatedLessThan parameter will retrieve all resources created before the specified created date, in "YYYY-MM-ddThh:mmZ" format with a Z offset, as defined by RFC 3339.

    Example: 2016-12-19T16:39:57.600Z

  • :target_id (String) —

    A filter to return only items related to a specific target OCID.

  • :target_database_group_id (String) —

    A filter to return the target database group that matches the specified OCID.

  • :db_user_name (String) —

    A filter to return only items that match the specified user name.

  • :sort_order (String) —

    The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

  • :sort_by (String) —

    The field used for sorting. Only one sorting parameter order (sortOrder) can be specified. The DISPLAYNAME sort order is case sensitive. (default to TIMECREATED) Allowed values are: TIMECREATED, DISPLAYNAME, TIMELASTSTARTED

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:



21074
21075
21076
21077
21078
21079
21080
21081
21082
21083
21084
21085
21086
21087
21088
21089
21090
21091
21092
21093
21094
21095
21096
21097
21098
21099
21100
21101
21102
21103
21104
21105
21106
21107
21108
21109
21110
21111
21112
21113
21114
21115
21116
21117
21118
21119
21120
21121
21122
21123
21124
21125
21126
21127
21128
21129
21130
21131
21132
21133
21134
21135
21136
21137
21138
21139
21140
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 21074

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[:targetDatabaseGroupId] = opts[:target_database_group_id] if opts[:target_database_group_id]
  query_params[:dbUserName] = opts[:db_user_name] if opts[:db_user_name]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#list_sql_collections') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataSafe::Models::SqlCollectionCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_sql_firewall_allowed_sql_analytics(compartment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_sql_firewall_allowed_sql_analytics API.

Returns the aggregation details of all SQL Firewall allowed SQL statements.

The ListSqlFirewallAllowedSqlAnalytics operation returns the aggregates of the SQL Firewall allowed SQL statements in the specified compartmentId.

The parameter accessLevel specifies whether to return only those compartments for which the requestor has INSPECT permissions on at least one resource directly or indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if Principal doesn't have access to even one of the child compartments. This is valid only when compartmentIdInSubtree is set to true.

The parameter compartmentIdInSubtree applies when you perform ListSqlFirewallAllowedSqlAnalytics on the compartmentId passed and when it is set to true, the entire hierarchy of compartments can be returned. To get a full list of all compartments and subcompartments in the tenancy (root compartment), set the parameter compartmentIdInSubtree to true and accessLevel to ACCESSIBLE.

Parameters:

  • compartment_id (String) —

    A filter to return only resources that match the specified compartment OCID.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :compartment_id_in_subtree (BOOLEAN) —

    Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting. (default to false)

  • :access_level (String) —

    Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed. (default to RESTRICTED) Allowed values are: RESTRICTED, ACCESSIBLE

  • :limit (Integer) —

    For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

  • :page (String) —

    For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

  • :scim_query (String) —

    The scimQuery query parameter accepts filter expressions that use the syntax described in Section 3.2.2.2 of the System for Cross-Domain Identity Management (SCIM) specification, which is available at RFC3339. In SCIM filtering expressions, text, date, and time values must be enclosed in quotation marks, with date and time values using ISO-8601 format. (Numeric and boolean values should not be quoted.)

    Example: query=(currentUser eq "SCOTT") and (topLevel eq "YES")

  • :group_by (Array<String>) —

    The group by parameter to summarize the allowed SQL aggregation. Allowed values are: dbUserName, sqlLevel, sqlFirewallPolicyId, lifecycleState

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:



21193
21194
21195
21196
21197
21198
21199
21200
21201
21202
21203
21204
21205
21206
21207
21208
21209
21210
21211
21212
21213
21214
21215
21216
21217
21218
21219
21220
21221
21222
21223
21224
21225
21226
21227
21228
21229
21230
21231
21232
21233
21234
21235
21236
21237
21238
21239
21240
21241
21242
21243
21244
21245
21246
21247
21248
21249
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 21193

def list_sql_firewall_allowed_sql_analytics(compartment_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#list_sql_firewall_allowed_sql_analytics.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_sql_firewall_allowed_sql_analytics." if compartment_id.nil?

  if opts[:access_level] && !%w[RESTRICTED ACCESSIBLE].include?(opts[:access_level])
    raise 'Invalid value for "access_level", must be one of RESTRICTED, ACCESSIBLE.'
  end


  group_by_allowable_values = %w[dbUserName sqlLevel sqlFirewallPolicyId lifecycleState]
  if opts[:group_by] && !opts[:group_by].empty?
    opts[:group_by].each do |val_to_check|
      unless group_by_allowable_values.include?(val_to_check)
        raise 'Invalid value for "group_by", must be one of dbUserName, sqlLevel, sqlFirewallPolicyId, lifecycleState.'
      end
    end
  end

  path = '/sqlFirewallAllowedSqlAnalytics'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:compartmentIdInSubtree] = opts[:compartment_id_in_subtree] if !opts[:compartment_id_in_subtree].nil?
  query_params[:accessLevel] = opts[:access_level] if opts[:access_level]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:scimQuery] = opts[:scim_query] if opts[:scim_query]
  query_params[:groupBy] = OCI::ApiClient.build_collection_params(opts[:group_by], :multi) if opts[:group_by] && !opts[:group_by].empty?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#list_sql_firewall_allowed_sql_analytics') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataSafe::Models::SqlFirewallAllowedSqlAnalyticsCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_sql_firewall_allowed_sqls(compartment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_sql_firewall_allowed_sqls API.

Retrieves a list of all SQL Firewall allowed SQL statements.

The ListSqlFirewallAllowedSqls operation returns only the SQL Firewall allowed SQL statements in the specified compartmentId.

The parameter accessLevel specifies whether to return only those compartments for which the requestor has INSPECT permissions on at least one resource directly or indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if Principal doesn't have access to even one of the child compartments. This is valid only when compartmentIdInSubtree is set to true.

The parameter compartmentIdInSubtree applies when you perform ListSqlFirewallPolicies on the compartmentId passed and when it is set to true, the entire hierarchy of compartments can be returned. To get a full list of all compartments and subcompartments in the tenancy (root compartment), set the parameter compartmentIdInSubtree to true and accessLevel to ACCESSIBLE.

Allowed values are: displayName, timeCollected

Parameters:

  • compartment_id (String) —

    A filter to return only resources that match the specified compartment OCID.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :compartment_id_in_subtree (BOOLEAN) —

    Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting. (default to false)

  • :access_level (String) —

    Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed. (default to RESTRICTED) Allowed values are: RESTRICTED, ACCESSIBLE

  • :limit (Integer) —

    For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

  • :page (String) —

    For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

  • :scim_query (String) —

    The scimQuery query parameter accepts filter expressions that use the syntax described in Section 3.2.2.2 of the System for Cross-Domain Identity Management (SCIM) specification, which is available at RFC3339. In SCIM filtering expressions, text, date, and time values must be enclosed in quotation marks, with date and time values using ISO-8601 format. (Numeric and boolean values should not be quoted.)

    Example: query=(currentUser eq "SCOTT") and (topLevel eq "YES")

  • :sort_order (String) —

    The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

  • :sort_by (String) —

    The field to sort by. Only one sort parameter should be provided. (default to timeCollected)

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:



21305
21306
21307
21308
21309
21310
21311
21312
21313
21314
21315
21316
21317
21318
21319
21320
21321
21322
21323
21324
21325
21326
21327
21328
21329
21330
21331
21332
21333
21334
21335
21336
21337
21338
21339
21340
21341
21342
21343
21344
21345
21346
21347
21348
21349
21350
21351
21352
21353
21354
21355
21356
21357
21358
21359
21360
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 21305

def list_sql_firewall_allowed_sqls(compartment_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#list_sql_firewall_allowed_sqls.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_sql_firewall_allowed_sqls." if compartment_id.nil?

  if opts[:access_level] && !%w[RESTRICTED ACCESSIBLE].include?(opts[:access_level])
    raise 'Invalid value for "access_level", must be one of RESTRICTED, ACCESSIBLE.'
  end

  if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of ASC, DESC.'
  end

  if opts[:sort_by] && !%w[displayName timeCollected].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of displayName, timeCollected.'
  end

  path = '/sqlFirewallAllowedSqls'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:compartmentIdInSubtree] = opts[:compartment_id_in_subtree] if !opts[:compartment_id_in_subtree].nil?
  query_params[:accessLevel] = opts[:access_level] if opts[:access_level]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:scimQuery] = opts[:scim_query] if opts[:scim_query]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#list_sql_firewall_allowed_sqls') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataSafe::Models::SqlFirewallAllowedSqlCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_sql_firewall_policies(compartment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_sql_firewall_policies API.

Retrieves a list of all SQL Firewall policies.

The ListSqlFirewallPolicies operation returns only the SQL Firewall policies in the specified compartmentId.

The parameter accessLevel specifies whether to return only those compartments for which the requestor has INSPECT permissions on at least one resource directly or indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if Principal doesn't have access to even one of the child compartments. This is valid only when compartmentIdInSubtree is set to true.

The parameter compartmentIdInSubtree applies when you perform ListSqlFirewallPolicies on the compartmentId passed and when it is set to true, the entire hierarchy of compartments can be returned. To get a full list of all compartments and subcompartments in the tenancy (root compartment), set the parameter compartmentIdInSubtree to true and accessLevel to ACCESSIBLE.

Parameters:

  • compartment_id (String) —

    A filter to return only resources that match the specified compartment OCID.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :compartment_id_in_subtree (BOOLEAN) —

    Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting. (default to false)

  • :access_level (String) —

    Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed. (default to RESTRICTED) Allowed values are: RESTRICTED, ACCESSIBLE

  • :display_name (String) —

    A filter to return only resources that match the specified display name.

  • :limit (Integer) —

    For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

  • :page (String) —

    For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

  • :security_policy_id (String) —

    An optional filter to return only resources that match the specified OCID of the security policy resource.

  • :lifecycle_state (String) —

    The current state of the SQL Firewall policy.

  • :sql_firewall_policy_id (String) —

    An optional filter to return only resources that match the specified OCID of the SQL Firewall policy resource.

  • :db_user_name (String) —

    A filter to return only items that match the specified user name.

  • :violation_action (String) —

    An optional filter to return only resources that match the specified violation action. Allowed values are: block, observe

  • :time_created_greater_than_or_equal_to (DateTime) —

    A filter to return only the resources that were created after the specified date and time, as defined by RFC3339. Using TimeCreatedGreaterThanOrEqualToQueryParam parameter retrieves all resources created after that date.

    Example: 2016-12-19T16:39:57.600Z

  • :time_created_less_than (DateTime) —

    Search for resources that were created before a specific date. Specifying this parameter corresponding timeCreatedLessThan parameter will retrieve all resources created before the specified created date, in "YYYY-MM-ddThh:mmZ" format with a Z offset, as defined by RFC 3339.

    Example: 2016-12-19T16:39:57.600Z

  • :sort_order (String) —

    The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

  • :sort_by (String) —

    The field used for sorting. Only one sorting order (sortOrder) can be specified. The default order for TIMECREATED is descending. The default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. (default to TIMECREATED) Allowed values are: TIMECREATED, DISPLAYNAME

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:



21431
21432
21433
21434
21435
21436
21437
21438
21439
21440
21441
21442
21443
21444
21445
21446
21447
21448
21449
21450
21451
21452
21453
21454
21455
21456
21457
21458
21459
21460
21461
21462
21463
21464
21465
21466
21467
21468
21469
21470
21471
21472
21473
21474
21475
21476
21477
21478
21479
21480
21481
21482
21483
21484
21485
21486
21487
21488
21489
21490
21491
21492
21493
21494
21495
21496
21497
21498
21499
21500
21501
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 21431

def list_sql_firewall_policies(compartment_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#list_sql_firewall_policies.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_sql_firewall_policies." if compartment_id.nil?

  if opts[:access_level] && !%w[RESTRICTED ACCESSIBLE].include?(opts[:access_level])
    raise 'Invalid value for "access_level", must be one of RESTRICTED, ACCESSIBLE.'
  end

  if opts[:lifecycle_state] && !OCI::DataSafe::Models::SQL_FIREWALL_POLICY_LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::DataSafe::Models::SQL_FIREWALL_POLICY_LIFECYCLE_STATE_ENUM.'
  end

  if opts[:violation_action] && !%w[block observe].include?(opts[:violation_action])
    raise 'Invalid value for "violation_action", must be one of block, observe.'
  end

  if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of ASC, DESC.'
  end

  if opts[:sort_by] && !%w[TIMECREATED DISPLAYNAME].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of TIMECREATED, DISPLAYNAME.'
  end

  path = '/sqlFirewallPolicies'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:compartmentIdInSubtree] = opts[:compartment_id_in_subtree] if !opts[:compartment_id_in_subtree].nil?
  query_params[:accessLevel] = opts[:access_level] if opts[:access_level]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:securityPolicyId] = opts[:security_policy_id] if opts[:security_policy_id]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:sqlFirewallPolicyId] = opts[:sql_firewall_policy_id] if opts[:sql_firewall_policy_id]
  query_params[:dbUserName] = opts[:db_user_name] if opts[:db_user_name]
  query_params[:violationAction] = opts[:violation_action] if opts[:violation_action]
  query_params[:timeCreatedGreaterThanOrEqualTo] = opts[:time_created_greater_than_or_equal_to] if opts[:time_created_greater_than_or_equal_to]
  query_params[:timeCreatedLessThan] = opts[:time_created_less_than] if opts[:time_created_less_than]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#list_sql_firewall_policies') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataSafe::Models::SqlFirewallPolicyCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_sql_firewall_policy_analytics(compartment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_sql_firewall_policy_analytics API.

Gets a list of aggregated SQL Firewall policy details.

The parameter accessLevel specifies whether to return only those compartments for which the requestor has INSPECT permissions on at least one resource directly or indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if principal doesn't have access to even one of the child compartments. This is valid only when compartmentIdInSubtree is set to true.

The parameter compartmentIdInSubtree applies when you perform SummarizedSqlFirewallPolicyInfo on the specified compartmentId and when it is set to true, the entire hierarchy of compartments can be returned. To get a full list of all compartments and subcompartments in the tenancy (root compartment), set the parameter compartmentIdInSubtree to true and accessLevel to ACCESSIBLE.

Parameters:

  • compartment_id (String) —

    A filter to return only resources that match the specified compartment OCID.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :compartment_id_in_subtree (BOOLEAN) —

    Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting. (default to false)

  • :access_level (String) —

    Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed. (default to RESTRICTED) Allowed values are: RESTRICTED, ACCESSIBLE

  • :limit (Integer) —

    For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

  • :page (String) —

    For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

  • :group_by (Array<String>) —

    The group by parameter to summarize SQL Firewall policy aggregation. Allowed values are: violationAction, enforcementScope, securityPolicyId, lifecycleState

  • :lifecycle_state (String) —

    The current state of the SQL Firewall policy.

  • :security_policy_id (String) —

    An optional filter to return only resources that match the specified OCID of the security policy resource.

  • :time_started (DateTime) —

    An optional filter to return the summary of the SQL Firewall policies created after the date-time specified, in the format defined by RFC3339.

  • :time_ended (DateTime) —

    An optional filter to return the summary of the SQL Firewall policies created before the date-time specified, in the format defined by RFC3339.

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:



21552
21553
21554
21555
21556
21557
21558
21559
21560
21561
21562
21563
21564
21565
21566
21567
21568
21569
21570
21571
21572
21573
21574
21575
21576
21577
21578
21579
21580
21581
21582
21583
21584
21585
21586
21587
21588
21589
21590
21591
21592
21593
21594
21595
21596
21597
21598
21599
21600
21601
21602
21603
21604
21605
21606
21607
21608
21609
21610
21611
21612
21613
21614
21615
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 21552

def list_sql_firewall_policy_analytics(compartment_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#list_sql_firewall_policy_analytics.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_sql_firewall_policy_analytics." if compartment_id.nil?

  if opts[:access_level] && !%w[RESTRICTED ACCESSIBLE].include?(opts[:access_level])
    raise 'Invalid value for "access_level", must be one of RESTRICTED, ACCESSIBLE.'
  end


  group_by_allowable_values = %w[violationAction enforcementScope securityPolicyId lifecycleState]
  if opts[:group_by] && !opts[:group_by].empty?
    opts[:group_by].each do |val_to_check|
      unless group_by_allowable_values.include?(val_to_check)
        raise 'Invalid value for "group_by", must be one of violationAction, enforcementScope, securityPolicyId, lifecycleState.'
      end
    end
  end

  if opts[:lifecycle_state] && !OCI::DataSafe::Models::SQL_FIREWALL_POLICY_LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::DataSafe::Models::SQL_FIREWALL_POLICY_LIFECYCLE_STATE_ENUM.'
  end

  path = '/sqlFirewallPolicyAnalytics'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:compartmentIdInSubtree] = opts[:compartment_id_in_subtree] if !opts[:compartment_id_in_subtree].nil?
  query_params[:accessLevel] = opts[:access_level] if opts[:access_level]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:groupBy] = OCI::ApiClient.build_collection_params(opts[:group_by], :multi) if opts[:group_by] && !opts[:group_by].empty?
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:securityPolicyId] = opts[:security_policy_id] if opts[:security_policy_id]
  query_params[:timeStarted] = opts[:time_started] if opts[:time_started]
  query_params[:timeEnded] = opts[:time_ended] if opts[:time_ended]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#list_sql_firewall_policy_analytics') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataSafe::Models::SqlFirewallPolicyAnalyticsCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_sql_firewall_violation_analytics(compartment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_sql_firewall_violation_analytics API.

Returns the aggregation details of the SQL Firewall violations.

Allowed values are: dbUserName, targetId, targetName, operationTime, timeCollected, clientOsUserName, operation, currentDbUserName, sqlLevel, clientIp, clientProgram, violationCause, violationAction, violationCount

Parameters:

  • compartment_id (String) —

    A filter to return only resources that match the specified compartment OCID.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :compartment_id_in_subtree (BOOLEAN) —

    Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting. (default to false)

  • :access_level (String) —

    Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed. (default to RESTRICTED) Allowed values are: RESTRICTED, ACCESSIBLE

  • :limit (Integer) —

    For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

  • :page (String) —

    For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :time_started (DateTime) —

    An optional filter to return audit events whose creation time in the database is greater than and equal to the date-time specified, in the format defined by RFC3339.

  • :time_ended (DateTime) —

    An optional filter to return audit events whose creation time in the database is less than and equal to the date-time specified, in the format defined by RFC3339.

  • :query_time_zone (String) —

    Default time zone is UTC if no time zone provided. The date-time considerations of the resource will be in accordance with the specified time zone. (default to UTC)

  • :sort_order (String) —

    The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

  • :sort_by (String) —

    If this query parameter is specified, the result is sorted by this query parameter value. (default to operationTime)

  • :scim_query (String) —

    The scimQuery query parameter accepts filter expressions that use the syntax described in Section 3.2.2.2 of the System for Cross-Domain Identity Management (SCIM) specification, which is available at RFC3339. In SCIM filtering expressions, text, date, and time values must be enclosed in quotation marks, with date and time values using ISO-8601 format. (Numeric and boolean values should not be quoted.)

    Example: query=(operationTime ge "2021-06-04T01:00:26.000Z") and (violationAction eq "BLOCKED")

  • :summary_field (Array<String>) —

    Specifies a subset of summarized fields to be returned in the response. Allowed values are: dbUserName, targetName, clientOsUserName, operation, sqlText, currentDbUserName, sqlLevel, clientIp, clientProgram, violationCause, violationAction, selects, creates, alters, drops, grants, revokes

  • :group_by (Array<String>) —

    A groupBy can only be used in combination with summaryField parameter. A groupBy value has to be a subset of the values mentioned in summaryField parameter.

    Allowed values are: dbUserName, targetName, operationTime, timeCollected, clientOsUserName, operation, sqlText, currentDbUserName, sqlLevel, clientIp, clientProgram, violationCause, violationAction

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

Returns:



21677
21678
21679
21680
21681
21682
21683
21684
21685
21686
21687
21688
21689
21690
21691
21692
21693
21694
21695
21696
21697
21698
21699
21700
21701
21702
21703
21704
21705
21706
21707
21708
21709
21710
21711
21712
21713
21714
21715
21716
21717
21718
21719
21720
21721
21722
21723
21724
21725
21726
21727
21728
21729
21730
21731
21732
21733
21734
21735
21736
21737
21738
21739
21740
21741
21742
21743
21744
21745
21746
21747
21748
21749
21750
21751
21752
21753
21754
21755
21756
21757
21758
21759
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 21677

def list_sql_firewall_violation_analytics(compartment_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#list_sql_firewall_violation_analytics.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_sql_firewall_violation_analytics." if compartment_id.nil?

  if opts[:access_level] && !%w[RESTRICTED ACCESSIBLE].include?(opts[:access_level])
    raise 'Invalid value for "access_level", must be one of RESTRICTED, ACCESSIBLE.'
  end

  if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of ASC, DESC.'
  end

  if opts[:sort_by] && !%w[dbUserName targetId targetName operationTime timeCollected clientOsUserName operation currentDbUserName sqlLevel clientIp clientProgram violationCause violationAction violationCount].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of dbUserName, targetId, targetName, operationTime, timeCollected, clientOsUserName, operation, currentDbUserName, sqlLevel, clientIp, clientProgram, violationCause, violationAction, violationCount.'
  end


  summary_field_allowable_values = %w[dbUserName targetName clientOsUserName operation sqlText currentDbUserName sqlLevel clientIp clientProgram violationCause violationAction selects creates alters drops grants revokes]
  if opts[:summary_field] && !opts[:summary_field].empty?
    opts[:summary_field].each do |val_to_check|
      unless summary_field_allowable_values.include?(val_to_check)
        raise 'Invalid value for "summary_field", must be one of dbUserName, targetName, clientOsUserName, operation, sqlText, currentDbUserName, sqlLevel, clientIp, clientProgram, violationCause, violationAction, selects, creates, alters, drops, grants, revokes.'
      end
    end
  end


  group_by_allowable_values = %w[dbUserName targetName operationTime timeCollected clientOsUserName operation sqlText currentDbUserName sqlLevel clientIp clientProgram violationCause violationAction]
  if opts[:group_by] && !opts[:group_by].empty?
    opts[:group_by].each do |val_to_check|
      unless group_by_allowable_values.include?(val_to_check)
        raise 'Invalid value for "group_by", must be one of dbUserName, targetName, operationTime, timeCollected, clientOsUserName, operation, sqlText, currentDbUserName, sqlLevel, clientIp, clientProgram, violationCause, violationAction.'
      end
    end
  end

  path = '/sqlFirewallViolationAnalytics'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:compartmentIdInSubtree] = opts[:compartment_id_in_subtree] if !opts[:compartment_id_in_subtree].nil?
  query_params[:accessLevel] = opts[:access_level] if opts[:access_level]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:timeStarted] = opts[:time_started] if opts[:time_started]
  query_params[:timeEnded] = opts[:time_ended] if opts[:time_ended]
  query_params[:queryTimeZone] = opts[:query_time_zone] if opts[:query_time_zone]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:scimQuery] = opts[:scim_query] if opts[:scim_query]
  query_params[:summaryField] = OCI::ApiClient.build_collection_params(opts[:summary_field], :multi) if opts[:summary_field] && !opts[:summary_field].empty?
  query_params[:groupBy] = OCI::ApiClient.build_collection_params(opts[:group_by], :multi) if opts[:group_by] && !opts[:group_by].empty?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#list_sql_firewall_violation_analytics') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataSafe::Models::SqlFirewallViolationAnalyticsCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_sql_firewall_violations(compartment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_sql_firewall_violations API.

Gets a list of all the SQL Firewall violations captured by the firewall.

Allowed values are: dbUserName, targetId, targetName, operationTime, timeCollected, clientOsUserName, operation, currentDbUserName, sqlLevel, clientIp, clientProgram, violationCause, violationAction

Parameters:

  • compartment_id (String) —

    A filter to return only resources that match the specified compartment OCID.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :compartment_id_in_subtree (BOOLEAN) —

    Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting. (default to false)

  • :limit (Integer) —

    For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

  • :page (String) —

    For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :access_level (String) —

    Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed. (default to RESTRICTED) Allowed values are: RESTRICTED, ACCESSIBLE

  • :sort_order (String) —

    The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

  • :sort_by (String) —

    If this query parameter is specified, the result is sorted by this query parameter value. (default to operationTime)

  • :scim_query (String) —

    The scimQuery query parameter accepts filter expressions that use the syntax described in Section 3.2.2.2 of the System for Cross-Domain Identity Management (SCIM) specification, which is available at RFC3339. In SCIM filtering expressions, text, date, and time values must be enclosed in quotation marks, with date and time values using ISO-8601 format. (Numeric and boolean values should not be quoted.)

    Example: query=(operationTime ge "2021-06-04T01:00:26.000Z") and (violationAction eq "BLOCKED")

Returns:



21802
21803
21804
21805
21806
21807
21808
21809
21810
21811
21812
21813
21814
21815
21816
21817
21818
21819
21820
21821
21822
21823
21824
21825
21826
21827
21828
21829
21830
21831
21832
21833
21834
21835
21836
21837
21838
21839
21840
21841
21842
21843
21844
21845
21846
21847
21848
21849
21850
21851
21852
21853
21854
21855
21856
21857
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 21802

def list_sql_firewall_violations(compartment_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#list_sql_firewall_violations.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_sql_firewall_violations." if compartment_id.nil?

  if opts[:access_level] && !%w[RESTRICTED ACCESSIBLE].include?(opts[:access_level])
    raise 'Invalid value for "access_level", must be one of RESTRICTED, ACCESSIBLE.'
  end

  if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of ASC, DESC.'
  end

  if opts[:sort_by] && !%w[dbUserName targetId targetName operationTime timeCollected clientOsUserName operation currentDbUserName sqlLevel clientIp clientProgram violationCause violationAction].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of dbUserName, targetId, targetName, operationTime, timeCollected, clientOsUserName, operation, currentDbUserName, sqlLevel, clientIp, clientProgram, violationCause, violationAction.'
  end

  path = '/sqlFirewallViolations'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:compartmentIdInSubtree] = opts[:compartment_id_in_subtree] if !opts[:compartment_id_in_subtree].nil?
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:accessLevel] = opts[:access_level] if opts[:access_level]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:scimQuery] = opts[:scim_query] if opts[:scim_query]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json, application/xml'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#list_sql_firewall_violations') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataSafe::Models::SqlFirewallViolationsCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_tables(target_database_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_tables API.

Returns a list of table metadata objects.

Allowed values are: SCHEMANAME, TABLENAME

Parameters:

  • target_database_id (String) —

    The OCID of the Data Safe target database.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :limit (Integer) —

    For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

  • :page (String) —

    For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

  • :schema_name (Array<String>) —

    A filter to return only items related to specific schema name.

  • :table_name (Array<String>) —

    A filter to return only items related to specific table name.

  • :sort_order (String) —

    The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

  • :sort_by (String) —

    The field used for sorting. Only one sorting order (sortOrder) can be specified. (default to TABLENAME)

  • :table_name_contains (String) —

    A filter to return only items if table name contains a specific string.

  • :schema_name_contains (String) —

    A filter to return only items if schema name contains a specific string.

Returns:



21887
21888
21889
21890
21891
21892
21893
21894
21895
21896
21897
21898
21899
21900
21901
21902
21903
21904
21905
21906
21907
21908
21909
21910
21911
21912
21913
21914
21915
21916
21917
21918
21919
21920
21921
21922
21923
21924
21925
21926
21927
21928
21929
21930
21931
21932
21933
21934
21935
21936
21937
21938
21939
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 21887

def list_tables(target_database_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#list_tables.' if logger

  raise "Missing the required parameter 'target_database_id' when calling list_tables." if target_database_id.nil?

  if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of ASC, DESC.'
  end

  if opts[:sort_by] && !%w[SCHEMANAME TABLENAME].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of SCHEMANAME, TABLENAME.'
  end
  raise "Parameter value for 'target_database_id' must not be blank" if OCI::Internal::Util.blank_string?(target_database_id)

  path = '/targetDatabases/{targetDatabaseId}/tables'.sub('{targetDatabaseId}', target_database_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:schemaName] = OCI::ApiClient.build_collection_params(opts[:schema_name], :multi) if opts[:schema_name] && !opts[:schema_name].empty?
  query_params[:tableName] = OCI::ApiClient.build_collection_params(opts[:table_name], :multi) if opts[:table_name] && !opts[:table_name].empty?
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:tableNameContains] = opts[:table_name_contains] if opts[:table_name_contains]
  query_params[:schemaNameContains] = opts[:schema_name_contains] if opts[:schema_name_contains]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#list_tables') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'Array<OCI::DataSafe::Models::TableSummary>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_target_alert_policy_associations(compartment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_target_alert_policy_associations API.

Gets a list of all target-alert policy associations.

Allowed values are: DISPLAYNAME, TIMECREATED, TIMEUPDATED

Parameters:

  • compartment_id (String) —

    A filter to return only resources that match the specified compartment OCID.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :target_alert_policy_association_id (String) —

    A filter to return only items related to a specific target-alert policy association ID.

  • :alert_policy_id (String) —

    A filter to return policy by it's OCID.

  • :target_id (String) —

    A filter to return only items related to a specific target OCID.

  • :lifecycle_state (String) —

    An optional filter to return only alert policies that have the given life-cycle state.

  • :limit (Integer) —

    For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

  • :page (String) —

    For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

  • :sort_order (String) —

    The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

  • :sort_by (String) —

    The field to sort by. Only one sort parameter may be provided. (default to TIMECREATED)

  • :target_type (String) —

    A optional filter to return only resources that belong to the specified alert policy association type.

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :time_created_greater_than_or_equal_to (DateTime) —

    A filter to return only the resources that were created after the specified date and time, as defined by RFC3339. Using TimeCreatedGreaterThanOrEqualToQueryParam parameter retrieves all resources created after that date.

    Example: 2016-12-19T16:39:57.600Z

  • :time_created_less_than (DateTime) —

    Search for resources that were created before a specific date. Specifying this parameter corresponding timeCreatedLessThan parameter will retrieve all resources created before the specified created date, in "YYYY-MM-ddThh:mmZ" format with a Z offset, as defined by RFC 3339.

    Example: 2016-12-19T16:39:57.600Z

  • :compartment_id_in_subtree (BOOLEAN) —

    Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting. (default to false)

  • :access_level (String) —

    Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed. (default to RESTRICTED) Allowed values are: RESTRICTED, ACCESSIBLE

Returns:



21992
21993
21994
21995
21996
21997
21998
21999
22000
22001
22002
22003
22004
22005
22006
22007
22008
22009
22010
22011
22012
22013
22014
22015
22016
22017
22018
22019
22020
22021
22022
22023
22024
22025
22026
22027
22028
22029
22030
22031
22032
22033
22034
22035
22036
22037
22038
22039
22040
22041
22042
22043
22044
22045
22046
22047
22048
22049
22050
22051
22052
22053
22054
22055
22056
22057
22058
22059
22060
22061
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 21992

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[:target_type] && !OCI::DataSafe::Models::TargetAlertPolicyAssociation::TARGET_TYPE_ENUM.include?(opts[:target_type])
    raise 'Invalid value for "target_type", must be one of the values in OCI::DataSafe::Models::TargetAlertPolicyAssociation::TARGET_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

  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[:targetType] = opts[:target_type] if opts[:target_type]
  query_params[:timeCreatedGreaterThanOrEqualTo] = opts[:time_created_greater_than_or_equal_to] if opts[:time_created_greater_than_or_equal_to]
  query_params[:timeCreatedLessThan] = opts[:time_created_less_than] if opts[:time_created_less_than]
  query_params[:compartmentIdInSubtree] = opts[:compartment_id_in_subtree] if !opts[:compartment_id_in_subtree].nil?
  query_params[:accessLevel] = opts[:access_level] if opts[:access_level]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#list_target_alert_policy_associations') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataSafe::Models::TargetAlertPolicyAssociationCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_target_alert_policy_unassociated_members(target_alert_policy_association_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_target_alert_policy_unassociated_members API.

Gets the details of target-alert policy association and its unassociated members by its ID. Allowed values are: targetId, notAppliedReason

Parameters:

  • target_alert_policy_association_id (String) —

    The OCID of the target-alert policy association.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :limit (Integer) —

    For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

  • :page (String) —

    For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

  • :sort_by (String) —

    The field to sort by. Only one sort parameter may be provided. (default to targetId)

  • :sort_order (String) —

    The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:



22086
22087
22088
22089
22090
22091
22092
22093
22094
22095
22096
22097
22098
22099
22100
22101
22102
22103
22104
22105
22106
22107
22108
22109
22110
22111
22112
22113
22114
22115
22116
22117
22118
22119
22120
22121
22122
22123
22124
22125
22126
22127
22128
22129
22130
22131
22132
22133
22134
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 22086

def list_target_alert_policy_unassociated_members(target_alert_policy_association_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#list_target_alert_policy_unassociated_members.' if logger

  raise "Missing the required parameter 'target_alert_policy_association_id' when calling list_target_alert_policy_unassociated_members." if target_alert_policy_association_id.nil?

  if opts[:sort_by] && !%w[targetId notAppliedReason].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of targetId, notAppliedReason.'
  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 'target_alert_policy_association_id' must not be blank" if OCI::Internal::Util.blank_string?(target_alert_policy_association_id)

  path = '/targetAlertPolicyAssociations/{targetAlertPolicyAssociationId}/unassociatedTargetMembers'.sub('{targetAlertPolicyAssociationId}', target_alert_policy_association_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[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#list_target_alert_policy_unassociated_members') 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::TargetAlertPolicyUnassociatedCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_target_database_groups(compartment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_target_database_groups API.

Retrieves a list of target database groups according to the specified query parameters.

Allowed values are: timeCreated, displayName, lifecycleState, membershipUpdateTime

Parameters:

  • compartment_id (String) —

    A filter to return only resources that match the specified compartment OCID.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :display_name (String) —

    A filter to return only resources that match the specified display name.

  • :filter (String) —

    The scim query filter parameter accepts filter expressions that use the syntax described in Section 3.2.2.2 of the System for Cross-Domain Identity Management (SCIM) specification, which is available at RFC3339. In SCIM filtering expressions, text, date, and time values must be enclosed in quotation marks, with date and time values using ISO-8601 format. (Numeric and boolean values should not be quoted.) Ex:** filter=(targetDatabaseId eq 'ocid1.datasafetargetdatabase.oc1.iad.abuwcljr3u2va4ba5wek53idpe5qq5kkbigzclscc6mysfecxzjt5dgmxqza')

  • :sort_by (String) —

    The sorting field for your request. You can only specify a single sorting order (sortOrder). The default order for timeCreated is descending. (default to timeCreated)

  • :lifecycle_state (String) —

    A filter to retrieve resources that exclusively align with the designated lifecycle state.

  • :compartment_id_in_subtree (BOOLEAN) —

    Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting. (default to false)

  • :access_level (String) —

    Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed. (default to RESTRICTED) Allowed values are: RESTRICTED, ACCESSIBLE

  • :sort_order (String) —

    The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

  • :time_created_greater_than_or_equal_to (DateTime) —

    A filter to return only the resources that were created after the specified date and time, as defined by RFC3339. Using TimeCreatedGreaterThanOrEqualToQueryParam parameter retrieves all resources created after that date.

    Example: 2016-12-19T16:39:57.600Z

  • :time_created_less_than (DateTime) —

    Search for resources that were created before a specific date. Specifying this parameter corresponding timeCreatedLessThan parameter will retrieve all resources created before the specified created date, in "YYYY-MM-ddThh:mmZ" format with a Z offset, as defined by RFC 3339.

    Example: 2016-12-19T16:39:57.600Z

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :limit (Integer) —

    For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

  • :page (String) —

    For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

  • :target_database_group_id (String) —

    A filter to return the target database group that matches the specified OCID.

Returns:



22193
22194
22195
22196
22197
22198
22199
22200
22201
22202
22203
22204
22205
22206
22207
22208
22209
22210
22211
22212
22213
22214
22215
22216
22217
22218
22219
22220
22221
22222
22223
22224
22225
22226
22227
22228
22229
22230
22231
22232
22233
22234
22235
22236
22237
22238
22239
22240
22241
22242
22243
22244
22245
22246
22247
22248
22249
22250
22251
22252
22253
22254
22255
22256
22257
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 22193

def list_target_database_groups(compartment_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#list_target_database_groups.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_target_database_groups." if compartment_id.nil?

  if opts[:sort_by] && !%w[timeCreated displayName lifecycleState membershipUpdateTime].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of timeCreated, displayName, lifecycleState, membershipUpdateTime.'
  end

  if opts[:lifecycle_state] && !OCI::DataSafe::Models::TARGET_DATABASE_GROUP_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_GROUP_LIFECYCLE_STATE_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

  path = '/targetDatabaseGroups'
  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[:filter] = opts[:filter] if opts[:filter]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  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[: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[:targetDatabaseGroupId] = opts[:target_database_group_id] if opts[:target_database_group_id]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#list_target_database_groups') 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::TargetDatabaseGroupCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_target_databases(compartment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_target_databases API.

Returns the list of registered target databases in Data Safe.

Parameters:

  • compartment_id (String) —

    A filter to return only resources that match the specified compartment OCID.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :associated_resource_id (String) —

    A filter to return the target databases that are associated to the resource id passed in as a parameter value.

  • :target_database_id (String) —

    A filter to return the target database that matches the specified OCID.

  • :display_name (String) —

    A filter to return only resources that match the specified display name.

  • :lifecycle_state (String) —

    A filter to return only target databases that match the specified lifecycle state.

  • :database_type (String) —

    A filter to return only target databases that match the specified database type.

  • :infrastructure_type (String) —

    A filter to return only target databases that match the specified infrastructure type.

  • :limit (Integer) —

    For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

  • :page (String) —

    For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

  • :compartment_id_in_subtree (BOOLEAN) —

    Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting. (default to false)

  • :access_level (String) —

    Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed. (default to RESTRICTED) Allowed values are: RESTRICTED, ACCESSIBLE

  • :sort_order (String) —

    The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

  • :sort_by (String) —

    The field used for sorting. Only one sorting order (sortOrder) can be specified. The default order for TIMECREATED is descending. The default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. (default to TIMECREATED) Allowed values are: TIMECREATED, DISPLAYNAME

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:



22301
22302
22303
22304
22305
22306
22307
22308
22309
22310
22311
22312
22313
22314
22315
22316
22317
22318
22319
22320
22321
22322
22323
22324
22325
22326
22327
22328
22329
22330
22331
22332
22333
22334
22335
22336
22337
22338
22339
22340
22341
22342
22343
22344
22345
22346
22347
22348
22349
22350
22351
22352
22353
22354
22355
22356
22357
22358
22359
22360
22361
22362
22363
22364
22365
22366
22367
22368
22369
22370
22371
22372
22373
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 22301

def list_target_databases(compartment_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#list_target_databases.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_target_databases." if compartment_id.nil?

  if opts[:lifecycle_state] && !OCI::DataSafe::Models::TARGET_DATABASE_LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::DataSafe::Models::TARGET_DATABASE_LIFECYCLE_STATE_ENUM.'
  end

  if opts[:database_type] && !OCI::DataSafe::Models::DATABASE_TYPE_ENUM.include?(opts[:database_type])
    raise 'Invalid value for "database_type", must be one of the values in OCI::DataSafe::Models::DATABASE_TYPE_ENUM.'
  end

  if opts[:infrastructure_type] && !OCI::DataSafe::Models::INFRASTRUCTURE_TYPE_ENUM.include?(opts[:infrastructure_type])
    raise 'Invalid value for "infrastructure_type", must be one of the values in OCI::DataSafe::Models::INFRASTRUCTURE_TYPE_ENUM.'
  end

  if opts[:access_level] && !%w[RESTRICTED ACCESSIBLE].include?(opts[:access_level])
    raise 'Invalid value for "access_level", must be one of RESTRICTED, ACCESSIBLE.'
  end

  if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of ASC, DESC.'
  end

  if opts[:sort_by] && !%w[TIMECREATED DISPLAYNAME].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of TIMECREATED, DISPLAYNAME.'
  end

  path = '/targetDatabases'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:associatedResourceId] = opts[:associated_resource_id] if opts[:associated_resource_id]
  query_params[:targetDatabaseId] = opts[:target_database_id] if opts[:target_database_id]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:databaseType] = opts[:database_type] if opts[:database_type]
  query_params[:infrastructureType] = opts[:infrastructure_type] if opts[:infrastructure_type]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:compartmentIdInSubtree] = opts[:compartment_id_in_subtree] if !opts[:compartment_id_in_subtree].nil?
  query_params[:accessLevel] = opts[:access_level] if opts[:access_level]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#list_target_databases') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'Array<OCI::DataSafe::Models::TargetDatabaseSummary>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_target_overrides(audit_profile_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_target_overrides API.

Gets a list of all targets whose audit settings override the target group setting.

Parameters:

  • audit_profile_id (String) —

    The OCID of the audit.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :limit (Integer) —

    For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

  • :page (String) —

    For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

  • :display_name (String) —

    A filter to return only resources that match the specified display name.

  • :sort_by (String) —

    The field used for sorting. Only one sorting order (sortOrder) can be specified. The default order for TIMECREATED is descending. The default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. (default to TIMECREATED) Allowed values are: TIMECREATED, DISPLAYNAME

  • :sort_order (String) —

    The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:



22402
22403
22404
22405
22406
22407
22408
22409
22410
22411
22412
22413
22414
22415
22416
22417
22418
22419
22420
22421
22422
22423
22424
22425
22426
22427
22428
22429
22430
22431
22432
22433
22434
22435
22436
22437
22438
22439
22440
22441
22442
22443
22444
22445
22446
22447
22448
22449
22450
22451
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 22402

def list_target_overrides(audit_profile_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#list_target_overrides.' if logger

  raise "Missing the required parameter 'audit_profile_id' when calling list_target_overrides." if audit_profile_id.nil?

  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 'audit_profile_id' must not be blank" if OCI::Internal::Util.blank_string?(audit_profile_id)

  path = '/auditProfiles/{auditProfileId}/targetOverrides'.sub('{auditProfileId}', audit_profile_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[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#list_target_overrides') 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::TargetOverrideCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_template_analytics(compartment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_template_analytics API.

Gets a list of template aggregated details in the specified compartment. This provides information about the overall template usage, by returning the count of the target databases/target groups using the templates. It also provides information about the statistics for the template baseline and the comparison related. If the comparison is done, it will show if there is any drift, and how many checks have drifts. The dimension field - isGroup identifies if the targetId belongs to a target group or a individual target. The dimension field - isCompared identifies if the comparison between the latest assessment and the template baseline assessment is done or not. The dimension field - isCompliant identifies if the latest assessment is compliant with the template baseline assessment or not. The dimension field - totalChecksFailed identifies how many checks in the template have drifts in the comparison.

When you perform the ListTemplateAnalytics operation, if the parameter compartmentIdInSubtree is set to "true," and if the parameter accessLevel is set to ACCESSIBLE, then the operation returns statistics from the compartments in which the requestor has INSPECT permissions on at least one resource, directly or indirectly (in subcompartments). If the operation is performed at the root compartment and the requestor does not have access to at least one subcompartment of the compartment specified by compartmentId, then "Not Authorized" is returned.

Parameters:

  • compartment_id (String) —

    A filter to return only resources that match the specified compartment OCID.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :compartment_id_in_subtree (BOOLEAN) —

    Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting. (default to false)

  • :access_level (String) —

    Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed. (default to RESTRICTED) Allowed values are: RESTRICTED, ACCESSIBLE

  • :template_assessment_id (String) —

    The OCID of the security assessment of type TEMPLATE.

  • :template_baseline_assessment_id (String) —

    The OCID of the security assessment of type TEMPLATE_BASELINE.

  • :is_group (BOOLEAN) —

    A filter to return only the target group related information if the OCID belongs to a target group.

  • :is_compared (BOOLEAN) —

    A filter to return only the statistics where the comparison between the latest assessment and the template baseline assessment is done.

  • :is_compliant (BOOLEAN) —

    A filter to return only the statistics where the latest assessment is compliant with the template baseline assessment.

  • :target_id (String) —

    A filter to return only items related to a specific target OCID.

  • :target_database_group_id (String) —

    A filter to return the target database group that matches the specified OCID.

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :limit (Integer) —

    For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

  • :page (String) —

    For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

Returns:



22501
22502
22503
22504
22505
22506
22507
22508
22509
22510
22511
22512
22513
22514
22515
22516
22517
22518
22519
22520
22521
22522
22523
22524
22525
22526
22527
22528
22529
22530
22531
22532
22533
22534
22535
22536
22537
22538
22539
22540
22541
22542
22543
22544
22545
22546
22547
22548
22549
22550
22551
22552
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 22501

def list_template_analytics(compartment_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#list_template_analytics.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_template_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

  path = '/securityAssessments/templateAnalytics'
  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[:templateAssessmentId] = opts[:template_assessment_id] if opts[:template_assessment_id]
  query_params[:templateBaselineAssessmentId] = opts[:template_baseline_assessment_id] if opts[:template_baseline_assessment_id]
  query_params[:isGroup] = opts[:is_group] if !opts[:is_group].nil?
  query_params[:isCompared] = opts[:is_compared] if !opts[:is_compared].nil?
  query_params[:isCompliant] = opts[:is_compliant] if !opts[:is_compliant].nil?
  query_params[:targetId] = opts[:target_id] if opts[:target_id]
  query_params[:targetDatabaseGroupId] = opts[:target_database_group_id] if opts[:target_database_group_id]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#list_template_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::TemplateAnalyticsCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_template_association_analytics(compartment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_template_association_analytics API.

Gets a list of template association details in the specified compartment. This provides information about the overall template usage, by returning the count of the target databases/target groups using the templates.

If the template baseline is created for a target group which contains several targets, we will have each individual target listed there as targetId field together with targetDatabaseGroupId. And if the template baseline is created for an individual target, it will have targetId field only.

By leveraging the targetId filter, you will be able to know all the template or template baseline that this target has something to do with. No matter if they are directly applied or created for this target, or they are for the target group the target belongs to.

When you perform the ListTemplateAssociationAnalytics operation, if the parameter compartmentIdInSubtree is set to "true," and if the parameter accessLevel is set to ACCESSIBLE, then the operation returns statistics from the compartments in which the requestor has INSPECT permissions on at least one resource, directly or indirectly (in subcompartments). If the operation is performed at the root compartment and the requestor does not have access to at least one subcompartment of the compartment specified by compartmentId, then "Not Authorized" is returned.

Parameters:

  • compartment_id (String) —

    A filter to return only resources that match the specified compartment OCID.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :compartment_id_in_subtree (BOOLEAN) —

    Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting. (default to false)

  • :access_level (String) —

    Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed. (default to RESTRICTED) Allowed values are: RESTRICTED, ACCESSIBLE

  • :template_assessment_id (String) —

    The OCID of the security assessment of type TEMPLATE.

  • :template_baseline_assessment_id (String) —

    The OCID of the security assessment of type TEMPLATE_BASELINE.

  • :target_id (String) —

    A filter to return only items related to a specific target OCID.

  • :target_database_group_id (String) —

    A filter to return the target database group that matches the specified OCID.

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :limit (Integer) —

    For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

  • :page (String) —

    For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

Returns:



22600
22601
22602
22603
22604
22605
22606
22607
22608
22609
22610
22611
22612
22613
22614
22615
22616
22617
22618
22619
22620
22621
22622
22623
22624
22625
22626
22627
22628
22629
22630
22631
22632
22633
22634
22635
22636
22637
22638
22639
22640
22641
22642
22643
22644
22645
22646
22647
22648
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 22600

def list_template_association_analytics(compartment_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#list_template_association_analytics.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_template_association_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

  path = '/securityAssessments/templateAssociationAnalytics'
  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[:templateAssessmentId] = opts[:template_assessment_id] if opts[:template_assessment_id]
  query_params[:templateBaselineAssessmentId] = opts[:template_baseline_assessment_id] if opts[:template_baseline_assessment_id]
  query_params[:targetId] = opts[:target_id] if opts[:target_id]
  query_params[:targetDatabaseGroupId] = opts[:target_database_group_id] if opts[:target_database_group_id]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#list_template_association_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::TemplateAssociationAnalyticsCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_unified_audit_policies(compartment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_unified_audit_policies API.

Retrieves a list of all Unified Audit policies.

The ListUnifiedAuditPolicies operation returns only the Unified Audit policies in the specified compartmentId.

The parameter accessLevel specifies whether to return only those compartments for which the requester has INSPECT permissions on at least one resource directly or indirectly (ACCESSIBLE) (the resource can be in a sub-compartment) 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 ListUnifiedAuditPolicies 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 sub-compartments in the tenancy (root compartment), set the parameter compartmentIdInSubtree to true and accessLevel to ACCESSIBLE.

Parameters:

  • compartment_id (String) —

    A filter to return only resources that match the specified compartment OCID.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :security_policy_id (String) —

    An optional filter to return only resources that match the specified OCID of the security policy resource.

  • :lifecycle_state (String) —

    The current state of the Unified Audit policy.

  • :access_level (String) —

    Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed. (default to RESTRICTED) Allowed values are: RESTRICTED, ACCESSIBLE

  • :display_name (String) —

    A filter to return only resources that match the specified display name.

  • :is_seeded (BOOLEAN) —

    A boolean flag indicating to list seeded unified audit policies. Set this parameter to get list of seeded unified audit policies. (default to false)

  • :time_created_greater_than_or_equal_to (DateTime) —

    A filter to return only the resources that were created after the specified date and time, as defined by RFC3339. Using TimeCreatedGreaterThanOrEqualToQueryParam parameter retrieves all resources created after that date.

    Example: 2016-12-19T16:39:57.600Z

  • :time_created_less_than (DateTime) —

    Search for resources that were created before a specific date. Specifying this parameter corresponding timeCreatedLessThan parameter will retrieve all resources created before the specified created date, in "YYYY-MM-ddThh:mmZ" format with a Z offset, as defined by RFC 3339.

    Example: 2016-12-19T16:39:57.600Z

  • :limit (Integer) —

    For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

  • :page (String) —

    For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

  • :unified_audit_policy_definition_id (String) —

    An optional filter to return only resources that match the specified OCID of the unified audit policy definition resource.

  • :unified_audit_policy_id (String) —

    An optional filter to return only resources that match the specified OCID of the Unified Audit policy resource.

  • :sort_order (String) —

    The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

  • :sort_by (String) —

    The field used for sorting. Only one sorting order (sortOrder) can be specified. The default order for TIMECREATED is descending. The default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. (default to TIMECREATED) Allowed values are: TIMECREATED, DISPLAYNAME

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :compartment_id_in_subtree (BOOLEAN) —

    Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting. (default to false)

Returns:



22718
22719
22720
22721
22722
22723
22724
22725
22726
22727
22728
22729
22730
22731
22732
22733
22734
22735
22736
22737
22738
22739
22740
22741
22742
22743
22744
22745
22746
22747
22748
22749
22750
22751
22752
22753
22754
22755
22756
22757
22758
22759
22760
22761
22762
22763
22764
22765
22766
22767
22768
22769
22770
22771
22772
22773
22774
22775
22776
22777
22778
22779
22780
22781
22782
22783
22784
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 22718

def list_unified_audit_policies(compartment_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#list_unified_audit_policies.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_unified_audit_policies." if compartment_id.nil?

  if opts[:lifecycle_state] && !OCI::DataSafe::Models::UNIFIED_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::UNIFIED_AUDIT_POLICY_LIFECYCLE_STATE_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 = '/unifiedAuditPolicies'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:securityPolicyId] = opts[:security_policy_id] if opts[:security_policy_id]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:accessLevel] = opts[:access_level] if opts[:access_level]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:isSeeded] = opts[:is_seeded] if !opts[:is_seeded].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[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:unifiedAuditPolicyDefinitionId] = opts[:unified_audit_policy_definition_id] if opts[:unified_audit_policy_definition_id]
  query_params[:unifiedAuditPolicyId] = opts[:unified_audit_policy_id] if opts[:unified_audit_policy_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?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#list_unified_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::UnifiedAuditPolicyCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_unified_audit_policy_definitions(compartment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_unified_audit_policy_definitions API.

Retrieves a list of all unified audit policy definitions in Data Safe.

The ListUnifiedAuditPolicyDefinitions operation returns only the unified audit policy definitions in the specified compartmentId.

The parameter accessLevel specifies whether to return only those compartments for which the requester 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 ListUnifiedAuditPolicyDefinitions on the compartmentId passed and when it is set to true, the entire hierarchy of compartments can be returned. To get a full list of all compartments and subcompartments in the tenancy (root compartment), set the parameter compartmentIdInSubtree to true and accessLevel to ACCESSIBLE.

Parameters:

  • compartment_id (String) —

    A filter to return only resources that match the specified compartment OCID.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :lifecycle_state (String) —

    The current state of the unified audit policy definition.

  • :unified_audit_policy_definition_id (String) —

    An optional filter to return only resources that match the specified OCID of the unified audit policy definition resource.

  • :access_level (String) —

    Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed. (default to RESTRICTED) Allowed values are: RESTRICTED, ACCESSIBLE

  • :display_name (String) —

    A filter to return only resources that match the specified display name.

  • :is_seeded (BOOLEAN) —

    A boolean flag indicating to list seeded unified audit policy definitions. Set this parameter to get list of seeded unified audit policy definitions. (default to false)

  • :unified_audit_policy_category (String) —

    The category to which the unified audit policy definition belongs to.

  • :unified_audit_policy_name (String) —

    The name of the unified audit policy.

  • :limit (Integer) —

    For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

  • :page (String) —

    For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

  • :compartment_id_in_subtree (BOOLEAN) —

    Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting. (default to false)

  • :sort_order (String) —

    The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

  • :sort_by (String) —

    The field used for sorting. Only one sorting order (sortOrder) can be specified. The default order for TIMECREATED is descending. The default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. (default to TIMECREATED) Allowed values are: TIMECREATED, DISPLAYNAME

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:



22841
22842
22843
22844
22845
22846
22847
22848
22849
22850
22851
22852
22853
22854
22855
22856
22857
22858
22859
22860
22861
22862
22863
22864
22865
22866
22867
22868
22869
22870
22871
22872
22873
22874
22875
22876
22877
22878
22879
22880
22881
22882
22883
22884
22885
22886
22887
22888
22889
22890
22891
22892
22893
22894
22895
22896
22897
22898
22899
22900
22901
22902
22903
22904
22905
22906
22907
22908
22909
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 22841

def list_unified_audit_policy_definitions(compartment_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#list_unified_audit_policy_definitions.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_unified_audit_policy_definitions." if compartment_id.nil?

  if opts[:lifecycle_state] && !OCI::DataSafe::Models::UNIFIED_AUDIT_POLICY_DEFINITION_LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::DataSafe::Models::UNIFIED_AUDIT_POLICY_DEFINITION_LIFECYCLE_STATE_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[:unified_audit_policy_category] && !OCI::DataSafe::Models::UnifiedAuditPolicyDefinition::AUDIT_POLICY_CATEGORY_ENUM.include?(opts[:unified_audit_policy_category])
    raise 'Invalid value for "unified_audit_policy_category", must be one of the values in OCI::DataSafe::Models::UnifiedAuditPolicyDefinition::AUDIT_POLICY_CATEGORY_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 = '/unifiedAuditPolicyDefinitions'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:unifiedAuditPolicyDefinitionId] = opts[:unified_audit_policy_definition_id] if opts[:unified_audit_policy_definition_id]
  query_params[:accessLevel] = opts[:access_level] if opts[:access_level]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:isSeeded] = opts[:is_seeded] if !opts[:is_seeded].nil?
  query_params[:unifiedAuditPolicyCategory] = opts[:unified_audit_policy_category] if opts[:unified_audit_policy_category]
  query_params[:unifiedAuditPolicyName] = opts[:unified_audit_policy_name] if opts[:unified_audit_policy_name]
  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[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#list_unified_audit_policy_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::UnifiedAuditPolicyDefinitionCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_user_access_analytics(user_assessment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_user_access_analytics API.

Gets a list of aggregated user access analytics in the specified target in a compartment.

Allowed values are: USERNAME, COUNT

Parameters:

  • user_assessment_id (String) —

    The OCID of the user assessment.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :sort_by (String) —

    The field to sort by. Only one sort parameter may be provided. (default to COUNT)

  • :sort_order (String) —

    The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

  • :limit (Integer) —

    For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

  • :page (String) —

    For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:



22935
22936
22937
22938
22939
22940
22941
22942
22943
22944
22945
22946
22947
22948
22949
22950
22951
22952
22953
22954
22955
22956
22957
22958
22959
22960
22961
22962
22963
22964
22965
22966
22967
22968
22969
22970
22971
22972
22973
22974
22975
22976
22977
22978
22979
22980
22981
22982
22983
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 22935

def list_user_access_analytics(user_assessment_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#list_user_access_analytics.' if logger

  raise "Missing the required parameter 'user_assessment_id' when calling list_user_access_analytics." if user_assessment_id.nil?

  if opts[:sort_by] && !%w[USERNAME COUNT].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of USERNAME, COUNT.'
  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}/userAccessAnalytics'.sub('{userAssessmentId}', user_assessment_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#list_user_access_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::UserAccessAnalyticsCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_user_analytics(user_assessment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_user_analytics API.

Gets a list of aggregated user details from the specified user assessment. This provides information about the overall state. of database user security. For example, the user details include how many users have the DBA role and how many users are in the critical category. This data is especially useful content for dashboards or to support analytics.

When you perform the ListUserAnalytics operation, if the parameter compartmentIdInSubtree is set to "true," and if the parameter accessLevel is set to ACCESSIBLE, then the operation returns compartments in which the requestor has READ permissions on at least one resource, directly or indirectly (in subcompartments). If the operation is performed at the root compartment and the requestor does not have access to at least one subcompartment of the compartment specified by compartmentId, then "Not Authorized" is returned.

The parameter compartmentIdInSubtree applies when you perform ListUserAnalytics on the compartmentId passed and when it is set to true, the entire hierarchy of compartments can be returned.

To use ListUserAnalytics to get a full list of all compartments and subcompartments in the tenancy from the root compartment, set the parameter compartmentIdInSubtree to true and accessLevel to ACCESSIBLE.

Allowed values are: userName, userCategory, accountStatus, timeLastLogin, targetId, timeUserCreated, authenticationType, timePasswordChanged

Parameters:

  • user_assessment_id (String) —

    The OCID of the user assessment.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :compartment_id_in_subtree (BOOLEAN) —

    Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting. (default to false)

  • :access_level (String) —

    Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed. (default to RESTRICTED) Allowed values are: RESTRICTED, ACCESSIBLE

  • :limit (Integer) —

    For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

  • :user_category (String) —

    A filter to return only items that match the specified user category.

  • :user_key (String) —

    A filter to return only items that match the specified user key.

  • :account_status (String) —

    A filter to return only items that match the specified account status.

  • :authentication_type (String) —

    A filter to return only items that match the specified authentication type.

  • :user_name (String) —

    A filter to return only items that match the specified user name.

  • :target_id (String) —

    A filter to return only items related to a specific target OCID.

  • :time_last_login_greater_than_or_equal_to (DateTime) —

    A filter to return users whose last login time in the database is greater than or equal to the date and time specified, in the format defined by RFC3339.

    Example: 2016-12-19T16:39:57.600Z

  • :time_last_login_less_than (DateTime) —

    A filter to return users whose last login time in the database is less than the date and time specified, in the format defined by RFC3339. Example: 2016-12-19T16:39:57.600Z

  • :time_user_created_greater_than_or_equal_to (DateTime) —

    A filter to return users whose creation time in the database is greater than or equal to the date and time specified, in the format defined by RFC3339. Example: 2016-12-19T16:39:57.600Z

  • :time_user_created_less_than (DateTime) —

    A filter to return users whose creation time in the database is less than the date and time specified, in the format defined by RFC3339. Example: 2016-12-19T16:39:57.600Z

  • :time_password_last_changed_greater_than_or_equal_to (DateTime) —

    A filter to return users whose last password change in the database is greater than or equal to the date and time specified, in the format defined by RFC3339.

    Example: 2016-12-19T16:39:57.600Z

  • :time_password_last_changed_less_than (DateTime) —

    A filter to return users whose last password change in the database is less than the date and time specified, in the format defined by RFC3339.

    Example: 2016-12-19T16:39:57.600Z

  • :time_password_expiry_greater_than_or_equal_to (DateTime) —

    A filter to return users whose password expiry date in the database is greater than or equal to the date and time specified, in the format defined by RFC3339. Example: 2016-12-19T16:39:57.600Z

  • :time_password_expiry_less_than (DateTime) —

    A filter to return users whose password expiry date in the database is less than the date and time specified, in the format defined by RFC3339. Example: 2016-12-19T16:39:57.600Z

  • :page (String) —

    For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

  • :sort_order (String) —

    The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

  • :sort_by (String) —

    The field to sort by. You can specify only one sort order (sortOrder). The default order for userName is ascending. (default to userName)

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:



23065
23066
23067
23068
23069
23070
23071
23072
23073
23074
23075
23076
23077
23078
23079
23080
23081
23082
23083
23084
23085
23086
23087
23088
23089
23090
23091
23092
23093
23094
23095
23096
23097
23098
23099
23100
23101
23102
23103
23104
23105
23106
23107
23108
23109
23110
23111
23112
23113
23114
23115
23116
23117
23118
23119
23120
23121
23122
23123
23124
23125
23126
23127
23128
23129
23130
23131
23132
23133
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 23065

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[:timePasswordExpiryGreaterThanOrEqualTo] = opts[:time_password_expiry_greater_than_or_equal_to] if opts[:time_password_expiry_greater_than_or_equal_to]
  query_params[:timePasswordExpiryLessThan] = opts[:time_password_expiry_less_than] if opts[:time_password_expiry_less_than]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#list_user_analytics') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'Array<OCI::DataSafe::Models::UserAggregation>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_user_assessments(compartment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_user_assessments API.

Gets a list of user assessments.

The ListUserAssessments operation returns only the assessments in the specified compartmentId. The list does not include any subcompartments of the compartmentId passed.

The parameter accessLevel specifies whether to return only those compartments for which the requestor has INSPECT permissions on at least one resource directly or indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if Principal doesn't have access to even one of the child compartments. This is valid only when compartmentIdInSubtree is set to true.

The parameter compartmentIdInSubtree applies when you perform ListUserAssessments on the compartmentId passed and when it is set to true, the entire hierarchy of compartments can be returned. To get a full list of all compartments and subcompartments in the tenancy (root compartment), set the parameter compartmentIdInSubtree to true and accessLevel to ACCESSIBLE.

Allowed values are: timeCreated, displayName

Parameters:

  • compartment_id (String) —

    A filter to return only resources that match the specified compartment OCID.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :compartment_id_in_subtree (BOOLEAN) —

    Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting. (default to false)

  • :access_level (String) —

    Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed. (default to RESTRICTED) Allowed values are: RESTRICTED, ACCESSIBLE

  • :display_name (String) —

    A filter to return only resources that match the specified display name.

  • :schedule_user_assessment_id (String) —

    The OCID of the user assessment of type SAVE_SCHEDULE.

  • :is_schedule_assessment (BOOLEAN) —

    A filter to return only user assessments of type SAVE_SCHEDULE. (default to false)

  • :is_baseline (BOOLEAN) —

    A filter to return only user assessments that are set as baseline. (default to false)

  • :target_id (String) —

    A filter to return only items related to a specific target OCID.

  • :type (String) —

    A filter to return only items that match the specified assessment type. Allowed values are: LATEST, SAVED, COMPARTMENT, SAVE_SCHEDULE

  • :triggered_by (String) —

    A filter to return user assessments that were created by either the system or by a user only. Allowed values are: USER, SYSTEM

  • :time_created_greater_than_or_equal_to (DateTime) —

    A filter to return only user assessments that were created after the specified date and time, as defined by RFC3339. Using timeCreatedGreaterThanOrEqualTo parameter retrieves all assessments created after that date.

    Example: 2016-12-19T16:39:57.600Z

  • :time_created_less_than (DateTime) —

    Search for resources that were created before a specific date. Specifying this parameter corresponding timeCreatedLessThan parameter will retrieve all resources created before the specified created date, in "YYYY-MM-ddThh:mmZ" format with a Z offset, as defined by RFC 3339.

    Example: 2016-12-19T16:39:57.600Z

  • :limit (Integer) —

    For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

  • :page (String) —

    For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

  • :lifecycle_state (String) —

    The current state of the user assessment.

  • :sort_order (String) —

    The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

  • :sort_by (String) —

    The field to sort by. You can specify only one sort order (sortOrder). The default order for timeCreated is descending. (default to timeCreated)

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :target_type (String) —

    A filter to return only only target database resources or target database group resources.

  • :target_database_group_id (String) —

    A filter to return the target database group that matches the specified OCID.

Returns:



23209
23210
23211
23212
23213
23214
23215
23216
23217
23218
23219
23220
23221
23222
23223
23224
23225
23226
23227
23228
23229
23230
23231
23232
23233
23234
23235
23236
23237
23238
23239
23240
23241
23242
23243
23244
23245
23246
23247
23248
23249
23250
23251
23252
23253
23254
23255
23256
23257
23258
23259
23260
23261
23262
23263
23264
23265
23266
23267
23268
23269
23270
23271
23272
23273
23274
23275
23276
23277
23278
23279
23280
23281
23282
23283
23284
23285
23286
23287
23288
23289
23290
23291
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 23209

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

  if opts[:target_type] && !OCI::DataSafe::Models::USER_ASSESSMENT_TARGET_TYPE_ENUM.include?(opts[:target_type])
    raise 'Invalid value for "target_type", must be one of the values in OCI::DataSafe::Models::USER_ASSESSMENT_TARGET_TYPE_ENUM.'
  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]
  query_params[:targetType] = opts[:target_type] if opts[:target_type]
  query_params[:targetDatabaseGroupId] = opts[:target_database_group_id] if opts[:target_database_group_id]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#list_user_assessments') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'Array<OCI::DataSafe::Models::UserAssessmentSummary>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_users(user_assessment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_users API.

Gets a list of users of the specified user assessment. The result contains the database user details for each user, such as user type, account status, last login time, user creation time, authentication type, user profile, and the date and time of the latest password change. It also contains the user category derived from these user details as well as privileges granted to each user.

as specified by '#/definitions/userTypes'.

Allowed values are: userName, userCategory, accountStatus, timeLastLogin, targetId, timeUserCreated, authenticationType, timePasswordChanged

Parameters:

  • user_assessment_id (String) —

    The OCID of the user assessment.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :limit (Integer) —

    For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

  • :compartment_id_in_subtree (BOOLEAN) —

    Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting. (default to false)

  • :access_level (String) —

    Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed. (default to RESTRICTED) Allowed values are: RESTRICTED, ACCESSIBLE

  • :user_category (String) —

    A filter to return only items that match the specified user category.

  • :user_role (String) —

    A filter to return only items that match the specified user role.

  • :user_profile (String) —

    A filter to return only items that match the specified user profile.

  • :user_type (String) —

    A filter to return only items that match the specified user type. The possible values can be - ADMIN_PRIVILEGED - APPLICATION - PRIVILEGED - SCHEMA - NON_PRIVILEGED

  • :user_key (String) —

    A filter to return only items that match the specified user key.

  • :account_status (String) —

    A filter to return only items that match the specified account status.

  • :authentication_type (String) —

    A filter to return only items that match the specified authentication type.

  • :user_name (String) —

    A filter to return only items that match the specified user name.

  • :target_id (String) —

    A filter to return only items related to a specific target OCID.

  • :time_last_login_greater_than_or_equal_to (DateTime) —

    A filter to return users whose last login time in the database is greater than or equal to the date and time specified, in the format defined by RFC3339.

    Example: 2016-12-19T16:39:57.600Z

  • :time_last_login_less_than (DateTime) —

    A filter to return users whose last login time in the database is less than the date and time specified, in the format defined by RFC3339. Example: 2016-12-19T16:39:57.600Z

  • :time_user_created_greater_than_or_equal_to (DateTime) —

    A filter to return users whose creation time in the database is greater than or equal to the date and time specified, in the format defined by RFC3339. Example: 2016-12-19T16:39:57.600Z

  • :time_user_created_less_than (DateTime) —

    A filter to return users whose creation time in the database is less than the date and time specified, in the format defined by RFC3339. Example: 2016-12-19T16:39:57.600Z

  • :time_password_last_changed_greater_than_or_equal_to (DateTime) —

    A filter to return users whose last password change in the database is greater than or equal to the date and time specified, in the format defined by RFC3339.

    Example: 2016-12-19T16:39:57.600Z

  • :time_password_last_changed_less_than (DateTime) —

    A filter to return users whose last password change in the database is less than the date and time specified, in the format defined by RFC3339.

    Example: 2016-12-19T16:39:57.600Z

  • :time_password_expiry_greater_than_or_equal_to (DateTime) —

    A filter to return users whose password expiry date in the database is greater than or equal to the date and time specified, in the format defined by RFC3339. Example: 2016-12-19T16:39:57.600Z

  • :time_password_expiry_less_than (DateTime) —

    A filter to return users whose password expiry date in the database is less than the date and time specified, in the format defined by RFC3339. Example: 2016-12-19T16:39:57.600Z

  • :page (String) —

    For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

  • :compartment_id (String) —

    A filter to return only resources that match the specified compartment OCID.

  • :sort_order (String) —

    The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

  • :sort_by (String) —

    The field to sort by. You can specify only one sort order (sortOrder). The default order for userName is ascending. (default to userName)

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :schema_list (Array<String>) —

    A filter to return items that contain the specified schema list.

  • :are_all_schemas_accessible (BOOLEAN) —

    A filter to return only items that match the criteria that all schemas can be accessed by a user.

Returns:



23375
23376
23377
23378
23379
23380
23381
23382
23383
23384
23385
23386
23387
23388
23389
23390
23391
23392
23393
23394
23395
23396
23397
23398
23399
23400
23401
23402
23403
23404
23405
23406
23407
23408
23409
23410
23411
23412
23413
23414
23415
23416
23417
23418
23419
23420
23421
23422
23423
23424
23425
23426
23427
23428
23429
23430
23431
23432
23433
23434
23435
23436
23437
23438
23439
23440
23441
23442
23443
23444
23445
23446
23447
23448
23449
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 23375

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[:timePasswordExpiryGreaterThanOrEqualTo] = opts[:time_password_expiry_greater_than_or_equal_to] if opts[:time_password_expiry_greater_than_or_equal_to]
  query_params[:timePasswordExpiryLessThan] = opts[:time_password_expiry_less_than] if opts[:time_password_expiry_less_than]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:compartmentId] = opts[:compartment_id] if opts[:compartment_id]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:schemaList] = OCI::ApiClient.build_collection_params(opts[:schema_list], :multi) if opts[:schema_list] && !opts[:schema_list].empty?
  query_params[:areAllSchemasAccessible] = opts[:are_all_schemas_accessible] if !opts[:are_all_schemas_accessible].nil?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#list_users') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'Array<OCI::DataSafe::Models::UserSummary>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_work_request_errors(work_request_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_work_request_errors API.

Gets a list of errors for the specified work request.

Parameters:

  • work_request_id (String) —

    The OCID of the work request.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :page (String) —

    For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

  • :limit (Integer) —

    For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

Returns:



23470
23471
23472
23473
23474
23475
23476
23477
23478
23479
23480
23481
23482
23483
23484
23485
23486
23487
23488
23489
23490
23491
23492
23493
23494
23495
23496
23497
23498
23499
23500
23501
23502
23503
23504
23505
23506
23507
23508
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 23470

def list_work_request_errors(work_request_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#list_work_request_errors.' if logger

  raise "Missing the required parameter 'work_request_id' when calling list_work_request_errors." if work_request_id.nil?
  raise "Parameter value for 'work_request_id' must not be blank" if OCI::Internal::Util.blank_string?(work_request_id)

  path = '/workRequests/{workRequestId}/errors'.sub('{workRequestId}', work_request_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:limit] = opts[:limit] if opts[:limit]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#list_work_request_errors') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'Array<OCI::DataSafe::Models::WorkRequestError>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_work_request_logs(work_request_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_work_request_logs API.

Gets a list of log entries for the specified work request.

Parameters:

  • work_request_id (String) —

    The OCID of the work request.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :page (String) —

    For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

  • :limit (Integer) —

    For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

Returns:



23529
23530
23531
23532
23533
23534
23535
23536
23537
23538
23539
23540
23541
23542
23543
23544
23545
23546
23547
23548
23549
23550
23551
23552
23553
23554
23555
23556
23557
23558
23559
23560
23561
23562
23563
23564
23565
23566
23567
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 23529

def list_work_request_logs(work_request_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#list_work_request_logs.' if logger

  raise "Missing the required parameter 'work_request_id' when calling list_work_request_logs." if work_request_id.nil?
  raise "Parameter value for 'work_request_id' must not be blank" if OCI::Internal::Util.blank_string?(work_request_id)

  path = '/workRequests/{workRequestId}/logs'.sub('{workRequestId}', work_request_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:limit] = opts[:limit] if opts[:limit]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#list_work_request_logs') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'Array<OCI::DataSafe::Models::WorkRequestLogEntry>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_work_requests(compartment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_work_requests API.

Gets a list of work requests.

Parameters:

  • compartment_id (String) —

    A filter to return only resources that match the specified compartment OCID.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :operation_type (String) —

    A filter to return only work requests that match the specific operation type.

  • :sort_by (String) —

    The field used for sorting. Only one sorting parameter can be specified. The default order is descending. (default to STARTTIME) Allowed values are: STARTTIME, FINISHTIME, ACCEPTEDTIME

  • :sort_order (String) —

    The sorting order for the work requests, either ascending (ASC) or descending (DESC). (default to DESC) Allowed values are: ASC, DESC

  • :resource_id (String) —

    A filter to return only work requests that match the specified resource OCID.

  • :target_database_id (String) —

    A filter to return only work requests that are associated to the specified target database OCID.

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :page (String) —

    For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

  • :limit (Integer) —

    For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

  • :compartment_id_in_subtree (BOOLEAN) —

    Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting. (default to false)

  • :access_level (String) —

    Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed. (default to RESTRICTED) Allowed values are: RESTRICTED, ACCESSIBLE

Returns:



23606
23607
23608
23609
23610
23611
23612
23613
23614
23615
23616
23617
23618
23619
23620
23621
23622
23623
23624
23625
23626
23627
23628
23629
23630
23631
23632
23633
23634
23635
23636
23637
23638
23639
23640
23641
23642
23643
23644
23645
23646
23647
23648
23649
23650
23651
23652
23653
23654
23655
23656
23657
23658
23659
23660
23661
23662
23663
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 23606

def list_work_requests(compartment_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#list_work_requests.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_work_requests." if compartment_id.nil?

  if opts[:sort_by] && !%w[STARTTIME FINISHTIME ACCEPTEDTIME].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of STARTTIME, FINISHTIME, ACCEPTEDTIME.'
  end

  if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of ASC, DESC.'
  end

  if opts[:access_level] && !%w[RESTRICTED ACCESSIBLE].include?(opts[:access_level])
    raise 'Invalid value for "access_level", must be one of RESTRICTED, ACCESSIBLE.'
  end

  path = '/workRequests'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:operationType] = opts[:operation_type] if opts[:operation_type]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:resourceId] = opts[:resource_id] if opts[:resource_id]
  query_params[:targetDatabaseId] = opts[:target_database_id] if opts[:target_database_id]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:compartmentIdInSubtree] = opts[:compartment_id_in_subtree] if !opts[:compartment_id_in_subtree].nil?
  query_params[:accessLevel] = opts[:access_level] if opts[:access_level]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#list_work_requests') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'Array<OCI::DataSafe::Models::WorkRequestSummary>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#logger ⇒ Logger

Returns The logger for this client. May be nil.

Returns:

  • (Logger) —

    The logger for this client. May be nil.



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

Note:

Click here to see an example of how to use mask_data API.

Masks data using the specified masking policy.

Parameters:

  • masking_policy_id (String) —

    The OCID of the masking policy.

  • mask_data_details (OCI::DataSafe::Models::MaskDataDetails) —

    Details to mask data.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:

  • (Response) —

    A Response object with data of type nil



23687
23688
23689
23690
23691
23692
23693
23694
23695
23696
23697
23698
23699
23700
23701
23702
23703
23704
23705
23706
23707
23708
23709
23710
23711
23712
23713
23714
23715
23716
23717
23718
23719
23720
23721
23722
23723
23724
23725
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 23687

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-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(mask_data_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#mask_data') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#modify_global_settings(modify_global_settings_details, compartment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use modify_global_settings API.

Modifies Global Settings in Data Safe in the tenancy and region.

Parameters:

  • modify_global_settings_details (OCI::DataSafe::Models::ModifyGlobalSettingsDetails) —

    The details used to update global settings in Data Safe.

  • compartment_id (String) —

    The OCID of the compartment.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

Returns:

  • (Response) —

    A Response object with data of type nil



23756
23757
23758
23759
23760
23761
23762
23763
23764
23765
23766
23767
23768
23769
23770
23771
23772
23773
23774
23775
23776
23777
23778
23779
23780
23781
23782
23783
23784
23785
23786
23787
23788
23789
23790
23791
23792
23793
23794
23795
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 23756

def modify_global_settings(modify_global_settings_details, compartment_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#modify_global_settings.' if logger

  raise "Missing the required parameter 'modify_global_settings_details' when calling modify_global_settings." if modify_global_settings_details.nil?
  raise "Missing the required parameter 'compartment_id' when calling modify_global_settings." if compartment_id.nil?
  raise "Parameter value for 'compartment_id' must not be blank" if OCI::Internal::Util.blank_string?(compartment_id)

  path = '/configuration/{compartmentId}/actions/modifyGlobalSettings'.sub('{compartmentId}', compartment_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(modify_global_settings_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#modify_global_settings') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#patch_alerts(patch_alerts_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use patch_alerts API.

Updates the status of one or more alert specified by the alert IDs.

Parameters:

  • patch_alerts_details (OCI::DataSafe::Models::PatchAlertsDetails) —

    The alert details to update the status of one or more alert specified by the alert IDs.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :compartment_id_in_subtree (BOOLEAN) —

    Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting. (default to false)

  • :access_level (String) —

    Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed. (default to RESTRICTED) Allowed values are: RESTRICTED, ACCESSIBLE

Returns:

  • (Response) —

    A Response object with data of type nil



23828
23829
23830
23831
23832
23833
23834
23835
23836
23837
23838
23839
23840
23841
23842
23843
23844
23845
23846
23847
23848
23849
23850
23851
23852
23853
23854
23855
23856
23857
23858
23859
23860
23861
23862
23863
23864
23865
23866
23867
23868
23869
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 23828

def patch_alerts(patch_alerts_details, opts = {})
  logger.debug 'Calling operation DataSafeClient#patch_alerts.' if logger

  raise "Missing the required parameter 'patch_alerts_details' when calling patch_alerts." if patch_alerts_details.nil?

  if opts[:access_level] && !%w[RESTRICTED ACCESSIBLE].include?(opts[:access_level])
    raise 'Invalid value for "access_level", must be one of RESTRICTED, ACCESSIBLE.'
  end

  path = '/alerts'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentIdInSubtree] = opts[:compartment_id_in_subtree] if !opts[:compartment_id_in_subtree].nil?
  query_params[:accessLevel] = opts[:access_level] if opts[:access_level]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(patch_alerts_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#patch_alerts') do
    @api_client.call_api(
      :PATCH,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#patch_checks(security_assessment_id, patch_checks_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use patch_checks API.

Patches one or more checks in the specified template type security assessment. Use it to add or delete checks. To add check, use CreateCheckDetails as the patch value.

Parameters:

  • security_assessment_id (String) —

    The OCID of the security assessment.

  • patch_checks_details (OCI::DataSafe::Models::PatchChecksDetails) —

    Details to patch checks.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

Returns:

  • (Response) —

    A Response object with data of type nil



23896
23897
23898
23899
23900
23901
23902
23903
23904
23905
23906
23907
23908
23909
23910
23911
23912
23913
23914
23915
23916
23917
23918
23919
23920
23921
23922
23923
23924
23925
23926
23927
23928
23929
23930
23931
23932
23933
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 23896

def patch_checks(security_assessment_id, patch_checks_details, opts = {})
  logger.debug 'Calling operation DataSafeClient#patch_checks.' if logger

  raise "Missing the required parameter 'security_assessment_id' when calling patch_checks." if security_assessment_id.nil?
  raise "Missing the required parameter 'patch_checks_details' when calling patch_checks." if patch_checks_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}/checks'.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(patch_checks_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#patch_checks') do
    @api_client.call_api(
      :PATCH,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#patch_discovery_job_results(discovery_job_id, patch_discovery_job_result_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use patch_discovery_job_results API.

Patches one or more discovery results. You can use this operation to set the plannedAction attribute before using ApplyDiscoveryJobResults to process the results based on this attribute.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:

  • (Response) —

    A Response object with data of type nil



23960
23961
23962
23963
23964
23965
23966
23967
23968
23969
23970
23971
23972
23973
23974
23975
23976
23977
23978
23979
23980
23981
23982
23983
23984
23985
23986
23987
23988
23989
23990
23991
23992
23993
23994
23995
23996
23997
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 23960

def patch_discovery_job_results(discovery_job_id, patch_discovery_job_result_details, opts = {})
  logger.debug 'Calling operation DataSafeClient#patch_discovery_job_results.' if logger

  raise "Missing the required parameter 'discovery_job_id' when calling patch_discovery_job_results." if discovery_job_id.nil?
  raise "Missing the required parameter 'patch_discovery_job_result_details' when calling patch_discovery_job_results." if patch_discovery_job_result_details.nil?
  raise "Parameter value for 'discovery_job_id' must not be blank" if OCI::Internal::Util.blank_string?(discovery_job_id)

  path = '/discoveryJobs/{discoveryJobId}/results'.sub('{discoveryJobId}', discovery_job_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(patch_discovery_job_result_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#patch_discovery_job_results') do
    @api_client.call_api(
      :PATCH,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#patch_findings(security_assessment_id, patch_findings_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use patch_findings API.

Patches one or more findings in the specified template baseline type security assessment. Use it to modify max allowed risk level in template baseline.

Parameters:

  • security_assessment_id (String) —

    The OCID of the security assessment.

  • patch_findings_details (OCI::DataSafe::Models::PatchFindingsDetails) —

    Details to patch findings.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

Returns:

  • (Response) —

    A Response object with data of type nil



24023
24024
24025
24026
24027
24028
24029
24030
24031
24032
24033
24034
24035
24036
24037
24038
24039
24040
24041
24042
24043
24044
24045
24046
24047
24048
24049
24050
24051
24052
24053
24054
24055
24056
24057
24058
24059
24060
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 24023

def patch_findings(security_assessment_id, patch_findings_details, opts = {})
  logger.debug 'Calling operation DataSafeClient#patch_findings.' if logger

  raise "Missing the required parameter 'security_assessment_id' when calling patch_findings." if security_assessment_id.nil?
  raise "Missing the required parameter 'patch_findings_details' when calling patch_findings." if patch_findings_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}/findings'.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(patch_findings_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#patch_findings') 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_grouped_sensitive_types(sensitive_type_group_id, patch_grouped_sensitive_types_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use patch_grouped_sensitive_types API.

Patches one or more sensitive types in a sensitive type group. You can use this operation to add or remove sensitive type ids in a sensitive type group.

Parameters:

  • sensitive_type_group_id (String) —

    The OCID of the sensitive type group.

  • patch_grouped_sensitive_types_details (OCI::DataSafe::Models::PatchGroupedSensitiveTypesDetails) —

    Details to patch sensitive type ids in a SensitiveTypeGroup.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:

  • (Response) —

    A Response object with data of type nil



24087
24088
24089
24090
24091
24092
24093
24094
24095
24096
24097
24098
24099
24100
24101
24102
24103
24104
24105
24106
24107
24108
24109
24110
24111
24112
24113
24114
24115
24116
24117
24118
24119
24120
24121
24122
24123
24124
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 24087

def patch_grouped_sensitive_types(sensitive_type_group_id, patch_grouped_sensitive_types_details, opts = {})
  logger.debug 'Calling operation DataSafeClient#patch_grouped_sensitive_types.' if logger

  raise "Missing the required parameter 'sensitive_type_group_id' when calling patch_grouped_sensitive_types." if sensitive_type_group_id.nil?
  raise "Missing the required parameter 'patch_grouped_sensitive_types_details' when calling patch_grouped_sensitive_types." if patch_grouped_sensitive_types_details.nil?
  raise "Parameter value for 'sensitive_type_group_id' must not be blank" if OCI::Internal::Util.blank_string?(sensitive_type_group_id)

  path = '/sensitiveTypeGroups/{sensitiveTypeGroupId}/groupedSensitiveTypes'.sub('{sensitiveTypeGroupId}', sensitive_type_group_id.to_s)
  operation_signing_strategy = :standard

  # rubocop: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_grouped_sensitive_types_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#patch_grouped_sensitive_types') do
    @api_client.call_api(
      :PATCH,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#patch_masking_columns(masking_policy_id, patch_masking_columns_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use patch_masking_columns API.

Patches one or more columns in the specified masking policy. Use it to create, or update masking columns. To create masking columns, use CreateMaskingColumnDetails as the patch value. And to update masking columns, use UpdateMaskingColumnDetails as the patch value.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

Returns:

  • (Response) —

    A Response object with data of type nil



24152
24153
24154
24155
24156
24157
24158
24159
24160
24161
24162
24163
24164
24165
24166
24167
24168
24169
24170
24171
24172
24173
24174
24175
24176
24177
24178
24179
24180
24181
24182
24183
24184
24185
24186
24187
24188
24189
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 24152

def patch_masking_columns(masking_policy_id, patch_masking_columns_details, opts = {})
  logger.debug 'Calling operation DataSafeClient#patch_masking_columns.' if logger

  raise "Missing the required parameter 'masking_policy_id' when calling patch_masking_columns." if masking_policy_id.nil?
  raise "Missing the required parameter 'patch_masking_columns_details' when calling patch_masking_columns." if patch_masking_columns_details.nil?
  raise "Parameter value for 'masking_policy_id' must not be blank" if OCI::Internal::Util.blank_string?(masking_policy_id)

  path = '/maskingPolicies/{maskingPolicyId}/maskingColumns'.sub('{maskingPolicyId}', masking_policy_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(patch_masking_columns_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#patch_masking_columns') do
    @api_client.call_api(
      :PATCH,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#patch_sdm_masking_policy_difference_columns(sdm_masking_policy_difference_id, patch_sdm_masking_policy_difference_columns_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use patch_sdm_masking_policy_difference_columns API.

Patches one or more SDM masking policy difference columns. You can use this operation to set the plannedAction attribute before using ApplySdmMaskingPolicyDifference to process the difference based on this attribute.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:

  • (Response) —

    A Response object with data of type nil



24216
24217
24218
24219
24220
24221
24222
24223
24224
24225
24226
24227
24228
24229
24230
24231
24232
24233
24234
24235
24236
24237
24238
24239
24240
24241
24242
24243
24244
24245
24246
24247
24248
24249
24250
24251
24252
24253
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 24216

def patch_sdm_masking_policy_difference_columns(sdm_masking_policy_difference_id, patch_sdm_masking_policy_difference_columns_details, opts = {})
  logger.debug 'Calling operation DataSafeClient#patch_sdm_masking_policy_difference_columns.' if logger

  raise "Missing the required parameter 'sdm_masking_policy_difference_id' when calling patch_sdm_masking_policy_difference_columns." if sdm_masking_policy_difference_id.nil?
  raise "Missing the required parameter 'patch_sdm_masking_policy_difference_columns_details' when calling patch_sdm_masking_policy_difference_columns." if patch_sdm_masking_policy_difference_columns_details.nil?
  raise "Parameter value for 'sdm_masking_policy_difference_id' must not be blank" if OCI::Internal::Util.blank_string?(sdm_masking_policy_difference_id)

  path = '/sdmMaskingPolicyDifferences/{sdmMaskingPolicyDifferenceId}/differenceColumns'.sub('{sdmMaskingPolicyDifferenceId}', sdm_masking_policy_difference_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(patch_sdm_masking_policy_difference_columns_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#patch_sdm_masking_policy_difference_columns') do
    @api_client.call_api(
      :PATCH,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#patch_sensitive_columns(sensitive_data_model_id, patch_sensitive_column_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use patch_sensitive_columns API.

Patches one or more columns in the specified sensitive data model. Use it to create, update, or delete sensitive columns. To create sensitive columns, use CreateSensitiveColumnDetails as the patch value. And to update sensitive columns, use UpdateSensitiveColumnDetails as the patch value.

Parameters:

  • sensitive_data_model_id (String) —

    The OCID of the sensitive data model.

  • patch_sensitive_column_details (OCI::DataSafe::Models::PatchSensitiveColumnDetails) —

    Details to patch sensitive columns.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:

  • (Response) —

    A Response object with data of type nil



24281
24282
24283
24284
24285
24286
24287
24288
24289
24290
24291
24292
24293
24294
24295
24296
24297
24298
24299
24300
24301
24302
24303
24304
24305
24306
24307
24308
24309
24310
24311
24312
24313
24314
24315
24316
24317
24318
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 24281

def patch_sensitive_columns(sensitive_data_model_id, patch_sensitive_column_details, opts = {})
  logger.debug 'Calling operation DataSafeClient#patch_sensitive_columns.' if logger

  raise "Missing the required parameter 'sensitive_data_model_id' when calling patch_sensitive_columns." if sensitive_data_model_id.nil?
  raise "Missing the required parameter 'patch_sensitive_column_details' when calling patch_sensitive_columns." if patch_sensitive_column_details.nil?
  raise "Parameter value for 'sensitive_data_model_id' must not be blank" if OCI::Internal::Util.blank_string?(sensitive_data_model_id)

  path = '/sensitiveDataModels/{sensitiveDataModelId}/sensitiveColumns'.sub('{sensitiveDataModelId}', sensitive_data_model_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(patch_sensitive_column_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#patch_sensitive_columns') do
    @api_client.call_api(
      :PATCH,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#patch_sql_firewall_allowed_sql(patch_sql_firewall_allowed_sql_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use patch_sql_firewall_allowed_sql API.

Delete multiple allowed sqls. You can use this operation to delete one or more allowed sqls. Create and update of multiple allowed sqls is not supported.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

Returns:

  • (Response) —

    A Response object with data of type nil



24344
24345
24346
24347
24348
24349
24350
24351
24352
24353
24354
24355
24356
24357
24358
24359
24360
24361
24362
24363
24364
24365
24366
24367
24368
24369
24370
24371
24372
24373
24374
24375
24376
24377
24378
24379
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 24344

def patch_sql_firewall_allowed_sql(patch_sql_firewall_allowed_sql_details, opts = {})
  logger.debug 'Calling operation DataSafeClient#patch_sql_firewall_allowed_sql.' if logger

  raise "Missing the required parameter 'patch_sql_firewall_allowed_sql_details' when calling patch_sql_firewall_allowed_sql." if patch_sql_firewall_allowed_sql_details.nil?

  path = '/sqlFirewallAllowedSqls'
  operation_signing_strategy = :standard

  # rubocop: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_sql_firewall_allowed_sql_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#patch_sql_firewall_allowed_sql') do
    @api_client.call_api(
      :PATCH,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#patch_target_alert_policy_association(patch_target_alert_policy_association_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use patch_target_alert_policy_association API.

Creates new target-alert policy associations that will be applied on the target database.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

Returns:

  • (Response) —

    A Response object with data of type nil



24404
24405
24406
24407
24408
24409
24410
24411
24412
24413
24414
24415
24416
24417
24418
24419
24420
24421
24422
24423
24424
24425
24426
24427
24428
24429
24430
24431
24432
24433
24434
24435
24436
24437
24438
24439
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 24404

def patch_target_alert_policy_association(patch_target_alert_policy_association_details, opts = {})
  logger.debug 'Calling operation DataSafeClient#patch_target_alert_policy_association.' if logger

  raise "Missing the required parameter 'patch_target_alert_policy_association_details' when calling patch_target_alert_policy_association." if patch_target_alert_policy_association_details.nil?

  path = '/targetAlertPolicyAssociations'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(patch_target_alert_policy_association_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#patch_target_alert_policy_association') do
    @api_client.call_api(
      :PATCH,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#provision_audit_policy(provision_audit_policy_details, audit_policy_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use provision_audit_policy API.

Provision audit policy.

Parameters:

  • provision_audit_policy_details (OCI::DataSafe::Models::ProvisionAuditPolicyDetails) —

    Details for provisioning the given policies on the source target database.

  • audit_policy_id (String) —

    Unique audit policy identifier.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

Returns:

  • (Response) —

    A Response object with data of type nil



24469
24470
24471
24472
24473
24474
24475
24476
24477
24478
24479
24480
24481
24482
24483
24484
24485
24486
24487
24488
24489
24490
24491
24492
24493
24494
24495
24496
24497
24498
24499
24500
24501
24502
24503
24504
24505
24506
24507
24508
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 24469

def provision_audit_policy(provision_audit_policy_details, audit_policy_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#provision_audit_policy.' if logger

  raise "Missing the required parameter 'provision_audit_policy_details' when calling provision_audit_policy." if provision_audit_policy_details.nil?
  raise "Missing the required parameter 'audit_policy_id' when calling provision_audit_policy." if audit_policy_id.nil?
  raise "Parameter value for 'audit_policy_id' must not be blank" if OCI::Internal::Util.blank_string?(audit_policy_id)

  path = '/auditPolicies/{auditPolicyId}/actions/provision'.sub('{auditPolicyId}', audit_policy_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(provision_audit_policy_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#provision_audit_policy') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#purge_sql_collection_logs(sql_collection_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use purge_sql_collection_logs API.

Purge the SQL collection logs for the specified SqlCollection.

Parameters:

  • sql_collection_id (String) —

    The OCID of the SQL collection resource.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

Returns:

  • (Response) —

    A Response object with data of type nil



24537
24538
24539
24540
24541
24542
24543
24544
24545
24546
24547
24548
24549
24550
24551
24552
24553
24554
24555
24556
24557
24558
24559
24560
24561
24562
24563
24564
24565
24566
24567
24568
24569
24570
24571
24572
24573
24574
24575
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 24537

def purge_sql_collection_logs(sql_collection_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#purge_sql_collection_logs.' if logger

  raise "Missing the required parameter 'sql_collection_id' when calling purge_sql_collection_logs." if sql_collection_id.nil?
  raise "Parameter value for 'sql_collection_id' must not be blank" if OCI::Internal::Util.blank_string?(sql_collection_id)

  path = '/sqlCollections/{sqlCollectionId}/actions/purgeLogs'.sub('{sqlCollectionId}', sql_collection_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#purge_sql_collection_logs') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#refresh_database_security_configuration(database_security_config_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use refresh_database_security_configuration API.

Refreshes the specified database security configuration.

Parameters:

  • database_security_config_id (String) —

    The OCID of the database security configuration resource.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

Returns:

  • (Response) —

    A Response object with data of type nil



24604
24605
24606
24607
24608
24609
24610
24611
24612
24613
24614
24615
24616
24617
24618
24619
24620
24621
24622
24623
24624
24625
24626
24627
24628
24629
24630
24631
24632
24633
24634
24635
24636
24637
24638
24639
24640
24641
24642
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 24604

def refresh_database_security_configuration(database_security_config_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#refresh_database_security_configuration.' if logger

  raise "Missing the required parameter 'database_security_config_id' when calling refresh_database_security_configuration." if database_security_config_id.nil?
  raise "Parameter value for 'database_security_config_id' must not be blank" if OCI::Internal::Util.blank_string?(database_security_config_id)

  path = '/databaseSecurityConfigs/{databaseSecurityConfigId}/actions/refresh'.sub('{databaseSecurityConfigId}', database_security_config_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#refresh_database_security_configuration') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#refresh_security_assessment(security_assessment_id, run_security_assessment_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use refresh_security_assessment API.

Runs a security assessment, refreshes the latest assessment, and saves it for future reference. The assessment runs with a securityAssessmentId of type LATEST. Before you start, first call the ListSecurityAssessments operation with filter "type = latest" to get the security assessment id for the target's latest assessment.

Parameters:

  • security_assessment_id (String) —

    The OCID of the security assessment.

  • run_security_assessment_details (OCI::DataSafe::Models::RunSecurityAssessmentDetails) —

    Details to create an on-demand saved security assessment.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

Returns:

  • (Response) —

    A Response object with data of type nil



24674
24675
24676
24677
24678
24679
24680
24681
24682
24683
24684
24685
24686
24687
24688
24689
24690
24691
24692
24693
24694
24695
24696
24697
24698
24699
24700
24701
24702
24703
24704
24705
24706
24707
24708
24709
24710
24711
24712
24713
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 24674

def refresh_security_assessment(security_assessment_id, run_security_assessment_details, opts = {})
  logger.debug 'Calling operation DataSafeClient#refresh_security_assessment.' if logger

  raise "Missing the required parameter 'security_assessment_id' when calling refresh_security_assessment." if security_assessment_id.nil?
  raise "Missing the required parameter 'run_security_assessment_details' when calling refresh_security_assessment." if run_security_assessment_details.nil?
  raise "Parameter value for 'security_assessment_id' must not be blank" if OCI::Internal::Util.blank_string?(security_assessment_id)

  path = '/securityAssessments/{securityAssessmentId}/actions/refresh'.sub('{securityAssessmentId}', security_assessment_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(run_security_assessment_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#refresh_security_assessment') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#refresh_security_policy_deployment(security_policy_deployment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use refresh_security_policy_deployment API.

Retrieve all the security policies from the associated target or target group and refresh the same on Data safe.

Parameters:

  • security_policy_deployment_id (String) —

    The OCID of the security policy deployment resource.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

Returns:

  • (Response) —

    A Response object with data of type nil



24742
24743
24744
24745
24746
24747
24748
24749
24750
24751
24752
24753
24754
24755
24756
24757
24758
24759
24760
24761
24762
24763
24764
24765
24766
24767
24768
24769
24770
24771
24772
24773
24774
24775
24776
24777
24778
24779
24780
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 24742

def refresh_security_policy_deployment(security_policy_deployment_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#refresh_security_policy_deployment.' if logger

  raise "Missing the required parameter 'security_policy_deployment_id' when calling refresh_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}/actions/refresh'.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 = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#refresh_security_policy_deployment') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#refresh_sql_collection_log_insights(sql_collection_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use refresh_sql_collection_log_insights API.

Refresh the specified SQL collection Log Insights.

Parameters:

  • sql_collection_id (String) —

    The OCID of the SQL collection resource.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

Returns:

  • (Response) —

    A Response object with data of type nil



24809
24810
24811
24812
24813
24814
24815
24816
24817
24818
24819
24820
24821
24822
24823
24824
24825
24826
24827
24828
24829
24830
24831
24832
24833
24834
24835
24836
24837
24838
24839
24840
24841
24842
24843
24844
24845
24846
24847
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 24809

def refresh_sql_collection_log_insights(sql_collection_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#refresh_sql_collection_log_insights.' if logger

  raise "Missing the required parameter 'sql_collection_id' when calling refresh_sql_collection_log_insights." if sql_collection_id.nil?
  raise "Parameter value for 'sql_collection_id' must not be blank" if OCI::Internal::Util.blank_string?(sql_collection_id)

  path = '/sqlCollections/{sqlCollectionId}/actions/refreshLogInsights'.sub('{sqlCollectionId}', sql_collection_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#refresh_sql_collection_log_insights') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#refresh_target_database(target_database_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use refresh_target_database API.

Refreshes the Data Safe target database to update it's state.

Parameters:

  • target_database_id (String) —

    The OCID of the Data Safe target database.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:

  • (Response) —

    A Response object with data of type nil



24877
24878
24879
24880
24881
24882
24883
24884
24885
24886
24887
24888
24889
24890
24891
24892
24893
24894
24895
24896
24897
24898
24899
24900
24901
24902
24903
24904
24905
24906
24907
24908
24909
24910
24911
24912
24913
24914
24915
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 24877

def refresh_target_database(target_database_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#refresh_target_database.' if logger

  raise "Missing the required parameter 'target_database_id' when calling refresh_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/refresh'.sub('{targetDatabaseId}', target_database_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#refresh_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

#refresh_user_assessment(user_assessment_id, run_user_assessment_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use refresh_user_assessment API.

Refreshes the latest assessment and saves it for future reference. This operation runs with a userAssessmentId of type LATEST. Before you start, first call the ListUserAssessments operation with filter "type = latest" to get the user assessment ID for the target's latest assessment.

Parameters:

  • user_assessment_id (String) —

    The OCID of the user assessment.

  • run_user_assessment_details (OCI::DataSafe::Models::RunUserAssessmentDetails) —

    The details required to create an on-demand saved user assessment.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

Returns:

  • (Response) —

    A Response object with data of type nil



24948
24949
24950
24951
24952
24953
24954
24955
24956
24957
24958
24959
24960
24961
24962
24963
24964
24965
24966
24967
24968
24969
24970
24971
24972
24973
24974
24975
24976
24977
24978
24979
24980
24981
24982
24983
24984
24985
24986
24987
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 24948

def refresh_user_assessment(user_assessment_id, run_user_assessment_details, opts = {})
  logger.debug 'Calling operation DataSafeClient#refresh_user_assessment.' if logger

  raise "Missing the required parameter 'user_assessment_id' when calling refresh_user_assessment." if user_assessment_id.nil?
  raise "Missing the required parameter 'run_user_assessment_details' when calling refresh_user_assessment." if run_user_assessment_details.nil?
  raise "Parameter value for 'user_assessment_id' must not be blank" if OCI::Internal::Util.blank_string?(user_assessment_id)

  path = '/userAssessments/{userAssessmentId}/actions/refresh'.sub('{userAssessmentId}', user_assessment_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(run_user_assessment_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#refresh_user_assessment') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#remove_schedule_report(report_definition_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use remove_schedule_report API.

Deletes the schedule of a .xls or .pdf report.

Parameters:

  • report_definition_id (String) —

    Unique report definition identifier

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

Returns:

  • (Response) —

    A Response object with data of type nil



25016
25017
25018
25019
25020
25021
25022
25023
25024
25025
25026
25027
25028
25029
25030
25031
25032
25033
25034
25035
25036
25037
25038
25039
25040
25041
25042
25043
25044
25045
25046
25047
25048
25049
25050
25051
25052
25053
25054
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 25016

def remove_schedule_report(report_definition_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#remove_schedule_report.' if logger

  raise "Missing the required parameter 'report_definition_id' when calling remove_schedule_report." if report_definition_id.nil?
  raise "Parameter value for 'report_definition_id' must not be blank" if OCI::Internal::Util.blank_string?(report_definition_id)

  path = '/reportDefinitions/{reportDefinitionId}/actions/removeScheduleReport'.sub('{reportDefinitionId}', report_definition_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#remove_schedule_report') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#remove_security_assessment_template(security_assessment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use remove_security_assessment_template API.

Remove the checks from the template to the specified security assessment.The security assessment provided in the path needs to be of type 'LATEST'.

Parameters:

  • security_assessment_id (String) —

    The OCID of the security assessment.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:

  • (Response) —

    A Response object with data of type nil



25083
25084
25085
25086
25087
25088
25089
25090
25091
25092
25093
25094
25095
25096
25097
25098
25099
25100
25101
25102
25103
25104
25105
25106
25107
25108
25109
25110
25111
25112
25113
25114
25115
25116
25117
25118
25119
25120
25121
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 25083

def remove_security_assessment_template(security_assessment_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#remove_security_assessment_template.' if logger

  raise "Missing the required parameter 'security_assessment_id' when calling remove_security_assessment_template." 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/removeTemplate'.sub('{securityAssessmentId}', security_assessment_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#remove_security_assessment_template') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#resume_audit_trail(audit_trail_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use resume_audit_trail API.

Resumes the specified audit trail once it got stopped.

Parameters:

  • audit_trail_id (String) —

    The OCID of the audit trail.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:

  • (Response) —

    A Response object with data of type nil



25145
25146
25147
25148
25149
25150
25151
25152
25153
25154
25155
25156
25157
25158
25159
25160
25161
25162
25163
25164
25165
25166
25167
25168
25169
25170
25171
25172
25173
25174
25175
25176
25177
25178
25179
25180
25181
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 25145

def resume_audit_trail(audit_trail_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#resume_audit_trail.' if logger

  raise "Missing the required parameter 'audit_trail_id' when calling resume_audit_trail." if audit_trail_id.nil?
  raise "Parameter value for 'audit_trail_id' must not be blank" if OCI::Internal::Util.blank_string?(audit_trail_id)

  path = '/auditTrails/{auditTrailId}/actions/resume'.sub('{auditTrailId}', audit_trail_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#resume_audit_trail') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#resume_work_request(work_request_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use resume_work_request API.

Resume the given work request. Issuing a resume does not guarantee of immediate resume of the work request.

Parameters:

  • work_request_id (String) —

    The OCID of the work request.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

Returns:

  • (Response) —

    A Response object with data of type nil



25211
25212
25213
25214
25215
25216
25217
25218
25219
25220
25221
25222
25223
25224
25225
25226
25227
25228
25229
25230
25231
25232
25233
25234
25235
25236
25237
25238
25239
25240
25241
25242
25243
25244
25245
25246
25247
25248
25249
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 25211

def resume_work_request(work_request_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#resume_work_request.' if logger

  raise "Missing the required parameter 'work_request_id' when calling resume_work_request." if work_request_id.nil?
  raise "Parameter value for 'work_request_id' must not be blank" if OCI::Internal::Util.blank_string?(work_request_id)

  path = '/workRequests/{workRequestId}/actions/resume'.sub('{workRequestId}', work_request_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#resume_work_request') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#retrieve_audit_policies(audit_policy_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use retrieve_audit_policies API.

Retrieves the audit policy details from the source target database.

Parameters:

  • audit_policy_id (String) —

    Unique audit policy identifier.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

Returns:

  • (Response) —

    A Response object with data of type nil



25278
25279
25280
25281
25282
25283
25284
25285
25286
25287
25288
25289
25290
25291
25292
25293
25294
25295
25296
25297
25298
25299
25300
25301
25302
25303
25304
25305
25306
25307
25308
25309
25310
25311
25312
25313
25314
25315
25316
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 25278

def retrieve_audit_policies(audit_policy_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#retrieve_audit_policies.' if logger

  raise "Missing the required parameter 'audit_policy_id' when calling retrieve_audit_policies." if audit_policy_id.nil?
  raise "Parameter value for 'audit_policy_id' must not be blank" if OCI::Internal::Util.blank_string?(audit_policy_id)

  path = '/auditPolicies/{auditPolicyId}/actions/retrieveFromTarget'.sub('{auditPolicyId}', audit_policy_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#retrieve_audit_policies') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#schedule_report(report_definition_id, schedule_report_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use schedule_report API.

Schedules a .xls or .pdf report based on parameters and report definition.

Parameters:

  • report_definition_id (String) —

    Unique report definition identifier

  • schedule_report_details (OCI::DataSafe::Models::ScheduleReportDetails) —

    The details for the audit report schedule. It contains details such as schedule, MIME type .xls/.pdf and number of rows.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

Returns:

  • (Response) —

    A Response object with data of type nil



25346
25347
25348
25349
25350
25351
25352
25353
25354
25355
25356
25357
25358
25359
25360
25361
25362
25363
25364
25365
25366
25367
25368
25369
25370
25371
25372
25373
25374
25375
25376
25377
25378
25379
25380
25381
25382
25383
25384
25385
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 25346

def schedule_report(report_definition_id, schedule_report_details, opts = {})
  logger.debug 'Calling operation DataSafeClient#schedule_report.' if logger

  raise "Missing the required parameter 'report_definition_id' when calling schedule_report." if report_definition_id.nil?
  raise "Missing the required parameter 'schedule_report_details' when calling schedule_report." if schedule_report_details.nil?
  raise "Parameter value for 'report_definition_id' must not be blank" if OCI::Internal::Util.blank_string?(report_definition_id)

  path = '/reportDefinitions/{reportDefinitionId}/actions/scheduleReport'.sub('{reportDefinitionId}', report_definition_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(schedule_report_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#schedule_report') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#set_security_assessment_baseline(security_assessment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use set_security_assessment_baseline API.

Sets the saved security assessment as the baseline in the compartment where the the specified assessment resides. The security assessment needs to be of type 'SAVED'.

Parameters:

  • security_assessment_id (String) —

    The OCID of the security assessment.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :base_line_details (OCI::DataSafe::Models::SecurityAssessmentBaseLineDetails) —

    Details of security assessment that need to be updated while setting the baseline.

Returns:

  • (Response) —

    A Response object with data of type nil



25415
25416
25417
25418
25419
25420
25421
25422
25423
25424
25425
25426
25427
25428
25429
25430
25431
25432
25433
25434
25435
25436
25437
25438
25439
25440
25441
25442
25443
25444
25445
25446
25447
25448
25449
25450
25451
25452
25453
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 25415

def set_security_assessment_baseline(security_assessment_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#set_security_assessment_baseline.' if logger

  raise "Missing the required parameter 'security_assessment_id' when calling set_security_assessment_baseline." if security_assessment_id.nil?
  raise "Parameter value for 'security_assessment_id' must not be blank" if OCI::Internal::Util.blank_string?(security_assessment_id)

  path = '/securityAssessments/{securityAssessmentId}/actions/setBaseline'.sub('{securityAssessmentId}', security_assessment_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(opts[:base_line_details])

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#set_security_assessment_baseline') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#set_user_assessment_baseline(user_assessment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use set_user_assessment_baseline API.

Sets the saved user assessment as the baseline in the compartment where the specified assessment resides. The user assessment needs to be of type 'SAVED'.

Parameters:

  • user_assessment_id (String) —

    The OCID of the user assessment.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :base_line_details (OCI::DataSafe::Models::UserAssessmentBaseLineDetails) —

    Details of user assessment that need to be updated while setting the baseline.

Returns:

  • (Response) —

    A Response object with data of type nil



25483
25484
25485
25486
25487
25488
25489
25490
25491
25492
25493
25494
25495
25496
25497
25498
25499
25500
25501
25502
25503
25504
25505
25506
25507
25508
25509
25510
25511
25512
25513
25514
25515
25516
25517
25518
25519
25520
25521
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 25483

def set_user_assessment_baseline(user_assessment_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#set_user_assessment_baseline.' if logger

  raise "Missing the required parameter 'user_assessment_id' when calling set_user_assessment_baseline." if user_assessment_id.nil?
  raise "Parameter value for 'user_assessment_id' must not be blank" if OCI::Internal::Util.blank_string?(user_assessment_id)

  path = '/userAssessments/{userAssessmentId}/actions/setBaseline'.sub('{userAssessmentId}', user_assessment_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(opts[:base_line_details])

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#set_user_assessment_baseline') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#start_audit_trail(start_audit_trail_details, audit_trail_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use start_audit_trail API.

Starts collection of audit records on the specified audit trail.

Parameters:

  • start_audit_trail_details (OCI::DataSafe::Models::StartAuditTrailDetails) —

    Details for the starting audit.

  • audit_trail_id (String) —

    The OCID of the audit trail.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

Returns:

  • (Response) —

    A Response object with data of type nil



25551
25552
25553
25554
25555
25556
25557
25558
25559
25560
25561
25562
25563
25564
25565
25566
25567
25568
25569
25570
25571
25572
25573
25574
25575
25576
25577
25578
25579
25580
25581
25582
25583
25584
25585
25586
25587
25588
25589
25590
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 25551

def start_audit_trail(start_audit_trail_details, audit_trail_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#start_audit_trail.' if logger

  raise "Missing the required parameter 'start_audit_trail_details' when calling start_audit_trail." if start_audit_trail_details.nil?
  raise "Missing the required parameter 'audit_trail_id' when calling start_audit_trail." if audit_trail_id.nil?
  raise "Parameter value for 'audit_trail_id' must not be blank" if OCI::Internal::Util.blank_string?(audit_trail_id)

  path = '/auditTrails/{auditTrailId}/actions/start'.sub('{auditTrailId}', audit_trail_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(start_audit_trail_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#start_audit_trail') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#start_sql_collection(sql_collection_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use start_sql_collection API.

Start the specified SQL collection.

Parameters:

  • sql_collection_id (String) —

    The OCID of the SQL collection resource.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

Returns:

  • (Response) —

    A Response object with data of type nil



25619
25620
25621
25622
25623
25624
25625
25626
25627
25628
25629
25630
25631
25632
25633
25634
25635
25636
25637
25638
25639
25640
25641
25642
25643
25644
25645
25646
25647
25648
25649
25650
25651
25652
25653
25654
25655
25656
25657
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 25619

def start_sql_collection(sql_collection_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#start_sql_collection.' if logger

  raise "Missing the required parameter 'sql_collection_id' when calling start_sql_collection." if sql_collection_id.nil?
  raise "Parameter value for 'sql_collection_id' must not be blank" if OCI::Internal::Util.blank_string?(sql_collection_id)

  path = '/sqlCollections/{sqlCollectionId}/actions/start'.sub('{sqlCollectionId}', sql_collection_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#start_sql_collection') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#stop_audit_trail(audit_trail_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use stop_audit_trail API.

Stops the specified audit trail.

Parameters:

  • audit_trail_id (String) —

    The OCID of the audit trail.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:

  • (Response) —

    A Response object with data of type nil



25681
25682
25683
25684
25685
25686
25687
25688
25689
25690
25691
25692
25693
25694
25695
25696
25697
25698
25699
25700
25701
25702
25703
25704
25705
25706
25707
25708
25709
25710
25711
25712
25713
25714
25715
25716
25717
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 25681

def stop_audit_trail(audit_trail_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#stop_audit_trail.' if logger

  raise "Missing the required parameter 'audit_trail_id' when calling stop_audit_trail." if audit_trail_id.nil?
  raise "Parameter value for 'audit_trail_id' must not be blank" if OCI::Internal::Util.blank_string?(audit_trail_id)

  path = '/auditTrails/{auditTrailId}/actions/stop'.sub('{auditTrailId}', audit_trail_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#stop_audit_trail') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#stop_sql_collection(sql_collection_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use stop_sql_collection API.

Stops the specified SQL collection.

Parameters:

  • sql_collection_id (String) —

    The OCID of the SQL collection resource.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

Returns:

  • (Response) —

    A Response object with data of type nil



25746
25747
25748
25749
25750
25751
25752
25753
25754
25755
25756
25757
25758
25759
25760
25761
25762
25763
25764
25765
25766
25767
25768
25769
25770
25771
25772
25773
25774
25775
25776
25777
25778
25779
25780
25781
25782
25783
25784
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 25746

def stop_sql_collection(sql_collection_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#stop_sql_collection.' if logger

  raise "Missing the required parameter 'sql_collection_id' when calling stop_sql_collection." if sql_collection_id.nil?
  raise "Parameter value for 'sql_collection_id' must not be blank" if OCI::Internal::Util.blank_string?(sql_collection_id)

  path = '/sqlCollections/{sqlCollectionId}/actions/stop'.sub('{sqlCollectionId}', sql_collection_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#stop_sql_collection') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#suspend_work_request(work_request_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use suspend_work_request API.

Suspend the given work request. Issuing a suspend does not guarantee of a immediate suspend of the work request.

Parameters:

  • work_request_id (String) —

    The OCID of the work request.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

Returns:

  • (Response) —

    A Response object with data of type nil



25814
25815
25816
25817
25818
25819
25820
25821
25822
25823
25824
25825
25826
25827
25828
25829
25830
25831
25832
25833
25834
25835
25836
25837
25838
25839
25840
25841
25842
25843
25844
25845
25846
25847
25848
25849
25850
25851
25852
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 25814

def suspend_work_request(work_request_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#suspend_work_request.' if logger

  raise "Missing the required parameter 'work_request_id' when calling suspend_work_request." if work_request_id.nil?
  raise "Parameter value for 'work_request_id' must not be blank" if OCI::Internal::Util.blank_string?(work_request_id)

  path = '/workRequests/{workRequestId}/actions/suspend'.sub('{workRequestId}', work_request_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#suspend_work_request') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#unset_security_assessment_baseline(security_assessment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use unset_security_assessment_baseline API.

Removes the baseline setting for the saved security assessment associated with the targetId passed via body. If no body or empty body is passed then the baseline settings of all the saved security assessments pertaining to the baseline assessment OCID provided in the path will be removed. Sets the if-match parameter to the value of the etag from a previous GET or POST response for that resource.

Parameters:

  • security_assessment_id (String) —

    The OCID of the security assessment.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :unset_security_assessment_baseline_details (OCI::DataSafe::Models::UnsetSecurityAssessmentBaselineDetails) —

    Details of the target associated with the security assessment for which the user intents to unset the baseline.

Returns:

  • (Response) —

    A Response object with data of type nil



25885
25886
25887
25888
25889
25890
25891
25892
25893
25894
25895
25896
25897
25898
25899
25900
25901
25902
25903
25904
25905
25906
25907
25908
25909
25910
25911
25912
25913
25914
25915
25916
25917
25918
25919
25920
25921
25922
25923
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 25885

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 = @api_client.object_to_http_body(opts[:unset_security_assessment_baseline_details])

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#unset_security_assessment_baseline') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#unset_user_assessment_baseline(user_assessment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use unset_user_assessment_baseline API.

Removes the baseline setting for the saved user assessment associated with the targetId passed via body. If no body or empty body is passed then the baseline settings of all the saved user assessments pertaining to the baseline assessment OCID provided in the path will be removed. Sets the if-match parameter to the value of the etag from a previous GET or POST response for that resource.

Parameters:

  • user_assessment_id (String) —

    The OCID of the user assessment.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :unset_user_assessment_baseline_details (OCI::DataSafe::Models::UnsetUserAssessmentBaselineDetails) —

    Details of the target associated with the user assessment for which the user intents to unset the baseline.

Returns:

  • (Response) —

    A Response object with data of type nil



25956
25957
25958
25959
25960
25961
25962
25963
25964
25965
25966
25967
25968
25969
25970
25971
25972
25973
25974
25975
25976
25977
25978
25979
25980
25981
25982
25983
25984
25985
25986
25987
25988
25989
25990
25991
25992
25993
25994
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 25956

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 = @api_client.object_to_http_body(opts[:unset_user_assessment_baseline_details])

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#unset_user_assessment_baseline') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_alert(alert_id, update_alert_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use update_alert API.

Updates the status of the specified alert.

Parameters:

  • alert_id (String) —

    The OCID of alert.

  • update_alert_details (OCI::DataSafe::Models::UpdateAlertDetails) —

    The details used to update alert status.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:



26019
26020
26021
26022
26023
26024
26025
26026
26027
26028
26029
26030
26031
26032
26033
26034
26035
26036
26037
26038
26039
26040
26041
26042
26043
26044
26045
26046
26047
26048
26049
26050
26051
26052
26053
26054
26055
26056
26057
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 26019

def update_alert(alert_id, update_alert_details, opts = {})
  logger.debug 'Calling operation DataSafeClient#update_alert.' if logger

  raise "Missing the required parameter 'alert_id' when calling update_alert." if alert_id.nil?
  raise "Missing the required parameter 'update_alert_details' when calling update_alert." if update_alert_details.nil?
  raise "Parameter value for 'alert_id' must not be blank" if OCI::Internal::Util.blank_string?(alert_id)

  path = '/alerts/{alertId}'.sub('{alertId}', alert_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(update_alert_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#update_alert') do
    @api_client.call_api(
      :PUT,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataSafe::Models::Alert'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_alert_policy(alert_policy_id, update_alert_policy_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use update_alert_policy API.

Updates the specified alert policy .

Parameters:

  • alert_policy_id (String) —

    The OCID of the alert policy.

  • update_alert_policy_details (OCI::DataSafe::Models::UpdateAlertPolicyDetails) —

    The details used to update the alert policy.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:

  • (Response) —

    A Response object with data of type nil



26082
26083
26084
26085
26086
26087
26088
26089
26090
26091
26092
26093
26094
26095
26096
26097
26098
26099
26100
26101
26102
26103
26104
26105
26106
26107
26108
26109
26110
26111
26112
26113
26114
26115
26116
26117
26118
26119
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 26082

def update_alert_policy(alert_policy_id, update_alert_policy_details, opts = {})
  logger.debug 'Calling operation DataSafeClient#update_alert_policy.' if logger

  raise "Missing the required parameter 'alert_policy_id' when calling update_alert_policy." if alert_policy_id.nil?
  raise "Missing the required parameter 'update_alert_policy_details' when calling update_alert_policy." if update_alert_policy_details.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[:'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_policy_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#update_alert_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_alert_policy_rule(alert_policy_id, rule_key, update_alert_policy_rule_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use update_alert_policy_rule API.

Updates the specified alert policy rule.

Parameters:

  • alert_policy_id (String) —

    The OCID of the alert policy.

  • rule_key (String) —

    The key of the alert policy rule.

  • update_alert_policy_rule_details (OCI::DataSafe::Models::UpdateAlertPolicyRuleDetails) —

    The details used to update the alert policy rule.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:

  • (Response) —

    A Response object with data of type nil



26145
26146
26147
26148
26149
26150
26151
26152
26153
26154
26155
26156
26157
26158
26159
26160
26161
26162
26163
26164
26165
26166
26167
26168
26169
26170
26171
26172
26173
26174
26175
26176
26177
26178
26179
26180
26181
26182
26183
26184
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 26145

def update_alert_policy_rule(alert_policy_id, rule_key, update_alert_policy_rule_details, opts = {})
  logger.debug 'Calling operation DataSafeClient#update_alert_policy_rule.' if logger

  raise "Missing the required parameter 'alert_policy_id' when calling update_alert_policy_rule." if alert_policy_id.nil?
  raise "Missing the required parameter 'rule_key' when calling update_alert_policy_rule." if rule_key.nil?
  raise "Missing the required parameter 'update_alert_policy_rule_details' when calling update_alert_policy_rule." if update_alert_policy_rule_details.nil?
  raise "Parameter value for 'alert_policy_id' must not be blank" if OCI::Internal::Util.blank_string?(alert_policy_id)
  raise "Parameter value for 'rule_key' must not be blank" if OCI::Internal::Util.blank_string?(rule_key)

  path = '/alertPolicies/{alertPolicyId}/rules/{ruleKey}'.sub('{alertPolicyId}', alert_policy_id.to_s).sub('{ruleKey}', rule_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_alert_policy_rule_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#update_alert_policy_rule') 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_attribute_set(attribute_set_id, update_attribute_set_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use update_attribute_set API.

Updates an attribute set.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:

  • (Response) —

    A Response object with data of type nil



26209
26210
26211
26212
26213
26214
26215
26216
26217
26218
26219
26220
26221
26222
26223
26224
26225
26226
26227
26228
26229
26230
26231
26232
26233
26234
26235
26236
26237
26238
26239
26240
26241
26242
26243
26244
26245
26246
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 26209

def update_attribute_set(attribute_set_id, update_attribute_set_details, opts = {})
  logger.debug 'Calling operation DataSafeClient#update_attribute_set.' if logger

  raise "Missing the required parameter 'attribute_set_id' when calling update_attribute_set." if attribute_set_id.nil?
  raise "Missing the required parameter 'update_attribute_set_details' when calling update_attribute_set." if update_attribute_set_details.nil?
  raise "Parameter value for 'attribute_set_id' must not be blank" if OCI::Internal::Util.blank_string?(attribute_set_id)

  path = '/attributeSets/{attributeSetId}'.sub('{attributeSetId}', attribute_set_id.to_s)
  operation_signing_strategy = :standard

  # rubocop: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_attribute_set_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#update_attribute_set') 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_archive_retrieval(audit_archive_retrieval_id, update_audit_archive_retrieval_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use update_audit_archive_retrieval API.

Updates the audit archive retrieval.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:

  • (Response) —

    A Response object with data of type nil



26271
26272
26273
26274
26275
26276
26277
26278
26279
26280
26281
26282
26283
26284
26285
26286
26287
26288
26289
26290
26291
26292
26293
26294
26295
26296
26297
26298
26299
26300
26301
26302
26303
26304
26305
26306
26307
26308
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 26271

def update_audit_archive_retrieval(audit_archive_retrieval_id, update_audit_archive_retrieval_details, opts = {})
  logger.debug 'Calling operation DataSafeClient#update_audit_archive_retrieval.' if logger

  raise "Missing the required parameter 'audit_archive_retrieval_id' when calling update_audit_archive_retrieval." if audit_archive_retrieval_id.nil?
  raise "Missing the required parameter 'update_audit_archive_retrieval_details' when calling update_audit_archive_retrieval." if update_audit_archive_retrieval_details.nil?
  raise "Parameter value for 'audit_archive_retrieval_id' must not be blank" if OCI::Internal::Util.blank_string?(audit_archive_retrieval_id)

  path = '/auditArchiveRetrievals/{auditArchiveRetrievalId}'.sub('{auditArchiveRetrievalId}', audit_archive_retrieval_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(update_audit_archive_retrieval_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#update_audit_archive_retrieval') do
    @api_client.call_api(
      :PUT,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_audit_policy(audit_policy_id, update_audit_policy_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use update_audit_policy API.

Updates the audit policy.

Parameters:

  • audit_policy_id (String) —

    Unique audit policy identifier.

  • update_audit_policy_details (OCI::DataSafe::Models::UpdateAuditPolicyDetails) —

    Details to update the audit policy.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:

  • (Response) —

    A Response object with data of type nil



26333
26334
26335
26336
26337
26338
26339
26340
26341
26342
26343
26344
26345
26346
26347
26348
26349
26350
26351
26352
26353
26354
26355
26356
26357
26358
26359
26360
26361
26362
26363
26364
26365
26366
26367
26368
26369
26370
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 26333

def update_audit_policy(audit_policy_id, update_audit_policy_details, opts = {})
  logger.debug 'Calling operation DataSafeClient#update_audit_policy.' if logger

  raise "Missing the required parameter 'audit_policy_id' when calling update_audit_policy." if audit_policy_id.nil?
  raise "Missing the required parameter 'update_audit_policy_details' when calling update_audit_policy." if update_audit_policy_details.nil?
  raise "Parameter value for 'audit_policy_id' must not be blank" if OCI::Internal::Util.blank_string?(audit_policy_id)

  path = '/auditPolicies/{auditPolicyId}'.sub('{auditPolicyId}', audit_policy_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(update_audit_policy_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#update_audit_policy') do
    @api_client.call_api(
      :PUT,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_audit_profile(audit_profile_id, update_audit_profile_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use update_audit_profile API.

Updates one or more attributes of the specified audit profile.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:

  • (Response) —

    A Response object with data of type nil



26395
26396
26397
26398
26399
26400
26401
26402
26403
26404
26405
26406
26407
26408
26409
26410
26411
26412
26413
26414
26415
26416
26417
26418
26419
26420
26421
26422
26423
26424
26425
26426
26427
26428
26429
26430
26431
26432
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 26395

def update_audit_profile(audit_profile_id, update_audit_profile_details, opts = {})
  logger.debug 'Calling operation DataSafeClient#update_audit_profile.' if logger

  raise "Missing the required parameter 'audit_profile_id' when calling update_audit_profile." if audit_profile_id.nil?
  raise "Missing the required parameter 'update_audit_profile_details' when calling update_audit_profile." if update_audit_profile_details.nil?
  raise "Parameter value for 'audit_profile_id' must not be blank" if OCI::Internal::Util.blank_string?(audit_profile_id)

  path = '/auditProfiles/{auditProfileId}'.sub('{auditProfileId}', audit_profile_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(update_audit_profile_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#update_audit_profile') do
    @api_client.call_api(
      :PUT,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_audit_trail(audit_trail_id, update_audit_trail_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use update_audit_trail API.

Updates one or more attributes of the specified audit trail.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:

  • (Response) —

    A Response object with data of type nil



26457
26458
26459
26460
26461
26462
26463
26464
26465
26466
26467
26468
26469
26470
26471
26472
26473
26474
26475
26476
26477
26478
26479
26480
26481
26482
26483
26484
26485
26486
26487
26488
26489
26490
26491
26492
26493
26494
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 26457

def update_audit_trail(audit_trail_id, update_audit_trail_details, opts = {})
  logger.debug 'Calling operation DataSafeClient#update_audit_trail.' if logger

  raise "Missing the required parameter 'audit_trail_id' when calling update_audit_trail." if audit_trail_id.nil?
  raise "Missing the required parameter 'update_audit_trail_details' when calling update_audit_trail." if update_audit_trail_details.nil?
  raise "Parameter value for 'audit_trail_id' must not be blank" if OCI::Internal::Util.blank_string?(audit_trail_id)

  path = '/auditTrails/{auditTrailId}'.sub('{auditTrailId}', audit_trail_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(update_audit_trail_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#update_audit_trail') do
    @api_client.call_api(
      :PUT,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_data_safe_private_endpoint(data_safe_private_endpoint_id, update_data_safe_private_endpoint_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use update_data_safe_private_endpoint API.

Updates one or more attributes of the specified Data Safe private endpoint.

Parameters:

  • data_safe_private_endpoint_id (String) —

    The OCID of the private endpoint.

  • update_data_safe_private_endpoint_details (OCI::DataSafe::Models::UpdateDataSafePrivateEndpointDetails) —

    The details used to update a Data Safe private endpoint.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:

  • (Response) —

    A Response object with data of type nil



26519
26520
26521
26522
26523
26524
26525
26526
26527
26528
26529
26530
26531
26532
26533
26534
26535
26536
26537
26538
26539
26540
26541
26542
26543
26544
26545
26546
26547
26548
26549
26550
26551
26552
26553
26554
26555
26556
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 26519

def update_data_safe_private_endpoint(data_safe_private_endpoint_id, update_data_safe_private_endpoint_details, opts = {})
  logger.debug 'Calling operation DataSafeClient#update_data_safe_private_endpoint.' if logger

  raise "Missing the required parameter 'data_safe_private_endpoint_id' when calling update_data_safe_private_endpoint." if data_safe_private_endpoint_id.nil?
  raise "Missing the required parameter 'update_data_safe_private_endpoint_details' when calling update_data_safe_private_endpoint." if update_data_safe_private_endpoint_details.nil?
  raise "Parameter value for 'data_safe_private_endpoint_id' must not be blank" if OCI::Internal::Util.blank_string?(data_safe_private_endpoint_id)

  path = '/dataSafePrivateEndpoints/{dataSafePrivateEndpointId}'.sub('{dataSafePrivateEndpointId}', data_safe_private_endpoint_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(update_data_safe_private_endpoint_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#update_data_safe_private_endpoint') do
    @api_client.call_api(
      :PUT,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_database_security_config(database_security_config_id, update_database_security_config_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use update_database_security_config API.

Updates the database security configuration.

Parameters:

  • database_security_config_id (String) —

    The OCID of the database security configuration resource.

  • update_database_security_config_details (OCI::DataSafe::Models::UpdateDatabaseSecurityConfigDetails) —

    Details to update the database security configuration.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:

  • (Response) —

    A Response object with data of type nil



26581
26582
26583
26584
26585
26586
26587
26588
26589
26590
26591
26592
26593
26594
26595
26596
26597
26598
26599
26600
26601
26602
26603
26604
26605
26606
26607
26608
26609
26610
26611
26612
26613
26614
26615
26616
26617
26618
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 26581

def update_database_security_config(database_security_config_id, update_database_security_config_details, opts = {})
  logger.debug 'Calling operation DataSafeClient#update_database_security_config.' if logger

  raise "Missing the required parameter 'database_security_config_id' when calling update_database_security_config." if database_security_config_id.nil?
  raise "Missing the required parameter 'update_database_security_config_details' when calling update_database_security_config." if update_database_security_config_details.nil?
  raise "Parameter value for 'database_security_config_id' must not be blank" if OCI::Internal::Util.blank_string?(database_security_config_id)

  path = '/databaseSecurityConfigs/{databaseSecurityConfigId}'.sub('{databaseSecurityConfigId}', database_security_config_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(update_database_security_config_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#update_database_security_config') do
    @api_client.call_api(
      :PUT,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_finding(security_assessment_id, finding_key, update_finding_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use update_finding API.

Updates one or more attributes of the specified finding.

Parameters:

  • security_assessment_id (String) —

    The OCID of the security assessment.

  • finding_key (String) —

    The unique key that identifies the finding. It is a string and unique within a security assessment.

  • update_finding_details (OCI::DataSafe::Models::UpdateFindingDetails) —

    Details to change risk of a finding.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

Returns:

  • (Response) —

    A Response object with data of type nil



26649
26650
26651
26652
26653
26654
26655
26656
26657
26658
26659
26660
26661
26662
26663
26664
26665
26666
26667
26668
26669
26670
26671
26672
26673
26674
26675
26676
26677
26678
26679
26680
26681
26682
26683
26684
26685
26686
26687
26688
26689
26690
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 26649

def update_finding(security_assessment_id, finding_key, update_finding_details, opts = {})
  logger.debug 'Calling operation DataSafeClient#update_finding.' if logger

  raise "Missing the required parameter 'security_assessment_id' when calling update_finding." if security_assessment_id.nil?
  raise "Missing the required parameter 'finding_key' when calling update_finding." if finding_key.nil?
  raise "Missing the required parameter 'update_finding_details' when calling update_finding." if update_finding_details.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 'finding_key' must not be blank" if OCI::Internal::Util.blank_string?(finding_key)

  path = '/securityAssessments/{securityAssessmentId}/findings/{findingKey}'.sub('{securityAssessmentId}', security_assessment_id.to_s).sub('{findingKey}', finding_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-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(update_finding_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#update_finding') do
    @api_client.call_api(
      :PUT,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_library_masking_format(library_masking_format_id, update_library_masking_format_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use update_library_masking_format API.

Updates one or more attributes of the specified library masking format. Note that updating the formatEntries attribute replaces all the existing masking format entries with the specified format entries.

Parameters:

  • library_masking_format_id (String) —

    The OCID of the library masking format.

  • update_library_masking_format_details (OCI::DataSafe::Models::UpdateLibraryMaskingFormatDetails) —

    Details to update a library masking format.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:

  • (Response) —

    A Response object with data of type nil



26715
26716
26717
26718
26719
26720
26721
26722
26723
26724
26725
26726
26727
26728
26729
26730
26731
26732
26733
26734
26735
26736
26737
26738
26739
26740
26741
26742
26743
26744
26745
26746
26747
26748
26749
26750
26751
26752
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 26715

def update_library_masking_format(library_masking_format_id, update_library_masking_format_details, opts = {})
  logger.debug 'Calling operation DataSafeClient#update_library_masking_format.' if logger

  raise "Missing the required parameter 'library_masking_format_id' when calling update_library_masking_format." if library_masking_format_id.nil?
  raise "Missing the required parameter 'update_library_masking_format_details' when calling update_library_masking_format." if update_library_masking_format_details.nil?
  raise "Parameter value for 'library_masking_format_id' must not be blank" if OCI::Internal::Util.blank_string?(library_masking_format_id)

  path = '/libraryMaskingFormats/{libraryMaskingFormatId}'.sub('{libraryMaskingFormatId}', library_masking_format_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(update_library_masking_format_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#update_library_masking_format') do
    @api_client.call_api(
      :PUT,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_masking_column(masking_column_key, masking_policy_id, update_masking_column_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use update_masking_column API.

Updates one or more attributes of the specified masking column. Note that updating the maskingFormats attribute replaces the currently assigned masking formats with the specified masking formats.

Parameters:

  • masking_column_key (String) —

    The unique key that identifies the masking column. It's numeric and unique within a masking policy.

  • masking_policy_id (String) —

    The OCID of the masking policy.

  • update_masking_column_details (OCI::DataSafe::Models::UpdateMaskingColumnDetails) —

    Details to update a masking column.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:

  • (Response) —

    A Response object with data of type nil



26780
26781
26782
26783
26784
26785
26786
26787
26788
26789
26790
26791
26792
26793
26794
26795
26796
26797
26798
26799
26800
26801
26802
26803
26804
26805
26806
26807
26808
26809
26810
26811
26812
26813
26814
26815
26816
26817
26818
26819
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 26780

def update_masking_column(masking_column_key, masking_policy_id, update_masking_column_details, opts = {})
  logger.debug 'Calling operation DataSafeClient#update_masking_column.' if logger

  raise "Missing the required parameter 'masking_column_key' when calling update_masking_column." if masking_column_key.nil?
  raise "Missing the required parameter 'masking_policy_id' when calling update_masking_column." if masking_policy_id.nil?
  raise "Missing the required parameter 'update_masking_column_details' when calling update_masking_column." if update_masking_column_details.nil?
  raise "Parameter value for 'masking_column_key' must not be blank" if OCI::Internal::Util.blank_string?(masking_column_key)
  raise "Parameter value for 'masking_policy_id' must not be blank" if OCI::Internal::Util.blank_string?(masking_policy_id)

  path = '/maskingPolicies/{maskingPolicyId}/maskingColumns/{maskingColumnKey}'.sub('{maskingColumnKey}', masking_column_key.to_s).sub('{maskingPolicyId}', masking_policy_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(update_masking_column_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#update_masking_column') do
    @api_client.call_api(
      :PUT,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_masking_policy(masking_policy_id, update_masking_policy_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use update_masking_policy API.

Updates one or more attributes of the specified masking policy.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:

  • (Response) —

    A Response object with data of type nil



26844
26845
26846
26847
26848
26849
26850
26851
26852
26853
26854
26855
26856
26857
26858
26859
26860
26861
26862
26863
26864
26865
26866
26867
26868
26869
26870
26871
26872
26873
26874
26875
26876
26877
26878
26879
26880
26881
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 26844

def update_masking_policy(masking_policy_id, update_masking_policy_details, opts = {})
  logger.debug 'Calling operation DataSafeClient#update_masking_policy.' if logger

  raise "Missing the required parameter 'masking_policy_id' when calling update_masking_policy." if masking_policy_id.nil?
  raise "Missing the required parameter 'update_masking_policy_details' when calling update_masking_policy." if update_masking_policy_details.nil?
  raise "Parameter value for 'masking_policy_id' must not be blank" if OCI::Internal::Util.blank_string?(masking_policy_id)

  path = '/maskingPolicies/{maskingPolicyId}'.sub('{maskingPolicyId}', masking_policy_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(update_masking_policy_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#update_masking_policy') do
    @api_client.call_api(
      :PUT,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_on_prem_connector(on_prem_connector_id, update_on_prem_connector_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use update_on_prem_connector API.

Updates one or more attributes of the specified on-premises connector.

Parameters:

  • on_prem_connector_id (String) —

    The OCID of the on-premises connector.

  • update_on_prem_connector_details (OCI::DataSafe::Models::UpdateOnPremConnectorDetails) —

    The details used to update a on-premises connector.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:

  • (Response) —

    A Response object with data of type nil



26906
26907
26908
26909
26910
26911
26912
26913
26914
26915
26916
26917
26918
26919
26920
26921
26922
26923
26924
26925
26926
26927
26928
26929
26930
26931
26932
26933
26934
26935
26936
26937
26938
26939
26940
26941
26942
26943
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 26906

def update_on_prem_connector(on_prem_connector_id, update_on_prem_connector_details, opts = {})
  logger.debug 'Calling operation DataSafeClient#update_on_prem_connector.' if logger

  raise "Missing the required parameter 'on_prem_connector_id' when calling update_on_prem_connector." if on_prem_connector_id.nil?
  raise "Missing the required parameter 'update_on_prem_connector_details' when calling update_on_prem_connector." if update_on_prem_connector_details.nil?
  raise "Parameter value for 'on_prem_connector_id' must not be blank" if OCI::Internal::Util.blank_string?(on_prem_connector_id)

  path = '/onPremConnectors/{onPremConnectorId}'.sub('{onPremConnectorId}', on_prem_connector_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(update_on_prem_connector_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#update_on_prem_connector') do
    @api_client.call_api(
      :PUT,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_on_prem_connector_wallet(update_on_prem_connector_wallet_details, on_prem_connector_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use update_on_prem_connector_wallet API.

Updates the wallet for the specified on-premises connector to a new version.

Parameters:

  • update_on_prem_connector_wallet_details (OCI::DataSafe::Models::UpdateOnPremConnectorWalletDetails) —

    The details used to update an on-premises connector's wallet.

  • on_prem_connector_id (String) —

    The OCID of the on-premises connector.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:

  • (Response) —

    A Response object with data of type nil



26974
26975
26976
26977
26978
26979
26980
26981
26982
26983
26984
26985
26986
26987
26988
26989
26990
26991
26992
26993
26994
26995
26996
26997
26998
26999
27000
27001
27002
27003
27004
27005
27006
27007
27008
27009
27010
27011
27012
27013
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 26974

def update_on_prem_connector_wallet(update_on_prem_connector_wallet_details, on_prem_connector_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#update_on_prem_connector_wallet.' if logger

  raise "Missing the required parameter 'update_on_prem_connector_wallet_details' when calling update_on_prem_connector_wallet." if update_on_prem_connector_wallet_details.nil?
  raise "Missing the required parameter 'on_prem_connector_id' when calling update_on_prem_connector_wallet." if on_prem_connector_id.nil?
  raise "Parameter value for 'on_prem_connector_id' must not be blank" if OCI::Internal::Util.blank_string?(on_prem_connector_id)

  path = '/onPremConnectors/{onPremConnectorId}/wallet'.sub('{onPremConnectorId}', on_prem_connector_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(update_on_prem_connector_wallet_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#update_on_prem_connector_wallet') do
    @api_client.call_api(
      :PUT,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_peer_target_database(target_database_id, peer_target_database_id, update_peer_target_database_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use update_peer_target_database API.

Updates one or more attributes of the specified Data Safe peer target database.

Parameters:

  • target_database_id (String) —

    The OCID of the Data Safe target database.

  • peer_target_database_id (Integer) —

    The unique id of the peer target database.

  • update_peer_target_database_details (OCI::DataSafe::Models::UpdatePeerTargetDatabaseDetails) —

    Database details to be used to update the peer target database.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

Returns:

  • (Response) —

    A Response object with data of type nil



27044
27045
27046
27047
27048
27049
27050
27051
27052
27053
27054
27055
27056
27057
27058
27059
27060
27061
27062
27063
27064
27065
27066
27067
27068
27069
27070
27071
27072
27073
27074
27075
27076
27077
27078
27079
27080
27081
27082
27083
27084
27085
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 27044

def update_peer_target_database(target_database_id, peer_target_database_id, update_peer_target_database_details, opts = {})
  logger.debug 'Calling operation DataSafeClient#update_peer_target_database.' if logger

  raise "Missing the required parameter 'target_database_id' when calling update_peer_target_database." if target_database_id.nil?
  raise "Missing the required parameter 'peer_target_database_id' when calling update_peer_target_database." if peer_target_database_id.nil?
  raise "Missing the required parameter 'update_peer_target_database_details' when calling update_peer_target_database." if update_peer_target_database_details.nil?
  raise "Parameter value for 'target_database_id' must not be blank" if OCI::Internal::Util.blank_string?(target_database_id)
  raise "Parameter value for 'peer_target_database_id' must not be blank" if OCI::Internal::Util.blank_string?(peer_target_database_id)

  path = '/targetDatabases/{targetDatabaseId}/peerTargetDatabases/{peerTargetDatabaseId}'.sub('{targetDatabaseId}', target_database_id.to_s).sub('{peerTargetDatabaseId}', peer_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(update_peer_target_database_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#update_peer_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_report(report_id, update_report_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use update_report API.

Updates the specified report. Only tags can be updated.

Parameters:

  • report_id (String) —

    Unique report identifier

  • update_report_details (OCI::DataSafe::Models::UpdateReportDetails) —

    Details for the modified report.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

Returns:

  • (Response) —

    A Response object with data of type nil



27115
27116
27117
27118
27119
27120
27121
27122
27123
27124
27125
27126
27127
27128
27129
27130
27131
27132
27133
27134
27135
27136
27137
27138
27139
27140
27141
27142
27143
27144
27145
27146
27147
27148
27149
27150
27151
27152
27153
27154
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 27115

def update_report(report_id, update_report_details, opts = {})
  logger.debug 'Calling operation DataSafeClient#update_report.' if logger

  raise "Missing the required parameter 'report_id' when calling update_report." if report_id.nil?
  raise "Missing the required parameter 'update_report_details' when calling update_report." if update_report_details.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[:'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_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#update_report') do
    @api_client.call_api(
      :PUT,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_report_definition(report_definition_id, update_report_definition_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use update_report_definition API.

Updates the specified report definition. Only user created report definition can be updated. Seeded report definitions need to be saved as new report definition first.

Parameters:

  • report_definition_id (String) —

    Unique report definition identifier

  • update_report_definition_details (OCI::DataSafe::Models::UpdateReportDefinitionDetails) —

    Details for the modified report definition.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

Returns:

  • (Response) —

    A Response object with data of type nil



27184
27185
27186
27187
27188
27189
27190
27191
27192
27193
27194
27195
27196
27197
27198
27199
27200
27201
27202
27203
27204
27205
27206
27207
27208
27209
27210
27211
27212
27213
27214
27215
27216
27217
27218
27219
27220
27221
27222
27223
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 27184

def update_report_definition(report_definition_id, update_report_definition_details, opts = {})
  logger.debug 'Calling operation DataSafeClient#update_report_definition.' if logger

  raise "Missing the required parameter 'report_definition_id' when calling update_report_definition." if report_definition_id.nil?
  raise "Missing the required parameter 'update_report_definition_details' when calling update_report_definition." if update_report_definition_details.nil?
  raise "Parameter value for 'report_definition_id' must not be blank" if OCI::Internal::Util.blank_string?(report_definition_id)

  path = '/reportDefinitions/{reportDefinitionId}'.sub('{reportDefinitionId}', report_definition_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(update_report_definition_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#update_report_definition') do
    @api_client.call_api(
      :PUT,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_sdm_masking_policy_difference(sdm_masking_policy_difference_id, update_sdm_masking_policy_difference_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use update_sdm_masking_policy_difference API.

Updates one or more attributes of the specified sdm masking policy difference.

Parameters:

  • sdm_masking_policy_difference_id (String) —

    The OCID of the SDM masking policy difference.

  • update_sdm_masking_policy_difference_details (OCI::DataSafe::Models::UpdateSdmMaskingPolicyDifferenceDetails) —

    Details to update a sdm masking policy difference.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:

  • (Response) —

    A Response object with data of type nil



27248
27249
27250
27251
27252
27253
27254
27255
27256
27257
27258
27259
27260
27261
27262
27263
27264
27265
27266
27267
27268
27269
27270
27271
27272
27273
27274
27275
27276
27277
27278
27279
27280
27281
27282
27283
27284
27285
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 27248

def update_sdm_masking_policy_difference(sdm_masking_policy_difference_id, update_sdm_masking_policy_difference_details, opts = {})
  logger.debug 'Calling operation DataSafeClient#update_sdm_masking_policy_difference.' if logger

  raise "Missing the required parameter 'sdm_masking_policy_difference_id' when calling update_sdm_masking_policy_difference." if sdm_masking_policy_difference_id.nil?
  raise "Missing the required parameter 'update_sdm_masking_policy_difference_details' when calling update_sdm_masking_policy_difference." if update_sdm_masking_policy_difference_details.nil?
  raise "Parameter value for 'sdm_masking_policy_difference_id' must not be blank" if OCI::Internal::Util.blank_string?(sdm_masking_policy_difference_id)

  path = '/sdmMaskingPolicyDifferences/{sdmMaskingPolicyDifferenceId}'.sub('{sdmMaskingPolicyDifferenceId}', sdm_masking_policy_difference_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(update_sdm_masking_policy_difference_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#update_sdm_masking_policy_difference') do
    @api_client.call_api(
      :PUT,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_security_assessment(security_assessment_id, update_security_assessment_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use update_security_assessment API.

Updates one or more attributes of the specified security assessment. This operation allows to update the security assessment displayName, description, or schedule.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

Returns:

  • (Response) —

    A Response object with data of type nil



27311
27312
27313
27314
27315
27316
27317
27318
27319
27320
27321
27322
27323
27324
27325
27326
27327
27328
27329
27330
27331
27332
27333
27334
27335
27336
27337
27338
27339
27340
27341
27342
27343
27344
27345
27346
27347
27348
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 27311

def update_security_assessment(security_assessment_id, update_security_assessment_details, opts = {})
  logger.debug 'Calling operation DataSafeClient#update_security_assessment.' if logger

  raise "Missing the required parameter 'security_assessment_id' when calling update_security_assessment." if security_assessment_id.nil?
  raise "Missing the required parameter 'update_security_assessment_details' when calling update_security_assessment." if update_security_assessment_details.nil?
  raise "Parameter value for 'security_assessment_id' must not be blank" if OCI::Internal::Util.blank_string?(security_assessment_id)

  path = '/securityAssessments/{securityAssessmentId}'.sub('{securityAssessmentId}', security_assessment_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(update_security_assessment_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#update_security_assessment') do
    @api_client.call_api(
      :PUT,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_security_policy(security_policy_id, update_security_policy_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use update_security_policy API.

Updates the security policy.

Parameters:

  • security_policy_id (String) —

    The OCID of the security policy resource.

  • update_security_policy_details (OCI::DataSafe::Models::UpdateSecurityPolicyDetails) —

    Details to update the security policy.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:

  • (Response) —

    A Response object with data of type nil



27373
27374
27375
27376
27377
27378
27379
27380
27381
27382
27383
27384
27385
27386
27387
27388
27389
27390
27391
27392
27393
27394
27395
27396
27397
27398
27399
27400
27401
27402
27403
27404
27405
27406
27407
27408
27409
27410
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 27373

def update_security_policy(security_policy_id, update_security_policy_details, opts = {})
  logger.debug 'Calling operation DataSafeClient#update_security_policy.' if logger

  raise "Missing the required parameter 'security_policy_id' when calling update_security_policy." if security_policy_id.nil?
  raise "Missing the required parameter 'update_security_policy_details' when calling update_security_policy." if update_security_policy_details.nil?
  raise "Parameter value for 'security_policy_id' must not be blank" if OCI::Internal::Util.blank_string?(security_policy_id)

  path = '/securityPolicies/{securityPolicyId}'.sub('{securityPolicyId}', security_policy_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(update_security_policy_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#update_security_policy') do
    @api_client.call_api(
      :PUT,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_security_policy_config(security_policy_config_id, update_security_policy_config_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use update_security_policy_config API.

Updates the security policy configuration.

Parameters:

  • security_policy_config_id (String) —

    The OCID of the security policy configuration resource.

  • update_security_policy_config_details (OCI::DataSafe::Models::UpdateSecurityPolicyConfigDetails) —

    Details to update the security policy configuration.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:

  • (Response) —

    A Response object with data of type nil



27435
27436
27437
27438
27439
27440
27441
27442
27443
27444
27445
27446
27447
27448
27449
27450
27451
27452
27453
27454
27455
27456
27457
27458
27459
27460
27461
27462
27463
27464
27465
27466
27467
27468
27469
27470
27471
27472
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 27435

def update_security_policy_config(security_policy_config_id, update_security_policy_config_details, opts = {})
  logger.debug 'Calling operation DataSafeClient#update_security_policy_config.' if logger

  raise "Missing the required parameter 'security_policy_config_id' when calling update_security_policy_config." if security_policy_config_id.nil?
  raise "Missing the required parameter 'update_security_policy_config_details' when calling update_security_policy_config." if update_security_policy_config_details.nil?
  raise "Parameter value for 'security_policy_config_id' must not be blank" if OCI::Internal::Util.blank_string?(security_policy_config_id)

  path = '/securityPolicyConfigs/{securityPolicyConfigId}'.sub('{securityPolicyConfigId}', security_policy_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_security_policy_config_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#update_security_policy_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_security_policy_deployment(security_policy_deployment_id, update_security_policy_deployment_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use update_security_policy_deployment API.

Updates the security policy deployment.

Parameters:

  • security_policy_deployment_id (String) —

    The OCID of the security policy deployment resource.

  • update_security_policy_deployment_details (OCI::DataSafe::Models::UpdateSecurityPolicyDeploymentDetails) —

    Details to update the security policy deployment.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:

  • (Response) —

    A Response object with data of type nil



27497
27498
27499
27500
27501
27502
27503
27504
27505
27506
27507
27508
27509
27510
27511
27512
27513
27514
27515
27516
27517
27518
27519
27520
27521
27522
27523
27524
27525
27526
27527
27528
27529
27530
27531
27532
27533
27534
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 27497

def update_security_policy_deployment(security_policy_deployment_id, update_security_policy_deployment_details, opts = {})
  logger.debug 'Calling operation DataSafeClient#update_security_policy_deployment.' if logger

  raise "Missing the required parameter 'security_policy_deployment_id' when calling update_security_policy_deployment." if security_policy_deployment_id.nil?
  raise "Missing the required parameter 'update_security_policy_deployment_details' when calling update_security_policy_deployment." if update_security_policy_deployment_details.nil?
  raise "Parameter value for 'security_policy_deployment_id' must not be blank" if OCI::Internal::Util.blank_string?(security_policy_deployment_id)

  path = '/securityPolicyDeployments/{securityPolicyDeploymentId}'.sub('{securityPolicyDeploymentId}', security_policy_deployment_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(update_security_policy_deployment_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#update_security_policy_deployment') do
    @api_client.call_api(
      :PUT,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_sensitive_column(sensitive_data_model_id, sensitive_column_key, update_sensitive_column_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use update_sensitive_column API.

Updates one or more attributes of the specified sensitive column.

Parameters:

  • sensitive_data_model_id (String) —

    The OCID of the sensitive data model.

  • sensitive_column_key (String) —

    The unique key that identifies the sensitive column. It's numeric and unique within a sensitive data model.

  • update_sensitive_column_details (OCI::DataSafe::Models::UpdateSensitiveColumnDetails) —

    Details to update a sensitive column.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:

  • (Response) —

    A Response object with data of type nil



27560
27561
27562
27563
27564
27565
27566
27567
27568
27569
27570
27571
27572
27573
27574
27575
27576
27577
27578
27579
27580
27581
27582
27583
27584
27585
27586
27587
27588
27589
27590
27591
27592
27593
27594
27595
27596
27597
27598
27599
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 27560

def update_sensitive_column(sensitive_data_model_id, sensitive_column_key, update_sensitive_column_details, opts = {})
  logger.debug 'Calling operation DataSafeClient#update_sensitive_column.' if logger

  raise "Missing the required parameter 'sensitive_data_model_id' when calling update_sensitive_column." if sensitive_data_model_id.nil?
  raise "Missing the required parameter 'sensitive_column_key' when calling update_sensitive_column." if sensitive_column_key.nil?
  raise "Missing the required parameter 'update_sensitive_column_details' when calling update_sensitive_column." if update_sensitive_column_details.nil?
  raise "Parameter value for 'sensitive_data_model_id' must not be blank" if OCI::Internal::Util.blank_string?(sensitive_data_model_id)
  raise "Parameter value for 'sensitive_column_key' must not be blank" if OCI::Internal::Util.blank_string?(sensitive_column_key)

  path = '/sensitiveDataModels/{sensitiveDataModelId}/sensitiveColumns/{sensitiveColumnKey}'.sub('{sensitiveDataModelId}', sensitive_data_model_id.to_s).sub('{sensitiveColumnKey}', sensitive_column_key.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(update_sensitive_column_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#update_sensitive_column') do
    @api_client.call_api(
      :PUT,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_sensitive_data_model(sensitive_data_model_id, update_sensitive_data_model_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use update_sensitive_data_model API.

Updates one or more attributes of the specified sensitive data model. Note that updating any attribute of a sensitive data model does not perform data discovery.

Parameters:

  • sensitive_data_model_id (String) —

    The OCID of the sensitive data model.

  • update_sensitive_data_model_details (OCI::DataSafe::Models::UpdateSensitiveDataModelDetails) —

    Details to update a sensitive data model.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:

  • (Response) —

    A Response object with data of type nil



27626
27627
27628
27629
27630
27631
27632
27633
27634
27635
27636
27637
27638
27639
27640
27641
27642
27643
27644
27645
27646
27647
27648
27649
27650
27651
27652
27653
27654
27655
27656
27657
27658
27659
27660
27661
27662
27663
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 27626

def update_sensitive_data_model(sensitive_data_model_id, update_sensitive_data_model_details, opts = {})
  logger.debug 'Calling operation DataSafeClient#update_sensitive_data_model.' if logger

  raise "Missing the required parameter 'sensitive_data_model_id' when calling update_sensitive_data_model." if sensitive_data_model_id.nil?
  raise "Missing the required parameter 'update_sensitive_data_model_details' when calling update_sensitive_data_model." if update_sensitive_data_model_details.nil?
  raise "Parameter value for 'sensitive_data_model_id' must not be blank" if OCI::Internal::Util.blank_string?(sensitive_data_model_id)

  path = '/sensitiveDataModels/{sensitiveDataModelId}'.sub('{sensitiveDataModelId}', sensitive_data_model_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(update_sensitive_data_model_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#update_sensitive_data_model') do
    @api_client.call_api(
      :PUT,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_sensitive_type(sensitive_type_id, update_sensitive_type_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use update_sensitive_type API.

Updates one or more attributes of the specified sensitive type.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:

  • (Response) —

    A Response object with data of type nil



27688
27689
27690
27691
27692
27693
27694
27695
27696
27697
27698
27699
27700
27701
27702
27703
27704
27705
27706
27707
27708
27709
27710
27711
27712
27713
27714
27715
27716
27717
27718
27719
27720
27721
27722
27723
27724
27725
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 27688

def update_sensitive_type(sensitive_type_id, update_sensitive_type_details, opts = {})
  logger.debug 'Calling operation DataSafeClient#update_sensitive_type.' if logger

  raise "Missing the required parameter 'sensitive_type_id' when calling update_sensitive_type." if sensitive_type_id.nil?
  raise "Missing the required parameter 'update_sensitive_type_details' when calling update_sensitive_type." if update_sensitive_type_details.nil?
  raise "Parameter value for 'sensitive_type_id' must not be blank" if OCI::Internal::Util.blank_string?(sensitive_type_id)

  path = '/sensitiveTypes/{sensitiveTypeId}'.sub('{sensitiveTypeId}', sensitive_type_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(update_sensitive_type_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#update_sensitive_type') do
    @api_client.call_api(
      :PUT,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_sensitive_type_group(sensitive_type_group_id, update_sensitive_type_group_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use update_sensitive_type_group API.

Updates one or more attributes of the specified sensitive type group.

Parameters:

  • sensitive_type_group_id (String) —

    The OCID of the sensitive type group.

  • update_sensitive_type_group_details (OCI::DataSafe::Models::UpdateSensitiveTypeGroupDetails) —

    Details used to update the sensitive type group.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

Returns:

  • (Response) —

    A Response object with data of type nil



27750
27751
27752
27753
27754
27755
27756
27757
27758
27759
27760
27761
27762
27763
27764
27765
27766
27767
27768
27769
27770
27771
27772
27773
27774
27775
27776
27777
27778
27779
27780
27781
27782
27783
27784
27785
27786
27787
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 27750

def update_sensitive_type_group(sensitive_type_group_id, update_sensitive_type_group_details, opts = {})
  logger.debug 'Calling operation DataSafeClient#update_sensitive_type_group.' if logger

  raise "Missing the required parameter 'sensitive_type_group_id' when calling update_sensitive_type_group." if sensitive_type_group_id.nil?
  raise "Missing the required parameter 'update_sensitive_type_group_details' when calling update_sensitive_type_group." if update_sensitive_type_group_details.nil?
  raise "Parameter value for 'sensitive_type_group_id' must not be blank" if OCI::Internal::Util.blank_string?(sensitive_type_group_id)

  path = '/sensitiveTypeGroups/{sensitiveTypeGroupId}'.sub('{sensitiveTypeGroupId}', sensitive_type_group_id.to_s)
  operation_signing_strategy = :standard

  # rubocop: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_sensitive_type_group_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#update_sensitive_type_group') 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_types_export(sensitive_types_export_id, update_sensitive_types_export_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use update_sensitive_types_export API.

Updates one or more attributes of the specified sensitive types export.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:

  • (Response) —

    A Response object with data of type nil



27812
27813
27814
27815
27816
27817
27818
27819
27820
27821
27822
27823
27824
27825
27826
27827
27828
27829
27830
27831
27832
27833
27834
27835
27836
27837
27838
27839
27840
27841
27842
27843
27844
27845
27846
27847
27848
27849
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 27812

def update_sensitive_types_export(sensitive_types_export_id, update_sensitive_types_export_details, opts = {})
  logger.debug 'Calling operation DataSafeClient#update_sensitive_types_export.' if logger

  raise "Missing the required parameter 'sensitive_types_export_id' when calling update_sensitive_types_export." if sensitive_types_export_id.nil?
  raise "Missing the required parameter 'update_sensitive_types_export_details' when calling update_sensitive_types_export." if update_sensitive_types_export_details.nil?
  raise "Parameter value for 'sensitive_types_export_id' must not be blank" if OCI::Internal::Util.blank_string?(sensitive_types_export_id)

  path = '/sensitiveTypesExports/{sensitiveTypesExportId}'.sub('{sensitiveTypesExportId}', sensitive_types_export_id.to_s)
  operation_signing_strategy = :standard

  # rubocop: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_types_export_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#update_sensitive_types_export') do
    @api_client.call_api(
      :PUT,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_sql_collection(sql_collection_id, update_sql_collection_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use update_sql_collection API.

Updates the SQL collection.

Parameters:

  • sql_collection_id (String) —

    The OCID of the SQL collection resource.

  • update_sql_collection_details (OCI::DataSafe::Models::UpdateSqlCollectionDetails) —

    Details to update the SQL collection.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:

  • (Response) —

    A Response object with data of type nil



27874
27875
27876
27877
27878
27879
27880
27881
27882
27883
27884
27885
27886
27887
27888
27889
27890
27891
27892
27893
27894
27895
27896
27897
27898
27899
27900
27901
27902
27903
27904
27905
27906
27907
27908
27909
27910
27911
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 27874

def update_sql_collection(sql_collection_id, update_sql_collection_details, opts = {})
  logger.debug 'Calling operation DataSafeClient#update_sql_collection.' if logger

  raise "Missing the required parameter 'sql_collection_id' when calling update_sql_collection." if sql_collection_id.nil?
  raise "Missing the required parameter 'update_sql_collection_details' when calling update_sql_collection." if update_sql_collection_details.nil?
  raise "Parameter value for 'sql_collection_id' must not be blank" if OCI::Internal::Util.blank_string?(sql_collection_id)

  path = '/sqlCollections/{sqlCollectionId}'.sub('{sqlCollectionId}', sql_collection_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(update_sql_collection_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#update_sql_collection') do
    @api_client.call_api(
      :PUT,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_sql_firewall_policy(sql_firewall_policy_id, update_sql_firewall_policy_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use update_sql_firewall_policy API.

Updates the SQL Firewall policy.

Parameters:

  • sql_firewall_policy_id (String) —

    The OCID of the SQL Firewall policy resource.

  • update_sql_firewall_policy_details (OCI::DataSafe::Models::UpdateSqlFirewallPolicyDetails) —

    Details to update the SQL Firewall policy.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:

  • (Response) —

    A Response object with data of type nil



27936
27937
27938
27939
27940
27941
27942
27943
27944
27945
27946
27947
27948
27949
27950
27951
27952
27953
27954
27955
27956
27957
27958
27959
27960
27961
27962
27963
27964
27965
27966
27967
27968
27969
27970
27971
27972
27973
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 27936

def update_sql_firewall_policy(sql_firewall_policy_id, update_sql_firewall_policy_details, opts = {})
  logger.debug 'Calling operation DataSafeClient#update_sql_firewall_policy.' if logger

  raise "Missing the required parameter 'sql_firewall_policy_id' when calling update_sql_firewall_policy." if sql_firewall_policy_id.nil?
  raise "Missing the required parameter 'update_sql_firewall_policy_details' when calling update_sql_firewall_policy." if update_sql_firewall_policy_details.nil?
  raise "Parameter value for 'sql_firewall_policy_id' must not be blank" if OCI::Internal::Util.blank_string?(sql_firewall_policy_id)

  path = '/sqlFirewallPolicies/{sqlFirewallPolicyId}'.sub('{sqlFirewallPolicyId}', sql_firewall_policy_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(update_sql_firewall_policy_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#update_sql_firewall_policy') do
    @api_client.call_api(
      :PUT,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_target_alert_policy_association(target_alert_policy_association_id, update_target_alert_policy_association_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use update_target_alert_policy_association API.

Updates the specified target-alert policy association.

Parameters:

  • target_alert_policy_association_id (String) —

    The OCID of the target-alert policy association.

  • update_target_alert_policy_association_details (OCI::DataSafe::Models::UpdateTargetAlertPolicyAssociationDetails) —

    The details used to update the target-alert policy association.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:

  • (Response) —

    A Response object with data of type nil



27998
27999
28000
28001
28002
28003
28004
28005
28006
28007
28008
28009
28010
28011
28012
28013
28014
28015
28016
28017
28018
28019
28020
28021
28022
28023
28024
28025
28026
28027
28028
28029
28030
28031
28032
28033
28034
28035
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 27998

def update_target_alert_policy_association(target_alert_policy_association_id, update_target_alert_policy_association_details, opts = {})
  logger.debug 'Calling operation DataSafeClient#update_target_alert_policy_association.' if logger

  raise "Missing the required parameter 'target_alert_policy_association_id' when calling update_target_alert_policy_association." if target_alert_policy_association_id.nil?
  raise "Missing the required parameter 'update_target_alert_policy_association_details' when calling update_target_alert_policy_association." if update_target_alert_policy_association_details.nil?
  raise "Parameter value for 'target_alert_policy_association_id' must not be blank" if OCI::Internal::Util.blank_string?(target_alert_policy_association_id)

  path = '/targetAlertPolicyAssociations/{targetAlertPolicyAssociationId}'.sub('{targetAlertPolicyAssociationId}', target_alert_policy_association_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(update_target_alert_policy_association_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#update_target_alert_policy_association') do
    @api_client.call_api(
      :PUT,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_target_database(target_database_id, update_target_database_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use update_target_database API.

Updates one or more attributes of the specified Data Safe target database.

Parameters:

  • target_database_id (String) —

    The OCID of the Data Safe target database.

  • update_target_database_details (OCI::DataSafe::Models::UpdateTargetDatabaseDetails) —

    Details used to update the target database in Data Safe.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

Returns:

  • (Response) —

    A Response object with data of type nil



28065
28066
28067
28068
28069
28070
28071
28072
28073
28074
28075
28076
28077
28078
28079
28080
28081
28082
28083
28084
28085
28086
28087
28088
28089
28090
28091
28092
28093
28094
28095
28096
28097
28098
28099
28100
28101
28102
28103
28104
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 28065

def update_target_database(target_database_id, update_target_database_details, opts = {})
  logger.debug 'Calling operation DataSafeClient#update_target_database.' if logger

  raise "Missing the required parameter 'target_database_id' when calling update_target_database." if target_database_id.nil?
  raise "Missing the required parameter 'update_target_database_details' when calling update_target_database." if update_target_database_details.nil?
  raise "Parameter value for 'target_database_id' must not be blank" if OCI::Internal::Util.blank_string?(target_database_id)

  path = '/targetDatabases/{targetDatabaseId}'.sub('{targetDatabaseId}', target_database_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(update_target_database_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#update_target_database') do
    @api_client.call_api(
      :PUT,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_target_database_group(target_database_group_id, update_target_database_group_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use update_target_database_group API.

Updates one or more attributes of the specified target database group.

Parameters:

  • target_database_group_id (String) —

    The OCID of the specified target database group.

  • update_target_database_group_details (OCI::DataSafe::Models::UpdateTargetDatabaseGroupDetails) —

    Details used to update the target database group.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

Returns:

  • (Response) —

    A Response object with data of type nil



28134
28135
28136
28137
28138
28139
28140
28141
28142
28143
28144
28145
28146
28147
28148
28149
28150
28151
28152
28153
28154
28155
28156
28157
28158
28159
28160
28161
28162
28163
28164
28165
28166
28167
28168
28169
28170
28171
28172
28173
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 28134

def update_target_database_group(target_database_group_id, update_target_database_group_details, opts = {})
  logger.debug 'Calling operation DataSafeClient#update_target_database_group.' if logger

  raise "Missing the required parameter 'target_database_group_id' when calling update_target_database_group." if target_database_group_id.nil?
  raise "Missing the required parameter 'update_target_database_group_details' when calling update_target_database_group." if update_target_database_group_details.nil?
  raise "Parameter value for 'target_database_group_id' must not be blank" if OCI::Internal::Util.blank_string?(target_database_group_id)

  path = '/targetDatabaseGroups/{targetDatabaseGroupId}'.sub('{targetDatabaseGroupId}', target_database_group_id.to_s)
  operation_signing_strategy = :standard

  # rubocop: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_group_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#update_target_database_group') 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_unified_audit_policy(unified_audit_policy_id, update_unified_audit_policy_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use update_unified_audit_policy API.

Updates the Unified Audit policy.

Parameters:

  • unified_audit_policy_id (String) —

    The OCID of the Unified Audit policy resource.

  • update_unified_audit_policy_details (OCI::DataSafe::Models::UpdateUnifiedAuditPolicyDetails) —

    Details required to update the Unified Audit policy.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:

  • (Response) —

    A Response object with data of type nil



28198
28199
28200
28201
28202
28203
28204
28205
28206
28207
28208
28209
28210
28211
28212
28213
28214
28215
28216
28217
28218
28219
28220
28221
28222
28223
28224
28225
28226
28227
28228
28229
28230
28231
28232
28233
28234
28235
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 28198

def update_unified_audit_policy(unified_audit_policy_id, update_unified_audit_policy_details, opts = {})
  logger.debug 'Calling operation DataSafeClient#update_unified_audit_policy.' if logger

  raise "Missing the required parameter 'unified_audit_policy_id' when calling update_unified_audit_policy." if unified_audit_policy_id.nil?
  raise "Missing the required parameter 'update_unified_audit_policy_details' when calling update_unified_audit_policy." if update_unified_audit_policy_details.nil?
  raise "Parameter value for 'unified_audit_policy_id' must not be blank" if OCI::Internal::Util.blank_string?(unified_audit_policy_id)

  path = '/unifiedAuditPolicies/{unifiedAuditPolicyId}'.sub('{unifiedAuditPolicyId}', unified_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_unified_audit_policy_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#update_unified_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_unified_audit_policy_definition(unified_audit_policy_definition_id, update_unified_audit_policy_definition_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use update_unified_audit_policy_definition API.

Updates the unified audit policy definition.

Parameters:

  • unified_audit_policy_definition_id (String) —

    The OCID of the unified audit policy definition resource.

  • update_unified_audit_policy_definition_details (OCI::DataSafe::Models::UpdateUnifiedAuditPolicyDefinitionDetails) —

    Details to update the unified audit policy definition.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:

  • (Response) —

    A Response object with data of type nil



28260
28261
28262
28263
28264
28265
28266
28267
28268
28269
28270
28271
28272
28273
28274
28275
28276
28277
28278
28279
28280
28281
28282
28283
28284
28285
28286
28287
28288
28289
28290
28291
28292
28293
28294
28295
28296
28297
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 28260

def update_unified_audit_policy_definition(unified_audit_policy_definition_id, update_unified_audit_policy_definition_details, opts = {})
  logger.debug 'Calling operation DataSafeClient#update_unified_audit_policy_definition.' if logger

  raise "Missing the required parameter 'unified_audit_policy_definition_id' when calling update_unified_audit_policy_definition." if unified_audit_policy_definition_id.nil?
  raise "Missing the required parameter 'update_unified_audit_policy_definition_details' when calling update_unified_audit_policy_definition." if update_unified_audit_policy_definition_details.nil?
  raise "Parameter value for 'unified_audit_policy_definition_id' must not be blank" if OCI::Internal::Util.blank_string?(unified_audit_policy_definition_id)

  path = '/unifiedAuditPolicyDefinitions/{unifiedAuditPolicyDefinitionId}'.sub('{unifiedAuditPolicyDefinitionId}', unified_audit_policy_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 = @api_client.object_to_http_body(update_unified_audit_policy_definition_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#update_unified_audit_policy_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_user_assessment(user_assessment_id, update_user_assessment_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use update_user_assessment API.

Updates one or more attributes of the specified user assessment. This operation allows to update the user assessment displayName, description, or schedule.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    Unique identifier for the request.

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

Returns:

  • (Response) —

    A Response object with data of type nil



28323
28324
28325
28326
28327
28328
28329
28330
28331
28332
28333
28334
28335
28336
28337
28338
28339
28340
28341
28342
28343
28344
28345
28346
28347
28348
28349
28350
28351
28352
28353
28354
28355
28356
28357
28358
28359
28360
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 28323

def update_user_assessment(user_assessment_id, update_user_assessment_details, opts = {})
  logger.debug 'Calling operation DataSafeClient#update_user_assessment.' if logger

  raise "Missing the required parameter 'user_assessment_id' when calling update_user_assessment." if user_assessment_id.nil?
  raise "Missing the required parameter 'update_user_assessment_details' when calling update_user_assessment." if update_user_assessment_details.nil?
  raise "Parameter value for 'user_assessment_id' must not be blank" if OCI::Internal::Util.blank_string?(user_assessment_id)

  path = '/userAssessments/{userAssessmentId}'.sub('{userAssessmentId}', user_assessment_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(update_user_assessment_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#update_user_assessment') do
    @api_client.call_api(
      :PUT,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#upload_masking_policy(upload_masking_policy_details, masking_policy_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use upload_masking_policy API.

Uploads a masking policy file (also called template) to update the specified masking policy. To create a new masking policy using a file, first use the CreateMaskingPolicy operation to create an empty masking policy and then use this endpoint to upload the masking policy file. Note that the upload operation replaces the content of the specified masking policy, including all the existing columns and masking formats, with the content of the file.

Parameters:

  • upload_masking_policy_details (String, IO) —

    Details to upload a masking policy file.

  • masking_policy_id (String) —

    The OCID of the masking policy.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:

  • (Response) —

    A Response object with data of type nil



28390
28391
28392
28393
28394
28395
28396
28397
28398
28399
28400
28401
28402
28403
28404
28405
28406
28407
28408
28409
28410
28411
28412
28413
28414
28415
28416
28417
28418
28419
28420
28421
28422
28423
28424
28425
28426
28427
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 28390

def upload_masking_policy(upload_masking_policy_details, masking_policy_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#upload_masking_policy.' if logger

  raise "Missing the required parameter 'upload_masking_policy_details' when calling upload_masking_policy." if upload_masking_policy_details.nil?
  raise "Missing the required parameter 'masking_policy_id' when calling upload_masking_policy." if masking_policy_id.nil?
  raise "Parameter value for 'masking_policy_id' must not be blank" if OCI::Internal::Util.blank_string?(masking_policy_id)

  path = '/maskingPolicies/{maskingPolicyId}/actions/upload'.sub('{maskingPolicyId}', masking_policy_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf
  header_params[:'content-type'] ||= 'application/octet-stream'

  post_body = @api_client.object_to_http_body(upload_masking_policy_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#upload_masking_policy') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#upload_sensitive_data_model(sensitive_data_model_id, upload_sensitive_data_model_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use upload_sensitive_data_model API.

Uploads a sensitive data model file (also called template) to update the specified sensitive data model. To create a new sensitive data model using a file, first use the CreateSensitiveDataModel operation to create an empty data model and then use this endpoint to upload the data model file. Note that the upload operation replaces the content of the specified sensitive data model, including all the existing columns and their relationships, with the content of the file.

Parameters:

  • sensitive_data_model_id (String) —

    The OCID of the sensitive data model.

  • upload_sensitive_data_model_details (String, IO) —

    Details to upload a sensitive data model file.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    Unique identifier for the request.

Returns:

  • (Response) —

    A Response object with data of type nil



28456
28457
28458
28459
28460
28461
28462
28463
28464
28465
28466
28467
28468
28469
28470
28471
28472
28473
28474
28475
28476
28477
28478
28479
28480
28481
28482
28483
28484
28485
28486
28487
28488
28489
28490
28491
28492
28493
 
# File 'lib/oci/data_safe/data_safe_client.rb', line 28456

def upload_sensitive_data_model(sensitive_data_model_id, upload_sensitive_data_model_details, opts = {})
  logger.debug 'Calling operation DataSafeClient#upload_sensitive_data_model.' if logger

  raise "Missing the required parameter 'sensitive_data_model_id' when calling upload_sensitive_data_model." if sensitive_data_model_id.nil?
  raise "Missing the required parameter 'upload_sensitive_data_model_details' when calling upload_sensitive_data_model." if upload_sensitive_data_model_details.nil?
  raise "Parameter value for 'sensitive_data_model_id' must not be blank" if OCI::Internal::Util.blank_string?(sensitive_data_model_id)

  path = '/sensitiveDataModels/{sensitiveDataModelId}/actions/upload'.sub('{sensitiveDataModelId}', sensitive_data_model_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf
  header_params[:'content-type'] ||= 'application/octet-stream'

  post_body = @api_client.object_to_http_body(upload_sensitive_data_model_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#upload_sensitive_data_model') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end