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_clientOCI::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

#endpointString (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

#regionString

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_configOCI::Retry::RetryConfig (readonly)

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



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

def retry_config
  @retry_config
end

Instance Method Details

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

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

#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



479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
# File 'lib/oci/data_safe/data_safe_client.rb', line 479

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

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

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

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

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

  post_body = @api_client.object_to_http_body(calculate_audit_volume_available_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.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



548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
# File 'lib/oci/data_safe/data_safe_client.rb', line 548

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

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

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

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

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

  post_body = @api_client.object_to_http_body(calculate_audit_volume_collected_details)

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

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

Note:

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

Cancel the specified work request.

Parameters:

  • work_request_id (String)

    The OCID of the work request.

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

    the optional parameters

Options Hash (opts):

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

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

  • :opc_retry_token (String)

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

  • :opc_request_id (String)

    Unique identifier for the request.

  • :if_match (String)

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

Returns:

  • (Response)

    A Response object with data of type nil



617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
# File 'lib/oci/data_safe/data_safe_client.rb', line 617

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

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

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

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

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

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.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



685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
# File 'lib/oci/data_safe/data_safe_client.rb', line 685

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

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

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

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

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

  post_body = @api_client.object_to_http_body(change_alert_compartment_details)

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

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

Note:

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

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

Parameters:

Options Hash (opts):

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

    The retry configuration to apply to this operation. If no key is provided then the 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



755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
# File 'lib/oci/data_safe/data_safe_client.rb', line 755

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

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

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

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

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

  post_body = @api_client.object_to_http_body(change_audit_archive_retrieval_compartment_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.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



824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
# File 'lib/oci/data_safe/data_safe_client.rb', line 824

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

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

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

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

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

  post_body = @api_client.object_to_http_body(change_audit_policy_compartment_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.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



893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
# File 'lib/oci/data_safe/data_safe_client.rb', line 893

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

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

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

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

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

  post_body = @api_client.object_to_http_body(change_audit_profile_compartment_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.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



957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
# File 'lib/oci/data_safe/data_safe_client.rb', line 957

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

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

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

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

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

  post_body = @api_client.object_to_http_body(change_data_safe_private_endpoint_compartment_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.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



1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
# File 'lib/oci/data_safe/data_safe_client.rb', line 1024

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

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

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

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

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

  post_body = @api_client.object_to_http_body(change_database_security_config_compartment_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.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



1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
# File 'lib/oci/data_safe/data_safe_client.rb', line 1093

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

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

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

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

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

  post_body = @api_client.object_to_http_body(change_discovery_job_compartment_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.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



1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
# File 'lib/oci/data_safe/data_safe_client.rb', line 1162

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

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

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

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

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

  post_body = @api_client.object_to_http_body(change_library_masking_format_compartment_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.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



1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
# File 'lib/oci/data_safe/data_safe_client.rb', line 1231

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

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

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

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

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

  post_body = @api_client.object_to_http_body(change_masking_policy_compartment_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.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



1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
# File 'lib/oci/data_safe/data_safe_client.rb', line 1300

def change_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



1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
# File 'lib/oci/data_safe/data_safe_client.rb', line 1369

def change_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



1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
# File 'lib/oci/data_safe/data_safe_client.rb', line 1438

def change_report_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



1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
# File 'lib/oci/data_safe/data_safe_client.rb', line 1507

def change_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



1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
# File 'lib/oci/data_safe/data_safe_client.rb', line 1576

def change_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



1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
# File 'lib/oci/data_safe/data_safe_client.rb', line 1645

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



1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
# File 'lib/oci/data_safe/data_safe_client.rb', line 1719

def change_security_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



1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
# File 'lib/oci/data_safe/data_safe_client.rb', line 1788

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

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

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

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

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

  post_body = @api_client.object_to_http_body(change_security_policy_compartment_details)

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

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

Note:

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

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

Parameters:

Options Hash (opts):

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

    The retry configuration to apply to this operation. If no key is provided then the 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



1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
# File 'lib/oci/data_safe/data_safe_client.rb', line 1857

def change_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



1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
# File 'lib/oci/data_safe/data_safe_client.rb', line 1926

def change_sensitive_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



1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
# File 'lib/oci/data_safe/data_safe_client.rb', line 1995

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

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

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

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

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

  post_body = @api_client.object_to_http_body(change_sensitive_type_compartment_details)

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

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

Note:

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

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

Parameters:

Options Hash (opts):

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

    The retry configuration to apply to this operation. If no key is provided then the 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



2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
# File 'lib/oci/data_safe/data_safe_client.rb', line 2064

def change_sql_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



2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
# File 'lib/oci/data_safe/data_safe_client.rb', line 2133

def change_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



2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
# File 'lib/oci/data_safe/data_safe_client.rb', line 2202

def change_target_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



2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
# File 'lib/oci/data_safe/data_safe_client.rb', line 2271

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

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

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

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

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

  post_body = @api_client.object_to_http_body(change_target_database_compartment_details)

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

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

Note:

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

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

Parameters:

Options Hash (opts):

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

    The retry configuration to apply to this operation. If no key is provided then the 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



2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
# File 'lib/oci/data_safe/data_safe_client.rb', line 2345

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



2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
# File 'lib/oci/data_safe/data_safe_client.rb', line 2416

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

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

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

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

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

  post_body = @api_client.object_to_http_body(compare_security_assessment_details)

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

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

Note:

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

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

Parameters:

  • user_assessment_id (String)

    The OCID of the user assessment.

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

    Details of the user assessment comparison.

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

    the optional parameters

Options Hash (opts):

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

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

  • :opc_retry_token (String)

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

  • :opc_request_id (String)

    Unique identifier for the request.

  • :if_match (String)

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

Returns:

  • (Response)

    A Response object with data of type nil



2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
# File 'lib/oci/data_safe/data_safe_client.rb', line 2487

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

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

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

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

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

  post_body = @api_client.object_to_http_body(compare_user_assessment_details)

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

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

Note:

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

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

Parameters:

Options Hash (opts):

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

    The retry configuration to apply to this operation. If no key is provided then the 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:



2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
# File 'lib/oci/data_safe/data_safe_client.rb', line 2552

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

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

  path = '/auditArchiveRetrievals'
  operation_signing_strategy = :standard

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

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

  post_body = @api_client.object_to_http_body(create_audit_archive_retrieval_details)

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

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

Note:

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

Creates a new Data Safe private endpoint.

Parameters:

Options Hash (opts):

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

    The retry configuration to apply to this operation. If no key is provided then the 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:



2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
# File 'lib/oci/data_safe/data_safe_client.rb', line 2613

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:



2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
# File 'lib/oci/data_safe/data_safe_client.rb', line 2678

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:



2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
# File 'lib/oci/data_safe/data_safe_client.rb', line 2743

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



2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
# File 'lib/oci/data_safe/data_safe_client.rb', line 2824

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:



2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
# File 'lib/oci/data_safe/data_safe_client.rb', line 2902

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:



2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
# File 'lib/oci/data_safe/data_safe_client.rb', line 2963

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:



3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
# File 'lib/oci/data_safe/data_safe_client.rb', line 3030

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_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:



3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
# File 'lib/oci/data_safe/data_safe_client.rb', line 3094

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:



3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
# File 'lib/oci/data_safe/data_safe_client.rb', line 3159

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

  raise "Missing the required parameter 'create_sdm_masking_policy_difference_details' when calling create_sdm_masking_policy_difference." if create_sdm_masking_policy_difference_details.nil?

  path = '/sdmMaskingPolicyDifferences'
  operation_signing_strategy = :standard

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

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

  post_body = @api_client.object_to_http_body(create_sdm_masking_policy_difference_details)

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

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

Note:

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

Creates a new saved security assessment for one or multiple targets in a compartment. When this operation is performed, it will save the latest assessments in the specified compartment. If a schedule is passed, it will persist the latest assessments, at the defined date and time, in the format defined by RFC3339.

Parameters:

Options Hash (opts):

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

    The retry configuration to apply to this operation. If no key is provided then the 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:



3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
# File 'lib/oci/data_safe/data_safe_client.rb', line 3222

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

  raise "Missing the required parameter 'create_security_assessment_details' when calling create_security_assessment." if create_security_assessment_details.nil?

  path = '/securityAssessments'
  operation_signing_strategy = :standard

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

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

  post_body = @api_client.object_to_http_body(create_security_assessment_details)

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

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

Note:

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

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

Parameters:

  • sensitive_data_model_id (String)

    The OCID of the sensitive data model.

  • create_sensitive_column_details (OCI::DataSafe::Models::CreateSensitiveColumnDetails)

    Details to create a new sensitive column.

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

    the optional parameters

Options Hash (opts):

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

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

  • :opc_retry_token (String)

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

  • :opc_request_id (String)

    Unique identifier for the request.

Returns:

  • (Response)

    A Response object with data of type nil



3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
# File 'lib/oci/data_safe/data_safe_client.rb', line 3284

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:



3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
# File 'lib/oci/data_safe/data_safe_client.rb', line 3348

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:



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
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
# File 'lib/oci/data_safe/data_safe_client.rb', line 3411

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

  raise "Missing the required parameter 'create_sensitive_type_details' when calling create_sensitive_type." if create_sensitive_type_details.nil?

  path = '/sensitiveTypes'
  operation_signing_strategy = :standard

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

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

  post_body = @api_client.object_to_http_body(create_sensitive_type_details)

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

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

Note:

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

Creates a new SQL collection resource.

Parameters:

Options Hash (opts):

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

    The retry configuration to apply to this operation. If no key is provided then the 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:



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
3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
# File 'lib/oci/data_safe/data_safe_client.rb', line 3472

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:



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
3563
3564
3565
3566
3567
3568
3569
3570
# File 'lib/oci/data_safe/data_safe_client.rb', line 3533

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:



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
3624
3625
3626
3627
3628
3629
3630
3631
# File 'lib/oci/data_safe/data_safe_client.rb', line 3594

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

  raise "Missing the required parameter 'create_target_database_details' when calling create_target_database." if create_target_database_details.nil?

  path = '/targetDatabases'
  operation_signing_strategy = :standard

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

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

  post_body = @api_client.object_to_http_body(create_target_database_details)

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

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

Note:

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

Creates a new saved user assessment for one or multiple targets in a compartment. It saves the latest assessments in the specified compartment. If a scheduled is passed in, this operation persists the latest assessments that exist at the defined date and time, in the format defined by RFC3339.

Parameters:

Options Hash (opts):

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

    The retry configuration to apply to this operation. If no key is provided then the 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:



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
3687
3688
3689
3690
3691
3692
3693
3694
# File 'lib/oci/data_safe/data_safe_client.rb', line 3657

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



3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
# File 'lib/oci/data_safe/data_safe_client.rb', line 3724

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

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

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

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

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

  post_body = nil

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

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

Note:

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

To unload retrieved archive data, call the operation ListAuditArchiveRetrieval first. This will return the auditArchiveRetrievalId. Then call this operation with auditArchiveRetrievalId.

Parameters:

  • audit_archive_retrieval_id (String)

    OCID of the archive retrieval.

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

    the optional parameters

Options Hash (opts):

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

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

  • :if_match (String)

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

  • :opc_request_id (String)

    Unique identifier for the request.

Returns:

  • (Response)

    A Response object with data of type nil



3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
# File 'lib/oci/data_safe/data_safe_client.rb', line 3788

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

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

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

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

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

  post_body = nil

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

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

Note:

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

Deletes the specified audit trail.

Parameters:

  • audit_trail_id (String)

    The OCID of the audit trail.

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

    the optional parameters

Options Hash (opts):

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

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

  • :if_match (String)

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

  • :opc_request_id (String)

    Unique identifier for the request.

Returns:

  • (Response)

    A Response object with data of type nil



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
3873
3874
3875
3876
3877
3878
3879
3880
3881
3882
3883
3884
# File 'lib/oci/data_safe/data_safe_client.rb', line 3848

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



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
3938
3939
3940
3941
3942
3943
3944
# File 'lib/oci/data_safe/data_safe_client.rb', line 3908

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



3968
3969
3970
3971
3972
3973
3974
3975
3976
3977
3978
3979
3980
3981
3982
3983
3984
3985
3986
3987
3988
3989
3990
3991
3992
3993
3994
3995
3996
3997
3998
3999
4000
4001
4002
4003
4004
# File 'lib/oci/data_safe/data_safe_client.rb', line 3968

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



4029
4030
4031
4032
4033
4034
4035
4036
4037
4038
4039
4040
4041
4042
4043
4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
4055
4056
4057
4058
4059
4060
4061
4062
4063
4064
4065
4066
4067
# File 'lib/oci/data_safe/data_safe_client.rb', line 4029

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



4091
4092
4093
4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
4111
4112
4113
4114
4115
4116
4117
4118
4119
4120
4121
4122
4123
4124
4125
4126
4127
# File 'lib/oci/data_safe/data_safe_client.rb', line 4091

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



4152
4153
4154
4155
4156
4157
4158
4159
4160
4161
4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
4177
4178
4179
4180
4181
4182
4183
4184
4185
4186
4187
4188
4189
4190
# File 'lib/oci/data_safe/data_safe_client.rb', line 4152

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



4214
4215
4216
4217
4218
4219
4220
4221
4222
4223
4224
4225
4226
4227
4228
4229
4230
4231
4232
4233
4234
4235
4236
4237
4238
4239
4240
4241
4242
4243
4244
4245
4246
4247
4248
4249
4250
# File 'lib/oci/data_safe/data_safe_client.rb', line 4214

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



4274
4275
4276
4277
4278
4279
4280
4281
4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
4304
4305
4306
4307
4308
4309
4310
# File 'lib/oci/data_safe/data_safe_client.rb', line 4274

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_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



4334
4335
4336
4337
4338
4339
4340
4341
4342
4343
4344
4345
4346
4347
4348
4349
4350
4351
4352
4353
4354
4355
4356
4357
4358
4359
4360
4361
4362
4363
4364
4365
4366
4367
4368
4369
4370
# File 'lib/oci/data_safe/data_safe_client.rb', line 4334

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



4395
4396
4397
4398
4399
4400
4401
4402
4403
4404
4405
4406
4407
4408
4409
4410
4411
4412
4413
4414
4415
4416
4417
4418
4419
4420
4421
4422
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
# File 'lib/oci/data_safe/data_safe_client.rb', line 4395

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_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



4457
4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
4472
4473
4474
4475
4476
4477
4478
4479
4480
4481
4482
4483
4484
4485
4486
4487
4488
4489
4490
4491
4492
4493
# File 'lib/oci/data_safe/data_safe_client.rb', line 4457

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



4517
4518
4519
4520
4521
4522
4523
4524
4525
4526
4527
4528
4529
4530
4531
4532
4533
4534
4535
4536
4537
4538
4539
4540
4541
4542
4543
4544
4545
4546
4547
4548
4549
4550
4551
4552
4553
# File 'lib/oci/data_safe/data_safe_client.rb', line 4517

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



4581
4582
4583
4584
4585
4586
4587
4588
4589
4590
4591
4592
4593
4594
4595
4596
4597
4598
4599
4600
4601
4602
4603
4604
4605
4606
4607
4608
4609
4610
4611
4612
4613
4614
4615
4616
4617
# File 'lib/oci/data_safe/data_safe_client.rb', line 4581

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

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

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

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

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

  post_body = nil

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

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

Note:

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

Deletes the specified sensitive column.

Parameters:

  • sensitive_data_model_id (String)

    The OCID of the sensitive data model.

  • sensitive_column_key (String)

    The unique key that identifies the sensitive column. It's numeric and unique within a sensitive data model.

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

    the optional parameters

Options Hash (opts):

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

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

  • :if_match (String)

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

  • :opc_request_id (String)

    Unique identifier for the request.

Returns:

  • (Response)

    A Response object with data of type nil



4642
4643
4644
4645
4646
4647
4648
4649
4650
4651
4652
4653
4654
4655
4656
4657
4658
4659
4660
4661
4662
4663
4664
4665
4666
4667
4668
4669
4670
4671
4672
4673
4674
4675
4676
4677
4678
4679
4680
# File 'lib/oci/data_safe/data_safe_client.rb', line 4642

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



4704
4705
4706
4707
4708
4709
4710
4711
4712
4713
4714
4715
4716
4717
4718
4719
4720
4721
4722
4723
4724
4725
4726
4727
4728
4729
4730
4731
4732
4733
4734
4735
4736
4737
4738
4739
4740
# File 'lib/oci/data_safe/data_safe_client.rb', line 4704

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



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
4789
4790
4791
4792
4793
4794
4795
4796
4797
4798
4799
4800
# File 'lib/oci/data_safe/data_safe_client.rb', line 4764

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

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

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

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

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

  post_body = nil

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

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

Note:

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

Deletes the specified SQL collection.

Parameters:

  • sql_collection_id (String)

    The OCID of the SQL collection resource.

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

    the optional parameters

Options Hash (opts):

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

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

  • :if_match (String)

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

  • :opc_request_id (String)

    Unique identifier for the request.

Returns:

  • (Response)

    A Response object with data of type nil



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
4852
4853
4854
4855
4856
4857
4858
4859
4860
# File 'lib/oci/data_safe/data_safe_client.rb', line 4824

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

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

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

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

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

  post_body = nil

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

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

Note:

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

Deletes the SQL Firewall policy resource.

Parameters:

  • sql_firewall_policy_id (String)

    The OCID of the SQL Firewall policy resource.

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

    the optional parameters

Options Hash (opts):

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

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

  • :if_match (String)

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

  • :opc_request_id (String)

    Unique identifier for the request.

Returns:

  • (Response)

    A Response object with data of type nil



4885
4886
4887
4888
4889
4890
4891
4892
4893
4894
4895
4896
4897
4898
4899
4900
4901
4902
4903
4904
4905
4906
4907
4908
4909
4910
4911
4912
4913
4914
4915
4916
4917
4918
4919
4920
4921
# File 'lib/oci/data_safe/data_safe_client.rb', line 4885

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



4945
4946
4947
4948
4949
4950
4951
4952
4953
4954
4955
4956
4957
4958
4959
4960
4961
4962
4963
4964
4965
4966
4967
4968
4969
4970
4971
4972
4973
4974
4975
4976
4977
4978
4979
4980
4981
# File 'lib/oci/data_safe/data_safe_client.rb', line 4945

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



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
5037
5038
5039
5040
5041
# File 'lib/oci/data_safe/data_safe_client.rb', line 5005

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

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

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

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

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

  post_body = nil

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

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

Note:

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

Deletes the specified saved user assessment or schedule. To delete a user assessment schedule, first call the operation ListUserAssessments with filters "type = save_schedule". That call returns the scheduleAssessmentId. Then call DeleteUserAssessment with the scheduleAssessmentId. If the assessment being deleted is the baseline for that compartment, then it will impact all baselines in the compartment.

Parameters:

  • user_assessment_id (String)

    The OCID of the user assessment.

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

    the optional parameters

Options Hash (opts):

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

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

  • :if_match (String)

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

  • :opc_request_id (String)

    Unique identifier for the request.

Returns:

  • (Response)

    A Response object with data of type nil



5069
5070
5071
5072
5073
5074
5075
5076
5077
5078
5079
5080
5081
5082
5083
5084
5085
5086
5087
5088
5089
5090
5091
5092
5093
5094
5095
5096
5097
5098
5099
5100
5101
5102
5103
5104
5105
# File 'lib/oci/data_safe/data_safe_client.rb', line 5069

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

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

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

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

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

  post_body = nil

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

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

Note:

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

Updates the list of audit trails created under audit profile.The operation can be used to create new audit trails for target database when they become available for audit collection because of change of database version or change of database unified mode or change of data base edition or being deleted previously etc.

Parameters:

  • audit_profile_id (String)

    The OCID of the audit.

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

    the optional parameters

Options Hash (opts):

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

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

  • :opc_request_id (String)

    Unique identifier for the request.

  • :if_match (String)

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

  • :opc_retry_token (String)

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

Returns:

  • (Response)

    A Response object with data of type nil



5138
5139
5140
5141
5142
5143
5144
5145
5146
5147
5148
5149
5150
5151
5152
5153
5154
5155
5156
5157
5158
5159
5160
5161
5162
5163
5164
5165
5166
5167
5168
5169
5170
5171
5172
5173
5174
5175
5176
# File 'lib/oci/data_safe/data_safe_client.rb', line 5138

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



5201
5202
5203
5204
5205
5206
5207
5208
5209
5210
5211
5212
5213
5214
5215
5216
5217
5218
5219
5220
5221
5222
5223
5224
5225
5226
5227
5228
5229
5230
5231
5232
5233
5234
5235
5236
5237
5238
5239
5240
5241
5242
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
5281
5282
# File 'lib/oci/data_safe/data_safe_client.rb', line 5201

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



5303
5304
5305
5306
5307
5308
5309
5310
5311
5312
5313
5314
5315
5316
5317
5318
5319
5320
5321
5322
5323
5324
5325
5326
5327
5328
5329
5330
5331
5332
5333
5334
5335
5336
5337
5338
5339
5340
5341
5342
5343
5344
5345
5346
5347
5348
5349
5350
5351
5352
5353
5354
5355
5356
5357
5358
5359
5360
5361
5362
5363
5364
5365
5366
5367
5368
5369
5370
5371
5372
5373
5374
5375
5376
5377
5378
5379
5380
5381
5382
5383
5384
# File 'lib/oci/data_safe/data_safe_client.rb', line 5303

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



5409
5410
5411
5412
5413
5414
5415
5416
5417
5418
5419
5420
5421
5422
5423
5424
5425
5426
5427
5428
5429
5430
5431
5432
5433
5434
5435
5436
5437
5438
5439
5440
5441
5442
5443
5444
5445
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
5472
5473
5474
5475
5476
5477
5478
5479
5480
5481
5482
5483
5484
5485
5486
5487
5488
5489
5490
# File 'lib/oci/data_safe/data_safe_client.rb', line 5409

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



5514
5515
5516
5517
5518
5519
5520
5521
5522
5523
5524
5525
5526
5527
5528
5529
5530
5531
5532
5533
5534
5535
5536
5537
5538
5539
5540
5541
5542
5543
5544
5545
5546
5547
5548
5549
5550
5551
5552
5553
5554
5555
5556
5557
5558
5559
5560
5561
5562
5563
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 5514

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



5626
5627
5628
5629
5630
5631
5632
5633
5634
5635
5636
5637
5638
5639
5640
5641
5642
5643
5644
5645
5646
5647
5648
5649
5650
5651
5652
5653
5654
5655
5656
5657
5658
5659
5660
5661
5662
5663
5664
5665
5666
5667
5668
5669
5670
5671
5672
5673
5674
5675
5676
5677
5678
5679
5680
5681
5682
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
# File 'lib/oci/data_safe/data_safe_client.rb', line 5626

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



5741
5742
5743
5744
5745
5746
5747
5748
5749
5750
5751
5752
5753
5754
5755
5756
5757
5758
5759
5760
5761
5762
5763
5764
5765
5766
5767
5768
5769
5770
5771
5772
5773
5774
5775
5776
5777
5778
5779
5780
5781
5782
5783
5784
5785
5786
5787
5788
5789
5790
5791
5792
5793
5794
5795
5796
5797
5798
5799
5800
5801
5802
5803
5804
5805
5806
5807
5808
5809
5810
5811
5812
5813
5814
5815
5816
5817
5818
5819
5820
5821
5822
5823
5824
5825
# File 'lib/oci/data_safe/data_safe_client.rb', line 5741

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



5850
5851
5852
5853
5854
5855
5856
5857
5858
5859
5860
5861
5862
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
5900
5901
5902
5903
5904
5905
5906
5907
5908
5909
5910
5911
5912
5913
5914
5915
5916
5917
5918
5919
5920
5921
5922
5923
5924
5925
5926
5927
5928
5929
5930
5931
# File 'lib/oci/data_safe/data_safe_client.rb', line 5850

def download_sensitive_data_model(sensitive_data_model_id, download_sensitive_data_model_details, opts = {}, &block)
  logger.debug 'Calling operation DataSafeClient#download_sensitive_data_model.' if logger

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

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

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

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

  post_body = @api_client.object_to_http_body(download_sensitive_data_model_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#download_sensitive_data_model') do
    if !block.nil?
      @api_client.call_api(
        :POST,
        path,
        endpoint,
        header_params: header_params,
        query_params: query_params,
        operation_signing_strategy: operation_signing_strategy,
        body: post_body,
        return_type: 'Stream',
        &block
      )
    elsif opts[:response_target]
      if opts[:response_target].respond_to? :write
        @api_client.call_api(
          :POST,
          path,
          endpoint,
          header_params: header_params,
          query_params: query_params,
          operation_signing_strategy: operation_signing_strategy,
          body: post_body,
          return_type: 'Stream',
          &proc { |chunk, _response| opts[:response_target].write(chunk) }
        )
      elsif opts[:response_target].is_a?(String)
        File.open(opts[:response_target], 'wb') do |output|
          return @api_client.call_api(
            :POST,
            path,
            endpoint,
            header_params: header_params,
            query_params: query_params,
            operation_signing_strategy: operation_signing_strategy,
            body: post_body,
            return_type: 'Stream',
            &proc { |chunk, _response| output.write(chunk) }
          )
        end
      end
    else
      @api_client.call_api(
        :POST,
        path,
        endpoint,
        header_params: header_params,
        query_params: query_params,
        operation_signing_strategy: operation_signing_strategy,
        body: post_body,
        return_type: 'String'
      )
    end
  end
  # rubocop:enable Metrics/BlockLength
end

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

Note:

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

Downloads the report of the specified user assessment. To download the user assessment report, it needs to be generated first. Please use GenerateUserAssessmentReport to generate a downloadable report in the preferred format (PDF, XLS).

Parameters:

  • user_assessment_id (String)

    The OCID of the user assessment.

  • download_user_assessment_report_details (OCI::DataSafe::Models::DownloadUserAssessmentReportDetails)

    Details of the report.

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

    the optional parameters

  • [Block] (Hash)

    a customizable set of options

Options Hash (opts):

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

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

  • :if_match (String)

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

  • :opc_retry_token (String)

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

  • :opc_request_id (String)

    Unique identifier for the request.

  • :response_target (String, IO)

    Streaming http body into a file (specified by file name or File object) or IO object if the block is not given

Returns:

  • (Response)

    A Response object with data of type String if response_target and block are not given, otherwise with nil data



5965
5966
5967
5968
5969
5970
5971
5972
5973
5974
5975
5976
5977
5978
5979
5980
5981
5982
5983
5984
5985
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
6023
6024
6025
6026
6027
6028
6029
6030
6031
6032
6033
6034
6035
6036
6037
6038
6039
6040
6041
6042
6043
6044
6045
6046
6047
6048
6049
# File 'lib/oci/data_safe/data_safe_client.rb', line 5965

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



6075
6076
6077
6078
6079
6080
6081
6082
6083
6084
6085
6086
6087
6088
6089
6090
6091
6092
6093
6094
6095
6096
6097
6098
6099
6100
6101
6102
6103
6104
6105
6106
6107
6108
6109
6110
6111
# File 'lib/oci/data_safe/data_safe_client.rb', line 6075

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



6134
6135
6136
6137
6138
6139
6140
6141
6142
6143
6144
6145
6146
6147
6148
6149
6150
6151
6152
6153
6154
6155
6156
6157
6158
6159
6160
6161
6162
6163
6164
6165
6166
6167
6168
6169
6170
# File 'lib/oci/data_safe/data_safe_client.rb', line 6134

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



6194
6195
6196
6197
6198
6199
6200
6201
6202
6203
6204
6205
6206
6207
6208
6209
6210
6211
6212
6213
6214
6215
6216
6217
6218
6219
6220
6221
6222
6223
6224
6225
6226
6227
6228
6229
6230
6231
6232
# File 'lib/oci/data_safe/data_safe_client.rb', line 6194

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



6256
6257
6258
6259
6260
6261
6262
6263
6264
6265
6266
6267
6268
6269
6270
6271
6272
6273
6274
6275
6276
6277
6278
6279
6280
6281
6282
6283
6284
6285
6286
6287
6288
6289
6290
6291
6292
# File 'lib/oci/data_safe/data_safe_client.rb', line 6256

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



6315
6316
6317
6318
6319
6320
6321
6322
6323
6324
6325
6326
6327
6328
6329
6330
6331
6332
6333
6334
6335
6336
6337
6338
6339
6340
6341
6342
6343
6344
6345
6346
6347
6348
6349
6350
6351
# File 'lib/oci/data_safe/data_safe_client.rb', line 6315

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



6384
6385
6386
6387
6388
6389
6390
6391
6392
6393
6394
6395
6396
6397
6398
6399
6400
6401
6402
6403
6404
6405
6406
6407
6408
6409
6410
6411
6412
6413
6414
6415
6416
6417
6418
6419
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
6453
6454
6455
6456
6457
6458
6459
6460
6461
6462
6463
6464
6465
6466
6467
6468
# File 'lib/oci/data_safe/data_safe_client.rb', line 6384

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=(dateGenerated ge '2021-12-18T01-00-26') and (ilmTarget eq 'dscs-target')

Returns:

  • (Response)

    A Response object with data of type nil



6506
6507
6508
6509
6510
6511
6512
6513
6514
6515
6516
6517
6518
6519
6520
6521
6522
6523
6524
6525
6526
6527
6528
6529
6530
6531
6532
6533
6534
6535
6536
6537
6538
6539
6540
6541
6542
6543
6544
6545
6546
# File 'lib/oci/data_safe/data_safe_client.rb', line 6506

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



6578
6579
6580
6581
6582
6583
6584
6585
6586
6587
6588
6589
6590
6591
6592
6593
6594
6595
6596
6597
6598
6599
6600
6601
6602
6603
6604
6605
6606
6607
6608
6609
6610
6611
6612
6613
6614
6615
6616
6617
# File 'lib/oci/data_safe/data_safe_client.rb', line 6578

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



6640
6641
6642
6643
6644
6645
6646
6647
6648
6649
6650
6651
6652
6653
6654
6655
6656
6657
6658
6659
6660
6661
6662
6663
6664
6665
6666
6667
6668
6669
6670
6671
6672
6673
6674
6675
6676
# File 'lib/oci/data_safe/data_safe_client.rb', line 6640

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



6705
6706
6707
6708
6709
6710
6711
6712
6713
6714
6715
6716
6717
6718
6719
6720
6721
6722
6723
6724
6725
6726
6727
6728
6729
6730
6731
6732
6733
6734
6735
6736
6737
6738
6739
6740
6741
6742
6743
# File 'lib/oci/data_safe/data_safe_client.rb', line 6705

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



6775
6776
6777
6778
6779
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
# File 'lib/oci/data_safe/data_safe_client.rb', line 6775

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:



6832
6833
6834
6835
6836
6837
6838
6839
6840
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
# File 'lib/oci/data_safe/data_safe_client.rb', line 6832

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:



6886
6887
6888
6889
6890
6891
6892
6893
6894
6895
6896
6897
6898
6899
6900
6901
6902
6903
6904
6905
6906
6907
6908
6909
6910
6911
6912
6913
6914
6915
6916
6917
6918
6919
6920
6921
6922
# File 'lib/oci/data_safe/data_safe_client.rb', line 6886

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

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

  path = '/alertPolicies/{alertPolicyId}'.sub('{alertPolicyId}', alert_policy_id.to_s)
  operation_signing_strategy = :standard

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

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

  post_body = nil

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

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

Note:

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

Gets the details of the specified archive retreival.

Parameters:

  • audit_archive_retrieval_id (String)

    OCID of the archive retrieval.

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

    the optional parameters

Options Hash (opts):

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

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

  • :if_match (String)

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

  • :opc_request_id (String)

    Unique identifier for the request.

Returns:



6946
6947
6948
6949
6950
6951
6952
6953
6954
6955
6956
6957
6958
6959
6960
6961
6962
6963
6964
6965
6966
6967
6968
6969
6970
6971
6972
6973
6974
6975
6976
6977
6978
6979
6980
6981
6982
6983
# File 'lib/oci/data_safe/data_safe_client.rb', line 6946

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:



7001
7002
7003
7004
7005
7006
7007
7008
7009
7010
7011
7012
7013
7014
7015
7016
7017
7018
7019
7020
7021
7022
7023
7024
7025
7026
7027
7028
7029
7030
7031
7032
7033
7034
7035
7036
7037
# File 'lib/oci/data_safe/data_safe_client.rb', line 7001

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:



7055
7056
7057
7058
7059
7060
7061
7062
7063
7064
7065
7066
7067
7068
7069
7070
7071
7072
7073
7074
7075
7076
7077
7078
7079
7080
7081
7082
7083
7084
7085
7086
7087
7088
7089
7090
7091
# File 'lib/oci/data_safe/data_safe_client.rb', line 7055

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:



7109
7110
7111
7112
7113
7114
7115
7116
7117
7118
7119
7120
7121
7122
7123
7124
7125
7126
7127
7128
7129
7130
7131
7132
7133
7134
7135
7136
7137
7138
7139
7140
7141
7142
7143
7144
7145
# File 'lib/oci/data_safe/data_safe_client.rb', line 7109

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:



7171
7172
7173
7174
7175
7176
7177
7178
7179
7180
7181
7182
7183
7184
7185
7186
7187
7188
7189
7190
7191
7192
7193
7194
7195
7196
7197
7198
7199
7200
7201
7202
7203
7204
7205
7206
7207
# File 'lib/oci/data_safe/data_safe_client.rb', line 7171

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:



7240
7241
7242
7243
7244
7245
7246
7247
7248
7249
7250
7251
7252
7253
7254
7255
7256
7257
7258
7259
7260
7261
7262
7263
7264
7265
7266
7267
7268
7269
7270
7271
7272
7273
7274
7275
7276
7277
7278
7279
7280
7281
7282
7283
7284
# File 'lib/oci/data_safe/data_safe_client.rb', line 7240

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

  raise "Missing the required parameter 'compartment_id' when calling get_compatible_formats_for_sensitive_types." if compartment_id.nil?

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

  path = '/compatibleFormatsForSensitiveTypes'
  operation_signing_strategy = :standard

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

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

  post_body = nil

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

#get_data_safe_configuration(opts = {}) ⇒ Response

Note:

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

Gets the details of the Data Safe configuration.

Parameters:

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

    the optional parameters

Options Hash (opts):

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

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

  • :compartment_id (String)

    A filter to return only resources that match the specified compartment OCID.

  • :opc_request_id (String)

    Unique identifier for the request.

Returns:



7302
7303
7304
7305
7306
7307
7308
7309
7310
7311
7312
7313
7314
7315
7316
7317
7318
7319
7320
7321
7322
7323
7324
7325
7326
7327
7328
7329
7330
7331
7332
7333
7334
7335
7336
7337
# File 'lib/oci/data_safe/data_safe_client.rb', line 7302

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:



7355
7356
7357
7358
7359
7360
7361
7362
7363
7364
7365
7366
7367
7368
7369
7370
7371
7372
7373
7374
7375
7376
7377
7378
7379
7380
7381
7382
7383
7384
7385
7386
7387
7388
7389
7390
7391
# File 'lib/oci/data_safe/data_safe_client.rb', line 7355

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:



7409
7410
7411
7412
7413
7414
7415
7416
7417
7418
7419
7420
7421
7422
7423
7424
7425
7426
7427
7428
7429
7430
7431
7432
7433
7434
7435
7436
7437
7438
7439
7440
7441
7442
7443
7444
7445
# File 'lib/oci/data_safe/data_safe_client.rb', line 7409

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:



7464
7465
7466
7467
7468
7469
7470
7471
7472
7473
7474
7475
7476
7477
7478
7479
7480
7481
7482
7483
7484
7485
7486
7487
7488
7489
7490
7491
7492
7493
7494
7495
7496
7497
7498
7499
7500
7501
7502
# File 'lib/oci/data_safe/data_safe_client.rb', line 7464

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:



7521
7522
7523
7524
7525
7526
7527
7528
7529
7530
7531
7532
7533
7534
7535
7536
7537
7538
7539
7540
7541
7542
7543
7544
7545
7546
7547
7548
7549
7550
7551
7552
7553
7554
7555
7556
7557
7558
7559
# File 'lib/oci/data_safe/data_safe_client.rb', line 7521

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:



7578
7579
7580
7581
7582
7583
7584
7585
7586
7587
7588
7589
7590
7591
7592
7593
7594
7595
7596
7597
7598
7599
7600
7601
7602
7603
7604
7605
7606
7607
7608
7609
7610
7611
7612
7613
7614
7615
7616
# File 'lib/oci/data_safe/data_safe_client.rb', line 7578

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:



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
7666
7667
7668
7669
7670
# File 'lib/oci/data_safe/data_safe_client.rb', line 7634

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:



7689
7690
7691
7692
7693
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
# File 'lib/oci/data_safe/data_safe_client.rb', line 7689

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

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

  path = '/discoveryJobs/{discoveryJobId}/results/{resultKey}'.sub('{discoveryJobId}', discovery_job_id.to_s).sub('{resultKey}', result_key.to_s)
  operation_signing_strategy = :standard

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

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

  post_body = nil

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

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

Note:

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

Gets the details of the specified library masking format.

Parameters:

  • library_masking_format_id (String)

    The OCID of the library masking format.

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

    the optional parameters

Options Hash (opts):

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

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

  • :opc_request_id (String)

    Unique identifier for the request.

Returns:



7745
7746
7747
7748
7749
7750
7751
7752
7753
7754
7755
7756
7757
7758
7759
7760
7761
7762
7763
7764
7765
7766
7767
7768
7769
7770
7771
7772
7773
7774
7775
7776
7777
7778
7779
7780
7781
# File 'lib/oci/data_safe/data_safe_client.rb', line 7745

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:



7800
7801
7802
7803
7804
7805
7806
7807
7808
7809
7810
7811
7812
7813
7814
7815
7816
7817
7818
7819
7820
7821
7822
7823
7824
7825
7826
7827
7828
7829
7830
7831
7832
7833
7834
7835
7836
7837
7838
# File 'lib/oci/data_safe/data_safe_client.rb', line 7800

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:



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

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:



7910
7911
7912
7913
7914
7915
7916
7917
7918
7919
7920
7921
7922
7923
7924
7925
7926
7927
7928
7929
7930
7931
7932
7933
7934
7935
7936
7937
7938
7939
7940
7941
7942
7943
7944
7945
7946
# File 'lib/oci/data_safe/data_safe_client.rb', line 7910

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:



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

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:



8018
8019
8020
8021
8022
8023
8024
8025
8026
8027
8028
8029
8030
8031
8032
8033
8034
8035
8036
8037
8038
8039
8040
8041
8042
8043
8044
8045
8046
8047
8048
8049
8050
8051
8052
8053
8054
# File 'lib/oci/data_safe/data_safe_client.rb', line 8018

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:



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

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:



8135
8136
8137
8138
8139
8140
8141
8142
8143
8144
8145
8146
8147
8148
8149
8150
8151
8152
8153
8154
8155
8156
8157
8158
8159
8160
8161
8162
8163
8164
8165
8166
8167
8168
8169
8170
8171
8172
8173
# File 'lib/oci/data_safe/data_safe_client.rb', line 8135

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

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

  path = '/userAssessments/{userAssessmentId}/profiles/{profileName}'.sub('{userAssessmentId}', user_assessment_id.to_s).sub('{profileName}', profile_name.to_s)
  operation_signing_strategy = :standard

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

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

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#get_profile') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'Array<OCI::DataSafe::Models::Profile>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

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

Note:

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

Gets a report by identifier

Parameters:

  • report_id (String)

    Unique report identifier

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

    the optional parameters

Options Hash (opts):

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

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

  • :opc_request_id (String)

    Unique identifier for the request.

Returns:



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
8223
8224
8225
8226
8227
# File 'lib/oci/data_safe/data_safe_client.rb', line 8191

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



8247
8248
8249
8250
8251
8252
8253
8254
8255
8256
8257
8258
8259
8260
8261
8262
8263
8264
8265
8266
8267
8268
8269
8270
8271
8272
8273
8274
8275
8276
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
# File 'lib/oci/data_safe/data_safe_client.rb', line 8247

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:



8345
8346
8347
8348
8349
8350
8351
8352
8353
8354
8355
8356
8357
8358
8359
8360
8361
8362
8363
8364
8365
8366
8367
8368
8369
8370
8371
8372
8373
8374
8375
8376
8377
8378
8379
8380
8381
# File 'lib/oci/data_safe/data_safe_client.rb', line 8345

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:



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

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:



8453
8454
8455
8456
8457
8458
8459
8460
8461
8462
8463
8464
8465
8466
8467
8468
8469
8470
8471
8472
8473
8474
8475
8476
8477
8478
8479
8480
8481
8482
8483
8484
8485
8486
8487
8488
8489
# File 'lib/oci/data_safe/data_safe_client.rb', line 8453

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:



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

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:



8564
8565
8566
8567
8568
8569
8570
8571
8572
8573
8574
8575
8576
8577
8578
8579
8580
8581
8582
8583
8584
8585
8586
8587
8588
8589
8590
8591
8592
8593
8594
8595
8596
8597
8598
8599
8600
# File 'lib/oci/data_safe/data_safe_client.rb', line 8564

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

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

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

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

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

  post_body = nil

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

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

Note:

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

Gets a security policy deployment by identifier.

Parameters:

  • security_policy_deployment_id (String)

    The OCID of the security policy deployment resource.

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

    the optional parameters

Options Hash (opts):

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

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

  • :opc_request_id (String)

    Unique identifier for the request.

Returns:



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

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:



8677
8678
8679
8680
8681
8682
8683
8684
8685
8686
8687
8688
8689
8690
8691
8692
8693
8694
8695
8696
8697
8698
8699
8700
8701
8702
8703
8704
8705
8706
8707
8708
8709
8710
8711
8712
8713
8714
8715
# File 'lib/oci/data_safe/data_safe_client.rb', line 8677

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:



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

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:



8788
8789
8790
8791
8792
8793
8794
8795
8796
8797
8798
8799
8800
8801
8802
8803
8804
8805
8806
8807
8808
8809
8810
8811
8812
8813
8814
8815
8816
8817
8818
8819
8820
8821
8822
8823
8824
8825
8826
# File 'lib/oci/data_safe/data_safe_client.rb', line 8788

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:



8844
8845
8846
8847
8848
8849
8850
8851
8852
8853
8854
8855
8856
8857
8858
8859
8860
8861
8862
8863
8864
8865
8866
8867
8868
8869
8870
8871
8872
8873
8874
8875
8876
8877
8878
8879
8880
# File 'lib/oci/data_safe/data_safe_client.rb', line 8844

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:



8898
8899
8900
8901
8902
8903
8904
8905
8906
8907
8908
8909
8910
8911
8912
8913
8914
8915
8916
8917
8918
8919
8920
8921
8922
8923
8924
8925
8926
8927
8928
8929
8930
8931
8932
8933
8934
# File 'lib/oci/data_safe/data_safe_client.rb', line 8898

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

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

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

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

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

  post_body = nil

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

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

Note:

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

Gets a SQL collection by identifier.

Parameters:

  • sql_collection_id (String)

    The OCID of the SQL collection resource.

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

    the optional parameters

Options Hash (opts):

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

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

  • :opc_request_id (String)

    Unique identifier for the request.

Returns:



8952
8953
8954
8955
8956
8957
8958
8959
8960
8961
8962
8963
8964
8965
8966
8967
8968
8969
8970
8971
8972
8973
8974
8975
8976
8977
8978
8979
8980
8981
8982
8983
8984
8985
8986
8987
8988
# File 'lib/oci/data_safe/data_safe_client.rb', line 8952

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

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

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

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

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

  post_body = nil

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

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

Note:

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

Gets a SQL Firewall policy by identifier.

Parameters:

  • sql_firewall_policy_id (String)

    The OCID of the SQL Firewall policy resource.

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

    the optional parameters

Options Hash (opts):

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

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

  • :opc_request_id (String)

    Unique identifier for the request.

Returns:



9006
9007
9008
9009
9010
9011
9012
9013
9014
9015
9016
9017
9018
9019
9020
9021
9022
9023
9024
9025
9026
9027
9028
9029
9030
9031
9032
9033
9034
9035
9036
9037
9038
9039
9040
9041
9042
# File 'lib/oci/data_safe/data_safe_client.rb', line 9006

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:



9060
9061
9062
9063
9064
9065
9066
9067
9068
9069
9070
9071
9072
9073
9074
9075
9076
9077
9078
9079
9080
9081
9082
9083
9084
9085
9086
9087
9088
9089
9090
9091
9092
9093
9094
9095
9096
# File 'lib/oci/data_safe/data_safe_client.rb', line 9060

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:



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

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

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

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

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

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

  post_body = nil

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

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

Note:

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

Gets a user assessment by identifier.

Parameters:

  • user_assessment_id (String)

    The OCID of the user assessment.

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

    the optional parameters

Options Hash (opts):

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

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

  • :opc_request_id (String)

    Unique identifier for the request.

Returns:



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
9201
9202
9203
9204
9205
# File 'lib/oci/data_safe/data_safe_client.rb', line 9169

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:



9224
9225
9226
9227
9228
9229
9230
9231
9232
9233
9234
9235
9236
9237
9238
9239
9240
9241
9242
9243
9244
9245
9246
9247
9248
9249
9250
9251
9252
9253
9254
9255
9256
9257
9258
9259
9260
9261
9262
# File 'lib/oci/data_safe/data_safe_client.rb', line 9224

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:



9280
9281
9282
9283
9284
9285
9286
9287
9288
9289
9290
9291
9292
9293
9294
9295
9296
9297
9298
9299
9300
9301
9302
9303
9304
9305
9306
9307
9308
9309
9310
9311
9312
9313
9314
9315
9316
# File 'lib/oci/data_safe/data_safe_client.rb', line 9280

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

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

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

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

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

  post_body = nil

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

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

Note:

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

Returns the aggregation details of the alerts.

Allowed values are: displayName, timeCreated

Parameters:

  • compartment_id (String)

    A filter to return only resources that match the specified compartment OCID.

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

    the optional parameters

Options Hash (opts):

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

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

  • :compartment_id_in_subtree (BOOLEAN)

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

  • :limit (Integer)

    For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

  • :page (String)

    For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

  • :opc_request_id (String)

    Unique identifier for the request.

  • :if_match (String)

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

  • :time_started (DateTime)

    An optional filter to return audit events whose creation time in the database is greater than and equal to the date-time specified, in the format defined by RFC3339.

  • :time_ended (DateTime)

    An optional filter to return audit events whose creation time in the database is less than and equal to the date-time specified, in the format defined by RFC3339.

  • :query_time_zone (String)

    Default time zone is UTC if no time zone provided. The date-time considerations of the resource will be in accordance with the specified time zone. (default to UTC)

  • :sort_order (String)

    The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

  • :sort_by (String)

    The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. If no value is specified timeCreated is default. (default to timeCreated)

  • :access_level (String)

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

  • :scim_query (String)

    The scimQuery query parameter accepts filter expressions that use the syntax described in Section 3.2.2.2 of the System for Cross-Domain Identity Management (SCIM) specification, which is available at RFC3339. In SCIM filtering expressions, text, date, and time values must be enclosed in quotation marks, with date and time values using ISO-8601 format. (Numeric and boolean values should not be quoted.)

    Example: | query=(timeCreated ge '2021-06-04T01-00-26') and (targetNames eq 'target_1') query=(featureDetails.userName eq "user") and (targetNames eq "target_1") Supported fields: severity status alertType targetIds targetNames operationTime lifecycleState displayName timeCreated timeUpdated featureDetails.* (* can be any field in nestedStrMap in Feature Attributes in Alert Summary. For example - userName,object,clientHostname,osUserName,clientIPs,clientId,commandText,commandParam,clientProgram,objectType,targetOwner)

  • :summary_field (Array<String>)

    Specifies a subset of summarized fields to be returned in the response. Allowed values are: alertType, targetIds, targetNames, alertSeverity, alertStatus, timeCreated, policyId, open, closed, critical, high, medium, low, alertcount

  • :group_by (Array<String>)

    A groupBy can only be used in combination with summaryField parameter. A groupBy value has to be a subset of the values mentioned in summaryField parameter.

    Allowed values are: alertType, targetIds, targetNames, alertSeverity, alertStatus, timeCreated, policyId

  • :opc_retry_token (String)

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

Returns:



9399
9400
9401
9402
9403
9404
9405
9406
9407
9408
9409
9410
9411
9412
9413
9414
9415
9416
9417
9418
9419
9420
9421
9422
9423
9424
9425
9426
9427
9428
9429
9430
9431
9432
9433
9434
9435
9436
9437
9438
9439
9440
9441
9442
9443
9444
9445
9446
9447
9448
9449
9450
9451
9452
9453
9454
9455
9456
9457
9458
9459
9460
9461
9462
9463
9464
9465
9466
9467
9468
9469
9470
9471
9472
9473
9474
9475
9476
9477
9478
9479
9480
9481
9482
# File 'lib/oci/data_safe/data_safe_client.rb', line 9399

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

  raise "Missing the required parameter 'compartment_id' when calling list_alert_analytics." if compartment_id.nil?

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

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

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


  summary_field_allowable_values = %w[alertType targetIds targetNames alertSeverity alertStatus timeCreated policyId open closed critical high medium low alertcount]
  if opts[:summary_field] && !opts[:summary_field].empty?
    opts[:summary_field].each do |val_to_check|
      unless summary_field_allowable_values.include?(val_to_check)
        raise 'Invalid value for "summary_field", must be one of alertType, targetIds, targetNames, alertSeverity, alertStatus, timeCreated, policyId, open, closed, critical, high, medium, low, alertcount.'
      end
    end
  end


  group_by_allowable_values = %w[alertType targetIds targetNames alertSeverity alertStatus timeCreated policyId]
  if opts[:group_by] && !opts[:group_by].empty?
    opts[:group_by].each do |val_to_check|
      unless group_by_allowable_values.include?(val_to_check)
        raise 'Invalid value for "group_by", must be one of alertType, targetIds, targetNames, alertSeverity, alertStatus, timeCreated, policyId.'
      end
    end
  end

  path = '/alertAnalytics'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:compartmentIdInSubtree] = opts[:compartment_id_in_subtree] if !opts[:compartment_id_in_subtree].nil?
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:timeStarted] = opts[:time_started] if opts[:time_started]
  query_params[:timeEnded] = opts[:time_ended] if opts[:time_ended]
  query_params[:queryTimeZone] = opts[:query_time_zone] if opts[:query_time_zone]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:accessLevel] = opts[:access_level] if opts[:access_level]
  query_params[:scimQuery] = opts[:scim_query] if opts[:scim_query]
  query_params[:summaryField] = OCI::ApiClient.build_collection_params(opts[:summary_field], :multi) if opts[:summary_field] && !opts[:summary_field].empty?
  query_params[:groupBy] = OCI::ApiClient.build_collection_params(opts[:group_by], :multi) if opts[:group_by] && !opts[:group_by].empty?

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

  post_body = nil

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

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

Note:

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

Gets a list of all alert policies.

Allowed values are: displayName, timeCreated

Parameters:

  • compartment_id (String)

    A filter to return only resources that match the specified compartment OCID.

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

    the optional parameters

Options Hash (opts):

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

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

  • :alert_policy_id (String)

    A filter to return policy by it's OCID.

  • :type (String)

    An optional filter to return only alert policies of a certain type.

  • :is_user_defined (BOOLEAN)

    An optional filter to return only alert policies that are user-defined or not. (default to false)

  • :display_name (String)

    A filter to return only resources that match the specified display name.

  • :lifecycle_state (String)

    An optional filter to return only alert policies that have the given life-cycle state.

  • :limit (Integer)

    For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

  • :page (String)

    For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

  • :sort_order (String)

    The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

  • :sort_by (String)

    The field to sort by. Only one sort parameter may be provided. (default to timeCreated)

  • :opc_request_id (String)

    Unique identifier for the request.

  • :time_created_greater_than_or_equal_to (DateTime)

    A filter to return only the resources that were created after the specified date and time, as defined by RFC3339. Using TimeCreatedGreaterThanOrEqualToQueryParam parameter retrieves all resources created after that date.

    Example: 2016-12-19T16:39:57.600Z

  • :time_created_less_than (DateTime)

    Search for resources that were created before a specific date. Specifying this parameter corresponding timeCreatedLessThan parameter will retrieve all resources created before the specified created date, in "YYYY-MM-ddThh:mmZ" format with a Z offset, as defined by RFC 3339.

    Example: 2016-12-19T16:39:57.600Z

  • :compartment_id_in_subtree (BOOLEAN)

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

  • :access_level (String)

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

Returns:



9536
9537
9538
9539
9540
9541
9542
9543
9544
9545
9546
9547
9548
9549
9550
9551
9552
9553
9554
9555
9556
9557
9558
9559
9560
9561
9562
9563
9564
9565
9566
9567
9568
9569
9570
9571
9572
9573
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
9601
9602
9603
9604
9605
# File 'lib/oci/data_safe/data_safe_client.rb', line 9536

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:



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
9655
9656
9657
9658
9659
9660
9661
9662
9663
9664
9665
# File 'lib/oci/data_safe/data_safe_client.rb', line 9627

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

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

  path = '/alertPolicies/{alertPolicyId}/rules'.sub('{alertPolicyId}', alert_policy_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]

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

  post_body = nil

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

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

Note:

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

Gets a list of all alerts.

Allowed values are: displayName, timeCreated

Parameters:

  • compartment_id (String)

    A filter to return only resources that match the specified compartment OCID.

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

    the optional parameters

Options Hash (opts):

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

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

  • :id (String)

    A filter to return alert by it's OCID.

  • :compartment_id_in_subtree (BOOLEAN)

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

  • :limit (Integer)

    For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

  • :page (String)

    For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

  • :opc_request_id (String)

    Unique identifier for the request.

  • :access_level (String)

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

  • :sort_order (String)

    The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

  • :sort_by (String)

    The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. If no value is specified timeCreated is default. (default to timeCreated)

  • :scim_query (String)

    The scimQuery query parameter accepts filter expressions that use the syntax described in Section 3.2.2.2 of the System for Cross-Domain Identity Management (SCIM) specification, which is available at RFC3339. In SCIM filtering expressions, text, date, and time values must be enclosed in quotation marks, with date and time values using ISO-8601 format. (Numeric and boolean values should not be quoted.)

    Example: | query=(timeCreated ge '2021-06-04T01-00-26') and (targetNames eq 'target_1') query=(featureDetails.userName eq "user") and (targetNames eq "target_1") Supported fields: severity status alertType targetIds targetNames operationTime lifecycleState displayName timeCreated timeUpdated featureDetails.* (* can be any field in nestedStrMap in Feature Attributes in Alert Summary. For example - userName,object,clientHostname,osUserName,clientIPs,clientId,commandText,commandParam,clientProgram,objectType,targetOwner)

  • :field (Array<String>)

    Specifies a subset of fields to be returned in the response. Allowed values are: id, displayName, alertType, targetIds, targetNames, severity, status, operationTime, operation, operationStatus, timeCreated, timeUpdated, policyId, lifecycleState

Returns:



9726
9727
9728
9729
9730
9731
9732
9733
9734
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
9773
9774
9775
9776
9777
9778
9779
9780
9781
9782
9783
9784
9785
9786
9787
9788
9789
9790
9791
9792
9793
# File 'lib/oci/data_safe/data_safe_client.rb', line 9726

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

  raise "Missing the required parameter 'compartment_id' when calling list_alerts." if compartment_id.nil?

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

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

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


  field_allowable_values = %w[id displayName alertType targetIds targetNames severity status operationTime operation operationStatus timeCreated timeUpdated policyId lifecycleState]
  if opts[:field] && !opts[:field].empty?
    opts[:field].each do |val_to_check|
      unless field_allowable_values.include?(val_to_check)
        raise 'Invalid value for "field", must be one of id, displayName, alertType, targetIds, targetNames, severity, status, operationTime, operation, operationStatus, timeCreated, timeUpdated, policyId, lifecycleState.'
      end
    end
  end

  path = '/alerts'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:id] = opts[:id] if opts[:id]
  query_params[:compartmentIdInSubtree] = opts[:compartment_id_in_subtree] if !opts[:compartment_id_in_subtree].nil?
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:accessLevel] = opts[:access_level] if opts[:access_level]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:scimQuery] = opts[:scim_query] if opts[:scim_query]
  query_params[:field] = OCI::ApiClient.build_collection_params(opts[:field], :multi) if opts[:field] && !opts[:field].empty?

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

  post_body = nil

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

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

Note:

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

Returns the list of audit archive retrieval.

Parameters:

  • compartment_id (String)

    A filter to return only resources that match the specified compartment OCID.

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

    the optional parameters

Options Hash (opts):

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

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

  • :display_name (String)

    A filter to return only resources that match the specified display name.

  • :compartment_id_in_subtree (BOOLEAN)

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

  • :access_level (String)

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

  • :audit_archive_retrieval_id (String)

    OCID of the archive retrieval.

  • :target_id (String)

    The OCID of the target associated with the archive retrieval.

  • :limit (Integer)

    For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

  • :page (String)

    For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

  • :lifecycle_state (String)

    A filter to return only resources that matches the specified lifecycle state.

  • :time_of_expiry (DateTime)

    The date time when retrieved archive data will be deleted from Data Safe and unloaded back into archival.

  • :sort_order (String)

    The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

  • :sort_by (String)

    The field used for sorting. Only one sorting order (sortOrder) can be specified. The default order for TIMECREATED is descending. The default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. (default to TIMECREATED) Allowed values are: TIMECREATED, DISPLAYNAME

  • :opc_request_id (String)

    Unique identifier for the request.

Returns:



9836
9837
9838
9839
9840
9841
9842
9843
9844
9845
9846
9847
9848
9849
9850
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
9888
9889
9890
9891
9892
9893
9894
9895
9896
9897
9898
9899
# File 'lib/oci/data_safe/data_safe_client.rb', line 9836

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

  raise "Missing the required parameter 'compartment_id' when calling list_audit_archive_retrievals." if compartment_id.nil?

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

  if opts[:lifecycle_state] && !OCI::DataSafe::Models::AUDIT_ARCHIVE_RETRIEVAL_LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::DataSafe::Models::AUDIT_ARCHIVE_RETRIEVAL_LIFECYCLE_STATE_ENUM.'
  end

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

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

  path = '/auditArchiveRetrievals'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:compartmentIdInSubtree] = opts[:compartment_id_in_subtree] if !opts[:compartment_id_in_subtree].nil?
  query_params[:accessLevel] = opts[:access_level] if opts[:access_level]
  query_params[:auditArchiveRetrievalId] = opts[:audit_archive_retrieval_id] if opts[:audit_archive_retrieval_id]
  query_params[:targetId] = opts[:target_id] if opts[:target_id]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:timeOfExpiry] = opts[:time_of_expiry] if opts[:time_of_expiry]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]

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

  post_body = nil

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

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

Note:

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

By default the ListAuditEventAnalytics operation will return all of the summary columns. To filter for a specific summary column, specify it in the summaryField query parameter.

Example: /ListAuditEventAnalytics?summaryField=targetName&summaryField=userName&summaryField=clientHostname &summaryField=dmls&summaryField=privilegeChanges&summaryField=ddls&summaryField=loginFailure&summaryField=loginSuccess &summaryField=allRecord&q=(auditEventTime ge "2021-06-13T23:49:14")

/ListAuditEventAnalytics?timeStarted=2022-08-18T11:02:26.000Z&timeEnded=2022-08-24T11:02:26.000Z This will give number of events grouped by periods. Period can be 1 day, 1 week, etc.

/ListAuditEventAnalytics?summaryField=targetName&groupBy=targetName This will give the number of events group by targetName. Only targetName summary column would be returned.

Parameters:

  • compartment_id (String)

    A filter to return only resources that match the specified compartment OCID.

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

    the optional parameters

Options Hash (opts):

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

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

  • :opc_request_id (String)

    Unique identifier for the request.

  • :if_match (String)

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

  • :limit (Integer)

    For details about how pagination works, see List Pagination.

  • :page (String)

    It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

  • :compartment_id_in_subtree (BOOLEAN)

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

  • :access_level (String)

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

  • :scim_query (String)

    The scimQuery query parameter accepts filter expressions that use the syntax described in Section 3.2.2.2 of the System for Cross-Domain Identity Management (SCIM) specification, which is available at RFC3339. In SCIM filtering expressions, text, date, and time values must be enclosed in quotation marks, with date and time values using ISO-8601 format. (Numeric and boolean values should not be quoted.)

    Example: query=(operationTime ge '2021-06-04T01-00-26') and (eventName eq 'LOGON')

  • :summary_field (Array<String>)

    Specifies a subset of summarized fields to be returned in the response. Allowed values are: auditEventTime, dbUserName, targetId, targetName, targetClass, objectType, clientHostname, clientProgram, clientId, auditType, eventName, allRecord, auditSettingsChange, dbSchemaChange, entitlementChange, loginFailure, loginSuccess, allViolations, realmViolations, ruleViolations, dvconfigActivities, ddls, dmls, privilegeChanges, auditSettingsEnables, auditSettingsDisables, selects, creates, alters, drops, grants, revokes

  • :time_started (DateTime)

    An optional filter to return audit events whose creation time in the database is greater than and equal to the date-time specified, in the format defined by RFC3339.

  • :time_ended (DateTime)

    An optional filter to return audit events whose creation time in the database is less than and equal to the date-time specified, in the format defined by RFC3339.

  • :query_time_zone (String)

    Default time zone is UTC if no time zone provided. The date-time considerations of the resource will be in accordance with the specified time zone. (default to UTC)

  • :group_by (Array<String>)

    A groupBy can only be used in combination with summaryField parameter. A groupBy value has to be a subset of the values mentioned in summaryField parameter.

    Allowed values are: auditEventTime, dbUserName, targetId, targetName, targetClass, objectType, clientHostname, clientProgram, clientId, auditType, eventName

  • :opc_retry_token (String)

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

  • :sort_order (String)

    The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

  • :sort_by (String)

    If this query parameter is specified, the result is ordered based on this query parameter value. Allowed values are: targetId, targetClass, targetName, objectType, dbUserName, eventName, auditEventTime, clientHostname, clientProgram, clientId, auditType

Returns:



9981
9982
9983
9984
9985
9986
9987
9988
9989
9990
9991
9992
9993
9994
9995
9996
9997
9998
9999
10000
10001
10002
10003
10004
10005
10006
10007
10008
10009
10010
10011
10012
10013
10014
10015
10016
10017
10018
10019
10020
10021
10022
10023
10024
10025
10026
10027
10028
10029
10030
10031
10032
10033
10034
10035
10036
10037
10038
10039
10040
10041
10042
10043
10044
10045
10046
10047
10048
10049
10050
10051
10052
10053
10054
10055
10056
10057
10058
10059
10060
10061
10062
10063
10064
# File 'lib/oci/data_safe/data_safe_client.rb', line 9981

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

  raise "Missing the required parameter 'compartment_id' when calling list_audit_event_analytics." if compartment_id.nil?

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


  summary_field_allowable_values = %w[auditEventTime dbUserName targetId targetName targetClass objectType clientHostname clientProgram clientId auditType eventName allRecord auditSettingsChange dbSchemaChange entitlementChange loginFailure loginSuccess allViolations realmViolations ruleViolations dvconfigActivities ddls dmls privilegeChanges auditSettingsEnables auditSettingsDisables selects creates alters drops grants revokes]
  if opts[:summary_field] && !opts[:summary_field].empty?
    opts[:summary_field].each do |val_to_check|
      unless summary_field_allowable_values.include?(val_to_check)
        raise 'Invalid value for "summary_field", must be one of auditEventTime, dbUserName, targetId, targetName, targetClass, objectType, clientHostname, clientProgram, clientId, auditType, eventName, allRecord, auditSettingsChange, dbSchemaChange, entitlementChange, loginFailure, loginSuccess, allViolations, realmViolations, ruleViolations, dvconfigActivities, ddls, dmls, privilegeChanges, auditSettingsEnables, auditSettingsDisables, selects, creates, alters, drops, grants, revokes.'
      end
    end
  end


  group_by_allowable_values = %w[auditEventTime dbUserName targetId targetName targetClass objectType clientHostname clientProgram clientId auditType eventName]
  if opts[:group_by] && !opts[:group_by].empty?
    opts[:group_by].each do |val_to_check|
      unless group_by_allowable_values.include?(val_to_check)
        raise 'Invalid value for "group_by", must be one of auditEventTime, dbUserName, targetId, targetName, targetClass, objectType, clientHostname, clientProgram, clientId, auditType, eventName.'
      end
    end
  end

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

  if opts[:sort_by] && !%w[targetId targetClass targetName objectType dbUserName eventName auditEventTime clientHostname clientProgram clientId auditType].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of targetId, targetClass, targetName, objectType, dbUserName, eventName, auditEventTime, clientHostname, clientProgram, clientId, auditType.'
  end

  path = '/auditEventAnalytics'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:compartmentIdInSubtree] = opts[:compartment_id_in_subtree] if !opts[:compartment_id_in_subtree].nil?
  query_params[:accessLevel] = opts[:access_level] if opts[:access_level]
  query_params[:scimQuery] = opts[:scim_query] if opts[:scim_query]
  query_params[:summaryField] = OCI::ApiClient.build_collection_params(opts[:summary_field], :multi) if opts[:summary_field] && !opts[:summary_field].empty?
  query_params[:timeStarted] = opts[:time_started] if opts[:time_started]
  query_params[:timeEnded] = opts[:time_ended] if opts[:time_ended]
  query_params[:queryTimeZone] = opts[:query_time_zone] if opts[:query_time_zone]
  query_params[:groupBy] = OCI::ApiClient.build_collection_params(opts[:group_by], :multi) if opts[:group_by] && !opts[:group_by].empty?
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]

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

  post_body = nil

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

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

