Class: OCI::CloudGuard::CloudGuardClient

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

Note:

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

Adds a compartment to an existing security zone (SecurityZone resource), identified by securityZoneId. Specify parameters in an AddCompartmentDetails resource that you pass. 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 resource).
add_compartment_details (OCI::CloudGuard::Models::AddCompartmentDetails) —

Parameters for an existing compartment to be added to a 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 131

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

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

Note:

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

Cancels a work request identified by workRequestId.

Parameters:

work_request_id (String) —

The ID of the asynchronous 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.

Returns:

(Response) —

A Response object with data of type nil

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

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

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

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

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

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

#change_data_source_compartment(data_source_id, change_data_source_compartment_details, opts = {}) ⇒ `Response`

Note:

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

Moves a data source (DataSource resource), identified by parameters passed in a ChangeDataSourceCompartmentDetails resource, from the current compartment to another.

Parameters:

data_source_id (String) —

Data source OCID.
change_data_source_compartment_details (OCI::CloudGuard::Models::ChangeDataSourceCompartmentDetails) —

The compartment OCID of the DataSource resource
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

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

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_data_source_compartment(data_source_id, change_data_source_compartment_details, opts = {})
  logger.debug 'Calling operation CloudGuardClient#change_data_source_compartment.' if logger

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

  path = '/dataSources/{dataSourceId}/actions/changeCompartment'.sub('{dataSourceId}', data_source_id.to_s)
  operation_signing_strategy = :standard

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

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

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

Note:

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

Moves the detector recipe (DetectorRecipe resource), identified by detectorRecipeId, from the current compartment to another compartment. When provided, If-Match is checked against etag values of the resource.

Parameters:

detector_recipe_id (String) —

Detector recipe OCID
change_detector_recipe_compartment_details (OCI::CloudGuard::Models::ChangeDetectorRecipeCompartmentDetails) —

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

the optional parameters

Options Hash (opts):

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

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

For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. 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 339

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 to see an example of how to use change_managed_list_compartment API.

Moves the managed list (ManagedList resource), identified by managedListId, from the current compartment to another compartment.

Parameters:

managed_list_id (String) —

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

The compartment OCID 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 409

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 to see an example of how to use change_responder_recipe_compartment API.

Moves the responder recipe (ResponderRecipe resource), identified by responderRecipeId in a ChangeResponderRecipeCompartmentDetails resource, from the current compartment to another compartment. When provided, if-match is checked against etag values of the resource.

Parameters:

responder_recipe_id (String) —

OCID of the responder recipe.
change_responder_recipe_compartment_details (OCI::CloudGuard::Models::ChangeResponderRecipeCompartmentDetails) —

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

the optional parameters

Options Hash (opts):

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

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

For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. 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 482

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_saved_query_compartment(saved_query_id, change_saved_query_compartment_details, opts = {}) ⇒ `Response`

Note:

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

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

Parameters:

saved_query_id (String) —

Saved query OCID
change_saved_query_compartment_details (OCI::CloudGuard::Models::ChangeSavedQueryCompartmentDetails) —

The compartment OCID of the SavedQuery resource
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

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

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 552

def change_saved_query_compartment(saved_query_id, change_saved_query_compartment_details, opts = {})
  logger.debug 'Calling operation CloudGuardClient#change_saved_query_compartment.' if logger

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

  path = '/savedQueries/{savedQueryId}/actions/changeCompartment'.sub('{savedQueryId}', saved_query_id.to_s)
  operation_signing_strategy = :standard

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

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

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'CloudGuardClient#change_saved_query_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 to see an example of how to use change_security_recipe_compartment API.

Moves the security recipe (SecurityRecipe resource), identified by securityRecipeId, from the current compartment to another 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 SecurityRecipe resource
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

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

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 625

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 to see an example of how to use change_security_zone_compartment API.

Moves a security zone, identified by securityZoneId, to a different compartment. Pass parameters through a ChangeSecurityZoneCompartmentDetails resource. 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 resource).
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 698

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_adhoc_query(create_adhoc_query_details, opts = {}) ⇒ `Response`

Note:

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

Creates a AdhocQuery resource.

Parameters:

create_adhoc_query_details (OCI::CloudGuard::Models::CreateAdhocQueryDetails) —

Details for the new AdhocQuery resource
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

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

The client request ID for tracing.

Returns:

(Response) —

A Response object with data of type AdhocQuery

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

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

  raise "Missing the required parameter 'create_adhoc_query_details' when calling create_adhoc_query." if create_adhoc_query_details.nil?

  path = '/adhocQueries'
  operation_signing_strategy = :standard

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

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

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

Note:

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

Creates a new DataMaskRule resource 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 824

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_data_source(create_data_source_details, opts = {}) ⇒ `Response`

Note:

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

Creates a data source (DataSource resource), using parameters passed through a CreateDataSourceDetails resource.

Parameters:

create_data_source_details (OCI::CloudGuard::Models::CreateDataSourceDetails) —

Details for the new DataSource resource
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

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

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 887

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

  raise "Missing the required parameter 'create_data_source_details' when calling create_data_source." if create_data_source_details.nil?

  path = '/dataSources'
  operation_signing_strategy = :standard

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

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

Note:

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

Creates a new DetectorRecipe resource.

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 948

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_detector_recipe_detector_rule(detector_recipe_id, create_detector_recipe_detector_rule_details, opts = {}) ⇒ `Response`

Note:

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

Creates a detector rule.

Parameters:

detector_recipe_id (String) —

Detector recipe OCID
create_detector_recipe_detector_rule_details (OCI::CloudGuard::Models::CreateDetectorRecipeDetectorRuleDetails) —

The details with which detector rule is to be created.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

Returns:

(Response) —

A Response object with data of type DetectorRecipeDetectorRule

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

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

  raise "Missing the required parameter 'detector_recipe_id' when calling create_detector_recipe_detector_rule." if detector_recipe_id.nil?
  raise "Missing the required parameter 'create_detector_recipe_detector_rule_details' when calling create_detector_recipe_detector_rule." if create_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)

  path = '/detectorRecipes/{detectorRecipeId}/detectorRules'.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]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(create_detector_recipe_detector_rule_details)

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

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

Note:

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

Creates a new ManagedList resource.

Parameters:

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

Details for the new ManagedList 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_retry_token (String) —

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

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 to see an example of how to use create_responder_recipe API.

Creates a responder recipe (ResponderRecipe resource), from values passed in a CreateResponderRecipeDetails resource.

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 1137

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_saved_query(create_saved_query_details, opts = {}) ⇒ `Response`

Note:

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

Creates a SavedQuery resource.

Parameters:

create_saved_query_details (OCI::CloudGuard::Models::CreateSavedQueryDetails) —

Details for the new SavedQuery resource
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

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

The client request ID for tracing.

Returns:

(Response) —

A Response object with data of type SavedQuery

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

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

  raise "Missing the required parameter 'create_saved_query_details' when calling create_saved_query." if create_saved_query_details.nil?

  path = '/savedQueries'
  operation_signing_strategy = :standard

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

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

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

Note:

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

Creates a security zone recipe (SecurityRecipe resource), using parameters passed in a CreateSecurityRecipeDetails resource.

Parameters:

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

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

the optional parameters

Options Hash (opts):

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

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

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

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 1262

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 to see an example of how to use create_security_zone API.

Creates a security zone (SecurityZone resource) for a compartment. Pass parameters through a CreateSecurityZoneDetails resource.

Parameters:

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

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

the optional parameters

Options Hash (opts):

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

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

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

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 1325

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 to see an example of how to use create_target API.

