Class: OCI::CloudGuard::CloudGuardClient

#add_compartment(security_zone_id, add_compartment_details, opts = {}) ⇒ `Response`

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/cloudguard/add_compartment.rb.html) to see an example of how to use add_compartment API.

Add an existing compartment to a security zone. If you previously removed a subcompartment from a security zone, you can add it back to the same security zone. The security zone ensures that resources in the subcompartment comply with the security zone's policies.

Parameters:

security_zone_id (String) —

The unique identifier of the security zone (`SecurityZone`)
add_compartment_details (OCI::CloudGuard::Models::AddCompartmentDetails) —

The compartment to add to the security zone.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

The client request ID for tracing.

Returns:

(Response) —

A Response object with data of type SecurityZone

# File 'lib/oci/cloud_guard/cloud_guard_client.rb', line 124

def add_compartment(security_zone_id, add_compartment_details, opts = {})
  logger.debug 'Calling operation CloudGuardClient#add_compartment.' if logger

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

  path = '/securityZones/{securityZoneId}/actions/addCompartment'.sub('{securityZoneId}', security_zone_id.to_s)
  operation_signing_strategy = :standard

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

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'CloudGuardClient#add_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,
      return_type: 'OCI::CloudGuard::Models::SecurityZone'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#change_detector_recipe_compartment(detector_recipe_id, change_detector_recipe_compartment_details, opts = {}) ⇒ `Response`

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/cloudguard/change_detector_recipe_compartment.rb.html) to see an example of how to use change_detector_recipe_compartment API.

Moves the DetectorRecipe from current compartment to another.

Parameters:

detector_recipe_id (String) —

DetectorRecipe OCID
change_detector_recipe_compartment_details (OCI::CloudGuard::Models::ChangeDetectorRecipeCompartmentDetails) —

The target compartment id.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

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

The client request ID for tracing.
:opc_retry_token (String) —

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

Returns:

(Response) —

A Response object with data of type nil

# File 'lib/oci/cloud_guard/cloud_guard_client.rb', line 195

def change_detector_recipe_compartment(detector_recipe_id, change_detector_recipe_compartment_details, opts = {})
  logger.debug 'Calling operation CloudGuardClient#change_detector_recipe_compartment.' if logger

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

  path = '/detectorRecipes/{detectorRecipeId}/actions/changeCompartment'.sub('{detectorRecipeId}', detector_recipe_id.to_s)
  operation_signing_strategy = :standard

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

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_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_detector_recipe_compartment_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'CloudGuardClient#change_detector_recipe_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_managed_list_compartment(managed_list_id, change_managed_list_compartment_details, opts = {}) ⇒ `Response`

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/cloudguard/change_managed_list_compartment.rb.html) to see an example of how to use change_managed_list_compartment API.

Moves the ManagedList from current compartment to another.

Parameters:

managed_list_id (String) —

The cloudguard list OCID to be passed in the request.
change_managed_list_compartment_details (OCI::CloudGuard::Models::ChangeManagedListCompartmentDetails) —

The compartment id of the ManagedList
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

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

The client request ID for tracing.
:opc_retry_token (String) —

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

Returns:

(Response) —

A Response object with data of type nil

# File 'lib/oci/cloud_guard/cloud_guard_client.rb', line 265

def change_managed_list_compartment(managed_list_id, change_managed_list_compartment_details, opts = {})
  logger.debug 'Calling operation CloudGuardClient#change_managed_list_compartment.' if logger

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

  path = '/managedLists/{managedListId}/actions/changeCompartment'.sub('{managedListId}', managed_list_id.to_s)
  operation_signing_strategy = :standard

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

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_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_managed_list_compartment_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'CloudGuardClient#change_managed_list_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_responder_recipe_compartment(responder_recipe_id, change_responder_recipe_compartment_details, opts = {}) ⇒ `Response`

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/cloudguard/change_responder_recipe_compartment.rb.html) to see an example of how to use change_responder_recipe_compartment API.

Moves the ResponderRecipe from current compartment to another.

Parameters:

responder_recipe_id (String) —

OCID of ResponderRecipe
change_responder_recipe_compartment_details (OCI::CloudGuard::Models::ChangeResponderRecipeCompartmentDetails) —

The target compartment id.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

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

The client request ID for tracing.
:opc_retry_token (String) —

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

Returns:

(Response) —

A Response object with data of type nil

# File 'lib/oci/cloud_guard/cloud_guard_client.rb', line 335

def change_responder_recipe_compartment(responder_recipe_id, change_responder_recipe_compartment_details, opts = {})
  logger.debug 'Calling operation CloudGuardClient#change_responder_recipe_compartment.' if logger

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

  path = '/responderRecipes/{responderRecipeId}/actions/changeCompartment'.sub('{responderRecipeId}', responder_recipe_id.to_s)
  operation_signing_strategy = :standard

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

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_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_responder_recipe_compartment_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'CloudGuardClient#change_responder_recipe_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_recipe_compartment(security_recipe_id, change_security_recipe_compartment_details, opts = {}) ⇒ `Response`

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/cloudguard/change_security_recipe_compartment.rb.html) to see an example of how to use change_security_recipe_compartment API.

Moves a security zone recipe to a different compartment. When provided, `If-Match` is checked against `ETag` values of the resource.

Parameters:

security_recipe_id (String) —

The unique identifier of the security zone recipe (`SecurityRecipe`)
change_security_recipe_compartment_details (OCI::CloudGuard::Models::ChangeSecurityRecipeCompartmentDetails) —

The compartment to which you want to move the recipe.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

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

The client request ID for tracing.
:opc_retry_token (String) —

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

Returns:

(Response) —

A Response object with data of type nil

# File 'lib/oci/cloud_guard/cloud_guard_client.rb', line 405

def change_security_recipe_compartment(security_recipe_id, change_security_recipe_compartment_details, opts = {})
  logger.debug 'Calling operation CloudGuardClient#change_security_recipe_compartment.' if logger

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

  path = '/securityRecipes/{securityRecipeId}/actions/changeCompartment'.sub('{securityRecipeId}', security_recipe_id.to_s)
  operation_signing_strategy = :standard

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

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_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_recipe_compartment_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'CloudGuardClient#change_security_recipe_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_zone_compartment(security_zone_id, change_security_zone_compartment_details, opts = {}) ⇒ `Response`

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/cloudguard/change_security_zone_compartment.rb.html) to see an example of how to use change_security_zone_compartment API.

Moves a security zone to a different compartment. When provided, `If-Match` is checked against `ETag` values of the resource.

Parameters:

security_zone_id (String) —

The unique identifier of the security zone (`SecurityZone`)
change_security_zone_compartment_details (OCI::CloudGuard::Models::ChangeSecurityZoneCompartmentDetails) —

The compartment to which you want to move the security zone.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

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

The client request ID for tracing.
:opc_retry_token (String) —

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

Returns:

(Response) —

A Response object with data of type nil

# File 'lib/oci/cloud_guard/cloud_guard_client.rb', line 475

def change_security_zone_compartment(security_zone_id, change_security_zone_compartment_details, opts = {})
  logger.debug 'Calling operation CloudGuardClient#change_security_zone_compartment.' if logger

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

  path = '/securityZones/{securityZoneId}/actions/changeCompartment'.sub('{securityZoneId}', security_zone_id.to_s)
  operation_signing_strategy = :standard

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

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_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_zone_compartment_details)

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

#create_data_mask_rule(create_data_mask_rule_details, opts = {}) ⇒ `Response`

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/cloudguard/create_data_mask_rule.rb.html) to see an example of how to use create_data_mask_rule API.

Creates a new Data Mask Rule Definition

Parameters:

create_data_mask_rule_details (OCI::CloudGuard::Models::CreateDataMaskRuleDetails) —

Definition for the new Data Mask Rule.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. 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) —

The client request ID for tracing.

Returns:

(Response) —

A Response object with data of type DataMaskRule

# File 'lib/oci/cloud_guard/cloud_guard_client.rb', line 539

def create_data_mask_rule(create_data_mask_rule_details, opts = {})
  logger.debug 'Calling operation CloudGuardClient#create_data_mask_rule.' if logger

  raise "Missing the required parameter 'create_data_mask_rule_details' when calling create_data_mask_rule." if create_data_mask_rule_details.nil?

  path = '/dataMaskRules'
  operation_signing_strategy = :standard

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

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

#create_detector_recipe(create_detector_recipe_details, opts = {}) ⇒ `Response`

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/cloudguard/create_detector_recipe.rb.html) to see an example of how to use create_detector_recipe API.

Creates a DetectorRecipe

Parameters:

create_detector_recipe_details (OCI::CloudGuard::Models::CreateDetectorRecipeDetails) —

Details for the new DetectorRecipe.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

The client request ID for tracing.

Returns:

(Response) —

A Response object with data of type DetectorRecipe

# File 'lib/oci/cloud_guard/cloud_guard_client.rb', line 601

def create_detector_recipe(create_detector_recipe_details, opts = {})
  logger.debug 'Calling operation CloudGuardClient#create_detector_recipe.' if logger

  raise "Missing the required parameter 'create_detector_recipe_details' when calling create_detector_recipe." if create_detector_recipe_details.nil?

  path = '/detectorRecipes'
  operation_signing_strategy = :standard

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

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'CloudGuardClient#create_detector_recipe') do
    @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::CloudGuard::Models::DetectorRecipe'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_managed_list(create_managed_list_details, opts = {}) ⇒ `Response`

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/cloudguard/create_managed_list.rb.html) to see an example of how to use create_managed_list API.

Creates a new ManagedList.

Parameters:

create_managed_list_details (OCI::CloudGuard::Models::CreateManagedListDetails) —

Details for the new ManagedList.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

The client request ID for tracing.

Returns:

(Response) —

A Response object with data of type ManagedList

# File 'lib/oci/cloud_guard/cloud_guard_client.rb', line 663

def create_managed_list(create_managed_list_details, opts = {})
  logger.debug 'Calling operation CloudGuardClient#create_managed_list.' if logger

  raise "Missing the required parameter 'create_managed_list_details' when calling create_managed_list." if create_managed_list_details.nil?

  path = '/managedLists'
  operation_signing_strategy = :standard

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

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'CloudGuardClient#create_managed_list') do
    @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::CloudGuard::Models::ManagedList'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_responder_recipe(create_responder_recipe_details, opts = {}) ⇒ `Response`

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/cloudguard/create_responder_recipe.rb.html) to see an example of how to use create_responder_recipe API.

Create a ResponderRecipe.

Parameters:

create_responder_recipe_details (OCI::CloudGuard::Models::CreateResponderRecipeDetails) —

Details for ResponderRecipe.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

The client request ID for tracing.

Returns:

(Response) —

A Response object with data of type ResponderRecipe

# File 'lib/oci/cloud_guard/cloud_guard_client.rb', line 725

def create_responder_recipe(create_responder_recipe_details, opts = {})
  logger.debug 'Calling operation CloudGuardClient#create_responder_recipe.' if logger

  raise "Missing the required parameter 'create_responder_recipe_details' when calling create_responder_recipe." if create_responder_recipe_details.nil?

  path = '/responderRecipes'
  operation_signing_strategy = :standard

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

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'CloudGuardClient#create_responder_recipe') do
    @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::CloudGuard::Models::ResponderRecipe'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_security_recipe(create_security_recipe_details, opts = {}) ⇒ `Response`

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/cloudguard/create_security_recipe.rb.html) to see an example of how to use create_security_recipe API.

Creates a security zone recipe. A security zone recipe is a collection of security zone policies.

Parameters:

create_security_recipe_details (OCI::CloudGuard::Models::CreateSecurityRecipeDetails) —

Details for the new `SecurityRecipe`.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

The client request ID for tracing.

Returns:

(Response) —

A Response object with data of type SecurityRecipe

# File 'lib/oci/cloud_guard/cloud_guard_client.rb', line 787

def create_security_recipe(create_security_recipe_details, opts = {})
  logger.debug 'Calling operation CloudGuardClient#create_security_recipe.' if logger

  raise "Missing the required parameter 'create_security_recipe_details' when calling create_security_recipe." if create_security_recipe_details.nil?

  path = '/securityRecipes'
  operation_signing_strategy = :standard

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

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'CloudGuardClient#create_security_recipe') do
    @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::CloudGuard::Models::SecurityRecipe'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_security_zone(create_security_zone_details, opts = {}) ⇒ `Response`

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/cloudguard/create_security_zone.rb.html) to see an example of how to use create_security_zone API.

Creates a security zone for a compartment. A security zone enforces all security zone policies in a given security zone recipe. Any actions that violate a policy are denied. By default, any subcompartments are also in the same security zone.

Parameters:

create_security_zone_details (OCI::CloudGuard::Models::CreateSecurityZoneDetails) —

Details for the new `SecurityZone`.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

The client request ID for tracing.

Returns:

(Response) —

A Response object with data of type SecurityZone

# File 'lib/oci/cloud_guard/cloud_guard_client.rb', line 849

def create_security_zone(create_security_zone_details, opts = {})
  logger.debug 'Calling operation CloudGuardClient#create_security_zone.' if logger

  raise "Missing the required parameter 'create_security_zone_details' when calling create_security_zone." if create_security_zone_details.nil?

  path = '/securityZones'
  operation_signing_strategy = :standard

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

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'CloudGuardClient#create_security_zone') do
    @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::CloudGuard::Models::SecurityZone'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_target(create_target_details, opts = {}) ⇒ `Response`

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/cloudguard/create_target.rb.html) to see an example of how to use create_target API.

Creates a new Target

Parameters:

create_target_details (OCI::CloudGuard::Models::CreateTargetDetails) —

Details for the new Target.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

The client request ID for tracing.

Returns:

(Response) —

A Response object with data of type Target

# File 'lib/oci/cloud_guard/cloud_guard_client.rb', line 911

def create_target(create_target_details, opts = {})
  logger.debug 'Calling operation CloudGuardClient#create_target.' if logger

  raise "Missing the required parameter 'create_target_details' when calling create_target." if create_target_details.nil?

  path = '/targets'
  operation_signing_strategy = :standard

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

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'CloudGuardClient#create_target') do
    @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::CloudGuard::Models::Target'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_target_detector_recipe(target_id, attach_target_detector_recipe_details, opts = {}) ⇒ `Response`

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/cloudguard/create_target_detector_recipe.rb.html) to see an example of how to use create_target_detector_recipe API.

Attach a DetectorRecipe with the Target

Parameters:

target_id (String) —

OCID of target
attach_target_detector_recipe_details (OCI::CloudGuard::Models::AttachTargetDetectorRecipeDetails) —

Details for associating DetectorRecipe to Target
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

The client request ID for tracing.

Returns:

(Response) —

A Response object with data of type TargetDetectorRecipe

# File 'lib/oci/cloud_guard/cloud_guard_client.rb', line 974

def create_target_detector_recipe(target_id, attach_target_detector_recipe_details, opts = {})
  logger.debug 'Calling operation CloudGuardClient#create_target_detector_recipe.' if logger

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

  path = '/targets/{targetId}/targetDetectorRecipes'.sub('{targetId}', target_id.to_s)
  operation_signing_strategy = :standard

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

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'CloudGuardClient#create_target_detector_recipe') do
    @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::CloudGuard::Models::TargetDetectorRecipe'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_target_responder_recipe(target_id, attach_target_responder_recipe_details, opts = {}) ⇒ `Response`

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/cloudguard/create_target_responder_recipe.rb.html) to see an example of how to use create_target_responder_recipe API.

Attach a ResponderRecipe with the Target

Parameters:

target_id (String) —

OCID of target
attach_target_responder_recipe_details (OCI::CloudGuard::Models::AttachTargetResponderRecipeDetails) —

Details for associating ResponderRecipe to Target
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

The client request ID for tracing.

Returns:

(Response) —

A Response object with data of type TargetResponderRecipe

# File 'lib/oci/cloud_guard/cloud_guard_client.rb', line 1039

def create_target_responder_recipe(target_id, attach_target_responder_recipe_details, opts = {})
  logger.debug 'Calling operation CloudGuardClient#create_target_responder_recipe.' if logger

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

  path = '/targets/{targetId}/targetResponderRecipes'.sub('{targetId}', target_id.to_s)
  operation_signing_strategy = :standard

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

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'CloudGuardClient#create_target_responder_recipe') do
    @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::CloudGuard::Models::TargetResponderRecipe'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#delete_data_mask_rule(data_mask_rule_id, opts = {}) ⇒ `Response`

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/cloudguard/delete_data_mask_rule.rb.html) to see an example of how to use delete_data_mask_rule API.

Deletes a DataMaskRule identified by dataMaskRuleId

Parameters:

data_mask_rule_id (String) —

OCID of dataMaskRule
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

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

The client request ID for tracing.

Returns:

(Response) —

A Response object with data of type nil

# File 'lib/oci/cloud_guard/cloud_guard_client.rb', line 1102

def delete_data_mask_rule(data_mask_rule_id, opts = {})
  logger.debug 'Calling operation CloudGuardClient#delete_data_mask_rule.' if logger

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

  path = '/dataMaskRules/{dataMaskRuleId}'.sub('{dataMaskRuleId}', data_mask_rule_id.to_s)
  operation_signing_strategy = :standard

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

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_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: 'CloudGuardClient#delete_data_mask_rule') do
    @api_client.call_api(
      :DELETE,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#delete_detector_recipe(detector_recipe_id, opts = {}) ⇒ `Response`

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/cloudguard/delete_detector_recipe.rb.html) to see an example of how to use delete_detector_recipe API.

Deletes a DetectorRecipe identified by detectorRecipeId

Parameters:

detector_recipe_id (String) —

DetectorRecipe 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
:if_match (String) —

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

The client request ID for tracing.
:opc_retry_token (String) —

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

Returns:

(Response) —

A Response object with data of type nil

# File 'lib/oci/cloud_guard/cloud_guard_client.rb', line 1168

def delete_detector_recipe(detector_recipe_id, opts = {})
  logger.debug 'Calling operation CloudGuardClient#delete_detector_recipe.' if logger

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

  path = '/detectorRecipes/{detectorRecipeId}'.sub('{detectorRecipeId}', detector_recipe_id.to_s)
  operation_signing_strategy = :standard

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

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_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: 'CloudGuardClient#delete_detector_recipe') 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_managed_list(managed_list_id, opts = {}) ⇒ `Response`

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/cloudguard/delete_managed_list.rb.html) to see an example of how to use delete_managed_list API.

Deletes a managed list identified by managedListId

Parameters:

managed_list_id (String) —

The cloudguard list OCID to be passed in the request.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

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

The client request ID for tracing.
:opc_retry_token (String) —

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

Returns:

(Response) —

A Response object with data of type nil

# File 'lib/oci/cloud_guard/cloud_guard_client.rb', line 1236

def delete_managed_list(managed_list_id, opts = {})
  logger.debug 'Calling operation CloudGuardClient#delete_managed_list.' if logger

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

  path = '/managedLists/{managedListId}'.sub('{managedListId}', managed_list_id.to_s)
  operation_signing_strategy = :standard

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

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_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: 'CloudGuardClient#delete_managed_list') 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_responder_recipe(responder_recipe_id, opts = {}) ⇒ `Response`

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/cloudguard/delete_responder_recipe.rb.html) to see an example of how to use delete_responder_recipe API.

Delete the ResponderRecipe resource by identifier

Parameters:

responder_recipe_id (String) —

OCID of ResponderRecipe
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

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

The client request ID for tracing.

Returns:

(Response) —

A Response object with data of type nil

# File 'lib/oci/cloud_guard/cloud_guard_client.rb', line 1298

def delete_responder_recipe(responder_recipe_id, opts = {})
  logger.debug 'Calling operation CloudGuardClient#delete_responder_recipe.' if logger

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

  path = '/responderRecipes/{responderRecipeId}'.sub('{responderRecipeId}', responder_recipe_id.to_s)
  operation_signing_strategy = :standard

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

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_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: 'CloudGuardClient#delete_responder_recipe') 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_recipe(security_recipe_id, opts = {}) ⇒ `Response`

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/cloudguard/delete_security_recipe.rb.html) to see an example of how to use delete_security_recipe API.

Deletes a security zone recipe. The recipe can't be associated with an existing security zone.

Parameters:

security_recipe_id (String) —

The unique identifier of the security zone recipe (`SecurityRecipe`)
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

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

The client request ID for tracing.

Returns:

(Response) —

A Response object with data of type nil

# File 'lib/oci/cloud_guard/cloud_guard_client.rb', line 1358

def delete_security_recipe(security_recipe_id, opts = {})
  logger.debug 'Calling operation CloudGuardClient#delete_security_recipe.' if logger

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

  path = '/securityRecipes/{securityRecipeId}'.sub('{securityRecipeId}', security_recipe_id.to_s)
  operation_signing_strategy = :standard

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

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_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: 'CloudGuardClient#delete_security_recipe') 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_zone(security_zone_id, opts = {}) ⇒ `Response`

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/cloudguard/delete_security_zone.rb.html) to see an example of how to use delete_security_zone API.

Deletes an existing security zone with a given identifier.

Parameters:

security_zone_id (String) —

The unique identifier of the security zone (`SecurityZone`)
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

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

The client request ID for tracing.

Returns:

(Response) —