Note:

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

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

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

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

Allowed values are: dbUserName, targetName, databaseType, targetClass, auditEventTime, timeCollected, osUserName, operation, operationStatus, eventName, errorCode, errorMessage, objectType, objectName, objectOwner, clientHostname, clientIp, isAlerted, actionTaken, clientProgram, commandText, commandParam, extendedEventAttributes, auditLocation, osTerminal, clientId, auditPolicies, auditType

Parameters:

  • compartment_id (String)

    A filter to return only resources that match the specified compartment OCID.

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

    the optional parameters

Options Hash (opts):

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

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

  • :opc_request_id (String)

    Unique identifier for the request.

  • :compartment_id_in_subtree (BOOLEAN)

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

  • :access_level (String)

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

  • :limit (Integer)

    For details about how pagination works, see List Pagination.

  • :page (String)

    It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

  • :scim_query (String)

    The scimQuery query parameter accepts filter expressions that use the syntax described in Section 3.2.2.2 of the System for Cross-Domain Identity Management (SCIM) specification, which is available at RFC3339. In SCIM filtering expressions, text, date, and time values must be enclosed in quotation marks, with date and time values using ISO-8601 format. (Numeric and boolean values should not be quoted.)

    Example: query=(operationTime ge '2021-06-04T01-00-26') and (eventName eq 'LOGON')

  • :sort_order (String)

    The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

  • :sort_by (String)

    If this query parameter is specified, the result is sorted by this query parameter value. (default to auditEventTime)