Creates a target (Target resource), using parameters passed in a CreateTargetDetails resource.

Parameters:

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

Contains generic target information which is required for all target types
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

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 to see an example of how to use create_target_detector_recipe API.

Attaches a DetectorRecipe to a target (Target resource) identified by targetId, using parameters passed in a TargetAttachTargetDetectorRecipeDetails resource. Attach a DetectorRecipe with the Target

Parameters:

target_id (String) —

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

Details for associating DetectorRecipe with 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 1452

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 to see an example of how to use create_target_responder_recipe API.

Attaches a responder recipe to a target.

Parameters:

target_id (String) —

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

Details for attaching a responder recipe to a 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 1517

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

#create_wlp_agent(create_wlp_agent_details, opts = {}) ⇒ `Response`

Note:

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

Creates and registers a WLP agent for an on-premise resource.

Parameters:

create_wlp_agent_details (OCI::CloudGuard::Models::CreateWlpAgentDetails) —

Details for the WLP agent to be created
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

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

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

  raise "Missing the required parameter 'create_wlp_agent_details' when calling create_wlp_agent." if create_wlp_agent_details.nil?

  path = '/wlpAgents'
  operation_signing_strategy = :standard

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

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

#delete_adhoc_query(adhoc_query_id, opts = {}) ⇒ `Response`

Note:

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

Deletes a AdhocQuery resource identified by adhocQueryId.

Parameters:

adhoc_query_id (String) —

Adhoc query 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 1649

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

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

  path = '/adhocQueries/{adhocQueryId}'.sub('{adhocQueryId}', adhoc_query_id.to_s)
  operation_signing_strategy = :standard

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

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

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

Note:

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

Deletes a DataMaskRule resource, identified by dataMaskRuleId.

Parameters:

data_mask_rule_id (String) —

OCID of the 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
:if_match (String) —

For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. 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 1711

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_data_source(data_source_id, opts = {}) ⇒ `Response`

Note:

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

Deletes a data source (DataSource resource) identified by dataSourceId.

Parameters:

data_source_id (String) —

Data source 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 1777

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

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

  path = '/dataSources/{dataSourceId}'.sub('{dataSourceId}', data_source_id.to_s)
  operation_signing_strategy = :standard

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

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_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_data_source') 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 to see an example of how to use delete_detector_recipe API.

Deletes a detector recipe (DetectorRecipe resource) identified by detectorRecipeId.

Parameters:

detector_recipe_id (String) —

Detector recipe 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 1845

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_detector_recipe_detector_rule(detector_recipe_id, detector_rule_id, opts = {}) ⇒ `Response`

Note:

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

Deletes the DetectorRecipeDetectorRule resource identified by detectorRuleId.

Parameters:

detector_recipe_id (String) —

Detector recipe OCID
detector_rule_id (String) —

The unique identifier of a 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
:if_match (String) —

For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. 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 1908

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

  raise "Missing the required parameter 'detector_recipe_id' when calling delete_detector_recipe_detector_rule." if detector_recipe_id.nil?
  raise "Missing the required parameter 'detector_rule_id' when calling delete_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[:'if-match'] = opts[: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_detector_recipe_detector_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_rule_data_source(detector_recipe_id, detector_rule_id, data_source_id, opts = {}) ⇒ `Response`

Note:

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

Deletes the DetectorRecipeDetectorRuleDataSource resource by identifier.

Parameters:

detector_recipe_id (String) —

Detector recipe OCID
detector_rule_id (String) —

The unique identifier of a detector rule.
data_source_id (String) —

Data source 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.

Returns:

(Response) —