A Response object with data of type nil

# File 'lib/oci/cloud_guard/cloud_guard_client.rb', line 1418

def delete_security_zone(security_zone_id, opts = {})
  logger.debug 'Calling operation CloudGuardClient#delete_security_zone.' if logger

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

  path = '/securityZones/{securityZoneId}'.sub('{securityZoneId}', security_zone_id.to_s)
  operation_signing_strategy = :standard

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

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_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: 'CloudGuardClient#delete_security_zone') 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(target_id, opts = {}) ⇒ `Response`

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/cloudguard/delete_target.rb.html) to see an example of how to use delete_target API.

Deletes a Target identified by targetId

Parameters:

target_id (String) —

OCID of target
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

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

The client request ID for tracing.

Returns:

(Response) —

A Response object with data of type nil

# File 'lib/oci/cloud_guard/cloud_guard_client.rb', line 1478

def delete_target(target_id, opts = {})
  logger.debug 'Calling operation CloudGuardClient#delete_target.' if logger

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

  path = '/targets/{targetId}'.sub('{targetId}', target_id.to_s)
  operation_signing_strategy = :standard

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

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_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: 'CloudGuardClient#delete_target') 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_detector_recipe(target_id, target_detector_recipe_id, opts = {}) ⇒ `Response`

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/cloudguard/delete_target_detector_recipe.rb.html) to see an example of how to use delete_target_detector_recipe API.

Delete the TargetDetectorRecipe resource by identifier

Parameters:

target_id (String) —

OCID of target
target_detector_recipe_id (String) —

OCID of TargetDetectorRecipe
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

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

The client request ID for tracing.

Returns:

(Response) —

A Response object with data of type nil

# File 'lib/oci/cloud_guard/cloud_guard_client.rb', line 1539

def delete_target_detector_recipe(target_id, target_detector_recipe_id, opts = {})
  logger.debug 'Calling operation CloudGuardClient#delete_target_detector_recipe.' if logger

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

  path = '/targets/{targetId}/targetDetectorRecipes/{targetDetectorRecipeId}'.sub('{targetId}', target_id.to_s).sub('{targetDetectorRecipeId}', target_detector_recipe_id.to_s)
  operation_signing_strategy = :standard

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

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_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: 'CloudGuardClient#delete_target_detector_recipe') 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_responder_recipe(target_id, target_responder_recipe_id, opts = {}) ⇒ `Response`

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/cloudguard/delete_target_responder_recipe.rb.html) to see an example of how to use delete_target_responder_recipe API.

Delete the TargetResponderRecipe resource by identifier

Parameters:

target_id (String) —

OCID of target
target_responder_recipe_id (String) —

OCID of TargetResponderRecipe
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

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

The client request ID for tracing.

Returns:

(Response) —

A Response object with data of type nil

# File 'lib/oci/cloud_guard/cloud_guard_client.rb', line 1602

def delete_target_responder_recipe(target_id, target_responder_recipe_id, opts = {})
  logger.debug 'Calling operation CloudGuardClient#delete_target_responder_recipe.' if logger

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

  path = '/targets/{targetId}/targetResponderRecipes/{targetResponderRecipeId}'.sub('{targetId}', target_id.to_s).sub('{targetResponderRecipeId}', target_responder_recipe_id.to_s)
  operation_signing_strategy = :standard

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

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_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: 'CloudGuardClient#delete_target_responder_recipe') 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

#execute_responder_execution(responder_execution_id, compartment_id, opts = {}) ⇒ `Response`

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/cloudguard/execute_responder_execution.rb.html) to see an example of how to use execute_responder_execution API.

Executes the responder execution. When provided, If-Match is checked against ETag values of the resource.

Parameters:

responder_execution_id (String) —

The identifier of the responder execution.
compartment_id (String) —

The ID of the compartment in which to list resources.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

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

The client request ID for tracing.
:opc_retry_token (String) —

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

Details for Responder Configuration

Returns:

(Response) —

A Response object with data of type nil

# File 'lib/oci/cloud_guard/cloud_guard_client.rb', line 1672

def execute_responder_execution(responder_execution_id, compartment_id, opts = {})
  logger.debug 'Calling operation CloudGuardClient#execute_responder_execution.' if logger

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

  path = '/responderExecutions/{responderExecutionId}/actions/execute'.sub('{responderExecutionId}', responder_execution_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = 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]
  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(opts[:execute_responder_execution_details])

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'CloudGuardClient#execute_responder_execution') do
    @api_client.call_api(
      :POST,
      path,
      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_condition_metadata_type(condition_metadata_type_id, opts = {}) ⇒ `Response`

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/cloudguard/get_condition_metadata_type.rb.html) to see an example of how to use get_condition_metadata_type API.

Returns ConditionType with its details.

Parameters:

condition_metadata_type_id (String) —

The type of the condition meta 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) —

The client request ID for tracing.
:service_type (String) —

ServiceType filter for the condition meta data.
:resource_type (String) —

Resource filter for the condition meta data.

Returns:

(Response) —

A Response object with data of type ConditionMetadataType

# File 'lib/oci/cloud_guard/cloud_guard_client.rb', line 1733

def get_condition_metadata_type(condition_metadata_type_id, opts = {})
  logger.debug 'Calling operation CloudGuardClient#get_condition_metadata_type.' if logger

  raise "Missing the required parameter 'condition_metadata_type_id' when calling get_condition_metadata_type." if condition_metadata_type_id.nil?
  unless OCI::CloudGuard::Models::CONDITION_TYPE_ENUM_ENUM.include?(condition_metadata_type_id)
    raise 'Invalid value for "condition_metadata_type_id", must be one of the values in OCI::CloudGuard::Models::CONDITION_TYPE_ENUM_ENUM.'
  end

  raise "Parameter value for 'condition_metadata_type_id' must not be blank" if OCI::Internal::Util.blank_string?(condition_metadata_type_id)

  path = '/conditionMetadataTypes/{conditionMetadataTypeId}'.sub('{conditionMetadataTypeId}', condition_metadata_type_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:serviceType] = opts[:service_type] if opts[:service_type]
  query_params[:resourceType] = opts[:resource_type] if opts[:resource_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: 'CloudGuardClient#get_condition_metadata_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::CloudGuard::Models::ConditionMetadataType'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_configuration(compartment_id, opts = {}) ⇒ `Response`

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/cloudguard/get_configuration.rb.html) to see an example of how to use get_configuration API.

GET Cloud Guard Configuration Details for a Tenancy.

Parameters:

compartment_id (String) —

The ID of the compartment in which to list resources.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

The client request ID for tracing.

Returns:

(Response) —

A Response object with data of type Configuration

# File 'lib/oci/cloud_guard/cloud_guard_client.rb', line 1793

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

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

  path = '/configuration'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = 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: 'CloudGuardClient#get_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::CloudGuard::Models::Configuration'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_data_mask_rule(data_mask_rule_id, opts = {}) ⇒ `Response`

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/cloudguard/get_data_mask_rule.rb.html) to see an example of how to use get_data_mask_rule API.

Returns a DataMaskRule identified by DataMaskRuleId

Parameters:

data_mask_rule_id (String) —

OCID of dataMaskRule
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

The client request ID for tracing.

Returns:

(Response) —

A Response object with data of type DataMaskRule

# File 'lib/oci/cloud_guard/cloud_guard_client.rb', line 1847

def get_data_mask_rule(data_mask_rule_id, opts = {})
  logger.debug 'Calling operation CloudGuardClient#get_data_mask_rule.' if logger

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

  path = '/dataMaskRules/{dataMaskRuleId}'.sub('{dataMaskRuleId}', data_mask_rule_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable 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: 'CloudGuardClient#get_data_mask_rule') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::CloudGuard::Models::DataMaskRule'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_detector(detector_id, opts = {}) ⇒ `Response`

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/cloudguard/get_detector.rb.html) to see an example of how to use get_detector API.

Returns a Detector identified by detectorId.

Parameters:

detector_id (String) —

The Name of Detector.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

The client request ID for tracing.

Returns:

(Response) —

A Response object with data of type Detector

# File 'lib/oci/cloud_guard/cloud_guard_client.rb', line 1902

def get_detector(detector_id, opts = {})
  logger.debug 'Calling operation CloudGuardClient#get_detector.' if logger

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

  path = '/detectors/{detectorId}'.sub('{detectorId}', detector_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable 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: 'CloudGuardClient#get_detector') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::CloudGuard::Models::Detector'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_detector_recipe(detector_recipe_id, opts = {}) ⇒ `Response`

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/cloudguard/get_detector_recipe.rb.html) to see an example of how to use get_detector_recipe API.

Returns a DetectorRecipe identified by detectorRecipeId

Parameters:

detector_recipe_id (String) —

DetectorRecipe 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) —

The client request ID for tracing.

Returns:

(Response) —

A Response object with data of type DetectorRecipe

# File 'lib/oci/cloud_guard/cloud_guard_client.rb', line 1956

def get_detector_recipe(detector_recipe_id, opts = {})
  logger.debug 'Calling operation CloudGuardClient#get_detector_recipe.' if logger

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

  path = '/detectorRecipes/{detectorRecipeId}'.sub('{detectorRecipeId}', detector_recipe_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable 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: 'CloudGuardClient#get_detector_recipe') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::CloudGuard::Models::DetectorRecipe'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_detector_recipe_detector_rule(detector_recipe_id, detector_rule_id, opts = {}) ⇒ `Response`

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/cloudguard/get_detector_recipe_detector_rule.rb.html) to see an example of how to use get_detector_recipe_detector_rule API.

Get DetectorRule by identifier

Parameters:

detector_recipe_id (String) —

DetectorRecipe OCID
detector_rule_id (String) —

The key of Detector Rule.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

The client request ID for tracing.

Returns:

(Response) —

A Response object with data of type DetectorRecipeDetectorRule

# File 'lib/oci/cloud_guard/cloud_guard_client.rb', line 2011

def get_detector_recipe_detector_rule(detector_recipe_id, detector_rule_id, opts = {})
  logger.debug 'Calling operation CloudGuardClient#get_detector_recipe_detector_rule.' if logger

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

  path = '/detectorRecipes/{detectorRecipeId}/detectorRules/{detectorRuleId}'.sub('{detectorRecipeId}', detector_recipe_id.to_s).sub('{detectorRuleId}', detector_rule_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable 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: 'CloudGuardClient#get_detector_recipe_detector_rule') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::CloudGuard::Models::DetectorRecipeDetectorRule'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_detector_rule(detector_id, detector_rule_id, opts = {}) ⇒ `Response`

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/cloudguard/get_detector_rule.rb.html) to see an example of how to use get_detector_rule API.

Returns a Detector Rule identified by detectorRuleId

Parameters:

detector_id (String) —

The Name of Detector.
detector_rule_id (String) —

The key of Detector Rule.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

The client request ID for tracing.

Returns:

(Response) —

A Response object with data of type DetectorRule

# File 'lib/oci/cloud_guard/cloud_guard_client.rb', line 2069

def get_detector_rule(detector_id, detector_rule_id, opts = {})
  logger.debug 'Calling operation CloudGuardClient#get_detector_rule.' if logger

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

  path = '/detectors/{detectorId}/detectorRules/{detectorRuleId}'.sub('{detectorId}', detector_id.to_s).sub('{detectorRuleId}', detector_rule_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable 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: 'CloudGuardClient#get_detector_rule') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::CloudGuard::Models::DetectorRule'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_managed_list(managed_list_id, opts = {}) ⇒ `Response`

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/cloudguard/get_managed_list.rb.html) to see an example of how to use get_managed_list API.

Returns a managed list identified by managedListId

Parameters:

managed_list_id (String) —

The cloudguard list OCID to be passed in the 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) —

The client request ID for tracing.

Returns:

(Response) —

A Response object with data of type ManagedList

# File 'lib/oci/cloud_guard/cloud_guard_client.rb', line 2125

def get_managed_list(managed_list_id, opts = {})
  logger.debug 'Calling operation CloudGuardClient#get_managed_list.' if logger

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

  path = '/managedLists/{managedListId}'.sub('{managedListId}', managed_list_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable 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: 'CloudGuardClient#get_managed_list') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::CloudGuard::Models::ManagedList'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_problem(problem_id, opts = {}) ⇒ `Response`

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/cloudguard/get_problem.rb.html) to see an example of how to use get_problem API.

Returns a Problems response

Parameters:

problem_id (String) —

OCId of the problem.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

The client request ID for tracing.

Returns:

(Response) —

A Response object with data of type Problem

# File 'lib/oci/cloud_guard/cloud_guard_client.rb', line 2179

def get_problem(problem_id, opts = {})
  logger.debug 'Calling operation CloudGuardClient#get_problem.' if logger

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

  path = '/problems/{problemId}'.sub('{problemId}', problem_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable 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: 'CloudGuardClient#get_problem') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::CloudGuard::Models::Problem'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_resource_profile(resource_profile_id, opts = {}) ⇒ `Response`

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/cloudguard/get_resource_profile.rb.html) to see an example of how to use get_resource_profile API.

Returns resource profile details

Parameters:

resource_profile_id (String) —

OCID of the resource profile.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

The client request ID for tracing.

Returns:

(Response) —

A Response object with data of type ResourceProfile

# File 'lib/oci/cloud_guard/cloud_guard_client.rb', line 2233

def get_resource_profile(resource_profile_id, opts = {})
  logger.debug 'Calling operation CloudGuardClient#get_resource_profile.' if logger

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

  path = '/resourceProfiles/{resourceProfileId}'.sub('{resourceProfileId}', resource_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: 'CloudGuardClient#get_resource_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::CloudGuard::Models::ResourceProfile'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_responder_execution(responder_execution_id, opts = {}) ⇒ `Response`

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/cloudguard/get_responder_execution.rb.html) to see an example of how to use get_responder_execution API.

Returns a Responder Execution identified by responderExecutionId

Parameters:

responder_execution_id (String) —

The identifier of the responder execution.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

The client request ID for tracing.

Returns:

(Response) —

A Response object with data of type ResponderExecution

# File 'lib/oci/cloud_guard/cloud_guard_client.rb', line 2288

def get_responder_execution(responder_execution_id, opts = {})
  logger.debug 'Calling operation CloudGuardClient#get_responder_execution.' if logger

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

  path = '/responderExecutions/{responderExecutionId}'.sub('{responderExecutionId}', responder_execution_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable 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: 'CloudGuardClient#get_responder_execution') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::CloudGuard::Models::ResponderExecution'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_responder_recipe(responder_recipe_id, opts = {}) ⇒ `Response`

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/cloudguard/get_responder_recipe.rb.html) to see an example of how to use get_responder_recipe API.

Get a ResponderRecipe by identifier

Parameters:

responder_recipe_id (String) —

OCID of ResponderRecipe
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

The client request ID for tracing.

Returns:

(Response) —

A Response object with data of type ResponderRecipe

# File 'lib/oci/cloud_guard/cloud_guard_client.rb', line 2342

def get_responder_recipe(responder_recipe_id, opts = {})
  logger.debug 'Calling operation CloudGuardClient#get_responder_recipe.' if logger

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

  path = '/responderRecipes/{responderRecipeId}'.sub('{responderRecipeId}', responder_recipe_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable 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: 'CloudGuardClient#get_responder_recipe') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::CloudGuard::Models::ResponderRecipe'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_responder_recipe_responder_rule(responder_recipe_id, responder_rule_id, opts = {}) ⇒ `Response`

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/cloudguard/get_responder_recipe_responder_rule.rb.html) to see an example of how to use get_responder_recipe_responder_rule API.

Get ResponderRule by identifier

Parameters:

responder_recipe_id (String) —

OCID of ResponderRecipe
responder_rule_id (String) —

The id of ResponderRule
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

The client request ID for tracing.

Returns:

(Response) —

A Response object with data of type ResponderRecipeResponderRule

# File 'lib/oci/cloud_guard/cloud_guard_client.rb', line 2397

def get_responder_recipe_responder_rule(responder_recipe_id, responder_rule_id, opts = {})
  logger.debug 'Calling operation CloudGuardClient#get_responder_recipe_responder_rule.' if logger

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

  path = '/responderRecipes/{responderRecipeId}/responderRules/{responderRuleId}'.sub('{responderRecipeId}', responder_recipe_id.to_s).sub('{responderRuleId}', responder_rule_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable 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: 'CloudGuardClient#get_responder_recipe_responder_rule') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::CloudGuard::Models::ResponderRecipeResponderRule'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_responder_rule(responder_rule_id, opts = {}) ⇒ `Response`

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/cloudguard/get_responder_rule.rb.html) to see an example of how to use get_responder_rule API.

Get a ResponderRule by identifier

Parameters:

responder_rule_id (String) —

The id of ResponderRule
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

The client request ID for tracing.

Returns:

(Response) —

A Response object with data of type ResponderRule

# File 'lib/oci/cloud_guard/cloud_guard_client.rb', line 2453

def get_responder_rule(responder_rule_id, opts = {})
  logger.debug 'Calling operation CloudGuardClient#get_responder_rule.' if logger

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

  path = '/responderRules/{responderRuleId}'.sub('{responderRuleId}', responder_rule_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable 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: 'CloudGuardClient#get_responder_rule') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::CloudGuard::Models::ResponderRule'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

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

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/cloudguard/get_security_policy.rb.html) to see an example of how to use get_security_policy API.

Gets a security zone policy using its identifier. When a policy is enabled in a security zone, then any action in the zone that attempts to violate that policy is denied.

Parameters:

security_policy_id (String) —

The unique identifier of the security zone policy (`SecurityPolicy`)
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

The client request ID for tracing.

Returns:

(Response) —

A Response object with data of type SecurityPolicy

# File 'lib/oci/cloud_guard/cloud_guard_client.rb', line 2507

def get_security_policy(security_policy_id, opts = {})
  logger.debug 'Calling operation CloudGuardClient#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: 'CloudGuardClient#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::CloudGuard::Models::SecurityPolicy'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_security_recipe(security_recipe_id, opts = {}) ⇒ `Response`

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/cloudguard/get_security_recipe.rb.html) to see an example of how to use get_security_recipe API.

Gets a security zone recipe by identifier. A security zone recipe is a collection of security zone policies.

Parameters:

security_recipe_id (String) —

The unique identifier of the security zone recipe (`SecurityRecipe`)
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

The client request ID for tracing.

Returns:

(Response) —

A Response object with data of type SecurityRecipe

# File 'lib/oci/cloud_guard/cloud_guard_client.rb', line 2561

def get_security_recipe(security_recipe_id, opts = {})
  logger.debug 'Calling operation CloudGuardClient#get_security_recipe.' if logger

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

  path = '/securityRecipes/{securityRecipeId}'.sub('{securityRecipeId}', security_recipe_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable 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: 'CloudGuardClient#get_security_recipe') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::CloudGuard::Models::SecurityRecipe'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_security_zone(security_zone_id, opts = {}) ⇒ `Response`

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/cloudguard/get_security_zone.rb.html) to see an example of how to use get_security_zone API.

Gets a security zone by its identifier. A security zone is associated with a security zone recipe and enforces all security zone policies in the recipe. Any actions in the zone's compartments that violate a policy are denied.

Parameters:

security_zone_id (String) —

The unique identifier of the security zone (`SecurityZone`)
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

The client request ID for tracing.

Returns:

(Response) —

A Response object with data of type SecurityZone

# File 'lib/oci/cloud_guard/cloud_guard_client.rb', line 2615

def get_security_zone(security_zone_id, opts = {})
  logger.debug 'Calling operation CloudGuardClient#get_security_zone.' if logger

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

  path = '/securityZones/{securityZoneId}'.sub('{securityZoneId}', security_zone_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable 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: 'CloudGuardClient#get_security_zone') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::CloudGuard::Models::SecurityZone'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_sighting(sighting_id, opts = {}) ⇒ `Response`

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/cloudguard/get_sighting.rb.html) to see an example of how to use get_sighting API.

Returns Sighting details

Parameters:

sighting_id (String) —

OCID of the sighting.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

The client request ID for tracing.

Returns:

(Response) —

A Response object with data of type Sighting

# File 'lib/oci/cloud_guard/cloud_guard_client.rb', line 2669

def get_sighting(sighting_id, opts = {})
  logger.debug 'Calling operation CloudGuardClient#get_sighting.' if logger

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

  path = '/sightings/{sightingId}'.sub('{sightingId}', sighting_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable 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: 'CloudGuardClient#get_sighting') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::CloudGuard::Models::Sighting'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_target(target_id, opts = {}) ⇒ `Response`

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/cloudguard/get_target.rb.html) to see an example of how to use get_target API.

Returns a Target identified by targetId

Parameters:

target_id (String) —

OCID of target
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

The client request ID for tracing.

Returns:

(Response) —

A Response object with data of type Target

# File 'lib/oci/cloud_guard/cloud_guard_client.rb', line 2723

def get_target(target_id, opts = {})
  logger.debug 'Calling operation CloudGuardClient#get_target.' if logger

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

  path = '/targets/{targetId}'.sub('{targetId}', target_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable 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: 'CloudGuardClient#get_target') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::CloudGuard::Models::Target'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_target_detector_recipe(target_id, target_detector_recipe_id, opts = {}) ⇒ `Response`

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/cloudguard/get_target_detector_recipe.rb.html) to see an example of how to use get_target_detector_recipe API.