Returns:



10122
10123
10124
10125
10126
10127
10128
10129
10130
10131
10132
10133
10134
10135
10136
10137
10138
10139
10140
10141
10142
10143
10144
10145
10146
10147
10148
10149
10150
10151
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
# File 'lib/oci/data_safe/data_safe_client.rb', line 10122

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

  raise "Missing the required parameter 'compartment_id' when calling list_audit_events." if compartment_id.nil?

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

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

  if opts[:sort_by] && !%w[dbUserName targetName databaseType targetClass auditEventTime timeCollected osUserName operation operationStatus eventName errorCode errorMessage objectType objectName objectOwner clientHostname clientIp isAlerted actionTaken clientProgram commandText commandParam extendedEventAttributes auditLocation osTerminal clientId auditPolicies auditType].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of dbUserName, targetName, databaseType, targetClass, auditEventTime, timeCollected, osUserName, operation, operationStatus, eventName, errorCode, errorMessage, objectType, objectName, objectOwner, clientHostname, clientIp, isAlerted, actionTaken, clientProgram, commandText, commandParam, extendedEventAttributes, auditLocation, osTerminal, clientId, auditPolicies, auditType.'
  end

  path = '/auditEvents'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:compartmentIdInSubtree] = opts[:compartment_id_in_subtree] if !opts[:compartment_id_in_subtree].nil?
  query_params[:accessLevel] = opts[:access_level] if opts[:access_level]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:scimQuery] = opts[:scim_query] if opts[:scim_query]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]

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

  post_body = nil

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

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

Note:

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

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

The ListAuditPolicies operation returns only the audit policies in the specified compartmentId. The list does not include any subcompartments of the compartmentId passed.

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

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

Parameters:

  • compartment_id (String)

    A filter to return only resources that match the specified compartment OCID.

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

    the optional parameters

Options Hash (opts):

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

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

  • :compartment_id_in_subtree (BOOLEAN)

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

  • :access_level (String)

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

  • :display_name (String)

    A filter to return only resources that match the specified display name.

  • :limit (Integer)

    For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

  • :page (String)

    For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

  • :target_id (String)

    A filter to return only items related to a specific target OCID.

  • :lifecycle_state (String)

    The current state of the audit policy.

  • :audit_policy_id (String)

    An optional filter to return only resources that match the specified id.

  • :sort_order (String)

    The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

  • :sort_by (String)

    The field used for sorting. Only one sorting order (sortOrder) can be specified. The default order for TIMECREATED is descending. The default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. (default to TIMECREATED) Allowed values are: TIMECREATED, DISPLAYNAME

  • :opc_request_id (String)

    Unique identifier for the request.

Returns:



10233
10234
10235
10236
10237
10238
10239
10240
10241
10242
10243
10244
10245
10246
10247
10248
10249
10250
10251
10252
10253
10254
10255
10256
10257
10258
10259
10260
10261
10262
10263
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 10233

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

  raise "Missing the required parameter 'compartment_id' when calling list_audit_policies." if compartment_id.nil?

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

  if opts[:lifecycle_state] && !OCI::DataSafe::Models::AUDIT_POLICY_LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::DataSafe::Models::AUDIT_POLICY_LIFECYCLE_STATE_ENUM.'
  end

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

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

  path = '/auditPolicies'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:compartmentIdInSubtree] = opts[:compartment_id_in_subtree] if !opts[:compartment_id_in_subtree].nil?
  query_params[:accessLevel] = opts[:access_level] if opts[:access_level]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:targetId] = opts[:target_id] if opts[:target_id]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:auditPolicyId] = opts[:audit_policy_id] if opts[:audit_policy_id]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]

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

  post_body = nil

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

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

Note:

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

Gets a list of aggregated audit policy details on the target databases. A audit policy aggregation helps understand the overall state of policies provisioned on targets. It is especially useful to create dashboards or to support analytics.

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

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

Example: ListAuditPolicyAnalytics?groupBy=auditPolicyCategory

Parameters:

  • compartment_id (String)

    A filter to return only resources that match the specified compartment OCID.

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

    the optional parameters

Options Hash (opts):

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

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

  • :compartment_id_in_subtree (BOOLEAN)

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

  • :access_level (String)

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

  • :limit (Integer)

    For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

  • :page (String)

    For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

  • :group_by (Array<String>)

    The group by parameter to summarize audit policy aggregation. Allowed values are: auditPolicyCategory, auditPolicyName, targetId

  • :audit_policy_category (String)

    The category to which the audit policy belongs to.

  • :audit_policy_name (String)

    In case of seeded policies, it is the policy name defined by Data Safe. In case of custom Policies, it is the policy name that is used to create the policies on the target database. In case of Oracle Pre-seeded policies, it is the default policy name of the same.

  • :target_id (String)

    A filter to return only items related to a specific target OCID.

  • :lifecycle_state (String)

    The current state of the audit policy.

  • :opc_request_id (String)

    Unique identifier for the request.

Returns:



10349
10350
10351
10352
10353
10354
10355
10356
10357
10358
10359
10360
10361
10362
10363
10364
10365
10366
10367
10368
10369
10370
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
10410
10411
10412
10413
10414
10415
10416
# File 'lib/oci/data_safe/data_safe_client.rb', line 10349

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

  raise "Missing the required parameter 'compartment_id' when calling list_audit_policy_analytics." if compartment_id.nil?

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


  group_by_allowable_values = %w[auditPolicyCategory auditPolicyName targetId]
  if opts[:group_by] && !opts[:group_by].empty?
    opts[:group_by].each do |val_to_check|
      unless group_by_allowable_values.include?(val_to_check)
        raise 'Invalid value for "group_by", must be one of auditPolicyCategory, auditPolicyName, targetId.'
      end
    end
  end

  if opts[:audit_policy_category] && !OCI::DataSafe::Models::AUDIT_POLICY_CATEGORY_ENUM.include?(opts[:audit_policy_category])
    raise 'Invalid value for "audit_policy_category", must be one of the values in OCI::DataSafe::Models::AUDIT_POLICY_CATEGORY_ENUM.'
  end

  if opts[:lifecycle_state] && !OCI::DataSafe::Models::AUDIT_POLICY_LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::DataSafe::Models::AUDIT_POLICY_LIFECYCLE_STATE_ENUM.'
  end

  path = '/auditPolicyAnalytics'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:compartmentIdInSubtree] = opts[:compartment_id_in_subtree] if !opts[:compartment_id_in_subtree].nil?
  query_params[:accessLevel] = opts[:access_level] if opts[:access_level]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:groupBy] = OCI::ApiClient.build_collection_params(opts[:group_by], :multi) if opts[:group_by] && !opts[:group_by].empty?
  query_params[:auditPolicyCategory] = opts[:audit_policy_category] if opts[:audit_policy_category]
  query_params[:auditPolicyName] = opts[:audit_policy_name] if opts[:audit_policy_name]
  query_params[:targetId] = opts[:target_id] if opts[:target_id]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]

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

  post_body = nil

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

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

Note:

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

Gets a list of audit profile aggregated details . A audit profile aggregation helps understand the overall state of audit profile profiles. As an example, it helps understand how many audit profiles have paid usage. It is especially useful to create dashboards or to support analytics.

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

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

Parameters:

  • compartment_id (String)

    A filter to return only resources that match the specified compartment OCID.

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

    the optional parameters

Options Hash (opts):

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

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

  • :compartment_id_in_subtree (BOOLEAN)

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

  • :access_level (String)

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

  • :limit (Integer)

    For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

  • :page (String)

    For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

  • :group_by (Array<String>)

    The group by parameter for summarize operation on audit. Allowed values are: isPaidUsageEnabled

  • :opc_request_id (String)

    Unique identifier for the request.

Returns:



10460
10461
10462
10463
10464
10465
10466
10467
10468
10469
10470
10471
10472
10473
10474
10475
10476
10477
10478
10479
10480
10481
10482
10483
10484
10485
10486
10487
10488
10489
10490
10491
10492
10493
10494
10495
10496
10497
10498
10499
10500
10501
10502
10503
10504
10505
10506
10507
10508
10509
10510
10511
10512
10513
10514
10515
# File 'lib/oci/data_safe/data_safe_client.rb', line 10460

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

  raise "Missing the required parameter 'compartment_id' when calling list_audit_profile_analytics." if compartment_id.nil?

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


  group_by_allowable_values = %w[isPaidUsageEnabled]
  if opts[:group_by] && !opts[:group_by].empty?
    opts[:group_by].each do |val_to_check|
      unless group_by_allowable_values.include?(val_to_check)
        raise 'Invalid value for "group_by", must be one of isPaidUsageEnabled.'
      end
    end
  end

  path = '/auditProfileAnalytics'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:compartmentIdInSubtree] = opts[:compartment_id_in_subtree] if !opts[:compartment_id_in_subtree].nil?
  query_params[:accessLevel] = opts[:access_level] if opts[:access_level]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:groupBy] = OCI::ApiClient.build_collection_params(opts[:group_by], :multi) if opts[:group_by] && !opts[:group_by].empty?

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

  post_body = nil

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

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

Note:

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

Gets a list of all audit profiles.

The ListAuditProfiles operation returns only the audit profiles in the specified compartmentId. The list does not include any subcompartments of the compartmentId passed.

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

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

Parameters:

  • compartment_id (String)

    A filter to return only resources that match the specified compartment OCID.

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

    the optional parameters

Options Hash (opts):

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

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

  • :compartment_id_in_subtree (BOOLEAN)

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

  • :access_level (String)

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

  • :audit_profile_id (String)

    A optional filter to return only resources that match the specified id.

  • :target_id (String)

    A filter to return only items related to a specific target OCID.

  • :display_name (String)

    A filter to return only resources that match the specified display name.

  • :limit (Integer)

    For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

  • :page (String)

    For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

  • :lifecycle_state (String)

    A optional filter to return only resources that match the specified lifecycle state.

  • :is_override_global_retention_setting (BOOLEAN)

    A optional filter to return only resources that match the specified retention configured value.

  • :is_paid_usage_enabled (BOOLEAN)

    Indicates if you want to continue audit record collection beyond the free limit of one million audit records per month per target database, incurring additional charges. The default value is inherited from the global settings. You can change at the global level or at the target level.

  • :audit_collected_volume_greater_than_or_equal_to (Integer)

    A filter to return only items that have count of audit records collected greater than or equal to the specified value.

  • :sort_order (String)

    The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

  • :sort_by (String)

    The field used for sorting. Only one sorting order (sortOrder) can be specified. The default order for TIMECREATED is descending. The default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. (default to TIMECREATED) Allowed values are: TIMECREATED, DISPLAYNAME

  • :opc_request_id (String)

    Unique identifier for the request.

Returns:



10578
10579
10580
10581
10582
10583
10584
10585
10586
10587
10588
10589
10590
10591
10592
10593
10594
10595
10596
10597
10598
10599
10600
10601
10602
10603
10604
10605
10606
10607
10608
10609
10610
10611
10612
10613
10614
10615
10616
10617
10618
10619
10620
10621
10622
10623
10624
10625
10626
10627
10628
10629
10630
10631
10632
10633
10634
10635
10636
10637
10638
10639
10640
10641
10642
10643
# File 'lib/oci/data_safe/data_safe_client.rb', line 10578

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

  raise "Missing the required parameter 'compartment_id' when calling list_audit_profiles." if compartment_id.nil?

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

  if opts[:lifecycle_state] && !OCI::DataSafe::Models::AUDIT_PROFILE_LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::DataSafe::Models::AUDIT_PROFILE_LIFECYCLE_STATE_ENUM.'
  end

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

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

  path = '/auditProfiles'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:compartmentIdInSubtree] = opts[:compartment_id_in_subtree] if !opts[:compartment_id_in_subtree].nil?
  query_params[:accessLevel] = opts[:access_level] if opts[:access_level]
  query_params[:auditProfileId] = opts[:audit_profile_id] if opts[:audit_profile_id]
  query_params[:targetId] = opts[:target_id] if opts[:target_id]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:isOverrideGlobalRetentionSetting] = opts[:is_override_global_retention_setting] if !opts[:is_override_global_retention_setting].nil?
  query_params[:isPaidUsageEnabled] = opts[:is_paid_usage_enabled] if !opts[:is_paid_usage_enabled].nil?
  query_params[:auditCollectedVolumeGreaterThanOrEqualTo] = opts[:audit_collected_volume_greater_than_or_equal_to] if opts[:audit_collected_volume_greater_than_or_equal_to]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]

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

  post_body = nil

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

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

Note:

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

Gets a list of audit trail aggregated details . A audit trail aggregation helps understand the overall state of trails. As an example, it helps understand how many trails are running or stopped. It is especially useful to create dashboards or to support analytics.

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

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

Parameters:

  • compartment_id (String)

    A filter to return only resources that match the specified compartment OCID.

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

    the optional parameters

Options Hash (opts):

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

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

  • :compartment_id_in_subtree (BOOLEAN)

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

  • :access_level (String)

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

  • :limit (Integer)

    For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

  • :page (String)

    For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

  • :group_by (Array<String>)

    The group by parameter for summarize operation on audit trail. Allowed values are: location, lifecycleState, status, targetId

  • :target_id (String)

    A filter to return only items related to a specific target OCID.

  • :opc_request_id (String)

    Unique identifier for the request.

Returns:



10688
10689
10690
10691
10692
10693
10694
10695
10696
10697
10698
10699
10700
10701
10702
10703
10704
10705
10706
10707
10708
10709
10710
10711
10712
10713
10714
10715
10716
10717
10718
10719
10720
10721
10722
10723
10724
10725
10726
10727
10728
10729
10730
10731
10732
10733
10734
10735
10736
10737
10738
10739
10740
10741
10742
10743
10744
# File 'lib/oci/data_safe/data_safe_client.rb', line 10688

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

  raise "Missing the required parameter 'compartment_id' when calling list_audit_trail_analytics." if compartment_id.nil?

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


  group_by_allowable_values = %w[location lifecycleState status targetId]
  if opts[:group_by] && !opts[:group_by].empty?
    opts[:group_by].each do |val_to_check|
      unless group_by_allowable_values.include?(val_to_check)
        raise 'Invalid value for "group_by", must be one of location, lifecycleState, status, targetId.'
      end
    end
  end

  path = '/auditTrailAnalytics'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:compartmentIdInSubtree] = opts[:compartment_id_in_subtree] if !opts[:compartment_id_in_subtree].nil?
  query_params[:accessLevel] = opts[:access_level] if opts[:access_level]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:groupBy] = OCI::ApiClient.build_collection_params(opts[:group_by], :multi) if opts[:group_by] && !opts[:group_by].empty?
  query_params[:targetId] = opts[:target_id] if opts[:target_id]

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

  post_body = nil

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

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

Note:

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

Gets a list of all audit trails. The ListAuditTrails operation returns only the audit trails in the specified compartmentId. The list does not include any subcompartments of the compartmentId passed.

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

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

Parameters:

  • compartment_id (String)

    A filter to return only resources that match the specified compartment OCID.

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

    the optional parameters

Options Hash (opts):

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

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

  • :compartment_id_in_subtree (BOOLEAN)

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

  • :access_level (String)

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

  • :audit_trail_id (String)

    A optional filter to return only resources that match the specified id.

  • :display_name (String)

    A filter to return only resources that match the specified display name.

  • :target_id (String)

    A filter to return only items related to a specific target OCID.

  • :limit (Integer)

    For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

  • :page (String)

    For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

  • :lifecycle_state (String)

    A optional filter to return only resources that match the specified lifecycle state.

  • :status (String)

    A optional filter to return only resources that match the specified sub-state of audit trail.

  • :sort_order (String)

    The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

  • :sort_by (String)

    The field used for sorting. Only one sorting order (sortOrder) can be specified. The default order for TIMECREATED is descending. The default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. (default to TIMECREATED) Allowed values are: TIMECREATED, DISPLAYNAME

  • :opc_request_id (String)

    Unique identifier for the request.

Returns:



10800
10801
10802
10803
10804
10805
10806
10807
10808
10809
10810
10811
10812
10813
10814
10815
10816
10817
10818
10819
10820
10821
10822
10823
10824
10825
10826
10827
10828
10829
10830
10831
10832
10833
10834
10835
10836
10837
10838
10839
10840
10841
10842
10843
10844
10845
10846
10847
10848
10849
10850
10851
10852
10853
10854
10855
10856
10857
10858
10859
10860
10861
10862
10863
10864
10865
10866
10867
# File 'lib/oci/data_safe/data_safe_client.rb', line 10800

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

  raise "Missing the required parameter 'compartment_id' when calling list_audit_trails." if compartment_id.nil?

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

  if opts[:lifecycle_state] && !OCI::DataSafe::Models::AUDIT_TRAIL_LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::DataSafe::Models::AUDIT_TRAIL_LIFECYCLE_STATE_ENUM.'
  end

  if opts[:status] && !OCI::DataSafe::Models::AUDIT_TRAIL_STATUS_ENUM.include?(opts[:status])
    raise 'Invalid value for "status", must be one of the values in OCI::DataSafe::Models::AUDIT_TRAIL_STATUS_ENUM.'
  end

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

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

  path = '/auditTrails'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:compartmentIdInSubtree] = opts[:compartment_id_in_subtree] if !opts[:compartment_id_in_subtree].nil?
  query_params[:accessLevel] = opts[:access_level] if opts[:access_level]
  query_params[:auditTrailId] = opts[:audit_trail_id] if opts[:audit_trail_id]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:targetId] = opts[:target_id] if opts[:target_id]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:status] = opts[:status] if opts[:status]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]

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

  post_body = nil

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

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

Note:

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

Retrieves a list of audit trails, and associated audit event volume for each trail up to defined start date. Allowed values are: monthInConsideration, volume, trailLocation

Parameters:

  • audit_profile_id (String)

    The OCID of the audit.

  • work_request_id (String)

    The OCID of the work request.

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

    the optional parameters

Options Hash (opts):

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

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

  • :trail_location (String)

    The audit trail location.

  • :month_in_consideration_greater_than (DateTime)

    Specifying monthInConsiderationGreaterThan parameter will retrieve all items for which the event month is greater than the date and time specified, in the format defined by RFC3339.

    Example: 2016-12-19T00:00:00.000Z

  • :month_in_consideration_less_than (DateTime)

    Specifying monthInConsiderationLessThan parameter will retrieve all items for which the event month is less than the date and time specified, in the format defined by RFC3339.

    Example: 2016-12-19T00:00:00.000Z

  • :limit (Integer)

    For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

  • :page (String)

    For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

  • :sort_order (String)

    The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

  • :sort_by (String)

    The field to sort by. You can specify only one sort order(sortOrder). The default order for all fields is ascending. (default to monthInConsideration)

  • :opc_request_id (String)

    Unique identifier for the request.

Returns:



10908
10909
10910
10911
10912
10913
10914
10915
10916
10917
10918
10919
10920
10921
10922
10923
10924
10925
10926
10927
10928
10929
10930
10931
10932
10933
10934
10935
10936
10937
10938
10939
10940
10941
10942
10943
10944
10945
10946
10947
10948
10949
10950
10951
10952
10953
10954
10955
10956
10957
10958
10959
10960
10961
# File 'lib/oci/data_safe/data_safe_client.rb', line 10908

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

  raise "Missing the required parameter 'audit_profile_id' when calling list_available_audit_volumes." if audit_profile_id.nil?
  raise "Missing the required parameter 'work_request_id' when calling list_available_audit_volumes." if work_request_id.nil?

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

  if opts[:sort_by] && !%w[monthInConsideration volume trailLocation].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of monthInConsideration, volume, trailLocation.'
  end
  raise "Parameter value for 'audit_profile_id' must not be blank" if OCI::Internal::Util.blank_string?(audit_profile_id)

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

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:workRequestId] = work_request_id
  query_params[:trailLocation] = opts[:trail_location] if opts[:trail_location]
  query_params[:monthInConsiderationGreaterThan] = opts[:month_in_consideration_greater_than] if opts[:month_in_consideration_greater_than]
  query_params[:monthInConsiderationLessThan] = opts[:month_in_consideration_less_than] if opts[:month_in_consideration_less_than]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]

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

  post_body = nil

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

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

Note:

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

Gets a list of all collected audit volume data points. Allowed values are: monthInConsideration, onlineVolume, archivedVolume

Parameters:

  • audit_profile_id (String)

    The OCID of the audit.

  • work_request_id (String)

    The OCID of the work request.

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

    the optional parameters

Options Hash (opts):

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

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

  • :month_in_consideration_greater_than (DateTime)

    Specifying monthInConsiderationGreaterThan parameter will retrieve all items for which the event month is greater than the date and time specified, in the format defined by RFC3339.

    Example: 2016-12-19T00:00:00.000Z

  • :month_in_consideration_less_than (DateTime)

    Specifying monthInConsiderationLessThan parameter will retrieve all items for which the event month is less than the date and time specified, in the format defined by RFC3339.

    Example: 2016-12-19T00:00:00.000Z

  • :limit (Integer)

    For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

  • :page (String)

    For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

  • :sort_order (String)

    The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

  • :sort_by (String)

    The field to sort by. You can specify only one sort order(sortOrder). The default order for all fields is ascending. (default to monthInConsideration)

  • :opc_request_id (String)

    Unique identifier for the request.

Returns:



11001
11002
11003
11004
11005
11006
11007
11008
11009
11010
11011
11012
11013
11014
11015
11016
11017
11018
11019
11020
11021
11022
11023
11024
11025
11026
11027
11028
11029
11030
11031
11032
11033
11034
11035
11036
11037
11038
11039
11040
11041
11042
11043
11044
11045
11046
11047
11048
11049
11050
11051
11052
11053
# File 'lib/oci/data_safe/data_safe_client.rb', line 11001

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:



11086
11087
11088
11089
11090
11091
11092
11093
11094
11095
11096
11097
11098
11099
11100
11101
11102
11103
11104
11105
11106
11107
11108
11109
11110
11111
11112
11113
11114
11115
11116
11117
11118
11119
11120
11121
11122
11123
11124
11125
11126
11127
11128
11129
11130
11131
11132
11133
11134
11135
11136
11137
11138
11139
11140
11141
# File 'lib/oci/data_safe/data_safe_client.rb', line 11086

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:



11182
11183
11184
11185
11186
11187
11188
11189
11190
11191
11192
11193
11194
11195
11196
11197
11198
11199
11200
11201
11202
11203
11204
11205
11206
11207
11208
11209
11210
11211
11212
11213
11214
11215
11216
11217
11218
11219
11220
11221
11222
11223
11224
11225
11226
11227
11228
11229
11230
11231
11232
11233
11234
11235
11236
11237
11238
11239
11240
11241
11242
11243
# File 'lib/oci/data_safe/data_safe_client.rb', line 11182

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

  raise "Missing the required parameter 'compartment_id' when calling list_data_safe_private_endpoints." if compartment_id.nil?

  if opts[:lifecycle_state] && !OCI::DataSafe::Models::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::DataSafe::Models::LIFECYCLE_STATE_ENUM.'
  end

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

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

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

  path = '/dataSafePrivateEndpoints'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:vcnId] = opts[:vcn_id] if opts[:vcn_id]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:compartmentIdInSubtree] = opts[:compartment_id_in_subtree] if !opts[:compartment_id_in_subtree].nil?
  query_params[:accessLevel] = opts[:access_level] if opts[:access_level]

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

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#list_data_safe_private_endpoints') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'Array<OCI::DataSafe::Models::DataSafePrivateEndpointSummary>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

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

Note:

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

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

The ListDatabaseSecurityConfigs operation returns only the database security configurations in the specified compartmentId.

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

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

Parameters:

  • compartment_id (String)

    A filter to return only resources that match the specified compartment OCID.

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

    the optional parameters

Options Hash (opts):

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

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

  • :compartment_id_in_subtree (BOOLEAN)

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

  • :access_level (String)

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

  • :display_name (String)

    A filter to return only resources that match the specified display name.

  • :limit (Integer)

    For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

  • :page (String)

    For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

  • :lifecycle_state (String)

    The current state of the database security configuration.

  • :database_security_config_id (String)

    An optional filter to return only resources that match the specified OCID of the database security configuration resource.

  • :time_created_greater_than_or_equal_to (DateTime)

    A filter to return only the resources that were created after the specified date and time, as defined by RFC3339. Using TimeCreatedGreaterThanOrEqualToQueryParam parameter retrieves all resources created after that date.

    Example: 2016-12-19T16:39:57.600Z

  • :time_created_less_than (DateTime)

    Search for resources that were created before a specific date. Specifying this parameter corresponding timeCreatedLessThan parameter will retrieve all resources created before the specified created date, in "YYYY-MM-ddThh:mmZ" format with a Z offset, as defined by RFC 3339.

    Example: 2016-12-19T16:39:57.600Z

  • :target_id (String)

    A filter to return only items related to a specific target OCID.

  • :sort_order (String)

    The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

  • :sort_by (String)

    The field used for sorting. Only one sorting order (sortOrder) can be specified. The default order for TIMECREATED is descending. The default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. (default to TIMECREATED) Allowed values are: TIMECREATED, DISPLAYNAME

  • :opc_request_id (String)

    Unique identifier for the request.