A Response object with data of type nil

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

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

  raise "Missing the required parameter 'detector_recipe_id' when calling delete_detector_recipe_detector_rule_data_source." if detector_recipe_id.nil?
  raise "Missing the required parameter 'detector_rule_id' when calling delete_detector_recipe_detector_rule_data_source." if detector_rule_id.nil?
  raise "Missing the required parameter 'data_source_id' when calling delete_detector_recipe_detector_rule_data_source." if data_source_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)
  raise "Parameter value for 'data_source_id' must not be blank" if OCI::Internal::Util.blank_string?(data_source_id)

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

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

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[: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_detector_recipe_detector_rule_data_source') 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 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 managed 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 2042

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 to see an example of how to use delete_responder_recipe API.

Deletes a responder recipe (ResponderRecipe resource) identified by responderRecipeId.

Parameters:

responder_recipe_id (String) —

OCID of the responder 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 nil

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

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_saved_query(saved_query_id, opts = {}) ⇒ `Response`

Note:

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

Deletes a SavedQuery resource identified by savedQueryId.

Parameters:

saved_query_id (String) —

Saved query 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 2170

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

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

  path = '/savedQueries/{savedQueryId}'.sub('{savedQueryId}', saved_query_id.to_s)
  operation_signing_strategy = :standard

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

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_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_saved_query') 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 to see an example of how to use delete_security_recipe API.

Deletes a security zone recipe, identified by securityRecipeId. 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 2232

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 to see an example of how to use delete_security_zone API.

Deletes a security zone, identified by securityZoneId.

Parameters:

security_zone_id (String) —

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

the optional parameters

Options Hash (opts):

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

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

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

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 2292

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 to see an example of how to use delete_target API.

Deletes a target (Target resource) identified by targetId.

Parameters:

target_id (String) —

OCID of the 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 2352

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 to see an example of how to use delete_target_detector_recipe API.

Deletes the target detector recipe (TargetDetectorRecipe resource) identified by targetDetectorRecipeId, from a target (Target resource) identified by targetId.

Parameters:

target_id (String) —

OCID of the target
target_detector_recipe_id (String) —

OCID of the target detector 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 nil

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

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 to see an example of how to use delete_target_responder_recipe API.

Detaches a target responder recipe (TargetResponderRecipe resource) identified by targetResponderRecipeId, from a target (Target resource) identified by targetId.

Parameters:

target_id (String) —

OCID of the target
target_responder_recipe_id (String) —

OCID of the target responder 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 nil

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

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

#delete_wlp_agent(wlp_agent_id, opts = {}) ⇒ `Response`

Note:

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

Deletes and unregisters the WLP agent for an on-premise resource. x-obmcs-splat: routing: strategy: route-to-any-ad serviceList: [ 'cloudguard-cp-SPLAT_ENV' ] resources: wlpAgent: serviceResourceName: WlpAgent targetCompartmentId: downstream.getOr404('cloudguard-cp-SPLAT_ENV', 'GetWlpAgent', request.resourceId).compartmentId actionKind: delete resourceOcid: request.resourceId reconciliationCanStartAfterSecs: 30 permissions: [ "WLP_AGENT_DELETE" ] authorization: mode: automated check: resources.grantedPermissions.contains('WLP_AGENT_DELETE') allowCrossTenancy: true tagStore: mode: automated maximumAttemptCount: 3 throttling: perUserLimit: rpsLimit: 15 perTenantLimit: rpsLimit: 30 quotas: mode: automated search: mode: backfilling operationResourceName: wlpAgent lock: mode: test operationResourceName: wlpAgent

Parameters:

wlp_agent_id (String) —

WLP agent 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 2582

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

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

  path = '/wlpAgents/{wlpAgentId}'.sub('{wlpAgentId}', wlp_agent_id.to_s)
  operation_signing_strategy = :standard

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

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_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_wlp_agent') 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 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 unique identifier of the responder execution.
compartment_id (String) —

The OCID 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 2654

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_adhoc_query(adhoc_query_id, opts = {}) ⇒ `Response`

Note:

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

Returns an adhoc query identified by adhocQueryId.

Parameters:

adhoc_query_id (String) —

Adhoc query 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 AdhocQuery

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

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

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

  path = '/adhocQueries/{adhocQueryId}'.sub('{adhocQueryId}', adhoc_query_id.to_s)
  operation_signing_strategy = :standard

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

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_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_adhoc_query') do
    @api_client.call_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::AdhocQuery'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_adhoc_query_result_content(adhoc_query_id, opts = {}, &block) ⇒ `Response`

Note:

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

Downloads the results for a given adhoc ID (from includes results from all monitoring regions).

Parameters:

adhoc_query_id (String) —

Adhoc query OCID.
opts (Hash) (defaults to: {}) —

the optional parameters
[Block] (Hash) —

a customizable set of options

Options Hash (opts):

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

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

The client request ID for tracing.
:response_target (String, IO) —

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

Returns:

(Response) —

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

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

def get_adhoc_query_result_content(adhoc_query_id, opts = {}, &block)
  logger.debug 'Calling operation CloudGuardClient#get_adhoc_query_result_content.' if logger

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

  path = '/adhocQueries/{adhocQueryId}/results/content'.sub('{adhocQueryId}', adhoc_query_id.to_s)
  operation_signing_strategy = :standard

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

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

  post_body = nil

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

#get_condition_metadata_type(condition_metadata_type_id, opts = {}) ⇒ `Response`

Note:

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

Returns a ConditionMetatDataType resource with its details.

Parameters:

condition_metadata_type_id (String) —

The type of the condition metadata.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

Service type filter for the condition metadata.
:resource_type (String) —

Resource filter for the condition metadata.

Returns:

(Response) —

A Response object with data of type ConditionMetadataType

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

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 to see an example of how to use get_configuration API.

Returns the configuration details for a Cloud Guard tenancy, identified by root compartment OCID.

Parameters:

compartment_id (String) —

The OCID 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 2931

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 to see an example of how to use get_data_mask_rule API.

Returns a DataMaskRule resource, identified by dataMaskRuleId.

Parameters:

data_mask_rule_id (String) —

OCID of the 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_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 2985

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_data_source(data_source_id, opts = {}) ⇒ `Response`

Note:

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

Returns a data source (DataSource resource) identified by dataSourceId.

Parameters:

data_source_id (String) —

Data source 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 DataSource

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

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

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

  path = '/dataSources/{dataSourceId}'.sub('{dataSourceId}', data_source_id.to_s)
  operation_signing_strategy = :standard

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

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_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_source') do
    @api_client.call_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::DataSource'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

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

Note:

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

Returns a Detector resource, identified by detectorId.

Parameters:

detector_id (String) —

Detector name.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

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 to see an example of how to use get_detector_recipe API.

Returns a detector recipe (DetectorRecipe resource) identified by detectorRecipeId.

Parameters:

detector_recipe_id (String) —

Detector recipe 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 3148

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 to see an example of how to use get_detector_recipe_detector_rule API.

Returns a detector rule (DetectorRule resource) identified by detectorRuleId.

Parameters:

detector_recipe_id (String) —

Detector recipe OCID
detector_rule_id (String) —

The unique identifier of a 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 3203

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 to see an example of how to use get_detector_rule API.

Returns a detector rule (DetectorRule resource) identified by detectorRuleId.

Parameters:

detector_id (String) —

Detector name.
detector_rule_id (String) —

The unique identifier of a 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 3261

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 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 managed 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 3317

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 to see an example of how to use get_problem API.

Returns the Problem resource identified by problemId.

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 3371

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(resource_id, opts = {}) ⇒ `Response`

Note:

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

Returns a resource identified by resourceId

Parameters:

resource_id (String) —

CloudGuard resource 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 Resource

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

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

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

  path = '/resources/{resourceId}'.sub('{resourceId}', resource_id.to_s)
  operation_signing_strategy = :standard

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

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_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') do
    @api_client.call_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::Resource'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

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

Note:

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

Returns details for a resource profile, identified by resourceProfileId.

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 3479

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_resource_vulnerability(resource_id, vulnerability_key, opts = {}) ⇒ `Response`

Note:

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

Returns the vulnerability details associated with the cveId where resource is an instance

Parameters:

resource_id (String) —

CloudGuard resource OCID
vulnerability_key (String) —

CloudGuard vulnerability 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
:opc_request_id (String) —

The client request ID for tracing.

Returns:

(Response) —

A Response object with data of type ResourceVulnerability

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

def get_resource_vulnerability(resource_id, vulnerability_key, opts = {})
  logger.debug 'Calling operation CloudGuardClient#get_resource_vulnerability.' if logger

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

  path = '/resources/{resourceId}/vulnerabilities/{vulnerabilityKey}'.sub('{resourceId}', resource_id.to_s).sub('{vulnerabilityKey}', vulnerability_key.to_s)
  operation_signing_strategy = :standard

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

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

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'CloudGuardClient#get_resource_vulnerability') do
    @api_client.call_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::ResourceVulnerability'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

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

Note:

Click here 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 unique 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 3591

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 to see an example of how to use get_responder_recipe API.

Returns a responder recipe (ResponderRecipe resource) identified by responderRecipeId.

Parameters:

responder_recipe_id (String) —

OCID of the responder 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
: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 3645

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 to see an example of how to use get_responder_recipe_responder_rule API.

Returns a responder rule (ResponderRule resource) identified by responderRuleId.

Parameters:

responder_recipe_id (String) —

OCID of the responder recipe.
responder_rule_id (String) —

Unique identifier of the responder 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 ResponderRecipeResponderRule

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

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 to see an example of how to use get_responder_rule API.

Returns a responder rule (ResponderRule resource) identified by resonderRuleId.

Parameters:

responder_rule_id (String) —

Unique identifier of the responder 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 ResponderRule

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

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_saved_query(saved_query_id, opts = {}) ⇒ `Response`

Note:

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

Returns a SavedQuery resource identified by savedQueryId.

Parameters:

saved_query_id (String) —

Saved query 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 SavedQuery

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

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

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

  path = '/savedQueries/{savedQueryId}'.sub('{savedQueryId}', saved_query_id.to_s)
  operation_signing_strategy = :standard

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

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_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_saved_query') do
    @api_client.call_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::SavedQuery'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

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

Note:

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

Returns a security zone policy (SecurityPolicy resource), identified by its unique ID (securityPolicyId). When a policy is enabled in a security zone, then any action in the zone that attempts to violate that policy is blocked.

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 3867

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 to see an example of how to use get_security_recipe API.

Returns a security zone recipe (SecurityRecipe resource) identified by securityRecipeId.

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 3921

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 to see an example of how to use get_security_zone API.

Returns a security zone (SecurityZone resource) identified by securityZoneId.

Parameters:

security_zone_id (String) —

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

the optional parameters

Options Hash (opts):

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

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

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 3975

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 to see an example of how to use get_sighting API.

Returns a single sighting (Sighting resource) identified by sightingId.

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 4029

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 to see an example of how to use get_target API.

Returns a target (Target resource) identified by targetId.

Parameters:

target_id (String) —

OCID of the 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 4083

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 to see an example of how to use get_target_detector_recipe API.

Returns a target detector recipe (TargetDetectorRecipe resource) identified by targetDetectorRecipeId.

Parameters:

target_id (String) —

OCID of the target
target_detector_recipe_id (String) —

OCID of the target detector 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
: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 4138

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 to see an example of how to use get_target_detector_recipe_detector_rule API.

Returns DetectorRule resource by identified by targetDetectorRecipeId.

Parameters:

target_id (String) —

OCID of the target
target_detector_recipe_id (String) —