Get a TargetDetectorRecipe by identifier

Parameters:

target_id (String) —

OCID of target
target_detector_recipe_id (String) —

OCID of TargetDetectorRecipe
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

The client request ID for tracing.

Returns:

(Response) —

A Response object with data of type TargetDetectorRecipe

# File 'lib/oci/cloud_guard/cloud_guard_client.rb', line 2778

def get_target_detector_recipe(target_id, target_detector_recipe_id, opts = {})
  logger.debug 'Calling operation CloudGuardClient#get_target_detector_recipe.' if logger

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

  path = '/targets/{targetId}/targetDetectorRecipes/{targetDetectorRecipeId}'.sub('{targetId}', target_id.to_s).sub('{targetDetectorRecipeId}', target_detector_recipe_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable 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: 'CloudGuardClient#get_target_detector_recipe') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::CloudGuard::Models::TargetDetectorRecipe'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_target_detector_recipe_detector_rule(target_id, target_detector_recipe_id, detector_rule_id, opts = {}) ⇒ `Response`

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/cloudguard/get_target_detector_recipe_detector_rule.rb.html) to see an example of how to use get_target_detector_recipe_detector_rule API.

Get DetectorRule by identifier

Parameters:

target_id (String) —

OCID of target
target_detector_recipe_id (String) —

OCID of TargetDetectorRecipe
detector_rule_id (String) —

The id of DetectorRule
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

The client request ID for tracing.

Returns:

(Response) —

A Response object with data of type TargetDetectorRecipeDetectorRule

# File 'lib/oci/cloud_guard/cloud_guard_client.rb', line 2836

def get_target_detector_recipe_detector_rule(target_id, target_detector_recipe_id, detector_rule_id, opts = {})
  logger.debug 'Calling operation CloudGuardClient#get_target_detector_recipe_detector_rule.' if logger

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

  path = '/targets/{targetId}/targetDetectorRecipes/{targetDetectorRecipeId}/detectorRules/{detectorRuleId}'.sub('{targetId}', target_id.to_s).sub('{targetDetectorRecipeId}', target_detector_recipe_id.to_s).sub('{detectorRuleId}', detector_rule_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable 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: 'CloudGuardClient#get_target_detector_recipe_detector_rule') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::CloudGuard::Models::TargetDetectorRecipeDetectorRule'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_target_responder_recipe(target_id, target_responder_recipe_id, opts = {}) ⇒ `Response`

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/cloudguard/get_target_responder_recipe.rb.html) to see an example of how to use get_target_responder_recipe API.

Get a TargetResponderRecipe by identifier

Parameters:

target_id (String) —

OCID of target
target_responder_recipe_id (String) —

OCID of TargetResponderRecipe
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

The client request ID for tracing.

Returns:

(Response) —

A Response object with data of type TargetResponderRecipe

# File 'lib/oci/cloud_guard/cloud_guard_client.rb', line 2895

def get_target_responder_recipe(target_id, target_responder_recipe_id, opts = {})
  logger.debug 'Calling operation CloudGuardClient#get_target_responder_recipe.' if logger

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

  path = '/targets/{targetId}/targetResponderRecipes/{targetResponderRecipeId}'.sub('{targetId}', target_id.to_s).sub('{targetResponderRecipeId}', target_responder_recipe_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable 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: 'CloudGuardClient#get_target_responder_recipe') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::CloudGuard::Models::TargetResponderRecipe'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_target_responder_recipe_responder_rule(target_id, target_responder_recipe_id, responder_rule_id, opts = {}) ⇒ `Response`

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/cloudguard/get_target_responder_recipe_responder_rule.rb.html) to see an example of how to use get_target_responder_recipe_responder_rule API.

Get ResponderRule by identifier

Parameters:

target_id (String) —

OCID of target
target_responder_recipe_id (String) —

OCID of TargetResponderRecipe
responder_rule_id (String) —

The id of ResponderRule
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

The client request ID for tracing.

Returns:

(Response) —

A Response object with data of type TargetResponderRecipeResponderRule

# File 'lib/oci/cloud_guard/cloud_guard_client.rb', line 2953

def get_target_responder_recipe_responder_rule(target_id, target_responder_recipe_id, responder_rule_id, opts = {})
  logger.debug 'Calling operation CloudGuardClient#get_target_responder_recipe_responder_rule.' if logger

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

  path = '/targets/{targetId}/targetResponderRecipes/{targetResponderRecipeId}/responderRules/{responderRuleId}'.sub('{targetId}', target_id.to_s).sub('{targetResponderRecipeId}', target_responder_recipe_id.to_s).sub('{responderRuleId}', responder_rule_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable 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: 'CloudGuardClient#get_target_responder_recipe_responder_rule') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::CloudGuard::Models::TargetResponderRecipeResponderRule'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_condition_metadata_types(compartment_id, opts = {}) ⇒ `Response`

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/cloudguard/list_condition_metadata_types.rb.html) to see an example of how to use list_condition_metadata_types API.

Returns a list of condition types.

Allowed values are: timeCreated, displayName

Parameters:

compartment_id (String) —

The ID of the compartment in which to list resources.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

The field life cycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active. (default to ACTIVE)
:limit (Integer) —

The maximum number of items to return. (default to 10)
:page (String) —

The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
:sort_order (String) —

The sort order to use, either 'asc' or 'desc'. (default to ASC)
:sort_by (String) —

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

The client request ID for tracing.

Returns:

(Response) —

A Response object with data of type ConditionMetadataTypeCollection

# File 'lib/oci/cloud_guard/cloud_guard_client.rb', line 3019

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

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

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

  if opts[:sort_order] && !OCI::CloudGuard::Models::SORT_ORDERS_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::CloudGuard::Models::SORT_ORDERS_ENUM.'
  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 = '/conditionMetadataTypes'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[: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: 'CloudGuardClient#list_condition_metadata_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::CloudGuard::Models::ConditionMetadataTypeCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_data_mask_rules(compartment_id, opts = {}) ⇒ `Response`

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/cloudguard/list_data_mask_rules.rb.html) to see an example of how to use list_data_mask_rules API.

Returns a list of all Data Mask Rules in the root 'compartmentId' passed.

Allowed values are: timeCreated, displayName

Parameters:

compartment_id (String) —

The ID of the compartment in which to list resources.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

The retry configuration to apply to this operation. If no key is provided then the 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 entire display name given.
:lifecycle_state (String) —

The field life cycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active. (default to ACTIVE)
: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) —

The maximum number of items to return. (default to 10)
:page (String) —

The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
:sort_order (String) —

The sort order to use, either 'asc' or 'desc'. (default to ASC)
:sort_by (String) —

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

The client request ID for tracing.
:data_mask_rule_status (String) —

The status of the dataMaskRule. (default to ENABLED)
:target_id (String) —

OCID of target (default to null)
:iam_group_id (String) —

OCID of iamGroup (default to null)
:target_type (String) —

Type of target (default to null)

Returns:

(Response) —

A Response object with data of type DataMaskRuleCollection

# File 'lib/oci/cloud_guard/cloud_guard_client.rb', line 3110

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

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

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

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

  if opts[:sort_order] && !OCI::CloudGuard::Models::SORT_ORDERS_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::CloudGuard::Models::SORT_ORDERS_ENUM.'
  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[:data_mask_rule_status] && !OCI::CloudGuard::Models::DATA_MASK_RULE_STATUS_ENUM.include?(opts[:data_mask_rule_status])
    raise 'Invalid value for "data_mask_rule_status", must be one of the values in OCI::CloudGuard::Models::DATA_MASK_RULE_STATUS_ENUM.'
  end

  path = '/dataMaskRules'
  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[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  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[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:dataMaskRuleStatus] = opts[:data_mask_rule_status] if opts[:data_mask_rule_status]
  query_params[:targetId] = opts[:target_id] if opts[:target_id]
  query_params[:iamGroupId] = opts[:iam_group_id] if opts[:iam_group_id]
  query_params[:targetType] = opts[:target_type] if opts[:target_type]

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

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'CloudGuardClient#list_data_mask_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::CloudGuard::Models::DataMaskRuleCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_detector_recipe_detector_rules(detector_recipe_id, compartment_id, opts = {}) ⇒ `Response`

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/cloudguard/list_detector_recipe_detector_rules.rb.html) to see an example of how to use list_detector_recipe_detector_rules API.

Returns a list of DetectorRule associated with DetectorRecipe.

Allowed values are: displayName, riskLevel

Parameters:

detector_recipe_id (String) —

DetectorRecipe OCID
compartment_id (String) —

The ID of the compartment in which to list resources.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

The retry configuration to apply to this operation. If no key is provided then the 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 entire display name given.
:lifecycle_state (String) —

The field life cycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active. (default to ACTIVE)
:limit (Integer) —

The maximum number of items to return. (default to 10)
:page (String) —

The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
:sort_order (String) —

The sort order to use, either 'asc' or 'desc'. (default to ASC)
:sort_by (String) —

The field to sort by. Only one sort order may be provided. Default order for displayName is ascending. If no value is specified displayName is default. (default to displayName)
:opc_request_id (String) —

The client request ID for tracing.

Returns:

(Response) —

A Response object with data of type DetectorRecipeDetectorRuleCollection

# File 'lib/oci/cloud_guard/cloud_guard_client.rb', line 3205

def list_detector_recipe_detector_rules(detector_recipe_id, compartment_id, opts = {})
  logger.debug 'Calling operation CloudGuardClient#list_detector_recipe_detector_rules.' if logger

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

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

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

  if opts[:sort_by] && !%w[displayName riskLevel].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of displayName, riskLevel.'
  end
  raise "Parameter value for 'detector_recipe_id' must not be blank" if OCI::Internal::Util.blank_string?(detector_recipe_id)

  path = '/detectorRecipes/{detectorRecipeId}/detectorRules'.sub('{detectorRecipeId}', detector_recipe_id.to_s)
  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[: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]

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

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'CloudGuardClient#list_detector_recipe_detector_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::CloudGuard::Models::DetectorRecipeDetectorRuleCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_detector_recipes(compartment_id, opts = {}) ⇒ `Response`

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/cloudguard/list_detector_recipes.rb.html) to see an example of how to use list_detector_recipes API.

Returns a list of all Detector Recipes in a compartment

The ListDetectorRecipes operation returns only the detector recipes in `compartmentId` passed. 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 ListDetectorRecipes 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) —

The ID of the compartment in which to list resources.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

The retry configuration to apply to this operation. If no key is provided then the 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 entire display name given.
:resource_metadata_only (BOOLEAN) —
Default is false. When set to true, the list of all Oracle Managed Resources Metadata supported by Cloud Guard are returned.
```
(default to false)
```
:lifecycle_state (String) —

The field life cycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active. (default to ACTIVE)
:limit (Integer) —

The maximum number of items to return. (default to 10)
:page (String) —

The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
: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 depending on the the setting of `accessLevel`.
```
(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 'asc' or 'desc'. (default to ASC)
:sort_by (String) —

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

The client request ID for tracing.

Returns:

(Response) —

A Response object with data of type DetectorRecipeCollection

# File 'lib/oci/cloud_guard/cloud_guard_client.rb', line 3318

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

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

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

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

  if opts[:sort_order] && !OCI::CloudGuard::Models::SORT_ORDERS_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::CloudGuard::Models::SORT_ORDERS_ENUM.'
  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 = '/detectorRecipes'
  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[:resourceMetadataOnly] = opts[:resource_metadata_only] if !opts[:resource_metadata_only].nil?
  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[: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: 'CloudGuardClient#list_detector_recipes') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::CloudGuard::Models::DetectorRecipeCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_detector_rules(detector_id, compartment_id, opts = {}) ⇒ `Response`

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/cloudguard/list_detector_rules.rb.html) to see an example of how to use list_detector_rules API.

Returns a list of detector rules for the detectorId passed.

Allowed values are: timeCreated, displayName

Parameters:

detector_id (String) —

The Name of Detector.
compartment_id (String) —

The ID of the compartment in which to list resources.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

The retry configuration to apply to this operation. If no key is provided then the 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 entire display name given.
:limit (Integer) —

The maximum number of items to return. (default to 10)
:lifecycle_state (String) —

The field life cycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active. (default to ACTIVE)
:page (String) —

The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
:sort_order (String) —

The sort order to use, either 'asc' or 'desc'. (default to ASC)
:sort_by (String) —

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

The client request ID for tracing.

Returns:

(Response) —

A Response object with data of type DetectorRuleCollection

# File 'lib/oci/cloud_guard/cloud_guard_client.rb', line 3407

def list_detector_rules(detector_id, compartment_id, opts = {})
  logger.debug 'Calling operation CloudGuardClient#list_detector_rules.' if logger

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

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

  if opts[:sort_order] && !OCI::CloudGuard::Models::SORT_ORDERS_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::CloudGuard::Models::SORT_ORDERS_ENUM.'
  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
  raise "Parameter value for 'detector_id' must not be blank" if OCI::Internal::Util.blank_string?(detector_id)

  path = '/detectors/{detectorId}/detectorRules'.sub('{detectorId}', detector_id.to_s)
  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[:limit] = opts[:limit] if opts[:limit]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  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: 'CloudGuardClient#list_detector_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::CloudGuard::Models::DetectorRuleCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_detectors(compartment_id, opts = {}) ⇒ `Response`

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/cloudguard/list_detectors.rb.html) to see an example of how to use list_detectors API.

Returns detector catalog - list of detectors supported by Cloud Guard

Allowed values are: timeCreated, displayName

Parameters:

compartment_id (String) —

The ID of the compartment in which to list resources.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

The maximum number of items to return. (default to 10)
:lifecycle_state (String) —

The field life cycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active. (default to ACTIVE)
:page (String) —

The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
:sort_order (String) —

The sort order to use, either 'asc' or 'desc'. (default to ASC)
:sort_by (String) —

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

The client request ID for tracing.

Returns:

(Response) —

A Response object with data of type DetectorCollection

# File 'lib/oci/cloud_guard/cloud_guard_client.rb', line 3489

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

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

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

  if opts[:sort_order] && !OCI::CloudGuard::Models::SORT_ORDERS_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::CloudGuard::Models::SORT_ORDERS_ENUM.'
  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 = '/detectors'
  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[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  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: 'CloudGuardClient#list_detectors') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::CloudGuard::Models::DetectorCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_impacted_resources(problem_id, opts = {}) ⇒ `Response`

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/cloudguard/list_impacted_resources.rb.html) to see an example of how to use list_impacted_resources API.

Returns a list of Impacted Resources for a CloudGuard Problem

Allowed values are: timeCreated

Parameters:

problem_id (String) —

OCId of the problem.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

The maximum number of items to return. (default to 10)
:page (String) —

The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
:sort_order (String) —

The sort order to use, either 'asc' or 'desc'. (default to ASC)
: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)
:opc_request_id (String) —

The client request ID for tracing.

Returns:

(Response) —

A Response object with data of type ImpactedResourceCollection

# File 'lib/oci/cloud_guard/cloud_guard_client.rb', line 3567

def list_impacted_resources(problem_id, opts = {})
  logger.debug 'Calling operation CloudGuardClient#list_impacted_resources.' if logger

  raise "Missing the required parameter 'problem_id' when calling list_impacted_resources." if problem_id.nil?

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

  if opts[:sort_by] && !%w[timeCreated].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of timeCreated.'
  end
  raise "Parameter value for 'problem_id' must not be blank" if OCI::Internal::Util.blank_string?(problem_id)

  path = '/problems/{problemId}/impactedResources'.sub('{problemId}', problem_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]

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

  post_body = nil

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

#list_managed_list_types(compartment_id, opts = {}) ⇒ `Response`

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/cloudguard/list_managed_list_types.rb.html) to see an example of how to use list_managed_list_types API.

Returns all ManagedList types supported by Cloud Guard

Allowed values are: displayName, riskLevel

Parameters:

compartment_id (String) —

The ID of the compartment in which to list resources.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

The field life cycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active. (default to ACTIVE)
:limit (Integer) —

The maximum number of items to return. (default to 10)
:page (String) —

The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
:sort_order (String) —

The sort order to use, either 'asc' or 'desc'. (default to ASC)
:sort_by (String) —

The field to sort by. Only one sort order may be provided. Default order for displayName is ascending. If no value is specified displayName is default. (default to displayName)
:opc_request_id (String) —

The client request ID for tracing.

Returns:

(Response) —

A Response object with data of type ManagedListTypeCollection

# File 'lib/oci/cloud_guard/cloud_guard_client.rb', line 3640

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

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

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

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

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

  path = '/managedListTypes'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[: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: 'CloudGuardClient#list_managed_list_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::CloudGuard::Models::ManagedListTypeCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_managed_lists(compartment_id, opts = {}) ⇒ `Response`

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/cloudguard/list_managed_lists.rb.html) to see an example of how to use list_managed_lists API.

Returns a list of ListManagedLists. The ListManagedLists operation returns only the managed lists in `compartmentId` passed. The list does not include any subcompartments of the compartmentId passed.

The parameter `accessLevel` specifies whether to return ManagedLists in 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 ListManagedLists 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) —

The ID of the compartment in which to list resources.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

The retry configuration to apply to this operation. If no key is provided then the 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 entire display name given.
:resource_metadata_only (BOOLEAN) —
Default is false. When set to true, the list of all Oracle Managed Resources Metadata supported by Cloud Guard are returned.
```
(default to false)
```
:lifecycle_state (String) —

The field life cycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active. (default to ACTIVE)
:list_type (String) —

The type of the ManagedList.
:limit (Integer) —

The maximum number of items to return. (default to 10)
:page (String) —

The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
: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 depending on the the setting of `accessLevel`.
```
(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 'asc' or 'desc'. (default to ASC)
:sort_by (String) —

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

The client request ID for tracing.

Returns:

(Response) —

A Response object with data of type ManagedListCollection

# File 'lib/oci/cloud_guard/cloud_guard_client.rb', line 3750

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

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

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

  if opts[:list_type] && !OCI::CloudGuard::Models::MANAGED_LIST_TYPE_ENUM.include?(opts[:list_type])
    raise 'Invalid value for "list_type", must be one of the values in OCI::CloudGuard::Models::MANAGED_LIST_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] && !OCI::CloudGuard::Models::SORT_ORDERS_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::CloudGuard::Models::SORT_ORDERS_ENUM.'
  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 = '/managedLists'
  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[:resourceMetadataOnly] = opts[:resource_metadata_only] if !opts[:resource_metadata_only].nil?
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:listType] = opts[:list_type] if opts[:list_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: 'CloudGuardClient#list_managed_lists') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::CloudGuard::Models::ManagedListCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_policies(compartment_id, opts = {}) ⇒ `Response`

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/cloudguard/list_policies.rb.html) to see an example of how to use list_policies API.

Returns the list of global policy statements needed by Cloud Guard when enabling

Allowed values are: timeCreated, displayName

Parameters:

compartment_id (String) —

The ID of the compartment in which to list resources.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

The client request ID for tracing.
:limit (Integer) —

The maximum number of items to return. (default to 10)
:page (String) —

The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
:sort_order (String) —

The sort order to use, either 'asc' or 'desc'. (default to ASC)
:sort_by (String) —

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

Returns:

(Response) —

A Response object with data of type PolicyCollection

# File 'lib/oci/cloud_guard/cloud_guard_client.rb', line 3841

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

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

  if opts[:sort_order] && !OCI::CloudGuard::Models::SORT_ORDERS_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::CloudGuard::Models::SORT_ORDERS_ENUM.'
  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 = '/policies'
  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[: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: 'CloudGuardClient#list_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::CloudGuard::Models::PolicyCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_problem_endpoints(problem_id, opts = {}) ⇒ `Response`

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/cloudguard/list_problem_endpoints.rb.html) to see an example of how to use list_problem_endpoints API.

Returns a list of endpoints associated with a cloud guard problem

Allowed values are: timeCreated

Parameters:

problem_id (String) —

OCId of the problem.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

The maximum number of items to return. (default to 10)
:page (String) —

The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
:sort_order (String) —

The sort order to use, either 'asc' or 'desc'. (default to ASC)
: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)
:opc_request_id (String) —

The client request ID for tracing.

Returns:

(Response) —

A Response object with data of type ProblemEndpointCollection

# File 'lib/oci/cloud_guard/cloud_guard_client.rb', line 3914

def list_problem_endpoints(problem_id, opts = {})
  logger.debug 'Calling operation CloudGuardClient#list_problem_endpoints.' if logger

  raise "Missing the required parameter 'problem_id' when calling list_problem_endpoints." if problem_id.nil?

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

  if opts[:sort_by] && !%w[timeCreated].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of timeCreated.'
  end
  raise "Parameter value for 'problem_id' must not be blank" if OCI::Internal::Util.blank_string?(problem_id)

  path = '/problems/{problemId}/endpoints'.sub('{problemId}', problem_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]

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

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'CloudGuardClient#list_problem_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: 'OCI::CloudGuard::Models::ProblemEndpointCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_problem_histories(compartment_id, problem_id, opts = {}) ⇒ `Response`

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/cloudguard/list_problem_histories.rb.html) to see an example of how to use list_problem_histories API.

Returns a list of Actions done on CloudGuard Problem