Returns:



11311
11312
11313
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
11351
11352
11353
11354
11355
11356
11357
11358
11359
11360
11361
11362
11363
11364
11365
11366
11367
11368
11369
11370
11371
11372
11373
11374
11375
# File 'lib/oci/data_safe/data_safe_client.rb', line 11311

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

  raise "Missing the required parameter 'compartment_id' when calling list_database_security_configs." if compartment_id.nil?

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

  if opts[:lifecycle_state] && !OCI::DataSafe::Models::DATABASE_SECURITY_CONFIG_LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::DataSafe::Models::DATABASE_SECURITY_CONFIG_LIFECYCLE_STATE_ENUM.'
  end

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

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

  path = '/databaseSecurityConfigs'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:compartmentIdInSubtree] = opts[:compartment_id_in_subtree] if !opts[:compartment_id_in_subtree].nil?
  query_params[:accessLevel] = opts[:access_level] if opts[:access_level]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:databaseSecurityConfigId] = opts[:database_security_config_id] if opts[:database_security_config_id]
  query_params[:timeCreatedGreaterThanOrEqualTo] = opts[:time_created_greater_than_or_equal_to] if opts[:time_created_greater_than_or_equal_to]
  query_params[:timeCreatedLessThan] = opts[:time_created_less_than] if opts[:time_created_less_than]
  query_params[:targetId] = opts[:target_id] if opts[:target_id]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]

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

  post_body = nil

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

#list_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:



11411
11412
11413
11414
11415
11416
11417
11418
11419
11420
11421
11422
11423
11424
11425
11426
11427
11428
11429
11430
11431
11432
11433
11434
11435
11436
11437
11438
11439
11440
11441
11442
11443
11444
11445
11446
11447
11448
11449
11450
11451
11452
11453
11454
11455
11456
11457
11458
11459
11460
# File 'lib/oci/data_safe/data_safe_client.rb', line 11411

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.

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:



11497
11498
11499
11500
11501
11502
11503
11504
11505
11506
11507
11508
11509
11510
11511
11512
11513
11514
11515
11516
11517
11518
11519
11520
11521
11522
11523
11524
11525
11526
11527
11528
11529
11530
11531
11532
11533
11534
11535
11536
11537
11538
11539
11540
11541
11542
11543
11544
11545
11546
11547
# File 'lib/oci/data_safe/data_safe_client.rb', line 11497

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:



11579
11580
11581
11582
11583
11584
11585
11586
11587
11588
11589
11590
11591
11592
11593
11594
11595
11596
11597
11598
11599
11600
11601
11602
11603
11604
11605
11606
11607
11608
11609
11610
11611
11612
11613
11614
11615
11616
11617
11618
11619
11620
11621
11622
11623
11624
11625
11626
11627
11628
11629
11630
11631
11632
11633
11634
11635
11636
11637
11638
11639
11640
11641
11642
11643
11644
11645
# File 'lib/oci/data_safe/data_safe_client.rb', line 11579

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.

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

Returns:



11679
11680
11681
11682
11683
11684
11685
11686
11687
11688
11689
11690
11691
11692
11693
11694
11695
11696
11697
11698
11699
11700
11701
11702
11703
11704
11705
11706
11707
11708
11709
11710
11711
11712
11713
11714
11715
11716
11717
11718
11719
11720
11721
11722
11723
11724
11725
11726
11727
# File 'lib/oci/data_safe/data_safe_client.rb', line 11679

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

  path = '/discoveryAnalytics'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:compartmentIdInSubtree] = opts[:compartment_id_in_subtree] if !opts[:compartment_id_in_subtree].nil?
  query_params[:groupBy] = opts[:group_by] if opts[:group_by]
  query_params[:targetId] = opts[:target_id] if opts[:target_id]
  query_params[:sensitiveDataModelId] = opts[:sensitive_data_model_id] if opts[:sensitive_data_model_id]
  query_params[: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?

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

  post_body = nil

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

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

Note:

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

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

Parameters:

  • discovery_job_id (String)

    The OCID of the discovery job.

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

    the optional parameters

Options Hash (opts):

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

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

  • :discovery_type (String)

    A filter to return only the resources that match the specified discovery type.

  • :planned_action (String)

    A filter to return only the resources that match the specified planned action.

  • :is_result_applied (BOOLEAN)

    A filter to return the discovery result resources based on the value of their isResultApplied attribute.

  • :schema_name (Array<String>)

    A filter to return only items related to specific schema name.

  • :object_name (Array<String>)

    A filter to return only items related to a specific object name.

  • :column_name (Array<String>)

    A filter to return only a specific column based on column name.

  • :sort_order (String)

    The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

  • :sort_by (String)

    The field to sort by. You can specify only one sorting parameter (sortOrder). The default order for timeFinished is descending. The default order for discoveryType, schemaName, objectName, columnName and plannedAction is ascending. (default to timeFinished) Allowed values are: discoveryType, timeFinished, schemaName, objectName, columnName, plannedAction

  • :opc_request_id (String)

    Unique identifier for the request.

  • :limit (Integer)

    For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

  • :page (String)

    For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

Returns:



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
11793
11794
11795
11796
11797
11798
11799
11800
11801
11802
11803
11804
11805
11806
11807
11808
11809
11810
11811
11812
11813
11814
11815
11816
11817
11818
11819
11820
11821
# File 'lib/oci/data_safe/data_safe_client.rb', line 11759

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

  raise "Missing the required parameter 'discovery_job_id' when calling list_discovery_job_results." if discovery_job_id.nil?

  if opts[:discovery_type] && !OCI::DataSafe::Models::DiscoveryJob::DISCOVERY_TYPE_ENUM.include?(opts[:discovery_type])
    raise 'Invalid value for "discovery_type", must be one of the values in OCI::DataSafe::Models::DiscoveryJob::DISCOVERY_TYPE_ENUM.'
  end

  if opts[:planned_action] && !OCI::DataSafe::Models::DiscoveryJobResult::PLANNED_ACTION_ENUM.include?(opts[:planned_action])
    raise 'Invalid value for "planned_action", must be one of the values in OCI::DataSafe::Models::DiscoveryJobResult::PLANNED_ACTION_ENUM.'
  end

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

  if opts[:sort_by] && !%w[discoveryType timeFinished schemaName objectName columnName plannedAction].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of discoveryType, timeFinished, schemaName, objectName, columnName, plannedAction.'
  end
  raise "Parameter value for 'discovery_job_id' must not be blank" if OCI::Internal::Util.blank_string?(discovery_job_id)

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

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:discoveryType] = opts[:discovery_type] if opts[:discovery_type]
  query_params[:plannedAction] = opts[:planned_action] if opts[:planned_action]
  query_params[:isResultApplied] = opts[:is_result_applied] if !opts[:is_result_applied].nil?
  query_params[:schemaName] = OCI::ApiClient.build_collection_params(opts[:schema_name], :multi) if opts[:schema_name] && !opts[:schema_name].empty?
  query_params[:objectName] = OCI::ApiClient.build_collection_params(opts[:object_name], :multi) if opts[:object_name] && !opts[:object_name].empty?
  query_params[:columnName] = OCI::ApiClient.build_collection_params(opts[:column_name], :multi) if opts[:column_name] && !opts[:column_name].empty?
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]

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

  post_body = nil

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

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

Note:

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

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

Parameters:

  • compartment_id (String)

    A filter to return only resources that match the specified compartment OCID.

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

    the optional parameters

Options Hash (opts):

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

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

  • :compartment_id_in_subtree (BOOLEAN)

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

  • :access_level (String)

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

  • :display_name (String)

    A filter to return only resources that match the specified display name.

  • :discovery_job_id (String)

    A filter to return only the resources that match the specified discovery job OCID.

  • :target_id (String)

    A filter to return only items related to a specific target OCID.

  • :lifecycle_state (String)

    A filter to return only the resources that match the specified lifecycle state.

  • :sensitive_data_model_id (String)

    A filter to return only the resources that match the specified sensitive data model OCID.

  • :sort_order (String)

    The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

  • :sort_by (String)

    The field to sort by. You can specify only one sorting parameter (sortOrder). The default order for timeFinished is descending. The default order for displayName is ascending. (default to timeStarted) Allowed values are: timeStarted, displayName

  • :opc_request_id (String)

    Unique identifier for the request.

  • :limit (Integer)

    For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

  • :page (String)

    For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

Returns:



11862
11863
11864
11865
11866
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
11904
11905
11906
11907
11908
11909
11910
11911
11912
11913
11914
11915
11916
11917
11918
11919
11920
11921
11922
11923
11924
11925
# File 'lib/oci/data_safe/data_safe_client.rb', line 11862

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

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

Returns:



11971
11972
11973
11974
11975
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
12013
12014
12015
12016
12017
12018
12019
12020
12021
12022
12023
12024
12025
12026
12027
12028
12029
12030
12031
12032
# File 'lib/oci/data_safe/data_safe_client.rb', line 11971

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].include?(opts[:group_by])
    raise 'Invalid value for "group_by", must be one of findingKeyAndTopFindingStatus, findingKeyAndSeverity.'
  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

  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]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_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.

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

Parameters:

  • security_assessment_id (String)

    The OCID of the security assessment.

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

    the optional parameters

Options Hash (opts):

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

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

  • :opc_request_id (String)

    Unique identifier for the request.

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

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

  • :limit (Integer)

    For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

  • :page (String)

    For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

  • :compartment_id_in_subtree (BOOLEAN)

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

  • :access_level (String)

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

  • :finding_key (String)

    Each finding in security assessment has an associated key (think of key as a finding's name). For a given finding, the key will be the same across targets. The user can use these keys to filter the findings.

Returns:



12070
12071
12072
12073
12074
12075
12076
12077
12078
12079
12080
12081
12082
12083
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
12121
12122
12123
12124
12125
12126
12127
12128
12129
12130
12131
# File 'lib/oci/data_safe/data_safe_client.rb', line 12070

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

  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

  if opts[:access_level] && !%w[RESTRICTED ACCESSIBLE].include?(opts[:access_level])
    raise 'Invalid value for "access_level", must be one of RESTRICTED, ACCESSIBLE.'
  end
  raise "Parameter value for 'security_assessment_id' must not be blank" if OCI::Internal::Util.blank_string?(security_assessment_id)

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

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:isTopFinding] = opts[:is_top_finding] if !opts[:is_top_finding].nil?
  query_params[:severity] = opts[:severity] if opts[:severity]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:references] = opts[:references] if opts[:references]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:compartmentIdInSubtree] = opts[:compartment_id_in_subtree] if !opts[:compartment_id_in_subtree].nil?
  query_params[:accessLevel] = opts[:access_level] if opts[:access_level]
  query_params[:findingKey] = opts[:finding_key] if opts[:finding_key]

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

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#list_findings') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'Array<OCI::DataSafe::Models::FindingSummary>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_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:



12189
12190
12191
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
12229
12230
12231
12232
12233
12234
12235
12236
12237
12238
12239
12240
12241
12242
12243
12244
12245
12246
12247
12248
12249
12250
# File 'lib/oci/data_safe/data_safe_client.rb', line 12189

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:



12287
12288
12289
12290
12291
12292
12293
12294
12295
12296
12297
12298
12299
12300
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
12338
12339
12340
12341
12342
12343
12344
# File 'lib/oci/data_safe/data_safe_client.rb', line 12287

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

  raise "Missing the required parameter 'user_assessment_id' when calling list_grants." if user_assessment_id.nil?
  raise "Missing the required parameter 'user_key' when calling list_grants." if user_key.nil?

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

  if opts[:sort_by] && !%w[grantName grantType privilegeCategory depthLevel key].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of grantName, grantType, privilegeCategory, depthLevel, key.'
  end
  raise "Parameter value for 'user_assessment_id' must not be blank" if OCI::Internal::Util.blank_string?(user_assessment_id)
  raise "Parameter value for 'user_key' must not be blank" if OCI::Internal::Util.blank_string?(user_key)

  path = '/userAssessments/{userAssessmentId}/users/{userKey}/grants'.sub('{userAssessmentId}', user_assessment_id.to_s).sub('{userKey}', user_key.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:grantKey] = opts[:grant_key] if opts[:grant_key]
  query_params[:grantName] = opts[:grant_name] if opts[:grant_name]
  query_params[:privilegeType] = opts[:privilege_type] if opts[:privilege_type]
  query_params[:privilegeCategory] = opts[:privilege_category] if opts[:privilege_category]
  query_params[:depthLevel] = opts[:depth_level] if opts[:depth_level]
  query_params[:depthLevelGreaterThanOrEqualTo] = opts[:depth_level_greater_than_or_equal_to] if opts[:depth_level_greater_than_or_equal_to]
  query_params[:depthLevelLessThan] = opts[:depth_level_less_than] if opts[:depth_level_less_than]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]

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

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#list_grants') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'Array<OCI::DataSafe::Models::GrantSummary>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

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

Note:

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

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

Parameters:

  • compartment_id (String)

    A filter to return only resources that match the specified compartment OCID.

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

    the optional parameters

Options Hash (opts):

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

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

  • :library_masking_format_id (String)

    A filter to return only the resources that match the specified library masking format OCID.

  • :compartment_id_in_subtree (BOOLEAN)

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

  • :access_level (String)

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

  • :display_name (String)

    A filter to return only resources that match the specified display name.

  • :limit (Integer)

    For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

  • :page (String)

    For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

  • :lifecycle_state (String)

    A filter to return only the resources that match the specified lifecycle states.

  • :time_created_greater_than_or_equal_to (DateTime)

    A filter to return only the resources that were created after the specified date and time, as defined by RFC3339. Using TimeCreatedGreaterThanOrEqualToQueryParam parameter retrieves all resources created after that date.

    Example: 2016-12-19T16:39:57.600Z

  • :time_created_less_than (DateTime)

    Search for resources that were created before a specific date. Specifying this parameter corresponding timeCreatedLessThan parameter will retrieve all resources created before the specified created date, in "YYYY-MM-ddThh:mmZ" format with a Z offset, as defined by RFC 3339.

    Example: 2016-12-19T16:39:57.600Z

  • :library_masking_format_source (String)

    A filter to return the library masking format resources based on the value of their source attribute. (default to USER)

  • :sort_order (String)

    The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

  • :sort_by (String)

    The field to sort by. You can specify only one sorting parameter (sortOrder). The default order for timeCreated is descending. The default order for displayName is ascending. The displayName sort order is case sensitive. (default to timeCreated) Allowed values are: displayName, timeCreated

  • :opc_request_id (String)

    Unique identifier for the request.

Returns:



12398
12399
12400
12401
12402
12403
12404
12405
12406
12407
12408
12409
12410
12411
12412
12413
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
12456
12457
12458
12459
12460
12461
12462
12463
12464
12465
12466
# File 'lib/oci/data_safe/data_safe_client.rb', line 12398

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

  raise "Missing the required parameter 'compartment_id' when calling list_library_masking_formats." if compartment_id.nil?

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

  if opts[:lifecycle_state] && !OCI::DataSafe::Models::MASKING_LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::DataSafe::Models::MASKING_LIFECYCLE_STATE_ENUM.'
  end

  if opts[:library_masking_format_source] && !OCI::DataSafe::Models::LIBRARY_MASKING_FORMAT_SOURCE_ENUM.include?(opts[:library_masking_format_source])
    raise 'Invalid value for "library_masking_format_source", must be one of the values in OCI::DataSafe::Models::LIBRARY_MASKING_FORMAT_SOURCE_ENUM.'
  end

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

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

  path = '/libraryMaskingFormats'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:libraryMaskingFormatId] = opts[:library_masking_format_id] if opts[:library_masking_format_id]
  query_params[:compartmentIdInSubtree] = opts[:compartment_id_in_subtree] if !opts[:compartment_id_in_subtree].nil?
  query_params[:accessLevel] = opts[:access_level] if opts[:access_level]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:timeCreatedGreaterThanOrEqualTo] = opts[:time_created_greater_than_or_equal_to] if opts[:time_created_greater_than_or_equal_to]
  query_params[:timeCreatedLessThan] = opts[:time_created_less_than] if opts[:time_created_less_than]
  query_params[:libraryMaskingFormatSource] = opts[:library_masking_format_source] if opts[:library_masking_format_source]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]

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

  post_body = nil

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

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

Note:

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

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

Allowed values are: schemaName, objectName

Parameters:

  • masking_report_id (String)

    The OCID of the masking report.

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

    the optional parameters

Options Hash (opts):

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

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

  • :limit (Integer)

    For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

  • :page (String)

    For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

  • :sort_order (String)

    The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

  • :sort_by (String)

    The field to sort by. You can specify only one sorting parameter (sortOrder). The default order for all the fields is ascending. (default to schemaName)

  • :schema_name (Array<String>)

    A filter to return only items related to specific schema name.

  • :object_name (Array<String>)

    A filter to return only items related to a specific object name.

  • :column_name (Array<String>)

    A filter to return only a specific column based on column name.

  • :object_type (Array<String>)

    A filter to return only items related to a specific object type. (default to [ALL]) Allowed values are: ALL, TABLE, EDITIONING_VIEW

  • :masking_column_group (Array<String>)

    A filter to return only the resources that match the specified masking column group.

  • :sensitive_type_id (String)

    A filter to return only items related to a specific sensitive type OCID.

  • :opc_request_id (String)

    Unique identifier for the request.

Returns:



12499
12500
12501
12502
12503
12504
12505
12506
12507
12508
12509
12510
12511
12512
12513
12514
12515
12516
12517
12518
12519
12520
12521
12522
12523
12524
12525
12526
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 12499

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

  raise "Missing the required parameter 'masking_report_id' when calling list_masked_columns." if masking_report_id.nil?

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

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


  object_type_allowable_values = %w[ALL TABLE EDITIONING_VIEW]
  if opts[:object_type] && !opts[:object_type].empty?
    opts[:object_type].each do |val_to_check|
      unless object_type_allowable_values.include?(val_to_check)
        raise 'Invalid value for "object_type", must be one of ALL, TABLE, EDITIONING_VIEW.'
      end
    end
  end
  raise "Parameter value for 'masking_report_id' must not be blank" if OCI::Internal::Util.blank_string?(masking_report_id)

  path = '/maskingReports/{maskingReportId}/maskedColumns'.sub('{maskingReportId}', masking_report_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:schemaName] = OCI::ApiClient.build_collection_params(opts[:schema_name], :multi) if opts[:schema_name] && !opts[:schema_name].empty?
  query_params[:objectName] = OCI::ApiClient.build_collection_params(opts[:object_name], :multi) if opts[:object_name] && !opts[:object_name].empty?
  query_params[:columnName] = OCI::ApiClient.build_collection_params(opts[:column_name], :multi) if opts[:column_name] && !opts[:column_name].empty?
  query_params[:objectType] = OCI::ApiClient.build_collection_params(opts[:object_type], :multi) if opts[:object_type] && !opts[:object_type].empty?
  query_params[:maskingColumnGroup] = OCI::ApiClient.build_collection_params(opts[:masking_column_group], :multi) if opts[:masking_column_group] && !opts[:masking_column_group].empty?
  query_params[:sensitiveTypeId] = opts[:sensitive_type_id] if opts[:sensitive_type_id]

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

  post_body = nil

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

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

Note:

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

Gets consolidated masking analytics data based on the specified query parameters. If CompartmentIdInSubtreeQueryParam is specified as true, the behaviour is equivalent to accessLevel "ACCESSIBLE" by default.

Parameters:

  • compartment_id (String)

    A filter to return only resources that match the specified compartment OCID.

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

    the optional parameters

Options Hash (opts):

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

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

  • :compartment_id_in_subtree (BOOLEAN)

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

  • :group_by (String)

    Attribute by which the masking analytics data should be grouped. Allowed values are: targetId, policyId

  • :target_id (String)

    A filter to return only items related to a specific target OCID.

  • :masking_policy_id (String)

    A filter to return only the resources that match the specified masking policy OCID.

  • :limit (Integer)

    For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

  • :page (String)

    For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

  • :opc_request_id (String)

    Unique identifier for the request.

Returns:



12593
12594
12595
12596
12597
12598
12599
12600
12601
12602
12603
12604
12605
12606
12607
12608
12609
12610
12611
12612
12613
12614
12615
12616
12617
12618
12619
12620
12621
12622
12623
12624
12625
12626
12627
12628
12629
12630
12631
12632
12633
12634
12635
12636
12637
12638
12639
# File 'lib/oci/data_safe/data_safe_client.rb', line 12593

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

  raise "Missing the required parameter 'compartment_id' when calling list_masking_analytics." if compartment_id.nil?

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

  path = '/maskingAnalytics'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:compartmentIdInSubtree] = opts[:compartment_id_in_subtree] if !opts[:compartment_id_in_subtree].nil?
  query_params[:groupBy] = opts[:group_by] if opts[:group_by]
  query_params[:targetId] = opts[:target_id] if opts[:target_id]
  query_params[:maskingPolicyId] = opts[:masking_policy_id] if opts[:masking_policy_id]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]

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

  post_body = nil

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

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

Note:

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

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

Parameters:

  • masking_policy_id (String)

    The OCID of the masking policy.

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

    the optional parameters

Options Hash (opts):

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

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

  • :limit (Integer)

    For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

  • :page (String)

    For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

  • :sort_order (String)

    The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

  • :sort_by (String)

    The field to sort by. You can specify only one sorting parameter (sortOrder). The default order for timeCreated is descending. The default order for other fields is ascending. (default to timeCreated) Allowed values are: timeCreated, schemaName, objectName, dataType

  • :masking_column_lifecycle_state (String)

    A filter to return only the resources that match the specified lifecycle states.

  • :data_type (Array<String>)

    A filter to return only resources that match the specified data types. Allowed values are: CHARACTER, DATE, LOB, NUMERIC

  • :schema_name (Array<String>)

    A filter to return only items related to specific schema name.

  • :object_name (Array<String>)

    A filter to return only items related to a specific object name.

  • :column_name (Array<String>)

    A filter to return only a specific column based on column name.

  • :object_type (Array<String>)

    A filter to return only items related to a specific object type. (default to [ALL]) Allowed values are: ALL, TABLE, EDITIONING_VIEW

  • :masking_column_group (Array<String>)

    A filter to return only the resources that match the specified masking column group.

  • :sensitive_type_id (String)

    A filter to return only items related to a specific sensitive type OCID.

  • :is_masking_enabled (BOOLEAN)

    A filter to return the masking column resources based on the value of their isMaskingEnabled attribute. A value of true returns only those columns for which masking is enabled. A value of false returns only those columns for which masking is disabled. Omitting this parameter returns all the masking columns in a masking policy.

  • :is_seed_required (BOOLEAN)

    A filter to return masking columns based on whether the assigned masking formats need a seed value for masking. A value of true returns those masking columns that are using Deterministic Encryption or Deterministic Substitution masking format. (default to false)

  • :time_created_greater_than_or_equal_to (DateTime)

    A filter to return only the resources that were created after the specified date and time, as defined by RFC3339. Using TimeCreatedGreaterThanOrEqualToQueryParam parameter retrieves all resources created after that date.

    Example: 2016-12-19T16:39:57.600Z

  • :time_created_less_than (DateTime)

    Search for resources that were created before a specific date. Specifying this parameter corresponding timeCreatedLessThan parameter will retrieve all resources created before the specified created date, in "YYYY-MM-ddThh:mmZ" format with a Z offset, as defined by RFC 3339.

    Example: 2016-12-19T16:39:57.600Z

  • :time_updated_greater_than_or_equal_to (DateTime)

    Search for resources that were updated after a specific date. Specifying this parameter corresponding timeUpdatedGreaterThanOrEqualTo parameter will retrieve all resources updated after the specified created date, in "YYYY-MM-ddThh:mmZ" format with a Z offset, as defined by RFC 3339.

  • :time_updated_less_than (DateTime)

    Search for resources that were updated before a specific date. Specifying this parameter corresponding timeUpdatedLessThan parameter will retrieve all resources updated before the specified created date, in "YYYY-MM-ddThh:mmZ" format with a Z offset, as defined by RFC 3339.

  • :opc_request_id (String)

    Unique identifier for the request.

Returns:



12709
12710
12711
12712
12713
12714
12715
12716
12717
12718
12719
12720
12721
12722
12723
12724
12725
12726
12727
12728
12729
12730
12731
12732
12733
12734
12735
12736
12737
12738
12739
12740
12741
12742
12743
12744
12745
12746
12747
12748
12749
12750
12751
12752
12753
12754
12755
12756
12757
12758
12759
12760
12761
12762
12763
12764
12765
12766
12767
12768
12769
12770
12771
12772
12773
12774
12775
12776
12777
12778
12779
12780
12781
12782
12783
12784
12785
12786
12787
12788
12789
12790
12791
12792
12793
12794
12795
# File 'lib/oci/data_safe/data_safe_client.rb', line 12709

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

  raise "Missing the required parameter 'masking_policy_id' when calling list_masking_columns." if masking_policy_id.nil?

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

  if opts[:sort_by] && !%w[timeCreated schemaName objectName dataType].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of timeCreated, schemaName, objectName, dataType.'
  end

  if opts[:masking_column_lifecycle_state] && !OCI::DataSafe::Models::MASKING_COLUMN_LIFECYCLE_STATE_ENUM.include?(opts[:masking_column_lifecycle_state])
    raise 'Invalid value for "masking_column_lifecycle_state", must be one of the values in OCI::DataSafe::Models::MASKING_COLUMN_LIFECYCLE_STATE_ENUM.'
  end


  data_type_allowable_values = %w[CHARACTER DATE LOB NUMERIC]
  if opts[:data_type] && !opts[:data_type].empty?
    opts[:data_type].each do |val_to_check|
      unless data_type_allowable_values.include?(val_to_check)
        raise 'Invalid value for "data_type", must be one of CHARACTER, DATE, LOB, NUMERIC.'
      end
    end
  end


  object_type_allowable_values = %w[ALL TABLE EDITIONING_VIEW]
  if opts[:object_type] && !opts[:object_type].empty?
    opts[:object_type].each do |val_to_check|
      unless object_type_allowable_values.include?(val_to_check)
        raise 'Invalid value for "object_type", must be one of ALL, TABLE, EDITIONING_VIEW.'
      end
    end
  end
  raise "Parameter value for 'masking_policy_id' must not be blank" if OCI::Internal::Util.blank_string?(masking_policy_id)

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

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:maskingColumnLifecycleState] = opts[:masking_column_lifecycle_state] if opts[:masking_column_lifecycle_state]
  query_params[:dataType] = OCI::ApiClient.build_collection_params(opts[:data_type], :multi) if opts[:data_type] && !opts[:data_type].empty?
  query_params[:schemaName] = OCI::ApiClient.build_collection_params(opts[:schema_name], :multi) if opts[:schema_name] && !opts[:schema_name].empty?
  query_params[:objectName] = OCI::ApiClient.build_collection_params(opts[:object_name], :multi) if opts[:object_name] && !opts[:object_name].empty?
  query_params[:columnName] = OCI::ApiClient.build_collection_params(opts[:column_name], :multi) if opts[:column_name] && !opts[:column_name].empty?
  query_params[:objectType] = OCI::ApiClient.build_collection_params(opts[:object_type], :multi) if opts[:object_type] && !opts[:object_type].empty?
  query_params[:maskingColumnGroup] = OCI::ApiClient.build_collection_params(opts[:masking_column_group], :multi) if opts[:masking_column_group] && !opts[:masking_column_group].empty?
  query_params[:sensitiveTypeId] = opts[:sensitive_type_id] if opts[:sensitive_type_id]
  query_params[:isMaskingEnabled] = opts[:is_masking_enabled] if !opts[:is_masking_enabled].nil?
  query_params[:isSeedRequired] = opts[:is_seed_required] if !opts[:is_seed_required].nil?
  query_params[:timeCreatedGreaterThanOrEqualTo] = opts[:time_created_greater_than_or_equal_to] if opts[:time_created_greater_than_or_equal_to]
  query_params[:timeCreatedLessThan] = opts[:time_created_less_than] if opts[:time_created_less_than]
  query_params[:timeUpdatedGreaterThanOrEqualTo] = opts[:time_updated_greater_than_or_equal_to] if opts[:time_updated_greater_than_or_equal_to]
  query_params[:timeUpdatedLessThan] = opts[:time_updated_less_than] if opts[:time_updated_less_than]

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

  post_body = nil

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

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

Note:

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

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

Parameters:

  • masking_policy_id (String)

    The OCID of the masking policy.

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

    the optional parameters

Options Hash (opts):

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

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

  • :limit (Integer)

    For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

  • :page (String)

    For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

  • :sort_order (String)

    The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

  • :sort_by (String)

    The field to sort by. You can specify only one sorting parameter (sortOrder). The default order is ascending. (default to schemaName) Allowed values are: schemaName, objectName, objectType

  • :schema_name (Array<String>)

    A filter to return only items related to specific schema name.

  • :object_name (Array<String>)

    A filter to return only items related to a specific object name.

  • :object_type (Array<String>)

    A filter to return only items related to a specific object type. (default to [ALL]) Allowed values are: ALL, TABLE, EDITIONING_VIEW

  • :opc_request_id (String)

    Unique identifier for the request.

Returns:



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

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:



12941
12942
12943
12944
12945
12946
12947
12948
12949
12950
12951
12952
12953
12954
12955
12956
12957
12958
12959
12960
12961
12962
12963
12964
12965
12966
12967
12968
12969
12970
12971
12972
12973
12974
12975
12976
12977
12978
12979
12980
12981
12982
12983
12984
12985
12986
12987
12988
12989
12990
12991
12992
12993
12994
12995
12996
12997
12998
12999
13000
13001
13002
13003
13004
13005
13006
# File 'lib/oci/data_safe/data_safe_client.rb', line 12941

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:



13033
13034
13035
13036
13037
13038
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
13078
13079
13080
13081
13082
13083
13084
13085
13086
# File 'lib/oci/data_safe/data_safe_client.rb', line 13033

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:



13125
13126
13127
13128
13129
13130
13131
13132
13133
13134
13135
13136
13137
13138
13139
13140
13141
13142
13143
13144
13145
13146
13147
13148
13149
13150
13151
13152
13153
13154
13155
13156
13157
13158
13159
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
# File 'lib/oci/data_safe/data_safe_client.rb', line 13125

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_reports(compartment_id, opts = {}) ⇒ Response