OCID of the target detector recipe.
detector_rule_id (String) —

The unique identifier of the 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 TargetDetectorRecipeDetectorRule

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

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 to see an example of how to use get_target_responder_recipe API.

Returns a target responder recipe (TargetResponderRecipe) identified by targetResponderRecipeId for a target (Target resource) identified by targetId.

Parameters:

target_id (String) —

OCID of the target
target_responder_recipe_id (String) —

OCID of the target responder 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
: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 4257

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 to see an example of how to use get_target_responder_recipe_responder_rule API.

Returns a responder rule (ResponderRule resource) identified by responderRuleId, from a target responder recipe (TargetResponderRecipe resource) identified by targetResponderRecipeId, attached to a target (Target resource) identified by targetId.

Parameters:

target_id (String) —

OCID of the target
target_responder_recipe_id (String) —

OCID of the target responder recipe.
responder_rule_id (String) —

Unique identifier of the responder 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 TargetResponderRecipeResponderRule

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

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

#get_wlp_agent(wlp_agent_id, opts = {}) ⇒ `Response`

Note:

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

Returns a WlpAgent resource for an on-premise resource identified by wlpAgentId.

Parameters:

wlp_agent_id (String) —

WLP agent 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 WlpAgent

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

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

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

  path = '/wlpAgents/{wlpAgentId}'.sub('{wlpAgentId}', wlp_agent_id.to_s)
  operation_signing_strategy = :standard

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

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_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_wlp_agent') do
    @api_client.call_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::WlpAgent'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

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

Note:

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

Returns details for a work request (WorkRequest resource) identified by workRequestId.

Parameters:

work_request_id (String) —

The ID of the asynchronous 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 WorkRequest

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

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

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

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

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

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

  post_body = nil

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

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

Note:

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

Returns a list of all adhoc queries (AdhocQuery resources) for a compartment identified by compartmentId. List is returned in a AdhocQueryCollection resource with page of AdhocQuerySummary resources.

The ListAdhocQueries operation returns only the adhoc queries 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 ListAdhocQueries 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 OCID 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
:adhoc_query_status (String) —

The status of the adhoc query created. Default value for state is provisioning. If no value is specified state is provisioning.
:time_started_filter_query_param (DateTime) —

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

End time for a filter. If end time is not specified, end time will be set to 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.
: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 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 (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 AdhocQueryCollection

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

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

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

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

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:adhocQueryStatus] = opts[:adhoc_query_status] if opts[:adhoc_query_status]
  query_params[:timeStartedFilterQueryParam] = opts[:time_started_filter_query_param] if opts[:time_started_filter_query_param]
  query_params[:timeEndedFilterQueryParam] = opts[:time_ended_filter_query_param] if opts[:time_ended_filter_query_param]
  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_adhoc_queries') do
    @api_client.call_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::AdhocQueryCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

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

Note:

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

Lists the results for a given adhoc ID (from includes results from all monitoring regions). Allowed values are: timeCreated, displayName

Parameters:

adhoc_query_id (String) —

Adhoc query OCID.
compartment_id (String) —

The OCID 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.
:sort_order (String) —