Allowed values are: timeCreated

Parameters:

compartment_id (String) —

The ID of the compartment in which to list resources.
problem_id (String) —

OCId of the problem.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

The maximum number of items to return. (default to 10)
:page (String) —

The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
:sort_order (String) —

The sort order to use, either 'asc' or 'desc'. (default to ASC)
: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)
:opc_request_id (String) —

The client request ID for tracing.

Returns:

(Response) —

A Response object with data of type ProblemHistoryCollection

# File 'lib/oci/cloud_guard/cloud_guard_client.rb', line 3988

def list_problem_histories(compartment_id, problem_id, opts = {})
  logger.debug 'Calling operation CloudGuardClient#list_problem_histories.' if logger

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

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

  if opts[:sort_by] && !%w[timeCreated].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of timeCreated.'
  end
  raise "Parameter value for 'problem_id' must not be blank" if OCI::Internal::Util.blank_string?(problem_id)

  path = '/problems/{problemId}/histories'.sub('{problemId}', problem_id.to_s)
  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[: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: 'CloudGuardClient#list_problem_histories') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::CloudGuard::Models::ProblemHistoryCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_problems(compartment_id, opts = {}) ⇒ `Response`

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/cloudguard/list_problems.rb.html) to see an example of how to use list_problems API.

Returns a list of all Problems identified by the Cloud Guard

The ListProblems operation returns only the problems in `compartmentId` passed. 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 ListProblems 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: riskLevel, timeLastDetected, resourceName

Parameters:

compartment_id (String) —

The ID of the compartment in which to list resources.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

Start time for a filter. If start time is not specified, start time will be set to current time - 30 days.
:time_last_detected_less_than_or_equal_to (DateTime) —

End time for a filter. If end time is not specified, end time will be set to current time.
:time_first_detected_greater_than_or_equal_to (DateTime) —

Start time for a filter. If start time is not specified, start time will be set to current time - 30 days.
:time_first_detected_less_than_or_equal_to (DateTime) —

End time for a filter. If end time is not specified, end time will be set to current time.
:lifecycle_detail (String) —

The field life cycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active. (default to OPEN)
:lifecycle_state (String) —

The field life cycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active. (default to ACTIVE)
:region (String) —

OCI Monitoring region.
:risk_level (String) —

Risk level of the Problem.
:resource_type (String) —

Resource Type associated with the resource.
:city (String) —

City of the problem.
:state (String) —

State of the problem.
:country (String) —

Country of the problem.
:label (String) —

Label associated with the Problem.
:detector_rule_id_list (Array<String>) —

Comma seperated list of detector rule ids to be passed in to match against Problems. (default to [])
:detector_type (String) —

The field to list the Problems by Detector Type. Valid values are IAAS_ACTIVITY_DETECTOR and IAAS_CONFIGURATION_DETECTOR
:target_id (String) —

The ID of the target in which to list resources.
:problem_category (String) —

Setting this to `SECURITY_ZONE` returns only security-zone related violations.
: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 depending on the the setting of `accessLevel`.
```
(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
:resource_id (String) —

The ID of the resource associated with the problem.
:limit (Integer) —

The maximum number of items to return. (default to 10)
:page (String) —

The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
:sort_order (String) —

The sort order to use, either 'asc' or 'desc'. (default to ASC)
:sort_by (String) —

The field to sort by. Only one sort order may be provided. Default order for riskLevel, timeLastDetected and resourceName is descending. Default order for riskLevel and resourceName is ascending. If no value is specified timeLastDetected is default. (default to timeLastDetected)
:opc_request_id (String) —

The client request ID for tracing.

Returns:

(Response) —

A Response object with data of type ProblemCollection

# File 'lib/oci/cloud_guard/cloud_guard_client.rb', line 4109

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

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

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

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

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

  if opts[:problem_category] && !OCI::CloudGuard::Models::PROBLEM_CATEGORY_ENUM_ENUM.include?(opts[:problem_category])
    raise 'Invalid value for "problem_category", must be one of the values in OCI::CloudGuard::Models::PROBLEM_CATEGORY_ENUM_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] && !OCI::CloudGuard::Models::SORT_ORDERS_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::CloudGuard::Models::SORT_ORDERS_ENUM.'
  end

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

  path = '/problems'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:timeLastDetectedGreaterThanOrEqualTo] = opts[:time_last_detected_greater_than_or_equal_to] if opts[:time_last_detected_greater_than_or_equal_to]
  query_params[:timeLastDetectedLessThanOrEqualTo] = opts[:time_last_detected_less_than_or_equal_to] if opts[:time_last_detected_less_than_or_equal_to]
  query_params[:timeFirstDetectedGreaterThanOrEqualTo] = opts[:time_first_detected_greater_than_or_equal_to] if opts[:time_first_detected_greater_than_or_equal_to]
  query_params[:timeFirstDetectedLessThanOrEqualTo] = opts[:time_first_detected_less_than_or_equal_to] if opts[:time_first_detected_less_than_or_equal_to]
  query_params[:lifecycleDetail] = opts[:lifecycle_detail] if opts[:lifecycle_detail]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:region] = opts[:region] if opts[:region]
  query_params[:riskLevel] = opts[:risk_level] if opts[:risk_level]
  query_params[:resourceType] = opts[:resource_type] if opts[:resource_type]
  query_params[:city] = opts[:city] if opts[:city]
  query_params[:state] = opts[:state] if opts[:state]
  query_params[:country] = opts[:country] if opts[:country]
  query_params[:label] = opts[:label] if opts[:label]
  query_params[:detectorRuleIdList] = OCI::ApiClient.build_collection_params(opts[:detector_rule_id_list], :multi) if opts[:detector_rule_id_list] && !opts[:detector_rule_id_list].empty?
  query_params[:detectorType] = opts[:detector_type] if opts[:detector_type]
  query_params[:targetId] = opts[:target_id] if opts[:target_id]
  query_params[:problemCategory] = opts[:problem_category] if opts[:problem_category]
  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[:resourceId] = opts[:resource_id] if opts[:resource_id]
  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: 'CloudGuardClient#list_problems') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::CloudGuard::Models::ProblemCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_recommendations(compartment_id, opts = {}) ⇒ `Response`

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/cloudguard/list_recommendations.rb.html) to see an example of how to use list_recommendations API.

Returns a list of all Recommendations.

Allowed values are: riskLevel, timeCreated

Parameters:

compartment_id (String) —

The ID of the compartment in which to list resources.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

The sort order to use, either 'asc' or 'desc'. (default to ASC)
:sort_by (String) —

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

The ID of the target in which to list resources.
: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 depending on the the setting of `accessLevel`.
```
(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
:lifecycle_state (String) —

The field life cycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active. (default to ACTIVE)
:lifecycle_detail (String) —

The field life cycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active. (default to OPEN)
:limit (Integer) —

The maximum number of items to return. (default to 10)
:page (String) —

The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
:opc_request_id (String) —

The client request ID for tracing.

Returns:

(Response) —

A Response object with data of type RecommendationSummaryCollection

# File 'lib/oci/cloud_guard/cloud_guard_client.rb', line 4237

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

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

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

  if opts[:sort_by] && !%w[riskLevel timeCreated].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of riskLevel, 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

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

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

  path = '/recommendations'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:targetId] = opts[:target_id] if opts[:target_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[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:lifecycleDetail] = opts[:lifecycle_detail] if opts[:lifecycle_detail]
  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: 'CloudGuardClient#list_recommendations') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::CloudGuard::Models::RecommendationSummaryCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_resource_profile_endpoints(resource_profile_id, opts = {}) ⇒ `Response`

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/cloudguard/list_resource_profile_endpoints.rb.html) to see an example of how to use list_resource_profile_endpoints API.

Returns a list of endpoints for Cloud Guard resource profile

Allowed values are: timeCreated

Parameters:

resource_profile_id (String) —

OCID of the resource profile.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

The maximum number of items to return. (default to 10)
:page (String) —

The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
:sort_order (String) —

The sort order to use, either 'asc' or 'desc'. (default to ASC)
: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)
:opc_request_id (String) —

The client request ID for tracing.

Returns:

(Response) —

A Response object with data of type ResourceProfileEndpointCollection

# File 'lib/oci/cloud_guard/cloud_guard_client.rb', line 4326

def list_resource_profile_endpoints(resource_profile_id, opts = {})
  logger.debug 'Calling operation CloudGuardClient#list_resource_profile_endpoints.' if logger

  raise "Missing the required parameter 'resource_profile_id' when calling list_resource_profile_endpoints." if resource_profile_id.nil?

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

  if opts[:sort_by] && !%w[timeCreated].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of timeCreated.'
  end
  raise "Parameter value for 'resource_profile_id' must not be blank" if OCI::Internal::Util.blank_string?(resource_profile_id)

  path = '/resourceProfiles/{resourceProfileId}/endpoints'.sub('{resourceProfileId}', resource_profile_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[: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: 'CloudGuardClient#list_resource_profile_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: 'OCI::CloudGuard::Models::ResourceProfileEndpointCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_resource_profile_impacted_resources(resource_profile_id, opts = {}) ⇒ `Response`

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/cloudguard/list_resource_profile_impacted_resources.rb.html) to see an example of how to use list_resource_profile_impacted_resources API.

Returns a list of impacted resources for Cloud Guard resource profile

Allowed values are: timeCreated

Parameters:

resource_profile_id (String) —

OCID of the resource profile.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

The maximum number of items to return. (default to 10)
:page (String) —

The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
:sort_order (String) —

The sort order to use, either 'asc' or 'desc'. (default to ASC)
: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)
:opc_request_id (String) —

The client request ID for tracing.

Returns:

(Response) —

A Response object with data of type ResourceProfileImpactedResourceCollection

# File 'lib/oci/cloud_guard/cloud_guard_client.rb', line 4398

def list_resource_profile_impacted_resources(resource_profile_id, opts = {})
  logger.debug 'Calling operation CloudGuardClient#list_resource_profile_impacted_resources.' if logger

  raise "Missing the required parameter 'resource_profile_id' when calling list_resource_profile_impacted_resources." if resource_profile_id.nil?

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

  if opts[:sort_by] && !%w[timeCreated].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of timeCreated.'
  end
  raise "Parameter value for 'resource_profile_id' must not be blank" if OCI::Internal::Util.blank_string?(resource_profile_id)

  path = '/resourceProfiles/{resourceProfileId}/impactedResources'.sub('{resourceProfileId}', resource_profile_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[: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: 'CloudGuardClient#list_resource_profile_impacted_resources') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::CloudGuard::Models::ResourceProfileImpactedResourceCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_resource_profiles(compartment_id, opts = {}) ⇒ `Response`

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/cloudguard/list_resource_profiles.rb.html) to see an example of how to use list_resource_profiles API.

Returns a list of all resource profiles identified by the Cloud Guard The ListResourceProfiles operation returns only resource profiles that match the passed filters.

The ListResourceProfiles operation returns only the resource profiles in `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 ListResourceProfiles 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: riskScore, riskScoreGrowth, timeFirstDetected, timeLastDetected, sightingsCount, displayName, type

Parameters:

compartment_id (String) —

The ID of the compartment in which to list resources.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

Start time for a filter. If start time is not specified, start time will be set to current time - 30 days.
:time_last_detected_less_than_or_equal_to (DateTime) —

End time for a filter. If end time is not specified, end time will be set to current time.
:time_first_detected_greater_than_or_equal_to (DateTime) —

Start time for a filter. If start time is not specified, start time will be set to current time - 30 days.
:time_first_detected_less_than_or_equal_to (DateTime) —

End time for a filter. If end time is not specified, end time will be set to current time.
: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 depending on the the setting of `accessLevel`.
```
(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
:resource_types (Array<String>) —

A filter to return only resources that match the list of resource types given (default to [])
:risk_score_greater_than_or_equal_to (Float) —

risk score filter
:risk_score_less_than_or_equal_to (Float) —

risk score filter
:techniques (Array<String>) —

A filter to return only resources that match the list of techniques given (default to [])
:tactics (Array<String>) —

A filter to return only resources that match the list of tactics given. (default to [])
:limit (Integer) —

The maximum number of items to return. (default to 10)
:page (String) —

The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
:sort_order (String) —

The sort order to use, either 'asc' or 'desc'. (default to ASC)
:sort_by (String) —

The field to sort resource profiles. Only one sort order may be provided. Default order for timeLastDetected is descending. If no value is specified timeLastDetected is default. (default to timeLastDetected)
:opc_request_id (String) —

The client request ID for tracing.

Returns:

(Response) —

A Response object with data of type ResourceProfileCollection

# File 'lib/oci/cloud_guard/cloud_guard_client.rb', line 4505

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

  raise "Missing the required parameter 'compartment_id' when calling list_resource_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[:sort_order] && !OCI::CloudGuard::Models::SORT_ORDERS_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::CloudGuard::Models::SORT_ORDERS_ENUM.'
  end

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

  path = '/resourceProfiles'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:timeLastDetectedGreaterThanOrEqualTo] = opts[:time_last_detected_greater_than_or_equal_to] if opts[:time_last_detected_greater_than_or_equal_to]
  query_params[:timeLastDetectedLessThanOrEqualTo] = opts[:time_last_detected_less_than_or_equal_to] if opts[:time_last_detected_less_than_or_equal_to]
  query_params[:timeFirstDetectedGreaterThanOrEqualTo] = opts[:time_first_detected_greater_than_or_equal_to] if opts[:time_first_detected_greater_than_or_equal_to]
  query_params[:timeFirstDetectedLessThanOrEqualTo] = opts[:time_first_detected_less_than_or_equal_to] if opts[:time_first_detected_less_than_or_equal_to]
  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[:resourceTypes] = OCI::ApiClient.build_collection_params(opts[:resource_types], :multi) if opts[:resource_types] && !opts[:resource_types].empty?
  query_params[:riskScoreGreaterThanOrEqualTo] = opts[:risk_score_greater_than_or_equal_to] if opts[:risk_score_greater_than_or_equal_to]
  query_params[:riskScoreLessThanOrEqualTo] = opts[:risk_score_less_than_or_equal_to] if opts[:risk_score_less_than_or_equal_to]
  query_params[:techniques] = OCI::ApiClient.build_collection_params(opts[:techniques], :multi) if opts[:techniques] && !opts[:techniques].empty?
  query_params[:tactics] = OCI::ApiClient.build_collection_params(opts[:tactics], :multi) if opts[:tactics] && !opts[:tactics].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: 'CloudGuardClient#list_resource_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::CloudGuard::Models::ResourceProfileCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_resource_types(compartment_id, opts = {}) ⇒ `Response`

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/cloudguard/list_resource_types.rb.html) to see an example of how to use list_resource_types API.

Returns a list of resource types.

Allowed values are: displayName, riskLevel

Parameters:

compartment_id (String) —

The ID of the compartment in which to list resources.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

Detector type
:lifecycle_state (String) —

The field life cycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active. (default to ACTIVE)
:limit (Integer) —

The maximum number of items to return. (default to 10)
:page (String) —

The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
:sort_order (String) —

The sort order to use, either 'asc' or 'desc'. (default to ASC)
:sort_by (String) —

The field to sort by. Only one sort order may be provided. Default order for displayName is ascending. If no value is specified displayName is default. (default to displayName)
:opc_request_id (String) —

The client request ID for tracing.

Returns:

(Response) —

A Response object with data of type ResourceTypeCollection

# File 'lib/oci/cloud_guard/cloud_guard_client.rb', line 4595

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

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

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

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

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

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

  path = '/resourceTypes'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:detectorId] = opts[:detector_id] if opts[:detector_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]

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

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'CloudGuardClient#list_resource_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::CloudGuard::Models::ResourceTypeCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_responder_activities(problem_id, opts = {}) ⇒ `Response`

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/cloudguard/list_responder_activities.rb.html) to see an example of how to use list_responder_activities API.

Returns a list of Responder activities done on CloudGuard Problem

Allowed values are: timeCreated, responderRuleName

Parameters:

problem_id (String) —

OCId of the problem.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

The maximum number of items to return. (default to 10)
:page (String) —

The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
:sort_order (String) —

The sort order to use, either 'asc' or 'desc'. (default to ASC)
:sort_by (String) —

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

The client request ID for tracing.

Returns:

(Response) —

A Response object with data of type ResponderActivityCollection

# File 'lib/oci/cloud_guard/cloud_guard_client.rb', line 4678

def list_responder_activities(problem_id, opts = {})
  logger.debug 'Calling operation CloudGuardClient#list_responder_activities.' if logger

  raise "Missing the required parameter 'problem_id' when calling list_responder_activities." if problem_id.nil?

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

  if opts[:sort_by] && !%w[timeCreated responderRuleName].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of timeCreated, responderRuleName.'
  end
  raise "Parameter value for 'problem_id' must not be blank" if OCI::Internal::Util.blank_string?(problem_id)

  path = '/problems/{problemId}/responderActivities'.sub('{problemId}', problem_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]

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

  post_body = nil

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

#list_responder_executions(compartment_id, opts = {}) ⇒ `Response`

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/cloudguard/list_responder_executions.rb.html) to see an example of how to use list_responder_executions API.

Returns a list of Responder Executions. A Responder Execution is an entity that tracks the collective execution of multiple Responder Rule Executions for a given Problem.

Allowed values are: timeCreated, responderRuleName, resourceName, timeCompleted

Parameters:

compartment_id (String) —

The ID of the compartment in which to list resources.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

The retry configuration to apply to this operation. If no key is provided then the 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 depending on the the setting of `accessLevel`.
```
(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
:responder_rule_ids (Array<String>) —

Responder Rule Ids filter for the Responder Executions. (default to [])
:time_created_greater_than_or_equal_to (DateTime) —

Creation Start time for filtering
:time_created_less_than_or_equal_to (DateTime) —

Creation End time for filtering
:time_completed_greater_than_or_equal_to (DateTime) —

Completion End Time
:time_completed_less_than_or_equal_to (DateTime) —

Completion Start Time
:target_id (String) —

The ID of the target in which to list resources.
:resource_type (String) —

Resource Type associated with the resource.
:responder_type (String) —

The field to list the Responder Executions by Responder Type. Valid values are REMEDIATION and NOTIFICATION

Allowed values are: REMEDIATION, NOTIFICATION
:responder_execution_status (String) —

The status of the responder execution in which to list responders. (default to ALL)
:responder_execution_mode (String) —

The mode of the responder execution in which to list responders. (default to ALL)
:limit (Integer) —

The maximum number of items to return. (default to 10)
:page (String) —

The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
:sort_order (String) —

The sort order to use, either 'asc' or 'desc'. (default to ASC)
:sort_by (String) —

The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for responderRuleName and resourceName is ascending. If no value is specified timeCreated is default. (default to timeCreated)
:opc_request_id (String) —

The client request ID for tracing.

Returns:

(Response) —

A Response object with data of type ResponderExecutionCollection

# File 'lib/oci/cloud_guard/cloud_guard_client.rb', line 4775

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

  raise "Missing the required parameter 'compartment_id' when calling list_responder_executions." 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[:responder_type] && !%w[REMEDIATION NOTIFICATION].include?(opts[:responder_type])
    raise 'Invalid value for "responder_type", must be one of REMEDIATION, NOTIFICATION.'
  end

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

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

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

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

  path = '/responderExecutions'
  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[:responderRuleIds] = OCI::ApiClient.build_collection_params(opts[:responder_rule_ids], :multi) if opts[:responder_rule_ids] && !opts[:responder_rule_ids].empty?
  query_params[:timeCreatedGreaterThanOrEqualTo] = opts[:time_created_greater_than_or_equal_to] if opts[:time_created_greater_than_or_equal_to]
  query_params[:timeCreatedLessThanOrEqualTo] = opts[:time_created_less_than_or_equal_to] if opts[:time_created_less_than_or_equal_to]
  query_params[:timeCompletedGreaterThanOrEqualTo] = opts[:time_completed_greater_than_or_equal_to] if opts[:time_completed_greater_than_or_equal_to]
  query_params[:timeCompletedLessThanOrEqualTo] = opts[:time_completed_less_than_or_equal_to] if opts[:time_completed_less_than_or_equal_to]
  query_params[:targetId] = opts[:target_id] if opts[:target_id]
  query_params[:resourceType] = opts[:resource_type] if opts[:resource_type]
  query_params[:responderType] = opts[:responder_type] if opts[:responder_type]
  query_params[:responderExecutionStatus] = opts[:responder_execution_status] if opts[:responder_execution_status]
  query_params[:responderExecutionMode] = opts[:responder_execution_mode] if opts[:responder_execution_mode]
  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: 'CloudGuardClient#list_responder_executions') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::CloudGuard::Models::ResponderExecutionCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_responder_recipe_responder_rules(responder_recipe_id, compartment_id, opts = {}) ⇒ `Response`

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/cloudguard/list_responder_recipe_responder_rules.rb.html) to see an example of how to use list_responder_recipe_responder_rules API.

Returns a list of ResponderRule associated with ResponderRecipe.

Allowed values are: displayName, riskLevel

Parameters:

responder_recipe_id (String) —

OCID of ResponderRecipe
compartment_id (String) —

The ID of the compartment in which to list resources.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

The retry configuration to apply to this operation. If no key is provided then the 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 entire display name given.
:lifecycle_state (String) —

The field life cycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active. (default to ACTIVE)
:limit (Integer) —

The maximum number of items to return. (default to 10)
:page (String) —

The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
:sort_order (String) —

The sort order to use, either 'asc' or 'desc'. (default to ASC)
:sort_by (String) —

The field to sort by. Only one sort order may be provided. Default order for displayName is ascending. If no value is specified displayName is default. (default to displayName)
:opc_request_id (String) —

The client request ID for tracing.

Returns:

(Response) —

A Response object with data of type ResponderRecipeResponderRuleCollection

# File 'lib/oci/cloud_guard/cloud_guard_client.rb', line 4879

def list_responder_recipe_responder_rules(responder_recipe_id, compartment_id, opts = {})
  logger.debug 'Calling operation CloudGuardClient#list_responder_recipe_responder_rules.' if logger

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

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

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

  if opts[:sort_by] && !%w[displayName riskLevel].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of displayName, riskLevel.'
  end
  raise "Parameter value for 'responder_recipe_id' must not be blank" if OCI::Internal::Util.blank_string?(responder_recipe_id)

  path = '/responderRecipes/{responderRecipeId}/responderRules'.sub('{responderRecipeId}', responder_recipe_id.to_s)
  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[: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]

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

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'CloudGuardClient#list_responder_recipe_responder_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::CloudGuard::Models::ResponderRecipeResponderRuleCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_responder_recipes(compartment_id, opts = {}) ⇒ `Response`

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/cloudguard/list_responder_recipes.rb.html) to see an example of how to use list_responder_recipes API.

Returns a list of all ResponderRecipes in a compartment The ListResponderRecipe operation returns only the targets in `compartmentId` passed. 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 ListResponderRecipe 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) —

The ID of the compartment in which to list resources.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit `nil` value is provided then the operation will not retry
:resource_metadata_only (BOOLEAN) —
Default is false. When set to true, the list of all Oracle Managed Resources Metadata supported by Cloud Guard are returned.
```
(default to false)
```
:display_name (String) —

A filter to return only resources that match the entire display name given.
:lifecycle_state (String) —

The field life cycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active. (default to ACTIVE)
:limit (Integer) —

The maximum number of items to return. (default to 10)
:page (String) —

The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
: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 depending on the the setting of `accessLevel`.
```
(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 'asc' or 'desc'. (default to ASC)
:sort_by (String) —

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

The client request ID for tracing.

Returns:

(Response) —

A Response object with data of type ResponderRecipeCollection

# File 'lib/oci/cloud_guard/cloud_guard_client.rb', line 4991

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

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

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

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

  if opts[:sort_order] && !OCI::CloudGuard::Models::SORT_ORDERS_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::CloudGuard::Models::SORT_ORDERS_ENUM.'
  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 = '/responderRecipes'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:resourceMetadataOnly] = opts[:resource_metadata_only] if !opts[:resource_metadata_only].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[: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: 'CloudGuardClient#list_responder_recipes') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::CloudGuard::Models::ResponderRecipeCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_responder_rules(compartment_id, opts = {}) ⇒ `Response`

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/cloudguard/list_responder_rules.rb.html) to see an example of how to use list_responder_rules API.