Note:

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

Gets a list of masking reports based on the specified query parameters. Allowed values are: timeMaskingFinished

Parameters:

  • compartment_id (String)

    A filter to return only resources that match the specified compartment OCID.

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

    the optional parameters

Options Hash (opts):

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

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

  • :limit (Integer)

    For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

  • :page (String)

    For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

  • :masking_policy_id (String)

    A filter to return only the resources that match the specified masking policy OCID.

  • :target_id (String)

    A filter to return only items related to a specific target OCID.

  • :sort_order (String)

    The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

  • :sort_by (String)

    The field to sort by. You can specify only one sorting parameter (sortOrder). The default order for timeMaskingFinished is descending. (default to timeMaskingFinished)

  • :opc_request_id (String)

    Unique identifier for the request.

  • :compartment_id_in_subtree (BOOLEAN)

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

  • :access_level (String)

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

Returns:



13224
13225
13226
13227
13228
13229
13230
13231
13232
13233
13234
13235
13236
13237
13238
13239
13240
13241
13242
13243
13244
13245
13246
13247
13248
13249
13250
13251
13252
13253
13254
13255
13256
13257
13258
13259
13260
13261
13262
13263
13264
13265
13266
13267
13268
13269
13270
13271
13272
13273
13274
13275
13276
13277
13278
13279
13280
# File 'lib/oci/data_safe/data_safe_client.rb', line 13224

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

  raise "Missing the required parameter 'compartment_id' when calling list_masking_reports." if compartment_id.nil?

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

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

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

  path = '/maskingReports'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:maskingPolicyId] = opts[:masking_policy_id] if opts[:masking_policy_id]
  query_params[:targetId] = opts[:target_id] if opts[:target_id]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:compartmentIdInSubtree] = opts[:compartment_id_in_subtree] if !opts[:compartment_id_in_subtree].nil?
  query_params[:accessLevel] = opts[:access_level] if opts[:access_level]

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

  post_body = nil

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

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

Note:

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

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

Parameters:

  • masking_policy_id (String)

    The OCID of the masking policy.

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

    the optional parameters

Options Hash (opts):

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

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

  • :limit (Integer)

    For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

  • :page (String)

    For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

  • :sort_order (String)

    The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

  • :sort_by (String)

    The field to sort by. You can specify only one sorting parameter (sortOrder). The default order is ascending. (default to schemaName) Allowed values are: schemaName

  • :schema_name (Array<String>)

    A filter to return only items related to specific schema name.

  • :opc_request_id (String)

    Unique identifier for the request.

Returns:



13308
13309
13310
13311
13312
13313
13314
13315
13316
13317
13318
13319
13320
13321
13322
13323
13324
13325
13326
13327
13328
13329
13330
13331
13332
13333
13334
13335
13336
13337
13338
13339
13340
13341
13342
13343
13344
13345
13346
13347
13348
13349
13350
13351
13352
13353
13354
13355
13356
13357
# File 'lib/oci/data_safe/data_safe_client.rb', line 13308

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

  raise "Missing the required parameter 'masking_policy_id' when calling list_masking_schemas." if masking_policy_id.nil?

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

  if opts[:sort_by] && !%w[schemaName].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of schemaName.'
  end
  raise "Parameter value for 'masking_policy_id' must not be blank" if OCI::Internal::Util.blank_string?(masking_policy_id)

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

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:schemaName] = OCI::ApiClient.build_collection_params(opts[:schema_name], :multi) if opts[:schema_name] && !opts[:schema_name].empty?

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

  post_body = nil

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

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

Note:

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

Gets a list of on-premises connectors.

Parameters:

  • compartment_id (String)

    A filter to return only resources that match the specified compartment OCID.

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

    the optional parameters

Options Hash (opts):

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

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

  • :on_prem_connector_id (String)

    A filter to return only the on-premises connector that matches the specified id.

  • :display_name (String)

    A filter to return only resources that match the specified display name.

  • :on_prem_connector_lifecycle_state (String)

    A filter to return only on-premises connector resources that match the specified lifecycle state.

  • :limit (Integer)

    For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

  • :page (String)

    For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

  • :sort_order (String)

    The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

  • :sort_by (String)

    The field used for sorting. Only one sorting order (sortOrder) can be specified. The default order for TIMECREATED is descending. The default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. (default to TIMECREATED) Allowed values are: TIMECREATED, DISPLAYNAME

  • :opc_request_id (String)

    Unique identifier for the request.

  • :compartment_id_in_subtree (BOOLEAN)

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

  • :access_level (String)

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

Returns:



13398
13399
13400
13401
13402
13403
13404
13405
13406
13407
13408
13409
13410
13411
13412
13413
13414
13415
13416
13417
13418
13419
13420
13421
13422
13423
13424
13425
13426
13427
13428
13429
13430
13431
13432
13433
13434
13435
13436
13437
13438
13439
13440
13441
13442
13443
13444
13445
13446
13447
13448
13449
13450
13451
13452
13453
13454
13455
13456
13457
13458
13459
# File 'lib/oci/data_safe/data_safe_client.rb', line 13398

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

  raise "Missing the required parameter 'compartment_id' when calling list_on_prem_connectors." if compartment_id.nil?

  if opts[:on_prem_connector_lifecycle_state] && !OCI::DataSafe::Models::ON_PREM_CONNECTOR_LIFECYCLE_STATE_ENUM.include?(opts[:on_prem_connector_lifecycle_state])
    raise 'Invalid value for "on_prem_connector_lifecycle_state", must be one of the values in OCI::DataSafe::Models::ON_PREM_CONNECTOR_LIFECYCLE_STATE_ENUM.'
  end

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

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

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

  path = '/onPremConnectors'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:onPremConnectorId] = opts[:on_prem_connector_id] if opts[:on_prem_connector_id]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:onPremConnectorLifecycleState] = opts[:on_prem_connector_lifecycle_state] if opts[:on_prem_connector_lifecycle_state]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:compartmentIdInSubtree] = opts[:compartment_id_in_subtree] if !opts[:compartment_id_in_subtree].nil?
  query_params[:accessLevel] = opts[:access_level] if opts[:access_level]

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

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#list_on_prem_connectors') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'Array<OCI::DataSafe::Models::OnPremConnectorSummary>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_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:



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
13524
13525
13526
13527
13528
13529
13530
13531
# File 'lib/oci/data_safe/data_safe_client.rb', line 13490

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:



13585
13586
13587
13588
13589
13590
13591
13592
13593
13594
13595
13596
13597
13598
13599
13600
13601
13602
13603
13604
13605
13606
13607
13608
13609
13610
13611
13612
13613
13614
13615
13616
13617
13618
13619
13620
13621
13622
13623
13624
13625
13626
13627
13628
13629
13630
13631
13632
13633
13634
13635
13636
13637
13638
13639
13640
13641
13642
13643
# File 'lib/oci/data_safe/data_safe_client.rb', line 13585

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:



13725
13726
13727
13728
13729
13730
13731
13732
13733
13734
13735
13736
13737
13738
13739
13740
13741
13742
13743
13744
13745
13746
13747
13748
13749
13750
13751
13752
13753
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
# File 'lib/oci/data_safe/data_safe_client.rb', line 13725

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

  raise "Missing the required parameter 'user_assessment_id' when calling list_profile_summaries." if user_assessment_id.nil?
  raise "Missing the required parameter 'compartment_id' when calling list_profile_summaries." if compartment_id.nil?

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

  if opts[:sort_by] && !%w[profileName targetId isUserCreated passwordVerificationFunction userCount sessionsPerUser inactiveAccountTime passwordLockTime failedLoginAttempts].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of profileName, targetId, isUserCreated, passwordVerificationFunction, userCount, sessionsPerUser, inactiveAccountTime, passwordLockTime, failedLoginAttempts.'
  end

  if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of ASC, DESC.'
  end
  raise "Parameter value for 'user_assessment_id' must not be blank" if OCI::Internal::Util.blank_string?(user_assessment_id)

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

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:compartmentIdInSubtree] = opts[:compartment_id_in_subtree] if !opts[:compartment_id_in_subtree].nil?
  query_params[:accessLevel] = opts[:access_level] if opts[:access_level]
  query_params[:targetId] = opts[:target_id] if opts[:target_id]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:profileName] = opts[:profile_name] if opts[:profile_name]
  query_params[:isUserCreated] = opts[:is_user_created] if !opts[:is_user_created].nil?
  query_params[:passwordVerificationFunction] = opts[:password_verification_function] if opts[:password_verification_function]
  query_params[:userCountGreaterThanOrEqual] = opts[:user_count_greater_than_or_equal] if opts[:user_count_greater_than_or_equal]
  query_params[:userCountLessThan] = opts[:user_count_less_than] if opts[:user_count_less_than]
  query_params[:failedLoginAttemptsGreaterThanOrEqual] = opts[:failed_login_attempts_greater_than_or_equal] if opts[:failed_login_attempts_greater_than_or_equal]
  query_params[:failedLoginAttemptsLessThan] = opts[:failed_login_attempts_less_than] if opts[:failed_login_attempts_less_than]
  query_params[:sessionsPerUserGreaterThanOrEqual] = opts[:sessions_per_user_greater_than_or_equal] if opts[:sessions_per_user_greater_than_or_equal]
  query_params[:sessionsPerUserLessThan] = opts[:sessions_per_user_less_than] if opts[:sessions_per_user_less_than]
  query_params[:inactiveAccountTimeGreaterThanOrEqual] = opts[:inactive_account_time_greater_than_or_equal] if opts[:inactive_account_time_greater_than_or_equal]
  query_params[:inactiveAccountTimeLessThan] = opts[:inactive_account_time_less_than] if opts[:inactive_account_time_less_than]
  query_params[:passwordLockTimeGreaterThanOrEqual] = opts[:password_lock_time_greater_than_or_equal] if opts[:password_lock_time_greater_than_or_equal]
  query_params[:passwordLockTimeLessThan] = opts[:password_lock_time_less_than] if opts[:password_lock_time_less_than]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]

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

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#list_profile_summaries') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'Array<OCI::DataSafe::Models::ProfileSummary>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

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

Note:

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

Gets a list of report definitions. The ListReportDefinitions operation returns only the report definitions in the specified compartmentId. It also returns the seeded report definitions which are available to all the compartments.

Parameters:

  • compartment_id (String)

    A filter to return only resources that match the specified compartment OCID.

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

    the optional parameters

Options Hash (opts):

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

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

  • :compartment_id_in_subtree (BOOLEAN)

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

  • :access_level (String)

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

  • :display_name (String)

    The name of the report definition to query.

  • :limit (Integer)

    For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

  • :page (String)

    For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

  • :sort_order (String)

    The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

  • :sort_by (String)

    The field used for sorting. Only one sorting parameter order (sortOrder) can be specified. The default order for TIMECREATED is descending. The default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. (default to TIMECREATED) Allowed values are: TIMECREATED, DISPLAYNAME, DISPLAYORDER

  • :opc_request_id (String)

    Unique identifier for the request.

  • :is_seeded (BOOLEAN)

    A boolean flag indicating to list seeded report definitions. Set this parameter to get list of seeded report definitions. (default to false)

  • :data_source (String)

    Specifies the name of a resource that provides data for the report. For example alerts, events.

  • :lifecycle_state (String)

    An optional filter to return only resources that match the specified lifecycle state.

  • :category (String)

    An optional filter to return only resources that match the specified category. Allowed values are: CUSTOM_REPORTS, SUMMARY, ACTIVITY_AUDITING

Returns:



13840
13841
13842
13843
13844
13845
13846
13847
13848
13849
13850
13851
13852
13853
13854
13855
13856
13857
13858
13859
13860
13861
13862
13863
13864
13865
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
# File 'lib/oci/data_safe/data_safe_client.rb', line 13840

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

  raise "Missing the required parameter 'compartment_id' when calling list_report_definitions." if compartment_id.nil?

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

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

  if opts[:sort_by] && !%w[TIMECREATED DISPLAYNAME DISPLAYORDER].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of TIMECREATED, DISPLAYNAME, DISPLAYORDER.'
  end

  if opts[:data_source] && !OCI::DataSafe::Models::REPORT_DEFINITION_DATA_SOURCE_ENUM.include?(opts[:data_source])
    raise 'Invalid value for "data_source", must be one of the values in OCI::DataSafe::Models::REPORT_DEFINITION_DATA_SOURCE_ENUM.'
  end

  if opts[:lifecycle_state] && !OCI::DataSafe::Models::REPORT_DEFINITION_LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::DataSafe::Models::REPORT_DEFINITION_LIFECYCLE_STATE_ENUM.'
  end

  if opts[:category] && !%w[CUSTOM_REPORTS SUMMARY ACTIVITY_AUDITING].include?(opts[:category])
    raise 'Invalid value for "category", must be one of CUSTOM_REPORTS, SUMMARY, ACTIVITY_AUDITING.'
  end

  path = '/reportDefinitions'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:compartmentIdInSubtree] = opts[:compartment_id_in_subtree] if !opts[:compartment_id_in_subtree].nil?
  query_params[:accessLevel] = opts[:access_level] if opts[:access_level]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:isSeeded] = opts[:is_seeded] if !opts[:is_seeded].nil?
  query_params[:dataSource] = opts[:data_source] if opts[:data_source]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:category] = opts[:category] if opts[:category]

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

  post_body = nil

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

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

Note:

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

Gets a list of all the reports in the compartment. It contains information such as report generation time. Allowed values are: timeGenerated, displayName

Parameters:

  • compartment_id (String)

    A filter to return only resources that match the specified compartment OCID.

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

    the optional parameters

Options Hash (opts):

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

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

  • :compartment_id_in_subtree (BOOLEAN)

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

  • :access_level (String)

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

  • :display_name (String)

    The name of the report definition to query.

  • :limit (Integer)

    For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

  • :page (String)

    For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

  • :sort_order (String)

    The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

  • :sort_by (String)

    The field to sort by. Only one sort order may be provided. Default order for timeGenerated is descending. Default order for displayName is ascending. If no value is specified timeGenerated is default. (default to timeGenerated)

  • :report_definition_id (String)

    The ID of the report definition to filter the list of reports

  • :opc_request_id (String)

    Unique identifier for the request.

  • :lifecycle_state (String)

    An optional filter to return only resources that match the specified lifecycle state.

  • :type (String)

    An optional filter to return only resources that match the specified type.

Returns:



13949
13950
13951
13952
13953
13954
13955
13956
13957
13958
13959
13960
13961
13962
13963
13964
13965
13966
13967
13968
13969
13970
13971
13972
13973
13974
13975
13976
13977
13978
13979
13980
13981
13982
13983
13984
13985
13986
13987
13988
13989
13990
13991
13992
13993
13994
13995
13996
13997
13998
13999
14000
14001
14002
14003
14004
14005
14006
14007
14008
14009
14010
14011
14012
14013
14014
14015
# File 'lib/oci/data_safe/data_safe_client.rb', line 13949

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

  raise "Missing the required parameter 'compartment_id' when calling list_reports." if compartment_id.nil?

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

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

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

  if opts[:lifecycle_state] && !OCI::DataSafe::Models::REPORT_LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::DataSafe::Models::REPORT_LIFECYCLE_STATE_ENUM.'
  end

  if opts[:type] && !OCI::DataSafe::Models::REPORT_TYPE_ENUM.include?(opts[:type])
    raise 'Invalid value for "type", must be one of the values in OCI::DataSafe::Models::REPORT_TYPE_ENUM.'
  end

  path = '/reports'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:compartmentIdInSubtree] = opts[:compartment_id_in_subtree] if !opts[:compartment_id_in_subtree].nil?
  query_params[:accessLevel] = opts[:access_level] if opts[:access_level]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:reportDefinitionId] = opts[:report_definition_id] if opts[:report_definition_id]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:type] = opts[:type] if opts[:type]

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

  post_body = nil

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

#list_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:



14040
14041
14042
14043
14044
14045
14046
14047
14048
14049
14050
14051
14052
14053
14054
14055
14056
14057
14058
14059
14060
14061
14062
14063
14064
14065
14066
14067
14068
14069
14070
14071
14072
14073
14074
14075
14076
14077
14078
14079
14080
14081
14082
# File 'lib/oci/data_safe/data_safe_client.rb', line 14040

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:



14112
14113
14114
14115
14116
14117
14118
14119
14120
14121
14122
14123
14124
14125
14126
14127
14128
14129
14130
14131
14132
14133
14134
14135
14136
14137
14138
14139
14140
14141
14142
14143
14144
14145
14146
14147
14148
14149
14150
14151
14152
14153
14154
14155
14156
14157
14158
14159
14160
14161
14162
14163
14164
# File 'lib/oci/data_safe/data_safe_client.rb', line 14112

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:



14193
14194
14195
14196
14197
14198
14199
14200
14201
14202
14203
14204
14205
14206
14207
14208
14209
14210
14211
14212
14213
14214
14215
14216
14217
14218
14219
14220
14221
14222
14223
14224
14225
14226
14227
14228
14229
14230
14231
14232
14233
14234
14235
14236
14237
14238
14239
14240
14241
14242
14243
14244
# File 'lib/oci/data_safe/data_safe_client.rb', line 14193

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:



14284
14285
14286
14287
14288
14289
14290
14291
14292
14293
14294
14295
14296
14297
14298
14299
14300
14301
14302
14303
14304
14305
14306
14307
14308
14309
14310
14311
14312
14313
14314
14315
14316
14317
14318
14319
14320
14321
14322
14323
14324
14325
14326
14327
14328
14329
14330
14331
14332
14333
14334
14335
14336
14337
14338
14339
14340
14341
14342
14343
14344
14345
14346
# File 'lib/oci/data_safe/data_safe_client.rb', line 14284

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

  raise "Missing the required parameter 'compartment_id' when calling list_sdm_masking_policy_differences." if compartment_id.nil?

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

  if opts[:lifecycle_state] && !OCI::DataSafe::Models::SdmMaskingPolicyDifference::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::DataSafe::Models::SdmMaskingPolicyDifference::LIFECYCLE_STATE_ENUM.'
  end

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

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

  path = '/sdmMaskingPolicyDifferences'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:compartmentIdInSubtree] = opts[:compartment_id_in_subtree] if !opts[:compartment_id_in_subtree].nil?
  query_params[:differenceAccessLevel] = opts[:difference_access_level] if opts[:difference_access_level]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:sensitiveDataModelId] = opts[:sensitive_data_model_id] if opts[:sensitive_data_model_id]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:maskingPolicyId] = opts[:masking_policy_id] if opts[:masking_policy_id]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]

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

  post_body = nil

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

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

Note:

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

Gets a list of security assessments.

The ListSecurityAssessments operation returns only the assessments in the specified compartmentId. The list does not include any subcompartments of the compartmentId passed.

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

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

Allowed values are: timeCreated, displayName

Parameters:

  • compartment_id (String)

    A filter to return only resources that match the specified compartment OCID.

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

    the optional parameters

Options Hash (opts):

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

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

  • :compartment_id_in_subtree (BOOLEAN)

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

  • :access_level (String)

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

  • :display_name (String)

    A filter to return only resources that match the specified display name.

  • :type (String)

    A filter to return only items that match the specified security assessment type. Allowed values are: LATEST, SAVED, SAVE_SCHEDULE, COMPARTMENT

  • :schedule_assessment_id (String)

    The OCID of the security assessment of type SAVE_SCHEDULE.

  • :is_schedule_assessment (BOOLEAN)

    A filter to return only security assessments of type save schedule. (default to false)

  • :triggered_by (String)

    A filter to return only security asessments that were created by either user or system. Allowed values are: USER, SYSTEM

  • :target_id (String)

    A filter to return only items related to a specific target OCID.

  • :sort_order (String)

    The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

  • :is_baseline (BOOLEAN)

    A filter to return only the security assessments that are set as a baseline. (default to false)

  • :sort_by (String)

    The field to sort by. You can specify only one sort order(sortOrder). The default order for timeCreated is descending. (default to timeCreated)

  • :time_created_greater_than_or_equal_to (DateTime)

    A filter to return only the resources that were created after the specified date and time, as defined by RFC3339. Using TimeCreatedGreaterThanOrEqualToQueryParam parameter retrieves all resources created after that date.

    Example: 2016-12-19T16:39:57.600Z

  • :time_created_less_than (DateTime)

    Search for resources that were created before a specific date. Specifying this parameter corresponding timeCreatedLessThan parameter will retrieve all resources created before the specified created date, in "YYYY-MM-ddThh:mmZ" format with a Z offset, as defined by RFC 3339.

    Example: 2016-12-19T16:39:57.600Z

  • :opc_request_id (String)

    Unique identifier for the request.

  • :limit (Integer)

    For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

  • :page (String)

    For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

  • :lifecycle_state (String)

    A filter to return only resources that match the specified lifecycle state.

Returns:



14420
14421
14422
14423
14424
14425
14426
14427
14428
14429
14430
14431
14432
14433
14434
14435
14436
14437
14438
14439
14440
14441
14442
14443
14444
14445
14446
14447
14448
14449
14450
14451
14452
14453
14454
14455
14456
14457
14458
14459
14460
14461
14462
14463
14464
14465
14466
14467
14468
14469
14470
14471
14472
14473
14474
14475
14476
14477
14478
14479
14480
14481
14482
14483
14484
14485
14486
14487
14488
14489
14490
14491
14492
14493
14494
14495
14496
# File 'lib/oci/data_safe/data_safe_client.rb', line 14420

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

  raise "Missing the required parameter 'compartment_id' when calling list_security_assessments." if compartment_id.nil?

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

  if opts[:type] && !%w[LATEST SAVED SAVE_SCHEDULE COMPARTMENT].include?(opts[:type])
    raise 'Invalid value for "type", must be one of LATEST, SAVED, SAVE_SCHEDULE, COMPARTMENT.'
  end

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

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

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

  if opts[:lifecycle_state] && !OCI::DataSafe::Models::SECURITY_ASSESSMENT_LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::DataSafe::Models::SECURITY_ASSESSMENT_LIFECYCLE_STATE_ENUM.'
  end

  path = '/securityAssessments'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:compartmentIdInSubtree] = opts[:compartment_id_in_subtree] if !opts[:compartment_id_in_subtree].nil?
  query_params[:accessLevel] = opts[:access_level] if opts[:access_level]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:type] = opts[:type] if opts[:type]
  query_params[:scheduleAssessmentId] = opts[:schedule_assessment_id] if opts[:schedule_assessment_id]
  query_params[:isScheduleAssessment] = opts[:is_schedule_assessment] if !opts[:is_schedule_assessment].nil?
  query_params[:triggeredBy] = opts[:triggered_by] if opts[:triggered_by]
  query_params[:targetId] = opts[:target_id] if opts[:target_id]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:isBaseline] = opts[:is_baseline] if !opts[:is_baseline].nil?
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:timeCreatedGreaterThanOrEqualTo] = opts[:time_created_greater_than_or_equal_to] if opts[:time_created_greater_than_or_equal_to]
  query_params[:timeCreatedLessThan] = opts[:time_created_less_than] if opts[:time_created_less_than]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]

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

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#list_security_assessments') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'Array<OCI::DataSafe::Models::SecurityAssessmentSummary>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_security_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.

Returns:



14532
14533
14534
14535
14536
14537
14538
14539
14540
14541
14542
14543
14544
14545
14546
14547
14548
14549
14550
14551
14552
14553
14554
14555
14556
14557
14558
14559
14560
14561
14562
14563
14564
14565
14566
14567
14568
14569
14570
14571
14572
14573
14574
14575
# File 'lib/oci/data_safe/data_safe_client.rb', line 14532

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]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_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.

Returns:



14628
14629
14630
14631
14632
14633
14634
14635
14636
14637
14638
14639
14640
14641
14642
14643
14644
14645
14646
14647
14648
14649
14650
14651
14652
14653
14654
14655
14656
14657
14658
14659
14660
14661
14662
14663
14664
14665
14666
14667
14668
14669
14670
14671
14672
14673
14674
14675
14676
14677
14678
14679
14680
14681
14682
14683
14684
14685
14686
14687
14688
14689
14690
14691
14692
14693
14694
14695
14696
14697
14698
14699
14700
14701
14702
14703
14704
14705
14706
14707
14708
14709
14710
14711
14712
14713
14714
14715
14716
14717
14718
14719
14720
14721
14722
14723
14724
14725
14726
14727
14728
# File 'lib/oci/data_safe/data_safe_client.rb', line 14628

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]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_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_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:



14782
14783
14784
14785
14786
14787
14788
14789
14790
14791
14792
14793
14794
14795
14796
14797
14798
14799
14800
14801
14802
14803
14804
14805
14806
14807
14808
14809
14810
14811
14812
14813
14814
14815
14816
14817
14818
14819
14820
14821
14822
14823
14824
14825
14826
14827
14828
14829
14830
14831
14832
14833
14834
14835
14836
14837
14838
14839
14840
14841
14842
14843
# File 'lib/oci/data_safe/data_safe_client.rb', line 14782

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

  raise "Missing the required parameter 'compartment_id' when calling list_security_policies." if compartment_id.nil?

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

  if opts[:lifecycle_state] && !OCI::DataSafe::Models::SECURITY_POLICY_LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::DataSafe::Models::SECURITY_POLICY_LIFECYCLE_STATE_ENUM.'
  end

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

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

  path = '/securityPolicies'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:compartmentIdInSubtree] = opts[:compartment_id_in_subtree] if !opts[:compartment_id_in_subtree].nil?
  query_params[:accessLevel] = opts[:access_level] if opts[:access_level]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:securityPolicyId] = opts[:security_policy_id] if opts[:security_policy_id]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]

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

  post_body = nil

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

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

Note:

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

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

The ListSecurityPolicyDeployments operation returns only the security policy deployments in the specified compartmentId.

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

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

Parameters:

  • compartment_id (String)

    A filter to return only resources that match the specified compartment OCID.

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

    the optional parameters

Options Hash (opts):

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

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

  • :compartment_id_in_subtree (BOOLEAN)

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

  • :access_level (String)

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

  • :display_name (String)

    A filter to return only resources that match the specified display name.

  • :limit (Integer)

    For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

  • :page (String)

    For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

  • :lifecycle_state (String)

    The current state of the security policy deployment.

  • :security_policy_deployment_id (String)

    An optional filter to return only resources that match the specified OCID of the security policy deployment resource.

  • :target_id (String)

    A filter to return only items related to a specific target OCID.

  • :security_policy_id (String)

    An optional filter to return only resources that match the specified OCID of the security policy resource.

  • :sort_order (String)

    The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

  • :sort_by (String)

    The field used for sorting. Only one sorting order (sortOrder) can be specified. The default order for TIMECREATED is descending. The default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. (default to TIMECREATED) Allowed values are: TIMECREATED, DISPLAYNAME

  • :opc_request_id (String)

    Unique identifier for the request.

Returns:



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
14933
14934
14935
14936
14937
14938
14939
14940
14941
14942
14943
14944
14945
14946
14947
14948
14949
14950
14951
14952
14953
14954
14955
14956
14957
14958
14959
14960
14961
14962
# File 'lib/oci/data_safe/data_safe_client.rb', line 14899

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

  raise "Missing the required parameter 'compartment_id' when calling list_security_policy_deployments." if compartment_id.nil?

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

  if opts[:lifecycle_state] && !OCI::DataSafe::Models::SECURITY_POLICY_DEPLOYMENT_LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::DataSafe::Models::SECURITY_POLICY_DEPLOYMENT_LIFECYCLE_STATE_ENUM.'
  end

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

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

  path = '/securityPolicyDeployments'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:compartmentIdInSubtree] = opts[:compartment_id_in_subtree] if !opts[:compartment_id_in_subtree].nil?
  query_params[:accessLevel] = opts[:access_level] if opts[:access_level]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:securityPolicyDeploymentId] = opts[:security_policy_deployment_id] if opts[:security_policy_deployment_id]
  query_params[:targetId] = opts[:target_id] if opts[:target_id]
  query_params[:securityPolicyId] = opts[:security_policy_id] if opts[:security_policy_id]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]

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

  post_body = nil

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

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

Note:

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

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

The ListSecurityPolicyEntryStates operation returns only the security policy entry states for the specified security policy entry.

Parameters:

  • security_policy_deployment_id (String)

    The OCID of the security policy deployment resource.

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

    the optional parameters

Options Hash (opts):

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

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

  • :limit (Integer)

    For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

  • :page (String)

    For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

  • :deployment_status (String)

    The current state of the security policy deployment.

  • :security_policy_entry_id (String)

    An optional filter to return only resources that match the specified security policy entry OCID.

  • :opc_request_id (String)

    Unique identifier for the request.

Returns:



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

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

  raise "Missing the required parameter 'security_policy_deployment_id' when calling list_security_policy_entry_states." if security_policy_deployment_id.nil?

  if opts[:deployment_status] && !OCI::DataSafe::Models::SECURITY_POLICY_ENTRY_STATE_DEPLOYMENT_STATUS_ENUM.include?(opts[:deployment_status])
    raise 'Invalid value for "deployment_status", must be one of the values in OCI::DataSafe::Models::SECURITY_POLICY_ENTRY_STATE_DEPLOYMENT_STATUS_ENUM.'
  end
  raise "Parameter value for 'security_policy_deployment_id' must not be blank" if OCI::Internal::Util.blank_string?(security_policy_deployment_id)

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

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:deploymentStatus] = opts[:deployment_status] if opts[:deployment_status]
  query_params[:securityPolicyEntryId] = opts[:security_policy_entry_id] if opts[:security_policy_entry_id]

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

  post_body = nil

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

#list_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:



15086
15087
15088
15089
15090
15091
15092
15093
15094
15095
15096
15097
15098
15099
15100
15101
15102
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
# File 'lib/oci/data_safe/data_safe_client.rb', line 15086

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_columns(sensitive_data_model_id, opts = {}) ⇒ Response

Note:

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

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

Parameters:

  • sensitive_data_model_id (String)

    The OCID of the sensitive data model.

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

    the optional parameters