The sort order to use (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 AdhocQueryResultCollection

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

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

  raise "Missing the required parameter 'adhoc_query_id' when calling list_adhoc_query_results." if adhoc_query_id.nil?
  raise "Missing the required parameter 'compartment_id' when calling list_adhoc_query_results." 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
  raise "Parameter value for 'adhoc_query_id' must not be blank" if OCI::Internal::Util.blank_string?(adhoc_query_id)

  path = '/adhocQueries/{adhocQueryId}/results'.sub('{adhocQueryId}', adhoc_query_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_adhoc_query_results') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::CloudGuard::Models::AdhocQueryResultCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

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

Note:

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

Returns a list of ConditionMetadataType resources.

Allowed values are: timeCreated, displayName

Parameters:

compartment_id (String) —

The OCID 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 lifecycle 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 (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 4685

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 to see an example of how to use list_data_mask_rules API.

Returns a list of all DataMaskRule resources in the specified compartmentId (OCID) and its subcompartments.

Allowed values are: timeCreated, displayName

Parameters:

compartment_id (String) —

The OCID 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 lifecycle 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 (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 data mask rule (default to ENABLED)
:target_id (String) —

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

OCID of the IAM group (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 4776

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_data_source_events(data_source_id, opts = {}) ⇒ `Response`

Note:

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

Returns a list of data source events (DataSourceEventCollection resource) from the data source (DataSource resource) identified by dataSourceId.

Allowed values are: timeCreated

Parameters:

data_source_id (String) —

Data source 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
:region (String) —

A filter to return only resource where their region matches the given region.
:page (String) —

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

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

The sort order to use (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 DataSourceEventCollection

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

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

  raise "Missing the required parameter 'data_source_id' when calling list_data_source_events." if data_source_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 'data_source_id' must not be blank" if OCI::Internal::Util.blank_string?(data_source_id)

  path = '/dataSources/{dataSourceId}/events'.sub('{dataSourceId}', data_source_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:region] = opts[:region] if opts[:region]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:limit] = opts[:limit] if opts[:limit]
  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_data_source_events') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::CloudGuard::Models::DataSourceEventCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

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

Note:

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

Returns a list of all data sources (DataSource resources) for a compartment identified by compartmentId. List is returned in a DataSourceCollection resource with page of DataSourceSummary resources.

The ListAdhocQueries operation returns only the adhoc queries 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 ListAdhocQueries 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 OCID 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.
:data_source_feed_provider (String) —

A filter to return only resources when their feed provider matches the given feed provider (DataSourceFeedProvider resource).
:lifecycle_state (String) —

The field lifecycle 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.
:logging_query_type (String) —

A filter to return only resources where their query type matches the given LoggingQueryType.
: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 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 (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 DataSourceCollection

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

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

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

  if opts[:data_source_feed_provider] && !OCI::CloudGuard::Models::DATA_SOURCE_FEED_PROVIDER_ENUM.include?(opts[:data_source_feed_provider])
    raise 'Invalid value for "data_source_feed_provider", must be one of the values in OCI::CloudGuard::Models::DATA_SOURCE_FEED_PROVIDER_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[:logging_query_type] && !OCI::CloudGuard::Models::LOGGING_QUERY_TYPE_ENUM.include?(opts[:logging_query_type])
    raise 'Invalid value for "logging_query_type", must be one of the values in OCI::CloudGuard::Models::LOGGING_QUERY_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 = '/dataSources'
  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[:dataSourceFeedProvider] = opts[:data_source_feed_provider] if opts[:data_source_feed_provider]
  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[:loggingQueryType] = opts[:logging_query_type] if opts[:logging_query_type]
  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_data_sources') do
    @api_client.call_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::DataSourceCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

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

Note:

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

Returns a list of detector rules (DetectorRule resources) for a detector recipe (DetectorRecipe resource), identified by detectorRecipeId.

Allowed values are: displayName, riskLevel

Parameters:

detector_recipe_id (String) —

Detector recipe OCID
compartment_id (String) —

The OCID 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 lifecycle 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 (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 5075

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 to see an example of how to use list_detector_recipes API.

Returns a list of all detector recipes (DetectorRecipe resources) in a compartment, identified by compartmentId.

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 OCID 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 is returned. (default to false)
:lifecycle_state (String) —

The field lifecycle 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 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 (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 5188

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 to see an example of how to use list_detector_rules API.

Returns a list of detector rules for the DetectorRecipe resource identified by detectorId.

Allowed values are: timeCreated, displayName

Parameters:

detector_id (String) —

Detector name.
compartment_id (String) —

The OCID 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 lifecycle 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 (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 5277

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 to see an example of how to use list_detectors API.

Returns a detector catalog (DetectorCollection resource) with a list of DetectorSummary resources.

Allowed values are: timeCreated, displayName

Parameters:

compartment_id (String) —

The OCID 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 lifecycle 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 (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 5359

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 to see an example of how to use list_impacted_resources API.

Returns a list of impacted resources for a problem identified by problemId.

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 (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 5437

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 to see an example of how to use list_managed_list_types API.

Returns all managed list types (listType parameter) that Cloud Guard supports. Allowed values are: displayName, riskLevel

Parameters:

compartment_id (String) —

The OCID 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 lifecycle 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 (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 5510

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 to see an example of how to use list_managed_lists API.

Returns a list of all ManagedList resources in a compartment, identified by compartmentId. 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 OCID 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 is returned. (default to false)
:lifecycle_state (String) —

The field lifecycle 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 managed list.
: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 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 (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 5620

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 to see an example of how to use list_policies API.

Returns the list of global policy statements (policy attributes) needed to fully enable Cloud Guard.

Allowed values are: timeCreated, displayName

Parameters:

compartment_id (String) —

The OCID 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 (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 5711

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 to see an example of how to use list_problem_endpoints API.

Returns a list of endpoints associated with a problem, identified by problemId.

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 (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 5784

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_entities(problem_id, opts = {}) ⇒ `Response`

Note:

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

Returns a list of entities for a 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
:page (String) —

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

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

The sort order to use (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 ProblemEntityCollection

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

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

  raise "Missing the required parameter 'problem_id' when calling list_problem_entities." 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}/entities'.sub('{problemId}', problem_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:limit] = opts[:limit] if opts[:limit]
  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_entities') do
    @api_client.call_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::ProblemEntityCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

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

Note:

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

Returns a list of actions taken on a problem.

Allowed values are: timeCreated

Parameters:

compartment_id (String) —

The OCID 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 (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 5931

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 to see an example of how to use list_problems API.

Returns a list of all Problems identified by Cloud Guard which are currently in the database and meet the filtering criteria.

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 OCID 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. (default to OPEN)
:lifecycle_state (String) —

The field lifecycle 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 or province of the problem.
:country (String) —

Country of the problem.
:label (String) —

User-defined 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.
: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 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 (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 6052

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 to see an example of how to use list_recommendations API.

Returns a list of recommendations (RecommendationSummaryCollection resource with a page of RecommendationSummary resources) for a specified compartment OCID.

Allowed values are: riskLevel, timeCreated

Parameters:

compartment_id (String) —

The OCID 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 (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 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 lifecycle 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 lifecycle state. Only one state can be provided. Default value for 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 6181

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_ports(resource_id, opts = {}) ⇒ `Response`

Note:

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

Returns the list of open ports associated with the resourceId where resource is an instance Allowed values are: timeCreated, displayName

Parameters:

resource_id (String) —

CloudGuard resource 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
:open_port (String) —

open port associated with the resource.
: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 (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 ResourcePortCollection

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

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

  raise "Missing the required parameter 'resource_id' when calling list_resource_ports." if resource_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
  raise "Parameter value for 'resource_id' must not be blank" if OCI::Internal::Util.blank_string?(resource_id)

  path = '/resources/{resourceId}/ports'.sub('{resourceId}', resource_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:openPort] = opts[:open_port] if opts[:open_port]
  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_ports') do
    @api_client.call_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::ResourcePortCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

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

Note:

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

Returns a list of endpoints (ResourceProfileEndpointCollection resource with a page of ResourceProfileEndpointSummary resources) for a resource profile identified by resourceProfileId.

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 (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 6346

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 to see an example of how to use list_resource_profile_impacted_resources API.

Returns a list of impacted resources (ResourceProfileImpactedResourceCollection resource with a page of ResourceProfileImpactedResourceSummary resources) for a resource profile identified by resourceProfileId.

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 (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 6421

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 to see an example of how to use list_resource_profiles API.

Returns a list of all resource profile summaries (ResourceProfileCollection resource with a page of ResourceProfileSummary resources) for a compartment, identified by compartmentId and filtered as specified.

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 OCID 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 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 (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 6528

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 to see an example of how to use list_resource_types API.

Returns a single ResourceTypeCollection resource, containing a list of resource types, identified by parameters specified.

Allowed values are: displayName, riskLevel

Parameters:

compartment_id (String) —

The OCID 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 lifecycle 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 (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 6619

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_resource_vulnerabilities(resource_id, opts = {}) ⇒ `Response`

Note:

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

Returns the list of vulnerabilities associated with the resourceId where resource is an instance Allowed values are: timeCreated, displayName

Parameters:

resource_id (String) —

CloudGuard resource 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
:cve_id (String) —

CVE ID associated with the resource.
:risk_level (String) —

Risk level of 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 (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 ResourceVulnerabilityCollection

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

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

  raise "Missing the required parameter 'resource_id' when calling list_resource_vulnerabilities." if resource_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
  raise "Parameter value for 'resource_id' must not be blank" if OCI::Internal::Util.blank_string?(resource_id)

  path = '/resources/{resourceId}/vulnerabilities'.sub('{resourceId}', resource_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:cveId] = opts[:cve_id] if opts[:cve_id]
  query_params[:riskLevel] = opts[:risk_level] if opts[:risk_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_resource_vulnerabilities') do
    @api_client.call_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::ResourceVulnerabilityCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

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

Note:

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

Returns a list of all resources in a compartment

The ListResources operation returns only the resources 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 ListResources 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 OCID 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
:target_id (String) —

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

OCI monitoring region.
:cvss_score (Integer) —

Cvss score associated with the resource.
:cvss_score_greater_than (Integer) —

Cvss score greater than associated with the resource.
:cvss_score_less_than (Integer) —

Cvss score less than associated with the resource.
:cve_id (String) —

CVE ID associated with the resource.
:risk_level (String) —

Risk level of the problem.
:risk_level_greater_than (String) —

To filter risk level greater than the one mentioned in query param
:risk_level_less_than (String) —

To filter risk level less than the one mentioned in query param
: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.
: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 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 (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 ResourceCollection

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

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

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

  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[: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 = '/resources'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:targetId] = opts[:target_id] if opts[:target_id]
  query_params[:region] = opts[:region] if opts[:region]
  query_params[:cvssScore] = opts[:cvss_score] if opts[:cvss_score]
  query_params[:cvssScoreGreaterThan] = opts[:cvss_score_greater_than] if opts[:cvss_score_greater_than]
  query_params[:cvssScoreLessThan] = opts[:cvss_score_less_than] if opts[:cvss_score_less_than]
  query_params[:cveId] = opts[:cve_id] if opts[:cve_id]
  query_params[:riskLevel] = opts[:risk_level] if opts[:risk_level]
  query_params[:riskLevelGreaterThan] = opts[:risk_level_greater_than] if opts[:risk_level_greater_than]
  query_params[:riskLevelLessThan] = opts[:risk_level_less_than] if opts[:risk_level_less_than]
  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[: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_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::ResourceCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

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

Note:

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

Returns a list of responder activities for a problem, identified by problemId, in a ResponderActivityCollection resource, with a page of ResponderActivitySummary resources.

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 (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 6911

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 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 OCID 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 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 unique identifier 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 (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 7009

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 to see an example of how to use list_responder_recipe_responder_rules API.

Returns a list of responder rules (ResponderRule resources in a responderRecipeResponderRuleCollection resource, with page of ResponderRuleSummary resources), for a responder recipe (ResponderRecipe resource), identified by responderRecipeId.

Allowed values are: displayName, riskLevel

Parameters:

responder_recipe_id (String) —

OCID of the responder recipe.
compartment_id (String) —

The OCID 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 lifecycle 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 (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 7115

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 to see an example of how to use list_responder_recipes API.

Returns a list (ResponderRecipeCollection resource, with a page of ResponderRecipeSummary resources) of all responder recipes (RespponderRecipe resources) in a compartment, identified by compartmentId. 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 OCID 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 is 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 lifecycle 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 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 (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 7228

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 to see an example of how to use list_responder_rules API.

Returns a list of responder rules for the ResponderRecipe resource identified by responderId. The list is contained in a ResponderRuleCollection resource with a page of ResponderRuleSummary resources.

Allowed values are: timeCreated, displayName

Parameters:

compartment_id (String) —

The OCID 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 lifecycle 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 (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 7318

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_saved_queries(compartment_id, opts = {}) ⇒ `Response`

Note:

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

Returns a list of saved queries run in a tenancy.

Allowed values are: timeCreated, displayName

Parameters:

compartment_id (String) —

The OCID 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)
: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 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 (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 SavedQueryCollection

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

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

  raise "Missing the required parameter 'compartment_id' when calling list_saved_queries." 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 displayName].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of timeCreated, displayName.'
  end

  path = '/savedQueries'
  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[: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_saved_queries') do
    @api_client.call_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::SavedQueryCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

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

Note:

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

Returns a list of security zone policies (SecurityPolicySummary resources), identified by compartmentId.

Allowed values are: timeCreated, displayName

Parameters:

compartment_id (String) —

The OCID 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 lifecycle 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 (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 7494

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 to see an example of how to use list_security_recipes API.

Returns a list of security zone recipes (SecurityRecipeSummary resources) in a compartment, identified by compartmentId.

Allowed values are: timeCreated, displayName

Parameters:

compartment_id (String) —

The OCID 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 lifecycle 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 (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 7578

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 to see an example of how to use list_security_zones API.

Returns a list of security zones (SecurityZone resources) in a compartment identified by compartmentId. List is contained in a page of SecurityZoneSummary resources.

Allowed values are: timeCreated, displayName

Parameters:

compartment_id (String) —

The OCID 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 lifecycle 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 resource).
:security_recipe_id (String) —

The unique identifier of the security zone recipe. (SecurityRecipe resource).
:is_required_security_zones_in_subtree (BOOLEAN) —

Is 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 (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 7664

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 to see an example of how to use list_sighting_endpoints API.

Returns sighting endpoints details in a SightingEndpointsCollection resource with a page of SightingEndpointSummary resources.

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 (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 7748

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 to see an example of how to use list_sighting_impacted_resources API.

Returns a list of impacted resources for a sighting, identified by sightingId, in a SightingImpactedResourceCollection resource with a page of SightingImpactedResourceSummary resources.

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 (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 7822

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 to see an example of how to use list_sightings API.

For the parameters passed, returns a list of sightings (SightingCollection resource) with a page of SightingSummary resources.

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 OCID 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 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 (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 7923

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 to see an example of how to use list_tactics API.

Returns a list of TacticSummary resources for a compartment, identified by compartmentId. Allowed values are: displayName

Parameters:

compartment_id (String) —

The OCID 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 lifecycle 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 (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 8006

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 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 the target
target_detector_recipe_id (String) —

OCID of the target detector recipe.
compartment_id (String) —

The OCID 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 lifecycle 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 (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 8088

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 to see an example of how to use list_target_detector_recipes API.

Returns a list of all target detector recipes (TargetDetectorRecipe resources) associated with a target (Target resource), identified by targetId. The list is contained in a TargetDetectorRecipeCollection resource with page of TargetDetectorRecipeSummary resources.

Allowed values are: timeCreated, displayName

Parameters:

target_id (String) —

OCID of the target
compartment_id (String) —

The OCID 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 lifecycle 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 (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 8176

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 to see an example of how to use list_target_responder_recipe_responder_rules API.

Returns a list of responder rules (ResponderRule resources) associated with a responder recipe (ResponderRecipe resource) attached to a Target. List is returned in a TargetResponderRecipeResponderRuleCollection resource with page of TargetResponderRecipeResponderRuleSummary resources.

Allowed values are: displayName, riskLevel

Parameters:

target_id (String) —

OCID of the target
target_responder_recipe_id (String) —

OCID of the target responder recipe.
compartment_id (String) —

The OCID 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 lifecycle 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 (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 8264

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 to see an example of how to use list_target_responder_recipes API.

Returns a list of summary information for all responder recipes (TargetResponderRecipeCollection resource, with a page of TargetResponderRecipeSummary resources) attached to a target identified by targetId, located in a compartment identified by compartmentId.

Allowed values are: timeCreated, displayName

Parameters:

target_id (String) —

OCID of the target
compartment_id (String) —

The OCID 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 lifecycle 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 (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 8352

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 to see an example of how to use list_targets API.

Returns a list of targets (TargetCollection resource with page of TargetSummary resources) for the target identified by compartmentId. By default, only the target associated with the compartment is returned. Setting compartmentIdInSubtree to true returns the entire hierarchy of targets in subcompartments.

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 targets in 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 OCID 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 lifecycle 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 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 (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 8465

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 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 OCID 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 lifecycle 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 (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 8553

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

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

Note:

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

Returns a list of WLP agents in a compartment.

Allowed values are: timeCreated, displayName

Parameters:

compartment_id (String) —

The OCID 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.
:sort_order (String) —

The sort order to use (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 WlpAgentCollection

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

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

  raise "Missing the required parameter 'compartment_id' when calling list_wlp_agents." 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 = '/wlpAgents'
  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_wlp_agents') do
    @api_client.call_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::WlpAgentCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

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

Note:

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

Returns a list of errors for a work request identified by workRequestId.

Parameters:

work_request_id (String) —

The ID of the asynchronous 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.
:page (String) —

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

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

The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. (default to timeCreated) Allowed values are: timeCreated
:sort_order (String) —

The sort order to use (default to ASC)

Returns:

(Response) —

A Response object with data of type WorkRequestErrorCollection

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

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

  raise "Missing the required parameter 'work_request_id' when calling list_work_request_errors." if work_request_id.nil?

  if opts[:sort_by] && !%w[timeCreated].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of timeCreated.'
  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
  raise "Parameter value for 'work_request_id' must not be blank" if OCI::Internal::Util.blank_string?(work_request_id)

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

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

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

  post_body = nil

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

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

Note:

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

Returns a paginated list (WorkRequestLogEntryCollection resource) of log entries for a request, identified by workRequestId.

Parameters:

work_request_id (String) —

The ID of the asynchronous 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.
:page (String) —

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

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

The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. (default to timeCreated) Allowed values are: timeCreated
:sort_order (String) —

The sort order to use (default to ASC)

Returns:

(Response) —

A Response object with data of type WorkRequestLogEntryCollection

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

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

  raise "Missing the required parameter 'work_request_id' when calling list_work_request_logs." if work_request_id.nil?

  if opts[:sort_by] && !%w[timeCreated].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of timeCreated.'
  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
  raise "Parameter value for 'work_request_id' must not be blank" if OCI::Internal::Util.blank_string?(work_request_id)

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

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

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

  post_body = nil

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

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

Note:

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

Returns a list of work requests (WorkRequestSummaryCollection resource), in a compartment identified by compartmentId.

Parameters:

compartment_id (String) —

The OCID 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
:status (String) —

A filter to return only resources their lifecycleState matches the given operation status (OperationStatus resource).
:resource_id (String) —

The ID of the resource affected by the work request.
:opc_request_id (String) —

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

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

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

The sort order to use (default to ASC)
:sort_by (String) —

The field to sort by. Only one sort order may be provided. Default order for timeAccepted is descending. (default to timeAccepted) Allowed values are: timeAccepted

Returns:

(Response) —

A Response object with data of type WorkRequestSummaryCollection

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

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

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

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

  path = '/workRequests'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:status] = opts[:status] if opts[:status]
  query_params[:resourceId] = opts[:resource_id] if opts[:resource_id]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:limit] = opts[:limit] if opts[:limit]
  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_work_requests') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::CloudGuard::Models::WorkRequestSummaryCollection'
    )
  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.



96
97
98

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

def logger
  @api_client.config.logger
end

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

Note:

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

Removes a compartment from a security zone (SecurityZone resource), identified by securityZoneId. Pass compartmentId of compartment to remove through a RemoveCompartmentDetails resource. 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 resource).
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 8942

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 to see an example of how to use request_risk_scores API.

Returns a page of RiskScoreAggregation resources for a compartment, identified by compartmentId.

Parameters:

compartment_id (String) —

The OCID 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 9004

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 to see an example of how to use request_security_score_summarized_trend API.

Returns a page of SecurityScoreTrendAggregation resources. These measure the number of resources examined across all regions and compare it with the number of problems detected.

Parameters:

compartment_id (String) —

The OCID 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 9066

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 to see an example of how to use request_security_scores API.

Returns a page of SecurityScoreAggregation resources. These measure the number of resources examined across all regions and compare it with the number of problems detected.

Parameters:

compartment_id (String) —

The OCID 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 9128

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 to see an example of how to use request_summarized_activity_problems API.

Returns the summary of problems generated by OCI Activity Detector rules, identified by parameters specified.

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 OCID 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 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 9217

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 to see an example of how to use request_summarized_problems API.

Returns the number of problems matching the key-value pairs in dimensionMap.

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 OCID 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 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 9308

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 to see an example of how to use request_summarized_responder_executions API.

Returns the number of responder executions, identified by parameters specified, in a page of ResponderExecutionAggregation resources.

Setting accessLevel 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). u201CNot Authorizedu201D is returned if user doesn't have access to at least one of the child compartments. When accessLevel is set to RESTRICTED, permissions are checked and no partial results are displayed. This is valid only when compartmentIdInSubtree is set to true.

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 OCID 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 responder 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 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 9415

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 to see an example of how to use request_summarized_risk_scores API.

DEPRECATED

Parameters:

compartment_id (String) —

The OCID 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 9511

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 to see an example of how to use request_summarized_security_scores API.

DEPRECATED

Parameters:

compartment_id (String) —

The OCID 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 9570

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 to see an example of how to use request_summarized_top_trend_resource_profile_risk_scores API.

Returns a list of resource profile risk score aggregation summaries (ResourceProfileRiskScoreAggregationSummaryCollection resource with a page of ResourceProfileRiskScoreAggregationSummary resources) for a specified compartment.

Allowed values are: riskScore, riskScoreGrowth, timeFirstDetected, timeLastDetected

Parameters:

compartment_id (String) —

The OCID 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 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 9650

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 to see an example of how to use request_summarized_trend_problems API.

Returns a ProblemTrendAggregationCollection resource for a compartment, identified by compartmentId, for the specified time period. The ProblemTrendAggregationCollection resource contains a list of ProblemTrendAggregation resources.

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 OCID 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 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 9748

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 to see an example of how to use request_summarized_trend_resource_risk_scores API.

Returns a summary of risk score trends in a ResourceRiskScoreAggregationCollection resource, with a page of ResourceRiskScoreAggregation resources, filtered by parameters that you specify in a RequestSummarizedTrendResourceRiskScoresDetailsresource.

Parameters:

request_summarized_trend_resource_risk_scores_details (OCI::CloudGuard::Models::RequestSummarizedTrendResourceRiskScoresDetails) —

The filter to fetch risk score trend
compartment_id (String) —

The OCID 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 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 9832

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 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 OCID 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 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 9925

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 to see an example of how to use request_summarized_trend_security_scores API.

DEPRECATED

Parameters:

compartment_id (String) —

The OCID 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 9994

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 to see an example of how to use skip_bulk_responder_execution API.

Skips the execution for a bulk of responder executions.

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 10052

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 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 unique identifier of the responder execution.
compartment_id (String) —

The OCID 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 10117

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 to see an example of how to use trigger_responder API.

Sends the problem identified by problemId to the responder engine, to be processed by rule thatu2019s identified by responderRuleId, in the TriggerResponderDetails resource thatu2019s passed.

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 10190

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 to see an example of how to use update_bulk_problem_status API.

Changes the status for all problems listed in the problemIds array, passed through the UpdateBulkProblemStatusDetails resource, from the current status to the status set in UpdateBulkProblemStatusDetails.

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 10248

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 to see an example of how to use update_configuration API.

Updates configuration details for a Cloud Guard tenancy, identified by root compartment OCID. The reporting region cannot be updated once created.

Parameters:

update_configuration_details (OCI::CloudGuard::Models::UpdateConfigurationDetails) —

Updates configuration details of Cloud Guard for a Tenancy.
compartment_id (String) —

The OCID 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 10315

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 to see an example of how to use update_data_mask_rule API.

Updates a data mask rule (DataMaskRule resource) identified by dataMaskRuleId.

Parameters:

data_mask_rule_id (String) —

OCID of the data mask rule
update_data_mask_rule_details (OCI::CloudGuard::Models::UpdateDataMaskRuleDetails) —

The data mask rule 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 10380

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_data_source(data_source_id, update_data_source_details, opts = {}) ⇒ `Response`

Note:

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

Updates a data source (DataSource resource) identified by dataSourceId, using values passed in an UpdateDataSourceDetails resource.

Parameters:

data_source_id (String) —

Data source OCID.
update_data_source_details (OCI::CloudGuard::Models::UpdateDataSourceDetails) —

Details for the DataSource resource 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 nil

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

def update_data_source(data_source_id, update_data_source_details, opts = {})
  logger.debug 'Calling operation CloudGuardClient#update_data_source.' if logger

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

  path = '/dataSources/{dataSourceId}'.sub('{dataSourceId}', data_source_id.to_s)
  operation_signing_strategy = :standard

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

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

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

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

Note:

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

Updates a detector recipe (DetectorRecipe resource) identified by detectorRecipeId.

Parameters:

detector_recipe_id (String) —

Detector recipe 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 10521

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 to see an example of how to use update_detector_recipe_detector_rule API.

Updates a detector rule (DetectorRule resource) identified by detectorRuleId.

Parameters:

detector_recipe_id (String) —

Detector recipe OCID
detector_rule_id (String) —

The unique identifier of a 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 10587

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 to see an example of how to use update_managed_list API.

Updates a ManagedList resource, identified by managedList.

Parameters:

managed_list_id (String) —

The managed list OCID to be passed in the request.
update_managed_list_details (OCI::CloudGuard::Models::UpdateManagedListDetails) —

Details for the ManagedList resource 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 10658

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 to see an example of how to use update_problem_status API.

Changes the current status of the problem, identified by problemId, to the status specified in the UpdateProblemStatusDetails resource that you pass.

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 10730

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 to see an example of how to use update_responder_recipe API.

Updates a responder recipe (ResponderRecipe resource) identified by responderRecipeId, passed in an UpdateResponderRecipeDetails resource.

Parameters:

responder_recipe_id (String) —

OCID of the responder recipe.
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 10797

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 to see an example of how to use update_responder_recipe_responder_rule API.

Updates a responder rule (ResponderRule resource) identified by responderRuleId, passed in a UpdateResponderRecipeResponderRuleDetails resource.

Parameters:

responder_recipe_id (String) —

OCID of the responder recipe.
responder_rule_id (String) —

Unique identifier of the responder rule.
update_responder_recipe_responder_rule_details (OCI::CloudGuard::Models::UpdateResponderRecipeResponderRuleDetails) —

The details to be updated for responder rule
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

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

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 10863

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_saved_query(saved_query_id, update_saved_query_details, opts = {}) ⇒ `Response`

Note:

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

Updates a saved query identified by savedQueryId.

Parameters:

saved_query_id (String) —

Saved query OCID
update_saved_query_details (OCI::CloudGuard::Models::UpdateSavedQueryDetails) —

Details for the SavedQuery resource 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 SavedQuery

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

def update_saved_query(saved_query_id, update_saved_query_details, opts = {})
  logger.debug 'Calling operation CloudGuardClient#update_saved_query.' if logger

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

  path = '/savedQueries/{savedQueryId}'.sub('{savedQueryId}', saved_query_id.to_s)
  operation_signing_strategy = :standard

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

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

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

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

Note:

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

Updates a security zone recipe (SecurityRecipe resource), identified by securityRecipeId, using parameters passed in an UpdateSecurityRecipeDetails resource.

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 11001

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 to see an example of how to use update_security_zone API.

Updates a security zone (SecurityZone resource) identified by securityZoneId. Pass parameters through an UpdateSecurityZoneDetails resource.

Parameters:

security_zone_id (String) —

The unique identifier of the security zone (SecurityZone resource).
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 11066

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 to see an example of how to use update_target API.

Updates a target (Target resource) identified by targetId, using parameters passed in an UpdateTargetDetails resource.

Parameters:

target_id (String) —

OCID of the 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 11131

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 to see an example of how to use update_target_detector_recipe API.

Updates a target detector recipe (TargtetDetectorRecipe resource) identified by targetDetectorRecipeId, using parameters passed in an UpdateTargetDetectorRecipeDetails resource.

Parameters:

target_id (String) —

OCID of the target
target_detector_recipe_id (String) —

OCID of the target detector recipe.
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 11197

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 to see an example of how to use update_target_detector_recipe_detector_rule API.

Updates the DetectorRule resource identified by targetDetectorRecipeId

Parameters:

target_id (String) —

OCID of the target
target_detector_recipe_id (String) —

OCID of the target detector recipe.
detector_rule_id (String) —

The unique identifier of the detector rule.
update_target_detector_recipe_detector_rule_details (OCI::CloudGuard::Models::UpdateTargetDetectorRecipeDetectorRuleDetails) —

The details to be updated for the 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
:if_match (String) —

For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. 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 11264

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 to see an example of how to use update_target_responder_recipe API.

Updates the target responder recipe (TargetResponderRecipe resource) identified by targetResponderRecipeId, attached to a target identified by targetId. Pass parameters for the update through an UpdateTargetResponderRecipeDetails resource.

Parameters:

target_id (String) —

OCID of the target
target_responder_recipe_id (String) —

OCID of the target responder recipe.
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 11336

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 to see an example of how to use update_target_responder_recipe_responder_rule API.

Updates a responder rule (ResponderRule resource) identified by responderRuleId, for a target responder recipe (TargetResponderRecipe resource) identified by targetResponderRecipeId, for a target (Target resource) identified by targetId. Parameters for the update are passed through an UpdateTargetResponderRecipeResponderRuleDetails resource.

Parameters:

target_id (String) —

OCID of the target
target_responder_recipe_id (String) —

OCID of the target responder recipe.
responder_rule_id (String) —

Unique identifier of the responder rule.
update_target_responder_recipe_responder_rule_details (OCI::CloudGuard::Models::UpdateTargetResponderRecipeResponderRuleDetails) —

The details to be updated for the ResponderRule resource.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

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

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 11408

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

#update_wlp_agent(wlp_agent_id, update_wlp_agent_details, opts = {}) ⇒ `Response`

Note:

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

Updates and renews the certificate for an on-premise WLP agent identified by wlpAgentId.

Parameters:

wlp_agent_id (String) —

WLP agent OCID.
update_wlp_agent_details (OCI::CloudGuard::Models::UpdateWlpAgentDetails) —

Details for the WlpAgent resource 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 WlpAgent

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

def update_wlp_agent(wlp_agent_id, update_wlp_agent_details, opts = {})
  logger.debug 'Calling operation CloudGuardClient#update_wlp_agent.' if logger

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

  path = '/wlpAgents/{wlpAgentId}'.sub('{wlpAgentId}', wlp_agent_id.to_s)
  operation_signing_strategy = :standard

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

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

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

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

#change_data_source_compartment(data_source_id, change_data_source_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_saved_query_compartment(saved_query_id, change_saved_query_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_adhoc_query(create_adhoc_query_details, opts = {}) ⇒ Response

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

#create_data_source(create_data_source_details, opts = {}) ⇒ Response

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

#create_detector_recipe_detector_rule(detector_recipe_id, create_detector_recipe_detector_rule_details, opts = {}) ⇒ Response

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

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

#create_saved_query(create_saved_query_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

#create_wlp_agent(create_wlp_agent_details, opts = {}) ⇒ Response

#delete_adhoc_query(adhoc_query_id, opts = {}) ⇒ Response

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

#delete_data_source(data_source_id, opts = {}) ⇒ Response

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

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

#delete_detector_recipe_detector_rule_data_source(detector_recipe_id, detector_rule_id, data_source_id, opts = {}) ⇒ Response

#delete_managed_list(managed_list_id, opts = {}) ⇒ Response

#delete_responder_recipe(responder_recipe_id, opts = {}) ⇒ Response

#delete_saved_query(saved_query_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

#delete_wlp_agent(wlp_agent_id, opts = {}) ⇒ Response

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

#get_adhoc_query(adhoc_query_id, opts = {}) ⇒ Response

#get_adhoc_query_result_content(adhoc_query_id, opts = {}, &block) ⇒ 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_data_source(data_source_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(resource_id, opts = {}) ⇒ Response

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

#get_resource_vulnerability(resource_id, vulnerability_key, 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_saved_query(saved_query_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

#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`

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

#change_data_source_compartment(data_source_id, change_data_source_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_saved_query_compartment(saved_query_id, change_saved_query_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_adhoc_query(create_adhoc_query_details, opts = {}) ⇒ `Response`

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

#create_data_source(create_data_source_details, opts = {}) ⇒ `Response`

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

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

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

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

#create_saved_query(create_saved_query_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`

#create_wlp_agent(create_wlp_agent_details, opts = {}) ⇒ `Response`

#delete_adhoc_query(adhoc_query_id, opts = {}) ⇒ `Response`

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

#delete_data_source(data_source_id, opts = {}) ⇒ `Response`

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

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

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

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

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

#delete_saved_query(saved_query_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`

#delete_wlp_agent(wlp_agent_id, opts = {}) ⇒ `Response`

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

#get_adhoc_query(adhoc_query_id, opts = {}) ⇒ `Response`

#get_adhoc_query_result_content(adhoc_query_id, opts = {}, &block) ⇒ `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_data_source(data_source_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(resource_id, opts = {}) ⇒ `Response`

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

#get_resource_vulnerability(resource_id, vulnerability_key, 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_saved_query(saved_query_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`

#get_wlp_agent(wlp_agent_id, opts = {}) ⇒ `Response`

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

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

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

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

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

#list_data_source_events(data_source_id, opts = {}) ⇒ `Response`