Returns a list of ResponderRule.

Allowed values are: timeCreated, displayName

Parameters:

compartment_id (String) —

The ID of the compartment in which to list resources.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

The retry configuration to apply to this operation. If no key is provided then the 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 entire display name given.
:lifecycle_state (String) —

The field life cycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active. (default to ACTIVE)
:limit (Integer) —

The maximum number of items to return. (default to 10)
:page (String) —

The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
:sort_order (String) —

The sort order to use, either 'asc' or 'desc'. (default to ASC)
:sort_by (String) —

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

The client request ID for tracing.

Returns:

(Response) —

A Response object with data of type ResponderRuleCollection

# File 'lib/oci/cloud_guard/cloud_guard_client.rb', line 5079

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

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

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

  if opts[:sort_order] && !OCI::CloudGuard::Models::SORT_ORDERS_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::CloudGuard::Models::SORT_ORDERS_ENUM.'
  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 = '/responderRules'
  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[: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]

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

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'CloudGuardClient#list_responder_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::CloudGuard::Models::ResponderRuleCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

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

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/cloudguard/list_security_policies.rb.html) to see an example of how to use list_security_policies API.

Returns a list of security zone policies. Specify any compartment.

Allowed values are: timeCreated, displayName

Parameters:

compartment_id (String) —

The ID of the compartment in which to list resources.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

The field life cycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active. (default to ACTIVE)
:display_name (String) —

A filter to return only resources that match the entire display name given.
:id (String) —

The unique identifier of the security zone policy (`SecurityPolicy`)
:limit (Integer) —

The maximum number of items to return. (default to 10)
:page (String) —

The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
:sort_order (String) —

The sort order to use, either 'asc' or 'desc'. (default to ASC)
:sort_by (String) —

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

The client request ID for tracing.

Returns:

(Response) —

A Response object with data of type SecurityPolicyCollection

# File 'lib/oci/cloud_guard/cloud_guard_client.rb', line 5161

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

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

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

  if opts[:sort_order] && !OCI::CloudGuard::Models::SORT_ORDERS_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::CloudGuard::Models::SORT_ORDERS_ENUM.'
  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[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:id] = opts[:id] if opts[:id]
  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: 'CloudGuardClient#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::CloudGuard::Models::SecurityPolicyCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_security_recipes(compartment_id, opts = {}) ⇒ `Response`

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/cloudguard/list_security_recipes.rb.html) to see an example of how to use list_security_recipes API.

Gets a list of all security zone recipes in a compartment.

Allowed values are: timeCreated, displayName

Parameters:

compartment_id (String) —

The ID of the compartment in which to list resources.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

The field life cycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active. (default to ACTIVE)
:display_name (String) —

A filter to return only resources that match the entire display name given.
:id (String) —

The unique identifier of the security zone recipe (`SecurityRecipe`)
:limit (Integer) —

The maximum number of items to return. (default to 10)
:page (String) —

The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
:sort_order (String) —

The sort order to use, either 'asc' or 'desc'. (default to ASC)
:sort_by (String) —

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

The client request ID for tracing.

Returns:

(Response) —

A Response object with data of type SecurityRecipeCollection

# File 'lib/oci/cloud_guard/cloud_guard_client.rb', line 5244

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

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

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

  if opts[:sort_order] && !OCI::CloudGuard::Models::SORT_ORDERS_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::CloudGuard::Models::SORT_ORDERS_ENUM.'
  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 = '/securityRecipes'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:id] = opts[:id] if opts[:id]
  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: 'CloudGuardClient#list_security_recipes') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::CloudGuard::Models::SecurityRecipeCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_security_zones(compartment_id, opts = {}) ⇒ `Response`

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/cloudguard/list_security_zones.rb.html) to see an example of how to use list_security_zones API.

Gets a list of all security zones in a compartment.

Allowed values are: timeCreated, displayName

Parameters:

compartment_id (String) —

The ID of the compartment in which to list resources.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

The field life cycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active. (default to ACTIVE)
:display_name (String) —

A filter to return only resources that match the entire display name given.
:id (String) —

The unique identifier of the security zone (`SecurityZone`)
:security_recipe_id (String) —

The unique identifier of the security zone recipe (`SecurityRecipe`)
:is_required_security_zones_in_subtree (BOOLEAN) —

security zones in the subtree
:limit (Integer) —

The maximum number of items to return. (default to 10)
:page (String) —

The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
:sort_order (String) —

The sort order to use, either 'asc' or 'desc'. (default to ASC)
:sort_by (String) —

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

The client request ID for tracing.

Returns:

(Response) —

A Response object with data of type SecurityZoneCollection

# File 'lib/oci/cloud_guard/cloud_guard_client.rb', line 5329

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

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

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

  if opts[:sort_order] && !OCI::CloudGuard::Models::SORT_ORDERS_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::CloudGuard::Models::SORT_ORDERS_ENUM.'
  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 = '/securityZones'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:id] = opts[:id] if opts[:id]
  query_params[:securityRecipeId] = opts[:security_recipe_id] if opts[:security_recipe_id]
  query_params[:isRequiredSecurityZonesInSubtree] = opts[:is_required_security_zones_in_subtree] if !opts[:is_required_security_zones_in_subtree].nil?
  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: 'CloudGuardClient#list_security_zones') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::CloudGuard::Models::SecurityZoneCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_sighting_endpoints(sighting_id, opts = {}) ⇒ `Response`

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/cloudguard/list_sighting_endpoints.rb.html) to see an example of how to use list_sighting_endpoints API.

Returns Sighting endpoints details

Allowed values are: timeCreated

Parameters:

sighting_id (String) —

OCID of the sighting.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

The maximum number of items to return. (default to 10)
:page (String) —

The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
:sort_order (String) —

The sort order to use, either 'asc' or 'desc'. (default to ASC)
: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)
:opc_request_id (String) —

The client request ID for tracing.

Returns:

(Response) —

A Response object with data of type SightingEndpointCollection

# File 'lib/oci/cloud_guard/cloud_guard_client.rb', line 5410

def list_sighting_endpoints(sighting_id, opts = {})
  logger.debug 'Calling operation CloudGuardClient#list_sighting_endpoints.' if logger

  raise "Missing the required parameter 'sighting_id' when calling list_sighting_endpoints." if sighting_id.nil?

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

  if opts[:sort_by] && !%w[timeCreated].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of timeCreated.'
  end
  raise "Parameter value for 'sighting_id' must not be blank" if OCI::Internal::Util.blank_string?(sighting_id)

  path = '/sightings/{sightingId}/endpoints'.sub('{sightingId}', sighting_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]

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

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'CloudGuardClient#list_sighting_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: 'OCI::CloudGuard::Models::SightingEndpointCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_sighting_impacted_resources(sighting_id, opts = {}) ⇒ `Response`

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/cloudguard/list_sighting_impacted_resources.rb.html) to see an example of how to use list_sighting_impacted_resources API.

Return a list of Impacted Resources for a CloudGuard Sighting

Allowed values are: timeCreated

Parameters:

sighting_id (String) —

OCID of the sighting.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

The maximum number of items to return. (default to 10)
:page (String) —

The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
:sort_order (String) —

The sort order to use, either 'asc' or 'desc'. (default to ASC)
: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)
:opc_request_id (String) —

The client request ID for tracing.

Returns:

(Response) —

A Response object with data of type SightingImpactedResourceCollection

# File 'lib/oci/cloud_guard/cloud_guard_client.rb', line 5482

def list_sighting_impacted_resources(sighting_id, opts = {})
  logger.debug 'Calling operation CloudGuardClient#list_sighting_impacted_resources.' if logger

  raise "Missing the required parameter 'sighting_id' when calling list_sighting_impacted_resources." if sighting_id.nil?

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

  if opts[:sort_by] && !%w[timeCreated].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of timeCreated.'
  end
  raise "Parameter value for 'sighting_id' must not be blank" if OCI::Internal::Util.blank_string?(sighting_id)

  path = '/sightings/{sightingId}/impactedResources'.sub('{sightingId}', sighting_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]

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

  post_body = nil

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

#list_sightings(compartment_id, opts = {}) ⇒ `Response`

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/cloudguard/list_sightings.rb.html) to see an example of how to use list_sightings API.

Returns a list of all Sightings identified by the Cloud Guard The ListSightings operation returns only sightings that match the passed filters.

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

Parameters:

compartment_id (String) —

The ID of the compartment in which to list resources.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

OCID of the problem.
:resource_profile_id (String) —

OCID of the resource profile.
: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 depending on the the setting of `accessLevel`.
```
(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) —

The maximum number of items to return. (default to 10)
:page (String) —

The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
:sort_order (String) —

The sort order to use, either 'asc' or 'desc'. (default to ASC)
: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)
:time_last_detected_greater_than_or_equal_to (DateTime) —

Start time for a filter. If start time is not specified, start time will be set to current time - 30 days.
:time_last_detected_less_than_or_equal_to (DateTime) —

End time for a filter. If end time is not specified, end time will be set to current time.
:opc_request_id (String) —

The client request ID for tracing.

Returns:

(Response) —

A Response object with data of type SightingCollection

# File 'lib/oci/cloud_guard/cloud_guard_client.rb', line 5583

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

  raise "Missing the required parameter 'compartment_id' when calling list_sightings." 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] && !OCI::CloudGuard::Models::SORT_ORDERS_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::CloudGuard::Models::SORT_ORDERS_ENUM.'
  end

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

  path = '/sightings'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:problemId] = opts[:problem_id] if opts[:problem_id]
  query_params[:resourceProfileId] = opts[:resource_profile_id] if opts[:resource_profile_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[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:timeLastDetectedGreaterThanOrEqualTo] = opts[:time_last_detected_greater_than_or_equal_to] if opts[:time_last_detected_greater_than_or_equal_to]
  query_params[:timeLastDetectedLessThanOrEqualTo] = opts[:time_last_detected_less_than_or_equal_to] if opts[:time_last_detected_less_than_or_equal_to]

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

  post_body = nil

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

#list_tactics(compartment_id, opts = {}) ⇒ `Response`

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/cloudguard/list_tactics.rb.html) to see an example of how to use list_tactics API.

Returns a list of tactics associated with detector rules.

Allowed values are: displayName

Parameters:

compartment_id (String) —

The ID of the compartment in which to list resources.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

The field life cycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active. (default to ACTIVE)
:limit (Integer) —

The maximum number of items to return. (default to 10)
:page (String) —

The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
:sort_order (String) —

The sort order to use, either 'asc' or 'desc'. (default to ASC)
:sort_by (String) —

The field to sort by. Only one sort order may be provided. Default order for displayName is ascending. If no value is specified displayName is default. (default to displayName)
:opc_request_id (String) —

The client request ID for tracing.

Returns:

(Response) —

A Response object with data of type TacticCollection

# File 'lib/oci/cloud_guard/cloud_guard_client.rb', line 5667

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

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

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

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

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

  path = '/tactics'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[: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: 'CloudGuardClient#list_tactics') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::CloudGuard::Models::TacticCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_target_detector_recipe_detector_rules(target_id, target_detector_recipe_id, compartment_id, opts = {}) ⇒ `Response`

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/cloudguard/list_target_detector_recipe_detector_rules.rb.html) to see an example of how to use list_target_detector_recipe_detector_rules API.

Returns a list of DetectorRule associated with DetectorRecipe within a Target.

Allowed values are: displayName, riskLevel

Parameters:

target_id (String) —

OCID of target
target_detector_recipe_id (String) —

OCID of TargetDetectorRecipe
compartment_id (String) —

The ID of the compartment in which to list resources.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

The retry configuration to apply to this operation. If no key is provided then the 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 entire display name given.
:lifecycle_state (String) —

The field life cycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active. (default to ACTIVE)
:limit (Integer) —

The maximum number of items to return. (default to 10)
:page (String) —

The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
:sort_order (String) —

The sort order to use, either 'asc' or 'desc'. (default to ASC)
:sort_by (String) —

The field to sort by. Only one sort order may be provided. Default order for displayName is ascending. If no value is specified displayName is default. (default to displayName)
:opc_request_id (String) —

The client request ID for tracing.

Returns:

(Response) —

A Response object with data of type TargetDetectorRecipeDetectorRuleCollection

# File 'lib/oci/cloud_guard/cloud_guard_client.rb', line 5749

def list_target_detector_recipe_detector_rules(target_id, target_detector_recipe_id, compartment_id, opts = {})
  logger.debug 'Calling operation CloudGuardClient#list_target_detector_recipe_detector_rules.' if logger

  raise "Missing the required parameter 'target_id' when calling list_target_detector_recipe_detector_rules." if target_id.nil?
  raise "Missing the required parameter 'target_detector_recipe_id' when calling list_target_detector_recipe_detector_rules." if target_detector_recipe_id.nil?
  raise "Missing the required parameter 'compartment_id' when calling list_target_detector_recipe_detector_rules." if compartment_id.nil?

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

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

  if opts[:sort_by] && !%w[displayName riskLevel].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of displayName, riskLevel.'
  end
  raise "Parameter value for 'target_id' must not be blank" if OCI::Internal::Util.blank_string?(target_id)
  raise "Parameter value for 'target_detector_recipe_id' must not be blank" if OCI::Internal::Util.blank_string?(target_detector_recipe_id)

  path = '/targets/{targetId}/targetDetectorRecipes/{targetDetectorRecipeId}/detectorRules'.sub('{targetId}', target_id.to_s).sub('{targetDetectorRecipeId}', target_detector_recipe_id.to_s)
  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[: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]

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

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'CloudGuardClient#list_target_detector_recipe_detector_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::CloudGuard::Models::TargetDetectorRecipeDetectorRuleCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_target_detector_recipes(target_id, compartment_id, opts = {}) ⇒ `Response`

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/cloudguard/list_target_detector_recipes.rb.html) to see an example of how to use list_target_detector_recipes API.

Returns a list of all detector recipes associated with the target identified by targetId

Allowed values are: timeCreated, displayName

Parameters:

target_id (String) —

OCID of target
compartment_id (String) —

The ID of the compartment in which to list resources.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

The retry configuration to apply to this operation. If no key is provided then the 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 entire display name given.
:lifecycle_state (String) —

The field life cycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active. (default to ACTIVE)
:limit (Integer) —

The maximum number of items to return. (default to 10)
:page (String) —

The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
:sort_order (String) —

The sort order to use, either 'asc' or 'desc'. (default to ASC)
:sort_by (String) —

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

The client request ID for tracing.

Returns:

(Response) —

A Response object with data of type TargetDetectorRecipeCollection

# File 'lib/oci/cloud_guard/cloud_guard_client.rb', line 5834

def list_target_detector_recipes(target_id, compartment_id, opts = {})
  logger.debug 'Calling operation CloudGuardClient#list_target_detector_recipes.' if logger

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

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

  if opts[:sort_order] && !OCI::CloudGuard::Models::SORT_ORDERS_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::CloudGuard::Models::SORT_ORDERS_ENUM.'
  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
  raise "Parameter value for 'target_id' must not be blank" if OCI::Internal::Util.blank_string?(target_id)

  path = '/targets/{targetId}/targetDetectorRecipes'.sub('{targetId}', target_id.to_s)
  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[: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]

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

  post_body = nil

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

#list_target_responder_recipe_responder_rules(target_id, target_responder_recipe_id, compartment_id, opts = {}) ⇒ `Response`

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/cloudguard/list_target_responder_recipe_responder_rules.rb.html) to see an example of how to use list_target_responder_recipe_responder_rules API.

Returns a list of ResponderRule associated with ResponderRecipe within a Target.

Allowed values are: displayName, riskLevel

Parameters:

target_id (String) —

OCID of target
target_responder_recipe_id (String) —

OCID of TargetResponderRecipe
compartment_id (String) —

The ID of the compartment in which to list resources.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

The retry configuration to apply to this operation. If no key is provided then the 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 entire display name given.
:lifecycle_state (String) —

The field life cycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active. (default to ACTIVE)
:limit (Integer) —

The maximum number of items to return. (default to 10)
:page (String) —

The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
:sort_order (String) —

The sort order to use, either 'asc' or 'desc'. (default to ASC)
:sort_by (String) —

The field to sort by. Only one sort order may be provided. Default order for displayName is ascending. If no value is specified displayName is default. (default to displayName)
:opc_request_id (String) —

The client request ID for tracing.

Returns:

(Response) —

A Response object with data of type TargetResponderRecipeResponderRuleCollection

# File 'lib/oci/cloud_guard/cloud_guard_client.rb', line 5919

def list_target_responder_recipe_responder_rules(target_id, target_responder_recipe_id, compartment_id, opts = {})
  logger.debug 'Calling operation CloudGuardClient#list_target_responder_recipe_responder_rules.' if logger

  raise "Missing the required parameter 'target_id' when calling list_target_responder_recipe_responder_rules." if target_id.nil?
  raise "Missing the required parameter 'target_responder_recipe_id' when calling list_target_responder_recipe_responder_rules." if target_responder_recipe_id.nil?
  raise "Missing the required parameter 'compartment_id' when calling list_target_responder_recipe_responder_rules." if compartment_id.nil?

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

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

  if opts[:sort_by] && !%w[displayName riskLevel].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of displayName, riskLevel.'
  end
  raise "Parameter value for 'target_id' must not be blank" if OCI::Internal::Util.blank_string?(target_id)
  raise "Parameter value for 'target_responder_recipe_id' must not be blank" if OCI::Internal::Util.blank_string?(target_responder_recipe_id)

  path = '/targets/{targetId}/targetResponderRecipes/{targetResponderRecipeId}/responderRules'.sub('{targetId}', target_id.to_s).sub('{targetResponderRecipeId}', target_responder_recipe_id.to_s)
  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[: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]

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

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'CloudGuardClient#list_target_responder_recipe_responder_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::CloudGuard::Models::TargetResponderRecipeResponderRuleCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_target_responder_recipes(target_id, compartment_id, opts = {}) ⇒ `Response`

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/cloudguard/list_target_responder_recipes.rb.html) to see an example of how to use list_target_responder_recipes API.

Returns a list of all responder recipes associated with the target identified by targetId

Allowed values are: timeCreated, displayName

Parameters:

target_id (String) —

OCID of target
compartment_id (String) —

The ID of the compartment in which to list resources.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

The retry configuration to apply to this operation. If no key is provided then the 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 entire display name given.
:lifecycle_state (String) —

The field life cycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active. (default to ACTIVE)
:limit (Integer) —

The maximum number of items to return. (default to 10)
:page (String) —

The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
:sort_order (String) —

The sort order to use, either 'asc' or 'desc'. (default to ASC)
:sort_by (String) —

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

The client request ID for tracing.

Returns:

(Response) —

A Response object with data of type TargetResponderRecipeCollection

# File 'lib/oci/cloud_guard/cloud_guard_client.rb', line 6004

def list_target_responder_recipes(target_id, compartment_id, opts = {})
  logger.debug 'Calling operation CloudGuardClient#list_target_responder_recipes.' if logger

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

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

  if opts[:sort_order] && !OCI::CloudGuard::Models::SORT_ORDERS_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::CloudGuard::Models::SORT_ORDERS_ENUM.'
  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
  raise "Parameter value for 'target_id' must not be blank" if OCI::Internal::Util.blank_string?(target_id)

  path = '/targets/{targetId}/targetResponderRecipes'.sub('{targetId}', target_id.to_s)
  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[: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]

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

  post_body = nil

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

#list_targets(compartment_id, opts = {}) ⇒ `Response`

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/cloudguard/list_targets.rb.html) to see an example of how to use list_targets API.

Returns a list of all Targets in a compartment The ListTargets operation returns only the targets in `compartmentId` passed. 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 ListTargets 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) —

The ID of the compartment in which to list resources.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

The retry configuration to apply to this operation. If no key is provided then the 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 entire display name given.
:is_non_security_zone_targets_only_query (BOOLEAN) —
Default is false. When set to true, only the targets that would be deleted as part of security zone creation will be returned.
```
(default to false)
```
:lifecycle_state (String) —

The field life cycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active. (default to ACTIVE)
: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 depending on the the setting of `accessLevel`.
```
(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) —