Options Hash (opts):

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

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

  • :time_created_greater_than_or_equal_to (DateTime)

    A filter to return only the resources that were created after the specified date and time, as defined by RFC3339. Using TimeCreatedGreaterThanOrEqualToQueryParam parameter retrieves all resources created after that date.

    Example: 2016-12-19T16:39:57.600Z

  • :time_created_less_than (DateTime)

    Search for resources that were created before a specific date. Specifying this parameter corresponding timeCreatedLessThan parameter will retrieve all resources created before the specified created date, in "YYYY-MM-ddThh:mmZ" format with a Z offset, as defined by RFC 3339.

    Example: 2016-12-19T16:39:57.600Z

  • :time_updated_greater_than_or_equal_to (DateTime)

    Search for resources that were updated after a specific date. Specifying this parameter corresponding timeUpdatedGreaterThanOrEqualTo parameter will retrieve all resources updated after the specified created date, in "YYYY-MM-ddThh:mmZ" format with a Z offset, as defined by RFC 3339.

  • :time_updated_less_than (DateTime)

    Search for resources that were updated before a specific date. Specifying this parameter corresponding timeUpdatedLessThan parameter will retrieve all resources updated before the specified created date, in "YYYY-MM-ddThh:mmZ" format with a Z offset, as defined by RFC 3339.

  • :sensitive_column_lifecycle_state (String)

    Filters the sensitive column resources with the given lifecycle state values.

  • :schema_name (Array<String>)

    A filter to return only items related to specific schema name.

  • :object_name (Array<String>)

    A filter to return only items related to a specific object name.

  • :column_name (Array<String>)

    A filter to return only a specific column based on column name.

  • :object_type (Array<String>)

    A filter to return only items related to a specific object type. (default to [ALL]) Allowed values are: ALL, TABLE, EDITIONING_VIEW

  • :data_type (Array<String>)

    A filter to return only the resources that match the specified data types.

  • :status (Array<String>)

    A filter to return only the sensitive columns that match the specified status. Allowed values are: VALID, INVALID

  • :sensitive_type_id (Array<String>)

    A filter to return only the sensitive columns that are associated with one of the sensitive types identified by the specified OCIDs.

  • :parent_column_key (Array<String>)

    A filter to return only the sensitive columns that are children of one of the columns identified by the specified keys.

  • :relation_type (Array<String>)

    A filter to return sensitive columns based on their relationship with their parent columns. If set to NONE, it returns the sensitive columns that do not have any parent. The response includes the parent columns as well as the independent columns that are not in any relationship. If set to APP_DEFINED, it returns all the child columns that have application-level (non-dictionary) relationship with their parents. If set to DB_DEFINED, it returns all the child columns that have database-level (dictionary-defined) relationship with their parents.

    Allowed values are: NONE, APP_DEFINED, DB_DEFINED

  • :column_group (String)

    A filter to return only the sensitive columns that belong to the specified column group.

  • :limit (Integer)

    For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

  • :page (String)

    For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

  • :sort_order (String)

    The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

  • :sort_by (String)

    The field to sort by. You can specify only one sorting parameter (sortOrder). The default order for timeCreated is descending. The default order for schemaName, objectName, and columnName is ascending. (default to timeCreated) Allowed values are: timeCreated, schemaName, objectName, columnName, dataType

  • :opc_request_id (String)

    Unique identifier for the request.

  • :is_case_in_sensitive (BOOLEAN)

    A boolean flag indicating whether the search should be case-insensitive. The search is case-sensitive by default. Set this parameter to true to do case-insensitive search.

Returns:



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
15254
15255
15256
15257
15258
15259
15260
15261
15262
15263
15264
15265
15266
15267
15268
15269
15270
15271
15272
15273
15274
15275
15276
15277
15278
15279
15280
15281
15282
15283
15284
15285
15286
15287
15288
15289
15290
15291
15292
15293
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
# File 'lib/oci/data_safe/data_safe_client.rb', line 15222

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

  raise "Missing the required parameter 'sensitive_data_model_id' when calling list_sensitive_columns." if sensitive_data_model_id.nil?

  if opts[:sensitive_column_lifecycle_state] && !OCI::DataSafe::Models::SENSITIVE_COLUMN_LIFECYCLE_STATE_ENUM.include?(opts[:sensitive_column_lifecycle_state])
    raise 'Invalid value for "sensitive_column_lifecycle_state", must be one of the values in OCI::DataSafe::Models::SENSITIVE_COLUMN_LIFECYCLE_STATE_ENUM.'
  end


  object_type_allowable_values = %w[ALL TABLE EDITIONING_VIEW]
  if opts[:object_type] && !opts[:object_type].empty?
    opts[:object_type].each do |val_to_check|
      unless object_type_allowable_values.include?(val_to_check)
        raise 'Invalid value for "object_type", must be one of ALL, TABLE, EDITIONING_VIEW.'
      end
    end
  end


  status_allowable_values = %w[VALID INVALID]
  if opts[:status] && !opts[:status].empty?
    opts[:status].each do |val_to_check|
      unless status_allowable_values.include?(val_to_check)
        raise 'Invalid value for "status", must be one of VALID, INVALID.'
      end
    end
  end


  relation_type_allowable_values = %w[NONE APP_DEFINED DB_DEFINED]
  if opts[:relation_type] && !opts[:relation_type].empty?
    opts[:relation_type].each do |val_to_check|
      unless relation_type_allowable_values.include?(val_to_check)
        raise 'Invalid value for "relation_type", must be one of NONE, APP_DEFINED, DB_DEFINED.'
      end
    end
  end

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

  if opts[:sort_by] && !%w[timeCreated schemaName objectName columnName dataType].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of timeCreated, schemaName, objectName, columnName, dataType.'
  end
  raise "Parameter value for 'sensitive_data_model_id' must not be blank" if OCI::Internal::Util.blank_string?(sensitive_data_model_id)

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

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:timeCreatedGreaterThanOrEqualTo] = opts[:time_created_greater_than_or_equal_to] if opts[:time_created_greater_than_or_equal_to]
  query_params[:timeCreatedLessThan] = opts[:time_created_less_than] if opts[:time_created_less_than]
  query_params[:timeUpdatedGreaterThanOrEqualTo] = opts[:time_updated_greater_than_or_equal_to] if opts[:time_updated_greater_than_or_equal_to]
  query_params[:timeUpdatedLessThan] = opts[:time_updated_less_than] if opts[:time_updated_less_than]
  query_params[:sensitiveColumnLifecycleState] = opts[:sensitive_column_lifecycle_state] if opts[:sensitive_column_lifecycle_state]
  query_params[:schemaName] = OCI::ApiClient.build_collection_params(opts[:schema_name], :multi) if opts[:schema_name] && !opts[:schema_name].empty?
  query_params[:objectName] = OCI::ApiClient.build_collection_params(opts[:object_name], :multi) if opts[:object_name] && !opts[:object_name].empty?
  query_params[:columnName] = OCI::ApiClient.build_collection_params(opts[:column_name], :multi) if opts[:column_name] && !opts[:column_name].empty?
  query_params[:objectType] = OCI::ApiClient.build_collection_params(opts[:object_type], :multi) if opts[:object_type] && !opts[:object_type].empty?
  query_params[:dataType] = OCI::ApiClient.build_collection_params(opts[:data_type], :multi) if opts[:data_type] && !opts[:data_type].empty?
  query_params[:status] = OCI::ApiClient.build_collection_params(opts[:status], :multi) if opts[:status] && !opts[:status].empty?
  query_params[:sensitiveTypeId] = OCI::ApiClient.build_collection_params(opts[:sensitive_type_id], :multi) if opts[:sensitive_type_id] && !opts[:sensitive_type_id].empty?
  query_params[:parentColumnKey] = OCI::ApiClient.build_collection_params(opts[:parent_column_key], :multi) if opts[:parent_column_key] && !opts[:parent_column_key].empty?
  query_params[:relationType] = OCI::ApiClient.build_collection_params(opts[:relation_type], :multi) if opts[:relation_type] && !opts[:relation_type].empty?
  query_params[:columnGroup] = opts[:column_group] if opts[:column_group]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:isCaseInSensitive] = opts[:is_case_in_sensitive] if !opts[:is_case_in_sensitive].nil?

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

  post_body = nil

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

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

Note:

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

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

Parameters:

  • compartment_id (String)

    A filter to return only resources that match the specified compartment OCID.

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

    the optional parameters

Options Hash (opts):

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

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

  • :compartment_id_in_subtree (BOOLEAN)

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

  • :access_level (String)

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

  • :display_name (String)

    A filter to return only resources that match the specified display name.

  • :sensitive_data_model_id (String)

    A filter to return only the resources that match the specified sensitive data model OCID.

  • :time_created_greater_than_or_equal_to (DateTime)

    A filter to return only the resources that were created after the specified date and time, as defined by RFC3339. Using TimeCreatedGreaterThanOrEqualToQueryParam parameter retrieves all resources created after that date.

    Example: 2016-12-19T16:39:57.600Z

  • :time_created_less_than (DateTime)

    Search for resources that were created before a specific date. Specifying this parameter corresponding timeCreatedLessThan parameter will retrieve all resources created before the specified created date, in "YYYY-MM-ddThh:mmZ" format with a Z offset, as defined by RFC 3339.

    Example: 2016-12-19T16:39:57.600Z

  • :target_id (String)

    A filter to return only items related to a specific target OCID.

  • :sort_order (String)

    The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

  • :sort_by (String)

    The field to sort by. You can specify only one sorting parameter (sortOrder). The default order for timeCreated is descending. The default order for displayName is ascending. (default to timeCreated) Allowed values are: timeCreated, displayName

  • :opc_request_id (String)

    Unique identifier for the request.

  • :limit (Integer)

    For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

  • :page (String)

    For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

  • :lifecycle_state (String)

    A filter to return only the resources that match the specified lifecycle state.

Returns:



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

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:



15469
15470
15471
15472
15473
15474
15475
15476
15477
15478
15479
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
# File 'lib/oci/data_safe/data_safe_client.rb', line 15469

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:



15558
15559
15560
15561
15562
15563
15564
15565
15566
15567
15568
15569
15570
15571
15572
15573
15574
15575
15576
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
# File 'lib/oci/data_safe/data_safe_client.rb', line 15558

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

  raise "Missing the required parameter 'sensitive_data_model_id' when calling list_sensitive_schemas." if sensitive_data_model_id.nil?

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

  if opts[:sort_by] && !%w[schemaName].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of schemaName.'
  end
  raise "Parameter value for 'sensitive_data_model_id' must not be blank" if OCI::Internal::Util.blank_string?(sensitive_data_model_id)

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

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:schemaName] = OCI::ApiClient.build_collection_params(opts[:schema_name], :multi) if opts[:schema_name] && !opts[:schema_name].empty?
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]

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

  post_body = nil

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

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

Note:

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

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

Parameters:

  • compartment_id (String)

    A filter to return only resources that match the specified compartment OCID.

  • opts (Hash) (defaults to: {})

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig)

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :compartment_id_in_subtree (BOOLEAN)

    Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting. (default to false)

  • :access_level (String)

    Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed. (default to RESTRICTED) Allowed values are: RESTRICTED, ACCESSIBLE

  • :display_name (String)

    A filter to return only resources that match the specified display name.

  • :sensitive_type_id (String)

    A filter to return only items related to a specific sensitive type OCID.

  • :sensitive_type_source (String)

    A filter to return the sensitive type resources based on the value of their source attribute. (default to USER)

  • :entity_type (String)

    A filter to return the sensitive type resources based on the value of their entityType attribute.

  • :parent_category_id (String)

    A filter to return only the sensitive types that are children of the sensitive category identified by the specified OCID.

  • :default_masking_format_id (String)

    A filter to return only the sensitive types that have the default masking format identified by the specified OCID.

  • :time_created_greater_than_or_equal_to (DateTime)

    A filter to return only the resources that were created after the specified date and time, as defined by RFC3339. Using TimeCreatedGreaterThanOrEqualToQueryParam parameter retrieves all resources created after that date.

    Example: 2016-12-19T16:39:57.600Z

  • :time_created_less_than (DateTime)

    Search for resources that were created before a specific date. Specifying this parameter corresponding timeCreatedLessThan parameter will retrieve all resources created before the specified created date, in "YYYY-MM-ddThh:mmZ" format with a Z offset, as defined by RFC 3339.

    Example: 2016-12-19T16:39:57.600Z

  • :sort_order (String)

    The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

  • :sort_by (String)

    The field to sort by. You can specify only one sorting parameter (sortOrder). The default order for timeCreated is descending. The default order for displayName is ascending. (default to timeCreated) Allowed values are: timeCreated, displayName

  • :opc_request_id (String)

    Unique identifier for the request.

  • :limit (Integer)

    For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

  • :page (String)

    For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

  • :lifecycle_state (String)

    A filter to return only the resources that match the specified lifecycle state.

  • :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:



15667
15668
15669
15670
15671
15672
15673
15674
15675
15676
15677
15678
15679
15680
15681
15682
15683
15684
15685
15686
15687
15688
15689
15690
15691
15692
15693
15694
15695
15696
15697
15698
15699
15700
15701
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
# File 'lib/oci/data_safe/data_safe_client.rb', line 15667

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_sql_collection_analytics(compartment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_sql_collection_analytics API.

Retrieves a list of all SQL collection analytics in Data Safe.

The ListSqlCollectionAnalytics operation returns only the analytics for the SQL collections in the specified compartmentId.

The parameter accessLevel specifies whether to return only those compartments for which the requestor has INSPECT permissions on at least one resource directly or indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if Principal doesn't have access to even one of the child compartments. This is valid only when compartmentIdInSubtree is set to true.

The parameter compartmentIdInSubtree applies when you perform ListSqlCollections on the compartmentId passed and when it is set to true, the entire hierarchy of compartments can be returned. To get a full list of all compartments and subcompartments in the tenancy (root compartment), set the parameter compartmentIdInSubtree to true and accessLevel to ACCESSIBLE.

Parameters:

  • compartment_id (String)

    A filter to return only resources that match the specified compartment OCID.

  • opts (Hash) (defaults to: {})

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig)

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :compartment_id_in_subtree (BOOLEAN)

    Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting. (default to false)

  • :access_level (String)

    Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed. (default to RESTRICTED) Allowed values are: RESTRICTED, ACCESSIBLE

  • :limit (Integer)

    For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

  • :page (String)

    For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

  • :lifecycle_state (String)

    The current state of the SQL collection.

  • :target_id (String)

    A filter to return only items related to a specific target OCID.

  • :opc_request_id (String)

    Unique identifier for the request.

  • :group_by (Array<String>)

    The group by parameter to summarize SQL collection aggregation. Allowed values are: targetId, lifecycleState

  • :time_started (DateTime)

    An optional filter to return the stats of the SQL collection logs collected after the date-time specified, in the format defined by RFC3339.

  • :time_ended (DateTime)

    An optional filter to return the stats of the SQL collection logs collected before the date-time specified, in the format defined by RFC3339.

Returns:



15796
15797
15798
15799
15800
15801
15802
15803
15804
15805
15806
15807
15808
15809
15810
15811
15812
15813
15814
15815
15816
15817
15818
15819
15820
15821
15822
15823
15824
15825
15826
15827
15828
15829
15830
15831
15832
15833
15834
15835
15836
15837
15838
15839
15840
15841
15842
15843
15844
15845
15846
15847
15848
15849
15850
15851
15852
15853
15854
15855
15856
15857
15858
15859
# File 'lib/oci/data_safe/data_safe_client.rb', line 15796

def list_sql_collection_analytics(compartment_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#list_sql_collection_analytics.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_sql_collection_analytics." if compartment_id.nil?

  if opts[:access_level] && !%w[RESTRICTED ACCESSIBLE].include?(opts[:access_level])
    raise 'Invalid value for "access_level", must be one of RESTRICTED, ACCESSIBLE.'
  end

  if opts[:lifecycle_state] && !OCI::DataSafe::Models::SQL_COLLECTION_LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::DataSafe::Models::SQL_COLLECTION_LIFECYCLE_STATE_ENUM.'
  end


  group_by_allowable_values = %w[targetId lifecycleState]
  if opts[:group_by] && !opts[:group_by].empty?
    opts[:group_by].each do |val_to_check|
      unless group_by_allowable_values.include?(val_to_check)
        raise 'Invalid value for "group_by", must be one of targetId, lifecycleState.'
      end
    end
  end

  path = '/sqlCollectionAnalytics'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:compartmentIdInSubtree] = opts[:compartment_id_in_subtree] if !opts[:compartment_id_in_subtree].nil?
  query_params[:accessLevel] = opts[:access_level] if opts[:access_level]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:targetId] = opts[:target_id] if opts[:target_id]
  query_params[:groupBy] = OCI::ApiClient.build_collection_params(opts[:group_by], :multi) if opts[:group_by] && !opts[:group_by].empty?
  query_params[:timeStarted] = opts[:time_started] if opts[:time_started]
  query_params[:timeEnded] = opts[:time_ended] if opts[:time_ended]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#list_sql_collection_analytics') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataSafe::Models::SqlCollectionAnalyticsCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_sql_collection_log_insights(time_started, time_ended, sql_collection_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_sql_collection_log_insights API.

Retrieves a list of the SQL collection log analytics.

Parameters:

  • time_started (DateTime)

    An optional filter to return the stats of the SQL collection logs collected after the date-time specified, in the format defined by RFC3339.

  • time_ended (DateTime)

    An optional filter to return the stats of the SQL collection logs collected before the date-time specified, in the format defined by RFC3339.

  • sql_collection_id (String)

    The OCID of the SQL collection resource.

  • opts (Hash) (defaults to: {})

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig)

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :limit (Integer)

    For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

  • :page (String)

    For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

  • :opc_request_id (String)

    Unique identifier for the request.

  • :group_by (String)

    The group by parameter to summarize SQL collection log insights aggregation. Allowed values are: clientIp, clientProgram, clientOsUserName

Returns:



15888
15889
15890
15891
15892
15893
15894
15895
15896
15897
15898
15899
15900
15901
15902
15903
15904
15905
15906
15907
15908
15909
15910
15911
15912
15913
15914
15915
15916
15917
15918
15919
15920
15921
15922
15923
15924
15925
15926
15927
15928
15929
15930
15931
15932
15933
15934
15935
# File 'lib/oci/data_safe/data_safe_client.rb', line 15888

def list_sql_collection_log_insights(time_started, time_ended, sql_collection_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#list_sql_collection_log_insights.' if logger

  raise "Missing the required parameter 'time_started' when calling list_sql_collection_log_insights." if time_started.nil?
  raise "Missing the required parameter 'time_ended' when calling list_sql_collection_log_insights." if time_ended.nil?
  raise "Missing the required parameter 'sql_collection_id' when calling list_sql_collection_log_insights." if sql_collection_id.nil?

  if opts[:group_by] && !%w[clientIp clientProgram clientOsUserName].include?(opts[:group_by])
    raise 'Invalid value for "group_by", must be one of clientIp, clientProgram, clientOsUserName.'
  end
  raise "Parameter value for 'sql_collection_id' must not be blank" if OCI::Internal::Util.blank_string?(sql_collection_id)

  path = '/sqlCollections/{sqlCollectionId}/logInsights'.sub('{sqlCollectionId}', sql_collection_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:timeStarted] = time_started
  query_params[:timeEnded] = time_ended
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:groupBy] = opts[:group_by] if opts[:group_by]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#list_sql_collection_log_insights') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataSafe::Models::SqlCollectionLogInsightsCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_sql_collections(compartment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_sql_collections API.

Retrieves a list of all SQL collections in Data Safe.

The ListSqlCollections operation returns only the SQL collections in the specified compartmentId.

The parameter accessLevel specifies whether to return only those compartments for which the requestor has INSPECT permissions on at least one resource directly or indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if Principal doesn't have access to even one of the child compartments. This is valid only when compartmentIdInSubtree is set to true.

The parameter compartmentIdInSubtree applies when you perform ListSqlCollections on the compartmentId passed and when it is set to true, the entire hierarchy of compartments can be returned. To get a full list of all compartments and subcompartments in the tenancy (root compartment), set the parameter compartmentIdInSubtree to true and accessLevel to ACCESSIBLE.

Parameters:

  • compartment_id (String)

    A filter to return only resources that match the specified compartment OCID.

  • opts (Hash) (defaults to: {})

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig)

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :compartment_id_in_subtree (BOOLEAN)

    Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting. (default to false)

  • :access_level (String)

    Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed. (default to RESTRICTED) Allowed values are: RESTRICTED, ACCESSIBLE

  • :display_name (String)

    A filter to return only resources that match the specified display name.

  • :limit (Integer)

    For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

  • :page (String)

    For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

  • :lifecycle_state (String)

    The current state of the SQL collection.

  • :sql_collection_id (String)

    An optional filter to return only resources that match the specified OCID of the SQL collection resource.

  • :time_created_greater_than_or_equal_to (DateTime)

    A filter to return only the resources that were created after the specified date and time, as defined by RFC3339. Using TimeCreatedGreaterThanOrEqualToQueryParam parameter retrieves all resources created after that date.

    Example: 2016-12-19T16:39:57.600Z

  • :time_created_less_than (DateTime)

    Search for resources that were created before a specific date. Specifying this parameter corresponding timeCreatedLessThan parameter will retrieve all resources created before the specified created date, in "YYYY-MM-ddThh:mmZ" format with a Z offset, as defined by RFC 3339.

    Example: 2016-12-19T16:39:57.600Z

  • :target_id (String)

    A filter to return only items related to a specific target OCID.

  • :db_user_name (String)

    A filter to return only items that match the specified user name.

  • :sort_order (String)

    The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

  • :sort_by (String)

    The field used for sorting. Only one sorting parameter order (sortOrder) can be specified. The DISPLAYNAME sort order is case sensitive. (default to TIMECREATED) Allowed values are: TIMECREATED, DISPLAYNAME, TIMELASTSTARTED

  • :opc_request_id (String)

    Unique identifier for the request.

Returns:



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
# File 'lib/oci/data_safe/data_safe_client.rb', line 16003

def list_sql_collections(compartment_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#list_sql_collections.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_sql_collections." if compartment_id.nil?

  if opts[:access_level] && !%w[RESTRICTED ACCESSIBLE].include?(opts[:access_level])
    raise 'Invalid value for "access_level", must be one of RESTRICTED, ACCESSIBLE.'
  end

  if opts[:lifecycle_state] && !OCI::DataSafe::Models::SQL_COLLECTION_LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::DataSafe::Models::SQL_COLLECTION_LIFECYCLE_STATE_ENUM.'
  end

  if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of ASC, DESC.'
  end

  if opts[:sort_by] && !%w[TIMECREATED DISPLAYNAME TIMELASTSTARTED].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of TIMECREATED, DISPLAYNAME, TIMELASTSTARTED.'
  end

  path = '/sqlCollections'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:compartmentIdInSubtree] = opts[:compartment_id_in_subtree] if !opts[:compartment_id_in_subtree].nil?
  query_params[:accessLevel] = opts[:access_level] if opts[:access_level]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:sqlCollectionId] = opts[:sql_collection_id] if opts[:sql_collection_id]
  query_params[:timeCreatedGreaterThanOrEqualTo] = opts[:time_created_greater_than_or_equal_to] if opts[:time_created_greater_than_or_equal_to]
  query_params[:timeCreatedLessThan] = opts[:time_created_less_than] if opts[:time_created_less_than]
  query_params[:targetId] = opts[:target_id] if opts[:target_id]
  query_params[:dbUserName] = opts[:db_user_name] if opts[:db_user_name]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#list_sql_collections') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataSafe::Models::SqlCollectionCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_sql_firewall_allowed_sql_analytics(compartment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_sql_firewall_allowed_sql_analytics API.

Returns the aggregation details of all SQL Firewall allowed SQL statements.

The ListSqlFirewallAllowedSqlAnalytics operation returns the aggregates of the SQL Firewall allowed SQL statements in the specified compartmentId.

The parameter accessLevel specifies whether to return only those compartments for which the requestor has INSPECT permissions on at least one resource directly or indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if Principal doesn't have access to even one of the child compartments. This is valid only when compartmentIdInSubtree is set to true.

The parameter compartmentIdInSubtree applies when you perform ListSqlFirewallAllowedSqlAnalytics on the compartmentId passed and when it is set to true, the entire hierarchy of compartments can be returned. To get a full list of all compartments and subcompartments in the tenancy (root compartment), set the parameter compartmentIdInSubtree to true and accessLevel to ACCESSIBLE.

Parameters:

  • compartment_id (String)

    A filter to return only resources that match the specified compartment OCID.

  • opts (Hash) (defaults to: {})

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig)

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :compartment_id_in_subtree (BOOLEAN)

    Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting. (default to false)

  • :access_level (String)

    Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed. (default to RESTRICTED) Allowed values are: RESTRICTED, ACCESSIBLE

  • :limit (Integer)

    For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

  • :page (String)

    For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

  • :scim_query (String)

    The scimQuery query parameter accepts filter expressions that use the syntax described in Section 3.2.2.2 of the System for Cross-Domain Identity Management (SCIM) specification, which is available at RFC3339. In SCIM filtering expressions, text, date, and time values must be enclosed in quotation marks, with date and time values using ISO-8601 format. (Numeric and boolean values should not be quoted.)

    Example: query=(currentUser eq 'SCOTT') and (topLevel eq 'YES')

  • :group_by (Array<String>)

    The group by parameter to summarize the allowed SQL aggregation. Allowed values are: dbUserName, sqlLevel, sqlFirewallPolicyId, lifecycleState

  • :opc_request_id (String)

    Unique identifier for the request.

Returns:



16121
16122
16123
16124
16125
16126
16127
16128
16129
16130
16131
16132
16133
16134
16135
16136
16137
16138
16139
16140
16141
16142
16143
16144
16145
16146
16147
16148
16149
16150
16151
16152
16153
16154
16155
16156
16157
16158
16159
16160
16161
16162
16163
16164
16165
16166
16167
16168
16169
16170
16171
16172
16173
16174
16175
16176
16177
# File 'lib/oci/data_safe/data_safe_client.rb', line 16121

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:



16233
16234
16235
16236
16237
16238
16239
16240
16241
16242
16243
16244
16245
16246
16247
16248
16249
16250
16251
16252
16253
16254
16255
16256
16257
16258
16259
16260
16261
16262
16263
16264
16265
16266
16267
16268
16269
16270
16271
16272
16273
16274
16275
16276
16277
16278
16279
16280
16281
16282
16283
16284
16285
16286
16287
16288
# File 'lib/oci/data_safe/data_safe_client.rb', line 16233

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:



16359
16360
16361
16362
16363
16364
16365
16366
16367
16368
16369
16370
16371
16372
16373
16374
16375
16376
16377
16378
16379
16380
16381
16382
16383
16384
16385
16386
16387
16388
16389
16390
16391
16392
16393
16394
16395
16396
16397
16398
16399
16400
16401
16402
16403
16404
16405
16406
16407
16408
16409
16410
16411
16412
16413
16414
16415
16416
16417
16418
16419
16420
16421
16422
16423
16424
16425
16426
16427
16428
16429
# File 'lib/oci/data_safe/data_safe_client.rb', line 16359

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:



16480
16481
16482
16483
16484
16485
16486
16487
16488
16489
16490
16491
16492
16493
16494
16495
16496
16497
16498
16499
16500
16501
16502
16503
16504
16505
16506
16507
16508
16509
16510
16511
16512
16513
16514
16515
16516
16517
16518
16519
16520
16521
16522
16523
16524
16525
16526
16527
16528
16529
16530
16531
16532
16533
16534
16535
16536
16537
16538
16539
16540
16541
16542
16543
# File 'lib/oci/data_safe/data_safe_client.rb', line 16480

def list_sql_firewall_policy_analytics(compartment_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#list_sql_firewall_policy_analytics.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_sql_firewall_policy_analytics." if compartment_id.nil?

  if opts[:access_level] && !%w[RESTRICTED ACCESSIBLE].include?(opts[:access_level])
    raise 'Invalid value for "access_level", must be one of RESTRICTED, ACCESSIBLE.'
  end


  group_by_allowable_values = %w[violationAction enforcementScope securityPolicyId lifecycleState]
  if opts[:group_by] && !opts[:group_by].empty?
    opts[:group_by].each do |val_to_check|
      unless group_by_allowable_values.include?(val_to_check)
        raise 'Invalid value for "group_by", must be one of violationAction, enforcementScope, securityPolicyId, lifecycleState.'
      end
    end
  end

  if opts[:lifecycle_state] && !OCI::DataSafe::Models::SQL_FIREWALL_POLICY_LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::DataSafe::Models::SQL_FIREWALL_POLICY_LIFECYCLE_STATE_ENUM.'
  end

  path = '/sqlFirewallPolicyAnalytics'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:compartmentIdInSubtree] = opts[:compartment_id_in_subtree] if !opts[:compartment_id_in_subtree].nil?
  query_params[:accessLevel] = opts[:access_level] if opts[:access_level]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:groupBy] = OCI::ApiClient.build_collection_params(opts[:group_by], :multi) if opts[:group_by] && !opts[:group_by].empty?
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:securityPolicyId] = opts[:security_policy_id] if opts[:security_policy_id]
  query_params[:timeStarted] = opts[:time_started] if opts[:time_started]
  query_params[:timeEnded] = opts[:time_ended] if opts[:time_ended]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#list_sql_firewall_policy_analytics') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataSafe::Models::SqlFirewallPolicyAnalyticsCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_sql_firewall_violation_analytics(compartment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_sql_firewall_violation_analytics API.

Returns the aggregation details of the SQL Firewall violations.

Allowed values are: dbUserName, targetId, targetName, operationTime, timeCollected, clientOsUserName, operation, currentDbUserName, sqlLevel, clientIp, clientProgram, violationCause, violationAction, violationCount

Parameters:

  • compartment_id (String)

    A filter to return only resources that match the specified compartment OCID.

  • opts (Hash) (defaults to: {})

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig)

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :compartment_id_in_subtree (BOOLEAN)

    Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting. (default to false)

  • :access_level (String)

    Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed. (default to RESTRICTED) Allowed values are: RESTRICTED, ACCESSIBLE

  • :limit (Integer)

    For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

  • :page (String)

    For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

  • :opc_request_id (String)

    Unique identifier for the request.

  • :time_started (DateTime)

    An optional filter to return audit events whose creation time in the database is greater than and equal to the date-time specified, in the format defined by RFC3339.

  • :time_ended (DateTime)

    An optional filter to return audit events whose creation time in the database is less than and equal to the date-time specified, in the format defined by RFC3339.

  • :query_time_zone (String)

    Default time zone is UTC if no time zone provided. The date-time considerations of the resource will be in accordance with the specified time zone. (default to UTC)

  • :sort_order (String)

    The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

  • :sort_by (String)

    If this query parameter is specified, the result is sorted by this query parameter value. (default to operationTime)

  • :scim_query (String)

    The scimQuery query parameter accepts filter expressions that use the syntax described in Section 3.2.2.2 of the System for Cross-Domain Identity Management (SCIM) specification, which is available at RFC3339. In SCIM filtering expressions, text, date, and time values must be enclosed in quotation marks, with date and time values using ISO-8601 format. (Numeric and boolean values should not be quoted.)

    Example: query=(operationTime ge '2021-06-04T01-00-26') and (violationAction eq 'BLOCKED')

  • :summary_field (Array<String>)

    Specifies a subset of summarized fields to be returned in the response. Allowed values are: dbUserName, targetName, clientOsUserName, operation, sqlText, currentDbUserName, sqlLevel, clientIp, clientProgram, violationCause, violationAction, selects, creates, alters, drops, grants, revokes

  • :group_by (Array<String>)

    A groupBy can only be used in combination with summaryField parameter. A groupBy value has to be a subset of the values mentioned in summaryField parameter.

    Allowed values are: dbUserName, targetName, operationTime, timeCollected, clientOsUserName, operation, sqlText, currentDbUserName, sqlLevel, clientIp, clientProgram, violationCause, violationAction

  • :opc_retry_token (String)

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