The maximum number of items to return. (default to 10)
:page (String) —

The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
:sort_order (String) —

The sort order to use, either 'asc' or 'desc'. (default to ASC)
:sort_by (String) —

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

The client request ID for tracing.

Returns:

(Response) —

A Response object with data of type TargetCollection

# File 'lib/oci/cloud_guard/cloud_guard_client.rb', line 6116

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

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

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

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

  if opts[:sort_order] && !OCI::CloudGuard::Models::SORT_ORDERS_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::CloudGuard::Models::SORT_ORDERS_ENUM.'
  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 = '/targets'
  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[:isNonSecurityZoneTargetsOnlyQuery] = opts[:is_non_security_zone_targets_only_query] if !opts[:is_non_security_zone_targets_only_query].nil?
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:compartmentIdInSubtree] = opts[:compartment_id_in_subtree] if !opts[:compartment_id_in_subtree].nil?
  query_params[:accessLevel] = opts[:access_level] if opts[:access_level]
  query_params[: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: 'CloudGuardClient#list_targets') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::CloudGuard::Models::TargetCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_techniques(compartment_id, opts = {}) ⇒ `Response`

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/cloudguard/list_techniques.rb.html) to see an example of how to use list_techniques API.

Returns a list of techniques associated with detector rules.

Allowed values are: displayName

Parameters:

compartment_id (String) —

The ID of the compartment in which to list resources.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit `nil` value is provided then the operation will not retry
:tactics (Array<String>) —

A filter to return only resources that match the list of tactics given. (default to [])
:lifecycle_state (String) —

The field life cycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active. (default to ACTIVE)
:limit (Integer) —

The maximum number of items to return. (default to 10)
:page (String) —

The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
:sort_order (String) —

The sort order to use, either 'asc' or 'desc'. (default to ASC)
:sort_by (String) —

The field to sort by. Only one sort order may be provided. Default order for displayName is ascending. If no value is specified displayName is default. (default to displayName)
:opc_request_id (String) —

The client request ID for tracing.

Returns:

(Response) —

A Response object with data of type TechniqueCollection

# File 'lib/oci/cloud_guard/cloud_guard_client.rb', line 6204

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

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

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

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

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

  path = '/techniques'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:tactics] = OCI::ApiClient.build_collection_params(opts[:tactics], :multi) if opts[:tactics] && !opts[:tactics].empty?
  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]

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

  post_body = nil

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

#logger ⇒ `Logger`

Returns The logger for this client. May be nil.

Returns:

(Logger) —

The logger for this client. May be nil.



94
95
96

# File 'lib/oci/cloud_guard/cloud_guard_client.rb', line 94

def logger
  @api_client.config.logger
end

#remove_compartment(security_zone_id, remove_compartment_details, opts = {}) ⇒ `Response`

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/cloudguard/remove_compartment.rb.html) to see an example of how to use remove_compartment API.

Removes an existing compartment from a security zone. When you remove a subcompartment from a security zone, it no longer enforces security zone policies on the resources in the subcompartment. You can't remove the primary compartment that was used to create the security zone.

Parameters:

security_zone_id (String) —

The unique identifier of the security zone (`SecurityZone`)
remove_compartment_details (OCI::CloudGuard::Models::RemoveCompartmentDetails) —

The compartment to remove from the security zone.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

The client request ID for tracing.

Returns:

(Response) —

A Response object with data of type SecurityZone

# File 'lib/oci/cloud_guard/cloud_guard_client.rb', line 6289

def remove_compartment(security_zone_id, remove_compartment_details, opts = {})
  logger.debug 'Calling operation CloudGuardClient#remove_compartment.' if logger

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

  path = '/securityZones/{securityZoneId}/actions/removeCompartment'.sub('{securityZoneId}', security_zone_id.to_s)
  operation_signing_strategy = :standard

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

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'CloudGuardClient#remove_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,
      return_type: 'OCI::CloudGuard::Models::SecurityZone'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#request_risk_scores(compartment_id, opts = {}) ⇒ `Response`

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/cloudguard/request_risk_scores.rb.html) to see an example of how to use request_risk_scores API.

Examines the number of problems related to the resource and the relative severity of those problems.

Parameters:

compartment_id (String) —

The ID of the compartment in which to list resources.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

The maximum number of items to return. (default to 10)
:page (String) —

The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
:opc_request_id (String) —

The client request ID for tracing.

Returns:

(Response) —

A Response object with data of type RiskScoreAggregationCollection

# File 'lib/oci/cloud_guard/cloud_guard_client.rb', line 6350

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

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

  path = '/riskScores'
  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]

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

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'CloudGuardClient#request_risk_scores') do
    @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::CloudGuard::Models::RiskScoreAggregationCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#request_security_score_summarized_trend(compartment_id, opts = {}) ⇒ `Response`

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/cloudguard/request_security_score_summarized_trend.rb.html) to see an example of how to use request_security_score_summarized_trend API.

Measures the number of resources examined across all regions and compares it with the number of problems detected, for a given time period.

Parameters:

compartment_id (String) —

The ID of the compartment in which to list resources.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

Start time for a filter. If start time is not specified, start time will be set to today's current time - 30 days.
:time_score_computed_less_than_or_equal_to (DateTime) —

End time for a filter. If end time is not specified, end time will be set to today's current time.
:limit (Integer) —

The maximum number of items to return. (default to 10)
:page (String) —

The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
:opc_request_id (String) —

The client request ID for tracing.

Returns:

(Response) —

A Response object with data of type SecurityScoreTrendAggregationCollection

# File 'lib/oci/cloud_guard/cloud_guard_client.rb', line 6412

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

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

  path = '/securityScores/actions/summarizeTrend'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:timeScoreComputedGreaterThanOrEqualTo] = opts[:time_score_computed_greater_than_or_equal_to] if opts[:time_score_computed_greater_than_or_equal_to]
  query_params[:timeScoreComputedLessThanOrEqualTo] = opts[:time_score_computed_less_than_or_equal_to] if opts[:time_score_computed_less_than_or_equal_to]
  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: 'CloudGuardClient#request_security_score_summarized_trend') do
    @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::CloudGuard::Models::SecurityScoreTrendAggregationCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#request_security_scores(compartment_id, opts = {}) ⇒ `Response`

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/cloudguard/request_security_scores.rb.html) to see an example of how to use request_security_scores API.

Measures the number of resources examined across all regions and compares it with the number of problems detected.

Parameters:

compartment_id (String) —

The ID of the compartment in which to list resources.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

The maximum number of items to return. (default to 10)
:page (String) —

The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
:opc_request_id (String) —

The client request ID for tracing.

Returns:

(Response) —

A Response object with data of type SecurityScoreAggregationCollection

# File 'lib/oci/cloud_guard/cloud_guard_client.rb', line 6473

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

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

  path = '/securityScores'
  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]

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

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'CloudGuardClient#request_security_scores') do
    @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::CloudGuard::Models::SecurityScoreAggregationCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#request_summarized_activity_problems(compartment_id, opts = {}) ⇒ `Response`

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/cloudguard/request_summarized_activity_problems.rb.html) to see an example of how to use request_summarized_activity_problems API.

Returns the summary of Activity type problems identified by cloud guard, for a given set of dimensions.

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 summarize API 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.

The compartmentId to be passed with `accessLevel` and `compartmentIdInSubtree` params has to be the root compartment id (tenant-id) only.

Parameters:

compartment_id (String) —

The ID of the compartment in which to list resources.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

The retry configuration to apply to this operation. If no key is provided then the 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 depending on the the setting of `accessLevel`.
```
(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) —

The maximum number of items to return. (default to 10)
:include_unknown_locations (BOOLEAN) —
Default is false. When set to true, the summary of activity problems that has unknown values for city, state or country will be included.
```
(default to false)
```
:page (String) —

The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
:opc_request_id (String) —

The client request ID for tracing.

Returns:

(Response) —

A Response object with data of type ActivityProblemAggregationCollection

# File 'lib/oci/cloud_guard/cloud_guard_client.rb', line 6562

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

  raise "Missing the required parameter 'compartment_id' when calling request_summarized_activity_problems." 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 = '/problems/actions/summarizeActivityProblems'
  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[:includeUnknownLocations] = opts[:include_unknown_locations] if !opts[:include_unknown_locations].nil?
  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: 'CloudGuardClient#request_summarized_activity_problems') do
    @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::CloudGuard::Models::ActivityProblemAggregationCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#request_summarized_problems(list_dimensions, compartment_id, opts = {}) ⇒ `Response`

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/cloudguard/request_summarized_problems.rb.html) to see an example of how to use request_summarized_problems API.

Returns the number of problems identified by cloud guard, for a given set of dimensions.

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 summarize API 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:

list_dimensions (Array<String>) —

The possible attributes based on which the problems can be distinguished. Allowed values are: RESOURCE_TYPE, REGION, COMPARTMENT_ID, RISK_LEVEL
compartment_id (String) —

The ID of the compartment in which to list resources.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

The retry configuration to apply to this operation. If no key is provided then the 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 depending on the the setting of `accessLevel`.
```
(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) —

The maximum number of items to return. (default to 10)
:page (String) —

The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
:opc_request_id (String) —

The client request ID for tracing.

Returns:

(Response) —

A Response object with data of type ProblemAggregationCollection

# File 'lib/oci/cloud_guard/cloud_guard_client.rb', line 6653

def request_summarized_problems(list_dimensions, compartment_id, opts = {})
  logger.debug 'Calling operation CloudGuardClient#request_summarized_problems.' if logger

  raise "Missing the required parameter 'list_dimensions' when calling request_summarized_problems." if list_dimensions.nil?

  list_dimensions_allowable_values = %w[RESOURCE_TYPE REGION COMPARTMENT_ID RISK_LEVEL]
  list_dimensions.each do |val_to_check|
    unless list_dimensions_allowable_values.include?(val_to_check)
      raise "Invalid value for 'list_dimensions', must be one of RESOURCE_TYPE, REGION, COMPARTMENT_ID, RISK_LEVEL."
    end
  end
  raise "Missing the required parameter 'compartment_id' when calling request_summarized_problems." 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 = '/problems/actions/summarize'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:listDimensions] = OCI::ApiClient.build_collection_params(list_dimensions, :multi)
  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: 'CloudGuardClient#request_summarized_problems') do
    @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::CloudGuard::Models::ProblemAggregationCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#request_summarized_responder_executions(responder_executions_dimensions, compartment_id, opts = {}) ⇒ `Response`

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/cloudguard/request_summarized_responder_executions.rb.html) to see an example of how to use request_summarized_responder_executions API.

Returns the number of Responder Executions, for a given set of dimensions.

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 summarize API 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:

responder_executions_dimensions (Array<String>) —

The possible attributes based on which the responder executions can be distinguished Allowed values are: RESPONDER_RULE_TYPE, RESPONDER_EXECUTION_STATUS
compartment_id (String) —

The ID of the compartment in which to list resources.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit `nil` value is provided then the operation will not retry
:responder_type_filter (Array<String>) —
The possible filters for Responder Type Dimension to distinguish Responder Executions. If no values are passed, the metric for responder executions of all reponder types are returned
```
(default to [])
```
Allowed values are: REMEDIATION, NOTIFICATION
:responder_execution_status_filter (Array<String>) —
The possible filters for Responder Type Dimension to distinguish Responder Executions. If no values are passed, the metric for responder executions of all status are returned
```
(default to [])
```
Allowed values are: STARTED, AWAITING_CONFIRMATION, SUCCEEDED, FAILED, SKIPPED
: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 depending on the the setting of `accessLevel`.
```
(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) —

The maximum number of items to return. (default to 10)
:page (String) —

The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
:opc_request_id (String) —

The client request ID for tracing.

Returns:

(Response) —

A Response object with data of type ResponderExecutionAggregationCollection

# File 'lib/oci/cloud_guard/cloud_guard_client.rb', line 6760

def request_summarized_responder_executions(responder_executions_dimensions, compartment_id, opts = {})
  logger.debug 'Calling operation CloudGuardClient#request_summarized_responder_executions.' if logger

  raise "Missing the required parameter 'responder_executions_dimensions' when calling request_summarized_responder_executions." if responder_executions_dimensions.nil?

  responder_executions_dimensions_allowable_values = %w[RESPONDER_RULE_TYPE RESPONDER_EXECUTION_STATUS]
  responder_executions_dimensions.each do |val_to_check|
    unless responder_executions_dimensions_allowable_values.include?(val_to_check)
      raise "Invalid value for 'responder_executions_dimensions', must be one of RESPONDER_RULE_TYPE, RESPONDER_EXECUTION_STATUS."
    end
  end
  raise "Missing the required parameter 'compartment_id' when calling request_summarized_responder_executions." if compartment_id.nil?


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


  responder_execution_status_filter_allowable_values = %w[STARTED AWAITING_CONFIRMATION SUCCEEDED FAILED SKIPPED]
  if opts[:responder_execution_status_filter] && !opts[:responder_execution_status_filter].empty?
    opts[:responder_execution_status_filter].each do |val_to_check|
      unless responder_execution_status_filter_allowable_values.include?(val_to_check)
        raise 'Invalid value for "responder_execution_status_filter", must be one of STARTED, AWAITING_CONFIRMATION, SUCCEEDED, FAILED, SKIPPED.'
      end
    end
  end

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

  path = '/responderExecutions/actions/summarize'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:responderExecutionsDimensions] = OCI::ApiClient.build_collection_params(responder_executions_dimensions, :multi)
  query_params[:compartmentId] = compartment_id
  query_params[:responderTypeFilter] = OCI::ApiClient.build_collection_params(opts[:responder_type_filter], :multi) if opts[:responder_type_filter] && !opts[:responder_type_filter].empty?
  query_params[:responderExecutionStatusFilter] = OCI::ApiClient.build_collection_params(opts[:responder_execution_status_filter], :multi) if opts[:responder_execution_status_filter] && !opts[:responder_execution_status_filter].empty?
  query_params[:compartmentIdInSubtree] = opts[:compartment_id_in_subtree] if !opts[:compartment_id_in_subtree].nil?
  query_params[:accessLevel] = opts[:access_level] if opts[:access_level]
  query_params[: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: 'CloudGuardClient#request_summarized_responder_executions') do
    @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::CloudGuard::Models::ResponderExecutionAggregationCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#request_summarized_risk_scores(compartment_id, opts = {}) ⇒ `Response`

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/cloudguard/request_summarized_risk_scores.rb.html) to see an example of how to use request_summarized_risk_scores API.

DEPRECATED

Parameters:

compartment_id (String) —

The ID of the compartment in which to list resources.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

The maximum number of items to return. (default to 10)
:page (String) —

The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
:opc_request_id (String) —

The client request ID for tracing.

Returns:

(Response) —

A Response object with data of type RiskScoreAggregationCollection

# File 'lib/oci/cloud_guard/cloud_guard_client.rb', line 6856

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

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

  path = '/problems/actions/summarizeRiskScore'
  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]

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

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'CloudGuardClient#request_summarized_risk_scores') do
    @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::CloudGuard::Models::RiskScoreAggregationCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#request_summarized_security_scores(compartment_id, opts = {}) ⇒ `Response`

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/cloudguard/request_summarized_security_scores.rb.html) to see an example of how to use request_summarized_security_scores API.

DEPRECATED

Parameters:

compartment_id (String) —

The ID of the compartment in which to list resources.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

The maximum number of items to return. (default to 10)
:page (String) —

The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
:opc_request_id (String) —

The client request ID for tracing.

Returns:

(Response) —

A Response object with data of type SecurityScoreAggregationCollection

# File 'lib/oci/cloud_guard/cloud_guard_client.rb', line 6915

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

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

  path = '/problems/actions/summarizeSecurityScore'
  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]

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

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'CloudGuardClient#request_summarized_security_scores') do
    @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::CloudGuard::Models::SecurityScoreAggregationCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#request_summarized_top_trend_resource_profile_risk_scores(compartment_id, opts = {}) ⇒ `Response`

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/cloudguard/request_summarized_top_trend_resource_profile_risk_scores.rb.html) to see an example of how to use request_summarized_top_trend_resource_profile_risk_scores API.

Summarizes the resource profile risk score top trends for the given time range based on the search filters.

Allowed values are: riskScore, riskScoreGrowth, timeFirstDetected, timeLastDetected

Parameters:

compartment_id (String) —

The ID of the compartment in which to list resources.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

Start time for a filter. If start time is not specified, start time will be set to today's current time - 30 days.
:time_score_computed_less_than_or_equal_to (DateTime) —

End time for a filter. If end time is not specified, end time will be set to today's current time.
: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 depending on the the setting of `accessLevel`.
```
(default to false)
```
:sort_by (String) —

The field to sort trendlines for resource profiles. Only one sort order may be provided. If no value is specified riskScore is default. (default to riskScore)
:count (Integer) —

Number of resource profile risk score trend-lines to be displayed. Default value is 10. (default to 10)
: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) —

The maximum number of items to return. (default to 10)
:page (String) —

The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
:opc_request_id (String) —

The client request ID for tracing.

Returns:

(Response) —

A Response object with data of type ResourceProfileRiskScoreAggregationSummaryCollection

# File 'lib/oci/cloud_guard/cloud_guard_client.rb', line 6992

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

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

  if opts[:sort_by] && !%w[riskScore riskScoreGrowth timeFirstDetected timeLastDetected].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of riskScore, riskScoreGrowth, timeFirstDetected, timeLastDetected.'
  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 = '/resourceProfileRiskScores/actions/summarizeTopTrends'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:timeScoreComputedGreaterThanOrEqualTo] = opts[:time_score_computed_greater_than_or_equal_to] if opts[:time_score_computed_greater_than_or_equal_to]
  query_params[:timeScoreComputedLessThanOrEqualTo] = opts[:time_score_computed_less_than_or_equal_to] if opts[:time_score_computed_less_than_or_equal_to]
  query_params[:compartmentIdInSubtree] = opts[:compartment_id_in_subtree] if !opts[:compartment_id_in_subtree].nil?
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:count] = opts[:count] if opts[:count]
  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: 'CloudGuardClient#request_summarized_top_trend_resource_profile_risk_scores') do
    @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::CloudGuard::Models::ResourceProfileRiskScoreAggregationSummaryCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#request_summarized_trend_problems(compartment_id, opts = {}) ⇒ `Response`

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/cloudguard/request_summarized_trend_problems.rb.html) to see an example of how to use request_summarized_trend_problems API.

Returns the number of problems identified by cloud guard, for a given time period.

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 summarize API 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) —

The ID of the compartment in which to list resources.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

Start time for a filter. If start time is not specified, start time will be set to current time - 30 days.
:time_first_detected_less_than_or_equal_to (DateTime) —

End time for a filter. If end time is not specified, end time will be set to current time.
: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 depending on the the setting of `accessLevel`.
```
(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) —

The maximum number of items to return. (default to 10)
:page (String) —

The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
:opc_request_id (String) —

The client request ID for tracing.

Returns:

(Response) —

A Response object with data of type ProblemTrendAggregationCollection

# File 'lib/oci/cloud_guard/cloud_guard_client.rb', line 7090

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

  raise "Missing the required parameter 'compartment_id' when calling request_summarized_trend_problems." 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 = '/problems/actions/summarizeTrend'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:timeFirstDetectedGreaterThanOrEqualTo] = opts[:time_first_detected_greater_than_or_equal_to] if opts[:time_first_detected_greater_than_or_equal_to]
  query_params[:timeFirstDetectedLessThanOrEqualTo] = opts[:time_first_detected_less_than_or_equal_to] if opts[:time_first_detected_less_than_or_equal_to]
  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: 'CloudGuardClient#request_summarized_trend_problems') do
    @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::CloudGuard::Models::ProblemTrendAggregationCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#request_summarized_trend_resource_risk_scores(request_summarized_trend_resource_risk_scores_details, compartment_id, opts = {}) ⇒ `Response`

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/cloudguard/request_summarized_trend_resource_risk_scores.rb.html) to see an example of how to use request_summarized_trend_resource_risk_scores API.

Summarizes the resource risk score trend for the given time range based on the search filters.

Parameters:

request_summarized_trend_resource_risk_scores_details (OCI::CloudGuard::Models::RequestSummarizedTrendResourceRiskScoresDetails) —

The filter to fetch risk score trend.
compartment_id (String) —

The ID of the compartment in which to list resources.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

Start time for a filter. If start time is not specified, start time will be set to today's current time - 30 days.
:time_score_computed_less_than_or_equal_to (DateTime) —

End time for a filter. If end time is not specified, end time will be set to today's current time.
: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 depending on the the setting of `accessLevel`.
```
(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) —

The maximum number of items to return. (default to 10)
:page (String) —

The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
:opc_request_id (String) —

The client request ID for tracing.

Returns:

(Response) —

A Response object with data of type ResourceRiskScoreAggregationCollection

# File 'lib/oci/cloud_guard/cloud_guard_client.rb', line 7171

def request_summarized_trend_resource_risk_scores(request_summarized_trend_resource_risk_scores_details, compartment_id, opts = {})
  logger.debug 'Calling operation CloudGuardClient#request_summarized_trend_resource_risk_scores.' if logger

  raise "Missing the required parameter 'request_summarized_trend_resource_risk_scores_details' when calling request_summarized_trend_resource_risk_scores." if request_summarized_trend_resource_risk_scores_details.nil?
  raise "Missing the required parameter 'compartment_id' when calling request_summarized_trend_resource_risk_scores." 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 = '/resourceRiskScores/actions/summarizeTrend'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:timeScoreComputedGreaterThanOrEqualTo] = opts[:time_score_computed_greater_than_or_equal_to] if opts[:time_score_computed_greater_than_or_equal_to]
  query_params[:timeScoreComputedLessThanOrEqualTo] = opts[:time_score_computed_less_than_or_equal_to] if opts[:time_score_computed_less_than_or_equal_to]
  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 = @api_client.object_to_http_body(request_summarized_trend_resource_risk_scores_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'CloudGuardClient#request_summarized_trend_resource_risk_scores') do
    @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::CloudGuard::Models::ResourceRiskScoreAggregationCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#request_summarized_trend_responder_executions(compartment_id, opts = {}) ⇒ `Response`

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/cloudguard/request_summarized_trend_responder_executions.rb.html) to see an example of how to use request_summarized_trend_responder_executions API.

Returns the number of remediations performed by Responders, for a given time period.

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 summarize API 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) —

The ID of the compartment in which to list resources.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

Completion End Time
:time_completed_less_than_or_equal_to (DateTime) —

Completion Start Time
: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 depending on the the setting of `accessLevel`.
```
(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) —

The maximum number of items to return. (default to 10)
:page (String) —

The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
:opc_request_id (String) —

The client request ID for tracing.

Returns:

(Response) —

A Response object with data of type ResponderExecutionTrendAggregationCollection

# File 'lib/oci/cloud_guard/cloud_guard_client.rb', line 7264

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

  raise "Missing the required parameter 'compartment_id' when calling request_summarized_trend_responder_executions." 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 = '/responderExecutions/actions/summarizeTrend'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:timeCompletedGreaterThanOrEqualTo] = opts[:time_completed_greater_than_or_equal_to] if opts[:time_completed_greater_than_or_equal_to]
  query_params[:timeCompletedLessThanOrEqualTo] = opts[:time_completed_less_than_or_equal_to] if opts[:time_completed_less_than_or_equal_to]
  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: 'CloudGuardClient#request_summarized_trend_responder_executions') do
    @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::CloudGuard::Models::ResponderExecutionTrendAggregationCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#request_summarized_trend_security_scores(compartment_id, opts = {}) ⇒ `Response`

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/cloudguard/request_summarized_trend_security_scores.rb.html) to see an example of how to use request_summarized_trend_security_scores API.

DEPRECATED

Parameters:

compartment_id (String) —

The ID of the compartment in which to list resources.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

Start time for a filter. If start time is not specified, start time will be set to today's current time - 30 days.
:time_score_computed_less_than_or_equal_to (DateTime) —

End time for a filter. If end time is not specified, end time will be set to today's current time.
:limit (Integer) —

The maximum number of items to return. (default to 10)
:page (String) —

The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
:opc_request_id (String) —

The client request ID for tracing.

Returns:

(Response) —

A Response object with data of type SecurityScoreTrendAggregationCollection

# File 'lib/oci/cloud_guard/cloud_guard_client.rb', line 7333

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

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

  path = '/problems/actions/summarizeSecurityScoreTrend'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:timeScoreComputedGreaterThanOrEqualTo] = opts[:time_score_computed_greater_than_or_equal_to] if opts[:time_score_computed_greater_than_or_equal_to]
  query_params[:timeScoreComputedLessThanOrEqualTo] = opts[:time_score_computed_less_than_or_equal_to] if opts[:time_score_computed_less_than_or_equal_to]
  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: 'CloudGuardClient#request_summarized_trend_security_scores') do
    @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::CloudGuard::Models::SecurityScoreTrendAggregationCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#skip_bulk_responder_execution(skip_bulk_responder_execution_details, opts = {}) ⇒ `Response`

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/cloudguard/skip_bulk_responder_execution.rb.html) to see an example of how to use skip_bulk_responder_execution API.

Skips the execution for a bulk of responder executions The operation is atomic in nature

Parameters:

skip_bulk_responder_execution_details (OCI::CloudGuard::Models::SkipBulkResponderExecutionDetails) —

A list of responder execution ids to skip the execution
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

The client request ID for tracing.

Returns:

(Response) —

A Response object with data of type nil

# File 'lib/oci/cloud_guard/cloud_guard_client.rb', line 7393

def skip_bulk_responder_execution(skip_bulk_responder_execution_details, opts = {})
  logger.debug 'Calling operation CloudGuardClient#skip_bulk_responder_execution.' if logger

  raise "Missing the required parameter 'skip_bulk_responder_execution_details' when calling skip_bulk_responder_execution." if skip_bulk_responder_execution_details.nil?

  path = '/responderExecutions/actions/bulkSkip'
  operation_signing_strategy = :standard

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

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

#skip_responder_execution(responder_execution_id, compartment_id, opts = {}) ⇒ `Response`

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/cloudguard/skip_responder_execution.rb.html) to see an example of how to use skip_responder_execution API.

Skips the execution of the responder execution. When provided, If-Match is checked against ETag values of the resource.

Parameters:

responder_execution_id (String) —

The identifier of the responder execution.
compartment_id (String) —

The ID of the compartment in which to list resources.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

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

The client request ID for tracing.
:opc_retry_token (String) —

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

Returns:

(Response) —

A Response object with data of type nil

# File 'lib/oci/cloud_guard/cloud_guard_client.rb', line 7458

def skip_responder_execution(responder_execution_id, compartment_id, opts = {})
  logger.debug 'Calling operation CloudGuardClient#skip_responder_execution.' if logger

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

  path = '/responderExecutions/{responderExecutionId}/actions/skip'.sub('{responderExecutionId}', responder_execution_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = 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]
  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: 'CloudGuardClient#skip_responder_execution') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#trigger_responder(problem_id, trigger_responder_details, opts = {}) ⇒ `Response`

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/cloudguard/trigger_responder.rb.html) to see an example of how to use trigger_responder API.

push the problem to responder

Parameters:

problem_id (String) —

OCId of the problem.
trigger_responder_details (OCI::CloudGuard::Models::TriggerResponderDetails) —

The responder may update the problem.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

The client request ID for tracing.
:if_match (String) —

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

Returns:

(Response) —

A Response object with data of type nil

# File 'lib/oci/cloud_guard/cloud_guard_client.rb', line 7530

def trigger_responder(problem_id, trigger_responder_details, opts = {})
  logger.debug 'Calling operation CloudGuardClient#trigger_responder.' if logger

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

  path = '/problems/{problemId}/actions/triggerResponder'.sub('{problemId}', problem_id.to_s)
  operation_signing_strategy = :standard

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

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'CloudGuardClient#trigger_responder') do
    @api_client.call_api(
      :POST,
      path,
      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_bulk_problem_status(update_bulk_problem_status_details, opts = {}) ⇒ `Response`

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/cloudguard/update_bulk_problem_status.rb.html) to see an example of how to use update_bulk_problem_status API.

Updates the statuses in bulk for a list of problems The operation is atomic in nature

Parameters:

update_bulk_problem_status_details (OCI::CloudGuard::Models::UpdateBulkProblemStatusDetails) —

A list of problem ids to be passed in to update the Problem 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
:opc_request_id (String) —

The client request ID for tracing.

Returns:

(Response) —

A Response object with data of type nil

# File 'lib/oci/cloud_guard/cloud_guard_client.rb', line 7589

def update_bulk_problem_status(update_bulk_problem_status_details, opts = {})
  logger.debug 'Calling operation CloudGuardClient#update_bulk_problem_status.' if logger

  raise "Missing the required parameter 'update_bulk_problem_status_details' when calling update_bulk_problem_status." if update_bulk_problem_status_details.nil?

  path = '/problems/actions/bulkUpdateStatus'
  operation_signing_strategy = :standard

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

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'CloudGuardClient#update_bulk_problem_status') do
    @api_client.call_api(
      :POST,
      path,
      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_configuration(update_configuration_details, compartment_id, opts = {}) ⇒ `Response`

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/cloudguard/update_configuration.rb.html) to see an example of how to use update_configuration API.

Enable/Disable Cloud Guard. The reporting region cannot be updated once created.

Parameters:

update_configuration_details (OCI::CloudGuard::Models::UpdateConfigurationDetails) —

Update Configuration Details of Cloud Guard for a Tenancy.
compartment_id (String) —

The ID of the compartment in which to list resources.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

The client request ID for tracing.
:opc_retry_token (String) —

A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. 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.

Returns:

(Response) —

A Response object with data of type Configuration

# File 'lib/oci/cloud_guard/cloud_guard_client.rb', line 7655

def update_configuration(update_configuration_details, compartment_id, opts = {})
  logger.debug 'Calling operation CloudGuardClient#update_configuration.' if logger

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

  path = '/configuration'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = 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]
  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]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(update_configuration_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'CloudGuardClient#update_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,
      return_type: 'OCI::CloudGuard::Models::Configuration'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_data_mask_rule(data_mask_rule_id, update_data_mask_rule_details, opts = {}) ⇒ `Response`

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/cloudguard/update_data_mask_rule.rb.html) to see an example of how to use update_data_mask_rule API.

Updates a DataMaskRule identified by dataMaskRuleId

Parameters:

data_mask_rule_id (String) —

OCID of dataMaskRule
update_data_mask_rule_details (OCI::CloudGuard::Models::UpdateDataMaskRuleDetails) —

The information to be updated.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

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

The client request ID for tracing.

Returns:

(Response) —

A Response object with data of type DataMaskRule

# File 'lib/oci/cloud_guard/cloud_guard_client.rb', line 7720

def update_data_mask_rule(data_mask_rule_id, update_data_mask_rule_details, opts = {})
  logger.debug 'Calling operation CloudGuardClient#update_data_mask_rule.' if logger

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

  path = '/dataMaskRules/{dataMaskRuleId}'.sub('{dataMaskRuleId}', data_mask_rule_id.to_s)
  operation_signing_strategy = :standard

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

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_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_mask_rule_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'CloudGuardClient#update_data_mask_rule') do
    @api_client.call_api(
      :PUT,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::CloudGuard::Models::DataMaskRule'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_detector_recipe(detector_recipe_id, update_detector_recipe_details, opts = {}) ⇒ `Response`

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/cloudguard/update_detector_recipe.rb.html) to see an example of how to use update_detector_recipe API.

Updates a detector recipe identified by detectorRecipeId

Parameters:

detector_recipe_id (String) —

DetectorRecipe OCID
update_detector_recipe_details (OCI::CloudGuard::Models::UpdateDetectorRecipeDetails) —

Details for the DetectorRecipe to be updated
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

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

The client request ID for tracing.
:opc_retry_token (String) —

A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. 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 DetectorRecipe

# File 'lib/oci/cloud_guard/cloud_guard_client.rb', line 7789

def update_detector_recipe(detector_recipe_id, update_detector_recipe_details, opts = {})
  logger.debug 'Calling operation CloudGuardClient#update_detector_recipe.' if logger

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

  path = '/detectorRecipes/{detectorRecipeId}'.sub('{detectorRecipeId}', detector_recipe_id.to_s)
  operation_signing_strategy = :standard

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

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_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_detector_recipe_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'CloudGuardClient#update_detector_recipe') 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::CloudGuard::Models::DetectorRecipe'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_detector_recipe_detector_rule(detector_recipe_id, detector_rule_id, update_detector_recipe_detector_rule_details, opts = {}) ⇒ `Response`

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/cloudguard/update_detector_recipe_detector_rule.rb.html) to see an example of how to use update_detector_recipe_detector_rule API.

Update the DetectorRule by identifier

Parameters:

detector_recipe_id (String) —

DetectorRecipe OCID
detector_rule_id (String) —

The key of Detector Rule.
update_detector_recipe_detector_rule_details (OCI::CloudGuard::Models::UpdateDetectorRecipeDetectorRuleDetails) —

The details to be updated for DetectorRule.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

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

The client request ID for tracing.

Returns:

(Response) —

A Response object with data of type DetectorRecipeDetectorRule

# File 'lib/oci/cloud_guard/cloud_guard_client.rb', line 7855

def update_detector_recipe_detector_rule(detector_recipe_id, detector_rule_id, update_detector_recipe_detector_rule_details, opts = {})
  logger.debug 'Calling operation CloudGuardClient#update_detector_recipe_detector_rule.' if logger

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

  path = '/detectorRecipes/{detectorRecipeId}/detectorRules/{detectorRuleId}'.sub('{detectorRecipeId}', detector_recipe_id.to_s).sub('{detectorRuleId}', detector_rule_id.to_s)
  operation_signing_strategy = :standard

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

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_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_detector_recipe_detector_rule_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'CloudGuardClient#update_detector_recipe_detector_rule') do
    @api_client.call_api(
      :PUT,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::CloudGuard::Models::DetectorRecipeDetectorRule'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_managed_list(managed_list_id, update_managed_list_details, opts = {}) ⇒ `Response`

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/cloudguard/update_managed_list.rb.html) to see an example of how to use update_managed_list API.

Updates a managed list identified by managedListId

Parameters:

managed_list_id (String) —

The cloudguard list OCID to be passed in the request.
update_managed_list_details (OCI::CloudGuard::Models::UpdateManagedListDetails) —

Details for the ManagedList to be updated
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

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

The client request ID for tracing.
:opc_retry_token (String) —

A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. 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 ManagedList

# File 'lib/oci/cloud_guard/cloud_guard_client.rb', line 7926

def update_managed_list(managed_list_id, update_managed_list_details, opts = {})
  logger.debug 'Calling operation CloudGuardClient#update_managed_list.' if logger

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

  path = '/managedLists/{managedListId}'.sub('{managedListId}', managed_list_id.to_s)
  operation_signing_strategy = :standard

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

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_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_managed_list_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'CloudGuardClient#update_managed_list') 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::CloudGuard::Models::ManagedList'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_problem_status(problem_id, update_problem_status_details, opts = {}) ⇒ `Response`

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/cloudguard/update_problem_status.rb.html) to see an example of how to use update_problem_status API.

updates the problem details

Parameters:

problem_id (String) —

OCId of the problem.
update_problem_status_details (OCI::CloudGuard::Models::UpdateProblemStatusDetails) —

The additional details for the problem.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

The client request ID for tracing.
:if_match (String) —

For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST 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 Problem

# File 'lib/oci/cloud_guard/cloud_guard_client.rb', line 7998

def update_problem_status(problem_id, update_problem_status_details, opts = {})
  logger.debug 'Calling operation CloudGuardClient#update_problem_status.' if logger

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

  path = '/problems/{problemId}/actions/updateStatus'.sub('{problemId}', problem_id.to_s)
  operation_signing_strategy = :standard

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

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'CloudGuardClient#update_problem_status') do
    @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::CloudGuard::Models::Problem'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_responder_recipe(responder_recipe_id, update_responder_recipe_details, opts = {}) ⇒ `Response`

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/cloudguard/update_responder_recipe.rb.html) to see an example of how to use update_responder_recipe API.

Update the ResponderRecipe resource by identifier

Parameters:

responder_recipe_id (String) —

OCID of ResponderRecipe
update_responder_recipe_details (OCI::CloudGuard::Models::UpdateResponderRecipeDetails) —

The details to be updated.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

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

The client request ID for tracing.

Returns:

(Response) —

A Response object with data of type ResponderRecipe

# File 'lib/oci/cloud_guard/cloud_guard_client.rb', line 8063

def update_responder_recipe(responder_recipe_id, update_responder_recipe_details, opts = {})
  logger.debug 'Calling operation CloudGuardClient#update_responder_recipe.' if logger

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

  path = '/responderRecipes/{responderRecipeId}'.sub('{responderRecipeId}', responder_recipe_id.to_s)
  operation_signing_strategy = :standard

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

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_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_responder_recipe_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'CloudGuardClient#update_responder_recipe') 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::CloudGuard::Models::ResponderRecipe'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_responder_recipe_responder_rule(responder_recipe_id, responder_rule_id, update_responder_recipe_responder_rule_details, opts = {}) ⇒ `Response`

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/cloudguard/update_responder_recipe_responder_rule.rb.html) to see an example of how to use update_responder_recipe_responder_rule API.

Update the ResponderRule by identifier

Parameters:

responder_recipe_id (String) —

OCID of ResponderRecipe
responder_rule_id (String) —

The id of ResponderRule
update_responder_recipe_responder_rule_details (OCI::CloudGuard::Models::UpdateResponderRecipeResponderRuleDetails) —

The details to be updated for ResponderRule.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

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

The client request ID for tracing.

Returns:

(Response) —

A Response object with data of type ResponderRecipeResponderRule

# File 'lib/oci/cloud_guard/cloud_guard_client.rb', line 8127

def update_responder_recipe_responder_rule(responder_recipe_id, responder_rule_id, update_responder_recipe_responder_rule_details, opts = {})
  logger.debug 'Calling operation CloudGuardClient#update_responder_recipe_responder_rule.' if logger

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

  path = '/responderRecipes/{responderRecipeId}/responderRules/{responderRuleId}'.sub('{responderRecipeId}', responder_recipe_id.to_s).sub('{responderRuleId}', responder_rule_id.to_s)
  operation_signing_strategy = :standard

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

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_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_responder_recipe_responder_rule_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'CloudGuardClient#update_responder_recipe_responder_rule') do
    @api_client.call_api(
      :PUT,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::CloudGuard::Models::ResponderRecipeResponderRule'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_security_recipe(security_recipe_id, update_security_recipe_details, opts = {}) ⇒ `Response`

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/cloudguard/update_security_recipe.rb.html) to see an example of how to use update_security_recipe API.

Updates a security zone recipe. A security zone recipe is a collection of security zone policies.

Parameters:

security_recipe_id (String) —

The unique identifier of the security zone recipe (`SecurityRecipe`)
update_security_recipe_details (OCI::CloudGuard::Models::UpdateSecurityRecipeDetails) —

The information to be updated in the security zone recipe.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

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

The client request ID for tracing.

Returns:

(Response) —

A Response object with data of type SecurityRecipe

# File 'lib/oci/cloud_guard/cloud_guard_client.rb', line 8192

def update_security_recipe(security_recipe_id, update_security_recipe_details, opts = {})
  logger.debug 'Calling operation CloudGuardClient#update_security_recipe.' if logger

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

  path = '/securityRecipes/{securityRecipeId}'.sub('{securityRecipeId}', security_recipe_id.to_s)
  operation_signing_strategy = :standard

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

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_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_recipe_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'CloudGuardClient#update_security_recipe') 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::CloudGuard::Models::SecurityRecipe'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_security_zone(security_zone_id, update_security_zone_details, opts = {}) ⇒ `Response`

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/cloudguard/update_security_zone.rb.html) to see an example of how to use update_security_zone API.

Updates the security zone identified by its id

Parameters:

security_zone_id (String) —

The unique identifier of the security zone (`SecurityZone`)
update_security_zone_details (OCI::CloudGuard::Models::UpdateSecurityZoneDetails) —

The security zone information to be updated.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

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

The client request ID for tracing.

Returns:

(Response) —

A Response object with data of type SecurityZone