Returns:



16605
16606
16607
16608
16609
16610
16611
16612
16613
16614
16615
16616
16617
16618
16619
16620
16621
16622
16623
16624
16625
16626
16627
16628
16629
16630
16631
16632
16633
16634
16635
16636
16637
16638
16639
16640
16641
16642
16643
16644
16645
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
# File 'lib/oci/data_safe/data_safe_client.rb', line 16605

def list_sql_firewall_violation_analytics(compartment_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#list_sql_firewall_violation_analytics.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_sql_firewall_violation_analytics." if compartment_id.nil?

  if opts[:access_level] && !%w[RESTRICTED ACCESSIBLE].include?(opts[:access_level])
    raise 'Invalid value for "access_level", must be one of RESTRICTED, ACCESSIBLE.'
  end

  if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of ASC, DESC.'
  end

  if opts[:sort_by] && !%w[dbUserName targetId targetName operationTime timeCollected clientOsUserName operation currentDbUserName sqlLevel clientIp clientProgram violationCause violationAction violationCount].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of dbUserName, targetId, targetName, operationTime, timeCollected, clientOsUserName, operation, currentDbUserName, sqlLevel, clientIp, clientProgram, violationCause, violationAction, violationCount.'
  end


  summary_field_allowable_values = %w[dbUserName targetName clientOsUserName operation sqlText currentDbUserName sqlLevel clientIp clientProgram violationCause violationAction selects creates alters drops grants revokes]
  if opts[:summary_field] && !opts[:summary_field].empty?
    opts[:summary_field].each do |val_to_check|
      unless summary_field_allowable_values.include?(val_to_check)
        raise 'Invalid value for "summary_field", must be one of dbUserName, targetName, clientOsUserName, operation, sqlText, currentDbUserName, sqlLevel, clientIp, clientProgram, violationCause, violationAction, selects, creates, alters, drops, grants, revokes.'
      end
    end
  end


  group_by_allowable_values = %w[dbUserName targetName operationTime timeCollected clientOsUserName operation sqlText currentDbUserName sqlLevel clientIp clientProgram violationCause violationAction]
  if opts[:group_by] && !opts[:group_by].empty?
    opts[:group_by].each do |val_to_check|
      unless group_by_allowable_values.include?(val_to_check)
        raise 'Invalid value for "group_by", must be one of dbUserName, targetName, operationTime, timeCollected, clientOsUserName, operation, sqlText, currentDbUserName, sqlLevel, clientIp, clientProgram, violationCause, violationAction.'
      end
    end
  end

  path = '/sqlFirewallViolationAnalytics'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:compartmentIdInSubtree] = opts[:compartment_id_in_subtree] if !opts[:compartment_id_in_subtree].nil?
  query_params[:accessLevel] = opts[:access_level] if opts[:access_level]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:timeStarted] = opts[:time_started] if opts[:time_started]
  query_params[:timeEnded] = opts[:time_ended] if opts[:time_ended]
  query_params[:queryTimeZone] = opts[:query_time_zone] if opts[:query_time_zone]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:scimQuery] = opts[:scim_query] if opts[:scim_query]
  query_params[:summaryField] = OCI::ApiClient.build_collection_params(opts[:summary_field], :multi) if opts[:summary_field] && !opts[:summary_field].empty?
  query_params[:groupBy] = OCI::ApiClient.build_collection_params(opts[:group_by], :multi) if opts[:group_by] && !opts[:group_by].empty?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#list_sql_firewall_violation_analytics') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataSafe::Models::SqlFirewallViolationAnalyticsCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_sql_firewall_violations(compartment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_sql_firewall_violations API.

Gets a list of all the SQL Firewall violations captured by the firewall.

Allowed values are: dbUserName, targetId, targetName, operationTime, timeCollected, clientOsUserName, operation, currentDbUserName, sqlLevel, clientIp, clientProgram, violationCause, violationAction

Parameters:

  • compartment_id (String)

    A filter to return only resources that match the specified compartment OCID.

  • opts (Hash) (defaults to: {})

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig)

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :compartment_id_in_subtree (BOOLEAN)

    Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting. (default to false)

  • :limit (Integer)

    For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

  • :page (String)

    For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

  • :opc_request_id (String)

    Unique identifier for the request.

  • :access_level (String)

    Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed. (default to RESTRICTED) Allowed values are: RESTRICTED, ACCESSIBLE

  • :sort_order (String)

    The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

  • :sort_by (String)

    If this query parameter is specified, the result is sorted by this query parameter value. (default to operationTime)

  • :scim_query (String)

    The scimQuery query parameter accepts filter expressions that use the syntax described in Section 3.2.2.2 of the System for Cross-Domain Identity Management (SCIM) specification, which is available at RFC3339. In SCIM filtering expressions, text, date, and time values must be enclosed in quotation marks, with date and time values using ISO-8601 format. (Numeric and boolean values should not be quoted.)

    Example: query=(operationTime ge '2021-06-04T01-00-26') and (violationAction eq 'BLOCKED')

Returns:



16730
16731
16732
16733
16734
16735
16736
16737
16738
16739
16740
16741
16742
16743
16744
16745
16746
16747
16748
16749
16750
16751
16752
16753
16754
16755
16756
16757
16758
16759
16760
16761
16762
16763
16764
16765
16766
16767
16768
16769
16770
16771
16772
16773
16774
16775
16776
16777
16778
16779
16780
16781
16782
16783
16784
16785
# File 'lib/oci/data_safe/data_safe_client.rb', line 16730

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:



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
16854
16855
16856
16857
16858
16859
16860
16861
16862
16863
16864
16865
16866
16867
# File 'lib/oci/data_safe/data_safe_client.rb', line 16815

def list_tables(target_database_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#list_tables.' if logger

  raise "Missing the required parameter 'target_database_id' when calling list_tables." if target_database_id.nil?

  if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of ASC, DESC.'
  end

  if opts[:sort_by] && !%w[SCHEMANAME TABLENAME].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of SCHEMANAME, TABLENAME.'
  end
  raise "Parameter value for 'target_database_id' must not be blank" if OCI::Internal::Util.blank_string?(target_database_id)

  path = '/targetDatabases/{targetDatabaseId}/tables'.sub('{targetDatabaseId}', target_database_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:schemaName] = OCI::ApiClient.build_collection_params(opts[:schema_name], :multi) if opts[:schema_name] && !opts[:schema_name].empty?
  query_params[:tableName] = OCI::ApiClient.build_collection_params(opts[:table_name], :multi) if opts[:table_name] && !opts[:table_name].empty?
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:tableNameContains] = opts[:table_name_contains] if opts[:table_name_contains]
  query_params[:schemaNameContains] = opts[:schema_name_contains] if opts[:schema_name_contains]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#list_tables') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'Array<OCI::DataSafe::Models::TableSummary>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_target_alert_policy_associations(compartment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_target_alert_policy_associations API.

Gets a list of all target-alert policy associations.

Allowed values are: DISPLAYNAME, TIMECREATED, TIMEUPDATED

Parameters:

  • compartment_id (String)

    A filter to return only resources that match the specified compartment OCID.

  • opts (Hash) (defaults to: {})

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig)

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :target_alert_policy_association_id (String)

    A filter to return only items related to a specific target-alert policy association ID.

  • :alert_policy_id (String)

    A filter to return policy by it's OCID.

  • :target_id (String)

    A filter to return only items related to a specific target OCID.

  • :lifecycle_state (String)

    An optional filter to return only alert policies that have the given life-cycle state.

  • :limit (Integer)

    For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

  • :page (String)

    For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

  • :sort_order (String)

    The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

  • :sort_by (String)

    The field to sort by. Only one sort parameter may be provided. (default to TIMECREATED)

  • :opc_request_id (String)

    Unique identifier for the request.

  • :time_created_greater_than_or_equal_to (DateTime)

    A filter to return only the resources that were created after the specified date and time, as defined by RFC3339. Using TimeCreatedGreaterThanOrEqualToQueryParam parameter retrieves all resources created after that date.

    Example: 2016-12-19T16:39:57.600Z

  • :time_created_less_than (DateTime)

    Search for resources that were created before a specific date. Specifying this parameter corresponding timeCreatedLessThan parameter will retrieve all resources created before the specified created date, in "YYYY-MM-ddThh:mmZ" format with a Z offset, as defined by RFC 3339.

    Example: 2016-12-19T16:39:57.600Z

  • :compartment_id_in_subtree (BOOLEAN)

    Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting. (default to false)

  • :access_level (String)

    Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed. (default to RESTRICTED) Allowed values are: RESTRICTED, ACCESSIBLE

Returns:



16919
16920
16921
16922
16923
16924
16925
16926
16927
16928
16929
16930
16931
16932
16933
16934
16935
16936
16937
16938
16939
16940
16941
16942
16943
16944
16945
16946
16947
16948
16949
16950
16951
16952
16953
16954
16955
16956
16957
16958
16959
16960
16961
16962
16963
16964
16965
16966
16967
16968
16969
16970
16971
16972
16973
16974
16975
16976
16977
16978
16979
16980
16981
16982
16983
# File 'lib/oci/data_safe/data_safe_client.rb', line 16919

def list_target_alert_policy_associations(compartment_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#list_target_alert_policy_associations.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_target_alert_policy_associations." if compartment_id.nil?

  if opts[:lifecycle_state] && !OCI::DataSafe::Models::ALERT_POLICY_LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::DataSafe::Models::ALERT_POLICY_LIFECYCLE_STATE_ENUM.'
  end

  if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of ASC, DESC.'
  end

  if opts[:sort_by] && !%w[DISPLAYNAME TIMECREATED TIMEUPDATED].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of DISPLAYNAME, TIMECREATED, TIMEUPDATED.'
  end

  if opts[:access_level] && !%w[RESTRICTED ACCESSIBLE].include?(opts[:access_level])
    raise 'Invalid value for "access_level", must be one of RESTRICTED, ACCESSIBLE.'
  end

  path = '/targetAlertPolicyAssociations'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:targetAlertPolicyAssociationId] = opts[:target_alert_policy_association_id] if opts[:target_alert_policy_association_id]
  query_params[:alertPolicyId] = opts[:alert_policy_id] if opts[:alert_policy_id]
  query_params[:targetId] = opts[:target_id] if opts[:target_id]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:timeCreatedGreaterThanOrEqualTo] = opts[:time_created_greater_than_or_equal_to] if opts[:time_created_greater_than_or_equal_to]
  query_params[:timeCreatedLessThan] = opts[:time_created_less_than] if opts[:time_created_less_than]
  query_params[:compartmentIdInSubtree] = opts[:compartment_id_in_subtree] if !opts[:compartment_id_in_subtree].nil?
  query_params[:accessLevel] = opts[:access_level] if opts[:access_level]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#list_target_alert_policy_associations') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataSafe::Models::TargetAlertPolicyAssociationCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_target_databases(compartment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_target_databases API.

Returns the list of registered target databases in Data Safe.

Parameters:

  • compartment_id (String)

    A filter to return only resources that match the specified compartment OCID.

  • opts (Hash) (defaults to: {})

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig)

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :associated_resource_id (String)

    A filter to return the target databases that are associated to the resource id passed in as a parameter value.

  • :target_database_id (String)

    A filter to return the target database that matches the specified OCID.

  • :display_name (String)

    A filter to return only resources that match the specified display name.

  • :lifecycle_state (String)

    A filter to return only target databases that match the specified lifecycle state.

  • :database_type (String)

    A filter to return only target databases that match the specified database type.

  • :infrastructure_type (String)

    A filter to return only target databases that match the specified infrastructure type.

  • :limit (Integer)

    For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

  • :page (String)

    For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

  • :compartment_id_in_subtree (BOOLEAN)

    Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting. (default to false)

  • :access_level (String)

    Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed. (default to RESTRICTED) Allowed values are: RESTRICTED, ACCESSIBLE

  • :sort_order (String)

    The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

  • :sort_by (String)

    The field used for sorting. Only one sorting order (sortOrder) can be specified. The default order for TIMECREATED is descending. The default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. (default to TIMECREATED) Allowed values are: TIMECREATED, DISPLAYNAME

  • :opc_request_id (String)

    Unique identifier for the request.

Returns:



17027
17028
17029
17030
17031
17032
17033
17034
17035
17036
17037
17038
17039
17040
17041
17042
17043
17044
17045
17046
17047
17048
17049
17050
17051
17052
17053
17054
17055
17056
17057
17058
17059
17060
17061
17062
17063
17064
17065
17066
17067
17068
17069
17070
17071
17072
17073
17074
17075
17076
17077
17078
17079
17080
17081
17082
17083
17084
17085
17086
17087
17088
17089
17090
17091
17092
17093
17094
17095
17096
17097
17098
17099
# File 'lib/oci/data_safe/data_safe_client.rb', line 17027

def list_target_databases(compartment_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#list_target_databases.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_target_databases." if compartment_id.nil?

  if opts[:lifecycle_state] && !OCI::DataSafe::Models::TARGET_DATABASE_LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::DataSafe::Models::TARGET_DATABASE_LIFECYCLE_STATE_ENUM.'
  end

  if opts[:database_type] && !OCI::DataSafe::Models::DATABASE_TYPE_ENUM.include?(opts[:database_type])
    raise 'Invalid value for "database_type", must be one of the values in OCI::DataSafe::Models::DATABASE_TYPE_ENUM.'
  end

  if opts[:infrastructure_type] && !OCI::DataSafe::Models::INFRASTRUCTURE_TYPE_ENUM.include?(opts[:infrastructure_type])
    raise 'Invalid value for "infrastructure_type", must be one of the values in OCI::DataSafe::Models::INFRASTRUCTURE_TYPE_ENUM.'
  end

  if opts[:access_level] && !%w[RESTRICTED ACCESSIBLE].include?(opts[:access_level])
    raise 'Invalid value for "access_level", must be one of RESTRICTED, ACCESSIBLE.'
  end

  if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of ASC, DESC.'
  end

  if opts[:sort_by] && !%w[TIMECREATED DISPLAYNAME].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of TIMECREATED, DISPLAYNAME.'
  end

  path = '/targetDatabases'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:associatedResourceId] = opts[:associated_resource_id] if opts[:associated_resource_id]
  query_params[:targetDatabaseId] = opts[:target_database_id] if opts[:target_database_id]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:databaseType] = opts[:database_type] if opts[:database_type]
  query_params[:infrastructureType] = opts[:infrastructure_type] if opts[:infrastructure_type]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:compartmentIdInSubtree] = opts[:compartment_id_in_subtree] if !opts[:compartment_id_in_subtree].nil?
  query_params[:accessLevel] = opts[:access_level] if opts[:access_level]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#list_target_databases') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'Array<OCI::DataSafe::Models::TargetDatabaseSummary>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_user_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:



17125
17126
17127
17128
17129
17130
17131
17132
17133
17134
17135
17136
17137
17138
17139
17140
17141
17142
17143
17144
17145
17146
17147
17148
17149
17150
17151
17152
17153
17154
17155
17156
17157
17158
17159
17160
17161
17162
17163
17164
17165
17166
17167
17168
17169
17170
17171
17172
17173
# File 'lib/oci/data_safe/data_safe_client.rb', line 17125

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 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 ListUserAnalytics on the compartmentId passed and when it is set to true, the entire hierarchy of compartments can be returned.

To use ListUserAnalytics to get a full list of all compartments and subcompartments in the tenancy from the root compartment, set the parameter compartmentIdInSubtree to true and accessLevel to ACCESSIBLE.

Allowed values are: userName, userCategory, accountStatus, timeLastLogin, targetId, timeUserCreated, authenticationType, timePasswordChanged

Parameters:

  • user_assessment_id (String)

    The OCID of the user assessment.

  • opts (Hash) (defaults to: {})

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig)

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :compartment_id_in_subtree (BOOLEAN)

    Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting. (default to false)

  • :access_level (String)

    Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed. (default to RESTRICTED) Allowed values are: RESTRICTED, ACCESSIBLE

  • :limit (Integer)

    For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

  • :user_category (String)

    A filter to return only items that match the specified user category.

  • :user_key (String)

    A filter to return only items that match the specified user key.

  • :account_status (String)

    A filter to return only items that match the specified account status.

  • :authentication_type (String)

    A filter to return only items that match the specified authentication type.

  • :user_name (String)

    A filter to return only items that match the specified user name.

  • :target_id (String)

    A filter to return only items related to a specific target OCID.

  • :time_last_login_greater_than_or_equal_to (DateTime)

    A filter to return users whose last login time in the database is greater than or equal to the date and time specified, in the format defined by RFC3339.

    Example: 2016-12-19T16:39:57.600Z

  • :time_last_login_less_than (DateTime)

    A filter to return users whose last login time in the database is less than the date and time specified, in the format defined by RFC3339. Example: 2016-12-19T16:39:57.600Z

  • :time_user_created_greater_than_or_equal_to (DateTime)

    A filter to return users whose creation time in the database is greater than or equal to the date and time specified, in the format defined by RFC3339. Example: 2016-12-19T16:39:57.600Z

  • :time_user_created_less_than (DateTime)

    A filter to return users whose creation time in the database is less than the date and time specified, in the format defined by RFC3339. Example: 2016-12-19T16:39:57.600Z

  • :time_password_last_changed_greater_than_or_equal_to (DateTime)

    A filter to return users whose last password change in the database is greater than or equal to the date and time specified, in the format defined by RFC3339.

    Example: 2016-12-19T16:39:57.600Z

  • :time_password_last_changed_less_than (DateTime)

    A filter to return users whose last password change in the database is less than the date and time specified, in the format defined by RFC3339.

    Example: 2016-12-19T16:39:57.600Z

  • :page (String)

    For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

  • :sort_order (String)

    The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

  • :sort_by (String)

    The field to sort by. You can specify only one sort order (sortOrder). The default order for userName is ascending. (default to userName)

  • :opc_request_id (String)

    Unique identifier for the request.

Returns:



17249
17250
17251
17252
17253
17254
17255
17256
17257
17258
17259
17260
17261
17262
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
# File 'lib/oci/data_safe/data_safe_client.rb', line 17249

def list_user_analytics(user_assessment_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#list_user_analytics.' if logger

  raise "Missing the required parameter 'user_assessment_id' when calling list_user_analytics." if user_assessment_id.nil?

  if opts[:access_level] && !%w[RESTRICTED ACCESSIBLE].include?(opts[:access_level])
    raise 'Invalid value for "access_level", must be one of RESTRICTED, ACCESSIBLE.'
  end

  if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of ASC, DESC.'
  end

  if opts[:sort_by] && !%w[userName userCategory accountStatus timeLastLogin targetId timeUserCreated authenticationType timePasswordChanged].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of userName, userCategory, accountStatus, timeLastLogin, targetId, timeUserCreated, authenticationType, timePasswordChanged.'
  end
  raise "Parameter value for 'user_assessment_id' must not be blank" if OCI::Internal::Util.blank_string?(user_assessment_id)

  path = '/userAssessments/{userAssessmentId}/userAnalytics'.sub('{userAssessmentId}', user_assessment_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentIdInSubtree] = opts[:compartment_id_in_subtree] if !opts[:compartment_id_in_subtree].nil?
  query_params[:accessLevel] = opts[:access_level] if opts[:access_level]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:userCategory] = opts[:user_category] if opts[:user_category]
  query_params[:userKey] = opts[:user_key] if opts[:user_key]
  query_params[:accountStatus] = opts[:account_status] if opts[:account_status]
  query_params[:authenticationType] = opts[:authentication_type] if opts[:authentication_type]
  query_params[:userName] = opts[:user_name] if opts[:user_name]
  query_params[:targetId] = opts[:target_id] if opts[:target_id]
  query_params[:timeLastLoginGreaterThanOrEqualTo] = opts[:time_last_login_greater_than_or_equal_to] if opts[:time_last_login_greater_than_or_equal_to]
  query_params[:timeLastLoginLessThan] = opts[:time_last_login_less_than] if opts[:time_last_login_less_than]
  query_params[:timeUserCreatedGreaterThanOrEqualTo] = opts[:time_user_created_greater_than_or_equal_to] if opts[:time_user_created_greater_than_or_equal_to]
  query_params[:timeUserCreatedLessThan] = opts[:time_user_created_less_than] if opts[:time_user_created_less_than]
  query_params[:timePasswordLastChangedGreaterThanOrEqualTo] = opts[:time_password_last_changed_greater_than_or_equal_to] if opts[:time_password_last_changed_greater_than_or_equal_to]
  query_params[:timePasswordLastChangedLessThan] = opts[:time_password_last_changed_less_than] if opts[:time_password_last_changed_less_than]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#list_user_analytics') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'Array<OCI::DataSafe::Models::UserAggregation>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_user_assessments(compartment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_user_assessments API.

Gets a list of user assessments.

The ListUserAssessments operation returns only the assessments in the specified compartmentId. The list does not include any subcompartments of the compartmentId passed.

The parameter accessLevel specifies whether to return only those compartments for which the requestor has INSPECT permissions on at least one resource directly or indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if Principal doesn't have access to even one of the child compartments. This is valid only when compartmentIdInSubtree is set to true.

The parameter compartmentIdInSubtree applies when you perform ListUserAssessments on the compartmentId passed and when it is set to true, the entire hierarchy of compartments can be returned. To get a full list of all compartments and subcompartments in the tenancy (root compartment), set the parameter compartmentIdInSubtree to true and accessLevel to ACCESSIBLE.

Allowed values are: timeCreated, displayName

Parameters:

  • compartment_id (String)

    A filter to return only resources that match the specified compartment OCID.

  • opts (Hash) (defaults to: {})

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig)

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :compartment_id_in_subtree (BOOLEAN)

    Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting. (default to false)

  • :access_level (String)

    Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed. (default to RESTRICTED) Allowed values are: RESTRICTED, ACCESSIBLE

  • :display_name (String)

    A filter to return only resources that match the specified display name.

  • :schedule_user_assessment_id (String)

    The OCID of the user assessment of type SAVE_SCHEDULE.

  • :is_schedule_assessment (BOOLEAN)

    A filter to return only user assessments of type SAVE_SCHEDULE. (default to false)

  • :is_baseline (BOOLEAN)

    A filter to return only user assessments that are set as baseline. (default to false)

  • :target_id (String)

    A filter to return only items related to a specific target OCID.

  • :type (String)

    A filter to return only items that match the specified assessment type. Allowed values are: LATEST, SAVED, COMPARTMENT, SAVE_SCHEDULE

  • :triggered_by (String)

    A filter to return user assessments that were created by either the system or by a user only. Allowed values are: USER, SYSTEM

  • :time_created_greater_than_or_equal_to (DateTime)

    A filter to return only user assessments that were created after the specified date and time, as defined by RFC3339. Using timeCreatedGreaterThanOrEqualTo parameter retrieves all assessments created after that date.

    Example: 2016-12-19T16:39:57.600Z

  • :time_created_less_than (DateTime)

    Search for resources that were created before a specific date. Specifying this parameter corresponding timeCreatedLessThan parameter will retrieve all resources created before the specified created date, in "YYYY-MM-ddThh:mmZ" format with a Z offset, as defined by RFC 3339.

    Example: 2016-12-19T16:39:57.600Z

  • :limit (Integer)

    For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

  • :page (String)

    For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

  • :lifecycle_state (String)

    The current state of the user assessment.

  • :sort_order (String)

    The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

  • :sort_by (String)

    The field to sort by. You can specify only one sort order (sortOrder). The default order for timeCreated is descending. (default to timeCreated)

  • :opc_request_id (String)

    Unique identifier for the request.

Returns:



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
17425
17426
17427
17428
17429
17430
17431
17432
17433
17434
17435
17436
17437
17438
17439
17440
17441
17442
17443
17444
17445
17446
17447
17448
17449
17450
17451
17452
17453
17454
17455
17456
17457
17458
17459
17460
17461
17462
17463
17464
17465
# File 'lib/oci/data_safe/data_safe_client.rb', line 17389

def list_user_assessments(compartment_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#list_user_assessments.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_user_assessments." if compartment_id.nil?

  if opts[:access_level] && !%w[RESTRICTED ACCESSIBLE].include?(opts[:access_level])
    raise 'Invalid value for "access_level", must be one of RESTRICTED, ACCESSIBLE.'
  end

  if opts[:type] && !%w[LATEST SAVED COMPARTMENT SAVE_SCHEDULE].include?(opts[:type])
    raise 'Invalid value for "type", must be one of LATEST, SAVED, COMPARTMENT, SAVE_SCHEDULE.'
  end

  if opts[:triggered_by] && !%w[USER SYSTEM].include?(opts[:triggered_by])
    raise 'Invalid value for "triggered_by", must be one of USER, SYSTEM.'
  end

  if opts[:lifecycle_state] && !OCI::DataSafe::Models::USER_ASSESSMENT_LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::DataSafe::Models::USER_ASSESSMENT_LIFECYCLE_STATE_ENUM.'
  end

  if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of ASC, DESC.'
  end

  if opts[:sort_by] && !%w[timeCreated displayName].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of timeCreated, displayName.'
  end

  path = '/userAssessments'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:compartmentIdInSubtree] = opts[:compartment_id_in_subtree] if !opts[:compartment_id_in_subtree].nil?
  query_params[:accessLevel] = opts[:access_level] if opts[:access_level]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:scheduleUserAssessmentId] = opts[:schedule_user_assessment_id] if opts[:schedule_user_assessment_id]
  query_params[:isScheduleAssessment] = opts[:is_schedule_assessment] if !opts[:is_schedule_assessment].nil?
  query_params[:isBaseline] = opts[:is_baseline] if !opts[:is_baseline].nil?
  query_params[:targetId] = opts[:target_id] if opts[:target_id]
  query_params[:type] = opts[:type] if opts[:type]
  query_params[:triggeredBy] = opts[:triggered_by] if opts[:triggered_by]
  query_params[:timeCreatedGreaterThanOrEqualTo] = opts[:time_created_greater_than_or_equal_to] if opts[:time_created_greater_than_or_equal_to]
  query_params[:timeCreatedLessThan] = opts[:time_created_less_than] if opts[:time_created_less_than]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#list_user_assessments') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'Array<OCI::DataSafe::Models::UserAssessmentSummary>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_users(user_assessment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_users API.

Gets a list of users of the specified user assessment. The result contains the database user details for each user, such as user type, account status, last login time, user creation time, authentication type, user profile, and the date and time of the latest password change. It also contains the user category derived from these user details as well as privileges granted to each user.

as specified by '#/definitions/userTypes'.

Allowed values are: userName, userCategory, accountStatus, timeLastLogin, targetId, timeUserCreated, authenticationType, timePasswordChanged

Parameters:

  • user_assessment_id (String)

    The OCID of the user assessment.

  • opts (Hash) (defaults to: {})

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig)

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :limit (Integer)

    For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

  • :compartment_id_in_subtree (BOOLEAN)

    Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting. (default to false)

  • :access_level (String)

    Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed. (default to RESTRICTED) Allowed values are: RESTRICTED, ACCESSIBLE

  • :user_category (String)

    A filter to return only items that match the specified user category.

  • :user_role (String)

    A filter to return only items that match the specified user role.

  • :user_profile (String)

    A filter to return only items that match the specified user profile.

  • :user_type (String)

    A filter to return only items that match the specified user type. The possible values can be - ADMIN_PRIVILEGED - APPLICATION - PRIVILEGED - SCHEMA - NON_PRIVILEGED

  • :user_key (String)

    A filter to return only items that match the specified user key.

  • :account_status (String)

    A filter to return only items that match the specified account status.

  • :authentication_type (String)

    A filter to return only items that match the specified authentication type.

  • :user_name (String)

    A filter to return only items that match the specified user name.

  • :target_id (String)

    A filter to return only items related to a specific target OCID.

  • :time_last_login_greater_than_or_equal_to (DateTime)

    A filter to return users whose last login time in the database is greater than or equal to the date and time specified, in the format defined by RFC3339.

    Example: 2016-12-19T16:39:57.600Z

  • :time_last_login_less_than (DateTime)

    A filter to return users whose last login time in the database is less than the date and time specified, in the format defined by RFC3339. Example: 2016-12-19T16:39:57.600Z

  • :time_user_created_greater_than_or_equal_to (DateTime)

    A filter to return users whose creation time in the database is greater than or equal to the date and time specified, in the format defined by RFC3339. Example: 2016-12-19T16:39:57.600Z

  • :time_user_created_less_than (DateTime)

    A filter to return users whose creation time in the database is less than the date and time specified, in the format defined by RFC3339. Example: 2016-12-19T16:39:57.600Z

  • :time_password_last_changed_greater_than_or_equal_to (DateTime)

    A filter to return users whose last password change in the database is greater than or equal to the date and time specified, in the format defined by RFC3339.

    Example: 2016-12-19T16:39:57.600Z

  • :time_password_last_changed_less_than (DateTime)

    A filter to return users whose last password change in the database is less than the date and time specified, in the format defined by RFC3339.

    Example: 2016-12-19T16:39:57.600Z

  • :page (String)

    For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

  • :sort_order (String)

    The sort order to use, either ascending (ASC) or descending (DESC). (default to ASC) Allowed values are: ASC, DESC

  • :sort_by (String)

    The field to sort by. You can specify only one sort order (sortOrder). The default order for userName is ascending. (default to userName)

  • :opc_request_id (String)

    Unique identifier for the request.

  • :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:



17542
17543
17544
17545
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
17596
17597
17598
17599
17600
17601
17602
17603
17604
17605
17606
17607
17608
17609
17610
17611
17612
17613
# File 'lib/oci/data_safe/data_safe_client.rb', line 17542