# File 'lib/oci/cloud_guard/cloud_guard_client.rb', line 8255

def update_security_zone(security_zone_id, update_security_zone_details, opts = {})
  logger.debug 'Calling operation CloudGuardClient#update_security_zone.' if logger

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

  path = '/securityZones/{securityZoneId}'.sub('{securityZoneId}', security_zone_id.to_s)
  operation_signing_strategy = :standard

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

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_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_zone_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'CloudGuardClient#update_security_zone') 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::CloudGuard::Models::SecurityZone'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_target(target_id, update_target_details, opts = {}) ⇒ `Response`

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/cloudguard/update_target.rb.html) to see an example of how to use update_target API.

Updates a Target identified by targetId

Parameters:

target_id (String) —

OCID of target
update_target_details (OCI::CloudGuard::Models::UpdateTargetDetails) —

The information to be updated.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

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

The client request ID for tracing.

Returns:

(Response) —

A Response object with data of type Target

# File 'lib/oci/cloud_guard/cloud_guard_client.rb', line 8318

def update_target(target_id, update_target_details, opts = {})
  logger.debug 'Calling operation CloudGuardClient#update_target.' if logger

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

  path = '/targets/{targetId}'.sub('{targetId}', target_id.to_s)
  operation_signing_strategy = :standard

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

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_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_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'CloudGuardClient#update_target') 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::CloudGuard::Models::Target'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_target_detector_recipe(target_id, target_detector_recipe_id, update_target_detector_recipe_details, opts = {}) ⇒ `Response`

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/cloudguard/update_target_detector_recipe.rb.html) to see an example of how to use update_target_detector_recipe API.

Update the TargetDetectorRecipe resource by identifier

Parameters:

target_id (String) —

OCID of target
target_detector_recipe_id (String) —

OCID of TargetDetectorRecipe
update_target_detector_recipe_details (OCI::CloudGuard::Models::UpdateTargetDetectorRecipeDetails) —

The details to be updated.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

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

The client request ID for tracing.

Returns:

(Response) —

A Response object with data of type TargetDetectorRecipe

# File 'lib/oci/cloud_guard/cloud_guard_client.rb', line 8382

def update_target_detector_recipe(target_id, target_detector_recipe_id, update_target_detector_recipe_details, opts = {})
  logger.debug 'Calling operation CloudGuardClient#update_target_detector_recipe.' if logger

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

  path = '/targets/{targetId}/targetDetectorRecipes/{targetDetectorRecipeId}'.sub('{targetId}', target_id.to_s).sub('{targetDetectorRecipeId}', target_detector_recipe_id.to_s)
  operation_signing_strategy = :standard

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

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_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_detector_recipe_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'CloudGuardClient#update_target_detector_recipe') 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::CloudGuard::Models::TargetDetectorRecipe'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_target_detector_recipe_detector_rule(target_id, target_detector_recipe_id, detector_rule_id, update_target_detector_recipe_detector_rule_details, opts = {}) ⇒ `Response`

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/cloudguard/update_target_detector_recipe_detector_rule.rb.html) to see an example of how to use update_target_detector_recipe_detector_rule API.

Update the DetectorRule by identifier

Parameters:

target_id (String) —

OCID of target
target_detector_recipe_id (String) —

OCID of TargetDetectorRecipe
detector_rule_id (String) —

The id of DetectorRule
update_target_detector_recipe_detector_rule_details (OCI::CloudGuard::Models::UpdateTargetDetectorRecipeDetectorRuleDetails) —

The details to be updated for DetectorRule.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

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

The client request ID for tracing.

Returns:

(Response) —

A Response object with data of type TargetDetectorRecipeDetectorRule

# File 'lib/oci/cloud_guard/cloud_guard_client.rb', line 8449

def update_target_detector_recipe_detector_rule(target_id, target_detector_recipe_id, detector_rule_id, update_target_detector_recipe_detector_rule_details, opts = {})
  logger.debug 'Calling operation CloudGuardClient#update_target_detector_recipe_detector_rule.' if logger

  raise "Missing the required parameter 'target_id' when calling update_target_detector_recipe_detector_rule." if target_id.nil?
  raise "Missing the required parameter 'target_detector_recipe_id' when calling update_target_detector_recipe_detector_rule." if target_detector_recipe_id.nil?
  raise "Missing the required parameter 'detector_rule_id' when calling update_target_detector_recipe_detector_rule." if detector_rule_id.nil?
  raise "Missing the required parameter 'update_target_detector_recipe_detector_rule_details' when calling update_target_detector_recipe_detector_rule." if update_target_detector_recipe_detector_rule_details.nil?
  raise "Parameter value for 'target_id' must not be blank" if OCI::Internal::Util.blank_string?(target_id)
  raise "Parameter value for 'target_detector_recipe_id' must not be blank" if OCI::Internal::Util.blank_string?(target_detector_recipe_id)
  raise "Parameter value for 'detector_rule_id' must not be blank" if OCI::Internal::Util.blank_string?(detector_rule_id)

  path = '/targets/{targetId}/targetDetectorRecipes/{targetDetectorRecipeId}/detectorRules/{detectorRuleId}'.sub('{targetId}', target_id.to_s).sub('{targetDetectorRecipeId}', target_detector_recipe_id.to_s).sub('{detectorRuleId}', detector_rule_id.to_s)
  operation_signing_strategy = :standard

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

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_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_detector_recipe_detector_rule_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'CloudGuardClient#update_target_detector_recipe_detector_rule') do
    @api_client.call_api(
      :PUT,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::CloudGuard::Models::TargetDetectorRecipeDetectorRule'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_target_responder_recipe(target_id, target_responder_recipe_id, update_target_responder_recipe_details, opts = {}) ⇒ `Response`

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/cloudguard/update_target_responder_recipe.rb.html) to see an example of how to use update_target_responder_recipe API.

Update the TargetResponderRecipe resource by identifier

Parameters:

target_id (String) —

OCID of target
target_responder_recipe_id (String) —

OCID of TargetResponderRecipe
update_target_responder_recipe_details (OCI::CloudGuard::Models::UpdateTargetResponderRecipeDetails) —

The details to be updated.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

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

The client request ID for tracing.

Returns:

(Response) —

A Response object with data of type TargetResponderRecipe

# File 'lib/oci/cloud_guard/cloud_guard_client.rb', line 8517

def update_target_responder_recipe(target_id, target_responder_recipe_id, update_target_responder_recipe_details, opts = {})
  logger.debug 'Calling operation CloudGuardClient#update_target_responder_recipe.' if logger

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

  path = '/targets/{targetId}/targetResponderRecipes/{targetResponderRecipeId}'.sub('{targetId}', target_id.to_s).sub('{targetResponderRecipeId}', target_responder_recipe_id.to_s)
  operation_signing_strategy = :standard

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

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_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_responder_recipe_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'CloudGuardClient#update_target_responder_recipe') 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::CloudGuard::Models::TargetResponderRecipe'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_target_responder_recipe_responder_rule(target_id, target_responder_recipe_id, responder_rule_id, update_target_responder_recipe_responder_rule_details, opts = {}) ⇒ `Response`

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/cloudguard/update_target_responder_recipe_responder_rule.rb.html) to see an example of how to use update_target_responder_recipe_responder_rule API.

Update the ResponderRule by identifier

Parameters:

target_id (String) —

OCID of target
target_responder_recipe_id (String) —

OCID of TargetResponderRecipe
responder_rule_id (String) —

The id of ResponderRule
update_target_responder_recipe_responder_rule_details (OCI::CloudGuard::Models::UpdateTargetResponderRecipeResponderRuleDetails) —

The details to be updated for ResponderRule.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

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

The client request ID for tracing.

Returns:

(Response) —

A Response object with data of type TargetResponderRecipeResponderRule

# File 'lib/oci/cloud_guard/cloud_guard_client.rb', line 8584

def update_target_responder_recipe_responder_rule(target_id, target_responder_recipe_id, responder_rule_id, update_target_responder_recipe_responder_rule_details, opts = {})
  logger.debug 'Calling operation CloudGuardClient#update_target_responder_recipe_responder_rule.' if logger

  raise "Missing the required parameter 'target_id' when calling update_target_responder_recipe_responder_rule." if target_id.nil?
  raise "Missing the required parameter 'target_responder_recipe_id' when calling update_target_responder_recipe_responder_rule." if target_responder_recipe_id.nil?
  raise "Missing the required parameter 'responder_rule_id' when calling update_target_responder_recipe_responder_rule." if responder_rule_id.nil?
  raise "Missing the required parameter 'update_target_responder_recipe_responder_rule_details' when calling update_target_responder_recipe_responder_rule." if update_target_responder_recipe_responder_rule_details.nil?
  raise "Parameter value for 'target_id' must not be blank" if OCI::Internal::Util.blank_string?(target_id)
  raise "Parameter value for 'target_responder_recipe_id' must not be blank" if OCI::Internal::Util.blank_string?(target_responder_recipe_id)
  raise "Parameter value for 'responder_rule_id' must not be blank" if OCI::Internal::Util.blank_string?(responder_rule_id)

  path = '/targets/{targetId}/targetResponderRecipes/{targetResponderRecipeId}/responderRules/{responderRuleId}'.sub('{targetId}', target_id.to_s).sub('{targetResponderRecipeId}', target_responder_recipe_id.to_s).sub('{responderRuleId}', responder_rule_id.to_s)
  operation_signing_strategy = :standard

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

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_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_responder_recipe_responder_rule_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'CloudGuardClient#update_target_responder_recipe_responder_rule') do
    @api_client.call_api(
      :PUT,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::CloudGuard::Models::TargetResponderRecipeResponderRule'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

Overview

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) ⇒ CloudGuardClient

Instance Attribute Details

#api_client ⇒ OCI::ApiClient (readonly)

#endpoint ⇒ String (readonly)

#region ⇒ String

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

Instance Method Details

#add_compartment(security_zone_id, add_compartment_details, opts = {}) ⇒ Response

#change_detector_recipe_compartment(detector_recipe_id, change_detector_recipe_compartment_details, opts = {}) ⇒ Response

#change_managed_list_compartment(managed_list_id, change_managed_list_compartment_details, opts = {}) ⇒ Response

#change_responder_recipe_compartment(responder_recipe_id, change_responder_recipe_compartment_details, opts = {}) ⇒ Response

#change_security_recipe_compartment(security_recipe_id, change_security_recipe_compartment_details, opts = {}) ⇒ Response

#change_security_zone_compartment(security_zone_id, change_security_zone_compartment_details, opts = {}) ⇒ Response

#create_data_mask_rule(create_data_mask_rule_details, opts = {}) ⇒ Response

#create_detector_recipe(create_detector_recipe_details, opts = {}) ⇒ Response

#create_managed_list(create_managed_list_details, opts = {}) ⇒ Response

#create_responder_recipe(create_responder_recipe_details, opts = {}) ⇒ Response

#create_security_recipe(create_security_recipe_details, opts = {}) ⇒ Response

#create_security_zone(create_security_zone_details, opts = {}) ⇒ Response

#create_target(create_target_details, opts = {}) ⇒ Response

#create_target_detector_recipe(target_id, attach_target_detector_recipe_details, opts = {}) ⇒ Response

#create_target_responder_recipe(target_id, attach_target_responder_recipe_details, opts = {}) ⇒ Response

#delete_data_mask_rule(data_mask_rule_id, opts = {}) ⇒ Response

#delete_detector_recipe(detector_recipe_id, opts = {}) ⇒ Response

#delete_managed_list(managed_list_id, opts = {}) ⇒ Response

#delete_responder_recipe(responder_recipe_id, opts = {}) ⇒ Response

#delete_security_recipe(security_recipe_id, opts = {}) ⇒ Response

#delete_security_zone(security_zone_id, opts = {}) ⇒ Response

#delete_target(target_id, opts = {}) ⇒ Response

#delete_target_detector_recipe(target_id, target_detector_recipe_id, opts = {}) ⇒ Response

#delete_target_responder_recipe(target_id, target_responder_recipe_id, opts = {}) ⇒ Response

#execute_responder_execution(responder_execution_id, compartment_id, opts = {}) ⇒ Response

#get_condition_metadata_type(condition_metadata_type_id, opts = {}) ⇒ Response

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

#get_data_mask_rule(data_mask_rule_id, opts = {}) ⇒ Response

#get_detector(detector_id, opts = {}) ⇒ Response

#get_detector_recipe(detector_recipe_id, opts = {}) ⇒ Response

#get_detector_recipe_detector_rule(detector_recipe_id, detector_rule_id, opts = {}) ⇒ Response

#get_detector_rule(detector_id, detector_rule_id, opts = {}) ⇒ Response

#get_managed_list(managed_list_id, opts = {}) ⇒ Response

#get_problem(problem_id, opts = {}) ⇒ Response

#get_resource_profile(resource_profile_id, opts = {}) ⇒ Response

#get_responder_execution(responder_execution_id, opts = {}) ⇒ Response

#get_responder_recipe(responder_recipe_id, opts = {}) ⇒ Response

#get_responder_recipe_responder_rule(responder_recipe_id, responder_rule_id, opts = {}) ⇒ Response

#get_responder_rule(responder_rule_id, opts = {}) ⇒ Response

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

#get_security_recipe(security_recipe_id, opts = {}) ⇒ Response

#get_security_zone(security_zone_id, opts = {}) ⇒ Response

#get_sighting(sighting_id, opts = {}) ⇒ Response

#get_target(target_id, opts = {}) ⇒ Response

#get_target_detector_recipe(target_id, target_detector_recipe_id, opts = {}) ⇒ Response

#get_target_detector_recipe_detector_rule(target_id, target_detector_recipe_id, detector_rule_id, opts = {}) ⇒ Response

#get_target_responder_recipe(target_id, target_responder_recipe_id, opts = {}) ⇒ Response

#get_target_responder_recipe_responder_rule(target_id, target_responder_recipe_id, responder_rule_id, opts = {}) ⇒ Response

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

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

#list_detector_recipe_detector_rules(detector_recipe_id, compartment_id, opts = {}) ⇒ Response

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

#list_detector_rules(detector_id, compartment_id, opts = {}) ⇒ Response

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

#list_impacted_resources(problem_id, opts = {}) ⇒ Response

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

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

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

#list_problem_endpoints(problem_id, opts = {}) ⇒ Response

#list_problem_histories(compartment_id, problem_id, opts = {}) ⇒ Response

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

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

#list_resource_profile_endpoints(resource_profile_id, opts = {}) ⇒ Response

#list_resource_profile_impacted_resources(resource_profile_id, opts = {}) ⇒ Response

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

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

#list_responder_activities(problem_id, opts = {}) ⇒ Response

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

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

#api_client ⇒ `OCI::ApiClient` (readonly)

#endpoint ⇒ `String` (readonly)

#region ⇒ `String`

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

#add_compartment(security_zone_id, add_compartment_details, opts = {}) ⇒ `Response`

#change_detector_recipe_compartment(detector_recipe_id, change_detector_recipe_compartment_details, opts = {}) ⇒ `Response`

#change_managed_list_compartment(managed_list_id, change_managed_list_compartment_details, opts = {}) ⇒ `Response`

#change_responder_recipe_compartment(responder_recipe_id, change_responder_recipe_compartment_details, opts = {}) ⇒ `Response`

#change_security_recipe_compartment(security_recipe_id, change_security_recipe_compartment_details, opts = {}) ⇒ `Response`

#change_security_zone_compartment(security_zone_id, change_security_zone_compartment_details, opts = {}) ⇒ `Response`

#create_data_mask_rule(create_data_mask_rule_details, opts = {}) ⇒ `Response`

#create_detector_recipe(create_detector_recipe_details, opts = {}) ⇒ `Response`

#create_managed_list(create_managed_list_details, opts = {}) ⇒ `Response`

#create_responder_recipe(create_responder_recipe_details, opts = {}) ⇒ `Response`

#create_security_recipe(create_security_recipe_details, opts = {}) ⇒ `Response`

#create_security_zone(create_security_zone_details, opts = {}) ⇒ `Response`

#create_target(create_target_details, opts = {}) ⇒ `Response`

#create_target_detector_recipe(target_id, attach_target_detector_recipe_details, opts = {}) ⇒ `Response`

#create_target_responder_recipe(target_id, attach_target_responder_recipe_details, opts = {}) ⇒ `Response`

#delete_data_mask_rule(data_mask_rule_id, opts = {}) ⇒ `Response`

#delete_detector_recipe(detector_recipe_id, opts = {}) ⇒ `Response`

#delete_managed_list(managed_list_id, opts = {}) ⇒ `Response`

#delete_responder_recipe(responder_recipe_id, opts = {}) ⇒ `Response`

#delete_security_recipe(security_recipe_id, opts = {}) ⇒ `Response`

#delete_security_zone(security_zone_id, opts = {}) ⇒ `Response`

#delete_target(target_id, opts = {}) ⇒ `Response`

#delete_target_detector_recipe(target_id, target_detector_recipe_id, opts = {}) ⇒ `Response`

#delete_target_responder_recipe(target_id, target_responder_recipe_id, opts = {}) ⇒ `Response`

#execute_responder_execution(responder_execution_id, compartment_id, opts = {}) ⇒ `Response`

#get_condition_metadata_type(condition_metadata_type_id, opts = {}) ⇒ `Response`

#get_configuration(compartment_id, opts = {}) ⇒ `Response`

#get_data_mask_rule(data_mask_rule_id, opts = {}) ⇒ `Response`

#get_detector(detector_id, opts = {}) ⇒ `Response`

#get_detector_recipe(detector_recipe_id, opts = {}) ⇒ `Response`

#get_detector_recipe_detector_rule(detector_recipe_id, detector_rule_id, opts = {}) ⇒ `Response`

#get_detector_rule(detector_id, detector_rule_id, opts = {}) ⇒ `Response`

#get_managed_list(managed_list_id, opts = {}) ⇒ `Response`

#get_problem(problem_id, opts = {}) ⇒ `Response`

#get_resource_profile(resource_profile_id, opts = {}) ⇒ `Response`

#get_responder_execution(responder_execution_id, opts = {}) ⇒ `Response`

#get_responder_recipe(responder_recipe_id, opts = {}) ⇒ `Response`

#get_responder_recipe_responder_rule(responder_recipe_id, responder_rule_id, opts = {}) ⇒ `Response`

#get_responder_rule(responder_rule_id, opts = {}) ⇒ `Response`

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

#get_security_recipe(security_recipe_id, opts = {}) ⇒ `Response`

#get_security_zone(security_zone_id, opts = {}) ⇒ `Response`

#get_sighting(sighting_id, opts = {}) ⇒ `Response`

#get_target(target_id, opts = {}) ⇒ `Response`

#get_target_detector_recipe(target_id, target_detector_recipe_id, opts = {}) ⇒ `Response`

#get_target_detector_recipe_detector_rule(target_id, target_detector_recipe_id, detector_rule_id, opts = {}) ⇒ `Response`

#get_target_responder_recipe(target_id, target_responder_recipe_id, opts = {}) ⇒ `Response`

#get_target_responder_recipe_responder_rule(target_id, target_responder_recipe_id, responder_rule_id, opts = {}) ⇒ `Response`

#list_condition_metadata_types(compartment_id, opts = {}) ⇒ `Response`

#list_data_mask_rules(compartment_id, opts = {}) ⇒ `Response`

#list_detector_recipe_detector_rules(detector_recipe_id, compartment_id, opts = {}) ⇒ `Response`

#list_detector_recipes(compartment_id, opts = {}) ⇒ `Response`

#list_detector_rules(detector_id, compartment_id, opts = {}) ⇒ `Response`

#list_detectors(compartment_id, opts = {}) ⇒ `Response`

#list_impacted_resources(problem_id, opts = {}) ⇒ `Response`

#list_managed_list_types(compartment_id, opts = {}) ⇒ `Response`

#list_managed_lists(compartment_id, opts = {}) ⇒ `Response`

#list_policies(compartment_id, opts = {}) ⇒ `Response`

#list_problem_endpoints(problem_id, opts = {}) ⇒ `Response`

#list_problem_histories(compartment_id, problem_id, opts = {}) ⇒ `Response`

#list_problems(compartment_id, opts = {}) ⇒ `Response`

#list_recommendations(compartment_id, opts = {}) ⇒ `Response`

#list_resource_profile_endpoints(resource_profile_id, opts = {}) ⇒ `Response`

#list_resource_profile_impacted_resources(resource_profile_id, opts = {}) ⇒ `Response`

#list_resource_profiles(compartment_id, opts = {}) ⇒ `Response`

#list_resource_types(compartment_id, opts = {}) ⇒ `Response`

#list_responder_activities(problem_id, opts = {}) ⇒ `Response`

#list_responder_executions(compartment_id, opts = {}) ⇒ `Response`

#list_responder_recipe_responder_rules(responder_recipe_id, compartment_id, opts = {}) ⇒ `Response`

#list_responder_recipes(compartment_id, opts = {}) ⇒ `Response`

#list_responder_rules(compartment_id, opts = {}) ⇒ `Response`

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

#list_security_recipes(compartment_id, opts = {}) ⇒ `Response`

#list_security_zones(compartment_id, opts = {}) ⇒ `Response`

#list_sighting_endpoints(sighting_id, opts = {}) ⇒ `Response`