def list_users(user_assessment_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#list_users.' if logger

  raise "Missing the required parameter 'user_assessment_id' when calling list_users." if user_assessment_id.nil?

  if opts[:access_level] && !%w[RESTRICTED ACCESSIBLE].include?(opts[:access_level])
    raise 'Invalid value for "access_level", must be one of RESTRICTED, ACCESSIBLE.'
  end

  if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of ASC, DESC.'
  end

  if opts[:sort_by] && !%w[userName userCategory accountStatus timeLastLogin targetId timeUserCreated authenticationType timePasswordChanged].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of userName, userCategory, accountStatus, timeLastLogin, targetId, timeUserCreated, authenticationType, timePasswordChanged.'
  end
  raise "Parameter value for 'user_assessment_id' must not be blank" if OCI::Internal::Util.blank_string?(user_assessment_id)

  path = '/userAssessments/{userAssessmentId}/users'.sub('{userAssessmentId}', user_assessment_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:compartmentIdInSubtree] = opts[:compartment_id_in_subtree] if !opts[:compartment_id_in_subtree].nil?
  query_params[:accessLevel] = opts[:access_level] if opts[:access_level]
  query_params[:userCategory] = opts[:user_category] if opts[:user_category]
  query_params[:userRole] = opts[:user_role] if opts[:user_role]
  query_params[:userProfile] = opts[:user_profile] if opts[:user_profile]
  query_params[:userType] = opts[:user_type] if opts[:user_type]
  query_params[:userKey] = opts[:user_key] if opts[:user_key]
  query_params[:accountStatus] = opts[:account_status] if opts[:account_status]
  query_params[:authenticationType] = opts[:authentication_type] if opts[:authentication_type]
  query_params[:userName] = opts[:user_name] if opts[:user_name]
  query_params[:targetId] = opts[:target_id] if opts[:target_id]
  query_params[:timeLastLoginGreaterThanOrEqualTo] = opts[:time_last_login_greater_than_or_equal_to] if opts[:time_last_login_greater_than_or_equal_to]
  query_params[:timeLastLoginLessThan] = opts[:time_last_login_less_than] if opts[:time_last_login_less_than]
  query_params[:timeUserCreatedGreaterThanOrEqualTo] = opts[:time_user_created_greater_than_or_equal_to] if opts[:time_user_created_greater_than_or_equal_to]
  query_params[:timeUserCreatedLessThan] = opts[:time_user_created_less_than] if opts[:time_user_created_less_than]
  query_params[:timePasswordLastChangedGreaterThanOrEqualTo] = opts[:time_password_last_changed_greater_than_or_equal_to] if opts[:time_password_last_changed_greater_than_or_equal_to]
  query_params[:timePasswordLastChangedLessThan] = opts[:time_password_last_changed_less_than] if opts[:time_password_last_changed_less_than]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  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:



17634
17635
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
# File 'lib/oci/data_safe/data_safe_client.rb', line 17634

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:



17693
17694
17695
17696
17697
17698
17699
17700
17701
17702
17703
17704
17705
17706
17707
17708
17709
17710
17711
17712
17713
17714
17715
17716
17717
17718
17719
17720
17721
17722
17723
17724
17725
17726
17727
17728
17729
17730
17731
# File 'lib/oci/data_safe/data_safe_client.rb', line 17693

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:



17770
17771
17772
17773
17774
17775
17776
17777
17778
17779
17780
17781
17782
17783
17784
17785
17786
17787
17788
17789
17790
17791
17792
17793
17794
17795
17796
17797
17798
17799
17800
17801
17802
17803
17804
17805
17806
17807
17808
17809
17810
17811
17812
17813
17814
17815
17816
17817
17818
17819
17820
17821
17822
17823
17824
17825
17826
17827
# File 'lib/oci/data_safe/data_safe_client.rb', line 17770

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

#loggerLogger

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_request_id (String)

    Unique identifier for the request.

Returns:

  • (Response)

    A Response object with data of type nil



17846
17847
17848
17849
17850
17851
17852
17853
17854
17855
17856
17857
17858
17859
17860
17861
17862
17863
17864
17865
17866
17867
17868
17869
17870
17871
17872
17873
17874
17875
17876
17877
17878
17879
17880
17881
17882
# File 'lib/oci/data_safe/data_safe_client.rb', line 17846

def mask_data(masking_policy_id, mask_data_details, opts = {})
  logger.debug 'Calling operation DataSafeClient#mask_data.' if logger

  raise "Missing the required parameter 'masking_policy_id' when calling mask_data." if masking_policy_id.nil?
  raise "Missing the required parameter 'mask_data_details' when calling mask_data." if mask_data_details.nil?
  raise "Parameter value for 'masking_policy_id' must not be blank" if OCI::Internal::Util.blank_string?(masking_policy_id)

  path = '/maskingPolicies/{maskingPolicyId}/actions/mask'.sub('{maskingPolicyId}', masking_policy_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(mask_data_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#mask_data') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#modify_global_settings(modify_global_settings_details, compartment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use modify_global_settings API.

Modifies Global Settings in Data Safe in the tenancy and region.

Parameters:

  • modify_global_settings_details (OCI::DataSafe::Models::ModifyGlobalSettingsDetails)

    The details used to update global settings in Data Safe.

  • compartment_id (String)

    The OCID of the compartment.

  • opts (Hash) (defaults to: {})

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig)

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String)

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String)

    Unique identifier for the request.

  • :opc_retry_token (String)

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

Returns:

  • (Response)

    A Response object with data of type nil



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
# File 'lib/oci/data_safe/data_safe_client.rb', line 17913

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



17985
17986
17987
17988
17989
17990
17991
17992
17993
17994
17995
17996
17997
17998
17999
18000
18001
18002
18003
18004
18005
18006
18007
18008
18009
18010
18011
18012
18013
18014
18015
18016
18017
18018
18019
18020
18021
18022
18023
18024
18025
18026
# File 'lib/oci/data_safe/data_safe_client.rb', line 17985

def patch_alerts(patch_alerts_details, opts = {})
  logger.debug 'Calling operation DataSafeClient#patch_alerts.' if logger

  raise "Missing the required parameter 'patch_alerts_details' when calling patch_alerts." if patch_alerts_details.nil?

  if opts[:access_level] && !%w[RESTRICTED ACCESSIBLE].include?(opts[:access_level])
    raise 'Invalid value for "access_level", must be one of RESTRICTED, ACCESSIBLE.'
  end

  path = '/alerts'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentIdInSubtree] = opts[:compartment_id_in_subtree] if !opts[:compartment_id_in_subtree].nil?
  query_params[:accessLevel] = opts[:access_level] if opts[:access_level]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(patch_alerts_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#patch_alerts') do
    @api_client.call_api(
      :PATCH,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#patch_discovery_job_results(discovery_job_id, patch_discovery_job_result_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use patch_discovery_job_results API.

Patches one or more discovery results. You can use this operation to set the plannedAction attribute before using ApplyDiscoveryJobResults to process the results based on this attribute.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig)

    The retry configuration to apply to this operation. If no key is provided then the 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



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
# File 'lib/oci/data_safe/data_safe_client.rb', line 18053

def patch_discovery_job_results(discovery_job_id, patch_discovery_job_result_details, opts = {})
  logger.debug 'Calling operation DataSafeClient#patch_discovery_job_results.' if logger

  raise "Missing the required parameter 'discovery_job_id' when calling patch_discovery_job_results." if discovery_job_id.nil?
  raise "Missing the required parameter 'patch_discovery_job_result_details' when calling patch_discovery_job_results." if patch_discovery_job_result_details.nil?
  raise "Parameter value for 'discovery_job_id' must not be blank" if OCI::Internal::Util.blank_string?(discovery_job_id)

  path = '/discoveryJobs/{discoveryJobId}/results'.sub('{discoveryJobId}', discovery_job_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(patch_discovery_job_result_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#patch_discovery_job_results') do
    @api_client.call_api(
      :PATCH,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#patch_masking_columns(masking_policy_id, patch_masking_columns_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use patch_masking_columns API.

Patches one or more columns in the specified masking policy. Use it to create, or update masking columns. To create masking columns, use CreateMaskingColumnDetails as the patch value. And to update masking columns, use UpdateMaskingColumnDetails as the patch value.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig)

    The retry configuration to apply to this operation. If no key is provided then the 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



18118
18119
18120
18121
18122
18123
18124
18125
18126
18127
18128
18129
18130
18131
18132
18133
18134
18135
18136
18137
18138
18139
18140
18141
18142
18143
18144
18145
18146
18147
18148
18149
18150
18151
18152
18153
18154
18155
# File 'lib/oci/data_safe/data_safe_client.rb', line 18118

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



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
# File 'lib/oci/data_safe/data_safe_client.rb', line 18182

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



18247
18248
18249
18250
18251
18252
18253
18254
18255
18256
18257
18258
18259
18260
18261
18262
18263
18264
18265
18266
18267
18268
18269
18270
18271
18272
18273
18274
18275
18276
18277
18278
18279
18280
18281
18282
18283
18284
# File 'lib/oci/data_safe/data_safe_client.rb', line 18247

def patch_sensitive_columns(sensitive_data_model_id, patch_sensitive_column_details, opts = {})
  logger.debug 'Calling operation DataSafeClient#patch_sensitive_columns.' if logger

  raise "Missing the required parameter 'sensitive_data_model_id' when calling patch_sensitive_columns." if sensitive_data_model_id.nil?
  raise "Missing the required parameter 'patch_sensitive_column_details' when calling patch_sensitive_columns." if patch_sensitive_column_details.nil?
  raise "Parameter value for 'sensitive_data_model_id' must not be blank" if OCI::Internal::Util.blank_string?(sensitive_data_model_id)

  path = '/sensitiveDataModels/{sensitiveDataModelId}/sensitiveColumns'.sub('{sensitiveDataModelId}', sensitive_data_model_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(patch_sensitive_column_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#patch_sensitive_columns') do
    @api_client.call_api(
      :PATCH,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#patch_target_alert_policy_association(patch_target_alert_policy_association_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use patch_target_alert_policy_association API.

Creates new target-alert policy associations that will be applied on the target database.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig)

    The retry configuration to apply to this operation. If no key is provided then the 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



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
18338
18339
18340
18341
18342
18343
18344
# File 'lib/oci/data_safe/data_safe_client.rb', line 18309

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



18374
18375
18376
18377
18378
18379
18380
18381
18382
18383
18384
18385
18386
18387
18388
18389
18390
18391
18392
18393
18394
18395
18396
18397
18398
18399
18400
18401
18402
18403
18404
18405
18406
18407
18408
18409
18410
18411
18412
18413
# File 'lib/oci/data_safe/data_safe_client.rb', line 18374

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



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
18470
18471
18472
18473
18474
18475
18476
18477
18478
18479
18480
# File 'lib/oci/data_safe/data_safe_client.rb', line 18442

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



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
18537
18538
18539
18540
18541
18542
18543
18544
18545
18546
18547
# File 'lib/oci/data_safe/data_safe_client.rb', line 18509

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



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 18579

def refresh_security_assessment(security_assessment_id, run_security_assessment_details, opts = {})
  logger.debug 'Calling operation DataSafeClient#refresh_security_assessment.' if logger

  raise "Missing the required parameter 'security_assessment_id' when calling refresh_security_assessment." if security_assessment_id.nil?
  raise "Missing the required parameter 'run_security_assessment_details' when calling refresh_security_assessment." if run_security_assessment_details.nil?
  raise "Parameter value for 'security_assessment_id' must not be blank" if OCI::Internal::Util.blank_string?(security_assessment_id)

  path = '/securityAssessments/{securityAssessmentId}/actions/refresh'.sub('{securityAssessmentId}', security_assessment_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(run_security_assessment_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#refresh_security_assessment') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#refresh_sql_collection_log_insights(sql_collection_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use refresh_sql_collection_log_insights API.

Refresh the specified SQL collection Log Insights.

Parameters:

  • sql_collection_id (String)

    The OCID of the SQL collection resource.

  • opts (Hash) (defaults to: {})

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig)

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String)

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String)

    Unique identifier for the request.

  • :opc_retry_token (String)

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

Returns:

  • (Response)

    A Response object with data of type nil



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
# File 'lib/oci/data_safe/data_safe_client.rb', line 18647

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



18715
18716
18717
18718
18719
18720
18721
18722
18723
18724
18725
18726
18727
18728
18729
18730
18731
18732
18733
18734
18735
18736
18737
18738
18739
18740
18741
18742
18743
18744
18745
18746
18747
18748
18749
18750
18751
18752
18753
# File 'lib/oci/data_safe/data_safe_client.rb', line 18715

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



18786
18787
18788
18789
18790
18791
18792
18793
18794
18795
18796
18797
18798
18799
18800
18801
18802
18803
18804
18805
18806
18807
18808
18809
18810
18811
18812
18813
18814
18815
18816
18817
18818
18819
18820
18821
18822
18823
18824
18825
# File 'lib/oci/data_safe/data_safe_client.rb', line 18786

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



18854
18855
18856
18857
18858
18859
18860
18861
18862
18863
18864
18865
18866
18867
18868
18869
18870
18871
18872
18873
18874
18875
18876
18877
18878
18879
18880
18881
18882
18883
18884
18885
18886
18887
18888
18889
18890
18891
18892
# File 'lib/oci/data_safe/data_safe_client.rb', line 18854

def remove_schedule_report(report_definition_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#remove_schedule_report.' if logger

  raise "Missing the required parameter 'report_definition_id' when calling remove_schedule_report." if report_definition_id.nil?
  raise "Parameter value for 'report_definition_id' must not be blank" if OCI::Internal::Util.blank_string?(report_definition_id)

  path = '/reportDefinitions/{reportDefinitionId}/actions/removeScheduleReport'.sub('{reportDefinitionId}', report_definition_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#remove_schedule_report') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#resume_audit_trail(audit_trail_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use resume_audit_trail API.

Resumes the specified audit trail once it got stopped.

Parameters:

  • audit_trail_id (String)

    The OCID of the audit trail.

  • opts (Hash) (defaults to: {})

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig)

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String)

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String)

    Unique identifier for the request.

Returns:

  • (Response)

    A Response object with data of type nil



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
# File 'lib/oci/data_safe/data_safe_client.rb', line 18916

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



18982
18983
18984
18985
18986
18987
18988
18989
18990
18991
18992
18993
18994
18995
18996
18997
18998
18999
19000
19001
19002
19003
19004
19005
19006
19007
19008
19009
19010
19011
19012
19013
19014
19015
19016
19017
19018
19019
19020
# File 'lib/oci/data_safe/data_safe_client.rb', line 18982

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



19049
19050
19051
19052
19053
19054
19055
19056
19057
19058
19059
19060
19061
19062
19063
19064
19065
19066
19067
19068
19069
19070
19071
19072
19073
19074
19075
19076
19077
19078
19079
19080
19081
19082
19083
19084
19085
19086
19087
# File 'lib/oci/data_safe/data_safe_client.rb', line 19049

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



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
# File 'lib/oci/data_safe/data_safe_client.rb', line 19117

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



19186
19187
19188
19189
19190
19191
19192
19193
19194
19195
19196
19197
19198
19199
19200
19201
19202
19203
19204
19205
19206
19207
19208
19209
19210
19211
19212
19213
19214
19215
19216
19217
19218
19219
19220
19221
19222
19223
19224
# File 'lib/oci/data_safe/data_safe_client.rb', line 19186

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



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
# File 'lib/oci/data_safe/data_safe_client.rb', line 19254

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



19322
19323
19324
19325
19326
19327
19328
19329
19330
19331
19332
19333
19334
19335
19336
19337
19338
19339
19340
19341
19342
19343
19344
19345
19346
19347
19348
19349
19350
19351
19352
19353
19354
19355
19356
19357
19358
19359
19360
19361
# File 'lib/oci/data_safe/data_safe_client.rb', line 19322

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



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
# File 'lib/oci/data_safe/data_safe_client.rb', line 19390

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



19452
19453
19454
19455
19456
19457
19458
19459
19460
19461
19462
19463
19464
19465
19466
19467
19468
19469
19470
19471
19472
19473
19474
19475
19476
19477
19478
19479
19480
19481
19482
19483
19484
19485
19486
19487
19488
# File 'lib/oci/data_safe/data_safe_client.rb', line 19452

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



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
# File 'lib/oci/data_safe/data_safe_client.rb', line 19517

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



19585
19586
19587
19588
19589
19590
19591
19592
19593
19594
19595
19596
19597
19598
19599
19600
19601
19602
19603
19604
19605
19606
19607
19608
19609
19610
19611
19612
19613
19614
19615
19616
19617
19618
19619
19620
19621
19622
19623
# File 'lib/oci/data_safe/data_safe_client.rb', line 19585

def suspend_work_request(work_request_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#suspend_work_request.' if logger

  raise "Missing the required parameter 'work_request_id' when calling suspend_work_request." if work_request_id.nil?
  raise "Parameter value for 'work_request_id' must not be blank" if OCI::Internal::Util.blank_string?(work_request_id)

  path = '/workRequests/{workRequestId}/actions/suspend'.sub('{workRequestId}', work_request_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#suspend_work_request') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#unset_security_assessment_baseline(security_assessment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use unset_security_assessment_baseline API.

Removes the baseline setting for the saved security assessment. The saved security assessment is no longer considered a baseline. Sets the if-match parameter to the value of the etag from a previous GET or POST response for that resource.

Parameters:

  • security_assessment_id (String)

    The OCID of the security assessment.

  • opts (Hash) (defaults to: {})

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig)

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String)

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_retry_token (String)

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

  • :opc_request_id (String)

    Unique identifier for the request.

Returns:

  • (Response)

    A Response object with data of type nil



19654
19655
19656
19657
19658
19659
19660
19661
19662
19663
19664
19665
19666
19667
19668
19669
19670
19671
19672
19673
19674
19675
19676
19677
19678
19679
19680
19681
19682
19683
19684
19685
19686
19687
19688
19689
19690
19691
19692
# File 'lib/oci/data_safe/data_safe_client.rb', line 19654

def unset_security_assessment_baseline(security_assessment_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#unset_security_assessment_baseline.' if logger

  raise "Missing the required parameter 'security_assessment_id' when calling unset_security_assessment_baseline." if security_assessment_id.nil?
  raise "Parameter value for 'security_assessment_id' must not be blank" if OCI::Internal::Util.blank_string?(security_assessment_id)

  path = '/securityAssessments/{securityAssessmentId}/actions/unsetBaseline'.sub('{securityAssessmentId}', security_assessment_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#unset_security_assessment_baseline') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#unset_user_assessment_baseline(user_assessment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use unset_user_assessment_baseline API.

Removes the baseline setting for the saved user assessment. The saved user assessment is no longer considered a baseline. Sets the if-match parameter to the value of the etag from a previous GET or POST response for that resource.

Parameters:

  • user_assessment_id (String)

    The OCID of the user assessment.

  • opts (Hash) (defaults to: {})

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig)

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String)

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_retry_token (String)

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

  • :opc_request_id (String)

    Unique identifier for the request.

Returns:

  • (Response)

    A Response object with data of type nil



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
# File 'lib/oci/data_safe/data_safe_client.rb', line 19723

def unset_user_assessment_baseline(user_assessment_id, opts = {})
  logger.debug 'Calling operation DataSafeClient#unset_user_assessment_baseline.' if logger

  raise "Missing the required parameter 'user_assessment_id' when calling unset_user_assessment_baseline." if user_assessment_id.nil?
  raise "Parameter value for 'user_assessment_id' must not be blank" if OCI::Internal::Util.blank_string?(user_assessment_id)

  path = '/userAssessments/{userAssessmentId}/actions/unsetBaseline'.sub('{userAssessmentId}', user_assessment_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#unset_user_assessment_baseline') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_alert(alert_id, update_alert_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use update_alert API.

Updates the status of the specified alert.

Parameters:

  • alert_id (String)

    The OCID of alert.

  • update_alert_details (OCI::DataSafe::Models::UpdateAlertDetails)

    The details used to update alert status.

  • opts (Hash) (defaults to: {})

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig)

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String)

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String)

    Unique identifier for the request.

Returns:



19786
19787
19788
19789
19790
19791
19792
19793
19794
19795
19796
19797
19798
19799
19800
19801
19802
19803
19804
19805
19806
19807
19808
19809
19810
19811
19812
19813
19814
19815
19816
19817
19818
19819
19820
19821
19822
19823
19824
# File 'lib/oci/data_safe/data_safe_client.rb', line 19786

def update_alert(alert_id, update_alert_details, opts = {})
  logger.debug 'Calling operation DataSafeClient#update_alert.' if logger

  raise "Missing the required parameter 'alert_id' when calling update_alert." if alert_id.nil?
  raise "Missing the required parameter 'update_alert_details' when calling update_alert." if update_alert_details.nil?
  raise "Parameter value for 'alert_id' must not be blank" if OCI::Internal::Util.blank_string?(alert_id)

  path = '/alerts/{alertId}'.sub('{alertId}', alert_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(update_alert_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#update_alert') do
    @api_client.call_api(
      :PUT,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataSafe::Models::Alert'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_audit_archive_retrieval(audit_archive_retrieval_id, update_audit_archive_retrieval_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use update_audit_archive_retrieval API.

Updates the audit archive retrieval.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig)

    The retry configuration to apply to this operation. If no key is provided then the 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



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
19881
19882
19883
19884
19885
19886
# File 'lib/oci/data_safe/data_safe_client.rb', line 19849

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



19911
19912
19913
19914
19915
19916
19917
19918
19919
19920
19921
19922
19923
19924
19925
19926
19927
19928
19929
19930
19931
19932
19933
19934
19935
19936
19937
19938
19939
19940
19941
19942
19943
19944
19945
19946
19947
19948
# File 'lib/oci/data_safe/data_safe_client.rb', line 19911

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



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
# File 'lib/oci/data_safe/data_safe_client.rb', line 19973

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



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
# File 'lib/oci/data_safe/data_safe_client.rb', line 20035

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



20097
20098
20099
20100
20101
20102
20103
20104
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
# File 'lib/oci/data_safe/data_safe_client.rb', line 20097

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



20159
20160
20161
20162
20163
20164
20165
20166
20167
20168
20169
20170
20171
20172
20173
20174
20175
20176
20177
20178
20179
20180
20181
20182
20183
20184
20185
20186
20187
20188
20189
20190
20191
20192
20193
20194
20195
20196
# File 'lib/oci/data_safe/data_safe_client.rb', line 20159

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



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
# File 'lib/oci/data_safe/data_safe_client.rb', line 20227

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



20293
20294
20295
20296
20297
20298
20299
20300
20301
20302
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
# File 'lib/oci/data_safe/data_safe_client.rb', line 20293

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



20358
20359
20360
20361
20362
20363
20364
20365
20366
20367
20368
20369
20370
20371
20372
20373
20374
20375
20376
20377
20378
20379
20380
20381
20382
20383
20384
20385
20386
20387
20388
20389
20390
20391
20392
20393
20394
20395
20396
20397
# File 'lib/oci/data_safe/data_safe_client.rb', line 20358

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



20422
20423
20424
20425
20426
20427
20428
20429
20430
20431
20432
20433
20434
20435
20436
20437
20438
20439
20440
20441
20442
20443
20444
20445
20446
20447
20448
20449
20450
20451
20452
20453
20454
20455
20456
20457
20458
20459
# File 'lib/oci/data_safe/data_safe_client.rb', line 20422

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



20484
20485
20486
20487
20488
20489
20490
20491
20492
20493
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
# File 'lib/oci/data_safe/data_safe_client.rb', line 20484

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



20552
20553
20554
20555
20556
20557
20558
20559
20560
20561
20562
20563
20564
20565
20566
20567
20568
20569
20570
20571
20572
20573
20574
20575
20576
20577
20578
20579
20580
20581
20582
20583
20584
20585
20586
20587
20588
20589
20590
20591
# File 'lib/oci/data_safe/data_safe_client.rb', line 20552

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



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
# File 'lib/oci/data_safe/data_safe_client.rb', line 20622

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



20693
20694
20695
20696
20697
20698
20699
20700
20701
20702
20703
20704
20705
20706
20707
20708
20709
20710
20711
20712
20713
20714
20715
20716
20717
20718
20719
20720
20721
20722
20723
20724
20725
20726
20727
20728
20729
20730
20731
20732
# File 'lib/oci/data_safe/data_safe_client.rb', line 20693

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



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
# File 'lib/oci/data_safe/data_safe_client.rb', line 20762

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



20826
20827
20828
20829
20830
20831
20832
20833
20834
20835
20836
20837
20838
20839
20840
20841
20842
20843
20844
20845
20846
20847
20848
20849
20850
20851
20852
20853
20854
20855
20856
20857
20858
20859
20860
20861
20862
20863
# File 'lib/oci/data_safe/data_safe_client.rb', line 20826

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



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
# File 'lib/oci/data_safe/data_safe_client.rb', line 20889

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



20951
20952
20953
20954
20955
20956
20957
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
# File 'lib/oci/data_safe/data_safe_client.rb', line 20951

def update_security_policy(security_policy_id, update_security_policy_details, opts = {})
  logger.debug 'Calling operation DataSafeClient#update_security_policy.' if logger

  raise "Missing the required parameter 'security_policy_id' when calling update_security_policy." if security_policy_id.nil?
  raise "Missing the required parameter 'update_security_policy_details' when calling update_security_policy." if update_security_policy_details.nil?
  raise "Parameter value for 'security_policy_id' must not be blank" if OCI::Internal::Util.blank_string?(security_policy_id)

  path = '/securityPolicies/{securityPolicyId}'.sub('{securityPolicyId}', security_policy_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(update_security_policy_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#update_security_policy') do
    @api_client.call_api(
      :PUT,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_security_policy_deployment(security_policy_deployment_id, update_security_policy_deployment_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use update_security_policy_deployment API.

Updates the security policy deployment.

Parameters:

  • security_policy_deployment_id (String)

    The OCID of the security policy deployment resource.

  • update_security_policy_deployment_details (OCI::DataSafe::Models::UpdateSecurityPolicyDeploymentDetails)

    Details to update the security policy deployment.

  • opts (Hash) (defaults to: {})

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig)

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String)

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String)

    Unique identifier for the request.

Returns:

  • (Response)

    A Response object with data of type nil



21013
21014
21015
21016
21017
21018
21019
21020
21021
21022
21023
21024
21025
21026
21027
21028
21029
21030
21031
21032
21033
21034
21035
21036
21037
21038
21039
21040
21041
21042
21043
21044
21045
21046
21047
21048
21049
21050
# File 'lib/oci/data_safe/data_safe_client.rb', line 21013

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



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
# File 'lib/oci/data_safe/data_safe_client.rb', line 21076

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



21142
21143
21144
21145
21146
21147
21148
21149
21150
21151
21152
21153
21154
21155
21156
21157
21158
21159
21160
21161
21162
21163
21164
21165
21166
21167
21168
21169
21170
21171
21172
21173
21174
21175
21176
21177
21178
21179
# File 'lib/oci/data_safe/data_safe_client.rb', line 21142

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



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
# File 'lib/oci/data_safe/data_safe_client.rb', line 21204

def update_sensitive_type(sensitive_type_id, update_sensitive_type_details, opts = {})
  logger.debug 'Calling operation DataSafeClient#update_sensitive_type.' if logger

  raise "Missing the required parameter 'sensitive_type_id' when calling update_sensitive_type." if sensitive_type_id.nil?
  raise "Missing the required parameter 'update_sensitive_type_details' when calling update_sensitive_type." if update_sensitive_type_details.nil?
  raise "Parameter value for 'sensitive_type_id' must not be blank" if OCI::Internal::Util.blank_string?(sensitive_type_id)

  path = '/sensitiveTypes/{sensitiveTypeId}'.sub('{sensitiveTypeId}', sensitive_type_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(update_sensitive_type_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#update_sensitive_type') do
    @api_client.call_api(
      :PUT,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_sql_collection(sql_collection_id, update_sql_collection_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use update_sql_collection API.

Updates the SQL collection.

Parameters:

  • sql_collection_id (String)

    The OCID of the SQL collection resource.

  • update_sql_collection_details (OCI::DataSafe::Models::UpdateSqlCollectionDetails)

    Details to update the SQL collection.

  • opts (Hash) (defaults to: {})

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig)

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String)

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String)

    Unique identifier for the request.

Returns:

  • (Response)

    A Response object with data of type nil



21266
21267
21268
21269
21270
21271
21272
21273
21274
21275
21276
21277
21278
21279
21280
21281
21282
21283
21284
21285
21286
21287
21288
21289
21290
21291
21292
21293
21294
21295
21296
21297
21298
21299
21300
21301
21302
21303
# File 'lib/oci/data_safe/data_safe_client.rb', line 21266

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



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
21361
21362
21363
21364
21365
# File 'lib/oci/data_safe/data_safe_client.rb', line 21328

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



21390
21391
21392
21393
21394
21395
21396
21397
21398
21399
21400
21401
21402
21403
21404
21405
21406
21407
21408
21409
21410
21411
21412
21413
21414
21415
21416
21417
21418
21419
21420
21421
21422
21423
21424
21425
21426
21427
# File 'lib/oci/data_safe/data_safe_client.rb', line 21390

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



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
# File 'lib/oci/data_safe/data_safe_client.rb', line 21457

def update_target_database(target_database_id, update_target_database_details, opts = {})
  logger.debug 'Calling operation DataSafeClient#update_target_database.' if logger

  raise "Missing the required parameter 'target_database_id' when calling update_target_database." if target_database_id.nil?
  raise "Missing the required parameter 'update_target_database_details' when calling update_target_database." if update_target_database_details.nil?
  raise "Parameter value for 'target_database_id' must not be blank" if OCI::Internal::Util.blank_string?(target_database_id)

  path = '/targetDatabases/{targetDatabaseId}'.sub('{targetDatabaseId}', target_database_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(update_target_database_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataSafeClient#update_target_database') do
    @api_client.call_api(
      :PUT,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_user_assessment(user_assessment_id, update_user_assessment_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use update_user_assessment API.

Updates one or more attributes of the specified user assessment. This operation allows to update the user assessment displayName, description, or schedule.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig)

    The retry configuration to apply to this operation. If no key is provided then the 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



21522
21523
21524
21525
21526
21527
21528
21529
21530
21531
21532
21533
21534
21535
21536
21537
21538
21539
21540
21541
21542
21543
21544
21545
21546
21547
21548
21549
21550
21551
21552
21553
21554
21555
21556
21557
21558
21559
# File 'lib/oci/data_safe/data_safe_client.rb', line 21522

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



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
21616
21617
21618
21619
21620
21621
21622
21623
21624
21625
21626
# File 'lib/oci/data_safe/data_safe_client.rb', line 21589

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



21655
21656
21657
21658
21659
21660
21661
21662
21663
21664
21665
21666
21667
21668
21669
21670
21671
21672
21673
21674
21675
21676
21677
21678
21679
21680
21681
21682
21683
21684
21685
21686
21687
21688
21689
21690
21691
21692
# File 'lib/oci/data_safe/data_safe_client.rb', line 21655

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