Class: OCI::Opsi::OperationsInsightsClient

#add_exadata_insight_members(add_exadata_insight_members_details, exadata_insight_id, opts = {}) ⇒ `Response`

Note:

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

Add new members (e.g. databases and hosts) to an Exadata system in Operations Insights. Exadata-related metric collection and analysis will be started.

Parameters:

add_exadata_insight_members_details (OCI::Opsi::Models::AddExadataInsightMembersDetails) —

Details for the members (e.g. databases and hosts) of an Exadata system to be added in Operations Insights.
exadata_insight_id (String) —

Unique Exadata insight identifier
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

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

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
:opc_retry_token (String) —

A token that uniquely identifies a request that can be retried in case of a timeout or server error without risk of executing the same action again. Retry tokens expire after 24 hours.

Note: Retry tokens can be invalidated before the 24 hour time limit due to conflicting operations, such as a resource being deleted or purged from the system.

Returns:

(Response) —

A Response object with data of type nil

# File 'lib/oci/opsi/operations_insights_client.rb', line 127

def add_exadata_insight_members(add_exadata_insight_members_details, exadata_insight_id, opts = {})
  logger.debug 'Calling operation OperationsInsightsClient#add_exadata_insight_members.' if logger

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

  path = '/exadataInsights/{exadataInsightId}/actions/addMembers'.sub('{exadataInsightId}', exadata_insight_id.to_s)
  operation_signing_strategy = :standard

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

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

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'OperationsInsightsClient#add_exadata_insight_members') do
    @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_autonomous_database_insight_advanced_features(change_autonomous_database_insight_advanced_features_details, database_insight_id, opts = {}) ⇒ `Response`

Note:

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

Update connection detail for advanced features of Autonomous Database in Operations Insights.

Parameters:

change_autonomous_database_insight_advanced_features_details (OCI::Opsi::Models::ChangeAutonomousDatabaseInsightAdvancedFeaturesDetails) —

Details for the advanced features of Autonomous Database in Operations Insights.
database_insight_id (String) —

Unique database insight identifier
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

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

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
:opc_retry_token (String) —

A token that uniquely identifies a request that can be retried in case of a timeout or server error without risk of executing the same action again. Retry tokens expire after 24 hours.

Note: Retry tokens can be invalidated before the 24 hour time limit due to conflicting operations, such as a resource being deleted or purged from the system.

Returns:

(Response) —

A Response object with data of type nil

# File 'lib/oci/opsi/operations_insights_client.rb', line 198

def change_autonomous_database_insight_advanced_features(change_autonomous_database_insight_advanced_features_details, database_insight_id, opts = {})
  logger.debug 'Calling operation OperationsInsightsClient#change_autonomous_database_insight_advanced_features.' if logger

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

  path = '/databaseInsights/{databaseInsightId}/actions/changeAutonomousDatabaseInsightAdvancedFeatures'.sub('{databaseInsightId}', database_insight_id.to_s)
  operation_signing_strategy = :standard

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

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

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'OperationsInsightsClient#change_autonomous_database_insight_advanced_features') do
    @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_awr_hub_source_compartment(awr_hub_source_id, change_awr_hub_source_compartment_details, opts = {}) ⇒ `Response`

Note:

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

Moves an AwrHubSource resource from one compartment to another. When provided, If-Match is checked against ETag values of the resource.

Parameters:

awr_hub_source_id (String) —

Unique Awr Hub Source identifier
change_awr_hub_source_compartment_details (OCI::Opsi::Models::ChangeAwrHubSourceCompartmentDetails) —

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

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

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
:opc_retry_token (String) —

A token that uniquely identifies a request that can be retried in case of a timeout or server error without risk of executing the same action again. Retry tokens expire after 24 hours.

Note: Retry tokens can be invalidated before the 24 hour time limit due to conflicting operations, such as a resource being deleted or purged from the system.

Returns:

(Response) —

A Response object with data of type nil

# File 'lib/oci/opsi/operations_insights_client.rb', line 269

def change_awr_hub_source_compartment(awr_hub_source_id, change_awr_hub_source_compartment_details, opts = {})
  logger.debug 'Calling operation OperationsInsightsClient#change_awr_hub_source_compartment.' if logger

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

  path = '/awrHubSources/{awrHubSourceId}/actions/changeCompartment'.sub('{awrHubSourceId}', awr_hub_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_awr_hub_source_compartment_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'OperationsInsightsClient#change_awr_hub_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_database_insight_compartment(database_insight_id, change_database_insight_compartment_details, opts = {}) ⇒ `Response`

Note:

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

Moves a DatabaseInsight resource from one compartment identifier to another. When provided, If-Match is checked against ETag values of the resource.

Parameters:

database_insight_id (String) —

Unique database insight identifier
change_database_insight_compartment_details (OCI::Opsi::Models::ChangeDatabaseInsightCompartmentDetails) —

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

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

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
:opc_retry_token (String) —

A token that uniquely identifies a request that can be retried in case of a timeout or server error without risk of executing the same action again. Retry tokens expire after 24 hours.

Note: Retry tokens can be invalidated before the 24 hour time limit due to conflicting operations, such as a resource being deleted or purged from the system.

Returns:

(Response) —

A Response object with data of type nil

# File 'lib/oci/opsi/operations_insights_client.rb', line 340

def change_database_insight_compartment(database_insight_id, change_database_insight_compartment_details, opts = {})
  logger.debug 'Calling operation OperationsInsightsClient#change_database_insight_compartment.' if logger

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

  path = '/databaseInsights/{databaseInsightId}/actions/changeCompartment'.sub('{databaseInsightId}', database_insight_id.to_s)
  operation_signing_strategy = :standard

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

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

  post_body = @api_client.object_to_http_body(change_database_insight_compartment_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'OperationsInsightsClient#change_database_insight_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_enterprise_manager_bridge_compartment(enterprise_manager_bridge_id, change_enterprise_manager_bridge_compartment_details, opts = {}) ⇒ `Response`

Note:

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

Moves a EnterpriseManagerBridge resource from one compartment to another. When provided, If-Match is checked against ETag values of the resource.

Parameters:

enterprise_manager_bridge_id (String) —

Unique Enterprise Manager bridge identifier
change_enterprise_manager_bridge_compartment_details (OCI::Opsi::Models::ChangeEnterpriseManagerBridgeCompartmentDetails) —

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

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

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:

(Response) —

A Response object with data of type nil

# File 'lib/oci/opsi/operations_insights_client.rb', line 404

def change_enterprise_manager_bridge_compartment(enterprise_manager_bridge_id, change_enterprise_manager_bridge_compartment_details, opts = {})
  logger.debug 'Calling operation OperationsInsightsClient#change_enterprise_manager_bridge_compartment.' if logger

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

  path = '/enterpriseManagerBridges/{enterpriseManagerBridgeId}/actions/changeCompartment'.sub('{enterpriseManagerBridgeId}', enterprise_manager_bridge_id.to_s)
  operation_signing_strategy = :standard

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

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

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'OperationsInsightsClient#change_enterprise_manager_bridge_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_exadata_insight_compartment(exadata_insight_id, change_exadata_insight_compartment_details, opts = {}) ⇒ `Response`

Note:

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

Moves an Exadata insight resource from one compartment identifier to another. When provided, If-Match is checked against ETag values of the resource.

Parameters:

exadata_insight_id (String) —

Unique Exadata insight identifier
change_exadata_insight_compartment_details (OCI::Opsi::Models::ChangeExadataInsightCompartmentDetails) —

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

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

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
:opc_retry_token (String) —

A token that uniquely identifies a request that can be retried in case of a timeout or server error without risk of executing the same action again. Retry tokens expire after 24 hours.

Note: Retry tokens can be invalidated before the 24 hour time limit due to conflicting operations, such as a resource being deleted or purged from the system.

Returns:

(Response) —

A Response object with data of type nil

# File 'lib/oci/opsi/operations_insights_client.rb', line 473

def change_exadata_insight_compartment(exadata_insight_id, change_exadata_insight_compartment_details, opts = {})
  logger.debug 'Calling operation OperationsInsightsClient#change_exadata_insight_compartment.' if logger

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

  path = '/exadataInsights/{exadataInsightId}/actions/changeCompartment'.sub('{exadataInsightId}', exadata_insight_id.to_s)
  operation_signing_strategy = :standard

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

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

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'OperationsInsightsClient#change_exadata_insight_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_host_insight_compartment(host_insight_id, change_host_insight_compartment_details, opts = {}) ⇒ `Response`

Note:

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

Moves a HostInsight resource from one compartment identifier to another. When provided, If-Match is checked against ETag values of the resource.

Parameters:

host_insight_id (String) —

Unique host insight identifier
change_host_insight_compartment_details (OCI::Opsi::Models::ChangeHostInsightCompartmentDetails) —

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

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

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
:opc_retry_token (String) —

A token that uniquely identifies a request that can be retried in case of a timeout or server error without risk of executing the same action again. Retry tokens expire after 24 hours.

Note: Retry tokens can be invalidated before the 24 hour time limit due to conflicting operations, such as a resource being deleted or purged from the system.

Returns:

(Response) —

A Response object with data of type nil

# File 'lib/oci/opsi/operations_insights_client.rb', line 544

def change_host_insight_compartment(host_insight_id, change_host_insight_compartment_details, opts = {})
  logger.debug 'Calling operation OperationsInsightsClient#change_host_insight_compartment.' if logger

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

  path = '/hostInsights/{hostInsightId}/actions/changeCompartment'.sub('{hostInsightId}', host_insight_id.to_s)
  operation_signing_strategy = :standard

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

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

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'OperationsInsightsClient#change_host_insight_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_news_report_compartment(news_report_id, change_news_report_compartment_details, opts = {}) ⇒ `Response`

Note:

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

Moves a news report resource from one compartment identifier to another. When provided, If-Match is checked against ETag values of the resource.

Parameters:

news_report_id (String) —

Unique news report identifier.
change_news_report_compartment_details (OCI::Opsi::Models::ChangeNewsReportCompartmentDetails) —

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

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

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
:opc_retry_token (String) —

A token that uniquely identifies a request that can be retried in case of a timeout or server error without risk of executing the same action again. Retry tokens expire after 24 hours.

Note: Retry tokens can be invalidated before the 24 hour time limit due to conflicting operations, such as a resource being deleted or purged from the system.

Returns:

(Response) —

A Response object with data of type nil

# File 'lib/oci/opsi/operations_insights_client.rb', line 615

def change_news_report_compartment(news_report_id, change_news_report_compartment_details, opts = {})
  logger.debug 'Calling operation OperationsInsightsClient#change_news_report_compartment.' if logger

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

  path = '/newsReports/{newsReportId}/actions/changeCompartment'.sub('{newsReportId}', news_report_id.to_s)
  operation_signing_strategy = :standard

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

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

  post_body = @api_client.object_to_http_body(change_news_report_compartment_details)

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

#change_operations_insights_private_endpoint_compartment(operations_insights_private_endpoint_id, change_operations_insights_private_endpoint_compartment_details, opts = {}) ⇒ `Response`

Note:

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

Moves a private endpoint from one compartment to another. When provided, If-Match is checked against ETag values of the resource.

Parameters:

operations_insights_private_endpoint_id (String) —

The OCID of the Operation Insights private endpoint.
change_operations_insights_private_endpoint_compartment_details (OCI::Opsi::Models::ChangeOperationsInsightsPrivateEndpointCompartmentDetails) —

The details used to change the compartment of a private endpoint
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

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

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
:opc_retry_token (String) —

A token that uniquely identifies a request that can be retried in case of a timeout or server error without risk of executing the same action again. Retry tokens expire after 24 hours.

Note: Retry tokens can be invalidated before the 24 hour time limit due to conflicting operations, such as a resource being deleted or purged from the system.

Returns:

(Response) —

A Response object with data of type nil

# File 'lib/oci/opsi/operations_insights_client.rb', line 686

def change_operations_insights_private_endpoint_compartment(operations_insights_private_endpoint_id, change_operations_insights_private_endpoint_compartment_details, opts = {})
  logger.debug 'Calling operation OperationsInsightsClient#change_operations_insights_private_endpoint_compartment.' if logger

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

  path = '/operationsInsightsPrivateEndpoints/{operationsInsightsPrivateEndpointId}/actions/changeCompartment'.sub('{operationsInsightsPrivateEndpointId}', operations_insights_private_endpoint_id.to_s)
  operation_signing_strategy = :standard

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

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  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_operations_insights_private_endpoint_compartment_details)

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

#change_operations_insights_warehouse_compartment(operations_insights_warehouse_id, change_operations_insights_warehouse_compartment_details, opts = {}) ⇒ `Response`

Note:

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

Moves a Operations Insights Warehouse resource from one compartment to another. When provided, If-Match is checked against ETag values of the resource.

Parameters:

operations_insights_warehouse_id (String) —

Unique Operations Insights Warehouse identifier
change_operations_insights_warehouse_compartment_details (OCI::Opsi::Models::ChangeOperationsInsightsWarehouseCompartmentDetails) —

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

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

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
:opc_retry_token (String) —

A token that uniquely identifies a request that can be retried in case of a timeout or server error without risk of executing the same action again. Retry tokens expire after 24 hours.

Note: Retry tokens can be invalidated before the 24 hour time limit due to conflicting operations, such as a resource being deleted or purged from the system.

Returns:

(Response) —

A Response object with data of type nil

# File 'lib/oci/opsi/operations_insights_client.rb', line 757

def change_operations_insights_warehouse_compartment(operations_insights_warehouse_id, change_operations_insights_warehouse_compartment_details, opts = {})
  logger.debug 'Calling operation OperationsInsightsClient#change_operations_insights_warehouse_compartment.' if logger

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

  path = '/operationsInsightsWarehouses/{operationsInsightsWarehouseId}/actions/changeCompartment'.sub('{operationsInsightsWarehouseId}', operations_insights_warehouse_id.to_s)
  operation_signing_strategy = :standard

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

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

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'OperationsInsightsClient#change_operations_insights_warehouse_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_opsi_configuration_compartment(opsi_configuration_id, change_opsi_configuration_compartment_details, opts = {}) ⇒ `Response`

Note:

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

Moves an OpsiConfiguration resource from one compartment to another.

Parameters:

opsi_configuration_id (String) —

OCID of OPSI configuration resource.
change_opsi_configuration_compartment_details (OCI::Opsi::Models::ChangeOpsiConfigurationCompartmentDetails) —

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

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

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
:opc_retry_token (String) —

A token that uniquely identifies a request that can be retried in case of a timeout or server error without risk of executing the same action again. Retry tokens expire after 24 hours.

Note: Retry tokens can be invalidated before the 24 hour time limit due to conflicting operations, such as a resource being deleted or purged from the system.

Returns:

(Response) —

A Response object with data of type nil

# File 'lib/oci/opsi/operations_insights_client.rb', line 829

def change_opsi_configuration_compartment(opsi_configuration_id, change_opsi_configuration_compartment_details, opts = {})
  logger.debug 'Calling operation OperationsInsightsClient#change_opsi_configuration_compartment.' if logger

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

  path = '/opsiConfigurations/{opsiConfigurationId}/actions/changeCompartment'.sub('{opsiConfigurationId}', opsi_configuration_id.to_s)
  operation_signing_strategy = :standard

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

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

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'OperationsInsightsClient#change_opsi_configuration_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_pe_comanaged_database_insight(database_insight_id, change_pe_comanaged_database_insight_details, opts = {}) ⇒ `Response`

Note:

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

Change the connection details of a co-managed database insight. When provided, If-Match is checked against ETag values of the resource.

Parameters:

database_insight_id (String) —

Unique database insight identifier
change_pe_comanaged_database_insight_details (OCI::Opsi::Models::ChangePeComanagedDatabaseInsightDetails) —

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

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

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
:opc_retry_token (String) —

A token that uniquely identifies a request that can be retried in case of a timeout or server error without risk of executing the same action again. Retry tokens expire after 24 hours.

Note: Retry tokens can be invalidated before the 24 hour time limit due to conflicting operations, such as a resource being deleted or purged from the system.

Returns:

(Response) —

A Response object with data of type nil

# File 'lib/oci/opsi/operations_insights_client.rb', line 900

def change_pe_comanaged_database_insight(database_insight_id, change_pe_comanaged_database_insight_details, opts = {})
  logger.debug 'Calling operation OperationsInsightsClient#change_pe_comanaged_database_insight.' if logger

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

  path = '/databaseInsights/{databaseInsightId}/actions/changePeComanagedDatabaseInsightDetails'.sub('{databaseInsightId}', database_insight_id.to_s)
  operation_signing_strategy = :standard

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

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

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'OperationsInsightsClient#change_pe_comanaged_database_insight') do
    @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_awr_hub(create_awr_hub_details, opts = {}) ⇒ `Response`

Note:

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

Create a AWR hub resource for the tenant in Operations Insights. This resource will be created in root compartment.

Parameters:

create_awr_hub_details (OCI::Opsi::Models::CreateAwrHubDetails) —

Details using which an AWR hub resource will be created in Operations Insights.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

The retry configuration to apply to this operation. If no key is provided then the service-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 that can be retried in case of a timeout or server error without risk of executing the same action again. Retry tokens expire after 24 hours.

Note: Retry tokens can be invalidated before the 24 hour time limit due to conflicting operations, such as a resource being deleted or purged from the system.
:opc_request_id (String) —

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:

(Response) —

A Response object with data of type AwrHub

# File 'lib/oci/opsi/operations_insights_client.rb', line 968

def create_awr_hub(create_awr_hub_details, opts = {})
  logger.debug 'Calling operation OperationsInsightsClient#create_awr_hub.' if logger

  raise "Missing the required parameter 'create_awr_hub_details' when calling create_awr_hub." if create_awr_hub_details.nil?

  path = '/awrHubs'
  operation_signing_strategy = :standard

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

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'OperationsInsightsClient#create_awr_hub') do
    @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::Opsi::Models::AwrHub'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_awr_hub_source(create_awr_hub_source_details, opts = {}) ⇒ `Response`

Note:

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

Register Awr Hub source

Parameters:

create_awr_hub_source_details (OCI::Opsi::Models::CreateAwrHubSourceDetails) —

Payload containing details to register the source database
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

A token that uniquely identifies a request that can be retried in case of a timeout or server error without risk of executing the same action again. Retry tokens expire after 24 hours.

Note: Retry tokens can be invalidated before the 24 hour time limit due to conflicting operations, such as a resource being deleted or purged from the system.
:opc_request_id (String) —

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:

(Response) —

A Response object with data of type AwrHubSource

# File 'lib/oci/opsi/operations_insights_client.rb', line 1033

def create_awr_hub_source(create_awr_hub_source_details, opts = {})
  logger.debug 'Calling operation OperationsInsightsClient#create_awr_hub_source.' if logger

  raise "Missing the required parameter 'create_awr_hub_source_details' when calling create_awr_hub_source." if create_awr_hub_source_details.nil?

  path = '/awrHubSources'
  operation_signing_strategy = :standard

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

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'OperationsInsightsClient#create_awr_hub_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,
      return_type: 'OCI::Opsi::Models::AwrHubSource'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_database_insight(create_database_insight_details, opts = {}) ⇒ `Response`

Note:

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

Create a Database Insight resource for a database in Operations Insights. The database will be enabled in Operations Insights. Database metric collection and analysis will be started.

Parameters:

create_database_insight_details (OCI::Opsi::Models::CreateDatabaseInsightDetails) —

Details for the database for which a Database Insight resource will be created in Operations Insights.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

The retry configuration to apply to this operation. If no key is provided then the service-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 that can be retried in case of a timeout or server error without risk of executing the same action again. Retry tokens expire after 24 hours.

Note: Retry tokens can be invalidated before the 24 hour time limit due to conflicting operations, such as a resource being deleted or purged from the system.
:opc_request_id (String) —

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:

(Response) —

A Response object with data of type DatabaseInsight

# File 'lib/oci/opsi/operations_insights_client.rb', line 1098

def create_database_insight(create_database_insight_details, opts = {})
  logger.debug 'Calling operation OperationsInsightsClient#create_database_insight.' if logger

  raise "Missing the required parameter 'create_database_insight_details' when calling create_database_insight." if create_database_insight_details.nil?

  path = '/databaseInsights'
  operation_signing_strategy = :standard

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

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'OperationsInsightsClient#create_database_insight') do
    @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::Opsi::Models::DatabaseInsight'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_enterprise_manager_bridge(create_enterprise_manager_bridge_details, opts = {}) ⇒ `Response`

Note:

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

Create a Enterprise Manager bridge in Operations Insights.

Parameters:

create_enterprise_manager_bridge_details (OCI::Opsi::Models::CreateEnterpriseManagerBridgeDetails) —

Details for the Enterprise Manager bridge to be created in Operations Insights.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

The retry configuration to apply to this operation. If no key is provided then the service-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 that can be retried in case of a timeout or server error without risk of executing the same action again. Retry tokens expire after 24 hours.

Note: Retry tokens can be invalidated before the 24 hour time limit due to conflicting operations, such as a resource being deleted or purged from the system.
:opc_request_id (String) —

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:

(Response) —

A Response object with data of type EnterpriseManagerBridge

# File 'lib/oci/opsi/operations_insights_client.rb', line 1163

def create_enterprise_manager_bridge(create_enterprise_manager_bridge_details, opts = {})
  logger.debug 'Calling operation OperationsInsightsClient#create_enterprise_manager_bridge.' if logger

  raise "Missing the required parameter 'create_enterprise_manager_bridge_details' when calling create_enterprise_manager_bridge." if create_enterprise_manager_bridge_details.nil?

  path = '/enterpriseManagerBridges'
  operation_signing_strategy = :standard

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

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'OperationsInsightsClient#create_enterprise_manager_bridge') do
    @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::Opsi::Models::EnterpriseManagerBridge'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_exadata_insight(create_exadata_insight_details, opts = {}) ⇒ `Response`

Note:

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

Create an Exadata insight resource for an Exadata system in Operations Insights. The Exadata system will be enabled in Operations Insights. Exadata-related metric collection and analysis will be started.

Parameters:

create_exadata_insight_details (OCI::Opsi::Models::CreateExadataInsightDetails) —

Details for the Exadata system for which an Exadata insight resource will be created in Operations Insights.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

The retry configuration to apply to this operation. If no key is provided then the service-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 that can be retried in case of a timeout or server error without risk of executing the same action again. Retry tokens expire after 24 hours.

Note: Retry tokens can be invalidated before the 24 hour time limit due to conflicting operations, such as a resource being deleted or purged from the system.
:opc_request_id (String) —

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:

(Response) —

A Response object with data of type ExadataInsight

# File 'lib/oci/opsi/operations_insights_client.rb', line 1228

def create_exadata_insight(create_exadata_insight_details, opts = {})
  logger.debug 'Calling operation OperationsInsightsClient#create_exadata_insight.' if logger

  raise "Missing the required parameter 'create_exadata_insight_details' when calling create_exadata_insight." if create_exadata_insight_details.nil?

  path = '/exadataInsights'
  operation_signing_strategy = :standard

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

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'OperationsInsightsClient#create_exadata_insight') do
    @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::Opsi::Models::ExadataInsight'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_host_insight(create_host_insight_details, opts = {}) ⇒ `Response`

Note:

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

Create a Host Insight resource for a host in Operations Insights. The host will be enabled in Operations Insights. Host metric collection and analysis will be started.

Parameters:

create_host_insight_details (OCI::Opsi::Models::CreateHostInsightDetails) —

Details for the host for which a Host Insight resource will be created in Operations Insights.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

The retry configuration to apply to this operation. If no key is provided then the service-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 that can be retried in case of a timeout or server error without risk of executing the same action again. Retry tokens expire after 24 hours.

Note: Retry tokens can be invalidated before the 24 hour time limit due to conflicting operations, such as a resource being deleted or purged from the system.
:opc_request_id (String) —

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:

(Response) —

A Response object with data of type HostInsight

# File 'lib/oci/opsi/operations_insights_client.rb', line 1293

def create_host_insight(create_host_insight_details, opts = {})
  logger.debug 'Calling operation OperationsInsightsClient#create_host_insight.' if logger

  raise "Missing the required parameter 'create_host_insight_details' when calling create_host_insight." if create_host_insight_details.nil?

  path = '/hostInsights'
  operation_signing_strategy = :standard

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

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'OperationsInsightsClient#create_host_insight') do
    @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::Opsi::Models::HostInsight'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_news_report(create_news_report_details, opts = {}) ⇒ `Response`

Note:

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

Create a news report in Operations Insights. The report will be enabled in Operations Insights. Insights will be emailed as per selected frequency.

Parameters:

create_news_report_details (OCI::Opsi::Models::CreateNewsReportDetails) —

Details for the news report that will be created in Operations Insights.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

The retry configuration to apply to this operation. If no key is provided then the service-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 that can be retried in case of a timeout or server error without risk of executing the same action again. Retry tokens expire after 24 hours.

Note: Retry tokens can be invalidated before the 24 hour time limit due to conflicting operations, such as a resource being deleted or purged from the system.
:opc_request_id (String) —

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:

(Response) —

A Response object with data of type NewsReport

# File 'lib/oci/opsi/operations_insights_client.rb', line 1358

def create_news_report(create_news_report_details, opts = {})
  logger.debug 'Calling operation OperationsInsightsClient#create_news_report.' if logger

  raise "Missing the required parameter 'create_news_report_details' when calling create_news_report." if create_news_report_details.nil?

  path = '/newsReports'
  operation_signing_strategy = :standard

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

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

#create_operations_insights_private_endpoint(create_operations_insights_private_endpoint_details, opts = {}) ⇒ `Response`

Note:

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

Create a private endpoint resource for the tenant in Operations Insights. This resource will be created in customer compartment.

Parameters:

create_operations_insights_private_endpoint_details (OCI::Opsi::Models::CreateOperationsInsightsPrivateEndpointDetails) —

Details to create a new private endpoint.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

A token that uniquely identifies a request that can be retried in case of a timeout or server error without risk of executing the same action again. Retry tokens expire after 24 hours.

Note: Retry tokens can be invalidated before the 24 hour time limit due to conflicting operations, such as a resource being deleted or purged from the system.
:opc_request_id (String) —

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:

(Response) —

A Response object with data of type OperationsInsightsPrivateEndpoint

# File 'lib/oci/opsi/operations_insights_client.rb', line 1424

def create_operations_insights_private_endpoint(create_operations_insights_private_endpoint_details, opts = {})
  logger.debug 'Calling operation OperationsInsightsClient#create_operations_insights_private_endpoint.' if logger

  raise "Missing the required parameter 'create_operations_insights_private_endpoint_details' when calling create_operations_insights_private_endpoint." if create_operations_insights_private_endpoint_details.nil?

  path = '/operationsInsightsPrivateEndpoints'
  operation_signing_strategy = :standard

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

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

#create_operations_insights_warehouse(create_operations_insights_warehouse_details, opts = {}) ⇒ `Response`

Note:

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

Create a Operations Insights Warehouse resource for the tenant in Operations Insights. New ADW will be provisioned for this tenant. There is only expected to be 1 warehouse per tenant. The warehouse is expected to be in the root compartment. If the 'opsi-warehouse-type' header is passed to the API, a warehouse resource without ADW or Schema provisioning is created.

Parameters:

create_operations_insights_warehouse_details (OCI::Opsi::Models::CreateOperationsInsightsWarehouseDetails) —

Details using which an Operations Insights Warehouse resource will be created in Operations Insights.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

The retry configuration to apply to this operation. If no key is provided then the service-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 that can be retried in case of a timeout or server error without risk of executing the same action again. Retry tokens expire after 24 hours.

Note: Retry tokens can be invalidated before the 24 hour time limit due to conflicting operations, such as a resource being deleted or purged from the system.
:opc_request_id (String) —

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:

(Response) —

A Response object with data of type OperationsInsightsWarehouse

# File 'lib/oci/opsi/operations_insights_client.rb', line 1491

def create_operations_insights_warehouse(create_operations_insights_warehouse_details, opts = {})
  logger.debug 'Calling operation OperationsInsightsClient#create_operations_insights_warehouse.' if logger

  raise "Missing the required parameter 'create_operations_insights_warehouse_details' when calling create_operations_insights_warehouse." if create_operations_insights_warehouse_details.nil?

  path = '/operationsInsightsWarehouses'
  operation_signing_strategy = :standard

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

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'OperationsInsightsClient#create_operations_insights_warehouse') do
    @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::Opsi::Models::OperationsInsightsWarehouse'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_operations_insights_warehouse_user(create_operations_insights_warehouse_user_details, opts = {}) ⇒ `Response`

Note:

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

Create a Operations Insights Warehouse user resource for the tenant in Operations Insights. This resource will be created in root compartment.

Parameters:

create_operations_insights_warehouse_user_details (OCI::Opsi::Models::CreateOperationsInsightsWarehouseUserDetails) —

Parameter using which an Operations Insights Warehouse user resource will 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 that can be retried in case of a timeout or server error without risk of executing the same action again. Retry tokens expire after 24 hours.

Note: Retry tokens can be invalidated before the 24 hour time limit due to conflicting operations, such as a resource being deleted or purged from the system.
:opc_request_id (String) —

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:

(Response) —

A Response object with data of type OperationsInsightsWarehouseUser

# File 'lib/oci/opsi/operations_insights_client.rb', line 1557

def create_operations_insights_warehouse_user(create_operations_insights_warehouse_user_details, opts = {})
  logger.debug 'Calling operation OperationsInsightsClient#create_operations_insights_warehouse_user.' if logger

  raise "Missing the required parameter 'create_operations_insights_warehouse_user_details' when calling create_operations_insights_warehouse_user." if create_operations_insights_warehouse_user_details.nil?

  path = '/operationsInsightsWarehouseUsers'
  operation_signing_strategy = :standard

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

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'OperationsInsightsClient#create_operations_insights_warehouse_user') do
    @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::Opsi::Models::OperationsInsightsWarehouseUser'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_opsi_configuration(create_opsi_configuration_details, opts = {}) ⇒ `Response`

Note:

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

Create an OPSI configuration resource.

Allowed values are: configItems

Parameters:

create_opsi_configuration_details (OCI::Opsi::Models::CreateOpsiConfigurationDetails) —

Information about OPSI configuration resource 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 that can be retried in case of a timeout or server error without risk of executing the same action again. Retry tokens expire after 24 hours.

Note: Retry tokens can be invalidated before the 24 hour time limit due to conflicting operations, such as a resource being deleted or purged from the system.
:opc_request_id (String) —

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
:opsi_config_field (Array<String>) —

Optional fields to return as part of OpsiConfiguration object. Unless requested, these fields will not be returned by default. (default to [])
:config_item_custom_status (Array<String>) —

Specifies whether only customized configuration items or only non-customized configuration items or both have to be returned. By default only customized configuration items are returned. (default to [customized]) Allowed values are: customized, nonCustomized
:config_items_applicable_context (Array<String>) —

Returns the configuration items filtered by applicable contexts sent in this param. By default configuration items of all applicable contexts are returned. (default to [])
:config_item_field (Array<String>) —

Specifies the fields to return in a config item summary. (default to []) Allowed values are: name, value, defaultValue, metadata, applicableContexts

Returns:

(Response) —

A Response object with data of type OpsiConfiguration

# File 'lib/oci/opsi/operations_insights_client.rb', line 1633

def create_opsi_configuration(create_opsi_configuration_details, opts = {})
  logger.debug 'Calling operation OperationsInsightsClient#create_opsi_configuration.' if logger

  raise "Missing the required parameter 'create_opsi_configuration_details' when calling create_opsi_configuration." if create_opsi_configuration_details.nil?


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


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


  config_item_field_allowable_values = %w[name value defaultValue metadata applicableContexts]
  if opts[:config_item_field] && !opts[:config_item_field].empty?
    opts[:config_item_field].each do |val_to_check|
      unless config_item_field_allowable_values.include?(val_to_check)
        raise 'Invalid value for "config_item_field", must be one of name, value, defaultValue, metadata, applicableContexts.'
      end
    end
  end

  path = '/opsiConfigurations'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:opsiConfigField] = OCI::ApiClient.build_collection_params(opts[:opsi_config_field], :multi) if opts[:opsi_config_field] && !opts[:opsi_config_field].empty?
  query_params[:configItemCustomStatus] = OCI::ApiClient.build_collection_params(opts[:config_item_custom_status], :multi) if opts[:config_item_custom_status] && !opts[:config_item_custom_status].empty?
  query_params[:configItemsApplicableContext] = OCI::ApiClient.build_collection_params(opts[:config_items_applicable_context], :multi) if opts[:config_items_applicable_context] && !opts[:config_items_applicable_context].empty?
  query_params[:configItemField] = OCI::ApiClient.build_collection_params(opts[:config_item_field], :multi) if opts[:config_item_field] && !opts[:config_item_field].empty?

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

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

#delete_awr_hub(awr_hub_id, opts = {}) ⇒ `Response`

Note:

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

Deletes an AWR hub.

Parameters:

awr_hub_id (String) —

Unique Awr Hub identifier
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

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

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:

(Response) —

A Response object with data of type nil

# File 'lib/oci/opsi/operations_insights_client.rb', line 1728

def delete_awr_hub(awr_hub_id, opts = {})
  logger.debug 'Calling operation OperationsInsightsClient#delete_awr_hub.' if logger

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

  path = '/awrHubs/{awrHubId}'.sub('{awrHubId}', awr_hub_id.to_s)
  operation_signing_strategy = :standard

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

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

Note:

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

Deletes an Awr Hub object.

Parameters:

awr_hub_source_id (String) —

Unique Awr Hub Source identifier
object_name (String) —

Unique Awr Hub Object identifier
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

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

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:

(Response) —

A Response object with data of type nil

# File 'lib/oci/opsi/operations_insights_client.rb', line 1789

def delete_awr_hub_object(awr_hub_source_id, object_name, opts = {})
  logger.debug 'Calling operation OperationsInsightsClient#delete_awr_hub_object.' if logger

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

  path = '/awrHubObjects/awrHubSources/{awrHubSourceId}/o/{objectName}'.sub('{awrHubSourceId}', awr_hub_source_id.to_s).sub('{objectName}', object_name.to_s)
  operation_signing_strategy = :standard

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

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

Note:

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

Deletes an Awr Hub source object.

Parameters:

awr_hub_source_id (String) —

Unique Awr Hub Source identifier
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

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

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:

(Response) —

A Response object with data of type nil

# File 'lib/oci/opsi/operations_insights_client.rb', line 1851

def delete_awr_hub_source(awr_hub_source_id, opts = {})
  logger.debug 'Calling operation OperationsInsightsClient#delete_awr_hub_source.' if logger

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

  path = '/awrHubSources/{awrHubSourceId}'.sub('{awrHubSourceId}', awr_hub_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: 'OperationsInsightsClient#delete_awr_hub_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_database_insight(database_insight_id, opts = {}) ⇒ `Response`

Note:

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

Deletes a database insight. The database insight will be deleted and cannot be enabled again.

Parameters:

database_insight_id (String) —

Unique database insight identifier
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

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

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:

(Response) —

A Response object with data of type nil

# File 'lib/oci/opsi/operations_insights_client.rb', line 1911

def delete_database_insight(database_insight_id, opts = {})
  logger.debug 'Calling operation OperationsInsightsClient#delete_database_insight.' if logger

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

  path = '/databaseInsights/{databaseInsightId}'.sub('{databaseInsightId}', database_insight_id.to_s)
  operation_signing_strategy = :standard

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

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

Note:

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

Deletes an Operations Insights Enterprise Manager bridge. If any database insight is still referencing this bridge, the operation will fail.

Parameters:

enterprise_manager_bridge_id (String) —

Unique Enterprise Manager bridge identifier
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

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

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:

(Response) —

A Response object with data of type nil

# File 'lib/oci/opsi/operations_insights_client.rb', line 1971

def delete_enterprise_manager_bridge(enterprise_manager_bridge_id, opts = {})
  logger.debug 'Calling operation OperationsInsightsClient#delete_enterprise_manager_bridge.' if logger

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

  path = '/enterpriseManagerBridges/{enterpriseManagerBridgeId}'.sub('{enterpriseManagerBridgeId}', enterprise_manager_bridge_id.to_s)
  operation_signing_strategy = :standard

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

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

Note:

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

Deletes an Exadata insight. The Exadata insight will be deleted and cannot be enabled again.

Parameters:

exadata_insight_id (String) —

Unique Exadata insight identifier
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

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

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:

(Response) —

A Response object with data of type nil

# File 'lib/oci/opsi/operations_insights_client.rb', line 2031

def delete_exadata_insight(exadata_insight_id, opts = {})
  logger.debug 'Calling operation OperationsInsightsClient#delete_exadata_insight.' if logger

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

  path = '/exadataInsights/{exadataInsightId}'.sub('{exadataInsightId}', exadata_insight_id.to_s)
  operation_signing_strategy = :standard

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

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

Note:

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

Deletes a host insight. The host insight will be deleted and cannot be enabled again.

Parameters:

host_insight_id (String) —

Unique host insight identifier
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

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

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:

(Response) —

A Response object with data of type nil

# File 'lib/oci/opsi/operations_insights_client.rb', line 2091

def delete_host_insight(host_insight_id, opts = {})
  logger.debug 'Calling operation OperationsInsightsClient#delete_host_insight.' if logger

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

  path = '/hostInsights/{hostInsightId}'.sub('{hostInsightId}', host_insight_id.to_s)
  operation_signing_strategy = :standard

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

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

Note:

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

Deletes a news report. The news report will be deleted and cannot be enabled again.

Parameters:

news_report_id (String) —

Unique news report identifier.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

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

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:

(Response) —

A Response object with data of type nil

# File 'lib/oci/opsi/operations_insights_client.rb', line 2151

def delete_news_report(news_report_id, opts = {})
  logger.debug 'Calling operation OperationsInsightsClient#delete_news_report.' if logger

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

  path = '/newsReports/{newsReportId}'.sub('{newsReportId}', news_report_id.to_s)
  operation_signing_strategy = :standard

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

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

  post_body = nil

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

#delete_operations_insights_private_endpoint(operations_insights_private_endpoint_id, opts = {}) ⇒ `Response`

Note:

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

Deletes a private endpoint.

Parameters:

operations_insights_private_endpoint_id (String) —

The OCID of the Operation Insights private endpoint.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

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

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:

(Response) —

A Response object with data of type nil

# File 'lib/oci/opsi/operations_insights_client.rb', line 2211

def delete_operations_insights_private_endpoint(operations_insights_private_endpoint_id, opts = {})
  logger.debug 'Calling operation OperationsInsightsClient#delete_operations_insights_private_endpoint.' if logger

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

  path = '/operationsInsightsPrivateEndpoints/{operationsInsightsPrivateEndpointId}'.sub('{operationsInsightsPrivateEndpointId}', operations_insights_private_endpoint_id.to_s)
  operation_signing_strategy = :standard

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

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

  post_body = nil

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

#delete_operations_insights_warehouse(operations_insights_warehouse_id, opts = {}) ⇒ `Response`

Note:

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

Deletes an Operations Insights Warehouse. There is only expected to be 1 warehouse per tenant. The warehouse is expected to be in the root compartment. User must delete AWR Hub resource for this warehouse before calling this operation. User must delete the warehouse users before calling this operation.

Parameters:

operations_insights_warehouse_id (String) —

Unique Operations Insights Warehouse identifier
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

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

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:

(Response) —

A Response object with data of type nil

# File 'lib/oci/opsi/operations_insights_client.rb', line 2275

def delete_operations_insights_warehouse(operations_insights_warehouse_id, opts = {})
  logger.debug 'Calling operation OperationsInsightsClient#delete_operations_insights_warehouse.' if logger

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

  path = '/operationsInsightsWarehouses/{operationsInsightsWarehouseId}'.sub('{operationsInsightsWarehouseId}', operations_insights_warehouse_id.to_s)
  operation_signing_strategy = :standard

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

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

Note:

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

Deletes an Operations Insights Warehouse User.

Parameters:

operations_insights_warehouse_user_id (String) —

Unique Operations Insights Warehouse User identifier
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

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

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:

(Response) —

A Response object with data of type nil

# File 'lib/oci/opsi/operations_insights_client.rb', line 2335

def delete_operations_insights_warehouse_user(operations_insights_warehouse_user_id, opts = {})
  logger.debug 'Calling operation OperationsInsightsClient#delete_operations_insights_warehouse_user.' if logger

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

  path = '/operationsInsightsWarehouseUsers/{operationsInsightsWarehouseUserId}'.sub('{operationsInsightsWarehouseUserId}', operations_insights_warehouse_user_id.to_s)
  operation_signing_strategy = :standard

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

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

Note:

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

Deletes an OPSI configuration resource.

Parameters:

opsi_configuration_id (String) —

OCID of OPSI configuration resource.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

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

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:

(Response) —

A Response object with data of type nil

# File 'lib/oci/opsi/operations_insights_client.rb', line 2396

def delete_opsi_configuration(opsi_configuration_id, opts = {})
  logger.debug 'Calling operation OperationsInsightsClient#delete_opsi_configuration.' if logger

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

  path = '/opsiConfigurations/{opsiConfigurationId}'.sub('{opsiConfigurationId}', opsi_configuration_id.to_s)
  operation_signing_strategy = :standard

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

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

#disable_autonomous_database_insight_advanced_features(database_insight_id, opts = {}) ⇒ `Response`

Note:

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

Disable advanced features for an Autonomous Database in Operations Insights. The connection detail and advanced features will be removed.

Parameters:

database_insight_id (String) —

Unique database insight identifier
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

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

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
:opc_retry_token (String) —

A token that uniquely identifies a request that can be retried in case of a timeout or server error without risk of executing the same action again. Retry tokens expire after 24 hours.

Note: Retry tokens can be invalidated before the 24 hour time limit due to conflicting operations, such as a resource being deleted or purged from the system.

Returns:

(Response) —

A Response object with data of type nil

# File 'lib/oci/opsi/operations_insights_client.rb', line 2463

def disable_autonomous_database_insight_advanced_features(database_insight_id, opts = {})
  logger.debug 'Calling operation OperationsInsightsClient#disable_autonomous_database_insight_advanced_features.' if logger

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

  path = '/databaseInsights/{databaseInsightId}/actions/disableAutonomousDatabaseInsightAdvancedFeatures'.sub('{databaseInsightId}', database_insight_id.to_s)
  operation_signing_strategy = :standard

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

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

#disable_awr_hub_source(awr_hub_source_id, opts = {}) ⇒ `Response`

Note:

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

Disables a Awr Hub source database in Operations Insights. This will stop the Awr data flow for the given Awr Hub source.

Parameters:

awr_hub_source_id (String) —

Unique Awr Hub Source identifier
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

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

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
:opc_retry_token (String) —

A token that uniquely identifies a request that can be retried in case of a timeout or server error without risk of executing the same action again. Retry tokens expire after 24 hours.

Note: Retry tokens can be invalidated before the 24 hour time limit due to conflicting operations, such as a resource being deleted or purged from the system.

Returns:

(Response) —

A Response object with data of type nil

# File 'lib/oci/opsi/operations_insights_client.rb', line 2532

def disable_awr_hub_source(awr_hub_source_id, opts = {})
  logger.debug 'Calling operation OperationsInsightsClient#disable_awr_hub_source.' if logger

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

  path = '/awrHubSources/{awrHubSourceId}/actions/disable'.sub('{awrHubSourceId}', awr_hub_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: 'OperationsInsightsClient#disable_awr_hub_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

#disable_database_insight(database_insight_id, opts = {}) ⇒ `Response`

Note:

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

Disables a database in Operations Insights. Database metric collection and analysis will be stopped.

Parameters:

database_insight_id (String) —

Unique database insight identifier
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

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

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
:opc_retry_token (String) —

A token that uniquely identifies a request that can be retried in case of a timeout or server error without risk of executing the same action again. Retry tokens expire after 24 hours.

Note: Retry tokens can be invalidated before the 24 hour time limit due to conflicting operations, such as a resource being deleted or purged from the system.

Returns:

(Response) —

A Response object with data of type nil

# File 'lib/oci/opsi/operations_insights_client.rb', line 2601

def disable_database_insight(database_insight_id, opts = {})
  logger.debug 'Calling operation OperationsInsightsClient#disable_database_insight.' if logger

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

  path = '/databaseInsights/{databaseInsightId}/actions/disable'.sub('{databaseInsightId}', database_insight_id.to_s)
  operation_signing_strategy = :standard

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

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

#disable_exadata_insight(exadata_insight_id, opts = {}) ⇒ `Response`

Note:

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

Disables an Exadata system in Operations Insights. Exadata-related metric collection and analysis will be stopped.

Parameters:

exadata_insight_id (String) —

Unique Exadata insight identifier
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

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

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
:opc_retry_token (String) —

A token that uniquely identifies a request that can be retried in case of a timeout or server error without risk of executing the same action again. Retry tokens expire after 24 hours.

Note: Retry tokens can be invalidated before the 24 hour time limit due to conflicting operations, such as a resource being deleted or purged from the system.

Returns:

(Response) —

A Response object with data of type nil

# File 'lib/oci/opsi/operations_insights_client.rb', line 2670

def disable_exadata_insight(exadata_insight_id, opts = {})
  logger.debug 'Calling operation OperationsInsightsClient#disable_exadata_insight.' if logger

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

  path = '/exadataInsights/{exadataInsightId}/actions/disable'.sub('{exadataInsightId}', exadata_insight_id.to_s)
  operation_signing_strategy = :standard

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

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

#disable_host_insight(host_insight_id, opts = {}) ⇒ `Response`

Note:

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

Disables a host in Operations Insights. Host metric collection and analysis will be stopped.

Parameters:

host_insight_id (String) —

Unique host insight identifier
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

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

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
:opc_retry_token (String) —

A token that uniquely identifies a request that can be retried in case of a timeout or server error without risk of executing the same action again. Retry tokens expire after 24 hours.

Note: Retry tokens can be invalidated before the 24 hour time limit due to conflicting operations, such as a resource being deleted or purged from the system.

Returns:

(Response) —

A Response object with data of type nil

# File 'lib/oci/opsi/operations_insights_client.rb', line 2739

def disable_host_insight(host_insight_id, opts = {})
  logger.debug 'Calling operation OperationsInsightsClient#disable_host_insight.' if logger

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

  path = '/hostInsights/{hostInsightId}/actions/disable'.sub('{hostInsightId}', host_insight_id.to_s)
  operation_signing_strategy = :standard

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

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

#download_operations_insights_warehouse_wallet(operations_insights_warehouse_id, download_operations_insights_warehouse_wallet_details, opts = {}, &block) ⇒ `Response`

Note:

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

Download the ADW wallet for Operations Insights Warehouse using which the Hub data is exposed.

Parameters:

operations_insights_warehouse_id (String) —

Unique Operations Insights Warehouse identifier
download_operations_insights_warehouse_wallet_details (OCI::Opsi::Models::DownloadOperationsInsightsWarehouseWalletDetails) —

The information to be updated.
opts (Hash) (defaults to: {}) —

the optional parameters
[Block] (Hash) —

a customizable set of options

Options Hash (opts):

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

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

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
:opc_retry_token (String) —

A token that uniquely identifies a request that can be retried in case of a timeout or server error without risk of executing the same action again. Retry tokens expire after 24 hours.

Note: Retry tokens can be invalidated before the 24 hour time limit due to conflicting operations, such as a resource being deleted or purged from the system.
: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/opsi/operations_insights_client.rb', line 2807

def download_operations_insights_warehouse_wallet(operations_insights_warehouse_id, download_operations_insights_warehouse_wallet_details, opts = {}, &block)
  logger.debug 'Calling operation OperationsInsightsClient#download_operations_insights_warehouse_wallet.' if logger

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

  path = '/operationsInsightsWarehouses/{operationsInsightsWarehouseId}/actions/downloadWarehouseWallet'.sub('{operationsInsightsWarehouseId}', operations_insights_warehouse_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]
  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(download_operations_insights_warehouse_wallet_details)

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

#enable_autonomous_database_insight_advanced_features(enable_autonomous_database_insight_advanced_features_details, database_insight_id, opts = {}) ⇒ `Response`

Note:

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

Enables advanced features for an Autonomous Database in Operations Insights. A direct connection will be available for further collection.

Parameters:

enable_autonomous_database_insight_advanced_features_details (OCI::Opsi::Models::EnableAutonomousDatabaseInsightAdvancedFeaturesDetails) —

Connection Details for the Autonomous Database in Operations Insights.
database_insight_id (String) —

Unique database insight identifier
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

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

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
:opc_retry_token (String) —

A token that uniquely identifies a request that can be retried in case of a timeout or server error without risk of executing the same action again. Retry tokens expire after 24 hours.

Note: Retry tokens can be invalidated before the 24 hour time limit due to conflicting operations, such as a resource being deleted or purged from the system.

Returns:

(Response) —

A Response object with data of type nil

# File 'lib/oci/opsi/operations_insights_client.rb', line 2922

def enable_autonomous_database_insight_advanced_features(enable_autonomous_database_insight_advanced_features_details, database_insight_id, opts = {})
  logger.debug 'Calling operation OperationsInsightsClient#enable_autonomous_database_insight_advanced_features.' if logger

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

  path = '/databaseInsights/{databaseInsightId}/actions/enableAutonomousDatabaseInsightAdvancedFeatures'.sub('{databaseInsightId}', database_insight_id.to_s)
  operation_signing_strategy = :standard

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

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

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

#enable_awr_hub_source(awr_hub_source_id, opts = {}) ⇒ `Response`

Note:

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

Enables a Awr Hub source database in Operations Insights. This will resume the Awr data flow for the given Awr Hub source if it was stopped earlier.

Parameters:

awr_hub_source_id (String) —

Unique Awr Hub Source identifier
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

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

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
:opc_retry_token (String) —

A token that uniquely identifies a request that can be retried in case of a timeout or server error without risk of executing the same action again. Retry tokens expire after 24 hours.

Note: Retry tokens can be invalidated before the 24 hour time limit due to conflicting operations, such as a resource being deleted or purged from the system.

Returns:

(Response) —

A Response object with data of type nil

# File 'lib/oci/opsi/operations_insights_client.rb', line 2992

def enable_awr_hub_source(awr_hub_source_id, opts = {})
  logger.debug 'Calling operation OperationsInsightsClient#enable_awr_hub_source.' if logger

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

  path = '/awrHubSources/{awrHubSourceId}/actions/enable'.sub('{awrHubSourceId}', awr_hub_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: 'OperationsInsightsClient#enable_awr_hub_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

#enable_database_insight(enable_database_insight_details, database_insight_id, opts = {}) ⇒ `Response`

Note:

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

Enables a database in Operations Insights. Database metric collection and analysis will be started.

Parameters:

enable_database_insight_details (OCI::Opsi::Models::EnableDatabaseInsightDetails) —

Details for the database to be enabled in Operations Insights.
database_insight_id (String) —

Unique database insight identifier
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

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

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
:opc_retry_token (String) —

A token that uniquely identifies a request that can be retried in case of a timeout or server error without risk of executing the same action again. Retry tokens expire after 24 hours.

Note: Retry tokens can be invalidated before the 24 hour time limit due to conflicting operations, such as a resource being deleted or purged from the system.

Returns:

(Response) —

A Response object with data of type nil

# File 'lib/oci/opsi/operations_insights_client.rb', line 3062

def enable_database_insight(enable_database_insight_details, database_insight_id, opts = {})
  logger.debug 'Calling operation OperationsInsightsClient#enable_database_insight.' if logger

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

  path = '/databaseInsights/{databaseInsightId}/actions/enable'.sub('{databaseInsightId}', database_insight_id.to_s)
  operation_signing_strategy = :standard

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

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

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

#enable_exadata_insight(enable_exadata_insight_details, exadata_insight_id, opts = {}) ⇒ `Response`

Note:

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

Enables an Exadata system in Operations Insights. Exadata-related metric collection and analysis will be started.

Parameters:

enable_exadata_insight_details (OCI::Opsi::Models::EnableExadataInsightDetails) —

Details for the Exadata system to be enabled in Operations Insights.
exadata_insight_id (String) —

Unique Exadata insight identifier
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

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

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
:opc_retry_token (String) —

A token that uniquely identifies a request that can be retried in case of a timeout or server error without risk of executing the same action again. Retry tokens expire after 24 hours.

Note: Retry tokens can be invalidated before the 24 hour time limit due to conflicting operations, such as a resource being deleted or purged from the system.

Returns:

(Response) —

A Response object with data of type nil

# File 'lib/oci/opsi/operations_insights_client.rb', line 3133

def enable_exadata_insight(enable_exadata_insight_details, exadata_insight_id, opts = {})
  logger.debug 'Calling operation OperationsInsightsClient#enable_exadata_insight.' if logger

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

  path = '/exadataInsights/{exadataInsightId}/actions/enable'.sub('{exadataInsightId}', exadata_insight_id.to_s)
  operation_signing_strategy = :standard

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

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

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

#enable_host_insight(enable_host_insight_details, host_insight_id, opts = {}) ⇒ `Response`

Note:

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

Enables a host in Operations Insights. Host metric collection and analysis will be started.

Parameters:

enable_host_insight_details (OCI::Opsi::Models::EnableHostInsightDetails) —

Details for the host to be enabled in Operations Insights.
host_insight_id (String) —

Unique host insight identifier
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

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

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
:opc_retry_token (String) —

A token that uniquely identifies a request that can be retried in case of a timeout or server error without risk of executing the same action again. Retry tokens expire after 24 hours.

Note: Retry tokens can be invalidated before the 24 hour time limit due to conflicting operations, such as a resource being deleted or purged from the system.

Returns:

(Response) —

A Response object with data of type nil

# File 'lib/oci/opsi/operations_insights_client.rb', line 3204

def enable_host_insight(enable_host_insight_details, host_insight_id, opts = {})
  logger.debug 'Calling operation OperationsInsightsClient#enable_host_insight.' if logger

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

  path = '/hostInsights/{hostInsightId}/actions/enable'.sub('{hostInsightId}', host_insight_id.to_s)
  operation_signing_strategy = :standard

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

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

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'OperationsInsightsClient#enable_host_insight') do
    @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_awr_database_report(awr_hub_id, awr_source_database_identifier, opts = {}) ⇒ `Response`

Note:

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

Gets the AWR report for the specified database.

Parameters:

awr_hub_id (String) —

Unique Awr Hub identifier
awr_source_database_identifier (String) —

The internal ID of the database. The internal ID of the database is not the OCID. It can be retrieved from the following endpoint: /awrHubs/awrHubId/awrDatabases
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

The optional single value query parameter to filter by database instance number.
:begin_snapshot_identifier_greater_than_or_equal_to (Integer) —

The optional greater than or equal to filter on the snapshot ID.
:end_snapshot_identifier_less_than_or_equal_to (Integer) —

The optional less than or equal to query parameter to filter the snapshot Identifier.
:time_greater_than_or_equal_to (DateTime) —

The optional greater than or equal to query parameter to filter the timestamp. The timestamp format to be followed is: YYYY-MM-DDTHH:MM:SSZ, example 2020-12-03T19:00:53Z
:time_less_than_or_equal_to (DateTime) —

The optional less than or equal to query parameter to filter the timestamp. The timestamp format to be followed is: YYYY-MM-DDTHH:MM:SSZ, example 2020-12-03T19:00:53Z
:report_type (String) —

The query parameter to filter the AWR report types. (default to AWR) Allowed values are: AWR, ASH
:report_format (String) —

The format of the AWR report. (default to HTML) Allowed values are: HTML, TEXT
:opc_request_id (String) —

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:

(Response) —

A Response object with data of type AwrDatabaseReport

# File 'lib/oci/opsi/operations_insights_client.rb', line 3281

def get_awr_database_report(awr_hub_id, awr_source_database_identifier, opts = {})
  logger.debug 'Calling operation OperationsInsightsClient#get_awr_database_report.' if logger

  raise "Missing the required parameter 'awr_hub_id' when calling get_awr_database_report." if awr_hub_id.nil?
  raise "Missing the required parameter 'awr_source_database_identifier' when calling get_awr_database_report." if awr_source_database_identifier.nil?

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

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

  path = '/awrHubs/{awrHubId}/awrDatabaseReport'.sub('{awrHubId}', awr_hub_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:awrSourceDatabaseIdentifier] = awr_source_database_identifier
  query_params[:instanceNumber] = opts[:instance_number] if opts[:instance_number]
  query_params[:beginSnapshotIdentifierGreaterThanOrEqualTo] = opts[:begin_snapshot_identifier_greater_than_or_equal_to] if opts[:begin_snapshot_identifier_greater_than_or_equal_to]
  query_params[:endSnapshotIdentifierLessThanOrEqualTo] = opts[:end_snapshot_identifier_less_than_or_equal_to] if opts[:end_snapshot_identifier_less_than_or_equal_to]
  query_params[:timeGreaterThanOrEqualTo] = opts[:time_greater_than_or_equal_to] if opts[:time_greater_than_or_equal_to]
  query_params[:timeLessThanOrEqualTo] = opts[:time_less_than_or_equal_to] if opts[:time_less_than_or_equal_to]
  query_params[:reportType] = opts[:report_type] if opts[:report_type]
  query_params[:reportFormat] = opts[:report_format] if opts[:report_format]

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

  post_body = nil

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

#get_awr_database_sql_report(awr_hub_id, awr_source_database_identifier, sql_id, opts = {}) ⇒ `Response`

Note:

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

Gets the SQL health check report for one SQL of the specified database.

Parameters:

awr_hub_id (String) —

Unique Awr Hub identifier
awr_source_database_identifier (String) —

The internal ID of the database. The internal ID of the database is not the OCID. It can be retrieved from the following endpoint: /awrHubs/awrHubId/awrDatabases
sql_id (String) —

The parameter to filter SQL by ID. Note that the SQL ID is generated internally by Oracle for each SQL statement and can be retrieved from AWR Report API (/awrHubs/awrHubId/awrDbReport).
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

The optional single value query parameter to filter by database instance number.
:begin_snapshot_identifier_greater_than_or_equal_to (Integer) —

The optional greater than or equal to filter on the snapshot ID.
:end_snapshot_identifier_less_than_or_equal_to (Integer) —

The optional less than or equal to query parameter to filter the snapshot Identifier.
:time_greater_than_or_equal_to (DateTime) —

The optional greater than or equal to query parameter to filter the timestamp. The timestamp format to be followed is: YYYY-MM-DDTHH:MM:SSZ, example 2020-12-03T19:00:53Z
:time_less_than_or_equal_to (DateTime) —

The optional less than or equal to query parameter to filter the timestamp. The timestamp format to be followed is: YYYY-MM-DDTHH:MM:SSZ, example 2020-12-03T19:00:53Z
:report_format (String) —

The format of the AWR report. (default to HTML) Allowed values are: HTML, TEXT
:opc_request_id (String) —

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:

(Response) —

A Response object with data of type AwrDatabaseSqlReport

# File 'lib/oci/opsi/operations_insights_client.rb', line 3372

def get_awr_database_sql_report(awr_hub_id, awr_source_database_identifier, sql_id, opts = {})
  logger.debug 'Calling operation OperationsInsightsClient#get_awr_database_sql_report.' if logger

  raise "Missing the required parameter 'awr_hub_id' when calling get_awr_database_sql_report." if awr_hub_id.nil?
  raise "Missing the required parameter 'awr_source_database_identifier' when calling get_awr_database_sql_report." if awr_source_database_identifier.nil?
  raise "Missing the required parameter 'sql_id' when calling get_awr_database_sql_report." if sql_id.nil?

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

  path = '/awrHubs/{awrHubId}/awrDatabaseSqlReport'.sub('{awrHubId}', awr_hub_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:awrSourceDatabaseIdentifier] = awr_source_database_identifier
  query_params[:sqlId] = sql_id
  query_params[:instanceNumber] = opts[:instance_number] if opts[:instance_number]
  query_params[:beginSnapshotIdentifierGreaterThanOrEqualTo] = opts[:begin_snapshot_identifier_greater_than_or_equal_to] if opts[:begin_snapshot_identifier_greater_than_or_equal_to]
  query_params[:endSnapshotIdentifierLessThanOrEqualTo] = opts[:end_snapshot_identifier_less_than_or_equal_to] if opts[:end_snapshot_identifier_less_than_or_equal_to]
  query_params[:timeGreaterThanOrEqualTo] = opts[:time_greater_than_or_equal_to] if opts[:time_greater_than_or_equal_to]
  query_params[:timeLessThanOrEqualTo] = opts[:time_less_than_or_equal_to] if opts[:time_less_than_or_equal_to]
  query_params[:reportFormat] = opts[:report_format] if opts[:report_format]

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

  post_body = nil

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

#get_awr_hub(awr_hub_id, opts = {}) ⇒ `Response`

Note:

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

Gets details of an AWR hub.

Parameters:

awr_hub_id (String) —

Unique Awr Hub identifier
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:

(Response) —

A Response object with data of type AwrHub

# File 'lib/oci/opsi/operations_insights_client.rb', line 3442

def get_awr_hub(awr_hub_id, opts = {})
  logger.debug 'Calling operation OperationsInsightsClient#get_awr_hub.' if logger

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

  path = '/awrHubs/{awrHubId}'.sub('{awrHubId}', awr_hub_id.to_s)
  operation_signing_strategy = :standard

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

#get_awr_hub_object(awr_hub_source_id, object_name, opts = {}, &block) ⇒ `Response`

Note:

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

Gets the Awr Hub object metadata and body.

Parameters:

awr_hub_source_id (String) —

Unique Awr Hub Source identifier
object_name (String) —

Unique Awr Hub Object identifier
opts (Hash) (defaults to: {}) —

the optional parameters
[Block] (Hash) —

a customizable set of options

Options Hash (opts):

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

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

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
: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/opsi/operations_insights_client.rb', line 3501

def get_awr_hub_object(awr_hub_source_id, object_name, opts = {}, &block)
  logger.debug 'Calling operation OperationsInsightsClient#get_awr_hub_object.' if logger

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

  path = '/awrHubObjects/awrHubSources/{awrHubSourceId}/o/{objectName}'.sub('{awrHubSourceId}', awr_hub_source_id.to_s).sub('{objectName}', object_name.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: 'OperationsInsightsClient#get_awr_hub_object') 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_awr_hub_source(awr_hub_source_id, opts = {}) ⇒ `Response`

Note:

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

Gets the Awr Hub source object.

Parameters:

awr_hub_source_id (String) —

Unique Awr Hub Source identifier
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:

(Response) —

A Response object with data of type AwrHubSource

# File 'lib/oci/opsi/operations_insights_client.rb', line 3603

def get_awr_hub_source(awr_hub_source_id, opts = {})
  logger.debug 'Calling operation OperationsInsightsClient#get_awr_hub_source.' if logger

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

  path = '/awrHubSources/{awrHubSourceId}'.sub('{awrHubSourceId}', awr_hub_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: 'OperationsInsightsClient#get_awr_hub_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::Opsi::Models::AwrHubSource'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_awr_report(awr_hub_id, awr_source_database_identifier, opts = {}) ⇒ `Response`

Note:

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

Gets the AWR report for the specified source database in the AWR hub. The difference between the timeGreaterThanOrEqualTo and timeLessThanOrEqualTo should not be greater than 7 days. Either beginSnapshotIdentifierGreaterThanOrEqualTo & endSnapshotIdentifierLessThanOrEqualTo params Or timeGreaterThanOrEqualTo & timeLessThanOrEqualTo params are required.

Parameters:

awr_hub_id (String) —

Unique Awr Hub identifier
awr_source_database_identifier (String) —

AWR source database identifier.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

The format of the AWR report. Default report format is HTML. (default to HTML)
:instance_number (String) —

The optional single value query parameter to filter by database instance number.
:begin_snapshot_identifier_greater_than_or_equal_to (Integer) —

The optional greater than or equal to filter on the snapshot ID.
:end_snapshot_identifier_less_than_or_equal_to (Integer) —

The optional less than or equal to query parameter to filter the snapshot Identifier.
:time_greater_than_or_equal_to (DateTime) —

The optional greater than or equal to query parameter to filter the timestamp. The timestamp format to be followed is: YYYY-MM-DDTHH:MM:SSZ, example 2020-12-03T19:00:53Z
:time_less_than_or_equal_to (DateTime) —

The optional less than or equal to query parameter to filter the timestamp. The timestamp format to be followed is: YYYY-MM-DDTHH:MM:SSZ, example 2020-12-03T19:00:53Z
:opc_request_id (String) —

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:

(Response) —

A Response object with data of type AwrReport

# File 'lib/oci/opsi/operations_insights_client.rb', line 3672

def get_awr_report(awr_hub_id, awr_source_database_identifier, opts = {})
  logger.debug 'Calling operation OperationsInsightsClient#get_awr_report.' if logger

  raise "Missing the required parameter 'awr_hub_id' when calling get_awr_report." if awr_hub_id.nil?
  raise "Missing the required parameter 'awr_source_database_identifier' when calling get_awr_report." if awr_source_database_identifier.nil?

  if opts[:report_format] && !OCI::Opsi::Models::AWR_REPORT_FORMAT_TYPE_ENUM.include?(opts[:report_format])
    raise 'Invalid value for "report_format", must be one of the values in OCI::Opsi::Models::AWR_REPORT_FORMAT_TYPE_ENUM.'
  end
  raise "Parameter value for 'awr_hub_id' must not be blank" if OCI::Internal::Util.blank_string?(awr_hub_id)

  path = '/awrHubs/{awrHubId}/awrReport'.sub('{awrHubId}', awr_hub_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:awrSourceDatabaseIdentifier] = awr_source_database_identifier
  query_params[:reportFormat] = opts[:report_format] if opts[:report_format]
  query_params[:instanceNumber] = opts[:instance_number] if opts[:instance_number]
  query_params[:beginSnapshotIdentifierGreaterThanOrEqualTo] = opts[:begin_snapshot_identifier_greater_than_or_equal_to] if opts[:begin_snapshot_identifier_greater_than_or_equal_to]
  query_params[:endSnapshotIdentifierLessThanOrEqualTo] = opts[:end_snapshot_identifier_less_than_or_equal_to] if opts[:end_snapshot_identifier_less_than_or_equal_to]
  query_params[:timeGreaterThanOrEqualTo] = opts[:time_greater_than_or_equal_to] if opts[:time_greater_than_or_equal_to]
  query_params[:timeLessThanOrEqualTo] = opts[:time_less_than_or_equal_to] if opts[:time_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: 'OperationsInsightsClient#get_awr_report') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Opsi::Models::AwrReport'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_database_insight(database_insight_id, opts = {}) ⇒ `Response`

Note:

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

Gets details of a database insight.

Parameters:

database_insight_id (String) —

Unique database insight identifier
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:

(Response) —

A Response object with data of type DatabaseInsight

# File 'lib/oci/opsi/operations_insights_client.rb', line 3740

def get_database_insight(database_insight_id, opts = {})
  logger.debug 'Calling operation OperationsInsightsClient#get_database_insight.' if logger

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

  path = '/databaseInsights/{databaseInsightId}'.sub('{databaseInsightId}', database_insight_id.to_s)
  operation_signing_strategy = :standard

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

#get_enterprise_manager_bridge(enterprise_manager_bridge_id, opts = {}) ⇒ `Response`

Note:

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

Gets details of an Operations Insights Enterprise Manager bridge.

Parameters:

enterprise_manager_bridge_id (String) —

Unique Enterprise Manager bridge identifier
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:

(Response) —

A Response object with data of type EnterpriseManagerBridge

# File 'lib/oci/opsi/operations_insights_client.rb', line 3796

def get_enterprise_manager_bridge(enterprise_manager_bridge_id, opts = {})
  logger.debug 'Calling operation OperationsInsightsClient#get_enterprise_manager_bridge.' if logger

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

  path = '/enterpriseManagerBridges/{enterpriseManagerBridgeId}'.sub('{enterpriseManagerBridgeId}', enterprise_manager_bridge_id.to_s)
  operation_signing_strategy = :standard

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

#get_exadata_insight(exadata_insight_id, opts = {}) ⇒ `Response`

Note:

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

Gets details of an Exadata insight.

Parameters:

exadata_insight_id (String) —

Unique Exadata insight identifier
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:

(Response) —

A Response object with data of type ExadataInsight

# File 'lib/oci/opsi/operations_insights_client.rb', line 3852

def get_exadata_insight(exadata_insight_id, opts = {})
  logger.debug 'Calling operation OperationsInsightsClient#get_exadata_insight.' if logger

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

  path = '/exadataInsights/{exadataInsightId}'.sub('{exadataInsightId}', exadata_insight_id.to_s)
  operation_signing_strategy = :standard

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

#get_host_insight(host_insight_id, opts = {}) ⇒ `Response`

Note:

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

Gets details of a host insight.

Parameters:

host_insight_id (String) —

Unique host insight identifier
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:

(Response) —

A Response object with data of type HostInsight

# File 'lib/oci/opsi/operations_insights_client.rb', line 3908

def get_host_insight(host_insight_id, opts = {})
  logger.debug 'Calling operation OperationsInsightsClient#get_host_insight.' if logger

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

  path = '/hostInsights/{hostInsightId}'.sub('{hostInsightId}', host_insight_id.to_s)
  operation_signing_strategy = :standard

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

#get_news_report(news_report_id, opts = {}) ⇒ `Response`

Note:

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

Gets details of a news report.

Parameters:

news_report_id (String) —

Unique news report identifier.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:

(Response) —

A Response object with data of type NewsReport

# File 'lib/oci/opsi/operations_insights_client.rb', line 3964

def get_news_report(news_report_id, opts = {})
  logger.debug 'Calling operation OperationsInsightsClient#get_news_report.' if logger

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

  path = '/newsReports/{newsReportId}'.sub('{newsReportId}', news_report_id.to_s)
  operation_signing_strategy = :standard

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

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

  post_body = nil

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

#get_operations_insights_private_endpoint(operations_insights_private_endpoint_id, opts = {}) ⇒ `Response`

Note:

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

Gets the details of the specified private endpoint.

Parameters:

operations_insights_private_endpoint_id (String) —

The OCID of the Operation Insights private endpoint.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:

(Response) —

A Response object with data of type OperationsInsightsPrivateEndpoint

# File 'lib/oci/opsi/operations_insights_client.rb', line 4020

def get_operations_insights_private_endpoint(operations_insights_private_endpoint_id, opts = {})
  logger.debug 'Calling operation OperationsInsightsClient#get_operations_insights_private_endpoint.' if logger

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

  path = '/operationsInsightsPrivateEndpoints/{operationsInsightsPrivateEndpointId}'.sub('{operationsInsightsPrivateEndpointId}', operations_insights_private_endpoint_id.to_s)
  operation_signing_strategy = :standard

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

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

  post_body = nil

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

#get_operations_insights_warehouse(operations_insights_warehouse_id, opts = {}) ⇒ `Response`

Note:

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

Gets details of an Operations Insights Warehouse. There is only expected to be 1 warehouse per tenant. The warehouse is expected to be in the root compartment.

Parameters:

operations_insights_warehouse_id (String) —

Unique Operations Insights Warehouse identifier
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:

(Response) —

A Response object with data of type OperationsInsightsWarehouse

# File 'lib/oci/opsi/operations_insights_client.rb', line 4078

def get_operations_insights_warehouse(operations_insights_warehouse_id, opts = {})
  logger.debug 'Calling operation OperationsInsightsClient#get_operations_insights_warehouse.' if logger

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

  path = '/operationsInsightsWarehouses/{operationsInsightsWarehouseId}'.sub('{operationsInsightsWarehouseId}', operations_insights_warehouse_id.to_s)
  operation_signing_strategy = :standard

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

#get_operations_insights_warehouse_user(operations_insights_warehouse_user_id, opts = {}) ⇒ `Response`

Note:

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

Gets details of an Operations Insights Warehouse User.

Parameters:

operations_insights_warehouse_user_id (String) —

Unique Operations Insights Warehouse User identifier
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:

(Response) —

A Response object with data of type OperationsInsightsWarehouseUser

# File 'lib/oci/opsi/operations_insights_client.rb', line 4134

def get_operations_insights_warehouse_user(operations_insights_warehouse_user_id, opts = {})
  logger.debug 'Calling operation OperationsInsightsClient#get_operations_insights_warehouse_user.' if logger

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

  path = '/operationsInsightsWarehouseUsers/{operationsInsightsWarehouseUserId}'.sub('{operationsInsightsWarehouseUserId}', operations_insights_warehouse_user_id.to_s)
  operation_signing_strategy = :standard

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

#get_opsi_configuration(opsi_configuration_id, opts = {}) ⇒ `Response`

Note:

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

Gets details of an OPSI configuration resource. Values specified in configItemField and configItemCustomStatus query params will be considered, only if configItems field is requested as part of opsiConfigField query param. Values specified in configItemCustomStatus will determine whether only customized configuration items or only non-customized configuration items or both have to be returned.

Allowed values are: configItems

Parameters:

opsi_configuration_id (String) —

OCID of OPSI configuration resource.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

Optional fields to return as part of OpsiConfiguration object. Unless requested, these fields will not be returned by default. (default to [])
:config_item_custom_status (Array<String>) —

Specifies whether only customized configuration items or only non-customized configuration items or both have to be returned. By default only customized configuration items are returned. (default to [customized]) Allowed values are: customized, nonCustomized
:config_items_applicable_context (Array<String>) —

Returns the configuration items filtered by applicable contexts sent in this param. By default configuration items of all applicable contexts are returned. (default to [])
:config_item_field (Array<String>) —

Specifies the fields to return in a config item summary. (default to []) Allowed values are: name, value, defaultValue, metadata, applicableContexts
:opc_request_id (String) —

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:

(Response) —

A Response object with data of type OpsiConfiguration

# File 'lib/oci/opsi/operations_insights_client.rb', line 4205

def get_opsi_configuration(opsi_configuration_id, opts = {})
  logger.debug 'Calling operation OperationsInsightsClient#get_opsi_configuration.' if logger

  raise "Missing the required parameter 'opsi_configuration_id' when calling get_opsi_configuration." if opsi_configuration_id.nil?


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


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


  config_item_field_allowable_values = %w[name value defaultValue metadata applicableContexts]
  if opts[:config_item_field] && !opts[:config_item_field].empty?
    opts[:config_item_field].each do |val_to_check|
      unless config_item_field_allowable_values.include?(val_to_check)
        raise 'Invalid value for "config_item_field", must be one of name, value, defaultValue, metadata, applicableContexts.'
      end
    end
  end
  raise "Parameter value for 'opsi_configuration_id' must not be blank" if OCI::Internal::Util.blank_string?(opsi_configuration_id)

  path = '/opsiConfigurations/{opsiConfigurationId}'.sub('{opsiConfigurationId}', opsi_configuration_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:opsiConfigField] = OCI::ApiClient.build_collection_params(opts[:opsi_config_field], :multi) if opts[:opsi_config_field] && !opts[:opsi_config_field].empty?
  query_params[:configItemCustomStatus] = OCI::ApiClient.build_collection_params(opts[:config_item_custom_status], :multi) if opts[:config_item_custom_status] && !opts[:config_item_custom_status].empty?
  query_params[:configItemsApplicableContext] = OCI::ApiClient.build_collection_params(opts[:config_items_applicable_context], :multi) if opts[:config_items_applicable_context] && !opts[:config_items_applicable_context].empty?
  query_params[:configItemField] = OCI::ApiClient.build_collection_params(opts[:config_item_field], :multi) if opts[:config_item_field] && !opts[:config_item_field].empty?

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

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'OperationsInsightsClient#get_opsi_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::Opsi::Models::OpsiConfiguration'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

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

Note:

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

Gets details of an OPSI data object.

Parameters:

compartment_id (String) —

The OCID of the compartment.
opsi_data_object_identifier (String) —

Unique OPSI data object identifier.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:

(Response) —

A Response object with data of type OpsiDataObject

# File 'lib/oci/opsi/operations_insights_client.rb', line 4296

def get_opsi_data_object(compartment_id, opsi_data_object_identifier, opts = {})
  logger.debug 'Calling operation OperationsInsightsClient#get_opsi_data_object.' if logger

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

  path = '/opsiDataObjects/{opsiDataObjectIdentifier}'.sub('{opsiDataObjectIdentifier}', opsi_data_object_identifier.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[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

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

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

Note:

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

Gets the status of the work request with the given ID.

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

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:

(Response) —

A Response object with data of type WorkRequest

# File 'lib/oci/opsi/operations_insights_client.rb', line 4354

def get_work_request(work_request_id, opts = {})
  logger.debug 'Calling operation OperationsInsightsClient#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: 'OperationsInsightsClient#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::Opsi::Models::WorkRequest'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#head_awr_hub_object(awr_hub_source_id, object_name, opts = {}) ⇒ `Response`

Note:

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

Gets the Awr Hub object's user-defined metadata and entity tag (ETag).

Parameters:

awr_hub_source_id (String) —

Unique Awr Hub Source identifier
object_name (String) —

Unique Awr Hub Object identifier
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:

(Response) —

A Response object with data of type nil

# File 'lib/oci/opsi/operations_insights_client.rb', line 4412

def head_awr_hub_object(awr_hub_source_id, object_name, opts = {})
  logger.debug 'Calling operation OperationsInsightsClient#head_awr_hub_object.' if logger

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

  path = '/awrHubObjects/awrHubSources/{awrHubSourceId}/o/{objectName}'.sub('{awrHubSourceId}', awr_hub_source_id.to_s).sub('{objectName}', object_name.to_s)
  operation_signing_strategy = :standard

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

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

  post_body = nil

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

#ingest_addm_reports(ingest_addm_reports_details, opts = {}) ⇒ `Response`

Note:

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

This endpoint takes in a JSON payload, persists it in Operation Insights ingest pipeline. Either databaseId or id must be specified.

Parameters:

ingest_addm_reports_details (OCI::Opsi::Models::IngestAddmReportsDetails) —

Collection of addm reports for a particular database.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

Optional OCID of the associated DBaaS entity.
:id (String) —

OCID of the database insight resource.
:opc_request_id (String) —

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
:if_match (String) —

Used for optimistic concurrency control. In the update or delete call for a resource, set the if-match parameter to the value of the etag from a previous get, create, or update response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
:opc_retry_token (String) —

A token that uniquely identifies a request that can be retried in case of a timeout or server error without risk of executing the same action again. Retry tokens expire after 24 hours.

Note: Retry tokens can be invalidated before the 24 hour time limit due to conflicting operations, such as a resource being deleted or purged from the system.

Returns:

(Response) —

A Response object with data of type IngestAddmReportsResponseDetails

# File 'lib/oci/opsi/operations_insights_client.rb', line 4486

def ingest_addm_reports(ingest_addm_reports_details, opts = {})
  logger.debug 'Calling operation OperationsInsightsClient#ingest_addm_reports.' if logger

  raise "Missing the required parameter 'ingest_addm_reports_details' when calling ingest_addm_reports." if ingest_addm_reports_details.nil?

  path = '/databaseInsights/actions/ingestAddmReports'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:databaseId] = opts[:database_id] if opts[:database_id]
  query_params[:id] = opts[:id] if opts[: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[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(ingest_addm_reports_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'OperationsInsightsClient#ingest_addm_reports') do
    @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::Opsi::Models::IngestAddmReportsResponseDetails'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#ingest_database_configuration(ingest_database_configuration_details, opts = {}) ⇒ `Response`

Note:

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

This is a generic ingest endpoint for all database configuration metrics.

Parameters:

ingest_database_configuration_details (OCI::Opsi::Models::IngestDatabaseConfigurationDetails) —

Payload for one or more database configuration metrics for a particular database.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

Optional OCID of the associated DBaaS entity.
:id (String) —

OCID of the database insight resource.
:opc_request_id (String) —

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
:if_match (String) —

Used for optimistic concurrency control. In the update or delete call for a resource, set the if-match parameter to the value of the etag from a previous get, create, or update response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
:opc_retry_token (String) —

A token that uniquely identifies a request that can be retried in case of a timeout or server error without risk of executing the same action again. Retry tokens expire after 24 hours.

Note: Retry tokens can be invalidated before the 24 hour time limit due to conflicting operations, such as a resource being deleted or purged from the system.

Returns:

(Response) —

A Response object with data of type IngestDatabaseConfigurationResponseDetails

# File 'lib/oci/opsi/operations_insights_client.rb', line 4561

def ingest_database_configuration(ingest_database_configuration_details, opts = {})
  logger.debug 'Calling operation OperationsInsightsClient#ingest_database_configuration.' if logger

  raise "Missing the required parameter 'ingest_database_configuration_details' when calling ingest_database_configuration." if ingest_database_configuration_details.nil?

  path = '/databaseInsights/actions/ingestDatabaseConfiguration'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:databaseId] = opts[:database_id] if opts[:database_id]
  query_params[:id] = opts[:id] if opts[: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[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(ingest_database_configuration_details)

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

#ingest_host_configuration(id, ingest_host_configuration_details, opts = {}) ⇒ `Response`

Note:

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

This is a generic ingest endpoint for all the host configuration metrics

Parameters:

id (String) —

Required OCID of the host insight resource.
ingest_host_configuration_details (OCI::Opsi::Models::IngestHostConfigurationDetails) —

Payload for one or more host configuration metrics for a particular host.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
:if_match (String) —

Used for optimistic concurrency control. In the update or delete call for a resource, set the if-match parameter to the value of the etag from a previous get, create, or update response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
:opc_retry_token (String) —

A token that uniquely identifies a request that can be retried in case of a timeout or server error without risk of executing the same action again. Retry tokens expire after 24 hours.

Note: Retry tokens can be invalidated before the 24 hour time limit due to conflicting operations, such as a resource being deleted or purged from the system.

Returns:

(Response) —

A Response object with data of type IngestHostConfigurationResponseDetails

# File 'lib/oci/opsi/operations_insights_client.rb', line 4634

def ingest_host_configuration(id, ingest_host_configuration_details, opts = {})
  logger.debug 'Calling operation OperationsInsightsClient#ingest_host_configuration.' if logger

  raise "Missing the required parameter 'id' when calling ingest_host_configuration." if id.nil?
  raise "Missing the required parameter 'ingest_host_configuration_details' when calling ingest_host_configuration." if ingest_host_configuration_details.nil?

  path = '/hostInsights/actions/ingestHostConfiguration'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:id] = 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[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(ingest_host_configuration_details)

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

#ingest_host_metrics(id, ingest_host_metrics_details, opts = {}) ⇒ `Response`

Note:

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

This is a generic ingest endpoint for all the host performance metrics

Parameters:

id (String) —

Required OCID of the host insight resource.
ingest_host_metrics_details (OCI::Opsi::Models::IngestHostMetricsDetails) —

Payload for one or more host performance metrics for a particular host.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
:if_match (String) —

Used for optimistic concurrency control. In the update or delete call for a resource, set the if-match parameter to the value of the etag from a previous get, create, or update response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
:opc_retry_token (String) —

A token that uniquely identifies a request that can be retried in case of a timeout or server error without risk of executing the same action again. Retry tokens expire after 24 hours.

Note: Retry tokens can be invalidated before the 24 hour time limit due to conflicting operations, such as a resource being deleted or purged from the system.

Returns:

(Response) —

A Response object with data of type IngestHostMetricsResponseDetails

# File 'lib/oci/opsi/operations_insights_client.rb', line 4707

def ingest_host_metrics(id, ingest_host_metrics_details, opts = {})
  logger.debug 'Calling operation OperationsInsightsClient#ingest_host_metrics.' if logger

  raise "Missing the required parameter 'id' when calling ingest_host_metrics." if id.nil?
  raise "Missing the required parameter 'ingest_host_metrics_details' when calling ingest_host_metrics." if ingest_host_metrics_details.nil?

  path = '/hostInsights/actions/ingestHostMetrics'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:id] = 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[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(ingest_host_metrics_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'OperationsInsightsClient#ingest_host_metrics') do
    @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::Opsi::Models::IngestHostMetricsResponseDetails'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#ingest_sql_bucket(ingest_sql_bucket_details, opts = {}) ⇒ `Response`

Note:

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

The sqlbucket endpoint takes in a JSON payload, persists it in Operations Insights ingest pipeline. Either databaseId or id must be specified.

Parameters:

ingest_sql_bucket_details (OCI::Opsi::Models::IngestSqlBucketDetails) —

Collection of SQL bucket objects for a particular database.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

The OCID of the compartment.
:database_id (String) —

Optional OCID of the associated DBaaS entity.
:id (String) —

OCID of the database insight resource.
:opc_request_id (String) —

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
:if_match (String) —

Used for optimistic concurrency control. In the update or delete call for a resource, set the if-match parameter to the value of the etag from a previous get, create, or update response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
:opc_retry_token (String) —

A token that uniquely identifies a request that can be retried in case of a timeout or server error without risk of executing the same action again. Retry tokens expire after 24 hours.

Note: Retry tokens can be invalidated before the 24 hour time limit due to conflicting operations, such as a resource being deleted or purged from the system.

Returns:

(Response) —

A Response object with data of type IngestSqlBucketResponseDetails

# File 'lib/oci/opsi/operations_insights_client.rb', line 4785

def ingest_sql_bucket(ingest_sql_bucket_details, opts = {})
  logger.debug 'Calling operation OperationsInsightsClient#ingest_sql_bucket.' if logger

  raise "Missing the required parameter 'ingest_sql_bucket_details' when calling ingest_sql_bucket." if ingest_sql_bucket_details.nil?

  path = '/databaseInsights/actions/ingestSqlBucket'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = opts[:compartment_id] if opts[:compartment_id]
  query_params[:databaseId] = opts[:database_id] if opts[:database_id]
  query_params[:id] = opts[:id] if opts[: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[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(ingest_sql_bucket_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'OperationsInsightsClient#ingest_sql_bucket') do
    @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::Opsi::Models::IngestSqlBucketResponseDetails'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#ingest_sql_plan_lines(ingest_sql_plan_lines_details, opts = {}) ⇒ `Response`

Note:

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

The SqlPlanLines endpoint takes in a JSON payload, persists it in Operation Insights ingest pipeline. Either databaseId or id must be specified.

Parameters:

ingest_sql_plan_lines_details (OCI::Opsi::Models::IngestSqlPlanLinesDetails) —

Collection of SQL plan line objects for a particular database.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

The OCID of the compartment.
:database_id (String) —

Optional OCID of the associated DBaaS entity.
:id (String) —

OCID of the database insight resource.
:opc_request_id (String) —

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
:if_match (String) —

Used for optimistic concurrency control. In the update or delete call for a resource, set the if-match parameter to the value of the etag from a previous get, create, or update response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
:opc_retry_token (String) —

A token that uniquely identifies a request that can be retried in case of a timeout or server error without risk of executing the same action again. Retry tokens expire after 24 hours.

Note: Retry tokens can be invalidated before the 24 hour time limit due to conflicting operations, such as a resource being deleted or purged from the system.

Returns:

(Response) —

A Response object with data of type IngestSqlPlanLinesResponseDetails

# File 'lib/oci/opsi/operations_insights_client.rb', line 4864

def ingest_sql_plan_lines(ingest_sql_plan_lines_details, opts = {})
  logger.debug 'Calling operation OperationsInsightsClient#ingest_sql_plan_lines.' if logger

  raise "Missing the required parameter 'ingest_sql_plan_lines_details' when calling ingest_sql_plan_lines." if ingest_sql_plan_lines_details.nil?

  path = '/databaseInsights/actions/ingestSqlPlanLines'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = opts[:compartment_id] if opts[:compartment_id]
  query_params[:databaseId] = opts[:database_id] if opts[:database_id]
  query_params[:id] = opts[:id] if opts[: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[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(ingest_sql_plan_lines_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'OperationsInsightsClient#ingest_sql_plan_lines') do
    @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::Opsi::Models::IngestSqlPlanLinesResponseDetails'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#ingest_sql_stats(ingest_sql_stats_details, opts = {}) ⇒ `Response`

Note:

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

The SQL Stats endpoint takes in a JSON payload, persists it in Operations Insights ingest pipeline. Either databaseId or id must be specified.

Parameters:

ingest_sql_stats_details (OCI::Opsi::Models::IngestSqlStatsDetails) —

Collection of SQL stats objects for a particular database.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

Optional OCID of the associated DBaaS entity.
:id (String) —

OCID of the database insight resource.
:opc_request_id (String) —

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
:if_match (String) —

Used for optimistic concurrency control. In the update or delete call for a resource, set the if-match parameter to the value of the etag from a previous get, create, or update response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
:opc_retry_token (String) —

A token that uniquely identifies a request that can be retried in case of a timeout or server error without risk of executing the same action again. Retry tokens expire after 24 hours.

Note: Retry tokens can be invalidated before the 24 hour time limit due to conflicting operations, such as a resource being deleted or purged from the system.

Returns:

(Response) —

A Response object with data of type IngestSqlStatsResponseDetails

# File 'lib/oci/opsi/operations_insights_client.rb', line 4942

def ingest_sql_stats(ingest_sql_stats_details, opts = {})
  logger.debug 'Calling operation OperationsInsightsClient#ingest_sql_stats.' if logger

  raise "Missing the required parameter 'ingest_sql_stats_details' when calling ingest_sql_stats." if ingest_sql_stats_details.nil?

  path = '/databaseInsights/actions/ingestSqlStatsMetric'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:databaseId] = opts[:database_id] if opts[:database_id]
  query_params[:id] = opts[:id] if opts[: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[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(ingest_sql_stats_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'OperationsInsightsClient#ingest_sql_stats') do
    @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::Opsi::Models::IngestSqlStatsResponseDetails'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#ingest_sql_text(ingest_sql_text_details, opts = {}) ⇒ `Response`

Note:

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

The SqlText endpoint takes in a JSON payload, persists it in Operation Insights ingest pipeline. Either databaseId or id must be specified. Disclaimer: SQL text being uploaded explicitly via APIs is not masked. Any sensitive literals contained in the sqlFullText column should be masked prior to ingestion.

Parameters:

ingest_sql_text_details (OCI::Opsi::Models::IngestSqlTextDetails) —

Collection of SQL text objects for a particular database.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

The OCID of the compartment.
:database_id (String) —

Optional OCID of the associated DBaaS entity.
:id (String) —

OCID of the database insight resource.
:opc_request_id (String) —

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
:if_match (String) —

Used for optimistic concurrency control. In the update or delete call for a resource, set the if-match parameter to the value of the etag from a previous get, create, or update response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
:opc_retry_token (String) —

A token that uniquely identifies a request that can be retried in case of a timeout or server error without risk of executing the same action again. Retry tokens expire after 24 hours.

Note: Retry tokens can be invalidated before the 24 hour time limit due to conflicting operations, such as a resource being deleted or purged from the system.

Returns:

(Response) —

A Response object with data of type IngestSqlTextResponseDetails

# File 'lib/oci/opsi/operations_insights_client.rb', line 5021

def ingest_sql_text(ingest_sql_text_details, opts = {})
  logger.debug 'Calling operation OperationsInsightsClient#ingest_sql_text.' if logger

  raise "Missing the required parameter 'ingest_sql_text_details' when calling ingest_sql_text." if ingest_sql_text_details.nil?

  path = '/databaseInsights/actions/ingestSqlText'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = opts[:compartment_id] if opts[:compartment_id]
  query_params[:databaseId] = opts[:database_id] if opts[:database_id]
  query_params[:id] = opts[:id] if opts[: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[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(ingest_sql_text_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'OperationsInsightsClient#ingest_sql_text') do
    @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::Opsi::Models::IngestSqlTextResponseDetails'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

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

Note:

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

Gets list of ADDM finding categories.

Parameters:

compartment_id (String) —

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

the optional parameters

Options Hash (opts):

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

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

Optional list of database OCIDs of the associated DBaaS entity. (default to [])
:id (Array<String>) —

Optional list of database insight resource OCIDs. (default to [])
:limit (Integer) —

For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see List Pagination. Example: 50 (default to 50)
:page (String) —

For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination.
:sort_order (String) —

The sort order to use, either ascending (ASC) or descending (DESC).
:sort_by (String) —

Field name for sorting the finding categories (default to name) Allowed values are: name
:opc_request_id (String) —

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
:defined_tag_equals (Array<String>) —

A list of tag filters to apply. Only resources with a defined tag matching the value will be returned. Each item in the list has the format "namespace.tagName.value". All inputs are case-insensitive. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as "OR". Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as "AND".
:freeform_tag_equals (Array<String>) —

A list of tag filters to apply. Only resources with a freeform tag matching the value will be returned. The key for each tag is "tagName.value". All inputs are case-insensitive. Multiple values for the same tag name are interpreted as "OR". Values for different tag names are interpreted as "AND".
:defined_tag_exists (Array<String>) —

A list of tag existence filters to apply. Only resources for which the specified defined tags exist will be returned. Each item in the list has the format "namespace.tagName.true" (for checking existence of a defined tag) or "namespace.true". All inputs are case-insensitive. Currently, only existence ("true" at the end) is supported. Absence ("false" at the end) is not supported. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as "OR". Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as "AND".
:freeform_tag_exists (Array<String>) —

A list of tag existence filters to apply. Only resources for which the specified freeform tags exist the value will be returned. The key for each tag is "tagName.true". All inputs are case-insensitive. Currently, only existence ("true" at the end) is supported. Absence ("false" at the end) is not supported. Multiple values for different tag names are interpreted as "AND".
:compartment_id_in_subtree (BOOLEAN) —

A flag to search all resources within a given compartment and all sub-compartments. (default to false)

Returns:

(Response) —

A Response object with data of type AddmDbFindingCategoryCollection

# File 'lib/oci/opsi/operations_insights_client.rb', line 5124

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

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

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

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

  path = '/databaseInsights/addmDbFindingCategories'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:databaseId] = OCI::ApiClient.build_collection_params(opts[:database_id], :multi) if opts[:database_id] && !opts[:database_id].empty?
  query_params[:id] = OCI::ApiClient.build_collection_params(opts[:id], :multi) if opts[:id] && !opts[:id].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]
  query_params[:definedTagEquals] = OCI::ApiClient.build_collection_params(opts[:defined_tag_equals], :multi) if opts[:defined_tag_equals] && !opts[:defined_tag_equals].empty?
  query_params[:freeformTagEquals] = OCI::ApiClient.build_collection_params(opts[:freeform_tag_equals], :multi) if opts[:freeform_tag_equals] && !opts[:freeform_tag_equals].empty?
  query_params[:definedTagExists] = OCI::ApiClient.build_collection_params(opts[:defined_tag_exists], :multi) if opts[:defined_tag_exists] && !opts[:defined_tag_exists].empty?
  query_params[:freeformTagExists] = OCI::ApiClient.build_collection_params(opts[:freeform_tag_exists], :multi) if opts[:freeform_tag_exists] && !opts[:freeform_tag_exists].empty?
  query_params[:compartmentIdInSubtree] = opts[:compartment_id_in_subtree] if !opts[:compartment_id_in_subtree].nil?

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

  post_body = nil

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

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

Note:

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

Get the ADDM findings time series for the specified databases for a given time period.

Allowed values are: timestamp

Parameters:

compartment_id (String) —

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

the optional parameters

Options Hash (opts):

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

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

Optional list of database OCIDs of the associated DBaaS entity. (default to [])
:id (Array<String>) —

Optional list of database insight resource OCIDs. (default to [])
:instance_number (String) —

The optional single value query parameter to filter by database instance number.
:time_interval_start (DateTime) —

Analysis start time in UTC in ISO 8601 format(inclusive). Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). The minimum allowed value is 2 years prior to the current day. timeIntervalStart and timeIntervalEnd parameters are used together. If analysisTimeInterval is specified, this parameter is ignored.
:time_interval_end (DateTime) —

Analysis end time in UTC in ISO 8601 format(exclusive). Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). timeIntervalStart and timeIntervalEnd are used together. If timeIntervalEnd is not specified, current time is used as timeIntervalEnd.
:category_name (String) —

Optional value filter to match the finding category exactly.
:limit (Integer) —

For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see List Pagination. Example: 50 (default to 1000)
:page (String) —

For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination.
:sort_order (String) —

The sort order to use, either ascending (ASC) or descending (DESC).
:sort_by (String) —

Field name for sorting the ADDM finding time series summary data (default to timestamp)
:opc_request_id (String) —

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
:defined_tag_equals (Array<String>) —

A list of tag filters to apply. Only resources with a defined tag matching the value will be returned. Each item in the list has the format "namespace.tagName.value". All inputs are case-insensitive. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as "OR". Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as "AND".
:freeform_tag_equals (Array<String>) —

A list of tag filters to apply. Only resources with a freeform tag matching the value will be returned. The key for each tag is "tagName.value". All inputs are case-insensitive. Multiple values for the same tag name are interpreted as "OR". Values for different tag names are interpreted as "AND".
:defined_tag_exists (Array<String>) —

A list of tag existence filters to apply. Only resources for which the specified defined tags exist will be returned. Each item in the list has the format "namespace.tagName.true" (for checking existence of a defined tag) or "namespace.true". All inputs are case-insensitive. Currently, only existence ("true" at the end) is supported. Absence ("false" at the end) is not supported. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as "OR". Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as "AND".
:freeform_tag_exists (Array<String>) —

A list of tag existence filters to apply. Only resources for which the specified freeform tags exist the value will be returned. The key for each tag is "tagName.true". All inputs are case-insensitive. Currently, only existence ("true" at the end) is supported. Absence ("false" at the end) is not supported. Multiple values for different tag names are interpreted as "AND".
:compartment_id_in_subtree (BOOLEAN) —

A flag to search all resources within a given compartment and all sub-compartments. (default to false)

Returns:

(Response) —

A Response object with data of type AddmDbFindingsTimeSeriesCollection

# File 'lib/oci/opsi/operations_insights_client.rb', line 5256

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

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

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

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

  path = '/databaseInsights/addmDbFindingsTimeSeries'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:databaseId] = OCI::ApiClient.build_collection_params(opts[:database_id], :multi) if opts[:database_id] && !opts[:database_id].empty?
  query_params[:id] = OCI::ApiClient.build_collection_params(opts[:id], :multi) if opts[:id] && !opts[:id].empty?
  query_params[:instanceNumber] = opts[:instance_number] if opts[:instance_number]
  query_params[:timeIntervalStart] = opts[:time_interval_start] if opts[:time_interval_start]
  query_params[:timeIntervalEnd] = opts[:time_interval_end] if opts[:time_interval_end]
  query_params[:categoryName] = opts[:category_name] if opts[:category_name]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:definedTagEquals] = OCI::ApiClient.build_collection_params(opts[:defined_tag_equals], :multi) if opts[:defined_tag_equals] && !opts[:defined_tag_equals].empty?
  query_params[:freeformTagEquals] = OCI::ApiClient.build_collection_params(opts[:freeform_tag_equals], :multi) if opts[:freeform_tag_equals] && !opts[:freeform_tag_equals].empty?
  query_params[:definedTagExists] = OCI::ApiClient.build_collection_params(opts[:defined_tag_exists], :multi) if opts[:defined_tag_exists] && !opts[:defined_tag_exists].empty?
  query_params[:freeformTagExists] = OCI::ApiClient.build_collection_params(opts[:freeform_tag_exists], :multi) if opts[:freeform_tag_exists] && !opts[:freeform_tag_exists].empty?
  query_params[:compartmentIdInSubtree] = opts[:compartment_id_in_subtree] if !opts[:compartment_id_in_subtree].nil?

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

  post_body = nil

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

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

Note:

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

Gets list of ADDM database parameter categories for the specified databases.

Parameters:

compartment_id (String) —

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

the optional parameters

Options Hash (opts):

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

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

Optional list of database OCIDs of the associated DBaaS entity. (default to [])
:id (Array<String>) —

Optional list of database insight resource OCIDs. (default to [])
:limit (Integer) —

For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see List Pagination. Example: 50 (default to 50)
:page (String) —

For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination.
:sort_order (String) —

The sort order to use, either ascending (ASC) or descending (DESC).
:sort_by (String) —

Field name for sorting the database parameter categories (default to name) Allowed values are: name
:opc_request_id (String) —

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
:defined_tag_equals (Array<String>) —

A list of tag filters to apply. Only resources with a defined tag matching the value will be returned. Each item in the list has the format "namespace.tagName.value". All inputs are case-insensitive. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as "OR". Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as "AND".
:freeform_tag_equals (Array<String>) —

A list of tag filters to apply. Only resources with a freeform tag matching the value will be returned. The key for each tag is "tagName.value". All inputs are case-insensitive. Multiple values for the same tag name are interpreted as "OR". Values for different tag names are interpreted as "AND".
:defined_tag_exists (Array<String>) —

A list of tag existence filters to apply. Only resources for which the specified defined tags exist will be returned. Each item in the list has the format "namespace.tagName.true" (for checking existence of a defined tag) or "namespace.true". All inputs are case-insensitive. Currently, only existence ("true" at the end) is supported. Absence ("false" at the end) is not supported. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as "OR". Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as "AND".
:freeform_tag_exists (Array<String>) —

A list of tag existence filters to apply. Only resources for which the specified freeform tags exist the value will be returned. The key for each tag is "tagName.true". All inputs are case-insensitive. Currently, only existence ("true" at the end) is supported. Absence ("false" at the end) is not supported. Multiple values for different tag names are interpreted as "AND".
:compartment_id_in_subtree (BOOLEAN) —

A flag to search all resources within a given compartment and all sub-compartments. (default to false)

Returns:

(Response) —

A Response object with data of type AddmDbParameterCategoryCollection

# File 'lib/oci/opsi/operations_insights_client.rb', line 5377

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

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

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

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

  path = '/databaseInsights/addmDbParameterCategories'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:databaseId] = OCI::ApiClient.build_collection_params(opts[:database_id], :multi) if opts[:database_id] && !opts[:database_id].empty?
  query_params[:id] = OCI::ApiClient.build_collection_params(opts[:id], :multi) if opts[:id] && !opts[:id].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]
  query_params[:definedTagEquals] = OCI::ApiClient.build_collection_params(opts[:defined_tag_equals], :multi) if opts[:defined_tag_equals] && !opts[:defined_tag_equals].empty?
  query_params[:freeformTagEquals] = OCI::ApiClient.build_collection_params(opts[:freeform_tag_equals], :multi) if opts[:freeform_tag_equals] && !opts[:freeform_tag_equals].empty?
  query_params[:definedTagExists] = OCI::ApiClient.build_collection_params(opts[:defined_tag_exists], :multi) if opts[:defined_tag_exists] && !opts[:defined_tag_exists].empty?
  query_params[:freeformTagExists] = OCI::ApiClient.build_collection_params(opts[:freeform_tag_exists], :multi) if opts[:freeform_tag_exists] && !opts[:freeform_tag_exists].empty?
  query_params[:compartmentIdInSubtree] = opts[:compartment_id_in_subtree] if !opts[:compartment_id_in_subtree].nil?

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

  post_body = nil

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

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

Note:

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

Gets list of ADDM recommendation categories for the specified databases.

Parameters:

compartment_id (String) —

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

the optional parameters

Options Hash (opts):

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

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

Optional list of database OCIDs of the associated DBaaS entity. (default to [])
:id (Array<String>) —

Optional list of database insight resource OCIDs. (default to [])
:limit (Integer) —

For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see List Pagination. Example: 50 (default to 50)
:page (String) —

For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination.
:sort_order (String) —

The sort order to use, either ascending (ASC) or descending (DESC).
:sort_by (String) —

Field name for sorting the recommendation categories (default to name) Allowed values are: name
:opc_request_id (String) —

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
:defined_tag_equals (Array<String>) —

A list of tag filters to apply. Only resources with a defined tag matching the value will be returned. Each item in the list has the format "namespace.tagName.value". All inputs are case-insensitive. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as "OR". Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as "AND".
:freeform_tag_equals (Array<String>) —

A list of tag filters to apply. Only resources with a freeform tag matching the value will be returned. The key for each tag is "tagName.value". All inputs are case-insensitive. Multiple values for the same tag name are interpreted as "OR". Values for different tag names are interpreted as "AND".
:defined_tag_exists (Array<String>) —

A list of tag existence filters to apply. Only resources for which the specified defined tags exist will be returned. Each item in the list has the format "namespace.tagName.true" (for checking existence of a defined tag) or "namespace.true". All inputs are case-insensitive. Currently, only existence ("true" at the end) is supported. Absence ("false" at the end) is not supported. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as "OR". Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as "AND".
:freeform_tag_exists (Array<String>) —

A list of tag existence filters to apply. Only resources for which the specified freeform tags exist the value will be returned. The key for each tag is "tagName.true". All inputs are case-insensitive. Currently, only existence ("true" at the end) is supported. Absence ("false" at the end) is not supported. Multiple values for different tag names are interpreted as "AND".
:compartment_id_in_subtree (BOOLEAN) —

A flag to search all resources within a given compartment and all sub-compartments. (default to false)

Returns:

(Response) —

A Response object with data of type AddmDbRecommendationCategoryCollection

# File 'lib/oci/opsi/operations_insights_client.rb', line 5494

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

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

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

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

  path = '/databaseInsights/addmDbRecommendationCategories'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:databaseId] = OCI::ApiClient.build_collection_params(opts[:database_id], :multi) if opts[:database_id] && !opts[:database_id].empty?
  query_params[:id] = OCI::ApiClient.build_collection_params(opts[:id], :multi) if opts[:id] && !opts[:id].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]
  query_params[:definedTagEquals] = OCI::ApiClient.build_collection_params(opts[:defined_tag_equals], :multi) if opts[:defined_tag_equals] && !opts[:defined_tag_equals].empty?
  query_params[:freeformTagEquals] = OCI::ApiClient.build_collection_params(opts[:freeform_tag_equals], :multi) if opts[:freeform_tag_equals] && !opts[:freeform_tag_equals].empty?
  query_params[:definedTagExists] = OCI::ApiClient.build_collection_params(opts[:defined_tag_exists], :multi) if opts[:defined_tag_exists] && !opts[:defined_tag_exists].empty?
  query_params[:freeformTagExists] = OCI::ApiClient.build_collection_params(opts[:freeform_tag_exists], :multi) if opts[:freeform_tag_exists] && !opts[:freeform_tag_exists].empty?
  query_params[:compartmentIdInSubtree] = opts[:compartment_id_in_subtree] if !opts[:compartment_id_in_subtree].nil?

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

  post_body = nil

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

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

Note:

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

Gets time series data for ADDM recommendations for the specified databases.

Parameters:

compartment_id (String) —

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

the optional parameters

Options Hash (opts):

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

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

Optional list of database OCIDs of the associated DBaaS entity. (default to [])
:id (Array<String>) —

Optional list of database insight resource OCIDs. (default to [])
:instance_number (String) —

The optional single value query parameter to filter by database instance number.
:time_interval_start (DateTime) —

Analysis start time in UTC in ISO 8601 format(inclusive). Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). The minimum allowed value is 2 years prior to the current day. timeIntervalStart and timeIntervalEnd parameters are used together. If analysisTimeInterval is specified, this parameter is ignored.
:time_interval_end (DateTime) —

Analysis end time in UTC in ISO 8601 format(exclusive). Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). timeIntervalStart and timeIntervalEnd are used together. If timeIntervalEnd is not specified, current time is used as timeIntervalEnd.
:category_name (String) —

Optional value filter to match the finding category exactly.
:sql_identifier (String) —

Optional filter to return only resources whose sql id matches the value given. Only considered when categoryName is SQL_TUNING.
:owner_or_name_contains (String) —

Optional filter to return only resources whose owner or name contains the substring given. The match is not case sensitive. Only considered when categoryName is SCHEMA_OBJECT.
:name_contains (String) —

Optional filter to return only resources whose name contains the substring given. The match is not case sensitive. Only considered when categoryName is DATABASE_CONFIGURATION.
:name (String) —

Optional filter to return only resources whose name exactly matches the substring given. The match is case sensitive. Only considered when categoryName is DATABASE_CONFIGURATION.
:limit (Integer) —

For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see List Pagination. Example: 50 (default to 1000)
:page (String) —

For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination.
:sort_order (String) —

The sort order to use, either ascending (ASC) or descending (DESC).
:sort_by (String) —

Field name for sorting the ADDM recommendation time series summary data (default to timestamp) Allowed values are: timestamp
:opc_request_id (String) —

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
:defined_tag_equals (Array<String>) —

A list of tag filters to apply. Only resources with a defined tag matching the value will be returned. Each item in the list has the format "namespace.tagName.value". All inputs are case-insensitive. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as "OR". Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as "AND".
:freeform_tag_equals (Array<String>) —

A list of tag filters to apply. Only resources with a freeform tag matching the value will be returned. The key for each tag is "tagName.value". All inputs are case-insensitive. Multiple values for the same tag name are interpreted as "OR". Values for different tag names are interpreted as "AND".
:defined_tag_exists (Array<String>) —

A list of tag existence filters to apply. Only resources for which the specified defined tags exist will be returned. Each item in the list has the format "namespace.tagName.true" (for checking existence of a defined tag) or "namespace.true". All inputs are case-insensitive. Currently, only existence ("true" at the end) is supported. Absence ("false" at the end) is not supported. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as "OR". Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as "AND".
:freeform_tag_exists (Array<String>) —

A list of tag existence filters to apply. Only resources for which the specified freeform tags exist the value will be returned. The key for each tag is "tagName.true". All inputs are case-insensitive. Currently, only existence ("true" at the end) is supported. Absence ("false" at the end) is not supported. Multiple values for different tag names are interpreted as "AND".
:compartment_id_in_subtree (BOOLEAN) —

A flag to search all resources within a given compartment and all sub-compartments. (default to false)

Returns:

(Response) —

A Response object with data of type AddmDbRecommendationsTimeSeriesCollection

# File 'lib/oci/opsi/operations_insights_client.rb', line 5637

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

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

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

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

  path = '/databaseInsights/addmDbRecommendationsTimeSeries'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:databaseId] = OCI::ApiClient.build_collection_params(opts[:database_id], :multi) if opts[:database_id] && !opts[:database_id].empty?
  query_params[:id] = OCI::ApiClient.build_collection_params(opts[:id], :multi) if opts[:id] && !opts[:id].empty?
  query_params[:instanceNumber] = opts[:instance_number] if opts[:instance_number]
  query_params[:timeIntervalStart] = opts[:time_interval_start] if opts[:time_interval_start]
  query_params[:timeIntervalEnd] = opts[:time_interval_end] if opts[:time_interval_end]
  query_params[:categoryName] = opts[:category_name] if opts[:category_name]
  query_params[:sqlIdentifier] = opts[:sql_identifier] if opts[:sql_identifier]
  query_params[:ownerOrNameContains] = opts[:owner_or_name_contains] if opts[:owner_or_name_contains]
  query_params[:nameContains] = opts[:name_contains] if opts[:name_contains]
  query_params[:name] = opts[:name] if opts[:name]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:definedTagEquals] = OCI::ApiClient.build_collection_params(opts[:defined_tag_equals], :multi) if opts[:defined_tag_equals] && !opts[:defined_tag_equals].empty?
  query_params[:freeformTagEquals] = OCI::ApiClient.build_collection_params(opts[:freeform_tag_equals], :multi) if opts[:freeform_tag_equals] && !opts[:freeform_tag_equals].empty?
  query_params[:definedTagExists] = OCI::ApiClient.build_collection_params(opts[:defined_tag_exists], :multi) if opts[:defined_tag_exists] && !opts[:defined_tag_exists].empty?
  query_params[:freeformTagExists] = OCI::ApiClient.build_collection_params(opts[:freeform_tag_exists], :multi) if opts[:freeform_tag_exists] && !opts[:freeform_tag_exists].empty?
  query_params[:compartmentIdInSubtree] = opts[:compartment_id_in_subtree] if !opts[:compartment_id_in_subtree].nil?

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

  post_body = nil

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

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

Note:

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

Gets a list of ADDM database information

Parameters:

compartment_id (String) —

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

the optional parameters

Options Hash (opts):

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

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

Optional list of database OCIDs of the associated DBaaS entity. (default to [])
:id (Array<String>) —

Optional list of database insight resource OCIDs. (default to [])
:time_interval_start (DateTime) —

Analysis start time in UTC in ISO 8601 format(inclusive). Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). The minimum allowed value is 2 years prior to the current day. timeIntervalStart and timeIntervalEnd parameters are used together. If analysisTimeInterval is specified, this parameter is ignored.
:time_interval_end (DateTime) —

Analysis end time in UTC in ISO 8601 format(exclusive). Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). timeIntervalStart and timeIntervalEnd are used together. If timeIntervalEnd is not specified, current time is used as timeIntervalEnd.
:limit (Integer) —

For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see List Pagination. Example: 50 (default to 50)
:page (String) —

For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination.
:sort_order (String) —

The sort order to use, either ascending (ASC) or descending (DESC). (default to DESC)
:sort_by (String) —

Field name for sorting ADDM database data (default to numberOfFindings) Allowed values are: databaseName, numberOfFindings
:opc_request_id (String) —

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
:defined_tag_equals (Array<String>) —

A list of tag filters to apply. Only resources with a defined tag matching the value will be returned. Each item in the list has the format "namespace.tagName.value". All inputs are case-insensitive. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as "OR". Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as "AND".
:freeform_tag_equals (Array<String>) —

A list of tag filters to apply. Only resources with a freeform tag matching the value will be returned. The key for each tag is "tagName.value". All inputs are case-insensitive. Multiple values for the same tag name are interpreted as "OR". Values for different tag names are interpreted as "AND".
:defined_tag_exists (Array<String>) —

A list of tag existence filters to apply. Only resources for which the specified defined tags exist will be returned. Each item in the list has the format "namespace.tagName.true" (for checking existence of a defined tag) or "namespace.true". All inputs are case-insensitive. Currently, only existence ("true" at the end) is supported. Absence ("false" at the end) is not supported. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as "OR". Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as "AND".
:freeform_tag_exists (Array<String>) —

A list of tag existence filters to apply. Only resources for which the specified freeform tags exist the value will be returned. The key for each tag is "tagName.true". All inputs are case-insensitive. Currently, only existence ("true" at the end) is supported. Absence ("false" at the end) is not supported. Multiple values for different tag names are interpreted as "AND".
:compartment_id_in_subtree (BOOLEAN) —

A flag to search all resources within a given compartment and all sub-compartments. (default to false)

Returns:

(Response) —

A Response object with data of type AddmDbCollection

# File 'lib/oci/opsi/operations_insights_client.rb', line 5773

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

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

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

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

  path = '/databaseInsights/addmDbs'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:databaseId] = OCI::ApiClient.build_collection_params(opts[:database_id], :multi) if opts[:database_id] && !opts[:database_id].empty?
  query_params[:id] = OCI::ApiClient.build_collection_params(opts[:id], :multi) if opts[:id] && !opts[:id].empty?
  query_params[:timeIntervalStart] = opts[:time_interval_start] if opts[:time_interval_start]
  query_params[:timeIntervalEnd] = opts[:time_interval_end] if opts[:time_interval_end]
  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[:definedTagEquals] = OCI::ApiClient.build_collection_params(opts[:defined_tag_equals], :multi) if opts[:defined_tag_equals] && !opts[:defined_tag_equals].empty?
  query_params[:freeformTagEquals] = OCI::ApiClient.build_collection_params(opts[:freeform_tag_equals], :multi) if opts[:freeform_tag_equals] && !opts[:freeform_tag_equals].empty?
  query_params[:definedTagExists] = OCI::ApiClient.build_collection_params(opts[:defined_tag_exists], :multi) if opts[:defined_tag_exists] && !opts[:defined_tag_exists].empty?
  query_params[:freeformTagExists] = OCI::ApiClient.build_collection_params(opts[:freeform_tag_exists], :multi) if opts[:freeform_tag_exists] && !opts[:freeform_tag_exists].empty?
  query_params[:compartmentIdInSubtree] = opts[:compartment_id_in_subtree] if !opts[:compartment_id_in_subtree].nil?

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

  post_body = nil

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

#list_awr_database_snapshots(awr_hub_id, awr_source_database_identifier, opts = {}) ⇒ `Response`

Note:

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

Lists AWR snapshots for the specified database in the AWR.

Parameters:

awr_hub_id (String) —

Unique Awr Hub identifier
awr_source_database_identifier (String) —

The internal ID of the database. The internal ID of the database is not the OCID. It can be retrieved from the following endpoint: /awrHubs/awrHubId/awrDatabases
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

The optional single value query parameter to filter by database instance number.
:begin_snapshot_identifier_greater_than_or_equal_to (Integer) —

The optional greater than or equal to filter on the snapshot ID.
:end_snapshot_identifier_less_than_or_equal_to (Integer) —

The optional less than or equal to query parameter to filter the snapshot Identifier.
:time_greater_than_or_equal_to (DateTime) —

The optional greater than or equal to query parameter to filter the timestamp. The timestamp format to be followed is: YYYY-MM-DDTHH:MM:SSZ, example 2020-12-03T19:00:53Z
:time_less_than_or_equal_to (DateTime) —

The optional less than or equal to query parameter to filter the timestamp. The timestamp format to be followed is: YYYY-MM-DDTHH:MM:SSZ, example 2020-12-03T19:00:53Z
:page (String) —

For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination.
:limit (Integer) —

For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see List Pagination. Example: 50 (default to 50)
:sort_by (String) —

The option to sort the AWR snapshot summary data. (default to TIME_BEGIN) Allowed values are: TIME_BEGIN, SNAPSHOT_ID
:sort_order (String) —

The sort order to use, either ascending (ASC) or descending (DESC). (default to DESC)
:opc_request_id (String) —

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:

(Response) —

A Response object with data of type AwrDatabaseSnapshotCollection

# File 'lib/oci/opsi/operations_insights_client.rb', line 5878

def list_awr_database_snapshots(awr_hub_id, awr_source_database_identifier, opts = {})
  logger.debug 'Calling operation OperationsInsightsClient#list_awr_database_snapshots.' if logger

  raise "Missing the required parameter 'awr_hub_id' when calling list_awr_database_snapshots." if awr_hub_id.nil?
  raise "Missing the required parameter 'awr_source_database_identifier' when calling list_awr_database_snapshots." if awr_source_database_identifier.nil?

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

  if opts[:sort_order] && !OCI::Opsi::Models::SORT_ORDER_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::Opsi::Models::SORT_ORDER_ENUM.'
  end
  raise "Parameter value for 'awr_hub_id' must not be blank" if OCI::Internal::Util.blank_string?(awr_hub_id)

  path = '/awrHubs/{awrHubId}/awrDatabaseSnapshots'.sub('{awrHubId}', awr_hub_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:awrSourceDatabaseIdentifier] = awr_source_database_identifier
  query_params[:instanceNumber] = opts[:instance_number] if opts[:instance_number]
  query_params[:beginSnapshotIdentifierGreaterThanOrEqualTo] = opts[:begin_snapshot_identifier_greater_than_or_equal_to] if opts[:begin_snapshot_identifier_greater_than_or_equal_to]
  query_params[:endSnapshotIdentifierLessThanOrEqualTo] = opts[:end_snapshot_identifier_less_than_or_equal_to] if opts[:end_snapshot_identifier_less_than_or_equal_to]
  query_params[:timeGreaterThanOrEqualTo] = opts[:time_greater_than_or_equal_to] if opts[:time_greater_than_or_equal_to]
  query_params[:timeLessThanOrEqualTo] = opts[:time_less_than_or_equal_to] if opts[:time_less_than_or_equal_to]
  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: 'OperationsInsightsClient#list_awr_database_snapshots') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Opsi::Models::AwrDatabaseSnapshotCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_awr_databases(awr_hub_id, opts = {}) ⇒ `Response`

Note:

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

Gets the list of databases and their snapshot summary details available in the AWRHub.

Parameters:

awr_hub_id (String) —

Unique Awr Hub identifier
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

The optional single value query parameter to filter the entity name.
:time_greater_than_or_equal_to (DateTime) —

The optional greater than or equal to query parameter to filter the timestamp. The timestamp format to be followed is: YYYY-MM-DDTHH:MM:SSZ, example 2020-12-03T19:00:53Z
:time_less_than_or_equal_to (DateTime) —

The optional less than or equal to query parameter to filter the timestamp. The timestamp format to be followed is: YYYY-MM-DDTHH:MM:SSZ, example 2020-12-03T19:00:53Z
:page (String) —

For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination.
:limit (Integer) —

For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see List Pagination. Example: 50 (default to 50)
:sort_by (String) —

The option to sort the AWR summary data. (default to END_INTERVAL_TIME) Allowed values are: END_INTERVAL_TIME, NAME
:sort_order (String) —

The sort order to use, either ascending (ASC) or descending (DESC). (default to DESC)
:opc_request_id (String) —

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:

(Response) —

A Response object with data of type AwrDatabaseCollection

# File 'lib/oci/opsi/operations_insights_client.rb', line 5973

def list_awr_databases(awr_hub_id, opts = {})
  logger.debug 'Calling operation OperationsInsightsClient#list_awr_databases.' if logger

  raise "Missing the required parameter 'awr_hub_id' when calling list_awr_databases." if awr_hub_id.nil?

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

  if opts[:sort_order] && !OCI::Opsi::Models::SORT_ORDER_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::Opsi::Models::SORT_ORDER_ENUM.'
  end
  raise "Parameter value for 'awr_hub_id' must not be blank" if OCI::Internal::Util.blank_string?(awr_hub_id)

  path = '/awrHubs/{awrHubId}/awrDatabases'.sub('{awrHubId}', awr_hub_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:name] = opts[:name] if opts[:name]
  query_params[:timeGreaterThanOrEqualTo] = opts[:time_greater_than_or_equal_to] if opts[:time_greater_than_or_equal_to]
  query_params[:timeLessThanOrEqualTo] = opts[:time_less_than_or_equal_to] if opts[:time_less_than_or_equal_to]
  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: 'OperationsInsightsClient#list_awr_databases') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Opsi::Models::AwrDatabaseCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_awr_hub_objects(awr_hub_source_id, opts = {}) ⇒ `Response`

Note:

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

Gets a list of Awr Hub objects. Awr Hub id needs to specified.

Parameters:

awr_hub_source_id (String) —

Unique Awr Hub Source identifier
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

The string to use for matching against the start of object names in a Awr Hub list objects query.
:start (String) —

Object names returned by Awr Hub list objects query must be greater or equal to this parameter.
:_end (String) —

Object names returned by Awr Hub list objects query must be strictly less than this parameter.
:delimiter (String) —

When this parameter is set, only objects whose names do not contain the delimiter character (after an optionally specified prefix) are returned in the Awr Hub list objects key of the response body. Scanned objects whose names contain the delimiter have the part of their name up to the first occurrence of the delimiter (including the optional prefix) returned as a set of prefixes. Note that only '/' is a supported delimiter character at this time.
:start_after (String) —

Awr Hub Object name after which remaining objects are listed
:page (String) —

For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination.
:limit (Integer) —

For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see List Pagination. Example: 50 (default to 50)
:fields (String) —

By default all the fields are returned. Use this parameter to fetch specific fields 'size', 'etag', 'md5', 'timeCreated', 'timeModified', 'storageTier' and 'archivalState' fields. List the names of those fields in a comma-separated, case-insensitive list as the value of this parameter. For example: 'name,etag,timeCreated,md5,timeModified,storageTier,archivalState'.

Allowed values are: name, size, etag, timeCreated, md5, archivalState, timeModified, storageTier
:opc_request_id (String) —

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:

(Response) —

A Response object with data of type ListObjects

# File 'lib/oci/opsi/operations_insights_client.rb', line 6071

def list_awr_hub_objects(awr_hub_source_id, opts = {})
  logger.debug 'Calling operation OperationsInsightsClient#list_awr_hub_objects.' if logger

  raise "Missing the required parameter 'awr_hub_source_id' when calling list_awr_hub_objects." if awr_hub_source_id.nil?

  if opts[:fields] && !%w[name size etag timeCreated md5 archivalState timeModified storageTier].include?(opts[:fields])
    raise 'Invalid value for "fields", must be one of name, size, etag, timeCreated, md5, archivalState, timeModified, storageTier.'
  end
  raise "Parameter value for 'awr_hub_source_id' must not be blank" if OCI::Internal::Util.blank_string?(awr_hub_source_id)

  path = '/awrHubObjects/awrHubSources/{awrHubSourceId}/o'.sub('{awrHubSourceId}', awr_hub_source_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:prefix] = opts[:prefix] if opts[:prefix]
  query_params[:start] = opts[:start] if opts[:start]
  query_params[:end] = opts[:_end] if opts[:_end]
  query_params[:delimiter] = opts[:delimiter] if opts[:delimiter]
  query_params[:startAfter] = opts[:start_after] if opts[:start_after]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:fields] = opts[:fields] if opts[:fields]

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

  post_body = nil

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

#list_awr_hub_sources(awr_hub_id, opts = {}) ⇒ `Response`

Note:

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

Gets a list of Awr Hub source objects. Allowed values are: timeCreated, displayName

Parameters:

awr_hub_id (String) —

Unique Awr Hub identifier
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

The OCID of the compartment.
:awr_hub_source_id (String) —

Awr Hub source identifier
:source_type (Array<String>) —

Filter by one or more database type. Possible values are ADW-S, ATP-S, ADW-D, ATP-D, EXTERNAL-PDB, EXTERNAL-NONCDB.

Allowed values are: ADW_S, ATP_S, ADW_D, ATP_D, EXTERNAL_PDB, EXTERNAL_NONCDB, COMANAGED_VM_CDB, COMANAGED_VM_PDB, COMANAGED_VM_NONCDB, COMANAGED_BM_CDB, COMANAGED_BM_PDB, COMANAGED_BM_NONCDB, COMANAGED_EXACS_CDB, COMANAGED_EXACS_PDB, COMANAGED_EXACS_NONCDB, UNDEFINED
:name (String) —

Awr Hub source database name
:status (Array<String>) —

Resource Status (default to []) Allowed values are: ACCEPTING, NOT_ACCEPTING, NOT_REGISTERED, TERMINATED
:lifecycle_state (Array<String>) —

Lifecycle states Allowed values are: CREATING, UPDATING, ACTIVE, DELETING, DELETED, FAILED
:limit (Integer) —

For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see List Pagination. Example: 50 (default to 50)
:page (String) —

For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination.
:sort_order (String) —

The sort order to use, either ascending (ASC) or descending (DESC).
: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) —

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:

(Response) —

A Response object with data of type AwrHubSourceSummaryCollection

# File 'lib/oci/opsi/operations_insights_client.rb', line 6165

def list_awr_hub_sources(awr_hub_id, opts = {})
  logger.debug 'Calling operation OperationsInsightsClient#list_awr_hub_sources.' if logger

  raise "Missing the required parameter 'awr_hub_id' when calling list_awr_hub_sources." if awr_hub_id.nil?


  source_type_allowable_values = %w[ADW_S ATP_S ADW_D ATP_D EXTERNAL_PDB EXTERNAL_NONCDB COMANAGED_VM_CDB COMANAGED_VM_PDB COMANAGED_VM_NONCDB COMANAGED_BM_CDB COMANAGED_BM_PDB COMANAGED_BM_NONCDB COMANAGED_EXACS_CDB COMANAGED_EXACS_PDB COMANAGED_EXACS_NONCDB UNDEFINED]
  if opts[:source_type] && !opts[:source_type].empty?
    opts[:source_type].each do |val_to_check|
      unless source_type_allowable_values.include?(val_to_check)
        raise 'Invalid value for "source_type", must be one of ADW_S, ATP_S, ADW_D, ATP_D, EXTERNAL_PDB, EXTERNAL_NONCDB, COMANAGED_VM_CDB, COMANAGED_VM_PDB, COMANAGED_VM_NONCDB, COMANAGED_BM_CDB, COMANAGED_BM_PDB, COMANAGED_BM_NONCDB, COMANAGED_EXACS_CDB, COMANAGED_EXACS_PDB, COMANAGED_EXACS_NONCDB, UNDEFINED.'
      end
    end
  end


  status_allowable_values = %w[ACCEPTING NOT_ACCEPTING NOT_REGISTERED TERMINATED]
  if opts[:status] && !opts[:status].empty?
    opts[:status].each do |val_to_check|
      unless status_allowable_values.include?(val_to_check)
        raise 'Invalid value for "status", must be one of ACCEPTING, NOT_ACCEPTING, NOT_REGISTERED, TERMINATED.'
      end
    end
  end


  lifecycle_state_allowable_values = %w[CREATING UPDATING ACTIVE DELETING DELETED FAILED]
  if opts[:lifecycle_state] && !opts[:lifecycle_state].empty?
    opts[:lifecycle_state].each do |val_to_check|
      unless lifecycle_state_allowable_values.include?(val_to_check)
        raise 'Invalid value for "lifecycle_state", must be one of CREATING, UPDATING, ACTIVE, DELETING, DELETED, FAILED.'
      end
    end
  end

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

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:awrHubId] = awr_hub_id
  query_params[:compartmentId] = opts[:compartment_id] if opts[:compartment_id]
  query_params[:awrHubSourceId] = opts[:awr_hub_source_id] if opts[:awr_hub_source_id]
  query_params[:sourceType] = OCI::ApiClient.build_collection_params(opts[:source_type], :multi) if opts[:source_type] && !opts[:source_type].empty?
  query_params[:name] = opts[:name] if opts[:name]
  query_params[:status] = OCI::ApiClient.build_collection_params(opts[:status], :multi) if opts[:status] && !opts[:status].empty?
  query_params[:lifecycleState] = OCI::ApiClient.build_collection_params(opts[:lifecycle_state], :multi) if opts[:lifecycle_state] && !opts[:lifecycle_state].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: 'OperationsInsightsClient#list_awr_hub_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::Opsi::Models::AwrHubSourceSummaryCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_awr_hubs(operations_insights_warehouse_id, opts = {}) ⇒ `Response`

Note:

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

Gets a list of AWR hubs. Either compartmentId or id must be specified. All these resources are expected to be in root compartment.

Allowed values are: timeCreated, displayName

Parameters:

operations_insights_warehouse_id (String) —

Unique Operations Insights Warehouse identifier
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

The OCID of the compartment.
:display_name (String) —

A filter to return only resources that match the entire display name.
:id (String) —

Unique Awr Hub identifier
:lifecycle_state (Array<String>) —

Lifecycle states (default to []) Allowed values are: CREATING, UPDATING, ACTIVE, DELETING, DELETED, FAILED
:limit (Integer) —

For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see List Pagination. Example: 50 (default to 50)
:page (String) —

For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination.
:sort_order (String) —

The sort order to use, either ascending (ASC) or descending (DESC).
: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) —

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:

(Response) —

A Response object with data of type AwrHubSummaryCollection

# File 'lib/oci/opsi/operations_insights_client.rb', line 6290

def list_awr_hubs(operations_insights_warehouse_id, opts = {})
  logger.debug 'Calling operation OperationsInsightsClient#list_awr_hubs.' if logger

  raise "Missing the required parameter 'operations_insights_warehouse_id' when calling list_awr_hubs." if operations_insights_warehouse_id.nil?


  lifecycle_state_allowable_values = %w[CREATING UPDATING ACTIVE DELETING DELETED FAILED]
  if opts[:lifecycle_state] && !opts[:lifecycle_state].empty?
    opts[:lifecycle_state].each do |val_to_check|
      unless lifecycle_state_allowable_values.include?(val_to_check)
        raise 'Invalid value for "lifecycle_state", must be one of CREATING, UPDATING, ACTIVE, DELETING, DELETED, FAILED.'
      end
    end
  end

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

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:operationsInsightsWarehouseId] = operations_insights_warehouse_id
  query_params[:compartmentId] = opts[:compartment_id] if opts[:compartment_id]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:id] = opts[:id] if opts[:id]
  query_params[:lifecycleState] = OCI::ApiClient.build_collection_params(opts[:lifecycle_state], :multi) if opts[:lifecycle_state] && !opts[:lifecycle_state].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: 'OperationsInsightsClient#list_awr_hubs') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Opsi::Models::AwrHubSummaryCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_awr_snapshots(awr_hub_id, awr_source_database_identifier, opts = {}) ⇒ `Response`

Note:

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

Lists AWR snapshots for the specified source database in the AWR hub. The difference between the timeGreaterThanOrEqualTo and timeLessThanOrEqualTo should not exceed an elapsed range of 1 day. The timeGreaterThanOrEqualTo & timeLessThanOrEqualTo params are optional. If these params are not provided, by default last 1 day snapshots will be returned.

Parameters:

awr_hub_id (String) —

Unique Awr Hub identifier
awr_source_database_identifier (String) —

AWR source database identifier.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

The optional greater than or equal to query parameter to filter the timestamp. The timestamp format to be followed is: YYYY-MM-DDTHH:MM:SSZ, example 2020-12-03T19:00:53Z
:time_less_than_or_equal_to (DateTime) —

The optional less than or equal to query parameter to filter the timestamp. The timestamp format to be followed is: YYYY-MM-DDTHH:MM:SSZ, example 2020-12-03T19:00:53Z
:limit (Integer) —

For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see List Pagination. Example: 50 (default to 50)
:page (String) —

For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination.
:sort_order (String) —

The sort order to use, either ascending (ASC) or descending (DESC).
:sort_by (String) —

The option to sort the AWR snapshot summary data. Default sort is by timeBegin. (default to timeBegin) Allowed values are: timeBegin, snapshotId
:opc_request_id (String) —

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:

(Response) —

A Response object with data of type AwrSnapshotCollection

# File 'lib/oci/opsi/operations_insights_client.rb', line 6393

def list_awr_snapshots(awr_hub_id, awr_source_database_identifier, opts = {})
  logger.debug 'Calling operation OperationsInsightsClient#list_awr_snapshots.' if logger

  raise "Missing the required parameter 'awr_hub_id' when calling list_awr_snapshots." if awr_hub_id.nil?
  raise "Missing the required parameter 'awr_source_database_identifier' when calling list_awr_snapshots." if awr_source_database_identifier.nil?

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

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

  path = '/awrHubs/{awrHubId}/awrSnapshots'.sub('{awrHubId}', awr_hub_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:awrSourceDatabaseIdentifier] = awr_source_database_identifier
  query_params[:timeGreaterThanOrEqualTo] = opts[:time_greater_than_or_equal_to] if opts[:time_greater_than_or_equal_to]
  query_params[:timeLessThanOrEqualTo] = opts[:time_less_than_or_equal_to] if opts[:time_less_than_or_equal_to]
  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: 'OperationsInsightsClient#list_awr_snapshots') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Opsi::Models::AwrSnapshotCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_database_configurations(opts = {}) ⇒ `Response`

Note:

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

Gets a list of database insight configurations based on the query parameters specified. Either compartmentId or databaseInsightId query parameter must be specified. When both compartmentId and compartmentIdInSubtree are specified, a list of database insight configurations in that compartment and in all sub-compartments will be returned.

Allowed values are: databaseName, databaseDisplayName, databaseType

Parameters:

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

the optional parameters

Options Hash (opts):

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

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

The OCID of the compartment.
:enterprise_manager_bridge_id (String) —

Unique Enterprise Manager bridge identifier
:id (Array<String>) —

Optional list of database insight resource OCIDs. (default to [])
:database_id (Array<String>) —

Optional list of database OCIDs of the associated DBaaS entity. (default to [])
:exadata_insight_id (Array<String>) —

Optional list of exadata insight resource OCIDs. (default to [])
:cdb_name (Array<String>) —

Filter by one or more cdb name. (default to [])
:database_type (Array<String>) —

Filter by one or more database type. Possible values are ADW-S, ATP-S, ADW-D, ATP-D, EXTERNAL-PDB, EXTERNAL-NONCDB. (default to []) Allowed values are: ADW-S, ATP-S, ADW-D, ATP-D, EXTERNAL-PDB, EXTERNAL-NONCDB, COMANAGED-VM-CDB, COMANAGED-VM-PDB, COMANAGED-VM-NONCDB, COMANAGED-BM-CDB, COMANAGED-BM-PDB, COMANAGED-BM-NONCDB, COMANAGED-EXACS-CDB, COMANAGED-EXACS-PDB, COMANAGED-EXACS-NONCDB
:limit (Integer) —

For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see List Pagination. Example: 50 (default to 50)
:page (String) —

For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination.
:sort_order (String) —

The sort order to use, either ascending (ASC) or descending (DESC).
:sort_by (String) —

Database configuration list sort options. If fields parameter is selected, the sortBy parameter must be one of the fields specified. (default to databaseName)
:host_name (Array<String>) —

Filter by one or more hostname. (default to [])
:opc_request_id (String) —

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
:defined_tag_equals (Array<String>) —

A list of tag filters to apply. Only resources with a defined tag matching the value will be returned. Each item in the list has the format "namespace.tagName.value". All inputs are case-insensitive. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as "OR". Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as "AND".
:freeform_tag_equals (Array<String>) —

A list of tag filters to apply. Only resources with a freeform tag matching the value will be returned. The key for each tag is "tagName.value". All inputs are case-insensitive. Multiple values for the same tag name are interpreted as "OR". Values for different tag names are interpreted as "AND".
:defined_tag_exists (Array<String>) —

A list of tag existence filters to apply. Only resources for which the specified defined tags exist will be returned. Each item in the list has the format "namespace.tagName.true" (for checking existence of a defined tag) or "namespace.true". All inputs are case-insensitive. Currently, only existence ("true" at the end) is supported. Absence ("false" at the end) is not supported. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as "OR". Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as "AND".
:freeform_tag_exists (Array<String>) —

A list of tag existence filters to apply. Only resources for which the specified freeform tags exist the value will be returned. The key for each tag is "tagName.true". All inputs are case-insensitive. Currently, only existence ("true" at the end) is supported. Absence ("false" at the end) is not supported. Multiple values for different tag names are interpreted as "AND".
:compartment_id_in_subtree (BOOLEAN) —

A flag to search all resources within a given compartment and all sub-compartments. (default to false)
:vmcluster_name (Array<String>) —

Optional list of Exadata Insight VM cluster name. (default to [])

Returns:

(Response) —

A Response object with data of type DatabaseConfigurationCollection

# File 'lib/oci/opsi/operations_insights_client.rb', line 6522

def list_database_configurations(opts = {})
  logger.debug 'Calling operation OperationsInsightsClient#list_database_configurations.' if logger



  database_type_allowable_values = %w[ADW-S ATP-S ADW-D ATP-D EXTERNAL-PDB EXTERNAL-NONCDB COMANAGED-VM-CDB COMANAGED-VM-PDB COMANAGED-VM-NONCDB COMANAGED-BM-CDB COMANAGED-BM-PDB COMANAGED-BM-NONCDB COMANAGED-EXACS-CDB COMANAGED-EXACS-PDB COMANAGED-EXACS-NONCDB]
  if opts[:database_type] && !opts[:database_type].empty?
    opts[:database_type].each do |val_to_check|
      unless database_type_allowable_values.include?(val_to_check)
        raise 'Invalid value for "database_type", must be one of ADW-S, ATP-S, ADW-D, ATP-D, EXTERNAL-PDB, EXTERNAL-NONCDB, COMANAGED-VM-CDB, COMANAGED-VM-PDB, COMANAGED-VM-NONCDB, COMANAGED-BM-CDB, COMANAGED-BM-PDB, COMANAGED-BM-NONCDB, COMANAGED-EXACS-CDB, COMANAGED-EXACS-PDB, COMANAGED-EXACS-NONCDB.'
      end
    end
  end

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

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

  path = '/databaseInsights/databaseConfigurations'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = opts[:compartment_id] if opts[:compartment_id]
  query_params[:enterpriseManagerBridgeId] = opts[:enterprise_manager_bridge_id] if opts[:enterprise_manager_bridge_id]
  query_params[:id] = OCI::ApiClient.build_collection_params(opts[:id], :multi) if opts[:id] && !opts[:id].empty?
  query_params[:databaseId] = OCI::ApiClient.build_collection_params(opts[:database_id], :multi) if opts[:database_id] && !opts[:database_id].empty?
  query_params[:exadataInsightId] = OCI::ApiClient.build_collection_params(opts[:exadata_insight_id], :multi) if opts[:exadata_insight_id] && !opts[:exadata_insight_id].empty?
  query_params[:cdbName] = OCI::ApiClient.build_collection_params(opts[:cdb_name], :multi) if opts[:cdb_name] && !opts[:cdb_name].empty?
  query_params[:databaseType] = OCI::ApiClient.build_collection_params(opts[:database_type], :multi) if opts[:database_type] && !opts[:database_type].empty?
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:hostName] = OCI::ApiClient.build_collection_params(opts[:host_name], :multi) if opts[:host_name] && !opts[:host_name].empty?
  query_params[:definedTagEquals] = OCI::ApiClient.build_collection_params(opts[:defined_tag_equals], :multi) if opts[:defined_tag_equals] && !opts[:defined_tag_equals].empty?
  query_params[:freeformTagEquals] = OCI::ApiClient.build_collection_params(opts[:freeform_tag_equals], :multi) if opts[:freeform_tag_equals] && !opts[:freeform_tag_equals].empty?
  query_params[:definedTagExists] = OCI::ApiClient.build_collection_params(opts[:defined_tag_exists], :multi) if opts[:defined_tag_exists] && !opts[:defined_tag_exists].empty?
  query_params[:freeformTagExists] = OCI::ApiClient.build_collection_params(opts[:freeform_tag_exists], :multi) if opts[:freeform_tag_exists] && !opts[:freeform_tag_exists].empty?
  query_params[:compartmentIdInSubtree] = opts[:compartment_id_in_subtree] if !opts[:compartment_id_in_subtree].nil?
  query_params[:vmclusterName] = OCI::ApiClient.build_collection_params(opts[:vmcluster_name], :multi) if opts[:vmcluster_name] && !opts[:vmcluster_name].empty?

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

  post_body = nil

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

#list_database_insights(opts = {}) ⇒ `Response`

Note:

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

Gets a list of database insights based on the query parameters specified. Either compartmentId or id query parameter must be specified. When both compartmentId and compartmentIdInSubtree are specified, a list of database insights in that compartment and in all sub-compartments will be returned.

Allowed values are: compartmentId, databaseName, databaseDisplayName, databaseType, databaseVersion, databaseHostNames, freeformTags, definedTags

Parameters:

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

the optional parameters

Options Hash (opts):

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

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

The OCID of the compartment.
:enterprise_manager_bridge_id (String) —

Unique Enterprise Manager bridge identifier
:id (Array<String>) —

Optional list of database insight resource OCIDs. (default to [])
:status (Array<String>) —

Resource Status (default to [ENABLED]) Allowed values are: DISABLED, ENABLED, TERMINATED
:lifecycle_state (Array<String>) —

Lifecycle states (default to [ACTIVE]) Allowed values are: CREATING, UPDATING, ACTIVE, DELETING, DELETED, FAILED, NEEDS_ATTENTION
:database_type (Array<String>) —

Filter by one or more database type. Possible values are ADW-S, ATP-S, ADW-D, ATP-D, EXTERNAL-PDB, EXTERNAL-NONCDB. (default to []) Allowed values are: ADW-S, ATP-S, ADW-D, ATP-D, EXTERNAL-PDB, EXTERNAL-NONCDB, COMANAGED-VM-CDB, COMANAGED-VM-PDB, COMANAGED-VM-NONCDB, COMANAGED-BM-CDB, COMANAGED-BM-PDB, COMANAGED-BM-NONCDB, COMANAGED-EXACS-CDB, COMANAGED-EXACS-PDB, COMANAGED-EXACS-NONCDB
:database_id (Array<String>) —

Optional list of database OCIDs of the associated DBaaS entity. (default to [])
:fields (Array<String>) —

Specifies the fields to return in a database summary response. By default all fields are returned if omitted. (default to [])
:limit (Integer) —

For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see List Pagination. Example: 50 (default to 50)
:page (String) —

For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination.
:sort_order (String) —

The sort order to use, either ascending (ASC) or descending (DESC).
:sort_by (String) —

Database insight list sort options. If fields parameter is selected, the sortBy parameter must be one of the fields specified.

Allowed values are: databaseName, databaseDisplayName, databaseType
:exadata_insight_id (String) —

OCID of exadata insight resource.
:compartment_id_in_subtree (BOOLEAN) —

A flag to search all resources within a given compartment and all sub-compartments. (default to false)
:opsi_private_endpoint_id (String) —

Unique Operations Insights PrivateEndpoint identifier
:opc_request_id (String) —

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:

(Response) —

A Response object with data of type DatabaseInsightsCollection

# File 'lib/oci/opsi/operations_insights_client.rb', line 6650

def list_database_insights(opts = {})
  logger.debug 'Calling operation OperationsInsightsClient#list_database_insights.' if logger



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


  lifecycle_state_allowable_values = %w[CREATING UPDATING ACTIVE DELETING DELETED FAILED NEEDS_ATTENTION]
  if opts[:lifecycle_state] && !opts[:lifecycle_state].empty?
    opts[:lifecycle_state].each do |val_to_check|
      unless lifecycle_state_allowable_values.include?(val_to_check)
        raise 'Invalid value for "lifecycle_state", must be one of CREATING, UPDATING, ACTIVE, DELETING, DELETED, FAILED, NEEDS_ATTENTION.'
      end
    end
  end


  database_type_allowable_values = %w[ADW-S ATP-S ADW-D ATP-D EXTERNAL-PDB EXTERNAL-NONCDB COMANAGED-VM-CDB COMANAGED-VM-PDB COMANAGED-VM-NONCDB COMANAGED-BM-CDB COMANAGED-BM-PDB COMANAGED-BM-NONCDB COMANAGED-EXACS-CDB COMANAGED-EXACS-PDB COMANAGED-EXACS-NONCDB]
  if opts[:database_type] && !opts[:database_type].empty?
    opts[:database_type].each do |val_to_check|
      unless database_type_allowable_values.include?(val_to_check)
        raise 'Invalid value for "database_type", must be one of ADW-S, ATP-S, ADW-D, ATP-D, EXTERNAL-PDB, EXTERNAL-NONCDB, COMANAGED-VM-CDB, COMANAGED-VM-PDB, COMANAGED-VM-NONCDB, COMANAGED-BM-CDB, COMANAGED-BM-PDB, COMANAGED-BM-NONCDB, COMANAGED-EXACS-CDB, COMANAGED-EXACS-PDB, COMANAGED-EXACS-NONCDB.'
      end
    end
  end


  fields_allowable_values = %w[compartmentId databaseName databaseDisplayName databaseType databaseVersion databaseHostNames freeformTags definedTags]
  if opts[:fields] && !opts[:fields].empty?
    opts[:fields].each do |val_to_check|
      unless fields_allowable_values.include?(val_to_check)
        raise 'Invalid value for "fields", must be one of compartmentId, databaseName, databaseDisplayName, databaseType, databaseVersion, databaseHostNames, freeformTags, definedTags.'
      end
    end
  end

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

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

  path = '/databaseInsights'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = opts[:compartment_id] if opts[:compartment_id]
  query_params[:enterpriseManagerBridgeId] = opts[:enterprise_manager_bridge_id] if opts[:enterprise_manager_bridge_id]
  query_params[:id] = OCI::ApiClient.build_collection_params(opts[:id], :multi) if opts[:id] && !opts[:id].empty?
  query_params[:status] = OCI::ApiClient.build_collection_params(opts[:status], :multi) if opts[:status] && !opts[:status].empty?
  query_params[:lifecycleState] = OCI::ApiClient.build_collection_params(opts[:lifecycle_state], :multi) if opts[:lifecycle_state] && !opts[:lifecycle_state].empty?
  query_params[:databaseType] = OCI::ApiClient.build_collection_params(opts[:database_type], :multi) if opts[:database_type] && !opts[:database_type].empty?
  query_params[:databaseId] = OCI::ApiClient.build_collection_params(opts[:database_id], :multi) if opts[:database_id] && !opts[:database_id].empty?
  query_params[:fields] = OCI::ApiClient.build_collection_params(opts[:fields], :multi) if opts[:fields] && !opts[:fields].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]
  query_params[:exadataInsightId] = opts[:exadata_insight_id] if opts[:exadata_insight_id]
  query_params[:compartmentIdInSubtree] = opts[:compartment_id_in_subtree] if !opts[:compartment_id_in_subtree].nil?
  query_params[:opsiPrivateEndpointId] = opts[:opsi_private_endpoint_id] if opts[:opsi_private_endpoint_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: 'OperationsInsightsClient#list_database_insights') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Opsi::Models::DatabaseInsightsCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_enterprise_manager_bridges(opts = {}) ⇒ `Response`

Note:

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

Gets a list of Operations Insights Enterprise Manager bridges. Either compartmentId or id must be specified. When both compartmentId and compartmentIdInSubtree are specified, a list of bridges in that compartment and in all sub-compartments will be returned.

Allowed values are: timeCreated, displayName

Parameters:

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

the optional parameters

Options Hash (opts):

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

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

The OCID of the compartment.
:display_name (String) —

A filter to return only resources that match the entire display name.
:id (String) —

Unique Enterprise Manager bridge identifier
:lifecycle_state (Array<String>) —

Lifecycle states (default to [ACTIVE]) Allowed values are: CREATING, UPDATING, ACTIVE, DELETING, DELETED, FAILED, NEEDS_ATTENTION
:limit (Integer) —

For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see List Pagination. Example: 50 (default to 50)
:page (String) —

For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination.
:sort_order (String) —

The sort order to use, either ascending (ASC) or descending (DESC).
: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)
:compartment_id_in_subtree (BOOLEAN) —

A flag to search all resources within a given compartment and all sub-compartments. (default to false)
:opc_request_id (String) —

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:

(Response) —

A Response object with data of type EnterpriseManagerBridgeCollection

# File 'lib/oci/opsi/operations_insights_client.rb', line 6790

def list_enterprise_manager_bridges(opts = {})
  logger.debug 'Calling operation OperationsInsightsClient#list_enterprise_manager_bridges.' if logger



  lifecycle_state_allowable_values = %w[CREATING UPDATING ACTIVE DELETING DELETED FAILED NEEDS_ATTENTION]
  if opts[:lifecycle_state] && !opts[:lifecycle_state].empty?
    opts[:lifecycle_state].each do |val_to_check|
      unless lifecycle_state_allowable_values.include?(val_to_check)
        raise 'Invalid value for "lifecycle_state", must be one of CREATING, UPDATING, ACTIVE, DELETING, DELETED, FAILED, NEEDS_ATTENTION.'
      end
    end
  end

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

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = opts[:compartment_id] if opts[:compartment_id]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:id] = opts[:id] if opts[:id]
  query_params[:lifecycleState] = OCI::ApiClient.build_collection_params(opts[:lifecycle_state], :multi) if opts[:lifecycle_state] && !opts[:lifecycle_state].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]
  query_params[:compartmentIdInSubtree] = opts[:compartment_id_in_subtree] if !opts[:compartment_id_in_subtree].nil?

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

  post_body = nil

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

#list_exadata_configurations(opts = {}) ⇒ `Response`

Note:

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

Gets a list of exadata insight configurations. Either compartmentId or exadataInsightsId query parameter must be specified. Allowed values are: exadataName, exadataDisplayName, exadataType

Parameters:

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

the optional parameters

Options Hash (opts):

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

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

The OCID of the compartment.
:exadata_insight_id (Array<String>) —

Optional list of exadata insight resource OCIDs. (default to [])
:exadata_type (Array<String>) —

Filter by one or more Exadata types. Possible value are DBMACHINE, EXACS, and EXACC. (default to [])
:limit (Integer) —

For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see List Pagination. Example: 50 (default to 50)
:page (String) —

For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination.
:sort_order (String) —

The sort order to use, either ascending (ASC) or descending (DESC).
:sort_by (String) —

Exadata configuration list sort options. If fields parameter is selected, the sortBy parameter must be one of the fields specified. (default to exadataName)
:defined_tag_equals (Array<String>) —

A list of tag filters to apply. Only resources with a defined tag matching the value will be returned. Each item in the list has the format "namespace.tagName.value". All inputs are case-insensitive. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as "OR". Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as "AND".
:freeform_tag_equals (Array<String>) —

A list of tag filters to apply. Only resources with a freeform tag matching the value will be returned. The key for each tag is "tagName.value". All inputs are case-insensitive. Multiple values for the same tag name are interpreted as "OR". Values for different tag names are interpreted as "AND".
:defined_tag_exists (Array<String>) —

A list of tag existence filters to apply. Only resources for which the specified defined tags exist will be returned. Each item in the list has the format "namespace.tagName.true" (for checking existence of a defined tag) or "namespace.true". All inputs are case-insensitive. Currently, only existence ("true" at the end) is supported. Absence ("false" at the end) is not supported. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as "OR". Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as "AND".
:freeform_tag_exists (Array<String>) —

A list of tag existence filters to apply. Only resources for which the specified freeform tags exist the value will be returned. The key for each tag is "tagName.true". All inputs are case-insensitive. Currently, only existence ("true" at the end) is supported. Absence ("false" at the end) is not supported. Multiple values for different tag names are interpreted as "AND".
:opc_request_id (String) —

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:

(Response) —

A Response object with data of type ExadataConfigurationCollection

# File 'lib/oci/opsi/operations_insights_client.rb', line 6912

def list_exadata_configurations(opts = {})
  logger.debug 'Calling operation OperationsInsightsClient#list_exadata_configurations.' if logger


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

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

  path = '/exadataInsights/exadataConfigurations'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = opts[:compartment_id] if opts[:compartment_id]
  query_params[:exadataInsightId] = OCI::ApiClient.build_collection_params(opts[:exadata_insight_id], :multi) if opts[:exadata_insight_id] && !opts[:exadata_insight_id].empty?
  query_params[:exadataType] = OCI::ApiClient.build_collection_params(opts[:exadata_type], :multi) if opts[:exadata_type] && !opts[:exadata_type].empty?
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:definedTagEquals] = OCI::ApiClient.build_collection_params(opts[:defined_tag_equals], :multi) if opts[:defined_tag_equals] && !opts[:defined_tag_equals].empty?
  query_params[:freeformTagEquals] = OCI::ApiClient.build_collection_params(opts[:freeform_tag_equals], :multi) if opts[:freeform_tag_equals] && !opts[:freeform_tag_equals].empty?
  query_params[:definedTagExists] = OCI::ApiClient.build_collection_params(opts[:defined_tag_exists], :multi) if opts[:defined_tag_exists] && !opts[:defined_tag_exists].empty?
  query_params[:freeformTagExists] = OCI::ApiClient.build_collection_params(opts[:freeform_tag_exists], :multi) if opts[:freeform_tag_exists] && !opts[:freeform_tag_exists].empty?

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

  post_body = nil

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

#list_exadata_insights(opts = {}) ⇒ `Response`

Note:

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

Gets a list of Exadata insights based on the query parameters specified. Either compartmentId or id query parameter must be specified. When both compartmentId and compartmentIdInSubtree are specified, a list of Exadata insights in that compartment and in all sub-compartments will be returned.

Allowed values are: timeCreated, exadataName

Parameters:

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

the optional parameters

Options Hash (opts):

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

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

The OCID of the compartment.
:enterprise_manager_bridge_id (String) —

Unique Enterprise Manager bridge identifier
:id (Array<String>) —

Optional list of Exadata insight resource OCIDs. (default to [])
:status (Array<String>) —

Resource Status (default to [ENABLED]) Allowed values are: DISABLED, ENABLED, TERMINATED
:lifecycle_state (Array<String>) —

Lifecycle states (default to [ACTIVE]) Allowed values are: CREATING, UPDATING, ACTIVE, DELETING, DELETED, FAILED, NEEDS_ATTENTION
:exadata_type (Array<String>) —

Filter by one or more Exadata types. Possible value are DBMACHINE, EXACS, and EXACC. (default to [])
:limit (Integer) —

For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see List Pagination. Example: 50 (default to 50)
:page (String) —

For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination.
:sort_order (String) —

The sort order to use, either ascending (ASC) or descending (DESC).
:sort_by (String) —

Exadata insight list sort options. If fields parameter is selected, the sortBy parameter must be one of the fields specified. Default order for timeCreated is descending. Default order for exadataName is ascending. If no value is specified timeCreated is default. (default to timeCreated)
:compartment_id_in_subtree (BOOLEAN) —

A flag to search all resources within a given compartment and all sub-compartments. (default to false)
:opc_request_id (String) —

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:

(Response) —

A Response object with data of type ExadataInsightSummaryCollection

# File 'lib/oci/opsi/operations_insights_client.rb', line 7014

def list_exadata_insights(opts = {})
  logger.debug 'Calling operation OperationsInsightsClient#list_exadata_insights.' if logger



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


  lifecycle_state_allowable_values = %w[CREATING UPDATING ACTIVE DELETING DELETED FAILED NEEDS_ATTENTION]
  if opts[:lifecycle_state] && !opts[:lifecycle_state].empty?
    opts[:lifecycle_state].each do |val_to_check|
      unless lifecycle_state_allowable_values.include?(val_to_check)
        raise 'Invalid value for "lifecycle_state", must be one of CREATING, UPDATING, ACTIVE, DELETING, DELETED, FAILED, NEEDS_ATTENTION.'
      end
    end
  end

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

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

  path = '/exadataInsights'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = opts[:compartment_id] if opts[:compartment_id]
  query_params[:enterpriseManagerBridgeId] = opts[:enterprise_manager_bridge_id] if opts[:enterprise_manager_bridge_id]
  query_params[:id] = OCI::ApiClient.build_collection_params(opts[:id], :multi) if opts[:id] && !opts[:id].empty?
  query_params[:status] = OCI::ApiClient.build_collection_params(opts[:status], :multi) if opts[:status] && !opts[:status].empty?
  query_params[:lifecycleState] = OCI::ApiClient.build_collection_params(opts[:lifecycle_state], :multi) if opts[:lifecycle_state] && !opts[:lifecycle_state].empty?
  query_params[:exadataType] = OCI::ApiClient.build_collection_params(opts[:exadata_type], :multi) if opts[:exadata_type] && !opts[:exadata_type].empty?
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:compartmentIdInSubtree] = opts[:compartment_id_in_subtree] if !opts[:compartment_id_in_subtree].nil?

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

  post_body = nil

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

#list_host_configurations(opts = {}) ⇒ `Response`

Note:

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

Gets a list of host insight configurations based on the query parameters specified. Either compartmentId or hostInsightId query parameter must be specified. When both compartmentId and compartmentIdInSubtree are specified, a list of host insight configurations in that compartment and in all sub-compartments will be returned.

Allowed values are: hostName, platformType

Parameters:

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

the optional parameters

Options Hash (opts):

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

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

The OCID of the compartment.
:enterprise_manager_bridge_id (String) —

Unique Enterprise Manager bridge identifier
:id (Array<String>) —

Optional list of host insight resource OCIDs. (default to [])
:exadata_insight_id (Array<String>) —

Optional list of exadata insight resource OCIDs. (default to [])
:platform_type (Array<String>) —

Filter by one or more platform types. Supported platformType(s) for MACS-managed external host insight: [LINUX, SOLARIS, WINDOWS]. Supported platformType(s) for MACS-managed cloud host insight: [LINUX]. Supported platformType(s) for EM-managed external host insight: [LINUX, SOLARIS, SUNOS, ZLINUX, WINDOWS, AIX, HP-UX]. (default to []) Allowed values are: LINUX, SOLARIS, SUNOS, ZLINUX, WINDOWS, AIX, HP_UX
:limit (Integer) —

For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see List Pagination. Example: 50 (default to 50)
:page (String) —

For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination.
:sort_order (String) —

The sort order to use, either ascending (ASC) or descending (DESC).
:sort_by (String) —

Host configuration list sort options. (default to hostName)
:opc_request_id (String) —

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
:defined_tag_equals (Array<String>) —

A list of tag filters to apply. Only resources with a defined tag matching the value will be returned. Each item in the list has the format "namespace.tagName.value". All inputs are case-insensitive. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as "OR". Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as "AND".
:freeform_tag_equals (Array<String>) —

A list of tag filters to apply. Only resources with a freeform tag matching the value will be returned. The key for each tag is "tagName.value". All inputs are case-insensitive. Multiple values for the same tag name are interpreted as "OR". Values for different tag names are interpreted as "AND".
:defined_tag_exists (Array<String>) —

A list of tag existence filters to apply. Only resources for which the specified defined tags exist will be returned. Each item in the list has the format "namespace.tagName.true" (for checking existence of a defined tag) or "namespace.true". All inputs are case-insensitive. Currently, only existence ("true" at the end) is supported. Absence ("false" at the end) is not supported. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as "OR". Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as "AND".
:freeform_tag_exists (Array<String>) —

A list of tag existence filters to apply. Only resources for which the specified freeform tags exist the value will be returned. The key for each tag is "tagName.true". All inputs are case-insensitive. Currently, only existence ("true" at the end) is supported. Absence ("false" at the end) is not supported. Multiple values for different tag names are interpreted as "AND".
:compartment_id_in_subtree (BOOLEAN) —

A flag to search all resources within a given compartment and all sub-compartments. (default to false)
:host_type (Array<String>) —

Filter by one or more host types. Possible values are CLOUD-HOST, EXTERNAL-HOST, COMANAGED-VM-HOST, COMANAGED-BM-HOST, COMANAGED-EXACS-HOST (default to [])
:host_id (String) —

Optional OCID of the host (Compute Id)
:vmcluster_name (Array<String>) —

Optional list of Exadata Insight VM cluster name. (default to [])

Returns:

(Response) —

A Response object with data of type HostConfigurationCollection

# File 'lib/oci/opsi/operations_insights_client.rb', line 7165

def list_host_configurations(opts = {})
  logger.debug 'Calling operation OperationsInsightsClient#list_host_configurations.' if logger



  platform_type_allowable_values = %w[LINUX SOLARIS SUNOS ZLINUX WINDOWS AIX HP_UX]
  if opts[:platform_type] && !opts[:platform_type].empty?
    opts[:platform_type].each do |val_to_check|
      unless platform_type_allowable_values.include?(val_to_check)
        raise 'Invalid value for "platform_type", must be one of LINUX, SOLARIS, SUNOS, ZLINUX, WINDOWS, AIX, HP_UX.'
      end
    end
  end

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

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

  path = '/hostInsights/hostConfigurations'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = opts[:compartment_id] if opts[:compartment_id]
  query_params[:enterpriseManagerBridgeId] = opts[:enterprise_manager_bridge_id] if opts[:enterprise_manager_bridge_id]
  query_params[:id] = OCI::ApiClient.build_collection_params(opts[:id], :multi) if opts[:id] && !opts[:id].empty?
  query_params[:exadataInsightId] = OCI::ApiClient.build_collection_params(opts[:exadata_insight_id], :multi) if opts[:exadata_insight_id] && !opts[:exadata_insight_id].empty?
  query_params[:platformType] = OCI::ApiClient.build_collection_params(opts[:platform_type], :multi) if opts[:platform_type] && !opts[:platform_type].empty?
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:definedTagEquals] = OCI::ApiClient.build_collection_params(opts[:defined_tag_equals], :multi) if opts[:defined_tag_equals] && !opts[:defined_tag_equals].empty?
  query_params[:freeformTagEquals] = OCI::ApiClient.build_collection_params(opts[:freeform_tag_equals], :multi) if opts[:freeform_tag_equals] && !opts[:freeform_tag_equals].empty?
  query_params[:definedTagExists] = OCI::ApiClient.build_collection_params(opts[:defined_tag_exists], :multi) if opts[:defined_tag_exists] && !opts[:defined_tag_exists].empty?
  query_params[:freeformTagExists] = OCI::ApiClient.build_collection_params(opts[:freeform_tag_exists], :multi) if opts[:freeform_tag_exists] && !opts[:freeform_tag_exists].empty?
  query_params[:compartmentIdInSubtree] = opts[:compartment_id_in_subtree] if !opts[:compartment_id_in_subtree].nil?
  query_params[:hostType] = OCI::ApiClient.build_collection_params(opts[:host_type], :multi) if opts[:host_type] && !opts[:host_type].empty?
  query_params[:hostId] = opts[:host_id] if opts[:host_id]
  query_params[:vmclusterName] = OCI::ApiClient.build_collection_params(opts[:vmcluster_name], :multi) if opts[:vmcluster_name] && !opts[:vmcluster_name].empty?

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

  post_body = nil

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

#list_host_insights(opts = {}) ⇒ `Response`

Note:

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

Gets a list of host insights based on the query parameters specified. Either compartmentId or id query parameter must be specified. When both compartmentId and compartmentIdInSubtree are specified, a list of host insights in that compartment and in all sub-compartments will be returned.

Parameters:

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

the optional parameters

Options Hash (opts):

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

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

The OCID of the compartment.
:id (Array<String>) —

Optional list of host insight resource OCIDs. (default to [])
:status (Array<String>) —

Resource Status (default to [ENABLED]) Allowed values are: DISABLED, ENABLED, TERMINATED
:lifecycle_state (Array<String>) —

Lifecycle states (default to [ACTIVE]) Allowed values are: CREATING, UPDATING, ACTIVE, DELETING, DELETED, FAILED, NEEDS_ATTENTION
:host_type (Array<String>) —

Filter by one or more host types. Possible values are CLOUD-HOST, EXTERNAL-HOST, COMANAGED-VM-HOST, COMANAGED-BM-HOST, COMANAGED-EXACS-HOST (default to [])
:platform_type (Array<String>) —

Filter by one or more platform types. Supported platformType(s) for MACS-managed external host insight: [LINUX, SOLARIS, WINDOWS]. Supported platformType(s) for MACS-managed cloud host insight: [LINUX]. Supported platformType(s) for EM-managed external host insight: [LINUX, SOLARIS, SUNOS, ZLINUX, WINDOWS, AIX, HP-UX]. (default to []) Allowed values are: LINUX, SOLARIS, SUNOS, ZLINUX, WINDOWS, AIX, HP_UX
:limit (Integer) —

For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see List Pagination. Example: 50 (default to 50)
:page (String) —

For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination.
:sort_order (String) —

The sort order to use, either ascending (ASC) or descending (DESC).
:sort_by (String) —

Host insight list sort options. If fields parameter is selected, the sortBy parameter must be one of the fields specified.

Allowed values are: hostName, hostType
:enterprise_manager_bridge_id (String) —

Unique Enterprise Manager bridge identifier
:exadata_insight_id (String) —

OCID of exadata insight resource.
:compartment_id_in_subtree (BOOLEAN) —

A flag to search all resources within a given compartment and all sub-compartments. (default to false)
:opc_request_id (String) —

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:

(Response) —

A Response object with data of type HostInsightSummaryCollection

# File 'lib/oci/opsi/operations_insights_client.rb', line 7291

def list_host_insights(opts = {})
  logger.debug 'Calling operation OperationsInsightsClient#list_host_insights.' if logger



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


  lifecycle_state_allowable_values = %w[CREATING UPDATING ACTIVE DELETING DELETED FAILED NEEDS_ATTENTION]
  if opts[:lifecycle_state] && !opts[:lifecycle_state].empty?
    opts[:lifecycle_state].each do |val_to_check|
      unless lifecycle_state_allowable_values.include?(val_to_check)
        raise 'Invalid value for "lifecycle_state", must be one of CREATING, UPDATING, ACTIVE, DELETING, DELETED, FAILED, NEEDS_ATTENTION.'
      end
    end
  end


  platform_type_allowable_values = %w[LINUX SOLARIS SUNOS ZLINUX WINDOWS AIX HP_UX]
  if opts[:platform_type] && !opts[:platform_type].empty?
    opts[:platform_type].each do |val_to_check|
      unless platform_type_allowable_values.include?(val_to_check)
        raise 'Invalid value for "platform_type", must be one of LINUX, SOLARIS, SUNOS, ZLINUX, WINDOWS, AIX, HP_UX.'
      end
    end
  end

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

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

  path = '/hostInsights'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = opts[:compartment_id] if opts[:compartment_id]
  query_params[:id] = OCI::ApiClient.build_collection_params(opts[:id], :multi) if opts[:id] && !opts[:id].empty?
  query_params[:status] = OCI::ApiClient.build_collection_params(opts[:status], :multi) if opts[:status] && !opts[:status].empty?
  query_params[:lifecycleState] = OCI::ApiClient.build_collection_params(opts[:lifecycle_state], :multi) if opts[:lifecycle_state] && !opts[:lifecycle_state].empty?
  query_params[:hostType] = OCI::ApiClient.build_collection_params(opts[:host_type], :multi) if opts[:host_type] && !opts[:host_type].empty?
  query_params[:platformType] = OCI::ApiClient.build_collection_params(opts[:platform_type], :multi) if opts[:platform_type] && !opts[:platform_type].empty?
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:enterpriseManagerBridgeId] = opts[:enterprise_manager_bridge_id] if opts[:enterprise_manager_bridge_id]
  query_params[:exadataInsightId] = opts[:exadata_insight_id] if opts[:exadata_insight_id]
  query_params[:compartmentIdInSubtree] = opts[:compartment_id_in_subtree] if !opts[:compartment_id_in_subtree].nil?

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

  post_body = nil

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

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

Note:

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

Get a list of hosted entities details.

Parameters:

compartment_id (String) —

The OCID of the compartment.
id (String) —

Required OCID of the host insight 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
:analysis_time_interval (String) —

Specify time period in ISO 8601 format with respect to current time. Default is last 30 days represented by P30D. If timeInterval is specified, then timeIntervalStart and timeIntervalEnd will be ignored. Examples P90D (last 90 days), P4W (last 4 weeks), P2M (last 2 months), P1Y (last 12 months), . Maximum value allowed is 25 months prior to current time (P25M). (default to P30D)
:time_interval_start (DateTime) —

Analysis start time in UTC in ISO 8601 format(inclusive). Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). The minimum allowed value is 2 years prior to the current day. timeIntervalStart and timeIntervalEnd parameters are used together. If analysisTimeInterval is specified, this parameter is ignored.
:time_interval_end (DateTime) —

Analysis end time in UTC in ISO 8601 format(exclusive). Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). timeIntervalStart and timeIntervalEnd are used together. If timeIntervalEnd is not specified, current time is used as timeIntervalEnd.
:platform_type (Array<String>) —

Filter by one or more platform types. Supported platformType(s) for MACS-managed external host insight: [LINUX, SOLARIS, WINDOWS]. Supported platformType(s) for MACS-managed cloud host insight: [LINUX]. Supported platformType(s) for EM-managed external host insight: [LINUX, SOLARIS, SUNOS, ZLINUX, WINDOWS, AIX, HP-UX]. (default to []) Allowed values are: LINUX, SOLARIS, SUNOS, ZLINUX, WINDOWS, AIX, HP_UX
:exadata_insight_id (String) —

OCID of exadata insight resource.
:limit (Integer) —

For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see List Pagination. Example: 50 (default to 50)
:page (String) —

For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination.
:sort_order (String) —

The sort order to use, either ascending (ASC) or descending (DESC).
:sort_by (String) —

Hosted entity list sort options.

Allowed values are: entityName, entityType
:opc_request_id (String) —

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
:host_type (Array<String>) —

Filter by one or more host types. Possible values are CLOUD-HOST, EXTERNAL-HOST, COMANAGED-VM-HOST, COMANAGED-BM-HOST, COMANAGED-EXACS-HOST (default to [])
:host_id (String) —

Optional OCID of the host (Compute Id)

Returns:

(Response) —

A Response object with data of type HostedEntityCollection

# File 'lib/oci/opsi/operations_insights_client.rb', line 7443

def list_hosted_entities(compartment_id, id, opts = {})
  logger.debug 'Calling operation OperationsInsightsClient#list_hosted_entities.' if logger

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


  platform_type_allowable_values = %w[LINUX SOLARIS SUNOS ZLINUX WINDOWS AIX HP_UX]
  if opts[:platform_type] && !opts[:platform_type].empty?
    opts[:platform_type].each do |val_to_check|
      unless platform_type_allowable_values.include?(val_to_check)
        raise 'Invalid value for "platform_type", must be one of LINUX, SOLARIS, SUNOS, ZLINUX, WINDOWS, AIX, HP_UX.'
      end
    end
  end

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

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

  path = '/hostInsights/hostedEntities'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:id] = id
  query_params[:analysisTimeInterval] = opts[:analysis_time_interval] if opts[:analysis_time_interval]
  query_params[:timeIntervalStart] = opts[:time_interval_start] if opts[:time_interval_start]
  query_params[:timeIntervalEnd] = opts[:time_interval_end] if opts[:time_interval_end]
  query_params[:platformType] = OCI::ApiClient.build_collection_params(opts[:platform_type], :multi) if opts[:platform_type] && !opts[:platform_type].empty?
  query_params[:exadataInsightId] = opts[:exadata_insight_id] if opts[:exadata_insight_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]
  query_params[:hostType] = OCI::ApiClient.build_collection_params(opts[:host_type], :multi) if opts[:host_type] && !opts[:host_type].empty?
  query_params[:hostId] = opts[:host_id] if opts[:host_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: 'OperationsInsightsClient#list_hosted_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::Opsi::Models::HostedEntityCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

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

Note:

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

Gets a list of agent entities available to add a new hostInsight. An agent entity is "available" and will be shown if all the following conditions are true: 1. The agent OCID is not already being used for an existing hostInsight. 2. The agent availabilityStatus = 'ACTIVE' 3. The agent lifecycleState = 'ACTIVE'

Parameters:

compartment_id (String) —

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

the optional parameters

Options Hash (opts):

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

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

For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see List Pagination. Example: 50 (default to 50)
:page (String) —

For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination.
:sort_order (String) —

The sort order to use, either ascending (ASC) or descending (DESC).
:sort_by (String) —

Hosted entity list sort options.

Allowed values are: entityName, entityType
:opc_request_id (String) —

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:

(Response) —

A Response object with data of type ImportableAgentEntitySummaryCollection

# File 'lib/oci/opsi/operations_insights_client.rb', line 7550

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

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

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

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

  path = '/importableAgentEntities'
  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: 'OperationsInsightsClient#list_importable_agent_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::Opsi::Models::ImportableAgentEntitySummaryCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

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

Note:

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

Gets a list of available compute intances running cloud agent to add a new hostInsight. An Compute entity is "available" and will be shown if all the following conditions are true: 1. Compute is running OCA 2. OCI Management Agent is not enabled or If OCI Management Agent is enabled 2.1 The agent OCID is not already being used for an existing hostInsight. 2.2 The agent availabilityStatus = 'ACTIVE' 2.3 The agent lifecycleState = 'ACTIVE'

Parameters:

compartment_id (String) —

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

the optional parameters

Options Hash (opts):

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

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

For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see List Pagination. Example: 50 (default to 50)
:page (String) —

For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination.
:sort_order (String) —

The sort order to use, either ascending (ASC) or descending (DESC).
:sort_by (String) —

Compute entity list sort options.

Allowed values are: computeId, computeDisplayName, platformType, hostName
:opc_request_id (String) —

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:

(Response) —

A Response object with data of type ImportableComputeEntitySummaryCollection

# File 'lib/oci/opsi/operations_insights_client.rb', line 7640

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

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

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

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

  path = '/importableComputeEntities'
  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: 'OperationsInsightsClient#list_importable_compute_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::Opsi::Models::ImportableComputeEntitySummaryCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_importable_enterprise_manager_entities(enterprise_manager_bridge_id, opts = {}) ⇒ `Response`

Note:

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

Gets a list of importable entities for an Operations Insights Enterprise Manager bridge that have not been imported before.

Parameters:

enterprise_manager_bridge_id (String) —

Unique Enterprise Manager bridge identifier
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see List Pagination. Example: 50 (default to 50)
:page (String) —

For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination.
:enterprise_manager_entity_type (Array<String>) —

Filter by one or more Enterprise Manager entity types. Currently, the supported types are "oracle_pdb", "oracle_database", "host", "oracle_dbmachine", "oracle_exa_cloud_service", and "oracle_oci_exadata_cloud_service". If this parameter is not specified, targets of all supported entity types are returned by default. (default to [])
:enterprise_manager_identifier (String) —

Used in combination with enterpriseManagerParentEntityIdentifier to return the members of a particular Enterprise Manager parent entity. Both enterpriseManagerIdentifier and enterpriseManagerParentEntityIdentifier must be specified to identify a particular Enterprise Manager parent entity.
:enterprise_manager_parent_entity_identifier (String) —

Used in combination with enterpriseManagerIdentifier to return the members of a particular Enterprise Manager parent entity. Both enterpriseManagerIdentifier and enterpriseManagerParentEntityIdentifier must be specified to identify a particular Enterprise Manager parent entity.
:opc_request_id (String) —

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:

(Response) —

A Response object with data of type ImportableEnterpriseManagerEntityCollection

# File 'lib/oci/opsi/operations_insights_client.rb', line 7725

def list_importable_enterprise_manager_entities(enterprise_manager_bridge_id, opts = {})
  logger.debug 'Calling operation OperationsInsightsClient#list_importable_enterprise_manager_entities.' if logger

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

  path = '/enterpriseManagerBridges/{enterpriseManagerBridgeId}/importableEnterpriseManagerEntities'.sub('{enterpriseManagerBridgeId}', enterprise_manager_bridge_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[:enterpriseManagerEntityType] = OCI::ApiClient.build_collection_params(opts[:enterprise_manager_entity_type], :multi) if opts[:enterprise_manager_entity_type] && !opts[:enterprise_manager_entity_type].empty?
  query_params[:enterpriseManagerIdentifier] = opts[:enterprise_manager_identifier] if opts[:enterprise_manager_identifier]
  query_params[:enterpriseManagerParentEntityIdentifier] = opts[:enterprise_manager_parent_entity_identifier] if opts[:enterprise_manager_parent_entity_identifier]

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

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'OperationsInsightsClient#list_importable_enterprise_manager_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::Opsi::Models::ImportableEnterpriseManagerEntityCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_news_reports(opts = {}) ⇒ `Response`

Note:

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

Gets a list of news reports based on the query parameters specified. Either compartmentId or id query parameter must be specified.

Parameters:

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

the optional parameters

Options Hash (opts):

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

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

The OCID of the compartment.
:news_report_id (String) —

Unique Operations Insights news report identifier
:status (Array<String>) —

Resource Status (default to [ENABLED]) Allowed values are: DISABLED, ENABLED, TERMINATED
:lifecycle_state (Array<String>) —

Lifecycle states (default to [ACTIVE]) Allowed values are: CREATING, UPDATING, ACTIVE, DELETING, DELETED, FAILED, NEEDS_ATTENTION
:limit (Integer) —

For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see List Pagination. Example: 50 (default to 50)
:page (String) —

For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination.
:sort_order (String) —

The sort order to use, either ascending (ASC) or descending (DESC).
:sort_by (String) —

News report list sort options. If fields parameter is selected, the sortBy parameter must be one of the fields specified.

Allowed values are: name, newsFrequency
:compartment_id_in_subtree (BOOLEAN) —

A flag to search all resources within a given compartment and all sub-compartments. (default to false)
:opc_request_id (String) —

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:

(Response) —

A Response object with data of type NewsReportCollection

# File 'lib/oci/opsi/operations_insights_client.rb', line 7809

def list_news_reports(opts = {})
  logger.debug 'Calling operation OperationsInsightsClient#list_news_reports.' if logger



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


  lifecycle_state_allowable_values = %w[CREATING UPDATING ACTIVE DELETING DELETED FAILED NEEDS_ATTENTION]
  if opts[:lifecycle_state] && !opts[:lifecycle_state].empty?
    opts[:lifecycle_state].each do |val_to_check|
      unless lifecycle_state_allowable_values.include?(val_to_check)
        raise 'Invalid value for "lifecycle_state", must be one of CREATING, UPDATING, ACTIVE, DELETING, DELETED, FAILED, NEEDS_ATTENTION.'
      end
    end
  end

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

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

  path = '/newsReports'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = opts[:compartment_id] if opts[:compartment_id]
  query_params[:newsReportId] = opts[:news_report_id] if opts[:news_report_id]
  query_params[:status] = OCI::ApiClient.build_collection_params(opts[:status], :multi) if opts[:status] && !opts[:status].empty?
  query_params[:lifecycleState] = OCI::ApiClient.build_collection_params(opts[:lifecycle_state], :multi) if opts[:lifecycle_state] && !opts[:lifecycle_state].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]
  query_params[:compartmentIdInSubtree] = opts[:compartment_id_in_subtree] if !opts[:compartment_id_in_subtree].nil?

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

  post_body = nil

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

#list_operations_insights_private_endpoints(opts = {}) ⇒ `Response`

Note:

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

Gets a list of Operation Insights private endpoints. Allowed values are: timeCreated, id, displayName

Parameters:

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

the optional parameters

Options Hash (opts):

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

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

The OCID of the compartment.
:display_name (String) —

A filter to return only resources that match the entire display name.
:opsi_private_endpoint_id (String) —

Unique Operations Insights PrivateEndpoint identifier
:is_used_for_rac_dbs (BOOLEAN) —

The option to filter OPSI private endpoints that can used for RAC. Should be used along with vcnId query parameter. (default to false)
:vcn_id (String) —

The OCID of the VCN.
:lifecycle_state (Array<String>) —

Lifecycle states (default to []) Allowed values are: CREATING, UPDATING, ACTIVE, DELETING, DELETED, FAILED, NEEDS_ATTENTION
:limit (Integer) —

For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see List Pagination. Example: 50 (default to 50)
:page (String) —

For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination.
:sort_order (String) —

The sort order to use, either ascending (ASC) or descending (DESC).
:sort_by (String) —

The field to sort private endpoints. (default to timeCreated)
:compartment_id_in_subtree (BOOLEAN) —

A flag to search all resources within a given compartment and all sub-compartments. (default to false)
:opc_request_id (String) —

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:

(Response) —

A Response object with data of type OperationsInsightsPrivateEndpointCollection

# File 'lib/oci/opsi/operations_insights_client.rb', line 7923

def list_operations_insights_private_endpoints(opts = {})
  logger.debug 'Calling operation OperationsInsightsClient#list_operations_insights_private_endpoints.' if logger



  lifecycle_state_allowable_values = %w[CREATING UPDATING ACTIVE DELETING DELETED FAILED NEEDS_ATTENTION]
  if opts[:lifecycle_state] && !opts[:lifecycle_state].empty?
    opts[:lifecycle_state].each do |val_to_check|
      unless lifecycle_state_allowable_values.include?(val_to_check)
        raise 'Invalid value for "lifecycle_state", must be one of CREATING, UPDATING, ACTIVE, DELETING, DELETED, FAILED, NEEDS_ATTENTION.'
      end
    end
  end

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

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

  path = '/operationsInsightsPrivateEndpoints'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = opts[:compartment_id] if opts[:compartment_id]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:opsiPrivateEndpointId] = opts[:opsi_private_endpoint_id] if opts[:opsi_private_endpoint_id]
  query_params[:isUsedForRacDbs] = opts[:is_used_for_rac_dbs] if !opts[:is_used_for_rac_dbs].nil?
  query_params[:vcnId] = opts[:vcn_id] if opts[:vcn_id]
  query_params[:lifecycleState] = OCI::ApiClient.build_collection_params(opts[:lifecycle_state], :multi) if opts[:lifecycle_state] && !opts[:lifecycle_state].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]
  query_params[:compartmentIdInSubtree] = opts[:compartment_id_in_subtree] if !opts[:compartment_id_in_subtree].nil?

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

  post_body = nil

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

#list_operations_insights_warehouse_users(operations_insights_warehouse_id, opts = {}) ⇒ `Response`

Note:

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

Gets a list of Operations Insights Warehouse users. Either compartmentId or id must be specified. All these resources are expected to be in root compartment.

Allowed values are: timeCreated, displayName

Parameters:

operations_insights_warehouse_id (String) —

Unique Operations Insights Warehouse identifier
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

The OCID of the compartment.
:display_name (String) —

A filter to return only resources that match the entire display name.
:id (String) —

Unique Operations Insights Warehouse User identifier
:lifecycle_state (Array<String>) —

Lifecycle states (default to []) Allowed values are: CREATING, UPDATING, ACTIVE, DELETING, DELETED, FAILED
:limit (Integer) —

For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see List Pagination. Example: 50 (default to 50)
:page (String) —

For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination.
:sort_order (String) —

The sort order to use, either ascending (ASC) or descending (DESC).
: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) —

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:

(Response) —

A Response object with data of type OperationsInsightsWarehouseUserSummaryCollection

# File 'lib/oci/opsi/operations_insights_client.rb', line 8027

def list_operations_insights_warehouse_users(operations_insights_warehouse_id, opts = {})
  logger.debug 'Calling operation OperationsInsightsClient#list_operations_insights_warehouse_users.' if logger

  raise "Missing the required parameter 'operations_insights_warehouse_id' when calling list_operations_insights_warehouse_users." if operations_insights_warehouse_id.nil?


  lifecycle_state_allowable_values = %w[CREATING UPDATING ACTIVE DELETING DELETED FAILED]
  if opts[:lifecycle_state] && !opts[:lifecycle_state].empty?
    opts[:lifecycle_state].each do |val_to_check|
      unless lifecycle_state_allowable_values.include?(val_to_check)
        raise 'Invalid value for "lifecycle_state", must be one of CREATING, UPDATING, ACTIVE, DELETING, DELETED, FAILED.'
      end
    end
  end

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

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:operationsInsightsWarehouseId] = operations_insights_warehouse_id
  query_params[:compartmentId] = opts[:compartment_id] if opts[:compartment_id]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:id] = opts[:id] if opts[:id]
  query_params[:lifecycleState] = OCI::ApiClient.build_collection_params(opts[:lifecycle_state], :multi) if opts[:lifecycle_state] && !opts[:lifecycle_state].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: 'OperationsInsightsClient#list_operations_insights_warehouse_users') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Opsi::Models::OperationsInsightsWarehouseUserSummaryCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_operations_insights_warehouses(opts = {}) ⇒ `Response`

Note:

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

Gets a list of Operations Insights warehouses. Either compartmentId or id must be specified. There is only expected to be 1 warehouse per tenant. The warehouse is expected to be in the root compartment.

Allowed values are: timeCreated, displayName

Parameters:

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

the optional parameters

Options Hash (opts):

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

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

The OCID of the compartment.
:display_name (String) —

A filter to return only resources that match the entire display name.
:id (String) —

Unique Operations Insights Warehouse identifier
:lifecycle_state (Array<String>) —

Lifecycle states (default to []) Allowed values are: CREATING, UPDATING, ACTIVE, DELETING, DELETED, FAILED
:limit (Integer) —

For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see List Pagination. Example: 50 (default to 50)
:page (String) —

For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination.
:sort_order (String) —

The sort order to use, either ascending (ASC) or descending (DESC).
: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) —

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:

(Response) —

A Response object with data of type OperationsInsightsWarehouseSummaryCollection

# File 'lib/oci/opsi/operations_insights_client.rb', line 8130

def list_operations_insights_warehouses(opts = {})
  logger.debug 'Calling operation OperationsInsightsClient#list_operations_insights_warehouses.' if logger



  lifecycle_state_allowable_values = %w[CREATING UPDATING ACTIVE DELETING DELETED FAILED]
  if opts[:lifecycle_state] && !opts[:lifecycle_state].empty?
    opts[:lifecycle_state].each do |val_to_check|
      unless lifecycle_state_allowable_values.include?(val_to_check)
        raise 'Invalid value for "lifecycle_state", must be one of CREATING, UPDATING, ACTIVE, DELETING, DELETED, FAILED.'
      end
    end
  end

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

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = opts[:compartment_id] if opts[:compartment_id]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:id] = opts[:id] if opts[:id]
  query_params[:lifecycleState] = OCI::ApiClient.build_collection_params(opts[:lifecycle_state], :multi) if opts[:lifecycle_state] && !opts[:lifecycle_state].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: 'OperationsInsightsClient#list_operations_insights_warehouses') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Opsi::Models::OperationsInsightsWarehouseSummaryCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

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

Note:

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

Gets a list of OPSI configuration resources based on the query parameters specified.

Parameters:

compartment_id (String) —

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

the optional parameters

Options Hash (opts):

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

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

Filter to return based on resources that match the entire display name.
:lifecycle_state (Array<String>) —

Filter to return based on Lifecycle state of OPSI configuration. (default to [ACTIVE]) Allowed values are: CREATING, UPDATING, ACTIVE, DELETING, DELETED, FAILED
:opsi_config_type (Array<String>) —

Filter to return based on configuration type of OPSI configuration. (default to []) Allowed values are: UX_CONFIGURATION
:limit (Integer) —

For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see List Pagination. Example: 50 (default to 50)
:page (String) —

For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination.
:sort_order (String) —

The sort order to use, either ascending (ASC) or descending (DESC).
:sort_by (String) —

OPSI configurations list sort options.

Allowed values are: displayName
:opc_request_id (String) —

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:

(Response) —

A Response object with data of type OpsiConfigurationsCollection

# File 'lib/oci/opsi/operations_insights_client.rb', line 8231

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

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


  lifecycle_state_allowable_values = %w[CREATING UPDATING ACTIVE DELETING DELETED FAILED]
  if opts[:lifecycle_state] && !opts[:lifecycle_state].empty?
    opts[:lifecycle_state].each do |val_to_check|
      unless lifecycle_state_allowable_values.include?(val_to_check)
        raise 'Invalid value for "lifecycle_state", must be one of CREATING, UPDATING, ACTIVE, DELETING, DELETED, FAILED.'
      end
    end
  end


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

  if opts[:sort_order] && !OCI::Opsi::Models::SORT_ORDER_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::Opsi::Models::SORT_ORDER_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 = '/opsiConfigurations'
  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] = OCI::ApiClient.build_collection_params(opts[:lifecycle_state], :multi) if opts[:lifecycle_state] && !opts[:lifecycle_state].empty?
  query_params[:opsiConfigType] = OCI::ApiClient.build_collection_params(opts[:opsi_config_type], :multi) if opts[:opsi_config_type] && !opts[:opsi_config_type].empty?
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]

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

  post_body = nil

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

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

Note:

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

Gets a list of OPSI data objects based on the query parameters specified. CompartmentId id query parameter must be specified.

Parameters:

compartment_id (String) —

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

the optional parameters

Options Hash (opts):

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

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

OPSI data object types. (default to []) Allowed values are: DATABASE_INSIGHTS_DATA_OBJECT, HOST_INSIGHTS_DATA_OBJECT, EXADATA_INSIGHTS_DATA_OBJECT
:display_name (String) —

A filter to return only resources that match the entire display name.
:limit (Integer) —

For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see List Pagination. Example: 50 (default to 50)
:page (String) —

For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination.
:sort_order (String) —

The sort order to use, either ascending (ASC) or descending (DESC).
:sort_by (String) —

OPSI data object list sort options.

Allowed values are: displayName, dataObjectType, name
:group_name (String) —

A filter to return only data objects that belongs to the group of the given group name. By default, no filtering will be applied on group name.
:name (String) —

A filter to return only data objects that match the entire data object name. By default, no filtering will be applied on data object name.
:opc_request_id (String) —

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:

(Response) —

A Response object with data of type OpsiDataObjectsCollection

# File 'lib/oci/opsi/operations_insights_client.rb', line 8343

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

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


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

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

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

  path = '/opsiDataObjects'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:dataObjectType] = OCI::ApiClient.build_collection_params(opts[:data_object_type], :multi) if opts[:data_object_type] && !opts[:data_object_type].empty?
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:groupName] = opts[:group_name] if opts[:group_name]
  query_params[:name] = opts[:name] if opts[:name]

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

  post_body = nil

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

#list_sql_plans(compartment_id, sql_identifier, plan_hash, opts = {}) ⇒ `Response`

Note:

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

Query SQL Warehouse to list the plan xml for a given SQL execution plan. This returns a SqlPlanCollection object, but is currently limited to a single plan. Either databaseId or id must be specified.

Parameters:

compartment_id (String) —

The OCID of the compartment.
sql_identifier (String) —

Unique SQL_ID for a SQL Statement. Example: 6rgjh9bjmy2s7
plan_hash (Array<Integer>) —

Unique plan hash for a SQL Plan of a particular SQL Statement. Example: 9820154385
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

Optional OCID of the associated DBaaS entity.
:id (String) —

OCID of the database insight resource.
:page (String) —

For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination.
:opc_request_id (String) —

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:

(Response) —

A Response object with data of type SqlPlanCollection

# File 'lib/oci/opsi/operations_insights_client.rb', line 8441

def list_sql_plans(compartment_id, sql_identifier, plan_hash, opts = {})
  logger.debug 'Calling operation OperationsInsightsClient#list_sql_plans.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_sql_plans." if compartment_id.nil?
  raise "Missing the required parameter 'sql_identifier' when calling list_sql_plans." if sql_identifier.nil?
  raise "Missing the required parameter 'plan_hash' when calling list_sql_plans." if plan_hash.nil?

  path = '/databaseInsights/sqlPlans'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:sqlIdentifier] = sql_identifier
  query_params[:planHash] = OCI::ApiClient.build_collection_params(plan_hash, :multi)
  query_params[:databaseId] = opts[:database_id] if opts[:database_id]
  query_params[:id] = opts[:id] if opts[:id]
  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: 'OperationsInsightsClient#list_sql_plans') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Opsi::Models::SqlPlanCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

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

Note:

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

Search SQL by SQL Identifier across databases in a compartment and in all sub-compartments if specified. And get the SQL Text and the details of the databases executing the SQL for a given time period.

Parameters:

compartment_id (String) —

The OCID of the compartment.
sql_identifier (String) —

Unique SQL_ID for a SQL Statement. Example: 6rgjh9bjmy2s7
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

Specify time period in ISO 8601 format with respect to current time. Default is last 30 days represented by P30D. If timeInterval is specified, then timeIntervalStart and timeIntervalEnd will be ignored. Examples P90D (last 90 days), P4W (last 4 weeks), P2M (last 2 months), P1Y (last 12 months), . Maximum value allowed is 25 months prior to current time (P25M). (default to P30D)
:time_interval_start (DateTime) —

Analysis start time in UTC in ISO 8601 format(inclusive). Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). The minimum allowed value is 2 years prior to the current day. timeIntervalStart and timeIntervalEnd parameters are used together. If analysisTimeInterval is specified, this parameter is ignored.
:time_interval_end (DateTime) —

Analysis end time in UTC in ISO 8601 format(exclusive). Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). timeIntervalStart and timeIntervalEnd are used together. If timeIntervalEnd is not specified, current time is used as timeIntervalEnd.
:page (String) —

For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination.
:opc_request_id (String) —

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
:defined_tag_equals (Array<String>) —

A list of tag filters to apply. Only resources with a defined tag matching the value will be returned. Each item in the list has the format "namespace.tagName.value". All inputs are case-insensitive. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as "OR". Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as "AND".
:freeform_tag_equals (Array<String>) —

A list of tag filters to apply. Only resources with a freeform tag matching the value will be returned. The key for each tag is "tagName.value". All inputs are case-insensitive. Multiple values for the same tag name are interpreted as "OR". Values for different tag names are interpreted as "AND".
:defined_tag_exists (Array<String>) —

A list of tag existence filters to apply. Only resources for which the specified defined tags exist will be returned. Each item in the list has the format "namespace.tagName.true" (for checking existence of a defined tag) or "namespace.true". All inputs are case-insensitive. Currently, only existence ("true" at the end) is supported. Absence ("false" at the end) is not supported. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as "OR". Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as "AND".
:freeform_tag_exists (Array<String>) —

A list of tag existence filters to apply. Only resources for which the specified freeform tags exist the value will be returned. The key for each tag is "tagName.true". All inputs are case-insensitive. Currently, only existence ("true" at the end) is supported. Absence ("false" at the end) is not supported. Multiple values for different tag names are interpreted as "AND".
:compartment_id_in_subtree (BOOLEAN) —

A flag to search all resources within a given compartment and all sub-compartments. (default to false)

Returns:

(Response) —

A Response object with data of type SqlSearchCollection

# File 'lib/oci/opsi/operations_insights_client.rb', line 8552

def list_sql_searches(compartment_id, sql_identifier, opts = {})
  logger.debug 'Calling operation OperationsInsightsClient#list_sql_searches.' if logger

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

  path = '/databaseInsights/sqlSearches'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:sqlIdentifier] = sql_identifier
  query_params[:analysisTimeInterval] = opts[:analysis_time_interval] if opts[:analysis_time_interval]
  query_params[:timeIntervalStart] = opts[:time_interval_start] if opts[:time_interval_start]
  query_params[:timeIntervalEnd] = opts[:time_interval_end] if opts[:time_interval_end]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:definedTagEquals] = OCI::ApiClient.build_collection_params(opts[:defined_tag_equals], :multi) if opts[:defined_tag_equals] && !opts[:defined_tag_equals].empty?
  query_params[:freeformTagEquals] = OCI::ApiClient.build_collection_params(opts[:freeform_tag_equals], :multi) if opts[:freeform_tag_equals] && !opts[:freeform_tag_equals].empty?
  query_params[:definedTagExists] = OCI::ApiClient.build_collection_params(opts[:defined_tag_exists], :multi) if opts[:defined_tag_exists] && !opts[:defined_tag_exists].empty?
  query_params[:freeformTagExists] = OCI::ApiClient.build_collection_params(opts[:freeform_tag_exists], :multi) if opts[:freeform_tag_exists] && !opts[:freeform_tag_exists].empty?
  query_params[:compartmentIdInSubtree] = opts[:compartment_id_in_subtree] if !opts[:compartment_id_in_subtree].nil?

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

  post_body = nil

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

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

Note:

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

Query SQL Warehouse to get the full SQL Text for a SQL in a compartment and in all sub-compartments if specified.

Parameters:

compartment_id (String) —

The OCID of the compartment.
sql_identifier (Array<String>) —

One or more unique SQL_IDs for a SQL Statement. Example: 6rgjh9bjmy2s7
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

Optional list of database OCIDs of the assosicated DBaaS entity. (default to [])
:id (Array<String>) —

Optional list of database OCIDs of the database insight resource. (default to [])
:page (String) —

For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination.
:opc_request_id (String) —

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
:defined_tag_equals (Array<String>) —

A list of tag filters to apply. Only resources with a defined tag matching the value will be returned. Each item in the list has the format "namespace.tagName.value". All inputs are case-insensitive. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as "OR". Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as "AND".
:freeform_tag_equals (Array<String>) —

A list of tag filters to apply. Only resources with a freeform tag matching the value will be returned. The key for each tag is "tagName.value". All inputs are case-insensitive. Multiple values for the same tag name are interpreted as "OR". Values for different tag names are interpreted as "AND".
:defined_tag_exists (Array<String>) —

A list of tag existence filters to apply. Only resources for which the specified defined tags exist will be returned. Each item in the list has the format "namespace.tagName.true" (for checking existence of a defined tag) or "namespace.true". All inputs are case-insensitive. Currently, only existence ("true" at the end) is supported. Absence ("false" at the end) is not supported. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as "OR". Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as "AND".
:freeform_tag_exists (Array<String>) —

A list of tag existence filters to apply. Only resources for which the specified freeform tags exist the value will be returned. The key for each tag is "tagName.true". All inputs are case-insensitive. Currently, only existence ("true" at the end) is supported. Absence ("false" at the end) is not supported. Multiple values for different tag names are interpreted as "AND".
:compartment_id_in_subtree (BOOLEAN) —

A flag to search all resources within a given compartment and all sub-compartments. (default to false)

Returns:

(Response) —

A Response object with data of type SqlTextCollection

# File 'lib/oci/opsi/operations_insights_client.rb', line 8654

def list_sql_texts(compartment_id, sql_identifier, opts = {})
  logger.debug 'Calling operation OperationsInsightsClient#list_sql_texts.' if logger

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

  path = '/databaseInsights/sqlTexts'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:sqlIdentifier] = OCI::ApiClient.build_collection_params(sql_identifier, :multi)
  query_params[:databaseId] = OCI::ApiClient.build_collection_params(opts[:database_id], :multi) if opts[:database_id] && !opts[:database_id].empty?
  query_params[:id] = OCI::ApiClient.build_collection_params(opts[:id], :multi) if opts[:id] && !opts[:id].empty?
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:definedTagEquals] = OCI::ApiClient.build_collection_params(opts[:defined_tag_equals], :multi) if opts[:defined_tag_equals] && !opts[:defined_tag_equals].empty?
  query_params[:freeformTagEquals] = OCI::ApiClient.build_collection_params(opts[:freeform_tag_equals], :multi) if opts[:freeform_tag_equals] && !opts[:freeform_tag_equals].empty?
  query_params[:definedTagExists] = OCI::ApiClient.build_collection_params(opts[:defined_tag_exists], :multi) if opts[:defined_tag_exists] && !opts[:defined_tag_exists].empty?
  query_params[:freeformTagExists] = OCI::ApiClient.build_collection_params(opts[:freeform_tag_exists], :multi) if opts[:freeform_tag_exists] && !opts[:freeform_tag_exists].empty?
  query_params[:compartmentIdInSubtree] = opts[:compartment_id_in_subtree] if !opts[:compartment_id_in_subtree].nil?

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

  post_body = nil

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

#list_warehouse_data_objects(warehouse_type, warehouse_id, opts = {}) ⇒ `Response`

Note:

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

Gets a list of Warehouse data objects (e.g: views, tables), based on the query parameters specified.

Allowed values are: details

Parameters:

warehouse_type (String) —

Type of the Warehouse. Allowed values are: awrHubs
warehouse_id (String) —

The OCID of a Warehouse.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

A filter to return only data objects that match the data object type. By default, no filtering will be applied on data object type. (default to []) Allowed values are: VIEW, TABLE
:name (String) —

A filter to return only data objects that match the entire data object name. By default, no filtering will be applied on data object name.
:owner (String) —

A filter to return only data objects that match the entire data object owner name. By default, no filtering will be applied on data object owner name.
:limit (Integer) —

For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see List Pagination. Example: 50 (default to 50)
:page (String) —

For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination.
:sort_order (String) —

The sort order to use, either ascending (ASC) or descending (DESC).
:sort_by (String) —

Sort options for Warehouse data objects list. Allowed values are: dataObjectType, name, owner
:summary_field (Array<String>) —

Specifies the optional fields to return in a WarehouseDataObjectSummary. Unless requested, these fields are not returned by default. (default to [])
:opc_request_id (String) —

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:

(Response) —

A Response object with data of type WarehouseDataObjectCollection

# File 'lib/oci/opsi/operations_insights_client.rb', line 8745

def list_warehouse_data_objects(warehouse_type, warehouse_id, opts = {})
  logger.debug 'Calling operation OperationsInsightsClient#list_warehouse_data_objects.' if logger

  raise "Missing the required parameter 'warehouse_type' when calling list_warehouse_data_objects." if warehouse_type.nil?
  unless %w[awrHubs].include?(warehouse_type)
    raise "Invalid value for 'warehouse_type', must be one of awrHubs."
  end
  raise "Missing the required parameter 'warehouse_id' when calling list_warehouse_data_objects." if warehouse_id.nil?


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

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

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


  summary_field_allowable_values = %w[details]
  if opts[:summary_field] && !opts[:summary_field].empty?
    opts[:summary_field].each do |val_to_check|
      unless summary_field_allowable_values.include?(val_to_check)
        raise 'Invalid value for "summary_field", must be one of details.'
      end
    end
  end
  raise "Parameter value for 'warehouse_type' must not be blank" if OCI::Internal::Util.blank_string?(warehouse_type)
  raise "Parameter value for 'warehouse_id' must not be blank" if OCI::Internal::Util.blank_string?(warehouse_id)

  path = '/{warehouseType}/{warehouseId}/dataObjects'.sub('{warehouseType}', warehouse_type.to_s).sub('{warehouseId}', warehouse_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:dataObjectType] = OCI::ApiClient.build_collection_params(opts[:data_object_type], :multi) if opts[:data_object_type] && !opts[:data_object_type].empty?
  query_params[:name] = opts[:name] if opts[:name]
  query_params[:owner] = opts[:owner] if opts[:owner]
  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[:summaryField] = OCI::ApiClient.build_collection_params(opts[:summary_field], :multi) if opts[:summary_field] && !opts[:summary_field].empty?

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

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'OperationsInsightsClient#list_warehouse_data_objects') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Opsi::Models::WarehouseDataObjectCollection'
    )
  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.

Return a (paginated) list of errors for a given work request.

Allowed values are: timeAccepted

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

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
:page (String) —

For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination.
:limit (Integer) —

For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see List Pagination. Example: 50 (default to 50)
:sort_by (String) —

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

The sort order to use, either ascending (ASC) or descending (DESC).

Returns:

(Response) —

A Response object with data of type WorkRequestErrorCollection

# File 'lib/oci/opsi/operations_insights_client.rb', line 8858

def list_work_request_errors(work_request_id, opts = {})
  logger.debug 'Calling operation OperationsInsightsClient#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[timeAccepted].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of timeAccepted.'
  end

  if opts[:sort_order] && !OCI::Opsi::Models::SORT_ORDER_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::Opsi::Models::SORT_ORDER_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: 'OperationsInsightsClient#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::Opsi::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.

Return a (paginated) list of logs for a given work request.

Allowed values are: timeAccepted

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

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
:page (String) —

For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination.
:limit (Integer) —

For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see List Pagination. Example: 50 (default to 50)
:sort_by (String) —

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

The sort order to use, either ascending (ASC) or descending (DESC).

Returns:

(Response) —

A Response object with data of type WorkRequestLogEntryCollection

# File 'lib/oci/opsi/operations_insights_client.rb', line 8942

def list_work_request_logs(work_request_id, opts = {})
  logger.debug 'Calling operation OperationsInsightsClient#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[timeAccepted].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of timeAccepted.'
  end

  if opts[:sort_order] && !OCI::Opsi::Models::SORT_ORDER_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::Opsi::Models::SORT_ORDER_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: 'OperationsInsightsClient#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::Opsi::Models::WorkRequestLogEntryCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

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

Note:

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

Lists the work requests in a compartment. Either compartmentId or id must be specified. Only one of id, resourceId or relatedResourceId can be specified optionally.

Allowed values are: timeAccepted

Parameters:

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

the optional parameters

Options Hash (opts):

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

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

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
:page (String) —

For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination.
:limit (Integer) —

For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see List Pagination. Example: 50 (default to 50)
:compartment_id (String) —

The OCID of the compartment.
:id (String) —

The ID of the asynchronous work request.
:status (String) —

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

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

The ID of the related resource for the resource affected by the work request, e.g. the related Exadata Insight OCID of the Database Insight work request
:sort_order (String) —

The sort order to use, either ascending (ASC) or descending (DESC).
:sort_by (String) —

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

Returns:

(Response) —

A Response object with data of type WorkRequestCollection

# File 'lib/oci/opsi/operations_insights_client.rb', line 9030

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


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

  if opts[:sort_order] && !OCI::Opsi::Models::SORT_ORDER_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::Opsi::Models::SORT_ORDER_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[:page] = opts[:page] if opts[:page]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:compartmentId] = opts[:compartment_id] if opts[:compartment_id]
  query_params[:id] = opts[:id] if opts[:id]
  query_params[:status] = opts[:status] if opts[:status]
  query_params[:resourceId] = opts[:resource_id] if opts[:resource_id]
  query_params[:relatedResourceId] = opts[:related_resource_id] if opts[:related_resource_id]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]

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

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'OperationsInsightsClient#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::Opsi::Models::WorkRequestCollection'
    )
  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/opsi/operations_insights_client.rb', line 96

def logger
  @api_client.config.logger
end

#put_awr_hub_object(put_awr_hub_object_body, awr_hub_source_id, object_name, opts = {}) ⇒ `Response`

Note:

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

Creates a new object or overwrites an existing object with the same name to the Awr Hub.

Parameters:

put_awr_hub_object_body (String, IO) —

The object to be uploaded to the Awr Hub.
awr_hub_source_id (String) —

Unique Awr Hub Source identifier
object_name (String) —

Unique Awr Hub Object identifier
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

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

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:

(Response) —

A Response object with data of type nil

# File 'lib/oci/opsi/operations_insights_client.rb', line 9112

def put_awr_hub_object(put_awr_hub_object_body, awr_hub_source_id, object_name, opts = {})
  logger.debug 'Calling operation OperationsInsightsClient#put_awr_hub_object.' if logger

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

  path = '/awrHubObjects/awrHubSources/{awrHubSourceId}/o/{objectName}'.sub('{awrHubSourceId}', awr_hub_source_id.to_s).sub('{objectName}', object_name.to_s)
  operation_signing_strategy = :exclude_body

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

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

  post_body = @api_client.object_to_http_body(put_awr_hub_object_body)

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

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

Note:

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

Queries an OPSI data object with the inputs provided and sends the result set back. Either analysisTimeInterval or timeIntervalStart and timeIntervalEnd parameters need to be passed as well.

Parameters:

compartment_id (String) —

The OCID of the compartment.
query_opsi_data_object_data_details (OCI::Opsi::Models::QueryOpsiDataObjectDataDetails) —

The information to be used for querying an OPSI data object.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see List Pagination. Example: 50 (default to 50)
:page (String) —

For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination.
:opc_request_id (String) —

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:

(Response) —

A Response object with data of type QueryDataObjectResultSetRowsCollection

# File 'lib/oci/opsi/operations_insights_client.rb', line 9184

def query_opsi_data_object_data(compartment_id, query_opsi_data_object_data_details, opts = {})
  logger.debug 'Calling operation OperationsInsightsClient#query_opsi_data_object_data.' if logger

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

  path = '/opsiDataObjects/actions/queryData'
  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 = @api_client.object_to_http_body(query_opsi_data_object_data_details)

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

#query_warehouse_data_object_data(warehouse_type, warehouse_id, query_warehouse_data_object_data_details, opts = {}) ⇒ `Response`

Note:

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

Queries Warehouse data objects (e.g: views, tables) with the inputs provided and sends the result set back. Any data to which an OperationsInsightsWarehouseUser with a permission to the corresponding Warehouse can be queried.

Parameters:

warehouse_type (String) —

Type of the Warehouse. Allowed values are: awrHubs
warehouse_id (String) —

The OCID of a Warehouse.
query_warehouse_data_object_data_details (OCI::Opsi::Models::QueryWarehouseDataObjectDataDetails) —

The information to be used for querying a Warehouse.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see List Pagination. Example: 50 (default to 50)
:page (String) —

For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination.
:opc_request_id (String) —

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:

(Response) —

A Response object with data of type QueryDataObjectResultSetRowsCollection

# File 'lib/oci/opsi/operations_insights_client.rb', line 9259

def query_warehouse_data_object_data(warehouse_type, warehouse_id, query_warehouse_data_object_data_details, opts = {})
  logger.debug 'Calling operation OperationsInsightsClient#query_warehouse_data_object_data.' if logger

  raise "Missing the required parameter 'warehouse_type' when calling query_warehouse_data_object_data." if warehouse_type.nil?
  unless %w[awrHubs].include?(warehouse_type)
    raise "Invalid value for 'warehouse_type', must be one of awrHubs."
  end
  raise "Missing the required parameter 'warehouse_id' when calling query_warehouse_data_object_data." if warehouse_id.nil?
  raise "Missing the required parameter 'query_warehouse_data_object_data_details' when calling query_warehouse_data_object_data." if query_warehouse_data_object_data_details.nil?
  raise "Parameter value for 'warehouse_type' must not be blank" if OCI::Internal::Util.blank_string?(warehouse_type)
  raise "Parameter value for 'warehouse_id' must not be blank" if OCI::Internal::Util.blank_string?(warehouse_id)

  path = '/{warehouseType}/{warehouseId}/actions/queryData'.sub('{warehouseType}', warehouse_type.to_s).sub('{warehouseId}', warehouse_id.to_s)
  operation_signing_strategy = :standard

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

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

  post_body = @api_client.object_to_http_body(query_warehouse_data_object_data_details)

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

#rotate_operations_insights_warehouse_wallet(operations_insights_warehouse_id, opts = {}) ⇒ `Response`

Note:

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

Rotate the ADW wallet for Operations Insights Warehouse using which the Hub data is exposed.

Parameters:

operations_insights_warehouse_id (String) —

Unique Operations Insights Warehouse identifier
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
:if_match (String) —

Used for optimistic concurrency control. In the update or delete call for a resource, set the if-match parameter to the value of the etag from a previous get, create, or update 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/opsi/operations_insights_client.rb', line 9327

def rotate_operations_insights_warehouse_wallet(operations_insights_warehouse_id, opts = {})
  logger.debug 'Calling operation OperationsInsightsClient#rotate_operations_insights_warehouse_wallet.' if logger

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

  path = '/operationsInsightsWarehouses/{operationsInsightsWarehouseId}/actions/rotateWarehouseWallet'.sub('{operationsInsightsWarehouseId}', operations_insights_warehouse_id.to_s)
  operation_signing_strategy = :standard

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

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

  post_body = nil

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

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

Note:

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

Summarizes ADDM findings for the specified databases.

Parameters:

compartment_id (String) —

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

the optional parameters

Options Hash (opts):

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

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

Optional list of database OCIDs of the associated DBaaS entity. (default to [])
:id (Array<String>) —

Optional list of database insight resource OCIDs. (default to [])
:instance_number (String) —

The optional single value query parameter to filter by database instance number.
:time_interval_start (DateTime) —

Analysis start time in UTC in ISO 8601 format(inclusive). Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). The minimum allowed value is 2 years prior to the current day. timeIntervalStart and timeIntervalEnd parameters are used together. If analysisTimeInterval is specified, this parameter is ignored.
:time_interval_end (DateTime) —

Analysis end time in UTC in ISO 8601 format(exclusive). Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). timeIntervalStart and timeIntervalEnd are used together. If timeIntervalEnd is not specified, current time is used as timeIntervalEnd.
:category_name (String) —

Optional value filter to match the finding category exactly.
:limit (Integer) —

For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see List Pagination. Example: 50 (default to 1000)
:page (String) —

For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination.
:sort_order (String) —

The sort order to use, either ascending (ASC) or descending (DESC).
:sort_by (String) —

Field name for sorting the ADDM finding summary data (default to impactOverallPercent) Allowed values are: impactOverallPercent, impactMaxPercent, impactAvgActiveSessions, frequencyCount
:opc_request_id (String) —

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
:defined_tag_equals (Array<String>) —

A list of tag filters to apply. Only resources with a defined tag matching the value will be returned. Each item in the list has the format "namespace.tagName.value". All inputs are case-insensitive. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as "OR". Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as "AND".
:freeform_tag_equals (Array<String>) —

A list of tag filters to apply. Only resources with a freeform tag matching the value will be returned. The key for each tag is "tagName.value". All inputs are case-insensitive. Multiple values for the same tag name are interpreted as "OR". Values for different tag names are interpreted as "AND".
:defined_tag_exists (Array<String>) —

A list of tag existence filters to apply. Only resources for which the specified defined tags exist will be returned. Each item in the list has the format "namespace.tagName.true" (for checking existence of a defined tag) or "namespace.true". All inputs are case-insensitive. Currently, only existence ("true" at the end) is supported. Absence ("false" at the end) is not supported. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as "OR". Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as "AND".
:freeform_tag_exists (Array<String>) —

A list of tag existence filters to apply. Only resources for which the specified freeform tags exist the value will be returned. The key for each tag is "tagName.true". All inputs are case-insensitive. Currently, only existence ("true" at the end) is supported. Absence ("false" at the end) is not supported. Multiple values for different tag names are interpreted as "AND".
:compartment_id_in_subtree (BOOLEAN) —

A flag to search all resources within a given compartment and all sub-compartments. (default to false)

Returns:

(Response) —

A Response object with data of type AddmDbFindingAggregationCollection

# File 'lib/oci/opsi/operations_insights_client.rb', line 9439

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

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

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

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

  path = '/databaseInsights/addmDbFindings'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:databaseId] = OCI::ApiClient.build_collection_params(opts[:database_id], :multi) if opts[:database_id] && !opts[:database_id].empty?
  query_params[:id] = OCI::ApiClient.build_collection_params(opts[:id], :multi) if opts[:id] && !opts[:id].empty?
  query_params[:instanceNumber] = opts[:instance_number] if opts[:instance_number]
  query_params[:timeIntervalStart] = opts[:time_interval_start] if opts[:time_interval_start]
  query_params[:timeIntervalEnd] = opts[:time_interval_end] if opts[:time_interval_end]
  query_params[:categoryName] = opts[:category_name] if opts[:category_name]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:definedTagEquals] = OCI::ApiClient.build_collection_params(opts[:defined_tag_equals], :multi) if opts[:defined_tag_equals] && !opts[:defined_tag_equals].empty?
  query_params[:freeformTagEquals] = OCI::ApiClient.build_collection_params(opts[:freeform_tag_equals], :multi) if opts[:freeform_tag_equals] && !opts[:freeform_tag_equals].empty?
  query_params[:definedTagExists] = OCI::ApiClient.build_collection_params(opts[:defined_tag_exists], :multi) if opts[:defined_tag_exists] && !opts[:defined_tag_exists].empty?
  query_params[:freeformTagExists] = OCI::ApiClient.build_collection_params(opts[:freeform_tag_exists], :multi) if opts[:freeform_tag_exists] && !opts[:freeform_tag_exists].empty?
  query_params[:compartmentIdInSubtree] = opts[:compartment_id_in_subtree] if !opts[:compartment_id_in_subtree].nil?

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

  post_body = nil

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

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

Note:

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

Summarizes the AWR database parameter change history for the specified parameter. There will be one element for each time that parameter changed during the specified time period. This API is limited to only one parameter per request.

Parameters:

compartment_id (String) —

The OCID of the compartment.
name (String) —

Required filter to return only changes for the specified parameter. The match is case sensitive.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

Optional list of database OCIDs of the associated DBaaS entity. (default to [])
:id (Array<String>) —

Optional list of database insight resource OCIDs. (default to [])
:instance_number (String) —

The optional single value query parameter to filter by database instance number.
:time_interval_start (DateTime) —

Analysis start time in UTC in ISO 8601 format(inclusive). Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). The minimum allowed value is 2 years prior to the current day. timeIntervalStart and timeIntervalEnd parameters are used together. If analysisTimeInterval is specified, this parameter is ignored.
:time_interval_end (DateTime) —

Analysis end time in UTC in ISO 8601 format(exclusive). Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). timeIntervalStart and timeIntervalEnd are used together. If timeIntervalEnd is not specified, current time is used as timeIntervalEnd.
:value_contains (String) —

Optional filter to return only resources whose value contains the substring given. The match is not case sensitive.
:limit (Integer) —

For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see List Pagination. Example: 50 (default to 1000)
:page (String) —

For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination.
:sort_order (String) —

The sort order to use, either ascending (ASC) or descending (DESC).
:sort_by (String) —

Field name for sorting the database parameter change data (default to beginSnapId) Allowed values are: isChanged, beginSnapId
:opc_request_id (String) —

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
:defined_tag_equals (Array<String>) —

A list of tag filters to apply. Only resources with a defined tag matching the value will be returned. Each item in the list has the format "namespace.tagName.value". All inputs are case-insensitive. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as "OR". Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as "AND".
:freeform_tag_equals (Array<String>) —

A list of tag filters to apply. Only resources with a freeform tag matching the value will be returned. The key for each tag is "tagName.value". All inputs are case-insensitive. Multiple values for the same tag name are interpreted as "OR". Values for different tag names are interpreted as "AND".
:defined_tag_exists (Array<String>) —

A list of tag existence filters to apply. Only resources for which the specified defined tags exist will be returned. Each item in the list has the format "namespace.tagName.true" (for checking existence of a defined tag) or "namespace.true". All inputs are case-insensitive. Currently, only existence ("true" at the end) is supported. Absence ("false" at the end) is not supported. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as "OR". Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as "AND".
:freeform_tag_exists (Array<String>) —

A list of tag existence filters to apply. Only resources for which the specified freeform tags exist the value will be returned. The key for each tag is "tagName.true". All inputs are case-insensitive. Currently, only existence ("true" at the end) is supported. Absence ("false" at the end) is not supported. Multiple values for different tag names are interpreted as "AND".
:compartment_id_in_subtree (BOOLEAN) —

A flag to search all resources within a given compartment and all sub-compartments. (default to false)

Returns:

(Response) —

A Response object with data of type AddmDbParameterChangeAggregationCollection

# File 'lib/oci/opsi/operations_insights_client.rb', line 9580

def summarize_addm_db_parameter_changes(compartment_id, name, opts = {})
  logger.debug 'Calling operation OperationsInsightsClient#summarize_addm_db_parameter_changes.' if logger

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

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

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

  path = '/databaseInsights/addmDbParameterChanges'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:name] = name
  query_params[:databaseId] = OCI::ApiClient.build_collection_params(opts[:database_id], :multi) if opts[:database_id] && !opts[:database_id].empty?
  query_params[:id] = OCI::ApiClient.build_collection_params(opts[:id], :multi) if opts[:id] && !opts[:id].empty?
  query_params[:instanceNumber] = opts[:instance_number] if opts[:instance_number]
  query_params[:timeIntervalStart] = opts[:time_interval_start] if opts[:time_interval_start]
  query_params[:timeIntervalEnd] = opts[:time_interval_end] if opts[:time_interval_end]
  query_params[:valueContains] = opts[:value_contains] if opts[:value_contains]
  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[:definedTagEquals] = OCI::ApiClient.build_collection_params(opts[:defined_tag_equals], :multi) if opts[:defined_tag_equals] && !opts[:defined_tag_equals].empty?
  query_params[:freeformTagEquals] = OCI::ApiClient.build_collection_params(opts[:freeform_tag_equals], :multi) if opts[:freeform_tag_equals] && !opts[:freeform_tag_equals].empty?
  query_params[:definedTagExists] = OCI::ApiClient.build_collection_params(opts[:defined_tag_exists], :multi) if opts[:defined_tag_exists] && !opts[:defined_tag_exists].empty?
  query_params[:freeformTagExists] = OCI::ApiClient.build_collection_params(opts[:freeform_tag_exists], :multi) if opts[:freeform_tag_exists] && !opts[:freeform_tag_exists].empty?
  query_params[:compartmentIdInSubtree] = opts[:compartment_id_in_subtree] if !opts[:compartment_id_in_subtree].nil?

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

  post_body = nil

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

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

Note:

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

Summarizes database parameter history information for the specified databases. Return a list of parameters with information on whether the parameter values were changed or not within the specified time period. The response does not include the individual parameter changes within the time period.

Parameters:

compartment_id (String) —

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

the optional parameters

Options Hash (opts):

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

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

Optional list of database OCIDs of the associated DBaaS entity. (default to [])
:id (Array<String>) —

Optional list of database insight resource OCIDs. (default to [])
:instance_number (String) —

The optional single value query parameter to filter by database instance number.
:time_interval_start (DateTime) —

Analysis start time in UTC in ISO 8601 format(inclusive). Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). The minimum allowed value is 2 years prior to the current day. timeIntervalStart and timeIntervalEnd parameters are used together. If analysisTimeInterval is specified, this parameter is ignored.
:time_interval_end (DateTime) —

Analysis end time in UTC in ISO 8601 format(exclusive). Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). timeIntervalStart and timeIntervalEnd are used together. If timeIntervalEnd is not specified, current time is used as timeIntervalEnd.
:category_name (String) —

Optional value filter to match the parameter category exactly. Note the list of possible category names can be retrieved from the following endpoint: /databases/databaseId/addmDbParameterCategories.
:name_or_value_contains (String) —

Optional filter to return only resources whose name or value contains the substring given. The match is not case sensitive.
:is_changed (String) —

Optional filter to return only parameters whose value changed in the specified time period. Valid values include: TRUE, FALSE (default to false) Allowed values are: true, false
:is_default (String) —

Optional filter to return only parameters whose end value was set to the default value (TRUE) or was specified in the parameter file (FALSE). Valid values include: TRUE, FALSE (default to false) Allowed values are: true, false
:has_recommendations (String) —

Optional filter to return only parameters which have recommendations in the specified time period. Valid values include: TRUE, FALSE (default to false) Allowed values are: true, false
:limit (Integer) —

For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see List Pagination. Example: 50 (default to 1000)
:page (String) —

For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination.
:sort_order (String) —

The sort order to use, either ascending (ASC) or descending (DESC).
:sort_by (String) —

Field name for sorting the database parameter data (default to isChanged) Allowed values are: isChanged, name
:opc_request_id (String) —

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
:defined_tag_equals (Array<String>) —

A list of tag filters to apply. Only resources with a defined tag matching the value will be returned. Each item in the list has the format "namespace.tagName.value". All inputs are case-insensitive. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as "OR". Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as "AND".
:freeform_tag_equals (Array<String>) —

A list of tag filters to apply. Only resources with a freeform tag matching the value will be returned. The key for each tag is "tagName.value". All inputs are case-insensitive. Multiple values for the same tag name are interpreted as "OR". Values for different tag names are interpreted as "AND".
:defined_tag_exists (Array<String>) —

A list of tag existence filters to apply. Only resources for which the specified defined tags exist will be returned. Each item in the list has the format "namespace.tagName.true" (for checking existence of a defined tag) or "namespace.true". All inputs are case-insensitive. Currently, only existence ("true" at the end) is supported. Absence ("false" at the end) is not supported. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as "OR". Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as "AND".
:freeform_tag_exists (Array<String>) —

A list of tag existence filters to apply. Only resources for which the specified freeform tags exist the value will be returned. The key for each tag is "tagName.true". All inputs are case-insensitive. Currently, only existence ("true" at the end) is supported. Absence ("false" at the end) is not supported. Multiple values for different tag names are interpreted as "AND".
:compartment_id_in_subtree (BOOLEAN) —

A flag to search all resources within a given compartment and all sub-compartments. (default to false)

Returns:

(Response) —

A Response object with data of type AddmDbParameterAggregationCollection

# File 'lib/oci/opsi/operations_insights_client.rb', line 9737

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

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

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

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

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

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

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

  path = '/databaseInsights/addmDbParameters'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:databaseId] = OCI::ApiClient.build_collection_params(opts[:database_id], :multi) if opts[:database_id] && !opts[:database_id].empty?
  query_params[:id] = OCI::ApiClient.build_collection_params(opts[:id], :multi) if opts[:id] && !opts[:id].empty?
  query_params[:instanceNumber] = opts[:instance_number] if opts[:instance_number]
  query_params[:timeIntervalStart] = opts[:time_interval_start] if opts[:time_interval_start]
  query_params[:timeIntervalEnd] = opts[:time_interval_end] if opts[:time_interval_end]
  query_params[:categoryName] = opts[:category_name] if opts[:category_name]
  query_params[:nameOrValueContains] = opts[:name_or_value_contains] if opts[:name_or_value_contains]
  query_params[:isChanged] = opts[:is_changed] if opts[:is_changed]
  query_params[:isDefault] = opts[:is_default] if opts[:is_default]
  query_params[:hasRecommendations] = opts[:has_recommendations] if opts[:has_recommendations]
  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[:definedTagEquals] = OCI::ApiClient.build_collection_params(opts[:defined_tag_equals], :multi) if opts[:defined_tag_equals] && !opts[:defined_tag_equals].empty?
  query_params[:freeformTagEquals] = OCI::ApiClient.build_collection_params(opts[:freeform_tag_equals], :multi) if opts[:freeform_tag_equals] && !opts[:freeform_tag_equals].empty?
  query_params[:definedTagExists] = OCI::ApiClient.build_collection_params(opts[:defined_tag_exists], :multi) if opts[:defined_tag_exists] && !opts[:defined_tag_exists].empty?
  query_params[:freeformTagExists] = OCI::ApiClient.build_collection_params(opts[:freeform_tag_exists], :multi) if opts[:freeform_tag_exists] && !opts[:freeform_tag_exists].empty?
  query_params[:compartmentIdInSubtree] = opts[:compartment_id_in_subtree] if !opts[:compartment_id_in_subtree].nil?

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

  post_body = nil

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

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

Note:

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

Summarizes ADDM recommendations for the specified databases.

Parameters:

compartment_id (String) —

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

the optional parameters

Options Hash (opts):

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

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

Optional list of database OCIDs of the associated DBaaS entity. (default to [])
:id (Array<String>) —

Optional list of database insight resource OCIDs. (default to [])
:instance_number (String) —

The optional single value query parameter to filter by database instance number.
:time_interval_start (DateTime) —

Analysis start time in UTC in ISO 8601 format(inclusive). Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). The minimum allowed value is 2 years prior to the current day. timeIntervalStart and timeIntervalEnd parameters are used together. If analysisTimeInterval is specified, this parameter is ignored.
:time_interval_end (DateTime) —

Analysis end time in UTC in ISO 8601 format(exclusive). Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). timeIntervalStart and timeIntervalEnd are used together. If timeIntervalEnd is not specified, current time is used as timeIntervalEnd.
:category_name (String) —

Optional value filter to match the finding category exactly.
:finding_identifier (String) —

Unique finding ID
:sql_identifier (String) —

Optional filter to return only resources whose sql id matches the value given. Only considered when categoryName is SQL_TUNING.
:owner_or_name_contains (String) —

Optional filter to return only resources whose owner or name contains the substring given. The match is not case sensitive. Only considered when categoryName is SCHEMA_OBJECT.
:name_contains (String) —

Optional filter to return only resources whose name contains the substring given. The match is not case sensitive. Only considered when categoryName is DATABASE_CONFIGURATION.
:name (String) —

Optional filter to return only resources whose name exactly matches the substring given. The match is case sensitive. Only considered when categoryName is DATABASE_CONFIGURATION.
:limit (Integer) —

For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see List Pagination. Example: 50 (default to 1000)
:page (String) —

For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination.
:sort_order (String) —

The sort order to use, either ascending (ASC) or descending (DESC).
:sort_by (String) —

Field name for sorting the recommendation data (default to maxBenefitPercent) Allowed values are: maxBenefitPercent, maxBenefitAvgActiveSessions, frequencyCount
:opc_request_id (String) —

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
:defined_tag_equals (Array<String>) —

A list of tag filters to apply. Only resources with a defined tag matching the value will be returned. Each item in the list has the format "namespace.tagName.value". All inputs are case-insensitive. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as "OR". Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as "AND".
:freeform_tag_equals (Array<String>) —

A list of tag filters to apply. Only resources with a freeform tag matching the value will be returned. The key for each tag is "tagName.value". All inputs are case-insensitive. Multiple values for the same tag name are interpreted as "OR". Values for different tag names are interpreted as "AND".
:defined_tag_exists (Array<String>) —

A list of tag existence filters to apply. Only resources for which the specified defined tags exist will be returned. Each item in the list has the format "namespace.tagName.true" (for checking existence of a defined tag) or "namespace.true". All inputs are case-insensitive. Currently, only existence ("true" at the end) is supported. Absence ("false" at the end) is not supported. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as "OR". Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as "AND".
:freeform_tag_exists (Array<String>) —

A list of tag existence filters to apply. Only resources for which the specified freeform tags exist the value will be returned. The key for each tag is "tagName.true". All inputs are case-insensitive. Currently, only existence ("true" at the end) is supported. Absence ("false" at the end) is not supported. Multiple values for different tag names are interpreted as "AND".
:compartment_id_in_subtree (BOOLEAN) —

A flag to search all resources within a given compartment and all sub-compartments. (default to false)

Returns:

(Response) —

A Response object with data of type AddmDbRecommendationAggregationCollection

# File 'lib/oci/opsi/operations_insights_client.rb', line 9901

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

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

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

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

  path = '/databaseInsights/addmDbRecommendations'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:databaseId] = OCI::ApiClient.build_collection_params(opts[:database_id], :multi) if opts[:database_id] && !opts[:database_id].empty?
  query_params[:id] = OCI::ApiClient.build_collection_params(opts[:id], :multi) if opts[:id] && !opts[:id].empty?
  query_params[:instanceNumber] = opts[:instance_number] if opts[:instance_number]
  query_params[:timeIntervalStart] = opts[:time_interval_start] if opts[:time_interval_start]
  query_params[:timeIntervalEnd] = opts[:time_interval_end] if opts[:time_interval_end]
  query_params[:categoryName] = opts[:category_name] if opts[:category_name]
  query_params[:findingIdentifier] = opts[:finding_identifier] if opts[:finding_identifier]
  query_params[:sqlIdentifier] = opts[:sql_identifier] if opts[:sql_identifier]
  query_params[:ownerOrNameContains] = opts[:owner_or_name_contains] if opts[:owner_or_name_contains]
  query_params[:nameContains] = opts[:name_contains] if opts[:name_contains]
  query_params[:name] = opts[:name] if opts[:name]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:definedTagEquals] = OCI::ApiClient.build_collection_params(opts[:defined_tag_equals], :multi) if opts[:defined_tag_equals] && !opts[:defined_tag_equals].empty?
  query_params[:freeformTagEquals] = OCI::ApiClient.build_collection_params(opts[:freeform_tag_equals], :multi) if opts[:freeform_tag_equals] && !opts[:freeform_tag_equals].empty?
  query_params[:definedTagExists] = OCI::ApiClient.build_collection_params(opts[:defined_tag_exists], :multi) if opts[:defined_tag_exists] && !opts[:defined_tag_exists].empty?
  query_params[:freeformTagExists] = OCI::ApiClient.build_collection_params(opts[:freeform_tag_exists], :multi) if opts[:freeform_tag_exists] && !opts[:freeform_tag_exists].empty?
  query_params[:compartmentIdInSubtree] = opts[:compartment_id_in_subtree] if !opts[:compartment_id_in_subtree].nil?

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

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'OperationsInsightsClient#summarize_addm_db_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::Opsi::Models::AddmDbRecommendationAggregationCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

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

Note:

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

Summarizes Schema objects for the specified databases for the specified objectIdentifiers

Parameters:

compartment_id (String) —

The OCID of the compartment.
object_identifier (Array<Integer>) —

One or more unique Object id (from RDBMS)
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

Optional list of database OCIDs of the associated DBaaS entity. (default to [])
:id (Array<String>) —

Optional list of database insight resource OCIDs. (default to [])
:time_interval_start (DateTime) —

Analysis start time in UTC in ISO 8601 format(inclusive). Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). The minimum allowed value is 2 years prior to the current day. timeIntervalStart and timeIntervalEnd parameters are used together. If analysisTimeInterval is specified, this parameter is ignored.
:time_interval_end (DateTime) —

Analysis end time in UTC in ISO 8601 format(exclusive). Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). timeIntervalStart and timeIntervalEnd are used together. If timeIntervalEnd is not specified, current time is used as timeIntervalEnd.
:limit (Integer) —

For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see List Pagination. Example: 50 (default to 50)
:page (String) —

For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination.
:opc_request_id (String) —

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
:defined_tag_equals (Array<String>) —

A list of tag filters to apply. Only resources with a defined tag matching the value will be returned. Each item in the list has the format "namespace.tagName.value". All inputs are case-insensitive. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as "OR". Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as "AND".
:freeform_tag_equals (Array<String>) —

A list of tag filters to apply. Only resources with a freeform tag matching the value will be returned. The key for each tag is "tagName.value". All inputs are case-insensitive. Multiple values for the same tag name are interpreted as "OR". Values for different tag names are interpreted as "AND".
:defined_tag_exists (Array<String>) —

A list of tag existence filters to apply. Only resources for which the specified defined tags exist will be returned. Each item in the list has the format "namespace.tagName.true" (for checking existence of a defined tag) or "namespace.true". All inputs are case-insensitive. Currently, only existence ("true" at the end) is supported. Absence ("false" at the end) is not supported. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as "OR". Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as "AND".
:freeform_tag_exists (Array<String>) —

A list of tag existence filters to apply. Only resources for which the specified freeform tags exist the value will be returned. The key for each tag is "tagName.true". All inputs are case-insensitive. Currently, only existence ("true" at the end) is supported. Absence ("false" at the end) is not supported. Multiple values for different tag names are interpreted as "AND".
:compartment_id_in_subtree (BOOLEAN) —

A flag to search all resources within a given compartment and all sub-compartments. (default to false)

Returns:

(Response) —

A Response object with data of type AddmDbSchemaObjectCollection

# File 'lib/oci/opsi/operations_insights_client.rb', line 10036

def summarize_addm_db_schema_objects(compartment_id, object_identifier, opts = {})
  logger.debug 'Calling operation OperationsInsightsClient#summarize_addm_db_schema_objects.' if logger

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

  path = '/databaseInsights/addmDbSchemaObjects'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:objectIdentifier] = OCI::ApiClient.build_collection_params(object_identifier, :multi)
  query_params[:databaseId] = OCI::ApiClient.build_collection_params(opts[:database_id], :multi) if opts[:database_id] && !opts[:database_id].empty?
  query_params[:id] = OCI::ApiClient.build_collection_params(opts[:id], :multi) if opts[:id] && !opts[:id].empty?
  query_params[:timeIntervalStart] = opts[:time_interval_start] if opts[:time_interval_start]
  query_params[:timeIntervalEnd] = opts[:time_interval_end] if opts[:time_interval_end]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:definedTagEquals] = OCI::ApiClient.build_collection_params(opts[:defined_tag_equals], :multi) if opts[:defined_tag_equals] && !opts[:defined_tag_equals].empty?
  query_params[:freeformTagEquals] = OCI::ApiClient.build_collection_params(opts[:freeform_tag_equals], :multi) if opts[:freeform_tag_equals] && !opts[:freeform_tag_equals].empty?
  query_params[:definedTagExists] = OCI::ApiClient.build_collection_params(opts[:defined_tag_exists], :multi) if opts[:defined_tag_exists] && !opts[:defined_tag_exists].empty?
  query_params[:freeformTagExists] = OCI::ApiClient.build_collection_params(opts[:freeform_tag_exists], :multi) if opts[:freeform_tag_exists] && !opts[:freeform_tag_exists].empty?
  query_params[:compartmentIdInSubtree] = opts[:compartment_id_in_subtree] if !opts[:compartment_id_in_subtree].nil?

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

  post_body = nil

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

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

Note:

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

Summarizes SQL Statements for the specified databases for the specified sqlIdentifiers

Parameters:

compartment_id (String) —

The OCID of the compartment.
sql_identifier (Array<String>) —

One or more unique SQL_IDs for a SQL Statement. Example: 6rgjh9bjmy2s7
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

Optional list of database OCIDs of the associated DBaaS entity. (default to [])
:id (Array<String>) —

Optional list of database insight resource OCIDs. (default to [])
:time_interval_start (DateTime) —

Analysis start time in UTC in ISO 8601 format(inclusive). Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). The minimum allowed value is 2 years prior to the current day. timeIntervalStart and timeIntervalEnd parameters are used together. If analysisTimeInterval is specified, this parameter is ignored.
:time_interval_end (DateTime) —

Analysis end time in UTC in ISO 8601 format(exclusive). Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). timeIntervalStart and timeIntervalEnd are used together. If timeIntervalEnd is not specified, current time is used as timeIntervalEnd.
:limit (Integer) —

For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see List Pagination. Example: 50 (default to 50)
:page (String) —

For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination.
:opc_request_id (String) —

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
:defined_tag_equals (Array<String>) —

A list of tag filters to apply. Only resources with a defined tag matching the value will be returned. Each item in the list has the format "namespace.tagName.value". All inputs are case-insensitive. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as "OR". Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as "AND".
:freeform_tag_equals (Array<String>) —

A list of tag filters to apply. Only resources with a freeform tag matching the value will be returned. The key for each tag is "tagName.value". All inputs are case-insensitive. Multiple values for the same tag name are interpreted as "OR". Values for different tag names are interpreted as "AND".
:defined_tag_exists (Array<String>) —

A list of tag existence filters to apply. Only resources for which the specified defined tags exist will be returned. Each item in the list has the format "namespace.tagName.true" (for checking existence of a defined tag) or "namespace.true". All inputs are case-insensitive. Currently, only existence ("true" at the end) is supported. Absence ("false" at the end) is not supported. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as "OR". Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as "AND".
:freeform_tag_exists (Array<String>) —

A list of tag existence filters to apply. Only resources for which the specified freeform tags exist the value will be returned. The key for each tag is "tagName.true". All inputs are case-insensitive. Currently, only existence ("true" at the end) is supported. Absence ("false" at the end) is not supported. Multiple values for different tag names are interpreted as "AND".
:compartment_id_in_subtree (BOOLEAN) —

A flag to search all resources within a given compartment and all sub-compartments. (default to false)

Returns:

(Response) —

A Response object with data of type AddmDbSqlStatementCollection

# File 'lib/oci/opsi/operations_insights_client.rb', line 10157

def summarize_addm_db_sql_statements(compartment_id, sql_identifier, opts = {})
  logger.debug 'Calling operation OperationsInsightsClient#summarize_addm_db_sql_statements.' if logger

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

  path = '/databaseInsights/addmDbSqlStatements'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:sqlIdentifier] = OCI::ApiClient.build_collection_params(sql_identifier, :multi)
  query_params[:databaseId] = OCI::ApiClient.build_collection_params(opts[:database_id], :multi) if opts[:database_id] && !opts[:database_id].empty?
  query_params[:id] = OCI::ApiClient.build_collection_params(opts[:id], :multi) if opts[:id] && !opts[:id].empty?
  query_params[:timeIntervalStart] = opts[:time_interval_start] if opts[:time_interval_start]
  query_params[:timeIntervalEnd] = opts[:time_interval_end] if opts[:time_interval_end]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:definedTagEquals] = OCI::ApiClient.build_collection_params(opts[:defined_tag_equals], :multi) if opts[:defined_tag_equals] && !opts[:defined_tag_equals].empty?
  query_params[:freeformTagEquals] = OCI::ApiClient.build_collection_params(opts[:freeform_tag_equals], :multi) if opts[:freeform_tag_equals] && !opts[:freeform_tag_equals].empty?
  query_params[:definedTagExists] = OCI::ApiClient.build_collection_params(opts[:defined_tag_exists], :multi) if opts[:defined_tag_exists] && !opts[:defined_tag_exists].empty?
  query_params[:freeformTagExists] = OCI::ApiClient.build_collection_params(opts[:freeform_tag_exists], :multi) if opts[:freeform_tag_exists] && !opts[:freeform_tag_exists].empty?
  query_params[:compartmentIdInSubtree] = opts[:compartment_id_in_subtree] if !opts[:compartment_id_in_subtree].nil?

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

  post_body = nil

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

#summarize_awr_database_cpu_usages(awr_hub_id, awr_source_database_identifier, opts = {}) ⇒ `Response`

Note:

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

Summarizes the AWR CPU resource limits and metrics for the specified database in AWR. Based on the time range provided as part of query param, the metrics points will be returned in the response as below. - if time range is <=7 days then the metrics points will be for every MINUTES - if time range is <=2 hours then the metrics points will be for every 10 SECONDS - if time range is >7 days then the metrics points will be for every HOUR.

Parameters:

awr_hub_id (String) —

Unique Awr Hub identifier
awr_source_database_identifier (String) —

The internal ID of the database. The internal ID of the database is not the OCID. It can be retrieved from the following endpoint: /awrHubs/awrHubId/awrDatabases
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

The optional single value query parameter to filter by database instance number.
:begin_snapshot_identifier_greater_than_or_equal_to (Integer) —

The optional greater than or equal to filter on the snapshot ID.
:end_snapshot_identifier_less_than_or_equal_to (Integer) —

The optional less than or equal to query parameter to filter the snapshot Identifier.
:time_greater_than_or_equal_to (DateTime) —

The optional greater than or equal to query parameter to filter the timestamp. The timestamp format to be followed is: YYYY-MM-DDTHH:MM:SSZ, example 2020-12-03T19:00:53Z
:time_less_than_or_equal_to (DateTime) —

The optional less than or equal to query parameter to filter the timestamp. The timestamp format to be followed is: YYYY-MM-DDTHH:MM:SSZ, example 2020-12-03T19:00:53Z
:session_type (String) —

The optional query parameter to filter ASH activities by FOREGROUND or BACKGROUND. (default to FOREGROUND) Allowed values are: FOREGROUND, BACKGROUND, ALL
:page (String) —

For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination.
:limit (Integer) —

For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see List Pagination. Example: 50 (default to 1000)
:sort_by (String) —

The option to sort the AWR CPU usage summary data. (default to TIME_SAMPLED) Allowed values are: TIME_SAMPLED, AVG_VALUE
:sort_order (String) —

The sort order to use, either ascending (ASC) or descending (DESC). (default to DESC)
:opc_request_id (String) —

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:

(Response) —

A Response object with data of type AwrDatabaseCpuUsageCollection

# File 'lib/oci/opsi/operations_insights_client.rb', line 10260

def summarize_awr_database_cpu_usages(awr_hub_id, awr_source_database_identifier, opts = {})
  logger.debug 'Calling operation OperationsInsightsClient#summarize_awr_database_cpu_usages.' if logger

  raise "Missing the required parameter 'awr_hub_id' when calling summarize_awr_database_cpu_usages." if awr_hub_id.nil?
  raise "Missing the required parameter 'awr_source_database_identifier' when calling summarize_awr_database_cpu_usages." if awr_source_database_identifier.nil?

  if opts[:session_type] && !%w[FOREGROUND BACKGROUND ALL].include?(opts[:session_type])
    raise 'Invalid value for "session_type", must be one of FOREGROUND, BACKGROUND, ALL.'
  end

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

  if opts[:sort_order] && !OCI::Opsi::Models::SORT_ORDER_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::Opsi::Models::SORT_ORDER_ENUM.'
  end
  raise "Parameter value for 'awr_hub_id' must not be blank" if OCI::Internal::Util.blank_string?(awr_hub_id)

  path = '/awrHubs/{awrHubId}/awrDatabaseCpuUsages'.sub('{awrHubId}', awr_hub_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:awrSourceDatabaseIdentifier] = awr_source_database_identifier
  query_params[:instanceNumber] = opts[:instance_number] if opts[:instance_number]
  query_params[:beginSnapshotIdentifierGreaterThanOrEqualTo] = opts[:begin_snapshot_identifier_greater_than_or_equal_to] if opts[:begin_snapshot_identifier_greater_than_or_equal_to]
  query_params[:endSnapshotIdentifierLessThanOrEqualTo] = opts[:end_snapshot_identifier_less_than_or_equal_to] if opts[:end_snapshot_identifier_less_than_or_equal_to]
  query_params[:timeGreaterThanOrEqualTo] = opts[:time_greater_than_or_equal_to] if opts[:time_greater_than_or_equal_to]
  query_params[:timeLessThanOrEqualTo] = opts[:time_less_than_or_equal_to] if opts[:time_less_than_or_equal_to]
  query_params[:sessionType] = opts[:session_type] if opts[:session_type]
  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: 'OperationsInsightsClient#summarize_awr_database_cpu_usages') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Opsi::Models::AwrDatabaseCpuUsageCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#summarize_awr_database_metrics(awr_hub_id, awr_source_database_identifier, name, opts = {}) ⇒ `Response`

Note:

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

Summarizes the metric samples for the specified database in the AWR. The metric samples are summarized based on the Time dimension for each metric.

Parameters:

awr_hub_id (String) —

Unique Awr Hub identifier
awr_source_database_identifier (String) —

The internal ID of the database. The internal ID of the database is not the OCID. It can be retrieved from the following endpoint: /awrHubs/awrHubId/awrDatabases
name (Array<String>) —

The required multiple value query parameter to filter the entity 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
:instance_number (String) —

The optional single value query parameter to filter by database instance number.
:begin_snapshot_identifier_greater_than_or_equal_to (Integer) —

The optional greater than or equal to filter on the snapshot ID.
:end_snapshot_identifier_less_than_or_equal_to (Integer) —

The optional less than or equal to query parameter to filter the snapshot Identifier.
:time_greater_than_or_equal_to (DateTime) —

The optional greater than or equal to query parameter to filter the timestamp. The timestamp format to be followed is: YYYY-MM-DDTHH:MM:SSZ, example 2020-12-03T19:00:53Z
:time_less_than_or_equal_to (DateTime) —

The optional less than or equal to query parameter to filter the timestamp. The timestamp format to be followed is: YYYY-MM-DDTHH:MM:SSZ, example 2020-12-03T19:00:53Z
:page (String) —

For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination.
:limit (Integer) —

For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see List Pagination. Example: 50 (default to 1000)
:sort_by (String) —

The option to sort the AWR time series summary data. (default to TIMESTAMP) Allowed values are: TIMESTAMP, NAME
:sort_order (String) —

The sort order to use, either ascending (ASC) or descending (DESC). (default to DESC)
:opc_request_id (String) —

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:

(Response) —

A Response object with data of type AwrDatabaseMetricCollection

# File 'lib/oci/opsi/operations_insights_client.rb', line 10369

def summarize_awr_database_metrics(awr_hub_id, awr_source_database_identifier, name, opts = {})
  logger.debug 'Calling operation OperationsInsightsClient#summarize_awr_database_metrics.' if logger

  raise "Missing the required parameter 'awr_hub_id' when calling summarize_awr_database_metrics." if awr_hub_id.nil?
  raise "Missing the required parameter 'awr_source_database_identifier' when calling summarize_awr_database_metrics." if awr_source_database_identifier.nil?
  raise "Missing the required parameter 'name' when calling summarize_awr_database_metrics." if name.nil?

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

  if opts[:sort_order] && !OCI::Opsi::Models::SORT_ORDER_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::Opsi::Models::SORT_ORDER_ENUM.'
  end
  raise "Parameter value for 'awr_hub_id' must not be blank" if OCI::Internal::Util.blank_string?(awr_hub_id)

  path = '/awrHubs/{awrHubId}/awrDatabaseMetrics'.sub('{awrHubId}', awr_hub_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:awrSourceDatabaseIdentifier] = awr_source_database_identifier
  query_params[:name] = OCI::ApiClient.build_collection_params(name, :multi)
  query_params[:instanceNumber] = opts[:instance_number] if opts[:instance_number]
  query_params[:beginSnapshotIdentifierGreaterThanOrEqualTo] = opts[:begin_snapshot_identifier_greater_than_or_equal_to] if opts[:begin_snapshot_identifier_greater_than_or_equal_to]
  query_params[:endSnapshotIdentifierLessThanOrEqualTo] = opts[:end_snapshot_identifier_less_than_or_equal_to] if opts[:end_snapshot_identifier_less_than_or_equal_to]
  query_params[:timeGreaterThanOrEqualTo] = opts[:time_greater_than_or_equal_to] if opts[:time_greater_than_or_equal_to]
  query_params[:timeLessThanOrEqualTo] = opts[:time_less_than_or_equal_to] if opts[:time_less_than_or_equal_to]
  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: 'OperationsInsightsClient#summarize_awr_database_metrics') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Opsi::Models::AwrDatabaseMetricCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#summarize_awr_database_parameter_changes(awr_hub_id, awr_source_database_identifier, name, opts = {}) ⇒ `Response`

Note:

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

Summarizes the database parameter change history for one database parameter of the specified database in AWR. One change history record contains the previous value, the changed value, and the corresponding time range. If the database parameter value was changed multiple times within the time range, then multiple change history records are created for the same parameter. Note that this API only returns information on change history details for one database parameter. To get a list of all the database parameters whose values were changed during a specified time range, use the following API endpoint: /awrHubs/awrHubId/awrDbParameters?awrSourceDatabaseIdentifier=awrSourceDbId

Parameters:

awr_hub_id (String) —

Unique Awr Hub identifier
awr_source_database_identifier (String) —

The internal ID of the database. The internal ID of the database is not the OCID. It can be retrieved from the following endpoint: /awrHubs/awrHubId/awrDatabases
name (String) —

The required single value query parameter to filter the entity 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
:instance_number (String) —

The optional single value query parameter to filter by database instance number.
:begin_snapshot_identifier_greater_than_or_equal_to (Integer) —

The optional greater than or equal to filter on the snapshot ID.
:end_snapshot_identifier_less_than_or_equal_to (Integer) —

The optional less than or equal to query parameter to filter the snapshot Identifier.
:time_greater_than_or_equal_to (DateTime) —

The optional greater than or equal to query parameter to filter the timestamp. The timestamp format to be followed is: YYYY-MM-DDTHH:MM:SSZ, example 2020-12-03T19:00:53Z
:time_less_than_or_equal_to (DateTime) —

The optional less than or equal to query parameter to filter the timestamp. The timestamp format to be followed is: YYYY-MM-DDTHH:MM:SSZ, example 2020-12-03T19:00:53Z
:page (String) —

For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination.
:limit (Integer) —

For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see List Pagination. Example: 50 (default to 1000)
:sort_by (String) —

The option to sort the AWR database parameter change history data. (default to IS_CHANGED) Allowed values are: IS_CHANGED, NAME
:sort_order (String) —

The sort order to use, either ascending (ASC) or descending (DESC). (default to DESC)
:opc_request_id (String) —

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:

(Response) —

A Response object with data of type AwrDatabaseParameterChangeCollection

# File 'lib/oci/opsi/operations_insights_client.rb', line 10479

def summarize_awr_database_parameter_changes(awr_hub_id, awr_source_database_identifier, name, opts = {})
  logger.debug 'Calling operation OperationsInsightsClient#summarize_awr_database_parameter_changes.' if logger

  raise "Missing the required parameter 'awr_hub_id' when calling summarize_awr_database_parameter_changes." if awr_hub_id.nil?
  raise "Missing the required parameter 'awr_source_database_identifier' when calling summarize_awr_database_parameter_changes." if awr_source_database_identifier.nil?
  raise "Missing the required parameter 'name' when calling summarize_awr_database_parameter_changes." if name.nil?

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

  if opts[:sort_order] && !OCI::Opsi::Models::SORT_ORDER_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::Opsi::Models::SORT_ORDER_ENUM.'
  end
  raise "Parameter value for 'awr_hub_id' must not be blank" if OCI::Internal::Util.blank_string?(awr_hub_id)

  path = '/awrHubs/{awrHubId}/awrDatabaseParameterChanges'.sub('{awrHubId}', awr_hub_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:awrSourceDatabaseIdentifier] = awr_source_database_identifier
  query_params[:name] = name
  query_params[:instanceNumber] = opts[:instance_number] if opts[:instance_number]
  query_params[:beginSnapshotIdentifierGreaterThanOrEqualTo] = opts[:begin_snapshot_identifier_greater_than_or_equal_to] if opts[:begin_snapshot_identifier_greater_than_or_equal_to]
  query_params[:endSnapshotIdentifierLessThanOrEqualTo] = opts[:end_snapshot_identifier_less_than_or_equal_to] if opts[:end_snapshot_identifier_less_than_or_equal_to]
  query_params[:timeGreaterThanOrEqualTo] = opts[:time_greater_than_or_equal_to] if opts[:time_greater_than_or_equal_to]
  query_params[:timeLessThanOrEqualTo] = opts[:time_less_than_or_equal_to] if opts[:time_less_than_or_equal_to]
  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: 'OperationsInsightsClient#summarize_awr_database_parameter_changes') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Opsi::Models::AwrDatabaseParameterChangeCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#summarize_awr_database_parameters(awr_hub_id, awr_source_database_identifier, opts = {}) ⇒ `Response`

Note:

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

Summarizes the database parameter history for the specified database in AWR. This includes the list of database parameters, with information on whether the parameter values were modified within the query time range. Note that each database parameter is only listed once. Depending on the optional query parameters, the returned summary gets all the database parameters, which include:

Queryparam (valueChanged ="Y") - Each parameter whose value was changed during the time range, "isChanged : true" in response for the DB params. Queryparam (valueChanged ="N") - Each parameter whose value was unchanged during the time range, "isChanged : false" in response for the DB params. Queryparam (valueChanged ="Y" and valueModified = "SYSTEM_MOD") - Each parameter whose value was changed at the system level during the time range, "isChanged : true" & "valueModified : SYSTEM_MOD" in response for the DB params. Queryparam (valueChanged ="N" and valueDefault = "FALSE") - Each parameter whose value was unchanged during the time range, however, the value is not the default value, "isChanged : true" & "isDefault : false" in response for the DB params.

Note that this API does not return information on the number of times each database parameter has been changed within the time range. To get the database parameter value change history for a specific parameter, use the following API endpoint: /awrHubs/awrHubId/awrDbParameterChanges?awrSourceDatabaseIdentifier=awrSourceDbId

Parameters:

awr_hub_id (String) —

Unique Awr Hub identifier
awr_source_database_identifier (String) —

The internal ID of the database. The internal ID of the database is not the OCID. It can be retrieved from the following endpoint: /awrHubs/awrHubId/awrDatabases
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

The optional single value query parameter to filter by database instance number.
:begin_snapshot_identifier_greater_than_or_equal_to (Integer) —

The optional greater than or equal to filter on the snapshot ID.
:end_snapshot_identifier_less_than_or_equal_to (Integer) —

The optional less than or equal to query parameter to filter the snapshot Identifier.
:time_greater_than_or_equal_to (DateTime) —

The optional greater than or equal to query parameter to filter the timestamp. The timestamp format to be followed is: YYYY-MM-DDTHH:MM:SSZ, example 2020-12-03T19:00:53Z
:time_less_than_or_equal_to (DateTime) —

The optional less than or equal to query parameter to filter the timestamp. The timestamp format to be followed is: YYYY-MM-DDTHH:MM:SSZ, example 2020-12-03T19:00:53Z
:name (Array<String>) —

The optional multiple value query parameter to filter the entity name.
:name_contains (String) —

The optional contains query parameter to filter the entity name by any part of the name.
:value_changed (String) —

The optional query parameter to filter database parameters whose values were changed. (default to Y) Allowed values are: Y, N
:value_default (String) —

The optional query parameter to filter the database parameters that had the default value in the last snapshot. Allowed values are: TRUE, FALSE
:value_modified (String) —

The optional query parameter to filter the database parameters that had a modified value in the last snapshot. Allowed values are: MODIFIED, SYSTEM_MOD, FALSE
:page (String) —

For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination.
:limit (Integer) —

For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see List Pagination. Example: 50 (default to 1000)
:sort_by (String) —

The option to sort the AWR database parameter change history data. (default to IS_CHANGED) Allowed values are: IS_CHANGED, NAME
:sort_order (String) —

The sort order to use, either ascending (ASC) or descending (DESC). (default to DESC)
:opc_request_id (String) —

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:

(Response) —

A Response object with data of type AwrDatabaseParameterCollection

# File 'lib/oci/opsi/operations_insights_client.rb', line 10602

def summarize_awr_database_parameters(awr_hub_id, awr_source_database_identifier, opts = {})
  logger.debug 'Calling operation OperationsInsightsClient#summarize_awr_database_parameters.' if logger

  raise "Missing the required parameter 'awr_hub_id' when calling summarize_awr_database_parameters." if awr_hub_id.nil?
  raise "Missing the required parameter 'awr_source_database_identifier' when calling summarize_awr_database_parameters." if awr_source_database_identifier.nil?

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

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

  if opts[:value_modified] && !%w[MODIFIED SYSTEM_MOD FALSE].include?(opts[:value_modified])
    raise 'Invalid value for "value_modified", must be one of MODIFIED, SYSTEM_MOD, FALSE.'
  end

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

  if opts[:sort_order] && !OCI::Opsi::Models::SORT_ORDER_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::Opsi::Models::SORT_ORDER_ENUM.'
  end
  raise "Parameter value for 'awr_hub_id' must not be blank" if OCI::Internal::Util.blank_string?(awr_hub_id)

  path = '/awrHubs/{awrHubId}/awrDatabaseParameters'.sub('{awrHubId}', awr_hub_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:awrSourceDatabaseIdentifier] = awr_source_database_identifier
  query_params[:instanceNumber] = opts[:instance_number] if opts[:instance_number]
  query_params[:beginSnapshotIdentifierGreaterThanOrEqualTo] = opts[:begin_snapshot_identifier_greater_than_or_equal_to] if opts[:begin_snapshot_identifier_greater_than_or_equal_to]
  query_params[:endSnapshotIdentifierLessThanOrEqualTo] = opts[:end_snapshot_identifier_less_than_or_equal_to] if opts[:end_snapshot_identifier_less_than_or_equal_to]
  query_params[:timeGreaterThanOrEqualTo] = opts[:time_greater_than_or_equal_to] if opts[:time_greater_than_or_equal_to]
  query_params[:timeLessThanOrEqualTo] = opts[:time_less_than_or_equal_to] if opts[:time_less_than_or_equal_to]
  query_params[:name] = OCI::ApiClient.build_collection_params(opts[:name], :multi) if opts[:name] && !opts[:name].empty?
  query_params[:nameContains] = opts[:name_contains] if opts[:name_contains]
  query_params[:valueChanged] = opts[:value_changed] if opts[:value_changed]
  query_params[:valueDefault] = opts[:value_default] if opts[:value_default]
  query_params[:valueModified] = opts[:value_modified] if opts[:value_modified]
  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: 'OperationsInsightsClient#summarize_awr_database_parameters') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Opsi::Models::AwrDatabaseParameterCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#summarize_awr_database_snapshot_ranges(awr_hub_id, opts = {}) ⇒ `Response`

Note:

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

Summarizes the AWR snapshot ranges that contain continuous snapshots, for the specified AWRHub.

Parameters:

awr_hub_id (String) —

Unique Awr Hub identifier
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

The optional single value query parameter to filter the entity name.
:time_greater_than_or_equal_to (DateTime) —

The optional greater than or equal to query parameter to filter the timestamp. The timestamp format to be followed is: YYYY-MM-DDTHH:MM:SSZ, example 2020-12-03T19:00:53Z
:time_less_than_or_equal_to (DateTime) —

The optional less than or equal to query parameter to filter the timestamp. The timestamp format to be followed is: YYYY-MM-DDTHH:MM:SSZ, example 2020-12-03T19:00:53Z
:page (String) —

For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination.
:limit (Integer) —

For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see List Pagination. Example: 50 (default to 50)
:sort_by (String) —

The option to sort the AWR summary data. (default to END_INTERVAL_TIME) Allowed values are: END_INTERVAL_TIME, NAME
:sort_order (String) —

The sort order to use, either ascending (ASC) or descending (DESC). (default to DESC)
:opc_request_id (String) —

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:

(Response) —

A Response object with data of type AwrDatabaseSnapshotRangeCollection

# File 'lib/oci/opsi/operations_insights_client.rb', line 10714

def summarize_awr_database_snapshot_ranges(awr_hub_id, opts = {})
  logger.debug 'Calling operation OperationsInsightsClient#summarize_awr_database_snapshot_ranges.' if logger

  raise "Missing the required parameter 'awr_hub_id' when calling summarize_awr_database_snapshot_ranges." if awr_hub_id.nil?

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

  if opts[:sort_order] && !OCI::Opsi::Models::SORT_ORDER_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::Opsi::Models::SORT_ORDER_ENUM.'
  end
  raise "Parameter value for 'awr_hub_id' must not be blank" if OCI::Internal::Util.blank_string?(awr_hub_id)

  path = '/awrHubs/{awrHubId}/awrDatabaseSnapshotRanges'.sub('{awrHubId}', awr_hub_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:name] = opts[:name] if opts[:name]
  query_params[:timeGreaterThanOrEqualTo] = opts[:time_greater_than_or_equal_to] if opts[:time_greater_than_or_equal_to]
  query_params[:timeLessThanOrEqualTo] = opts[:time_less_than_or_equal_to] if opts[:time_less_than_or_equal_to]
  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: 'OperationsInsightsClient#summarize_awr_database_snapshot_ranges') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Opsi::Models::AwrDatabaseSnapshotRangeCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#summarize_awr_database_sysstats(awr_hub_id, awr_source_database_identifier, name, opts = {}) ⇒ `Response`

Note:

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

Summarizes the AWR SYSSTAT sample data for the specified database in AWR. The statistical data is summarized based on the Time dimension for each statistic.

Parameters:

awr_hub_id (String) —

Unique Awr Hub identifier
awr_source_database_identifier (String) —

The internal ID of the database. The internal ID of the database is not the OCID. It can be retrieved from the following endpoint: /awrHubs/awrHubId/awrDatabases
name (Array<String>) —

The required multiple value query parameter to filter the entity 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
:instance_number (String) —

The optional single value query parameter to filter by database instance number.
:begin_snapshot_identifier_greater_than_or_equal_to (Integer) —

The optional greater than or equal to filter on the snapshot ID.
:end_snapshot_identifier_less_than_or_equal_to (Integer) —

The optional less than or equal to query parameter to filter the snapshot Identifier.
:time_greater_than_or_equal_to (DateTime) —

The optional greater than or equal to query parameter to filter the timestamp. The timestamp format to be followed is: YYYY-MM-DDTHH:MM:SSZ, example 2020-12-03T19:00:53Z
:time_less_than_or_equal_to (DateTime) —

The optional less than or equal to query parameter to filter the timestamp. The timestamp format to be followed is: YYYY-MM-DDTHH:MM:SSZ, example 2020-12-03T19:00:53Z
:page (String) —

For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination.
:limit (Integer) —

For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see List Pagination. Example: 50 (default to 1000)
:sort_by (String) —

The option to sort the data within a time period. (default to TIME_BEGIN) Allowed values are: TIME_BEGIN, NAME
:sort_order (String) —

The sort order to use, either ascending (ASC) or descending (DESC). (default to DESC)
:opc_request_id (String) —

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:

(Response) —

A Response object with data of type AwrDatabaseSysstatCollection

# File 'lib/oci/opsi/operations_insights_client.rb', line 10814

def summarize_awr_database_sysstats(awr_hub_id, awr_source_database_identifier, name, opts = {})
  logger.debug 'Calling operation OperationsInsightsClient#summarize_awr_database_sysstats.' if logger

  raise "Missing the required parameter 'awr_hub_id' when calling summarize_awr_database_sysstats." if awr_hub_id.nil?
  raise "Missing the required parameter 'awr_source_database_identifier' when calling summarize_awr_database_sysstats." if awr_source_database_identifier.nil?
  raise "Missing the required parameter 'name' when calling summarize_awr_database_sysstats." if name.nil?

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

  if opts[:sort_order] && !OCI::Opsi::Models::SORT_ORDER_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::Opsi::Models::SORT_ORDER_ENUM.'
  end
  raise "Parameter value for 'awr_hub_id' must not be blank" if OCI::Internal::Util.blank_string?(awr_hub_id)

  path = '/awrHubs/{awrHubId}/awrDatabaseSysstats'.sub('{awrHubId}', awr_hub_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:awrSourceDatabaseIdentifier] = awr_source_database_identifier
  query_params[:name] = OCI::ApiClient.build_collection_params(name, :multi)
  query_params[:instanceNumber] = opts[:instance_number] if opts[:instance_number]
  query_params[:beginSnapshotIdentifierGreaterThanOrEqualTo] = opts[:begin_snapshot_identifier_greater_than_or_equal_to] if opts[:begin_snapshot_identifier_greater_than_or_equal_to]
  query_params[:endSnapshotIdentifierLessThanOrEqualTo] = opts[:end_snapshot_identifier_less_than_or_equal_to] if opts[:end_snapshot_identifier_less_than_or_equal_to]
  query_params[:timeGreaterThanOrEqualTo] = opts[:time_greater_than_or_equal_to] if opts[:time_greater_than_or_equal_to]
  query_params[:timeLessThanOrEqualTo] = opts[:time_less_than_or_equal_to] if opts[:time_less_than_or_equal_to]
  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: 'OperationsInsightsClient#summarize_awr_database_sysstats') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Opsi::Models::AwrDatabaseSysstatCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#summarize_awr_database_top_wait_events(awr_hub_id, awr_source_database_identifier, opts = {}) ⇒ `Response`

Note:

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

Summarizes the AWR top wait events.

Parameters:

awr_hub_id (String) —

Unique Awr Hub identifier
awr_source_database_identifier (String) —

The internal ID of the database. The internal ID of the database is not the OCID. It can be retrieved from the following endpoint: /awrHubs/awrHubId/awrDatabases
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

The optional single value query parameter to filter by database instance number.
:begin_snapshot_identifier_greater_than_or_equal_to (Integer) —

The optional greater than or equal to filter on the snapshot ID.
:end_snapshot_identifier_less_than_or_equal_to (Integer) —

The optional less than or equal to query parameter to filter the snapshot Identifier.
:time_greater_than_or_equal_to (DateTime) —

The optional greater than or equal to query parameter to filter the timestamp. The timestamp format to be followed is: YYYY-MM-DDTHH:MM:SSZ, example 2020-12-03T19:00:53Z
:time_less_than_or_equal_to (DateTime) —

The optional less than or equal to query parameter to filter the timestamp. The timestamp format to be followed is: YYYY-MM-DDTHH:MM:SSZ, example 2020-12-03T19:00:53Z
:session_type (String) —

The optional query parameter to filter ASH activities by FOREGROUND or BACKGROUND. (default to FOREGROUND) Allowed values are: FOREGROUND, BACKGROUND, ALL
:top_n (Integer) —

The optional query parameter to filter the number of top categories to be returned. (default to 10)
:sort_by (String) —

The option to sort the AWR top event summary data. (default to WAITS_PERSEC) Allowed values are: WAITS_PERSEC, AVG_WAIT_TIME_PERSEC
:sort_order (String) —

The sort order to use, either ascending (ASC) or descending (DESC). (default to DESC)
:opc_request_id (String) —

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:

(Response) —

A Response object with data of type AwrDatabaseTopWaitEventCollection

# File 'lib/oci/opsi/operations_insights_client.rb', line 10912

def summarize_awr_database_top_wait_events(awr_hub_id, awr_source_database_identifier, opts = {})
  logger.debug 'Calling operation OperationsInsightsClient#summarize_awr_database_top_wait_events.' if logger

  raise "Missing the required parameter 'awr_hub_id' when calling summarize_awr_database_top_wait_events." if awr_hub_id.nil?
  raise "Missing the required parameter 'awr_source_database_identifier' when calling summarize_awr_database_top_wait_events." if awr_source_database_identifier.nil?

  if opts[:session_type] && !%w[FOREGROUND BACKGROUND ALL].include?(opts[:session_type])
    raise 'Invalid value for "session_type", must be one of FOREGROUND, BACKGROUND, ALL.'
  end

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

  if opts[:sort_order] && !OCI::Opsi::Models::SORT_ORDER_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::Opsi::Models::SORT_ORDER_ENUM.'
  end
  raise "Parameter value for 'awr_hub_id' must not be blank" if OCI::Internal::Util.blank_string?(awr_hub_id)

  path = '/awrHubs/{awrHubId}/awrDatabaseTopWaitEvents'.sub('{awrHubId}', awr_hub_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:awrSourceDatabaseIdentifier] = awr_source_database_identifier
  query_params[:instanceNumber] = opts[:instance_number] if opts[:instance_number]
  query_params[:beginSnapshotIdentifierGreaterThanOrEqualTo] = opts[:begin_snapshot_identifier_greater_than_or_equal_to] if opts[:begin_snapshot_identifier_greater_than_or_equal_to]
  query_params[:endSnapshotIdentifierLessThanOrEqualTo] = opts[:end_snapshot_identifier_less_than_or_equal_to] if opts[:end_snapshot_identifier_less_than_or_equal_to]
  query_params[:timeGreaterThanOrEqualTo] = opts[:time_greater_than_or_equal_to] if opts[:time_greater_than_or_equal_to]
  query_params[:timeLessThanOrEqualTo] = opts[:time_less_than_or_equal_to] if opts[:time_less_than_or_equal_to]
  query_params[:sessionType] = opts[:session_type] if opts[:session_type]
  query_params[:topN] = opts[:top_n] if opts[:top_n]
  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: 'OperationsInsightsClient#summarize_awr_database_top_wait_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::Opsi::Models::AwrDatabaseTopWaitEventCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#summarize_awr_database_wait_event_buckets(awr_hub_id, awr_source_database_identifier, name, opts = {}) ⇒ `Response`

Note:

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

Summarizes AWR wait event data into value buckets and frequency, for the specified database in the AWR.

Parameters:

awr_hub_id (String) —

Unique Awr Hub identifier
awr_source_database_identifier (String) —

The internal ID of the database. The internal ID of the database is not the OCID. It can be retrieved from the following endpoint: /awrHubs/awrHubId/awrDatabases
name (String) —

The required single value query parameter to filter the entity 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
:instance_number (String) —

The optional single value query parameter to filter by database instance number.
:begin_snapshot_identifier_greater_than_or_equal_to (Integer) —

The optional greater than or equal to filter on the snapshot ID.
:end_snapshot_identifier_less_than_or_equal_to (Integer) —

The optional less than or equal to query parameter to filter the snapshot Identifier.
:time_greater_than_or_equal_to (DateTime) —

The optional greater than or equal to query parameter to filter the timestamp. The timestamp format to be followed is: YYYY-MM-DDTHH:MM:SSZ, example 2020-12-03T19:00:53Z
:time_less_than_or_equal_to (DateTime) —

The optional less than or equal to query parameter to filter the timestamp. The timestamp format to be followed is: YYYY-MM-DDTHH:MM:SSZ, example 2020-12-03T19:00:53Z
:num_bucket (Integer) —

The number of buckets within the histogram. (default to 10)
:min_value (Float) —

The minimum value of the histogram. (default to 0)
:max_value (Float) —

The maximum value of the histogram.
:page (String) —

For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination.
:limit (Integer) —

For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see List Pagination. Example: 50 (default to 1000)
:sort_by (String) —

The option to sort distribution data. (default to CATEGORY) Allowed values are: CATEGORY, PERCENTAGE
:sort_order (String) —

The sort order to use, either ascending (ASC) or descending (DESC).
:opc_request_id (String) —

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:

(Response) —

A Response object with data of type AwrDatabaseWaitEventBucketCollection

# File 'lib/oci/opsi/operations_insights_client.rb', line 11023

def summarize_awr_database_wait_event_buckets(awr_hub_id, awr_source_database_identifier, name, opts = {})
  logger.debug 'Calling operation OperationsInsightsClient#summarize_awr_database_wait_event_buckets.' if logger

  raise "Missing the required parameter 'awr_hub_id' when calling summarize_awr_database_wait_event_buckets." if awr_hub_id.nil?
  raise "Missing the required parameter 'awr_source_database_identifier' when calling summarize_awr_database_wait_event_buckets." if awr_source_database_identifier.nil?
  raise "Missing the required parameter 'name' when calling summarize_awr_database_wait_event_buckets." if name.nil?

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

  if opts[:sort_order] && !OCI::Opsi::Models::SORT_ORDER_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::Opsi::Models::SORT_ORDER_ENUM.'
  end
  raise "Parameter value for 'awr_hub_id' must not be blank" if OCI::Internal::Util.blank_string?(awr_hub_id)

  path = '/awrHubs/{awrHubId}/awrDatabaseWaitEventBuckets'.sub('{awrHubId}', awr_hub_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:awrSourceDatabaseIdentifier] = awr_source_database_identifier
  query_params[:name] = name
  query_params[:instanceNumber] = opts[:instance_number] if opts[:instance_number]
  query_params[:beginSnapshotIdentifierGreaterThanOrEqualTo] = opts[:begin_snapshot_identifier_greater_than_or_equal_to] if opts[:begin_snapshot_identifier_greater_than_or_equal_to]
  query_params[:endSnapshotIdentifierLessThanOrEqualTo] = opts[:end_snapshot_identifier_less_than_or_equal_to] if opts[:end_snapshot_identifier_less_than_or_equal_to]
  query_params[:timeGreaterThanOrEqualTo] = opts[:time_greater_than_or_equal_to] if opts[:time_greater_than_or_equal_to]
  query_params[:timeLessThanOrEqualTo] = opts[:time_less_than_or_equal_to] if opts[:time_less_than_or_equal_to]
  query_params[:numBucket] = opts[:num_bucket] if opts[:num_bucket]
  query_params[:minValue] = opts[:min_value] if opts[:min_value]
  query_params[:maxValue] = opts[:max_value] if opts[:max_value]
  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: 'OperationsInsightsClient#summarize_awr_database_wait_event_buckets') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Opsi::Models::AwrDatabaseWaitEventBucketCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#summarize_awr_database_wait_events(awr_hub_id, awr_source_database_identifier, opts = {}) ⇒ `Response`

Note:

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

Summarizes the AWR wait event sample data for the specified database in the AWR. The event data is summarized based on the Time dimension for each event.

Parameters:

awr_hub_id (String) —

Unique Awr Hub identifier
awr_source_database_identifier (String) —

The internal ID of the database. The internal ID of the database is not the OCID. It can be retrieved from the following endpoint: /awrHubs/awrHubId/awrDatabases
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

The optional single value query parameter to filter by database instance number.
:begin_snapshot_identifier_greater_than_or_equal_to (Integer) —

The optional greater than or equal to filter on the snapshot ID.
:end_snapshot_identifier_less_than_or_equal_to (Integer) —

The optional less than or equal to query parameter to filter the snapshot Identifier.
:time_greater_than_or_equal_to (DateTime) —

The optional greater than or equal to query parameter to filter the timestamp. The timestamp format to be followed is: YYYY-MM-DDTHH:MM:SSZ, example 2020-12-03T19:00:53Z
:time_less_than_or_equal_to (DateTime) —

The optional less than or equal to query parameter to filter the timestamp. The timestamp format to be followed is: YYYY-MM-DDTHH:MM:SSZ, example 2020-12-03T19:00:53Z
:name (Array<String>) —

The optional multiple value query parameter to filter the entity name.
:session_type (String) —

The optional query parameter to filter ASH activities by FOREGROUND or BACKGROUND. (default to FOREGROUND) Allowed values are: FOREGROUND, BACKGROUND, ALL
:page (String) —

For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination.
:limit (Integer) —

For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see List Pagination. Example: 50 (default to 1000)
:sort_by (String) —

The option to sort the data within a time period. (default to TIME_BEGIN) Allowed values are: TIME_BEGIN, NAME
:sort_order (String) —

The sort order to use, either ascending (ASC) or descending (DESC). (default to DESC)
:opc_request_id (String) —

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:

(Response) —

A Response object with data of type AwrDatabaseWaitEventCollection

# File 'lib/oci/opsi/operations_insights_client.rb', line 11134

def summarize_awr_database_wait_events(awr_hub_id, awr_source_database_identifier, opts = {})
  logger.debug 'Calling operation OperationsInsightsClient#summarize_awr_database_wait_events.' if logger

  raise "Missing the required parameter 'awr_hub_id' when calling summarize_awr_database_wait_events." if awr_hub_id.nil?
  raise "Missing the required parameter 'awr_source_database_identifier' when calling summarize_awr_database_wait_events." if awr_source_database_identifier.nil?

  if opts[:session_type] && !%w[FOREGROUND BACKGROUND ALL].include?(opts[:session_type])
    raise 'Invalid value for "session_type", must be one of FOREGROUND, BACKGROUND, ALL.'
  end

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

  if opts[:sort_order] && !OCI::Opsi::Models::SORT_ORDER_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::Opsi::Models::SORT_ORDER_ENUM.'
  end
  raise "Parameter value for 'awr_hub_id' must not be blank" if OCI::Internal::Util.blank_string?(awr_hub_id)

  path = '/awrHubs/{awrHubId}/awrDatabaseWaitEvents'.sub('{awrHubId}', awr_hub_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:awrSourceDatabaseIdentifier] = awr_source_database_identifier
  query_params[:instanceNumber] = opts[:instance_number] if opts[:instance_number]
  query_params[:beginSnapshotIdentifierGreaterThanOrEqualTo] = opts[:begin_snapshot_identifier_greater_than_or_equal_to] if opts[:begin_snapshot_identifier_greater_than_or_equal_to]
  query_params[:endSnapshotIdentifierLessThanOrEqualTo] = opts[:end_snapshot_identifier_less_than_or_equal_to] if opts[:end_snapshot_identifier_less_than_or_equal_to]
  query_params[:timeGreaterThanOrEqualTo] = opts[:time_greater_than_or_equal_to] if opts[:time_greater_than_or_equal_to]
  query_params[:timeLessThanOrEqualTo] = opts[:time_less_than_or_equal_to] if opts[:time_less_than_or_equal_to]
  query_params[:name] = OCI::ApiClient.build_collection_params(opts[:name], :multi) if opts[:name] && !opts[:name].empty?
  query_params[:sessionType] = opts[:session_type] if opts[:session_type]
  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: 'OperationsInsightsClient#summarize_awr_database_wait_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::Opsi::Models::AwrDatabaseWaitEventCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#summarize_awr_sources_summaries(awr_hub_id, opts = {}) ⇒ `Response`

Note:

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

Gets a list of summary of AWR Sources.

Allowed values are: snapshotsUploaded, name

Parameters:

awr_hub_id (String) —

Unique Awr Hub identifier
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

The OCID of the compartment.
:name (String) —

Name for an Awr source database
:limit (Integer) —

For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see List Pagination. Example: 50 (default to 50)
:page (String) —

For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination.
:sort_by (String) —

The order in which Awr sources summary records are listed (default to snapshotsUploaded)
:sort_order (String) —

The sort order to use, either ascending (ASC) or descending (DESC).
:opc_request_id (String) —

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:

(Response) —

A Response object with data of type SummarizeAwrSourcesSummariesCollection

# File 'lib/oci/opsi/operations_insights_client.rb', line 11234

def summarize_awr_sources_summaries(awr_hub_id, opts = {})
  logger.debug 'Calling operation OperationsInsightsClient#summarize_awr_sources_summaries.' if logger

  raise "Missing the required parameter 'awr_hub_id' when calling summarize_awr_sources_summaries." if awr_hub_id.nil?

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

  if opts[:sort_order] && !OCI::Opsi::Models::SORT_ORDER_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::Opsi::Models::SORT_ORDER_ENUM.'
  end
  raise "Parameter value for 'awr_hub_id' must not be blank" if OCI::Internal::Util.blank_string?(awr_hub_id)

  path = '/awrHubs/{awrHubId}/awrSourcesSummary'.sub('{awrHubId}', awr_hub_id.to_s)
  operation_signing_strategy = :standard

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

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

  post_body = nil

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

#summarize_configuration_items(opts = {}) ⇒ `Response`

Note:

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

Gets the applicable configuration items based on the query parameters specified. Configuration items for an opsiConfigType with respect to a compartmentId can be fetched. Values specified in configItemField param will determine what fields for each configuration items have to be returned.

Allowed values are: name, value, defaultValue, valueSourceConfig, metadata, applicableContexts

Parameters:

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

the optional parameters

Options Hash (opts):

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

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

The OCID of the compartment.
:opsi_config_type (String) —

Filter to return configuration items based on configuration type of OPSI configuration.
:limit (Integer) —

For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see List Pagination. Example: 50 (default to 50)
:page (String) —

For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination.
:config_items_applicable_context (Array<String>) —

Returns the configuration items filtered by applicable contexts sent in this param. By default configuration items of all applicable contexts are returned. (default to [])
:config_item_field (Array<String>) —

Specifies the fields to return in a config item summary. (default to [])
:name (String) —

A filter to return only configuration items that match the entire name.
:opc_request_id (String) —

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:

(Response) —

A Response object with data of type ConfigurationItemsCollection

# File 'lib/oci/opsi/operations_insights_client.rb', line 11323

def summarize_configuration_items(opts = {})
  logger.debug 'Calling operation OperationsInsightsClient#summarize_configuration_items.' if logger


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


  config_item_field_allowable_values = %w[name value defaultValue valueSourceConfig metadata applicableContexts]
  if opts[:config_item_field] && !opts[:config_item_field].empty?
    opts[:config_item_field].each do |val_to_check|
      unless config_item_field_allowable_values.include?(val_to_check)
        raise 'Invalid value for "config_item_field", must be one of name, value, defaultValue, valueSourceConfig, metadata, applicableContexts.'
      end
    end
  end

  path = '/opsiConfigurations/configurationItems'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = opts[:compartment_id] if opts[:compartment_id]
  query_params[:opsiConfigType] = opts[:opsi_config_type] if opts[:opsi_config_type]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:configItemsApplicableContext] = OCI::ApiClient.build_collection_params(opts[:config_items_applicable_context], :multi) if opts[:config_items_applicable_context] && !opts[:config_items_applicable_context].empty?
  query_params[:configItemField] = OCI::ApiClient.build_collection_params(opts[:config_item_field], :multi) if opts[:config_item_field] && !opts[:config_item_field].empty?
  query_params[:name] = opts[:name] if opts[:name]

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

  post_body = nil

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

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

Note:

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

Returns response with time series data (endTimestamp, capacity, baseCapacity) for the time period specified. The maximum time range for analysis is 2 years, hence this is intentionally not paginated. If compartmentIdInSubtree is specified, aggregates resources in a compartment and in all sub-compartments.

Allowed values are: HIGH_UTILIZATION, LOW_UTILIZATION, MEDIUM_HIGH_UTILIZATION, MEDIUM_LOW_UTILIZATION Allowed values are: endTimestamp, capacity, baseCapacity

Parameters:

compartment_id (String) —

The OCID of the compartment.
resource_metric (String) —

Filter by resource metric. Supported values are CPU , STORAGE, MEMORY and IO.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

Specify time period in ISO 8601 format with respect to current time. Default is last 30 days represented by P30D. If timeInterval is specified, then timeIntervalStart and timeIntervalEnd will be ignored. Examples P90D (last 90 days), P4W (last 4 weeks), P2M (last 2 months), P1Y (last 12 months), . Maximum value allowed is 25 months prior to current time (P25M). (default to P30D)
:time_interval_start (DateTime) —

Analysis start time in UTC in ISO 8601 format(inclusive). Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). The minimum allowed value is 2 years prior to the current day. timeIntervalStart and timeIntervalEnd parameters are used together. If analysisTimeInterval is specified, this parameter is ignored.
:time_interval_end (DateTime) —

Analysis end time in UTC in ISO 8601 format(exclusive). Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). timeIntervalStart and timeIntervalEnd are used together. If timeIntervalEnd is not specified, current time is used as timeIntervalEnd.
:database_type (Array<String>) —

Filter by one or more database type. Possible values are ADW-S, ATP-S, ADW-D, ATP-D, EXTERNAL-PDB, EXTERNAL-NONCDB. (default to []) Allowed values are: ADW-S, ATP-S, ADW-D, ATP-D, EXTERNAL-PDB, EXTERNAL-NONCDB, COMANAGED-VM-CDB, COMANAGED-VM-PDB, COMANAGED-VM-NONCDB, COMANAGED-BM-CDB, COMANAGED-BM-PDB, COMANAGED-BM-NONCDB, COMANAGED-EXACS-CDB, COMANAGED-EXACS-PDB, COMANAGED-EXACS-NONCDB
:database_id (Array<String>) —

Optional list of database OCIDs of the associated DBaaS entity. (default to [])
:id (Array<String>) —

Optional list of database insight resource OCIDs. (default to [])
:exadata_insight_id (Array<String>) —

Optional list of exadata insight resource OCIDs. (default to [])
:cdb_name (Array<String>) —

Filter by one or more cdb name. (default to [])
:utilization_level (String) —

Filter by utilization level by the following buckets: - HIGH_UTILIZATION: DBs with utilization greater or equal than 75. - LOW_UTILIZATION: DBs with utilization lower than 25. - MEDIUM_HIGH_UTILIZATION: DBs with utilization greater or equal than 50 but lower than 75. - MEDIUM_LOW_UTILIZATION: DBs with utilization greater or equal than 25 but lower than 50.
:page (String) —

For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination.
:sort_order (String) —

The sort order to use, either ascending (ASC) or descending (DESC).
:sort_by (String) —

Sorts using end timestamp , capacity or baseCapacity (default to endTimestamp)
:tablespace_name (String) —

Tablespace name for a database
:host_name (Array<String>) —

Filter by one or more hostname. (default to [])
:is_database_instance_level_metrics (BOOLEAN) —

Flag to indicate if database instance level metrics should be returned. The flag is ignored when a host name filter is not applied. When a hostname filter is applied this flag will determine whether to return metrics for the instances located on the specified host or for the whole database which contains an instance on this host. (default to false)
:opc_request_id (String) —

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
:defined_tag_equals (Array<String>) —

A list of tag filters to apply. Only resources with a defined tag matching the value will be returned. Each item in the list has the format "namespace.tagName.value". All inputs are case-insensitive. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as "OR". Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as "AND".
:freeform_tag_equals (Array<String>) —

A list of tag filters to apply. Only resources with a freeform tag matching the value will be returned. The key for each tag is "tagName.value". All inputs are case-insensitive. Multiple values for the same tag name are interpreted as "OR". Values for different tag names are interpreted as "AND".
:defined_tag_exists (Array<String>) —

A list of tag existence filters to apply. Only resources for which the specified defined tags exist will be returned. Each item in the list has the format "namespace.tagName.true" (for checking existence of a defined tag) or "namespace.true". All inputs are case-insensitive. Currently, only existence ("true" at the end) is supported. Absence ("false" at the end) is not supported. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as "OR". Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as "AND".
:freeform_tag_exists (Array<String>) —

A list of tag existence filters to apply. Only resources for which the specified freeform tags exist the value will be returned. The key for each tag is "tagName.true". All inputs are case-insensitive. Currently, only existence ("true" at the end) is supported. Absence ("false" at the end) is not supported. Multiple values for different tag names are interpreted as "AND".
:compartment_id_in_subtree (BOOLEAN) —

A flag to search all resources within a given compartment and all sub-compartments. (default to false)
:vmcluster_name (Array<String>) —

Optional list of Exadata Insight VM cluster name. (default to [])
:high_utilization_threshold (Integer) —

Percent value in which a resource metric is considered highly utilized. (default to 75)
:low_utilization_threshold (Integer) —

Percent value in which a resource metric is considered low utilized. (default to 25)

Returns:

(Response) —

A Response object with data of type SummarizeDatabaseInsightResourceCapacityTrendAggregationCollection

# File 'lib/oci/opsi/operations_insights_client.rb', line 11483

def summarize_database_insight_resource_capacity_trend(compartment_id, resource_metric, opts = {})
  logger.debug 'Calling operation OperationsInsightsClient#summarize_database_insight_resource_capacity_trend.' if logger

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


  database_type_allowable_values = %w[ADW-S ATP-S ADW-D ATP-D EXTERNAL-PDB EXTERNAL-NONCDB COMANAGED-VM-CDB COMANAGED-VM-PDB COMANAGED-VM-NONCDB COMANAGED-BM-CDB COMANAGED-BM-PDB COMANAGED-BM-NONCDB COMANAGED-EXACS-CDB COMANAGED-EXACS-PDB COMANAGED-EXACS-NONCDB]
  if opts[:database_type] && !opts[:database_type].empty?
    opts[:database_type].each do |val_to_check|
      unless database_type_allowable_values.include?(val_to_check)
        raise 'Invalid value for "database_type", must be one of ADW-S, ATP-S, ADW-D, ATP-D, EXTERNAL-PDB, EXTERNAL-NONCDB, COMANAGED-VM-CDB, COMANAGED-VM-PDB, COMANAGED-VM-NONCDB, COMANAGED-BM-CDB, COMANAGED-BM-PDB, COMANAGED-BM-NONCDB, COMANAGED-EXACS-CDB, COMANAGED-EXACS-PDB, COMANAGED-EXACS-NONCDB.'
      end
    end
  end

  if opts[:utilization_level] && !%w[HIGH_UTILIZATION LOW_UTILIZATION MEDIUM_HIGH_UTILIZATION MEDIUM_LOW_UTILIZATION].include?(opts[:utilization_level])
    raise 'Invalid value for "utilization_level", must be one of HIGH_UTILIZATION, LOW_UTILIZATION, MEDIUM_HIGH_UTILIZATION, MEDIUM_LOW_UTILIZATION.'
  end

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

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

  path = '/databaseInsights/resourceCapacityTrend'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:resourceMetric] = resource_metric
  query_params[:analysisTimeInterval] = opts[:analysis_time_interval] if opts[:analysis_time_interval]
  query_params[:timeIntervalStart] = opts[:time_interval_start] if opts[:time_interval_start]
  query_params[:timeIntervalEnd] = opts[:time_interval_end] if opts[:time_interval_end]
  query_params[:databaseType] = OCI::ApiClient.build_collection_params(opts[:database_type], :multi) if opts[:database_type] && !opts[:database_type].empty?
  query_params[:databaseId] = OCI::ApiClient.build_collection_params(opts[:database_id], :multi) if opts[:database_id] && !opts[:database_id].empty?
  query_params[:id] = OCI::ApiClient.build_collection_params(opts[:id], :multi) if opts[:id] && !opts[:id].empty?
  query_params[:exadataInsightId] = OCI::ApiClient.build_collection_params(opts[:exadata_insight_id], :multi) if opts[:exadata_insight_id] && !opts[:exadata_insight_id].empty?
  query_params[:cdbName] = OCI::ApiClient.build_collection_params(opts[:cdb_name], :multi) if opts[:cdb_name] && !opts[:cdb_name].empty?
  query_params[:utilizationLevel] = opts[:utilization_level] if opts[:utilization_level]
  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[:tablespaceName] = opts[:tablespace_name] if opts[:tablespace_name]
  query_params[:hostName] = OCI::ApiClient.build_collection_params(opts[:host_name], :multi) if opts[:host_name] && !opts[:host_name].empty?
  query_params[:isDatabaseInstanceLevelMetrics] = opts[:is_database_instance_level_metrics] if !opts[:is_database_instance_level_metrics].nil?
  query_params[:definedTagEquals] = OCI::ApiClient.build_collection_params(opts[:defined_tag_equals], :multi) if opts[:defined_tag_equals] && !opts[:defined_tag_equals].empty?
  query_params[:freeformTagEquals] = OCI::ApiClient.build_collection_params(opts[:freeform_tag_equals], :multi) if opts[:freeform_tag_equals] && !opts[:freeform_tag_equals].empty?
  query_params[:definedTagExists] = OCI::ApiClient.build_collection_params(opts[:defined_tag_exists], :multi) if opts[:defined_tag_exists] && !opts[:defined_tag_exists].empty?
  query_params[:freeformTagExists] = OCI::ApiClient.build_collection_params(opts[:freeform_tag_exists], :multi) if opts[:freeform_tag_exists] && !opts[:freeform_tag_exists].empty?
  query_params[:compartmentIdInSubtree] = opts[:compartment_id_in_subtree] if !opts[:compartment_id_in_subtree].nil?
  query_params[:vmclusterName] = OCI::ApiClient.build_collection_params(opts[:vmcluster_name], :multi) if opts[:vmcluster_name] && !opts[:vmcluster_name].empty?
  query_params[:highUtilizationThreshold] = opts[:high_utilization_threshold] if opts[:high_utilization_threshold]
  query_params[:lowUtilizationThreshold] = opts[:low_utilization_threshold] if opts[:low_utilization_threshold]

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

  post_body = nil

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

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

Note:

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

Get Forecast predictions for CPU and Storage resources since a time in the past. If compartmentIdInSubtree is specified, aggregates resources in a compartment and in all sub-compartments.

Allowed values are: HIGH_UTILIZATION, LOW_UTILIZATION, MEDIUM_HIGH_UTILIZATION, MEDIUM_LOW_UTILIZATION

Parameters:

compartment_id (String) —

The OCID of the compartment.
resource_metric (String) —

Filter by resource metric. Supported values are CPU , STORAGE, MEMORY and IO.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

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

Specify time period in ISO 8601 format with respect to current time. Default is last 30 days represented by P30D. If timeInterval is specified, then timeIntervalStart and timeIntervalEnd will be ignored. Examples P90D (last 90 days), P4W (last 4 weeks), P2M (last 2 months), P1Y (last 12 months), . Maximum value allowed is 25 months prior to current time (P25M). (default to P30D)
:time_interval_start (DateTime) —

Analysis start time in UTC in ISO 8601 format(inclusive). Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). The minimum allowed value is 2 years prior to the current day. timeIntervalStart and timeIntervalEnd parameters are used together. If analysisTimeInterval is specified, this parameter is ignored.
:time_interval_end (DateTime) —

Analysis end time in UTC in ISO 8601 format(exclusive). Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). timeIntervalStart and timeIntervalEnd are used together. If timeIntervalEnd is not specified, current time is used as timeIntervalEnd.
:database_type (Array<String>) —

Filter by one or more database type. Possible values are ADW-S, ATP-S, ADW-D, ATP-D, EXTERNAL-PDB, EXTERNAL-NONCDB. (default to []) Allowed values are: ADW-S, ATP-S, ADW-D, ATP-D, EXTERNAL-PDB, EXTERNAL-NONCDB, COMANAGED-VM-CDB, COMANAGED-VM-PDB, COMANAGED-VM-NONCDB, COMANAGED-BM-CDB, COMANAGED-BM-PDB, COMANAGED-BM-NONCDB, COMANAGED-EXACS-CDB, COMANAGED-EXACS-PDB, COMANAGED-EXACS-NONCDB
:database_id (Array<String>) —

Optional list of database OCIDs of the associated DBaaS entity. (default to [])
:id (Array<String>) —

Optional list of database insight resource OCIDs. (default to [])
:exadata_insight_id (Array<String>) —

Optional list of exadata insight resource OCIDs. (default to [])
:cdb_name (Array<String>) —

Filter by one or more cdb name. (default to [])
:statistic (String) —

Choose the type of statistic metric data to be used for forecasting. (default to AVG) Allowed values are: AVG, MAX
:forecast_days (Integer) —

Number of days used for utilization forecast analysis. (default to 30)
:forecast_model (String) —

Choose algorithm model for the forecasting. Possible values: - LINEAR: Uses linear regression algorithm for forecasting. - ML_AUTO: Automatically detects best algorithm to use for forecasting. - ML_NO_AUTO: Automatically detects seasonality of the data for forecasting using linear or seasonal algorithm. (default to ML_NO_AUTO) Allowed values are: LINEAR, ML_AUTO, ML_NO_AUTO
:utilization_level (String) —

Filter by utilization level by the following buckets: - HIGH_UTILIZATION: DBs with utilization greater or equal than 75. - LOW_UTILIZATION: DBs with utilization lower than 25. - MEDIUM_HIGH_UTILIZATION: DBs with utilization greater or equal than 50 but lower than 75. - MEDIUM_LOW_UTILIZATION: DBs with utilization greater or equal than 25 but lower than 50.
:confidence (Integer) —

This parameter is used to change data's confidence level, this data is ingested by the forecast algorithm. Confidence is the probability of an interval to contain the expected population parameter. Manipulation of this value will lead to different results. If not set, default confidence value is 95%. (default to 95)
:page (String) —

For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination.
:host_name (Array<String>) —

Filter by one or more hostname. (default to [])
:tablespace_name (String) —

Tablespace name for a database
:is_database_instance_level_metrics (BOOLEAN) —

Flag to indicate if database instance level metrics should be returned. The flag is ignored when a host name filter is not applied. When a hostname filter is applied this flag will determine whether to return metrics for the instances located on the specified host or for the whole database which contains an instance on this host. (default to false)
:opc_request_id (String) —

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
:defined_tag_equals (Array<String>) —

A list of tag filters to apply. Only resources with a defined tag matching the value will be returned. Each item in the list has the format "namespace.tagName.value". All inputs are case-insensitive. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as "OR". Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as "AND".
:freeform_tag_equals (Array<String>) —

A list of tag filters to apply. Only resources with a freeform tag matching the value will be returned. The key for each tag is "tagName.value". All inputs are case-insensitive. Multiple values for the same tag name are interpreted as "OR". Values for different tag names are interpreted as "AND".
:defined_tag_exists (Array<String>) —

A list of tag existence filters to apply. Only resources for which the specified defined tags exist will be returned. Each item in the list has the format "namespace.tagName.true" (for checking existence of a defined tag) or "namespace.true". All inputs are case-insensitive. Currently, only existence ("true" at the end) is supported. Absence ("false" at the end) is not supported. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as "OR". Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as "AND".
:freeform_tag_exists (Array<String>) —

A list of tag existence filters to apply. Only resources for which the specified freeform tags exist the value will be returned. The key for each tag is "tagName.true". All inputs are case-insensitive. Currently, only existence ("true" at the end) is supported. Absence ("false" at the end) is not supported. Multiple values for different tag names are interpreted as "AND".
:compartment_id_in_subtree (BOOLEAN) —

A flag to search all resources within a given compartment and all sub-compartments. (default to false)
:vmcluster_name (Array<String>) —

Optional list of Exadata Insight VM cluster name. (default to [])
:high_utilization_threshold (Integer) —

Percent value in which a resource metric is considered highly utilized. (default to 75)
:low_utilization_threshold (Integer) —

Percent value in which a resource metric is considered low utilized. (default to 25)

Returns:

(Response) —

A Response object with data of type SummarizeDatabaseInsightResourceForecastTrendAggregation

# File 'lib/oci/opsi/operations_insights_client.rb', line 11682

def summarize_database_insight_resource_forecast_trend(compartment_id, resource_metric, opts = {})
  logger.debug 'Calling operation OperationsInsightsClient#summarize_database_insight_resource_forecast_trend.' if logger

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


  database_type_allowable_values = %w[ADW-S ATP-S ADW-D ATP-D EXTERNAL-PDB EXTERNAL-NONCDB COMANAGED-VM-CDB COMANAGED-VM-PDB COMANAGED-VM-NONCDB COMANAGED-BM-CDB COMANAGED-BM-PDB COMANAGED-BM-NONCDB COMANAGED-EXACS-CDB COMANAGED-EXACS-PDB COMANAGED-EXACS-NONCDB]
  if opts[:database_type] && !opts[:database_type].empty?
    opts[:database_type].each do |val_to_check|
      unless database_type_allowable_values.include?(val_to_check)
        raise 'Invalid value for "database_type", must be one of ADW-S, ATP-S, ADW-D, ATP-D, EXTERNAL-PDB, EXTERNAL-NONCDB, COMANAGED-VM-CDB, COMANAGED-VM-PDB, COMANAGED-VM-NONCDB, COMANAGED-BM-CDB, COMANAGED-BM-PDB, COMANAGED-BM-NONCDB, COMANAGED-EXACS-CDB, COMANAGED-EXACS-PDB, COMANAGED-EXACS-NONCDB.'
      end
    end
  end

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

  if opts[:forecast_model] && !%w[LINEAR ML_AUTO ML_NO_AUTO].include?(opts[:forecast_model])
    raise 'Invalid value for "forecast_model", must be one of LINEAR, ML_AUTO, ML_NO_AUTO.'
  end

  if opts[:utilization_level] && !%w[HIGH_UTILIZATION LOW_UTILIZATION MEDIUM_HIGH_UTILIZATION MEDIUM_LOW_UTILIZATION].include?(opts[:utilization_level])
    raise 'Invalid value for "utilization_level", must be one of HIGH_UTILIZATION, LOW_UTILIZATION, MEDIUM_HIGH_UTILIZATION, MEDIUM_LOW_UTILIZATION.'
  end

  path = '/databaseInsights/resourceForecastTrend'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:resourceMetric] = resource_metric
  query_params[:analysisTimeInterval] = opts[:analysis_time_interval] if opts[:analysis_time_interval]
  query_params[:timeIntervalStart] = opts[:time_interval_start] if opts[:time_interval_start]
  query_params[:timeIntervalEnd] = opts[:time_interval_end] if opts[:time_interval_end]
  query_params[:databaseType] = OCI::ApiClient.build_collection_params(opts[:database_type], :multi) if opts[:database_type] && !opts[:database_type].empty?
  query_params[:databaseId] = OCI::ApiClient.build_collection_params(opts[:database_id], :multi) if opts[:database_id] && !opts[:database_id].empty?
  query_params[:id] = OCI::ApiClient.build_collection_params(opts[:id], :multi) if opts[:id] && !opts[:id].empty?
  query_params[:exadataInsightId] = OCI::ApiClient.build_collection_params(opts[:exadata_insight_id], :multi) if opts[:exadata_insight_id] && !opts[:exadata_insight_id].empty?
  query_params[:cdbName] = OCI::ApiClient.build_collection_params(opts[:cdb_name], :multi) if opts[:cdb_name] && !opts[:cdb_name].empty?
  query_params[:statistic] = opts[:statistic] if opts[:statistic]
  query_params[:forecastDays] = opts[:forecast_days] if opts[:forecast_days]
  query_params[:forecastModel] = opts[:forecast_model] if opts[:forecast_model]
  query_params[:utilizationLevel] = opts[:utilization_level] if opts[:utilization_level]
  query_params[:confidence] = opts[:confidence] if opts[:confidence]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:hostName] = OCI::ApiClient.build_collection_params(opts[:host_name], :multi) if opts[:host_name] && !opts[:host_name].empty?
  query_params[:tablespaceName] = opts[:tablespace_name] if opts[:tablespace_name]
  query_params[:isDatabaseInstanceLevelMetrics] = opts[:is_database_instance_level_metrics] if !opts[:is_database_instance_level_metrics].nil?
  query_params[:definedTagEquals] = OCI::ApiClient.build_collection_params(opts[:defined_tag_equals], :multi) if opts[:defined_tag_equals] && !opts[:defined_tag_equals].empty?
  query_params[:freeformTagEquals] = OCI::ApiClient.build_collection_params(opts[:freeform_tag_equals], :multi) if opts[:freeform_tag_equals] && !opts[:freeform_tag_equals].empty?
  query_params[:definedTagExists] = OCI::ApiClient.build_collection_params(opts[:defined_tag_exists], :multi) if opts[:defined_tag_exists] && !opts[:defined_tag_exists].empty?
  query_params[:freeformTagExists] = OCI::ApiClient.build_collection_params(opts[:freeform_tag_exists], :multi) if opts[:freeform_tag_exists] && !opts[:freeform_tag_exists].empty?
  query_params[:compartmentIdInSubtree] = opts[:compartment_id_in_subtree] if !opts[:compartment_id_in_subtree].nil?
  query_params[:vmclusterName] = OCI::ApiClient.build_collection_params(opts[:vmcluster_name], :multi) if opts[:vmcluster_name] && !opts[:vmcluster_name].empty?
  query_params[:highUtilizationThreshold] = opts[:high_utilization_threshold] if opts[:high_utilization_threshold]
  query_params[:lowUtilizationThreshold] = opts[:low_utilization_threshold] if opts[:low_utilization_threshold]

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

  post_body = nil

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

#summarize_database_insight_resource_statistics(compartment_id, resource_metric, opts = {}) ⇒ `Response`

Note:

Click here to see an example of how to use summarize_database_insight_resource_statistics API.

Lists the Resource statistics (usage,capacity, usage change percent, utilization percent, base capacity, isAutoScalingEnabled) for each database filtered by utilization level in a compartment and in all sub-compartments if specified.

Allowed values are: utilizationPercent, usage, usageChangePercent, databaseName, databaseType

Parameters:

compartment_id (String) —

The OCID of the compartment.
resource_metric (String) —

Filter by resource metric. Supported values are CPU , STORAGE, MEMORY and IO.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:retry_config (OCI::Retry::RetryConfig) —

The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry
:analysis_time_interval (String) —

Specify time period in ISO 8601 format with respect to current time. Default is last 30 days represented by P30D. If timeInterval is specified, then timeIntervalStart and timeIntervalEnd will be ignored. Examples P90D (last 90 days), P4W (last 4 weeks), P2M (last 2 months), P1Y (last 12 months), . Maximum value allowed is 25 months prior to current time (P25M). (default to P30D)
:time_interval_start (DateTime) —

Analysis start time in UTC in ISO 8601 format(inclusive). Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). The minimum allowed value is 2 years prior to the current day. timeIntervalStart and timeIntervalEnd parameters are used together. If analysisTimeInterval is specified, this parameter is ignored.
:time_interval_end (DateTime) —

Analysis end time in UTC in ISO 8601 format(exclusive). Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). timeIntervalStart and timeIntervalEnd are used together. If timeIntervalEnd is not specified, current time is used as timeIntervalEnd.
:database_type (Array<String>) —

Filter by one or more database type. Possible values are ADW-S, ATP-S, ADW-D, ATP-D, EXTERNAL-PDB, EXTERNAL-NONCDB. (default to []) Allowed values are: ADW-S, ATP-S, ADW-D, ATP-D, EXTERNAL-PDB, EXTERNAL-NONCDB, COMANAGED-VM-CDB, COMANAGED-VM-PDB, COMANAGED-VM-NONCDB, COMANAGED-BM-CDB, COMANAGED-BM-PDB, COMANAGED-BM-NONCDB, COMANAGED-EXACS-CDB, COMANAGED-EXACS-PDB, COMANAGED-EXACS-NONCDB
:database_id (Array<String>) —

Optional list of database OCIDs of the associated DBaaS entity. (default to [])
:id (Array<String>) —

Optional list of database insight resource OCIDs. (default to [])
:exadata_insight_id (Array<String>) —

Optional list of exadata insight resource OCIDs. (default to [])
:cdb_name (Array<String>) —

Filter by one or more cdb name. (default to [])
:percentile (Integer) —

Percentile values of daily usage to be used for computing the aggregate resource usage. (default to 90)
:insight_by (String) —

Return data of a specific insight Possible values are High Utilization, Low Utilization, Any ,High Utilization Forecast, Low Utilization Forecast (default to [ANY])
:forecast_days (Integer) —

Number of days used for utilization forecast analysis. (default to 30)
:limit (Integer) —

For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see List Pagination. Example: 50 (default to 50)
:page (String) —

For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination.
:sort_order (String) —

The sort order to use, either ascending (ASC) or descending (DESC).
:sort_by (String) —

The order in which resource statistics records are listed (default to utilizationPercent)
:host_name (Array<String>) —

Filter by one or more hostname. (default to [])
:is_database_instance_level_metrics (BOOLEAN) —

Flag to indicate if database instance level metrics should be returned. The flag is ignored when a host name filter is not applied. When a hostname filter is applied this flag will determine whether to return metrics for the instances located on the specified host or for the whole database which contains an instance on this host. (default to false)
:opc_request_id (String) —

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
:defined_tag_equals (Array<String>) —

A list of tag filters to apply. Only resources with a defined tag matching the value will be returned. Each item in the list has the format "namespace.tagName.value". All inputs are case-insensitive. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as "OR". Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as "AND".
:freeform_tag_equals (Array<String>) —

A list of tag filters to apply. Only resources with a freeform tag matching the value will be returned. The key for each tag is "tagName.value". All inputs are case-insensitive. Multiple values for the same tag name are interpreted as "OR". Values for different tag names are interpreted as "AND".
:defined_tag_exists (Array<String>) —

A list of tag existence filters to apply. Only resources for which the specified defined tags exist will be returned. Each item in the list has the format "namespace.tagName.true" (for checking existence of a defined tag) or "namespace.true". All inputs are case-insensitive. Currently, only existence ("true" at the end) is supported. Absence ("false" at the end) is not supported. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as "OR". Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as "AND".
:freeform_tag_exists (Array<String>) —

A list of tag existence filters to apply. Only resources for which the specified freeform tags exist the value will be returned. The key for each tag is "tagName.true". All inputs are case-insensitive. Currently, only existence ("true" at the end) is supported. Absence ("false" at the end) is not supported. Multiple values for different tag names are interpreted as "AND".
:compartment_id_in_subtree (BOOLEAN) —

A flag to search all resources within a given compartment and all sub-compartments. (default to false)
:vmcluster_name (Array<String>) —

Optional list of Exadata Insight VM cluster name. (default to [])
:high_utilization_threshold (Integer) —

Percent value in which a resource metric is considered highly utilized. (default to 75)
:low_utilization_threshold (Integer) —

Percent value in which a resource metric is considered low utilized. (default to 25)

Returns:

(Response) —

A Response object with data of type SummarizeDatabaseInsightResourceStatisticsAggregationCollection

# File 'lib/oci/opsi/operations_insights_client.rb', line 11876

def summarize_database_insight_resource_statistics(compartment_id, resource_metric, opts = {})
  logger.debug 'Calling operation OperationsInsightsClient#summarize_database_insight_resource_statistics.' if logger

  raise "Missing the required parameter 'compartment_id' when calling summarize_database_insight_resource_statistics." if compartment_id.nil?
  raise "Missing the required parameter 'resource_metric' when calling summarize_database_insight_resource_statistics." if resource_metric.nil?


  database_type_allowable_values = %w[ADW-S ATP-S ADW-D ATP-D EXTERNAL-PDB EXTERNAL-NONCDB COMANAGED-VM-CDB COMANAGED-VM-PDB COMANAGED-VM-NONCDB COMANAGED-BM-CDB COMANAGED-BM-PDB COMANAGED-BM-NONCDB COMANAGED-EXACS-CDB COMANAGED-EXACS-PDB COMANAGED-EXACS-NONCDB]
  if opts[:database_type] && !opts[:database_type].empty?
    opts[:database_type].each do |val_to_check|
      unless database_type_allowable_values.include?(val_to_check)
        raise 'Invalid value for "database_type", must be one of ADW-S, ATP-S, ADW-D, ATP-D, EXTERNAL-PDB, EXTERNAL-NONCDB, COMANAGED-VM-CDB, COMANAGED-VM-PDB, COMANAGED-VM-NONCDB, COMANAGED-BM-CDB, COMANAGED-BM-PDB, COMANAGED-BM-NONCDB, COMANAGED-EXACS-CDB, COMANAGED-EXACS-PDB, COMANAGED-EXACS-NONCDB.'
      end
    end
  end

  if opts[:sort_order] && !OCI::Opsi::Models::SORT_ORDER_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::Opsi::Models::SORT_ORDER_ENUM.'
  end

  if opts[:sort_by] && !%w[utilizationPercent usage usageChangePercent databaseName databaseType].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of utilizationPercent, usage, usageChangePercent, databaseName, databaseType.'
  end

  path = '/databaseInsights/resourceStatistics'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:resourceMetric] = resource_metric
  query_params[:analysisTimeInterval] = opts[:analysis_time_interval] if opts[:analysis_time_interval]
  query_params[:timeIntervalStart] = opts[:time_interval_start] if opts[:time_interval_start]
  query_params[:timeIntervalEnd] = opts[:time_interval_end] if opts[:time_interval_end]
  query_params[:databaseType] = OCI::ApiClient.build_collection_params(opts[:database_type], :multi) if opts[:database_type] && !opts[:database_type].empty?
  query_params[:databaseId] = OCI::ApiClient.build_collection_params(opts[:database_id], :multi) if opts[:database_id] && !opts[:database_id].empty?
  query_params[:id] = OCI::ApiClient.build_collection_params(opts[:id], :multi) if opts[:id] && !opts[:id].empty?
  query_params[:exadataInsightId] = OCI::ApiClient.build_collection_params(opts[:exadata_insight_id], :multi) if opts[:exadata_insight_id] && !opts[:exadata_insight_id].empty?
  query_params[:cdbName] = OCI::ApiClient.build_collection_params(opts[:cdb_name], :multi) if opts[:cdb_name] && !opts[:cdb_name].empty?
  query_params[:percentile] = opts[:percentile] if opts[:percentile]
  query_params[:insightBy] = opts[:insight_by] if opts[:insight_by]
  query_params[:forecastDays] = opts[:forecast_days] if opts[:forecast_days]
  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[:hostName] = OCI::ApiClient.build_collection_params(opts[:host_name], :multi) if opts[:host_name] && !opts[:host_name].empty?
  query_params[:isDatabaseInstanceLevelMetrics] = opts[:is_database_instance_level_metrics] if !opts[:is_database_instance_level_metrics].nil?
  query_params[:definedTagEquals] = OCI::ApiClient.build_collection_params(opts[:defined_tag_equals], :multi) if opts[:defined_tag_equals] && !opts[:defined_tag_equals].empty?
  query_params[:freeformTagEquals] = OCI::ApiClient.build_collection_params(opts[:freeform_tag_equals], :multi) if opts[:freeform_tag_equals] && !opts[:freeform_tag_equals].empty?
  query_params[:definedTagExists] = OCI::ApiClient.build_collection_params(opts[:defined_tag_exists], :multi) if opts[:defined_tag_exists] && !opts[:defined_tag_exists].empty?
  query_params[:freeformTagExists] = OCI::ApiClient.build_collection_params(opts[:freeform_tag_exists], :multi) if opts[:freeform_tag_exists] && !opts[:freeform_tag_exists].empty?
  query_params[:compartmentIdInSubtree] = opts[:compartment_id_in_subtree] if !opts[:compartment_id_in_subtree].nil?
  query_params[:vmclusterName] = OCI::ApiClient.build_collection_params(opts[:vmcluster_name], :multi) if opts[:vmcluster_name] && !opts[:vmcluster_name].empty?
  query_params[:highUtilizationThreshold] = opts[:high_utilization_threshold] if opts[:high_utilization_threshold]
  query_params[:lowUtilizationThreshold] = opts[:low_utilization_threshold] if opts[:low_utilization_threshold]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'OperationsInsightsClient#summarize_database_insight_resource_statistics') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Opsi::Models::SummarizeDatabaseInsightResourceStatisticsAggregationCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#summarize_database_insight_resource_usage(compartment_id, resource_metric, opts = {}) ⇒ `Response`

Note:

Click here to see an example of how to use summarize_database_insight_resource_usage API.

A cumulative distribution function is used to rank the usage data points per database within the specified time period. For each database, the minimum data point with a ranking > the percentile value is included in the summation. Linear regression functions are used to calculate the usage change percentage. If compartmentIdInSubtree is specified, aggregates resources in a compartment and in all sub-compartments.

Parameters:

compartment_id (String) —

The OCID of the compartment.
resource_metric (String) —

Filter by resource metric. Supported values are CPU , STORAGE, MEMORY and IO.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:retry_config (OCI::Retry::RetryConfig) —

The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry
:analysis_time_interval (String) —

Specify time period in ISO 8601 format with respect to current time. Default is last 30 days represented by P30D. If timeInterval is specified, then timeIntervalStart and timeIntervalEnd will be ignored. Examples P90D (last 90 days), P4W (last 4 weeks), P2M (last 2 months), P1Y (last 12 months), . Maximum value allowed is 25 months prior to current time (P25M). (default to P30D)
:time_interval_start (DateTime) —

Analysis start time in UTC in ISO 8601 format(inclusive). Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). The minimum allowed value is 2 years prior to the current day. timeIntervalStart and timeIntervalEnd parameters are used together. If analysisTimeInterval is specified, this parameter is ignored.
:time_interval_end (DateTime) —

Analysis end time in UTC in ISO 8601 format(exclusive). Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). timeIntervalStart and timeIntervalEnd are used together. If timeIntervalEnd is not specified, current time is used as timeIntervalEnd.
:database_type (Array<String>) —

Filter by one or more database type. Possible values are ADW-S, ATP-S, ADW-D, ATP-D, EXTERNAL-PDB, EXTERNAL-NONCDB. (default to []) Allowed values are: ADW-S, ATP-S, ADW-D, ATP-D, EXTERNAL-PDB, EXTERNAL-NONCDB, COMANAGED-VM-CDB, COMANAGED-VM-PDB, COMANAGED-VM-NONCDB, COMANAGED-BM-CDB, COMANAGED-BM-PDB, COMANAGED-BM-NONCDB, COMANAGED-EXACS-CDB, COMANAGED-EXACS-PDB, COMANAGED-EXACS-NONCDB
:database_id (Array<String>) —

Optional list of database OCIDs of the associated DBaaS entity. (default to [])
:id (Array<String>) —

Optional list of database insight resource OCIDs. (default to [])
:exadata_insight_id (Array<String>) —

Optional list of exadata insight resource OCIDs. (default to [])
:host_name (Array<String>) —

Filter by one or more hostname. (default to [])
:is_database_instance_level_metrics (BOOLEAN) —

Flag to indicate if database instance level metrics should be returned. The flag is ignored when a host name filter is not applied. When a hostname filter is applied this flag will determine whether to return metrics for the instances located on the specified host or for the whole database which contains an instance on this host. (default to false)
:page (String) —

For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination.
:percentile (Integer) —

Percentile values of daily usage to be used for computing the aggregate resource usage. (default to 90)
:opc_request_id (String) —

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
:defined_tag_equals (Array<String>) —

A list of tag filters to apply. Only resources with a defined tag matching the value will be returned. Each item in the list has the format "namespace.tagName.value". All inputs are case-insensitive. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as "OR". Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as "AND".
:freeform_tag_equals (Array<String>) —

A list of tag filters to apply. Only resources with a freeform tag matching the value will be returned. The key for each tag is "tagName.value". All inputs are case-insensitive. Multiple values for the same tag name are interpreted as "OR". Values for different tag names are interpreted as "AND".
:defined_tag_exists (Array<String>) —

A list of tag existence filters to apply. Only resources for which the specified defined tags exist will be returned. Each item in the list has the format "namespace.tagName.true" (for checking existence of a defined tag) or "namespace.true". All inputs are case-insensitive. Currently, only existence ("true" at the end) is supported. Absence ("false" at the end) is not supported. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as "OR". Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as "AND".
:freeform_tag_exists (Array<String>) —

A list of tag existence filters to apply. Only resources for which the specified freeform tags exist the value will be returned. The key for each tag is "tagName.true". All inputs are case-insensitive. Currently, only existence ("true" at the end) is supported. Absence ("false" at the end) is not supported. Multiple values for different tag names are interpreted as "AND".
:compartment_id_in_subtree (BOOLEAN) —

A flag to search all resources within a given compartment and all sub-compartments. (default to false)
:vmcluster_name (Array<String>) —

Optional list of Exadata Insight VM cluster name. (default to [])
:cdb_name (Array<String>) —

Filter by one or more cdb name. (default to [])

Returns:

(Response) —

A Response object with data of type SummarizeDatabaseInsightResourceUsageAggregation

# File 'lib/oci/opsi/operations_insights_client.rb', line 12049

def summarize_database_insight_resource_usage(compartment_id, resource_metric, opts = {})
  logger.debug 'Calling operation OperationsInsightsClient#summarize_database_insight_resource_usage.' if logger

  raise "Missing the required parameter 'compartment_id' when calling summarize_database_insight_resource_usage." if compartment_id.nil?
  raise "Missing the required parameter 'resource_metric' when calling summarize_database_insight_resource_usage." if resource_metric.nil?


  database_type_allowable_values = %w[ADW-S ATP-S ADW-D ATP-D EXTERNAL-PDB EXTERNAL-NONCDB COMANAGED-VM-CDB COMANAGED-VM-PDB COMANAGED-VM-NONCDB COMANAGED-BM-CDB COMANAGED-BM-PDB COMANAGED-BM-NONCDB COMANAGED-EXACS-CDB COMANAGED-EXACS-PDB COMANAGED-EXACS-NONCDB]
  if opts[:database_type] && !opts[:database_type].empty?
    opts[:database_type].each do |val_to_check|
      unless database_type_allowable_values.include?(val_to_check)
        raise 'Invalid value for "database_type", must be one of ADW-S, ATP-S, ADW-D, ATP-D, EXTERNAL-PDB, EXTERNAL-NONCDB, COMANAGED-VM-CDB, COMANAGED-VM-PDB, COMANAGED-VM-NONCDB, COMANAGED-BM-CDB, COMANAGED-BM-PDB, COMANAGED-BM-NONCDB, COMANAGED-EXACS-CDB, COMANAGED-EXACS-PDB, COMANAGED-EXACS-NONCDB.'
      end
    end
  end

  path = '/databaseInsights/resourceUsageSummary'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:resourceMetric] = resource_metric
  query_params[:analysisTimeInterval] = opts[:analysis_time_interval] if opts[:analysis_time_interval]
  query_params[:timeIntervalStart] = opts[:time_interval_start] if opts[:time_interval_start]
  query_params[:timeIntervalEnd] = opts[:time_interval_end] if opts[:time_interval_end]
  query_params[:databaseType] = OCI::ApiClient.build_collection_params(opts[:database_type], :multi) if opts[:database_type] && !opts[:database_type].empty?
  query_params[:databaseId] = OCI::ApiClient.build_collection_params(opts[:database_id], :multi) if opts[:database_id] && !opts[:database_id].empty?
  query_params[:id] = OCI::ApiClient.build_collection_params(opts[:id], :multi) if opts[:id] && !opts[:id].empty?
  query_params[:exadataInsightId] = OCI::ApiClient.build_collection_params(opts[:exadata_insight_id], :multi) if opts[:exadata_insight_id] && !opts[:exadata_insight_id].empty?
  query_params[:hostName] = OCI::ApiClient.build_collection_params(opts[:host_name], :multi) if opts[:host_name] && !opts[:host_name].empty?
  query_params[:isDatabaseInstanceLevelMetrics] = opts[:is_database_instance_level_metrics] if !opts[:is_database_instance_level_metrics].nil?
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:percentile] = opts[:percentile] if opts[:percentile]
  query_params[:definedTagEquals] = OCI::ApiClient.build_collection_params(opts[:defined_tag_equals], :multi) if opts[:defined_tag_equals] && !opts[:defined_tag_equals].empty?
  query_params[:freeformTagEquals] = OCI::ApiClient.build_collection_params(opts[:freeform_tag_equals], :multi) if opts[:freeform_tag_equals] && !opts[:freeform_tag_equals].empty?
  query_params[:definedTagExists] = OCI::ApiClient.build_collection_params(opts[:defined_tag_exists], :multi) if opts[:defined_tag_exists] && !opts[:defined_tag_exists].empty?
  query_params[:freeformTagExists] = OCI::ApiClient.build_collection_params(opts[:freeform_tag_exists], :multi) if opts[:freeform_tag_exists] && !opts[:freeform_tag_exists].empty?
  query_params[:compartmentIdInSubtree] = opts[:compartment_id_in_subtree] if !opts[:compartment_id_in_subtree].nil?
  query_params[:vmclusterName] = OCI::ApiClient.build_collection_params(opts[:vmcluster_name], :multi) if opts[:vmcluster_name] && !opts[:vmcluster_name].empty?
  query_params[:cdbName] = OCI::ApiClient.build_collection_params(opts[:cdb_name], :multi) if opts[:cdb_name] && !opts[:cdb_name].empty?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'OperationsInsightsClient#summarize_database_insight_resource_usage') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Opsi::Models::SummarizeDatabaseInsightResourceUsageAggregation'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#summarize_database_insight_resource_usage_trend(compartment_id, resource_metric, opts = {}) ⇒ `Response`

Note:

Click here to see an example of how to use summarize_database_insight_resource_usage_trend API.

Returns response with time series data (endTimestamp, usage, capacity) for the time period specified. The maximum time range for analysis is 2 years, hence this is intentionally not paginated. If compartmentIdInSubtree is specified, aggregates resources in a compartment and in all sub-compartments.

Allowed values are: endTimestamp, usage, capacity

Parameters:

compartment_id (String) —

The OCID of the compartment.
resource_metric (String) —

Filter by resource metric. Supported values are CPU , STORAGE, MEMORY and IO.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:retry_config (OCI::Retry::RetryConfig) —

The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry
:analysis_time_interval (String) —

Specify time period in ISO 8601 format with respect to current time. Default is last 30 days represented by P30D. If timeInterval is specified, then timeIntervalStart and timeIntervalEnd will be ignored. Examples P90D (last 90 days), P4W (last 4 weeks), P2M (last 2 months), P1Y (last 12 months), . Maximum value allowed is 25 months prior to current time (P25M). (default to P30D)
:time_interval_start (DateTime) —

Analysis start time in UTC in ISO 8601 format(inclusive). Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). The minimum allowed value is 2 years prior to the current day. timeIntervalStart and timeIntervalEnd parameters are used together. If analysisTimeInterval is specified, this parameter is ignored.
:time_interval_end (DateTime) —

Analysis end time in UTC in ISO 8601 format(exclusive). Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). timeIntervalStart and timeIntervalEnd are used together. If timeIntervalEnd is not specified, current time is used as timeIntervalEnd.
:database_type (Array<String>) —

Filter by one or more database type. Possible values are ADW-S, ATP-S, ADW-D, ATP-D, EXTERNAL-PDB, EXTERNAL-NONCDB. (default to []) Allowed values are: ADW-S, ATP-S, ADW-D, ATP-D, EXTERNAL-PDB, EXTERNAL-NONCDB, COMANAGED-VM-CDB, COMANAGED-VM-PDB, COMANAGED-VM-NONCDB, COMANAGED-BM-CDB, COMANAGED-BM-PDB, COMANAGED-BM-NONCDB, COMANAGED-EXACS-CDB, COMANAGED-EXACS-PDB, COMANAGED-EXACS-NONCDB
:database_id (Array<String>) —

Optional list of database OCIDs of the associated DBaaS entity. (default to [])
:id (Array<String>) —

Optional list of database insight resource OCIDs. (default to [])
:exadata_insight_id (Array<String>) —

Optional list of exadata insight resource OCIDs. (default to [])
:page (String) —

For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination.
:sort_order (String) —

The sort order to use, either ascending (ASC) or descending (DESC).
:sort_by (String) —

Sorts using end timestamp, usage or capacity (default to endTimestamp)
:host_name (Array<String>) —

Filter by one or more hostname. (default to [])
:is_database_instance_level_metrics (BOOLEAN) —

Flag to indicate if database instance level metrics should be returned. The flag is ignored when a host name filter is not applied. When a hostname filter is applied this flag will determine whether to return metrics for the instances located on the specified host or for the whole database which contains an instance on this host. (default to false)
:opc_request_id (String) —

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
:defined_tag_equals (Array<String>) —

A list of tag filters to apply. Only resources with a defined tag matching the value will be returned. Each item in the list has the format "namespace.tagName.value". All inputs are case-insensitive. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as "OR". Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as "AND".
:freeform_tag_equals (Array<String>) —

A list of tag filters to apply. Only resources with a freeform tag matching the value will be returned. The key for each tag is "tagName.value". All inputs are case-insensitive. Multiple values for the same tag name are interpreted as "OR". Values for different tag names are interpreted as "AND".
:defined_tag_exists (Array<String>) —

A list of tag existence filters to apply. Only resources for which the specified defined tags exist will be returned. Each item in the list has the format "namespace.tagName.true" (for checking existence of a defined tag) or "namespace.true". All inputs are case-insensitive. Currently, only existence ("true" at the end) is supported. Absence ("false" at the end) is not supported. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as "OR". Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as "AND".
:freeform_tag_exists (Array<String>) —

A list of tag existence filters to apply. Only resources for which the specified freeform tags exist the value will be returned. The key for each tag is "tagName.true". All inputs are case-insensitive. Currently, only existence ("true" at the end) is supported. Absence ("false" at the end) is not supported. Multiple values for different tag names are interpreted as "AND".
:compartment_id_in_subtree (BOOLEAN) —

A flag to search all resources within a given compartment and all sub-compartments. (default to false)
:vmcluster_name (Array<String>) —

Optional list of Exadata Insight VM cluster name. (default to [])
:cdb_name (Array<String>) —

Filter by one or more cdb name. (default to [])

Returns:

(Response) —

A Response object with data of type SummarizeDatabaseInsightResourceUsageTrendAggregationCollection

# File 'lib/oci/opsi/operations_insights_client.rb', line 12209

def summarize_database_insight_resource_usage_trend(compartment_id, resource_metric, opts = {})
  logger.debug 'Calling operation OperationsInsightsClient#summarize_database_insight_resource_usage_trend.' if logger

  raise "Missing the required parameter 'compartment_id' when calling summarize_database_insight_resource_usage_trend." if compartment_id.nil?
  raise "Missing the required parameter 'resource_metric' when calling summarize_database_insight_resource_usage_trend." if resource_metric.nil?


  database_type_allowable_values = %w[ADW-S ATP-S ADW-D ATP-D EXTERNAL-PDB EXTERNAL-NONCDB COMANAGED-VM-CDB COMANAGED-VM-PDB COMANAGED-VM-NONCDB COMANAGED-BM-CDB COMANAGED-BM-PDB COMANAGED-BM-NONCDB COMANAGED-EXACS-CDB COMANAGED-EXACS-PDB COMANAGED-EXACS-NONCDB]
  if opts[:database_type] && !opts[:database_type].empty?
    opts[:database_type].each do |val_to_check|
      unless database_type_allowable_values.include?(val_to_check)
        raise 'Invalid value for "database_type", must be one of ADW-S, ATP-S, ADW-D, ATP-D, EXTERNAL-PDB, EXTERNAL-NONCDB, COMANAGED-VM-CDB, COMANAGED-VM-PDB, COMANAGED-VM-NONCDB, COMANAGED-BM-CDB, COMANAGED-BM-PDB, COMANAGED-BM-NONCDB, COMANAGED-EXACS-CDB, COMANAGED-EXACS-PDB, COMANAGED-EXACS-NONCDB.'
      end
    end
  end

  if opts[:sort_order] && !OCI::Opsi::Models::SORT_ORDER_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::Opsi::Models::SORT_ORDER_ENUM.'
  end

  if opts[:sort_by] && !%w[endTimestamp usage capacity].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of endTimestamp, usage, capacity.'
  end

  path = '/databaseInsights/resourceUsageTrend'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:resourceMetric] = resource_metric
  query_params[:analysisTimeInterval] = opts[:analysis_time_interval] if opts[:analysis_time_interval]
  query_params[:timeIntervalStart] = opts[:time_interval_start] if opts[:time_interval_start]
  query_params[:timeIntervalEnd] = opts[:time_interval_end] if opts[:time_interval_end]
  query_params[:databaseType] = OCI::ApiClient.build_collection_params(opts[:database_type], :multi) if opts[:database_type] && !opts[:database_type].empty?
  query_params[:databaseId] = OCI::ApiClient.build_collection_params(opts[:database_id], :multi) if opts[:database_id] && !opts[:database_id].empty?
  query_params[:id] = OCI::ApiClient.build_collection_params(opts[:id], :multi) if opts[:id] && !opts[:id].empty?
  query_params[:exadataInsightId] = OCI::ApiClient.build_collection_params(opts[:exadata_insight_id], :multi) if opts[:exadata_insight_id] && !opts[:exadata_insight_id].empty?
  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[:hostName] = OCI::ApiClient.build_collection_params(opts[:host_name], :multi) if opts[:host_name] && !opts[:host_name].empty?
  query_params[:isDatabaseInstanceLevelMetrics] = opts[:is_database_instance_level_metrics] if !opts[:is_database_instance_level_metrics].nil?
  query_params[:definedTagEquals] = OCI::ApiClient.build_collection_params(opts[:defined_tag_equals], :multi) if opts[:defined_tag_equals] && !opts[:defined_tag_equals].empty?
  query_params[:freeformTagEquals] = OCI::ApiClient.build_collection_params(opts[:freeform_tag_equals], :multi) if opts[:freeform_tag_equals] && !opts[:freeform_tag_equals].empty?
  query_params[:definedTagExists] = OCI::ApiClient.build_collection_params(opts[:defined_tag_exists], :multi) if opts[:defined_tag_exists] && !opts[:defined_tag_exists].empty?
  query_params[:freeformTagExists] = OCI::ApiClient.build_collection_params(opts[:freeform_tag_exists], :multi) if opts[:freeform_tag_exists] && !opts[:freeform_tag_exists].empty?
  query_params[:compartmentIdInSubtree] = opts[:compartment_id_in_subtree] if !opts[:compartment_id_in_subtree].nil?
  query_params[:vmclusterName] = OCI::ApiClient.build_collection_params(opts[:vmcluster_name], :multi) if opts[:vmcluster_name] && !opts[:vmcluster_name].empty?
  query_params[:cdbName] = OCI::ApiClient.build_collection_params(opts[:cdb_name], :multi) if opts[:cdb_name] && !opts[:cdb_name].empty?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'OperationsInsightsClient#summarize_database_insight_resource_usage_trend') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Opsi::Models::SummarizeDatabaseInsightResourceUsageTrendAggregationCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#summarize_database_insight_resource_utilization_insight(compartment_id, resource_metric, opts = {}) ⇒ `Response`

Note:

Click here to see an example of how to use summarize_database_insight_resource_utilization_insight API.

Gets resources with current utilization (high and low) and projected utilization (high and low) for a resource type over specified time period. If compartmentIdInSubtree is specified, aggregates resources in a compartment and in all sub-compartments.

Parameters:

compartment_id (String) —

The OCID of the compartment.
resource_metric (String) —

Filter by resource metric. Supported values are CPU , STORAGE, MEMORY and IO.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:retry_config (OCI::Retry::RetryConfig) —

The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry
:analysis_time_interval (String) —

Specify time period in ISO 8601 format with respect to current time. Default is last 30 days represented by P30D. If timeInterval is specified, then timeIntervalStart and timeIntervalEnd will be ignored. Examples P90D (last 90 days), P4W (last 4 weeks), P2M (last 2 months), P1Y (last 12 months), . Maximum value allowed is 25 months prior to current time (P25M). (default to P30D)
:time_interval_start (DateTime) —

Analysis start time in UTC in ISO 8601 format(inclusive). Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). The minimum allowed value is 2 years prior to the current day. timeIntervalStart and timeIntervalEnd parameters are used together. If analysisTimeInterval is specified, this parameter is ignored.
:time_interval_end (DateTime) —

Analysis end time in UTC in ISO 8601 format(exclusive). Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). timeIntervalStart and timeIntervalEnd are used together. If timeIntervalEnd is not specified, current time is used as timeIntervalEnd.
:database_type (Array<String>) —

Filter by one or more database type. Possible values are ADW-S, ATP-S, ADW-D, ATP-D, EXTERNAL-PDB, EXTERNAL-NONCDB. (default to []) Allowed values are: ADW-S, ATP-S, ADW-D, ATP-D, EXTERNAL-PDB, EXTERNAL-NONCDB, COMANAGED-VM-CDB, COMANAGED-VM-PDB, COMANAGED-VM-NONCDB, COMANAGED-BM-CDB, COMANAGED-BM-PDB, COMANAGED-BM-NONCDB, COMANAGED-EXACS-CDB, COMANAGED-EXACS-PDB, COMANAGED-EXACS-NONCDB
:database_id (Array<String>) —

Optional list of database OCIDs of the associated DBaaS entity. (default to [])
:id (Array<String>) —

Optional list of database insight resource OCIDs. (default to [])
:exadata_insight_id (Array<String>) —

Optional list of exadata insight resource OCIDs. (default to [])
:forecast_days (Integer) —

Number of days used for utilization forecast analysis. (default to 30)
:host_name (Array<String>) —

Filter by one or more hostname. (default to [])
:is_database_instance_level_metrics (BOOLEAN) —

Flag to indicate if database instance level metrics should be returned. The flag is ignored when a host name filter is not applied. When a hostname filter is applied this flag will determine whether to return metrics for the instances located on the specified host or for the whole database which contains an instance on this host. (default to false)
:page (String) —

For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination.
:opc_request_id (String) —

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
:defined_tag_equals (Array<String>) —

A list of tag filters to apply. Only resources with a defined tag matching the value will be returned. Each item in the list has the format "namespace.tagName.value". All inputs are case-insensitive. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as "OR". Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as "AND".
:freeform_tag_equals (Array<String>) —

A list of tag filters to apply. Only resources with a freeform tag matching the value will be returned. The key for each tag is "tagName.value". All inputs are case-insensitive. Multiple values for the same tag name are interpreted as "OR". Values for different tag names are interpreted as "AND".
:defined_tag_exists (Array<String>) —

A list of tag existence filters to apply. Only resources for which the specified defined tags exist will be returned. Each item in the list has the format "namespace.tagName.true" (for checking existence of a defined tag) or "namespace.true". All inputs are case-insensitive. Currently, only existence ("true" at the end) is supported. Absence ("false" at the end) is not supported. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as "OR". Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as "AND".
:freeform_tag_exists (Array<String>) —

A list of tag existence filters to apply. Only resources for which the specified freeform tags exist the value will be returned. The key for each tag is "tagName.true". All inputs are case-insensitive. Currently, only existence ("true" at the end) is supported. Absence ("false" at the end) is not supported. Multiple values for different tag names are interpreted as "AND".
:compartment_id_in_subtree (BOOLEAN) —

A flag to search all resources within a given compartment and all sub-compartments. (default to false)
:vmcluster_name (Array<String>) —

Optional list of Exadata Insight VM cluster name. (default to [])
:cdb_name (Array<String>) —

Filter by one or more cdb name. (default to [])
:high_utilization_threshold (Integer) —

Percent value in which a resource metric is considered highly utilized. (default to 75)
:low_utilization_threshold (Integer) —

Percent value in which a resource metric is considered low utilized. (default to 25)

Returns:

(Response) —

A Response object with data of type SummarizeDatabaseInsightResourceUtilizationInsightAggregation

# File 'lib/oci/opsi/operations_insights_client.rb', line 12376

def summarize_database_insight_resource_utilization_insight(compartment_id, resource_metric, opts = {})
  logger.debug 'Calling operation OperationsInsightsClient#summarize_database_insight_resource_utilization_insight.' if logger

  raise "Missing the required parameter 'compartment_id' when calling summarize_database_insight_resource_utilization_insight." if compartment_id.nil?
  raise "Missing the required parameter 'resource_metric' when calling summarize_database_insight_resource_utilization_insight." if resource_metric.nil?


  database_type_allowable_values = %w[ADW-S ATP-S ADW-D ATP-D EXTERNAL-PDB EXTERNAL-NONCDB COMANAGED-VM-CDB COMANAGED-VM-PDB COMANAGED-VM-NONCDB COMANAGED-BM-CDB COMANAGED-BM-PDB COMANAGED-BM-NONCDB COMANAGED-EXACS-CDB COMANAGED-EXACS-PDB COMANAGED-EXACS-NONCDB]
  if opts[:database_type] && !opts[:database_type].empty?
    opts[:database_type].each do |val_to_check|
      unless database_type_allowable_values.include?(val_to_check)
        raise 'Invalid value for "database_type", must be one of ADW-S, ATP-S, ADW-D, ATP-D, EXTERNAL-PDB, EXTERNAL-NONCDB, COMANAGED-VM-CDB, COMANAGED-VM-PDB, COMANAGED-VM-NONCDB, COMANAGED-BM-CDB, COMANAGED-BM-PDB, COMANAGED-BM-NONCDB, COMANAGED-EXACS-CDB, COMANAGED-EXACS-PDB, COMANAGED-EXACS-NONCDB.'
      end
    end
  end

  path = '/databaseInsights/resourceUtilizationInsight'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:resourceMetric] = resource_metric
  query_params[:analysisTimeInterval] = opts[:analysis_time_interval] if opts[:analysis_time_interval]
  query_params[:timeIntervalStart] = opts[:time_interval_start] if opts[:time_interval_start]
  query_params[:timeIntervalEnd] = opts[:time_interval_end] if opts[:time_interval_end]
  query_params[:databaseType] = OCI::ApiClient.build_collection_params(opts[:database_type], :multi) if opts[:database_type] && !opts[:database_type].empty?
  query_params[:databaseId] = OCI::ApiClient.build_collection_params(opts[:database_id], :multi) if opts[:database_id] && !opts[:database_id].empty?
  query_params[:id] = OCI::ApiClient.build_collection_params(opts[:id], :multi) if opts[:id] && !opts[:id].empty?
  query_params[:exadataInsightId] = OCI::ApiClient.build_collection_params(opts[:exadata_insight_id], :multi) if opts[:exadata_insight_id] && !opts[:exadata_insight_id].empty?
  query_params[:forecastDays] = opts[:forecast_days] if opts[:forecast_days]
  query_params[:hostName] = OCI::ApiClient.build_collection_params(opts[:host_name], :multi) if opts[:host_name] && !opts[:host_name].empty?
  query_params[:isDatabaseInstanceLevelMetrics] = opts[:is_database_instance_level_metrics] if !opts[:is_database_instance_level_metrics].nil?
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:definedTagEquals] = OCI::ApiClient.build_collection_params(opts[:defined_tag_equals], :multi) if opts[:defined_tag_equals] && !opts[:defined_tag_equals].empty?
  query_params[:freeformTagEquals] = OCI::ApiClient.build_collection_params(opts[:freeform_tag_equals], :multi) if opts[:freeform_tag_equals] && !opts[:freeform_tag_equals].empty?
  query_params[:definedTagExists] = OCI::ApiClient.build_collection_params(opts[:defined_tag_exists], :multi) if opts[:defined_tag_exists] && !opts[:defined_tag_exists].empty?
  query_params[:freeformTagExists] = OCI::ApiClient.build_collection_params(opts[:freeform_tag_exists], :multi) if opts[:freeform_tag_exists] && !opts[:freeform_tag_exists].empty?
  query_params[:compartmentIdInSubtree] = opts[:compartment_id_in_subtree] if !opts[:compartment_id_in_subtree].nil?
  query_params[:vmclusterName] = OCI::ApiClient.build_collection_params(opts[:vmcluster_name], :multi) if opts[:vmcluster_name] && !opts[:vmcluster_name].empty?
  query_params[:cdbName] = OCI::ApiClient.build_collection_params(opts[:cdb_name], :multi) if opts[:cdb_name] && !opts[:cdb_name].empty?
  query_params[:highUtilizationThreshold] = opts[:high_utilization_threshold] if opts[:high_utilization_threshold]
  query_params[:lowUtilizationThreshold] = opts[:low_utilization_threshold] if opts[:low_utilization_threshold]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'OperationsInsightsClient#summarize_database_insight_resource_utilization_insight') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Opsi::Models::SummarizeDatabaseInsightResourceUtilizationInsightAggregation'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#summarize_database_insight_tablespace_usage_trend(compartment_id, opts = {}) ⇒ `Response`

Note:

Click here to see an example of how to use summarize_database_insight_tablespace_usage_trend API.

Returns response with usage time series data (endTimestamp, usage, capacity) with breakdown by tablespaceName for the time period specified. The maximum time range for analysis is 2 years, hence this is intentionally not paginated. Either databaseId or id must be specified.

Parameters:

compartment_id (String) —

The OCID of the compartment.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:retry_config (OCI::Retry::RetryConfig) —

The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry
:analysis_time_interval (String) —

Specify time period in ISO 8601 format with respect to current time. Default is last 30 days represented by P30D. If timeInterval is specified, then timeIntervalStart and timeIntervalEnd will be ignored. Examples P90D (last 90 days), P4W (last 4 weeks), P2M (last 2 months), P1Y (last 12 months), . Maximum value allowed is 25 months prior to current time (P25M). (default to P30D)
:time_interval_start (DateTime) —

Analysis start time in UTC in ISO 8601 format(inclusive). Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). The minimum allowed value is 2 years prior to the current day. timeIntervalStart and timeIntervalEnd parameters are used together. If analysisTimeInterval is specified, this parameter is ignored.
:time_interval_end (DateTime) —

Analysis end time in UTC in ISO 8601 format(exclusive). Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). timeIntervalStart and timeIntervalEnd are used together. If timeIntervalEnd is not specified, current time is used as timeIntervalEnd.
:database_id (String) —

Optional OCID of the associated DBaaS entity.
:id (String) —

OCID of the database insight resource.
:page (String) —

For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination.
:limit (Integer) —

For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see List Pagination. Example: 50 (default to 50)
:opc_request_id (String) —

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:

(Response) —

A Response object with data of type SummarizeDatabaseInsightTablespaceUsageTrendAggregationCollection

# File 'lib/oci/opsi/operations_insights_client.rb', line 12497

def summarize_database_insight_tablespace_usage_trend(compartment_id, opts = {})
  logger.debug 'Calling operation OperationsInsightsClient#summarize_database_insight_tablespace_usage_trend.' if logger

  raise "Missing the required parameter 'compartment_id' when calling summarize_database_insight_tablespace_usage_trend." if compartment_id.nil?

  path = '/databaseInsights/tablespaceUsageTrend'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:analysisTimeInterval] = opts[:analysis_time_interval] if opts[:analysis_time_interval]
  query_params[:timeIntervalStart] = opts[:time_interval_start] if opts[:time_interval_start]
  query_params[:timeIntervalEnd] = opts[:time_interval_end] if opts[:time_interval_end]
  query_params[:databaseId] = opts[:database_id] if opts[:database_id]
  query_params[:id] = opts[:id] if opts[:id]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:limit] = opts[:limit] if opts[:limit]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'OperationsInsightsClient#summarize_database_insight_tablespace_usage_trend') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Opsi::Models::SummarizeDatabaseInsightTablespaceUsageTrendAggregationCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#summarize_exadata_insight_resource_capacity_trend(resource_type, resource_metric, exadata_insight_id, opts = {}) ⇒ `Response`

Note:

Click here to see an example of how to use summarize_exadata_insight_resource_capacity_trend API.

Returns response with time series data (endTimestamp, capacity) for the time period specified for an exadata system for a resource metric. Additionally resources can be filtered using databaseInsightId, hostInsightId or storageServerName query parameters. Top five resources are returned if total exceeds the limit specified. Valid values for ResourceType DATABASE are CPU,MEMORY,IO and STORAGE. Database name is returned in name field. DatabaseInsightId, cdbName and hostName query parameter applies to ResourceType DATABASE. Valid values for ResourceType HOST are CPU and MEMORY. HostName is returned in name field. HostInsightId and hostName query parameter applies to ResourceType HOST. Valid values for ResourceType STORAGE_SERVER are STORAGE, IOPS and THROUGHPUT. Storage server name is returned in name field for resourceMetric IOPS and THROUGHPUT and asmName is returned in name field for resourceMetric STORAGE. StorageServerName query parameter applies to ResourceType STORAGE_SERVER. Valid values for ResourceType DISKGROUP is STORAGE. Comma delimited (asmName,diskgroupName) is returned in name field.

Parameters:

resource_type (String) —

Filter by resource. Supported values are HOST , STORAGE_SERVER and DATABASE
resource_metric (String) —

Filter by resource metric. Supported values are CPU , STORAGE, MEMORY, IO, IOPS, THROUGHPUT
exadata_insight_id (String) —

OCID of exadata insight 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
:compartment_id (String) —

The OCID of the compartment.
:analysis_time_interval (String) —

Specify time period in ISO 8601 format with respect to current time. Default is last 30 days represented by P30D. If timeInterval is specified, then timeIntervalStart and timeIntervalEnd will be ignored. Examples P90D (last 90 days), P4W (last 4 weeks), P2M (last 2 months), P1Y (last 12 months), . Maximum value allowed is 25 months prior to current time (P25M). (default to P30D)
:time_interval_start (DateTime) —

Analysis start time in UTC in ISO 8601 format(inclusive). Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). The minimum allowed value is 2 years prior to the current day. timeIntervalStart and timeIntervalEnd parameters are used together. If analysisTimeInterval is specified, this parameter is ignored.
:time_interval_end (DateTime) —

Analysis end time in UTC in ISO 8601 format(exclusive). Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). timeIntervalStart and timeIntervalEnd are used together. If timeIntervalEnd is not specified, current time is used as timeIntervalEnd.
:database_insight_id (Array<String>) —

Optional list of database insight resource OCIDs. (default to [])
:host_insight_id (Array<String>) —

Optional list of host insight resource OCIDs. (default to [])
:storage_server_name (Array<String>) —

Optional storage server name on an exadata system. (default to [])
:exadata_type (Array<String>) —

Filter by one or more Exadata types. Possible value are DBMACHINE, EXACS, and EXACC. (default to [])
:cdb_name (Array<String>) —

Filter by one or more cdb name. (default to [])
:host_name (Array<String>) —

Filter by hostname. (default to [])
:page (String) —

For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination.
:limit (Integer) —

For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see List Pagination. Example: 50 (default to 5)
:sort_order (String) —

The sort order to use, either ascending (ASC) or descending (DESC).
:sort_by (String) —

The order in which resource capacity trend records are listed (default to name) Allowed values are: id, name
:opc_request_id (String) —

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:

(Response) —

A Response object with data of type SummarizeExadataInsightResourceCapacityTrendCollection

# File 'lib/oci/opsi/operations_insights_client.rb', line 12619

def summarize_exadata_insight_resource_capacity_trend(resource_type, resource_metric, exadata_insight_id, opts = {})
  logger.debug 'Calling operation OperationsInsightsClient#summarize_exadata_insight_resource_capacity_trend.' if logger

  raise "Missing the required parameter 'resource_type' when calling summarize_exadata_insight_resource_capacity_trend." if resource_type.nil?
  raise "Missing the required parameter 'resource_metric' when calling summarize_exadata_insight_resource_capacity_trend." if resource_metric.nil?
  raise "Missing the required parameter 'exadata_insight_id' when calling summarize_exadata_insight_resource_capacity_trend." if exadata_insight_id.nil?

  if opts[:sort_order] && !OCI::Opsi::Models::SORT_ORDER_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::Opsi::Models::SORT_ORDER_ENUM.'
  end

  if opts[:sort_by] && !%w[id name].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of id, name.'
  end

  path = '/exadataInsights/resourceCapacityTrend'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:resourceType] = resource_type
  query_params[:resourceMetric] = resource_metric
  query_params[:exadataInsightId] = exadata_insight_id
  query_params[:compartmentId] = opts[:compartment_id] if opts[:compartment_id]
  query_params[:analysisTimeInterval] = opts[:analysis_time_interval] if opts[:analysis_time_interval]
  query_params[:timeIntervalStart] = opts[:time_interval_start] if opts[:time_interval_start]
  query_params[:timeIntervalEnd] = opts[:time_interval_end] if opts[:time_interval_end]
  query_params[:databaseInsightId] = OCI::ApiClient.build_collection_params(opts[:database_insight_id], :multi) if opts[:database_insight_id] && !opts[:database_insight_id].empty?
  query_params[:hostInsightId] = OCI::ApiClient.build_collection_params(opts[:host_insight_id], :multi) if opts[:host_insight_id] && !opts[:host_insight_id].empty?
  query_params[:storageServerName] = OCI::ApiClient.build_collection_params(opts[:storage_server_name], :multi) if opts[:storage_server_name] && !opts[:storage_server_name].empty?
  query_params[:exadataType] = OCI::ApiClient.build_collection_params(opts[:exadata_type], :multi) if opts[:exadata_type] && !opts[:exadata_type].empty?
  query_params[:cdbName] = OCI::ApiClient.build_collection_params(opts[:cdb_name], :multi) if opts[:cdb_name] && !opts[:cdb_name].empty?
  query_params[:hostName] = OCI::ApiClient.build_collection_params(opts[:host_name], :multi) if opts[:host_name] && !opts[:host_name].empty?
  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: 'OperationsInsightsClient#summarize_exadata_insight_resource_capacity_trend') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Opsi::Models::SummarizeExadataInsightResourceCapacityTrendCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#summarize_exadata_insight_resource_capacity_trend_aggregated(resource_type, resource_metric, opts = {}) ⇒ `Response`

Note:

Click here to see an example of how to use summarize_exadata_insight_resource_capacity_trend_aggregated API.

Returns response with time series data (endTimestamp, capacity) for the time period specified for an exadata system or fleet aggregation for a resource metric. The maximum time range for analysis is 2 years, hence this is intentionally not paginated. Valid values for ResourceType DATABASE are CPU,MEMORY,IO and STORAGE. Valid values for ResourceType HOST are CPU and MEMORY. Valid values for ResourceType STORAGE_SERVER are STORAGE, IOPS and THROUGHPUT.

Allowed values are: endTimestamp, capacity

Parameters:

resource_type (String) —

Filter by resource. Supported values are HOST , STORAGE_SERVER and DATABASE
resource_metric (String) —

Filter by resource metric. Supported values are CPU , STORAGE, MEMORY, IO, IOPS, THROUGHPUT
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:retry_config (OCI::Retry::RetryConfig) —

The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry
:compartment_id (String) —

The OCID of the compartment.
:analysis_time_interval (String) —

Specify time period in ISO 8601 format with respect to current time. Default is last 30 days represented by P30D. If timeInterval is specified, then timeIntervalStart and timeIntervalEnd will be ignored. Examples P90D (last 90 days), P4W (last 4 weeks), P2M (last 2 months), P1Y (last 12 months), . Maximum value allowed is 25 months prior to current time (P25M). (default to P30D)
:time_interval_start (DateTime) —

Analysis start time in UTC in ISO 8601 format(inclusive). Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). The minimum allowed value is 2 years prior to the current day. timeIntervalStart and timeIntervalEnd parameters are used together. If analysisTimeInterval is specified, this parameter is ignored.
:time_interval_end (DateTime) —

Analysis end time in UTC in ISO 8601 format(exclusive). Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). timeIntervalStart and timeIntervalEnd are used together. If timeIntervalEnd is not specified, current time is used as timeIntervalEnd.
:exadata_insight_id (Array<String>) —

Optional list of exadata insight resource OCIDs. (default to [])
:exadata_type (Array<String>) —

Filter by one or more Exadata types. Possible value are DBMACHINE, EXACS, and EXACC. (default to [])
:cdb_name (Array<String>) —

Filter by one or more cdb name. (default to [])
:host_name (Array<String>) —

Filter by hostname. (default to [])
:page (String) —

For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination.
:sort_order (String) —

The sort order to use, either ascending (ASC) or descending (DESC).
:sort_by (String) —

Sorts using end timestamp or capacity. (default to endTimestamp)
:defined_tag_equals (Array<String>) —

A list of tag filters to apply. Only resources with a defined tag matching the value will be returned. Each item in the list has the format "namespace.tagName.value". All inputs are case-insensitive. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as "OR". Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as "AND".
:freeform_tag_equals (Array<String>) —

A list of tag filters to apply. Only resources with a freeform tag matching the value will be returned. The key for each tag is "tagName.value". All inputs are case-insensitive. Multiple values for the same tag name are interpreted as "OR". Values for different tag names are interpreted as "AND".
:defined_tag_exists (Array<String>) —

A list of tag existence filters to apply. Only resources for which the specified defined tags exist will be returned. Each item in the list has the format "namespace.tagName.true" (for checking existence of a defined tag) or "namespace.true". All inputs are case-insensitive. Currently, only existence ("true" at the end) is supported. Absence ("false" at the end) is not supported. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as "OR". Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as "AND".
:freeform_tag_exists (Array<String>) —

A list of tag existence filters to apply. Only resources for which the specified freeform tags exist the value will be returned. The key for each tag is "tagName.true". All inputs are case-insensitive. Currently, only existence ("true" at the end) is supported. Absence ("false" at the end) is not supported. Multiple values for different tag names are interpreted as "AND".
:opc_request_id (String) —

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:

(Response) —

A Response object with data of type SummarizeExadataInsightResourceCapacityTrendAggregation

# File 'lib/oci/opsi/operations_insights_client.rb', line 12767

def summarize_exadata_insight_resource_capacity_trend_aggregated(resource_type, resource_metric, opts = {})
  logger.debug 'Calling operation OperationsInsightsClient#summarize_exadata_insight_resource_capacity_trend_aggregated.' if logger

  raise "Missing the required parameter 'resource_type' when calling summarize_exadata_insight_resource_capacity_trend_aggregated." if resource_type.nil?
  raise "Missing the required parameter 'resource_metric' when calling summarize_exadata_insight_resource_capacity_trend_aggregated." if resource_metric.nil?

  if opts[:sort_order] && !OCI::Opsi::Models::SORT_ORDER_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::Opsi::Models::SORT_ORDER_ENUM.'
  end

  if opts[:sort_by] && !%w[endTimestamp capacity].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of endTimestamp, capacity.'
  end

  path = '/exadataInsights/resourceCapacityTrendAggregated'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:resourceType] = resource_type
  query_params[:resourceMetric] = resource_metric
  query_params[:compartmentId] = opts[:compartment_id] if opts[:compartment_id]
  query_params[:analysisTimeInterval] = opts[:analysis_time_interval] if opts[:analysis_time_interval]
  query_params[:timeIntervalStart] = opts[:time_interval_start] if opts[:time_interval_start]
  query_params[:timeIntervalEnd] = opts[:time_interval_end] if opts[:time_interval_end]
  query_params[:exadataInsightId] = OCI::ApiClient.build_collection_params(opts[:exadata_insight_id], :multi) if opts[:exadata_insight_id] && !opts[:exadata_insight_id].empty?
  query_params[:exadataType] = OCI::ApiClient.build_collection_params(opts[:exadata_type], :multi) if opts[:exadata_type] && !opts[:exadata_type].empty?
  query_params[:cdbName] = OCI::ApiClient.build_collection_params(opts[:cdb_name], :multi) if opts[:cdb_name] && !opts[:cdb_name].empty?
  query_params[:hostName] = OCI::ApiClient.build_collection_params(opts[:host_name], :multi) if opts[:host_name] && !opts[:host_name].empty?
  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[:definedTagEquals] = OCI::ApiClient.build_collection_params(opts[:defined_tag_equals], :multi) if opts[:defined_tag_equals] && !opts[:defined_tag_equals].empty?
  query_params[:freeformTagEquals] = OCI::ApiClient.build_collection_params(opts[:freeform_tag_equals], :multi) if opts[:freeform_tag_equals] && !opts[:freeform_tag_equals].empty?
  query_params[:definedTagExists] = OCI::ApiClient.build_collection_params(opts[:defined_tag_exists], :multi) if opts[:defined_tag_exists] && !opts[:defined_tag_exists].empty?
  query_params[:freeformTagExists] = OCI::ApiClient.build_collection_params(opts[:freeform_tag_exists], :multi) if opts[:freeform_tag_exists] && !opts[:freeform_tag_exists].empty?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'OperationsInsightsClient#summarize_exadata_insight_resource_capacity_trend_aggregated') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Opsi::Models::SummarizeExadataInsightResourceCapacityTrendAggregation'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#summarize_exadata_insight_resource_forecast_trend(resource_type, resource_metric, exadata_insight_id, opts = {}) ⇒ `Response`

Note:

Click here to see an example of how to use summarize_exadata_insight_resource_forecast_trend API.

Get historical usage and forecast predictions for an exadata system with breakdown by databases, hosts or storage servers. Additionally resources can be filtered using databaseInsightId, hostInsightId or storageServerName query parameters. Top five resources are returned if total exceeds the limit specified. Valid values for ResourceType DATABASE are CPU,MEMORY,IO and STORAGE. Database name is returned in name field. DatabaseInsightId , cdbName and hostName query parameter applies to ResourceType DATABASE. Valid values for ResourceType HOST are CPU and MEMORY. HostName s returned in name field. HostInsightId and hostName query parameter applies to ResourceType HOST. Valid values for ResourceType STORAGE_SERVER are STORAGE, IOPS and THROUGHPUT. Storage server name is returned in name field for resourceMetric IOPS and THROUGHPUT and asmName is returned in name field for resourceMetric STORAGE. StorageServerName query parameter applies to ResourceType STORAGE_SERVER. Valid value for ResourceType DISKGROUP is STORAGE. Comma delimited (asmName,diskgroupName) is returned in name field.

Parameters:

resource_type (String) —

Filter by resource. Supported values are HOST , STORAGE_SERVER and DATABASE
resource_metric (String) —

Filter by resource metric. Supported values are CPU , STORAGE, MEMORY, IO, IOPS, THROUGHPUT
exadata_insight_id (String) —

OCID of exadata insight 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
:analysis_time_interval (String) —

Specify time period in ISO 8601 format with respect to current time. Default is last 30 days represented by P30D. If timeInterval is specified, then timeIntervalStart and timeIntervalEnd will be ignored. Examples P90D (last 90 days), P4W (last 4 weeks), P2M (last 2 months), P1Y (last 12 months), . Maximum value allowed is 25 months prior to current time (P25M). (default to P30D)
:time_interval_start (DateTime) —

Analysis start time in UTC in ISO 8601 format(inclusive). Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). The minimum allowed value is 2 years prior to the current day. timeIntervalStart and timeIntervalEnd parameters are used together. If analysisTimeInterval is specified, this parameter is ignored.
:time_interval_end (DateTime) —

Analysis end time in UTC in ISO 8601 format(exclusive). Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). timeIntervalStart and timeIntervalEnd are used together. If timeIntervalEnd is not specified, current time is used as timeIntervalEnd.
:database_insight_id (Array<String>) —

Optional list of database insight resource OCIDs. (default to [])
:host_insight_id (Array<String>) —

Optional list of host insight resource OCIDs. (default to [])
:storage_server_name (Array<String>) —

Optional storage server name on an exadata system. (default to [])
:exadata_type (Array<String>) —

Filter by one or more Exadata types. Possible value are DBMACHINE, EXACS, and EXACC. (default to [])
:statistic (String) —

Choose the type of statistic metric data to be used for forecasting. (default to AVG) Allowed values are: AVG, MAX
:forecast_start_day (Integer) —

Number of days used for utilization forecast analysis. (default to 0)
:forecast_days (Integer) —

Number of days used for utilization forecast analysis. (default to 30)
:forecast_model (String) —

Choose algorithm model for the forecasting. Possible values: - LINEAR: Uses linear regression algorithm for forecasting. - ML_AUTO: Automatically detects best algorithm to use for forecasting. - ML_NO_AUTO: Automatically detects seasonality of the data for forecasting using linear or seasonal algorithm. (default to ML_NO_AUTO) Allowed values are: LINEAR, ML_AUTO, ML_NO_AUTO
:cdb_name (Array<String>) —

Filter by one or more cdb name. (default to [])
:host_name (Array<String>) —

Filter by hostname. (default to [])
:limit (Integer) —

For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see List Pagination. Example: 50 (default to 5)
:confidence (Integer) —

This parameter is used to change data's confidence level, this data is ingested by the forecast algorithm. Confidence is the probability of an interval to contain the expected population parameter. Manipulation of this value will lead to different results. If not set, default confidence value is 95%. (default to 95)
:sort_order (String) —

The sort order to use, either ascending (ASC) or descending (DESC).
:sort_by (String) —

The order in which resource Forecast trend records are listed (default to name) Allowed values are: id, name, daysToReachCapacity
:page (String) —

For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination.
:opc_request_id (String) —

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:

(Response) —

A Response object with data of type SummarizeExadataInsightResourceForecastTrendCollection

# File 'lib/oci/opsi/operations_insights_client.rb', line 12925

def summarize_exadata_insight_resource_forecast_trend(resource_type, resource_metric, exadata_insight_id, opts = {})
  logger.debug 'Calling operation OperationsInsightsClient#summarize_exadata_insight_resource_forecast_trend.' if logger

  raise "Missing the required parameter 'resource_type' when calling summarize_exadata_insight_resource_forecast_trend." if resource_type.nil?
  raise "Missing the required parameter 'resource_metric' when calling summarize_exadata_insight_resource_forecast_trend." if resource_metric.nil?
  raise "Missing the required parameter 'exadata_insight_id' when calling summarize_exadata_insight_resource_forecast_trend." if exadata_insight_id.nil?

  if opts[:statistic] && !%w[AVG MAX].include?(opts[:statistic])
    raise 'Invalid value for "statistic", must be one of AVG, MAX.'
  end

  if opts[:forecast_model] && !%w[LINEAR ML_AUTO ML_NO_AUTO].include?(opts[:forecast_model])
    raise 'Invalid value for "forecast_model", must be one of LINEAR, ML_AUTO, ML_NO_AUTO.'
  end

  if opts[:sort_order] && !OCI::Opsi::Models::SORT_ORDER_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::Opsi::Models::SORT_ORDER_ENUM.'
  end

  if opts[:sort_by] && !%w[id name daysToReachCapacity].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of id, name, daysToReachCapacity.'
  end

  path = '/exadataInsights/resourceForecastTrend'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:resourceType] = resource_type
  query_params[:resourceMetric] = resource_metric
  query_params[:exadataInsightId] = exadata_insight_id
  query_params[:analysisTimeInterval] = opts[:analysis_time_interval] if opts[:analysis_time_interval]
  query_params[:timeIntervalStart] = opts[:time_interval_start] if opts[:time_interval_start]
  query_params[:timeIntervalEnd] = opts[:time_interval_end] if opts[:time_interval_end]
  query_params[:databaseInsightId] = OCI::ApiClient.build_collection_params(opts[:database_insight_id], :multi) if opts[:database_insight_id] && !opts[:database_insight_id].empty?
  query_params[:hostInsightId] = OCI::ApiClient.build_collection_params(opts[:host_insight_id], :multi) if opts[:host_insight_id] && !opts[:host_insight_id].empty?
  query_params[:storageServerName] = OCI::ApiClient.build_collection_params(opts[:storage_server_name], :multi) if opts[:storage_server_name] && !opts[:storage_server_name].empty?
  query_params[:exadataType] = OCI::ApiClient.build_collection_params(opts[:exadata_type], :multi) if opts[:exadata_type] && !opts[:exadata_type].empty?
  query_params[:statistic] = opts[:statistic] if opts[:statistic]
  query_params[:forecastStartDay] = opts[:forecast_start_day] if opts[:forecast_start_day]
  query_params[:forecastDays] = opts[:forecast_days] if opts[:forecast_days]
  query_params[:forecastModel] = opts[:forecast_model] if opts[:forecast_model]
  query_params[:cdbName] = OCI::ApiClient.build_collection_params(opts[:cdb_name], :multi) if opts[:cdb_name] && !opts[:cdb_name].empty?
  query_params[:hostName] = OCI::ApiClient.build_collection_params(opts[:host_name], :multi) if opts[:host_name] && !opts[:host_name].empty?
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:confidence] = opts[:confidence] if opts[:confidence]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  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: 'OperationsInsightsClient#summarize_exadata_insight_resource_forecast_trend') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Opsi::Models::SummarizeExadataInsightResourceForecastTrendCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#summarize_exadata_insight_resource_forecast_trend_aggregated(resource_type, resource_metric, opts = {}) ⇒ `Response`

Note:

Click here to see an example of how to use summarize_exadata_insight_resource_forecast_trend_aggregated API.

Get aggregated historical usage and forecast predictions for resources. Either compartmentId or exadataInsightsId query parameter must be specified. Valid values for ResourceType DATABASE are CPU,MEMORY,IO and STORAGE. Valid values for ResourceType HOST are CPU and MEMORY. Valid values for ResourceType STORAGE_SERVER are STORAGE, IOPS and THROUGHPUT.

Parameters:

resource_type (String) —

Filter by resource. Supported values are HOST , STORAGE_SERVER and DATABASE
resource_metric (String) —

Filter by resource metric. Supported values are CPU , STORAGE, MEMORY, IO, IOPS, THROUGHPUT
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:retry_config (OCI::Retry::RetryConfig) —

The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry
:compartment_id (String) —

The OCID of the compartment.
:analysis_time_interval (String) —

Specify time period in ISO 8601 format with respect to current time. Default is last 30 days represented by P30D. If timeInterval is specified, then timeIntervalStart and timeIntervalEnd will be ignored. Examples P90D (last 90 days), P4W (last 4 weeks), P2M (last 2 months), P1Y (last 12 months), . Maximum value allowed is 25 months prior to current time (P25M). (default to P30D)
:time_interval_start (DateTime) —

Analysis start time in UTC in ISO 8601 format(inclusive). Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). The minimum allowed value is 2 years prior to the current day. timeIntervalStart and timeIntervalEnd parameters are used together. If analysisTimeInterval is specified, this parameter is ignored.
:time_interval_end (DateTime) —

Analysis end time in UTC in ISO 8601 format(exclusive). Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). timeIntervalStart and timeIntervalEnd are used together. If timeIntervalEnd is not specified, current time is used as timeIntervalEnd.
:exadata_insight_id (Array<String>) —

Optional list of exadata insight resource OCIDs. (default to [])
:exadata_type (Array<String>) —

Filter by one or more Exadata types. Possible value are DBMACHINE, EXACS, and EXACC. (default to [])
:statistic (String) —

Choose the type of statistic metric data to be used for forecasting. (default to AVG) Allowed values are: AVG, MAX
:forecast_start_day (Integer) —

Number of days used for utilization forecast analysis. (default to 0)
:forecast_days (Integer) —

Number of days used for utilization forecast analysis. (default to 30)
:forecast_model (String) —

Choose algorithm model for the forecasting. Possible values: - LINEAR: Uses linear regression algorithm for forecasting. - ML_AUTO: Automatically detects best algorithm to use for forecasting. - ML_NO_AUTO: Automatically detects seasonality of the data for forecasting using linear or seasonal algorithm. (default to ML_NO_AUTO) Allowed values are: LINEAR, ML_AUTO, ML_NO_AUTO
:cdb_name (Array<String>) —

Filter by one or more cdb name. (default to [])
:host_name (Array<String>) —

Filter by hostname. (default to [])
:confidence (Integer) —

This parameter is used to change data's confidence level, this data is ingested by the forecast algorithm. Confidence is the probability of an interval to contain the expected population parameter. Manipulation of this value will lead to different results. If not set, default confidence value is 95%. (default to 95)
:page (String) —

For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination.
:defined_tag_equals (Array<String>) —

A list of tag filters to apply. Only resources with a defined tag matching the value will be returned. Each item in the list has the format "namespace.tagName.value". All inputs are case-insensitive. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as "OR". Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as "AND".
:freeform_tag_equals (Array<String>) —

A list of tag filters to apply. Only resources with a freeform tag matching the value will be returned. The key for each tag is "tagName.value". All inputs are case-insensitive. Multiple values for the same tag name are interpreted as "OR". Values for different tag names are interpreted as "AND".
:defined_tag_exists (Array<String>) —

A list of tag existence filters to apply. Only resources for which the specified defined tags exist will be returned. Each item in the list has the format "namespace.tagName.true" (for checking existence of a defined tag) or "namespace.true". All inputs are case-insensitive. Currently, only existence ("true" at the end) is supported. Absence ("false" at the end) is not supported. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as "OR". Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as "AND".
:freeform_tag_exists (Array<String>) —

A list of tag existence filters to apply. Only resources for which the specified freeform tags exist the value will be returned. The key for each tag is "tagName.true". All inputs are case-insensitive. Currently, only existence ("true" at the end) is supported. Absence ("false" at the end) is not supported. Multiple values for different tag names are interpreted as "AND".
:opc_request_id (String) —

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:

(Response) —

A Response object with data of type SummarizeExadataInsightResourceForecastTrendAggregation

# File 'lib/oci/opsi/operations_insights_client.rb', line 13098

def summarize_exadata_insight_resource_forecast_trend_aggregated(resource_type, resource_metric, opts = {})
  logger.debug 'Calling operation OperationsInsightsClient#summarize_exadata_insight_resource_forecast_trend_aggregated.' if logger

  raise "Missing the required parameter 'resource_type' when calling summarize_exadata_insight_resource_forecast_trend_aggregated." if resource_type.nil?
  raise "Missing the required parameter 'resource_metric' when calling summarize_exadata_insight_resource_forecast_trend_aggregated." if resource_metric.nil?

  if opts[:statistic] && !%w[AVG MAX].include?(opts[:statistic])
    raise 'Invalid value for "statistic", must be one of AVG, MAX.'
  end

  if opts[:forecast_model] && !%w[LINEAR ML_AUTO ML_NO_AUTO].include?(opts[:forecast_model])
    raise 'Invalid value for "forecast_model", must be one of LINEAR, ML_AUTO, ML_NO_AUTO.'
  end

  path = '/exadataInsights/resourceForecastTrendAggregated'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:resourceType] = resource_type
  query_params[:resourceMetric] = resource_metric
  query_params[:compartmentId] = opts[:compartment_id] if opts[:compartment_id]
  query_params[:analysisTimeInterval] = opts[:analysis_time_interval] if opts[:analysis_time_interval]
  query_params[:timeIntervalStart] = opts[:time_interval_start] if opts[:time_interval_start]
  query_params[:timeIntervalEnd] = opts[:time_interval_end] if opts[:time_interval_end]
  query_params[:exadataInsightId] = OCI::ApiClient.build_collection_params(opts[:exadata_insight_id], :multi) if opts[:exadata_insight_id] && !opts[:exadata_insight_id].empty?
  query_params[:exadataType] = OCI::ApiClient.build_collection_params(opts[:exadata_type], :multi) if opts[:exadata_type] && !opts[:exadata_type].empty?
  query_params[:statistic] = opts[:statistic] if opts[:statistic]
  query_params[:forecastStartDay] = opts[:forecast_start_day] if opts[:forecast_start_day]
  query_params[:forecastDays] = opts[:forecast_days] if opts[:forecast_days]
  query_params[:forecastModel] = opts[:forecast_model] if opts[:forecast_model]
  query_params[:cdbName] = OCI::ApiClient.build_collection_params(opts[:cdb_name], :multi) if opts[:cdb_name] && !opts[:cdb_name].empty?
  query_params[:hostName] = OCI::ApiClient.build_collection_params(opts[:host_name], :multi) if opts[:host_name] && !opts[:host_name].empty?
  query_params[:confidence] = opts[:confidence] if opts[:confidence]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:definedTagEquals] = OCI::ApiClient.build_collection_params(opts[:defined_tag_equals], :multi) if opts[:defined_tag_equals] && !opts[:defined_tag_equals].empty?
  query_params[:freeformTagEquals] = OCI::ApiClient.build_collection_params(opts[:freeform_tag_equals], :multi) if opts[:freeform_tag_equals] && !opts[:freeform_tag_equals].empty?
  query_params[:definedTagExists] = OCI::ApiClient.build_collection_params(opts[:defined_tag_exists], :multi) if opts[:defined_tag_exists] && !opts[:defined_tag_exists].empty?
  query_params[:freeformTagExists] = OCI::ApiClient.build_collection_params(opts[:freeform_tag_exists], :multi) if opts[:freeform_tag_exists] && !opts[:freeform_tag_exists].empty?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'OperationsInsightsClient#summarize_exadata_insight_resource_forecast_trend_aggregated') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Opsi::Models::SummarizeExadataInsightResourceForecastTrendAggregation'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#summarize_exadata_insight_resource_statistics(exadata_insight_id, resource_type, resource_metric, opts = {}) ⇒ `Response`

Note:

Click here to see an example of how to use summarize_exadata_insight_resource_statistics API.

Lists the Resource statistics (usage, capacity, usage change percent, utilization percent) for each resource based on resourceMetric filtered by utilization level. Valid values for ResourceType DATABASE are CPU,MEMORY,IO and STORAGE. Valid values for ResourceType HOST are CPU and MEMORY. Valid values for ResourceType STORAGE_SERVER are STORAGE, IOPS, THROUGHPUT. Valid value for ResourceType DISKGROUP is STORAGE.

Allowed values are: utilizationPercent, usage, usageChangePercent

Parameters:

exadata_insight_id (String) —

OCID of exadata insight resource.
resource_type (String) —

Filter by resource. Supported values are HOST , STORAGE_SERVER and DATABASE
resource_metric (String) —

Filter by resource metric. Supported values are CPU , STORAGE, MEMORY, IO, IOPS, THROUGHPUT
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:retry_config (OCI::Retry::RetryConfig) —

The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry
:analysis_time_interval (String) —

Specify time period in ISO 8601 format with respect to current time. Default is last 30 days represented by P30D. If timeInterval is specified, then timeIntervalStart and timeIntervalEnd will be ignored. Examples P90D (last 90 days), P4W (last 4 weeks), P2M (last 2 months), P1Y (last 12 months), . Maximum value allowed is 25 months prior to current time (P25M). (default to P30D)
:time_interval_start (DateTime) —

Analysis start time in UTC in ISO 8601 format(inclusive). Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). The minimum allowed value is 2 years prior to the current day. timeIntervalStart and timeIntervalEnd parameters are used together. If analysisTimeInterval is specified, this parameter is ignored.
:time_interval_end (DateTime) —

Analysis end time in UTC in ISO 8601 format(exclusive). Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). timeIntervalStart and timeIntervalEnd are used together. If timeIntervalEnd is not specified, current time is used as timeIntervalEnd.
:exadata_type (Array<String>) —

Filter by one or more Exadata types. Possible value are DBMACHINE, EXACS, and EXACC. (default to [])
:cdb_name (Array<String>) —

Filter by one or more cdb name. (default to [])
:host_name (Array<String>) —

Filter by hostname. (default to [])
:percentile (Integer) —

Percentile values of daily usage to be used for computing the aggregate resource usage. (default to 90)
:sort_order (String) —

The sort order to use, either ascending (ASC) or descending (DESC).
:sort_by (String) —

The order in which resource statistics records are listed (default to utilizationPercent)
:limit (Integer) —

For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see List Pagination. Example: 50 (default to 50)
:page (String) —

For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination.
:opc_request_id (String) —

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:

(Response) —

A Response object with data of type SummarizeExadataInsightResourceStatisticsAggregationCollection

# File 'lib/oci/opsi/operations_insights_client.rb', line 13234

def summarize_exadata_insight_resource_statistics(exadata_insight_id, resource_type, resource_metric, opts = {})
  logger.debug 'Calling operation OperationsInsightsClient#summarize_exadata_insight_resource_statistics.' if logger

  raise "Missing the required parameter 'exadata_insight_id' when calling summarize_exadata_insight_resource_statistics." if exadata_insight_id.nil?
  raise "Missing the required parameter 'resource_type' when calling summarize_exadata_insight_resource_statistics." if resource_type.nil?
  raise "Missing the required parameter 'resource_metric' when calling summarize_exadata_insight_resource_statistics." if resource_metric.nil?

  if opts[:sort_order] && !OCI::Opsi::Models::SORT_ORDER_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::Opsi::Models::SORT_ORDER_ENUM.'
  end

  if opts[:sort_by] && !%w[utilizationPercent usage usageChangePercent].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of utilizationPercent, usage, usageChangePercent.'
  end

  path = '/exadataInsights/resourceStatistics'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:exadataInsightId] = exadata_insight_id
  query_params[:resourceType] = resource_type
  query_params[:resourceMetric] = resource_metric
  query_params[:analysisTimeInterval] = opts[:analysis_time_interval] if opts[:analysis_time_interval]
  query_params[:timeIntervalStart] = opts[:time_interval_start] if opts[:time_interval_start]
  query_params[:timeIntervalEnd] = opts[:time_interval_end] if opts[:time_interval_end]
  query_params[:exadataType] = OCI::ApiClient.build_collection_params(opts[:exadata_type], :multi) if opts[:exadata_type] && !opts[:exadata_type].empty?
  query_params[:cdbName] = OCI::ApiClient.build_collection_params(opts[:cdb_name], :multi) if opts[:cdb_name] && !opts[:cdb_name].empty?
  query_params[:hostName] = OCI::ApiClient.build_collection_params(opts[:host_name], :multi) if opts[:host_name] && !opts[:host_name].empty?
  query_params[:percentile] = opts[:percentile] if opts[:percentile]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'OperationsInsightsClient#summarize_exadata_insight_resource_statistics') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Opsi::Models::SummarizeExadataInsightResourceStatisticsAggregationCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#summarize_exadata_insight_resource_usage(compartment_id, resource_type, resource_metric, opts = {}) ⇒ `Response`

Note:

Click here to see an example of how to use summarize_exadata_insight_resource_usage API.

A cumulative distribution function is used to rank the usage data points per resource within the specified time period. For each resource, the minimum data point with a ranking > the percentile value is included in the summation. Linear regression functions are used to calculate the usage change percentage. Valid values for ResourceType DATABASE are CPU,MEMORY,IO and STORAGE. Valid values for ResourceType HOST are CPU and MEMORY. Valid values for ResourceType STORAGE_SERVER are STORAGE, IOPS and THROUGHPUT.

Allowed values are: utilizationPercent, usage, capacity, usageChangePercent

Parameters:

compartment_id (String) —

The OCID of the compartment.
resource_type (String) —

Filter by resource. Supported values are HOST , STORAGE_SERVER and DATABASE
resource_metric (String) —

Filter by resource metric. Supported values are CPU , STORAGE, MEMORY, IO, IOPS, THROUGHPUT
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:retry_config (OCI::Retry::RetryConfig) —

The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry
:analysis_time_interval (String) —

Specify time period in ISO 8601 format with respect to current time. Default is last 30 days represented by P30D. If timeInterval is specified, then timeIntervalStart and timeIntervalEnd will be ignored. Examples P90D (last 90 days), P4W (last 4 weeks), P2M (last 2 months), P1Y (last 12 months), . Maximum value allowed is 25 months prior to current time (P25M). (default to P30D)
:time_interval_start (DateTime) —

Analysis start time in UTC in ISO 8601 format(inclusive). Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). The minimum allowed value is 2 years prior to the current day. timeIntervalStart and timeIntervalEnd parameters are used together. If analysisTimeInterval is specified, this parameter is ignored.
:time_interval_end (DateTime) —

Analysis end time in UTC in ISO 8601 format(exclusive). Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). timeIntervalStart and timeIntervalEnd are used together. If timeIntervalEnd is not specified, current time is used as timeIntervalEnd.
:exadata_insight_id (Array<String>) —

Optional list of exadata insight resource OCIDs. (default to [])
:exadata_type (Array<String>) —

Filter by one or more Exadata types. Possible value are DBMACHINE, EXACS, and EXACC. (default to [])
:cdb_name (Array<String>) —

Filter by one or more cdb name. (default to [])
:host_name (Array<String>) —

Filter by hostname. (default to [])
:sort_order (String) —

The sort order to use, either ascending (ASC) or descending (DESC).
:sort_by (String) —

The order in which resource usage summary records are listed (default to utilizationPercent)
:page (String) —

For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination.
:limit (Integer) —

For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see List Pagination. Example: 50 (default to 5)
:percentile (Integer) —

Percentile values of daily usage to be used for computing the aggregate resource usage. (default to 90)
:defined_tag_equals (Array<String>) —

A list of tag filters to apply. Only resources with a defined tag matching the value will be returned. Each item in the list has the format "namespace.tagName.value". All inputs are case-insensitive. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as "OR". Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as "AND".
:freeform_tag_equals (Array<String>) —

A list of tag filters to apply. Only resources with a freeform tag matching the value will be returned. The key for each tag is "tagName.value". All inputs are case-insensitive. Multiple values for the same tag name are interpreted as "OR". Values for different tag names are interpreted as "AND".
:defined_tag_exists (Array<String>) —

A list of tag existence filters to apply. Only resources for which the specified defined tags exist will be returned. Each item in the list has the format "namespace.tagName.true" (for checking existence of a defined tag) or "namespace.true". All inputs are case-insensitive. Currently, only existence ("true" at the end) is supported. Absence ("false" at the end) is not supported. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as "OR". Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as "AND".
:freeform_tag_exists (Array<String>) —

A list of tag existence filters to apply. Only resources for which the specified freeform tags exist the value will be returned. The key for each tag is "tagName.true". All inputs are case-insensitive. Currently, only existence ("true" at the end) is supported. Absence ("false" at the end) is not supported. Multiple values for different tag names are interpreted as "AND".
:opc_request_id (String) —

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:

(Response) —

A Response object with data of type SummarizeExadataInsightResourceUsageCollection

# File 'lib/oci/opsi/operations_insights_client.rb', line 13388

def summarize_exadata_insight_resource_usage(compartment_id, resource_type, resource_metric, opts = {})
  logger.debug 'Calling operation OperationsInsightsClient#summarize_exadata_insight_resource_usage.' if logger

  raise "Missing the required parameter 'compartment_id' when calling summarize_exadata_insight_resource_usage." if compartment_id.nil?
  raise "Missing the required parameter 'resource_type' when calling summarize_exadata_insight_resource_usage." if resource_type.nil?
  raise "Missing the required parameter 'resource_metric' when calling summarize_exadata_insight_resource_usage." if resource_metric.nil?

  if opts[:sort_order] && !OCI::Opsi::Models::SORT_ORDER_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::Opsi::Models::SORT_ORDER_ENUM.'
  end

  if opts[:sort_by] && !%w[utilizationPercent usage capacity usageChangePercent].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of utilizationPercent, usage, capacity, usageChangePercent.'
  end

  path = '/exadataInsights/resourceUsageSummary'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:resourceType] = resource_type
  query_params[:resourceMetric] = resource_metric
  query_params[:analysisTimeInterval] = opts[:analysis_time_interval] if opts[:analysis_time_interval]
  query_params[:timeIntervalStart] = opts[:time_interval_start] if opts[:time_interval_start]
  query_params[:timeIntervalEnd] = opts[:time_interval_end] if opts[:time_interval_end]
  query_params[:exadataInsightId] = OCI::ApiClient.build_collection_params(opts[:exadata_insight_id], :multi) if opts[:exadata_insight_id] && !opts[:exadata_insight_id].empty?
  query_params[:exadataType] = OCI::ApiClient.build_collection_params(opts[:exadata_type], :multi) if opts[:exadata_type] && !opts[:exadata_type].empty?
  query_params[:cdbName] = OCI::ApiClient.build_collection_params(opts[:cdb_name], :multi) if opts[:cdb_name] && !opts[:cdb_name].empty?
  query_params[:hostName] = OCI::ApiClient.build_collection_params(opts[:host_name], :multi) if opts[:host_name] && !opts[:host_name].empty?
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:percentile] = opts[:percentile] if opts[:percentile]
  query_params[:definedTagEquals] = OCI::ApiClient.build_collection_params(opts[:defined_tag_equals], :multi) if opts[:defined_tag_equals] && !opts[:defined_tag_equals].empty?
  query_params[:freeformTagEquals] = OCI::ApiClient.build_collection_params(opts[:freeform_tag_equals], :multi) if opts[:freeform_tag_equals] && !opts[:freeform_tag_equals].empty?
  query_params[:definedTagExists] = OCI::ApiClient.build_collection_params(opts[:defined_tag_exists], :multi) if opts[:defined_tag_exists] && !opts[:defined_tag_exists].empty?
  query_params[:freeformTagExists] = OCI::ApiClient.build_collection_params(opts[:freeform_tag_exists], :multi) if opts[:freeform_tag_exists] && !opts[:freeform_tag_exists].empty?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'OperationsInsightsClient#summarize_exadata_insight_resource_usage') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Opsi::Models::SummarizeExadataInsightResourceUsageCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#summarize_exadata_insight_resource_usage_aggregated(compartment_id, resource_type, resource_metric, opts = {}) ⇒ `Response`

Note:

Click here to see an example of how to use summarize_exadata_insight_resource_usage_aggregated API.

A cumulative distribution function is used to rank the usage data points per database within the specified time period. For each database, the minimum data point with a ranking > the percentile value is included in the summation. Linear regression functions are used to calculate the usage change percentage. Valid values for ResourceType DATABASE are CPU,MEMORY,IO and STORAGE. Valid values for ResourceType HOST are CPU and MEMORY. Valid values for ResourceType STORAGE_SERVER are STORAGE, IOPS and THROUGHPUT.

Parameters:

compartment_id (String) —

The OCID of the compartment.
resource_type (String) —

Filter by resource. Supported values are HOST , STORAGE_SERVER and DATABASE
resource_metric (String) —

Filter by resource metric. Supported values are CPU , STORAGE, MEMORY, IO, IOPS, THROUGHPUT
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:retry_config (OCI::Retry::RetryConfig) —

The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry
:analysis_time_interval (String) —

Specify time period in ISO 8601 format with respect to current time. Default is last 30 days represented by P30D. If timeInterval is specified, then timeIntervalStart and timeIntervalEnd will be ignored. Examples P90D (last 90 days), P4W (last 4 weeks), P2M (last 2 months), P1Y (last 12 months), . Maximum value allowed is 25 months prior to current time (P25M). (default to P30D)
:time_interval_start (DateTime) —

Analysis start time in UTC in ISO 8601 format(inclusive). Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). The minimum allowed value is 2 years prior to the current day. timeIntervalStart and timeIntervalEnd parameters are used together. If analysisTimeInterval is specified, this parameter is ignored.
:time_interval_end (DateTime) —

Analysis end time in UTC in ISO 8601 format(exclusive). Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). timeIntervalStart and timeIntervalEnd are used together. If timeIntervalEnd is not specified, current time is used as timeIntervalEnd.
:exadata_insight_id (Array<String>) —

Optional list of exadata insight resource OCIDs. (default to [])
:exadata_type (Array<String>) —

Filter by one or more Exadata types. Possible value are DBMACHINE, EXACS, and EXACC. (default to [])
:cdb_name (Array<String>) —

Filter by one or more cdb name. (default to [])
:host_name (Array<String>) —

Filter by hostname. (default to [])
:page (String) —

For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination.
:percentile (Integer) —

Percentile values of daily usage to be used for computing the aggregate resource usage. (default to 90)
:defined_tag_equals (Array<String>) —

A list of tag filters to apply. Only resources with a defined tag matching the value will be returned. Each item in the list has the format "namespace.tagName.value". All inputs are case-insensitive. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as "OR". Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as "AND".
:freeform_tag_equals (Array<String>) —

A list of tag filters to apply. Only resources with a freeform tag matching the value will be returned. The key for each tag is "tagName.value". All inputs are case-insensitive. Multiple values for the same tag name are interpreted as "OR". Values for different tag names are interpreted as "AND".
:defined_tag_exists (Array<String>) —

A list of tag existence filters to apply. Only resources for which the specified defined tags exist will be returned. Each item in the list has the format "namespace.tagName.true" (for checking existence of a defined tag) or "namespace.true". All inputs are case-insensitive. Currently, only existence ("true" at the end) is supported. Absence ("false" at the end) is not supported. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as "OR". Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as "AND".
:freeform_tag_exists (Array<String>) —

A list of tag existence filters to apply. Only resources for which the specified freeform tags exist the value will be returned. The key for each tag is "tagName.true". All inputs are case-insensitive. Currently, only existence ("true" at the end) is supported. Absence ("false" at the end) is not supported. Multiple values for different tag names are interpreted as "AND".
:opc_request_id (String) —

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:

(Response) —

A Response object with data of type SummarizeExadataInsightResourceUsageAggregation

# File 'lib/oci/opsi/operations_insights_client.rb', line 13536

def summarize_exadata_insight_resource_usage_aggregated(compartment_id, resource_type, resource_metric, opts = {})
  logger.debug 'Calling operation OperationsInsightsClient#summarize_exadata_insight_resource_usage_aggregated.' if logger

  raise "Missing the required parameter 'compartment_id' when calling summarize_exadata_insight_resource_usage_aggregated." if compartment_id.nil?
  raise "Missing the required parameter 'resource_type' when calling summarize_exadata_insight_resource_usage_aggregated." if resource_type.nil?
  raise "Missing the required parameter 'resource_metric' when calling summarize_exadata_insight_resource_usage_aggregated." if resource_metric.nil?

  path = '/exadataInsights/resourceUsageSummaryAggregated'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:resourceType] = resource_type
  query_params[:resourceMetric] = resource_metric
  query_params[:analysisTimeInterval] = opts[:analysis_time_interval] if opts[:analysis_time_interval]
  query_params[:timeIntervalStart] = opts[:time_interval_start] if opts[:time_interval_start]
  query_params[:timeIntervalEnd] = opts[:time_interval_end] if opts[:time_interval_end]
  query_params[:exadataInsightId] = OCI::ApiClient.build_collection_params(opts[:exadata_insight_id], :multi) if opts[:exadata_insight_id] && !opts[:exadata_insight_id].empty?
  query_params[:exadataType] = OCI::ApiClient.build_collection_params(opts[:exadata_type], :multi) if opts[:exadata_type] && !opts[:exadata_type].empty?
  query_params[:cdbName] = OCI::ApiClient.build_collection_params(opts[:cdb_name], :multi) if opts[:cdb_name] && !opts[:cdb_name].empty?
  query_params[:hostName] = OCI::ApiClient.build_collection_params(opts[:host_name], :multi) if opts[:host_name] && !opts[:host_name].empty?
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:percentile] = opts[:percentile] if opts[:percentile]
  query_params[:definedTagEquals] = OCI::ApiClient.build_collection_params(opts[:defined_tag_equals], :multi) if opts[:defined_tag_equals] && !opts[:defined_tag_equals].empty?
  query_params[:freeformTagEquals] = OCI::ApiClient.build_collection_params(opts[:freeform_tag_equals], :multi) if opts[:freeform_tag_equals] && !opts[:freeform_tag_equals].empty?
  query_params[:definedTagExists] = OCI::ApiClient.build_collection_params(opts[:defined_tag_exists], :multi) if opts[:defined_tag_exists] && !opts[:defined_tag_exists].empty?
  query_params[:freeformTagExists] = OCI::ApiClient.build_collection_params(opts[:freeform_tag_exists], :multi) if opts[:freeform_tag_exists] && !opts[:freeform_tag_exists].empty?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'OperationsInsightsClient#summarize_exadata_insight_resource_usage_aggregated') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Opsi::Models::SummarizeExadataInsightResourceUsageAggregation'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#summarize_exadata_insight_resource_utilization_insight(compartment_id, resource_type, resource_metric, opts = {}) ⇒ `Response`

Note:

Click here to see an example of how to use summarize_exadata_insight_resource_utilization_insight API.

Gets current utilization, projected utilization and days to reach projectedUtilization for an exadata system over specified time period. Valid values for ResourceType DATABASE are CPU,MEMORY,IO and STORAGE. Valid values for ResourceType HOST are CPU and MEMORY. Valid values for ResourceType STORAGE_SERVER are STORAGE, IOPS and THROUGHPUT.

Parameters:

compartment_id (String) —

The OCID of the compartment.
resource_type (String) —

Filter by resource. Supported values are HOST , STORAGE_SERVER and DATABASE
resource_metric (String) —

Filter by resource metric. Supported values are CPU , STORAGE, MEMORY, IO, IOPS, THROUGHPUT
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:retry_config (OCI::Retry::RetryConfig) —

The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry
:analysis_time_interval (String) —

Specify time period in ISO 8601 format with respect to current time. Default is last 30 days represented by P30D. If timeInterval is specified, then timeIntervalStart and timeIntervalEnd will be ignored. Examples P90D (last 90 days), P4W (last 4 weeks), P2M (last 2 months), P1Y (last 12 months), . Maximum value allowed is 25 months prior to current time (P25M). (default to P30D)
:time_interval_start (DateTime) —

Analysis start time in UTC in ISO 8601 format(inclusive). Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). The minimum allowed value is 2 years prior to the current day. timeIntervalStart and timeIntervalEnd parameters are used together. If analysisTimeInterval is specified, this parameter is ignored.
:time_interval_end (DateTime) —

Analysis end time in UTC in ISO 8601 format(exclusive). Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). timeIntervalStart and timeIntervalEnd are used together. If timeIntervalEnd is not specified, current time is used as timeIntervalEnd.
:exadata_insight_id (Array<String>) —

Optional list of exadata insight resource OCIDs. (default to [])
:exadata_type (Array<String>) —

Filter by one or more Exadata types. Possible value are DBMACHINE, EXACS, and EXACC. (default to [])
:forecast_start_day (Integer) —

Number of days used for utilization forecast analysis. (default to 0)
:forecast_days (Integer) —

Number of days used for utilization forecast analysis. (default to 30)
:cdb_name (Array<String>) —

Filter by one or more cdb name. (default to [])
:host_name (Array<String>) —

Filter by hostname. (default to [])
:limit (Integer) —

For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see List Pagination. Example: 50 (default to 5)
:page (String) —

For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination.
:defined_tag_equals (Array<String>) —

A list of tag filters to apply. Only resources with a defined tag matching the value will be returned. Each item in the list has the format "namespace.tagName.value". All inputs are case-insensitive. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as "OR". Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as "AND".
:freeform_tag_equals (Array<String>) —

A list of tag filters to apply. Only resources with a freeform tag matching the value will be returned. The key for each tag is "tagName.value". All inputs are case-insensitive. Multiple values for the same tag name are interpreted as "OR". Values for different tag names are interpreted as "AND".
:defined_tag_exists (Array<String>) —

A list of tag existence filters to apply. Only resources for which the specified defined tags exist will be returned. Each item in the list has the format "namespace.tagName.true" (for checking existence of a defined tag) or "namespace.true". All inputs are case-insensitive. Currently, only existence ("true" at the end) is supported. Absence ("false" at the end) is not supported. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as "OR". Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as "AND".
:freeform_tag_exists (Array<String>) —

A list of tag existence filters to apply. Only resources for which the specified freeform tags exist the value will be returned. The key for each tag is "tagName.true". All inputs are case-insensitive. Currently, only existence ("true" at the end) is supported. Absence ("false" at the end) is not supported. Multiple values for different tag names are interpreted as "AND".
:opc_request_id (String) —

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:

(Response) —

A Response object with data of type SummarizeExadataInsightResourceUtilizationInsightAggregation

# File 'lib/oci/opsi/operations_insights_client.rb', line 13675

def summarize_exadata_insight_resource_utilization_insight(compartment_id, resource_type, resource_metric, opts = {})
  logger.debug 'Calling operation OperationsInsightsClient#summarize_exadata_insight_resource_utilization_insight.' if logger

  raise "Missing the required parameter 'compartment_id' when calling summarize_exadata_insight_resource_utilization_insight." if compartment_id.nil?
  raise "Missing the required parameter 'resource_type' when calling summarize_exadata_insight_resource_utilization_insight." if resource_type.nil?
  raise "Missing the required parameter 'resource_metric' when calling summarize_exadata_insight_resource_utilization_insight." if resource_metric.nil?

  path = '/exadataInsights/resourceUtilizationInsight'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:resourceType] = resource_type
  query_params[:resourceMetric] = resource_metric
  query_params[:analysisTimeInterval] = opts[:analysis_time_interval] if opts[:analysis_time_interval]
  query_params[:timeIntervalStart] = opts[:time_interval_start] if opts[:time_interval_start]
  query_params[:timeIntervalEnd] = opts[:time_interval_end] if opts[:time_interval_end]
  query_params[:exadataInsightId] = OCI::ApiClient.build_collection_params(opts[:exadata_insight_id], :multi) if opts[:exadata_insight_id] && !opts[:exadata_insight_id].empty?
  query_params[:exadataType] = OCI::ApiClient.build_collection_params(opts[:exadata_type], :multi) if opts[:exadata_type] && !opts[:exadata_type].empty?
  query_params[:forecastStartDay] = opts[:forecast_start_day] if opts[:forecast_start_day]
  query_params[:forecastDays] = opts[:forecast_days] if opts[:forecast_days]
  query_params[:cdbName] = OCI::ApiClient.build_collection_params(opts[:cdb_name], :multi) if opts[:cdb_name] && !opts[:cdb_name].empty?
  query_params[:hostName] = OCI::ApiClient.build_collection_params(opts[:host_name], :multi) if opts[:host_name] && !opts[:host_name].empty?
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:definedTagEquals] = OCI::ApiClient.build_collection_params(opts[:defined_tag_equals], :multi) if opts[:defined_tag_equals] && !opts[:defined_tag_equals].empty?
  query_params[:freeformTagEquals] = OCI::ApiClient.build_collection_params(opts[:freeform_tag_equals], :multi) if opts[:freeform_tag_equals] && !opts[:freeform_tag_equals].empty?
  query_params[:definedTagExists] = OCI::ApiClient.build_collection_params(opts[:defined_tag_exists], :multi) if opts[:defined_tag_exists] && !opts[:defined_tag_exists].empty?
  query_params[:freeformTagExists] = OCI::ApiClient.build_collection_params(opts[:freeform_tag_exists], :multi) if opts[:freeform_tag_exists] && !opts[:freeform_tag_exists].empty?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'OperationsInsightsClient#summarize_exadata_insight_resource_utilization_insight') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Opsi::Models::SummarizeExadataInsightResourceUtilizationInsightAggregation'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#summarize_exadata_members(exadata_insight_id, opts = {}) ⇒ `Response`

Note:

Click here to see an example of how to use summarize_exadata_members API.

Lists the software and hardware inventory of the Exadata System.

Parameters:

exadata_insight_id (String) —

OCID of exadata insight 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
:exadata_type (Array<String>) —

Filter by one or more Exadata types. Possible value are DBMACHINE, EXACS, and EXACC. (default to [])
:sort_order (String) —

The sort order to use, either ascending (ASC) or descending (DESC).
:sort_by (String) —

The order in which exadata member records are listed (default to name) Allowed values are: name, displayName, entityType
:limit (Integer) —

For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see List Pagination. Example: 50 (default to 500)
:page (String) —

For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination.
:opc_request_id (String) —

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:

(Response) —

A Response object with data of type ExadataMemberCollection

# File 'lib/oci/opsi/operations_insights_client.rb', line 13768

def summarize_exadata_members(exadata_insight_id, opts = {})
  logger.debug 'Calling operation OperationsInsightsClient#summarize_exadata_members.' if logger

  raise "Missing the required parameter 'exadata_insight_id' when calling summarize_exadata_members." if exadata_insight_id.nil?

  if opts[:sort_order] && !OCI::Opsi::Models::SORT_ORDER_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::Opsi::Models::SORT_ORDER_ENUM.'
  end

  if opts[:sort_by] && !%w[name displayName entityType].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of name, displayName, entityType.'
  end

  path = '/exadataInsights/exadataMembers'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:exadataInsightId] = exadata_insight_id
  query_params[:exadataType] = OCI::ApiClient.build_collection_params(opts[:exadata_type], :multi) if opts[:exadata_type] && !opts[:exadata_type].empty?
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'OperationsInsightsClient#summarize_exadata_members') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Opsi::Models::ExadataMemberCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#summarize_host_insight_disk_statistics(compartment_id, id, opts = {}) ⇒ `Response`

Note:

Click here to see an example of how to use summarize_host_insight_disk_statistics API.

Returns response with disk(s) statistics for a host.

Parameters:

compartment_id (String) —

The OCID of the compartment.
id (String) —

Required OCID of the host insight 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
:analysis_time_interval (String) —

Specify time period in ISO 8601 format with respect to current time. Default is last 30 days represented by P30D. If timeInterval is specified, then timeIntervalStart and timeIntervalEnd will be ignored. Examples P90D (last 90 days), P4W (last 4 weeks), P2M (last 2 months), P1Y (last 12 months), . Maximum value allowed is 25 months prior to current time (P25M). (default to P30D)
:time_interval_start (DateTime) —

Analysis start time in UTC in ISO 8601 format(inclusive). Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). The minimum allowed value is 2 years prior to the current day. timeIntervalStart and timeIntervalEnd parameters are used together. If analysisTimeInterval is specified, this parameter is ignored.
:time_interval_end (DateTime) —

Analysis end time in UTC in ISO 8601 format(exclusive). Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). timeIntervalStart and timeIntervalEnd are used together. If timeIntervalEnd is not specified, current time is used as timeIntervalEnd.
:host_id (String) —

Optional OCID of the host (Compute Id)
:statistic (String) —

Choose the type of statistic metric data to be used for forecasting. (default to AVG) Allowed values are: AVG, MAX
:opc_request_id (String) —

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:

(Response) —

A Response object with data of type SummarizeHostInsightsDiskStatisticsCollection

# File 'lib/oci/opsi/operations_insights_client.rb', line 13860

def summarize_host_insight_disk_statistics(compartment_id, id, opts = {})
  logger.debug 'Calling operation OperationsInsightsClient#summarize_host_insight_disk_statistics.' if logger

  raise "Missing the required parameter 'compartment_id' when calling summarize_host_insight_disk_statistics." if compartment_id.nil?
  raise "Missing the required parameter 'id' when calling summarize_host_insight_disk_statistics." if id.nil?

  if opts[:statistic] && !%w[AVG MAX].include?(opts[:statistic])
    raise 'Invalid value for "statistic", must be one of AVG, MAX.'
  end

  path = '/hostInsights/diskStatistics'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:id] = id
  query_params[:analysisTimeInterval] = opts[:analysis_time_interval] if opts[:analysis_time_interval]
  query_params[:timeIntervalStart] = opts[:time_interval_start] if opts[:time_interval_start]
  query_params[:timeIntervalEnd] = opts[:time_interval_end] if opts[:time_interval_end]
  query_params[:hostId] = opts[:host_id] if opts[:host_id]
  query_params[:statistic] = opts[:statistic] if opts[:statistic]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'OperationsInsightsClient#summarize_host_insight_disk_statistics') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Opsi::Models::SummarizeHostInsightsDiskStatisticsCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#summarize_host_insight_host_recommendation(compartment_id, id, resource_metric, opts = {}) ⇒ `Response`

Note:

Click here to see an example of how to use summarize_host_insight_host_recommendation API.

Returns response with some recommendations if apply for a host.

Parameters:

compartment_id (String) —

The OCID of the compartment.
id (String) —

Required OCID of the host insight resource.
resource_metric (String) —

Filter by host resource metric. Supported values are CPU, MEMORY, LOGICAL_MEMORY, STORAGE and NETWORK.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:retry_config (OCI::Retry::RetryConfig) —

The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry
:analysis_time_interval (String) —

Specify time period in ISO 8601 format with respect to current time. Default is last 30 days represented by P30D. If timeInterval is specified, then timeIntervalStart and timeIntervalEnd will be ignored. Examples P90D (last 90 days), P4W (last 4 weeks), P2M (last 2 months), P1Y (last 12 months), . Maximum value allowed is 25 months prior to current time (P25M). (default to P30D)
:time_interval_start (DateTime) —

Analysis start time in UTC in ISO 8601 format(inclusive). Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). The minimum allowed value is 2 years prior to the current day. timeIntervalStart and timeIntervalEnd parameters are used together. If analysisTimeInterval is specified, this parameter is ignored.
:time_interval_end (DateTime) —

Analysis end time in UTC in ISO 8601 format(exclusive). Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). timeIntervalStart and timeIntervalEnd are used together. If timeIntervalEnd is not specified, current time is used as timeIntervalEnd.
:host_id (String) —

Optional OCID of the host (Compute Id)
:limit (Integer) —

For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see List Pagination. Example: 50 (default to 50)
:statistic (String) —

Choose the type of statistic metric data to be used for forecasting. (default to AVG) Allowed values are: AVG, MAX
:opc_request_id (String) —

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:

(Response) —

A Response object with data of type SummarizeHostInsightHostRecommendationAggregation

# File 'lib/oci/opsi/operations_insights_client.rb', line 13959

def summarize_host_insight_host_recommendation(compartment_id, id, resource_metric, opts = {})
  logger.debug 'Calling operation OperationsInsightsClient#summarize_host_insight_host_recommendation.' if logger

  raise "Missing the required parameter 'compartment_id' when calling summarize_host_insight_host_recommendation." if compartment_id.nil?
  raise "Missing the required parameter 'id' when calling summarize_host_insight_host_recommendation." if id.nil?
  raise "Missing the required parameter 'resource_metric' when calling summarize_host_insight_host_recommendation." if resource_metric.nil?

  if opts[:statistic] && !%w[AVG MAX].include?(opts[:statistic])
    raise 'Invalid value for "statistic", must be one of AVG, MAX.'
  end

  path = '/hostInsights/hostRecommendation'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:id] = id
  query_params[:resourceMetric] = resource_metric
  query_params[:analysisTimeInterval] = opts[:analysis_time_interval] if opts[:analysis_time_interval]
  query_params[:timeIntervalStart] = opts[:time_interval_start] if opts[:time_interval_start]
  query_params[:timeIntervalEnd] = opts[:time_interval_end] if opts[:time_interval_end]
  query_params[:hostId] = opts[:host_id] if opts[:host_id]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:statistic] = opts[:statistic] if opts[:statistic]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'OperationsInsightsClient#summarize_host_insight_host_recommendation') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Opsi::Models::SummarizeHostInsightHostRecommendationAggregation'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#summarize_host_insight_network_usage_trend(compartment_id, id, opts = {}) ⇒ `Response`

Note:

Click here to see an example of how to use summarize_host_insight_network_usage_trend API.

Returns response with usage time series data with breakdown by network interface for the time period specified.

Parameters:

compartment_id (String) —

The OCID of the compartment.
id (String) —

Required OCID of the host insight 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
:analysis_time_interval (String) —

Specify time period in ISO 8601 format with respect to current time. Default is last 30 days represented by P30D. If timeInterval is specified, then timeIntervalStart and timeIntervalEnd will be ignored. Examples P90D (last 90 days), P4W (last 4 weeks), P2M (last 2 months), P1Y (last 12 months), . Maximum value allowed is 25 months prior to current time (P25M). (default to P30D)
:time_interval_start (DateTime) —

Analysis start time in UTC in ISO 8601 format(inclusive). Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). The minimum allowed value is 2 years prior to the current day. timeIntervalStart and timeIntervalEnd parameters are used together. If analysisTimeInterval is specified, this parameter is ignored.
:time_interval_end (DateTime) —

Analysis end time in UTC in ISO 8601 format(exclusive). Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). timeIntervalStart and timeIntervalEnd are used together. If timeIntervalEnd is not specified, current time is used as timeIntervalEnd.
:host_id (String) —

Optional OCID of the host (Compute Id)
:page (String) —

For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination.
:limit (Integer) —

For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see List Pagination. Example: 50 (default to 50)
:statistic (String) —

Choose the type of statistic metric data to be used for forecasting. (default to AVG) Allowed values are: AVG, MAX
:opc_request_id (String) —

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:

(Response) —

A Response object with data of type SummarizeHostInsightNetworkUsageTrendAggregationCollection

# File 'lib/oci/opsi/operations_insights_client.rb', line 14062

def summarize_host_insight_network_usage_trend(compartment_id, id, opts = {})
  logger.debug 'Calling operation OperationsInsightsClient#summarize_host_insight_network_usage_trend.' if logger

  raise "Missing the required parameter 'compartment_id' when calling summarize_host_insight_network_usage_trend." if compartment_id.nil?
  raise "Missing the required parameter 'id' when calling summarize_host_insight_network_usage_trend." if id.nil?

  if opts[:statistic] && !%w[AVG MAX].include?(opts[:statistic])
    raise 'Invalid value for "statistic", must be one of AVG, MAX.'
  end

  path = '/hostInsights/networkUsageTrend'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:id] = id
  query_params[:analysisTimeInterval] = opts[:analysis_time_interval] if opts[:analysis_time_interval]
  query_params[:timeIntervalStart] = opts[:time_interval_start] if opts[:time_interval_start]
  query_params[:timeIntervalEnd] = opts[:time_interval_end] if opts[:time_interval_end]
  query_params[:hostId] = opts[:host_id] if opts[:host_id]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:statistic] = opts[:statistic] if opts[:statistic]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'OperationsInsightsClient#summarize_host_insight_network_usage_trend') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Opsi::Models::SummarizeHostInsightNetworkUsageTrendAggregationCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#summarize_host_insight_resource_capacity_trend(compartment_id, resource_metric, opts = {}) ⇒ `Response`

Note:

Click here to see an example of how to use summarize_host_insight_resource_capacity_trend API.

Returns response with time series data (endTimestamp, capacity) for the time period specified. The maximum time range for analysis is 2 years, hence this is intentionally not paginated. If compartmentIdInSubtree is specified, aggregates resources in a compartment and in all sub-compartments.

Allowed values are: HIGH_UTILIZATION, LOW_UTILIZATION, MEDIUM_HIGH_UTILIZATION, MEDIUM_LOW_UTILIZATION Allowed values are: endTimestamp, capacity

Parameters:

compartment_id (String) —

The OCID of the compartment.
resource_metric (String) —

Filter by host resource metric. Supported values are CPU, MEMORY, LOGICAL_MEMORY, STORAGE and NETWORK.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:retry_config (OCI::Retry::RetryConfig) —

The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry
:analysis_time_interval (String) —

Specify time period in ISO 8601 format with respect to current time. Default is last 30 days represented by P30D. If timeInterval is specified, then timeIntervalStart and timeIntervalEnd will be ignored. Examples P90D (last 90 days), P4W (last 4 weeks), P2M (last 2 months), P1Y (last 12 months), . Maximum value allowed is 25 months prior to current time (P25M). (default to P30D)
:time_interval_start (DateTime) —

Analysis start time in UTC in ISO 8601 format(inclusive). Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). The minimum allowed value is 2 years prior to the current day. timeIntervalStart and timeIntervalEnd parameters are used together. If analysisTimeInterval is specified, this parameter is ignored.
:time_interval_end (DateTime) —

Analysis end time in UTC in ISO 8601 format(exclusive). Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). timeIntervalStart and timeIntervalEnd are used together. If timeIntervalEnd is not specified, current time is used as timeIntervalEnd.
:platform_type (Array<String>) —

Filter by one or more platform types. Supported platformType(s) for MACS-managed external host insight: [LINUX, SOLARIS, WINDOWS]. Supported platformType(s) for MACS-managed cloud host insight: [LINUX]. Supported platformType(s) for EM-managed external host insight: [LINUX, SOLARIS, SUNOS, ZLINUX, WINDOWS, AIX, HP-UX]. (default to []) Allowed values are: LINUX, SOLARIS, SUNOS, ZLINUX, WINDOWS, AIX, HP_UX
:id (Array<String>) —

Optional list of host insight resource OCIDs. (default to [])
:exadata_insight_id (Array<String>) —

Optional list of exadata insight resource OCIDs. (default to [])
:utilization_level (String) —

Filter by utilization level by the following buckets: - HIGH_UTILIZATION: DBs with utilization greater or equal than 75. - LOW_UTILIZATION: DBs with utilization lower than 25. - MEDIUM_HIGH_UTILIZATION: DBs with utilization greater or equal than 50 but lower than 75. - MEDIUM_LOW_UTILIZATION: DBs with utilization greater or equal than 25 but lower than 50.
:page (String) —

For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination.
:sort_order (String) —

The sort order to use, either ascending (ASC) or descending (DESC).
:sort_by (String) —

Sorts using end timestamp or capacity (default to endTimestamp)
:opc_request_id (String) —

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
:defined_tag_equals (Array<String>) —

A list of tag filters to apply. Only resources with a defined tag matching the value will be returned. Each item in the list has the format "namespace.tagName.value". All inputs are case-insensitive. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as "OR". Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as "AND".
:freeform_tag_equals (Array<String>) —

A list of tag filters to apply. Only resources with a freeform tag matching the value will be returned. The key for each tag is "tagName.value". All inputs are case-insensitive. Multiple values for the same tag name are interpreted as "OR". Values for different tag names are interpreted as "AND".
:defined_tag_exists (Array<String>) —

A list of tag existence filters to apply. Only resources for which the specified defined tags exist will be returned. Each item in the list has the format "namespace.tagName.true" (for checking existence of a defined tag) or "namespace.true". All inputs are case-insensitive. Currently, only existence ("true" at the end) is supported. Absence ("false" at the end) is not supported. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as "OR". Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as "AND".
:freeform_tag_exists (Array<String>) —

A list of tag existence filters to apply. Only resources for which the specified freeform tags exist the value will be returned. The key for each tag is "tagName.true". All inputs are case-insensitive. Currently, only existence ("true" at the end) is supported. Absence ("false" at the end) is not supported. Multiple values for different tag names are interpreted as "AND".
:compartment_id_in_subtree (BOOLEAN) —

A flag to search all resources within a given compartment and all sub-compartments. (default to false)
:host_type (Array<String>) —

Filter by one or more host types. Possible values are CLOUD-HOST, EXTERNAL-HOST, COMANAGED-VM-HOST, COMANAGED-BM-HOST, COMANAGED-EXACS-HOST (default to [])
:host_id (String) —

Optional OCID of the host (Compute Id)
:vmcluster_name (Array<String>) —

Optional list of Exadata Insight VM cluster name. (default to [])
:high_utilization_threshold (Integer) —

Percent value in which a resource metric is considered highly utilized. (default to 75)
:low_utilization_threshold (Integer) —

Percent value in which a resource metric is considered low utilized. (default to 25)

Returns:

(Response) —

A Response object with data of type SummarizeHostInsightResourceCapacityTrendAggregationCollection

# File 'lib/oci/opsi/operations_insights_client.rb', line 14211

def summarize_host_insight_resource_capacity_trend(compartment_id, resource_metric, opts = {})
  logger.debug 'Calling operation OperationsInsightsClient#summarize_host_insight_resource_capacity_trend.' if logger

  raise "Missing the required parameter 'compartment_id' when calling summarize_host_insight_resource_capacity_trend." if compartment_id.nil?
  raise "Missing the required parameter 'resource_metric' when calling summarize_host_insight_resource_capacity_trend." if resource_metric.nil?


  platform_type_allowable_values = %w[LINUX SOLARIS SUNOS ZLINUX WINDOWS AIX HP_UX]
  if opts[:platform_type] && !opts[:platform_type].empty?
    opts[:platform_type].each do |val_to_check|
      unless platform_type_allowable_values.include?(val_to_check)
        raise 'Invalid value for "platform_type", must be one of LINUX, SOLARIS, SUNOS, ZLINUX, WINDOWS, AIX, HP_UX.'
      end
    end
  end

  if opts[:utilization_level] && !%w[HIGH_UTILIZATION LOW_UTILIZATION MEDIUM_HIGH_UTILIZATION MEDIUM_LOW_UTILIZATION].include?(opts[:utilization_level])
    raise 'Invalid value for "utilization_level", must be one of HIGH_UTILIZATION, LOW_UTILIZATION, MEDIUM_HIGH_UTILIZATION, MEDIUM_LOW_UTILIZATION.'
  end

  if opts[:sort_order] && !OCI::Opsi::Models::SORT_ORDER_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::Opsi::Models::SORT_ORDER_ENUM.'
  end

  if opts[:sort_by] && !%w[endTimestamp capacity].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of endTimestamp, capacity.'
  end

  path = '/hostInsights/resourceCapacityTrend'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:resourceMetric] = resource_metric
  query_params[:analysisTimeInterval] = opts[:analysis_time_interval] if opts[:analysis_time_interval]
  query_params[:timeIntervalStart] = opts[:time_interval_start] if opts[:time_interval_start]
  query_params[:timeIntervalEnd] = opts[:time_interval_end] if opts[:time_interval_end]
  query_params[:platformType] = OCI::ApiClient.build_collection_params(opts[:platform_type], :multi) if opts[:platform_type] && !opts[:platform_type].empty?
  query_params[:id] = OCI::ApiClient.build_collection_params(opts[:id], :multi) if opts[:id] && !opts[:id].empty?
  query_params[:exadataInsightId] = OCI::ApiClient.build_collection_params(opts[:exadata_insight_id], :multi) if opts[:exadata_insight_id] && !opts[:exadata_insight_id].empty?
  query_params[:utilizationLevel] = opts[:utilization_level] if opts[:utilization_level]
  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[:definedTagEquals] = OCI::ApiClient.build_collection_params(opts[:defined_tag_equals], :multi) if opts[:defined_tag_equals] && !opts[:defined_tag_equals].empty?
  query_params[:freeformTagEquals] = OCI::ApiClient.build_collection_params(opts[:freeform_tag_equals], :multi) if opts[:freeform_tag_equals] && !opts[:freeform_tag_equals].empty?
  query_params[:definedTagExists] = OCI::ApiClient.build_collection_params(opts[:defined_tag_exists], :multi) if opts[:defined_tag_exists] && !opts[:defined_tag_exists].empty?
  query_params[:freeformTagExists] = OCI::ApiClient.build_collection_params(opts[:freeform_tag_exists], :multi) if opts[:freeform_tag_exists] && !opts[:freeform_tag_exists].empty?
  query_params[:compartmentIdInSubtree] = opts[:compartment_id_in_subtree] if !opts[:compartment_id_in_subtree].nil?
  query_params[:hostType] = OCI::ApiClient.build_collection_params(opts[:host_type], :multi) if opts[:host_type] && !opts[:host_type].empty?
  query_params[:hostId] = opts[:host_id] if opts[:host_id]
  query_params[:vmclusterName] = OCI::ApiClient.build_collection_params(opts[:vmcluster_name], :multi) if opts[:vmcluster_name] && !opts[:vmcluster_name].empty?
  query_params[:highUtilizationThreshold] = opts[:high_utilization_threshold] if opts[:high_utilization_threshold]
  query_params[:lowUtilizationThreshold] = opts[:low_utilization_threshold] if opts[:low_utilization_threshold]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'OperationsInsightsClient#summarize_host_insight_resource_capacity_trend') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Opsi::Models::SummarizeHostInsightResourceCapacityTrendAggregationCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#summarize_host_insight_resource_forecast_trend(compartment_id, resource_metric, opts = {}) ⇒ `Response`

Note:

Click here to see an example of how to use summarize_host_insight_resource_forecast_trend API.

Get Forecast predictions for CPU or memory resources since a time in the past. If compartmentIdInSubtree is specified, aggregates resources in a compartment and in all sub-compartments.

Allowed values are: HIGH_UTILIZATION, LOW_UTILIZATION, MEDIUM_HIGH_UTILIZATION, MEDIUM_LOW_UTILIZATION

Parameters:

compartment_id (String) —

The OCID of the compartment.
resource_metric (String) —

Filter by host resource metric. Supported values are CPU, MEMORY, LOGICAL_MEMORY, STORAGE and NETWORK.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:retry_config (OCI::Retry::RetryConfig) —

The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry
:analysis_time_interval (String) —

Specify time period in ISO 8601 format with respect to current time. Default is last 30 days represented by P30D. If timeInterval is specified, then timeIntervalStart and timeIntervalEnd will be ignored. Examples P90D (last 90 days), P4W (last 4 weeks), P2M (last 2 months), P1Y (last 12 months), . Maximum value allowed is 25 months prior to current time (P25M). (default to P30D)
:time_interval_start (DateTime) —

Analysis start time in UTC in ISO 8601 format(inclusive). Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). The minimum allowed value is 2 years prior to the current day. timeIntervalStart and timeIntervalEnd parameters are used together. If analysisTimeInterval is specified, this parameter is ignored.
:time_interval_end (DateTime) —

Analysis end time in UTC in ISO 8601 format(exclusive). Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). timeIntervalStart and timeIntervalEnd are used together. If timeIntervalEnd is not specified, current time is used as timeIntervalEnd.
:platform_type (Array<String>) —

Filter by one or more platform types. Supported platformType(s) for MACS-managed external host insight: [LINUX, SOLARIS, WINDOWS]. Supported platformType(s) for MACS-managed cloud host insight: [LINUX]. Supported platformType(s) for EM-managed external host insight: [LINUX, SOLARIS, SUNOS, ZLINUX, WINDOWS, AIX, HP-UX]. (default to []) Allowed values are: LINUX, SOLARIS, SUNOS, ZLINUX, WINDOWS, AIX, HP_UX
:id (Array<String>) —

Optional list of host insight resource OCIDs. (default to [])
:exadata_insight_id (Array<String>) —

Optional list of exadata insight resource OCIDs. (default to [])
:statistic (String) —

Choose the type of statistic metric data to be used for forecasting. (default to AVG) Allowed values are: AVG, MAX
:forecast_days (Integer) —

Number of days used for utilization forecast analysis. (default to 30)
:forecast_model (String) —

Choose algorithm model for the forecasting. Possible values: - LINEAR: Uses linear regression algorithm for forecasting. - ML_AUTO: Automatically detects best algorithm to use for forecasting. - ML_NO_AUTO: Automatically detects seasonality of the data for forecasting using linear or seasonal algorithm. (default to ML_NO_AUTO) Allowed values are: LINEAR, ML_AUTO, ML_NO_AUTO
:utilization_level (String) —

Filter by utilization level by the following buckets: - HIGH_UTILIZATION: DBs with utilization greater or equal than 75. - LOW_UTILIZATION: DBs with utilization lower than 25. - MEDIUM_HIGH_UTILIZATION: DBs with utilization greater or equal than 50 but lower than 75. - MEDIUM_LOW_UTILIZATION: DBs with utilization greater or equal than 25 but lower than 50.
:confidence (Integer) —

This parameter is used to change data's confidence level, this data is ingested by the forecast algorithm. Confidence is the probability of an interval to contain the expected population parameter. Manipulation of this value will lead to different results. If not set, default confidence value is 95%. (default to 95)
:page (String) —

For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination.
:opc_request_id (String) —

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
:defined_tag_equals (Array<String>) —

A list of tag filters to apply. Only resources with a defined tag matching the value will be returned. Each item in the list has the format "namespace.tagName.value". All inputs are case-insensitive. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as "OR". Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as "AND".
:freeform_tag_equals (Array<String>) —

A list of tag filters to apply. Only resources with a freeform tag matching the value will be returned. The key for each tag is "tagName.value". All inputs are case-insensitive. Multiple values for the same tag name are interpreted as "OR". Values for different tag names are interpreted as "AND".
:defined_tag_exists (Array<String>) —

A list of tag existence filters to apply. Only resources for which the specified defined tags exist will be returned. Each item in the list has the format "namespace.tagName.true" (for checking existence of a defined tag) or "namespace.true". All inputs are case-insensitive. Currently, only existence ("true" at the end) is supported. Absence ("false" at the end) is not supported. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as "OR". Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as "AND".
:freeform_tag_exists (Array<String>) —

A list of tag existence filters to apply. Only resources for which the specified freeform tags exist the value will be returned. The key for each tag is "tagName.true". All inputs are case-insensitive. Currently, only existence ("true" at the end) is supported. Absence ("false" at the end) is not supported. Multiple values for different tag names are interpreted as "AND".
:compartment_id_in_subtree (BOOLEAN) —

A flag to search all resources within a given compartment and all sub-compartments. (default to false)
:host_type (Array<String>) —

Filter by one or more host types. Possible values are CLOUD-HOST, EXTERNAL-HOST, COMANAGED-VM-HOST, COMANAGED-BM-HOST, COMANAGED-EXACS-HOST (default to [])
:host_id (String) —

Optional OCID of the host (Compute Id)
:vmcluster_name (Array<String>) —

Optional list of Exadata Insight VM cluster name. (default to [])
:high_utilization_threshold (Integer) —

Percent value in which a resource metric is considered highly utilized. (default to 75)
:low_utilization_threshold (Integer) —

Percent value in which a resource metric is considered low utilized. (default to 25)
:mount_point (String) —

Mount points are specialized NTFS filesystem objects.
:interface_name (String) —

Name of the network interface.

Returns:

(Response) —

A Response object with data of type SummarizeHostInsightResourceForecastTrendAggregation

# File 'lib/oci/opsi/operations_insights_client.rb', line 14406

def summarize_host_insight_resource_forecast_trend(compartment_id, resource_metric, opts = {})
  logger.debug 'Calling operation OperationsInsightsClient#summarize_host_insight_resource_forecast_trend.' if logger

  raise "Missing the required parameter 'compartment_id' when calling summarize_host_insight_resource_forecast_trend." if compartment_id.nil?
  raise "Missing the required parameter 'resource_metric' when calling summarize_host_insight_resource_forecast_trend." if resource_metric.nil?


  platform_type_allowable_values = %w[LINUX SOLARIS SUNOS ZLINUX WINDOWS AIX HP_UX]
  if opts[:platform_type] && !opts[:platform_type].empty?
    opts[:platform_type].each do |val_to_check|
      unless platform_type_allowable_values.include?(val_to_check)
        raise 'Invalid value for "platform_type", must be one of LINUX, SOLARIS, SUNOS, ZLINUX, WINDOWS, AIX, HP_UX.'
      end
    end
  end

  if opts[:statistic] && !%w[AVG MAX].include?(opts[:statistic])
    raise 'Invalid value for "statistic", must be one of AVG, MAX.'
  end

  if opts[:forecast_model] && !%w[LINEAR ML_AUTO ML_NO_AUTO].include?(opts[:forecast_model])
    raise 'Invalid value for "forecast_model", must be one of LINEAR, ML_AUTO, ML_NO_AUTO.'
  end

  if opts[:utilization_level] && !%w[HIGH_UTILIZATION LOW_UTILIZATION MEDIUM_HIGH_UTILIZATION MEDIUM_LOW_UTILIZATION].include?(opts[:utilization_level])
    raise 'Invalid value for "utilization_level", must be one of HIGH_UTILIZATION, LOW_UTILIZATION, MEDIUM_HIGH_UTILIZATION, MEDIUM_LOW_UTILIZATION.'
  end

  path = '/hostInsights/resourceForecastTrend'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:resourceMetric] = resource_metric
  query_params[:analysisTimeInterval] = opts[:analysis_time_interval] if opts[:analysis_time_interval]
  query_params[:timeIntervalStart] = opts[:time_interval_start] if opts[:time_interval_start]
  query_params[:timeIntervalEnd] = opts[:time_interval_end] if opts[:time_interval_end]
  query_params[:platformType] = OCI::ApiClient.build_collection_params(opts[:platform_type], :multi) if opts[:platform_type] && !opts[:platform_type].empty?
  query_params[:id] = OCI::ApiClient.build_collection_params(opts[:id], :multi) if opts[:id] && !opts[:id].empty?
  query_params[:exadataInsightId] = OCI::ApiClient.build_collection_params(opts[:exadata_insight_id], :multi) if opts[:exadata_insight_id] && !opts[:exadata_insight_id].empty?
  query_params[:statistic] = opts[:statistic] if opts[:statistic]
  query_params[:forecastDays] = opts[:forecast_days] if opts[:forecast_days]
  query_params[:forecastModel] = opts[:forecast_model] if opts[:forecast_model]
  query_params[:utilizationLevel] = opts[:utilization_level] if opts[:utilization_level]
  query_params[:confidence] = opts[:confidence] if opts[:confidence]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:definedTagEquals] = OCI::ApiClient.build_collection_params(opts[:defined_tag_equals], :multi) if opts[:defined_tag_equals] && !opts[:defined_tag_equals].empty?
  query_params[:freeformTagEquals] = OCI::ApiClient.build_collection_params(opts[:freeform_tag_equals], :multi) if opts[:freeform_tag_equals] && !opts[:freeform_tag_equals].empty?
  query_params[:definedTagExists] = OCI::ApiClient.build_collection_params(opts[:defined_tag_exists], :multi) if opts[:defined_tag_exists] && !opts[:defined_tag_exists].empty?
  query_params[:freeformTagExists] = OCI::ApiClient.build_collection_params(opts[:freeform_tag_exists], :multi) if opts[:freeform_tag_exists] && !opts[:freeform_tag_exists].empty?
  query_params[:compartmentIdInSubtree] = opts[:compartment_id_in_subtree] if !opts[:compartment_id_in_subtree].nil?
  query_params[:hostType] = OCI::ApiClient.build_collection_params(opts[:host_type], :multi) if opts[:host_type] && !opts[:host_type].empty?
  query_params[:hostId] = opts[:host_id] if opts[:host_id]
  query_params[:vmclusterName] = OCI::ApiClient.build_collection_params(opts[:vmcluster_name], :multi) if opts[:vmcluster_name] && !opts[:vmcluster_name].empty?
  query_params[:highUtilizationThreshold] = opts[:high_utilization_threshold] if opts[:high_utilization_threshold]
  query_params[:lowUtilizationThreshold] = opts[:low_utilization_threshold] if opts[:low_utilization_threshold]
  query_params[:mountPoint] = opts[:mount_point] if opts[:mount_point]
  query_params[:interfaceName] = opts[:interface_name] if opts[:interface_name]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'OperationsInsightsClient#summarize_host_insight_resource_forecast_trend') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Opsi::Models::SummarizeHostInsightResourceForecastTrendAggregation'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#summarize_host_insight_resource_statistics(compartment_id, resource_metric, opts = {}) ⇒ `Response`

Note:

Click here to see an example of how to use summarize_host_insight_resource_statistics API.

Lists the resource statistics (usage, capacity, usage change percent, utilization percent, load) for each host filtered by utilization level in a compartment and in all sub-compartments if specified.

Allowed values are: utilizationPercent, usage, usageChangePercent, hostName, platformType

Parameters:

compartment_id (String) —

The OCID of the compartment.
resource_metric (String) —

Filter by host resource metric. Supported values are CPU, MEMORY, LOGICAL_MEMORY, STORAGE and NETWORK.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:retry_config (OCI::Retry::RetryConfig) —

The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry
:analysis_time_interval (String) —

Specify time period in ISO 8601 format with respect to current time. Default is last 30 days represented by P30D. If timeInterval is specified, then timeIntervalStart and timeIntervalEnd will be ignored. Examples P90D (last 90 days), P4W (last 4 weeks), P2M (last 2 months), P1Y (last 12 months), . Maximum value allowed is 25 months prior to current time (P25M). (default to P30D)
:time_interval_start (DateTime) —

Analysis start time in UTC in ISO 8601 format(inclusive). Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). The minimum allowed value is 2 years prior to the current day. timeIntervalStart and timeIntervalEnd parameters are used together. If analysisTimeInterval is specified, this parameter is ignored.
:time_interval_end (DateTime) —

Analysis end time in UTC in ISO 8601 format(exclusive). Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). timeIntervalStart and timeIntervalEnd are used together. If timeIntervalEnd is not specified, current time is used as timeIntervalEnd.
:platform_type (Array<String>) —

Filter by one or more platform types. Supported platformType(s) for MACS-managed external host insight: [LINUX, SOLARIS, WINDOWS]. Supported platformType(s) for MACS-managed cloud host insight: [LINUX]. Supported platformType(s) for EM-managed external host insight: [LINUX, SOLARIS, SUNOS, ZLINUX, WINDOWS, AIX, HP-UX]. (default to []) Allowed values are: LINUX, SOLARIS, SUNOS, ZLINUX, WINDOWS, AIX, HP_UX
:id (Array<String>) —

Optional list of host insight resource OCIDs. (default to [])
:exadata_insight_id (Array<String>) —

Optional list of exadata insight resource OCIDs. (default to [])
:percentile (Integer) —

Percentile values of daily usage to be used for computing the aggregate resource usage. (default to 90)
:insight_by (String) —

Return data of a specific insight Possible values are High Utilization, Low Utilization, Any ,High Utilization Forecast, Low Utilization Forecast (default to [ANY])
:forecast_days (Integer) —

Number of days used for utilization forecast analysis. (default to 30)
:limit (Integer) —

For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see List Pagination. Example: 50 (default to 50)
:page (String) —

For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination.
:sort_order (String) —

The sort order to use, either ascending (ASC) or descending (DESC).
:sort_by (String) —

The order in which resource statistics records are listed. (default to utilizationPercent)
:opc_request_id (String) —

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
:defined_tag_equals (Array<String>) —

A list of tag filters to apply. Only resources with a defined tag matching the value will be returned. Each item in the list has the format "namespace.tagName.value". All inputs are case-insensitive. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as "OR". Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as "AND".
:freeform_tag_equals (Array<String>) —

A list of tag filters to apply. Only resources with a freeform tag matching the value will be returned. The key for each tag is "tagName.value". All inputs are case-insensitive. Multiple values for the same tag name are interpreted as "OR". Values for different tag names are interpreted as "AND".
:defined_tag_exists (Array<String>) —

A list of tag existence filters to apply. Only resources for which the specified defined tags exist will be returned. Each item in the list has the format "namespace.tagName.true" (for checking existence of a defined tag) or "namespace.true". All inputs are case-insensitive. Currently, only existence ("true" at the end) is supported. Absence ("false" at the end) is not supported. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as "OR". Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as "AND".
:freeform_tag_exists (Array<String>) —

A list of tag existence filters to apply. Only resources for which the specified freeform tags exist the value will be returned. The key for each tag is "tagName.true". All inputs are case-insensitive. Currently, only existence ("true" at the end) is supported. Absence ("false" at the end) is not supported. Multiple values for different tag names are interpreted as "AND".
:compartment_id_in_subtree (BOOLEAN) —

A flag to search all resources within a given compartment and all sub-compartments. (default to false)
:host_type (Array<String>) —

Filter by one or more host types. Possible values are CLOUD-HOST, EXTERNAL-HOST, COMANAGED-VM-HOST, COMANAGED-BM-HOST, COMANAGED-EXACS-HOST (default to [])
:host_id (String) —

Optional OCID of the host (Compute Id)
:vmcluster_name (Array<String>) —

Optional list of Exadata Insight VM cluster name. (default to [])
:high_utilization_threshold (Integer) —

Percent value in which a resource metric is considered highly utilized. (default to 75)
:low_utilization_threshold (Integer) —

Percent value in which a resource metric is considered low utilized. (default to 25)

Returns:

(Response) —

A Response object with data of type SummarizeHostInsightResourceStatisticsAggregationCollection

# File 'lib/oci/opsi/operations_insights_client.rb', line 14596

def summarize_host_insight_resource_statistics(compartment_id, resource_metric, opts = {})
  logger.debug 'Calling operation OperationsInsightsClient#summarize_host_insight_resource_statistics.' if logger

  raise "Missing the required parameter 'compartment_id' when calling summarize_host_insight_resource_statistics." if compartment_id.nil?
  raise "Missing the required parameter 'resource_metric' when calling summarize_host_insight_resource_statistics." if resource_metric.nil?


  platform_type_allowable_values = %w[LINUX SOLARIS SUNOS ZLINUX WINDOWS AIX HP_UX]
  if opts[:platform_type] && !opts[:platform_type].empty?
    opts[:platform_type].each do |val_to_check|
      unless platform_type_allowable_values.include?(val_to_check)
        raise 'Invalid value for "platform_type", must be one of LINUX, SOLARIS, SUNOS, ZLINUX, WINDOWS, AIX, HP_UX.'
      end
    end
  end

  if opts[:sort_order] && !OCI::Opsi::Models::SORT_ORDER_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::Opsi::Models::SORT_ORDER_ENUM.'
  end

  if opts[:sort_by] && !%w[utilizationPercent usage usageChangePercent hostName platformType].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of utilizationPercent, usage, usageChangePercent, hostName, platformType.'
  end

  path = '/hostInsights/resourceStatistics'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:resourceMetric] = resource_metric
  query_params[:analysisTimeInterval] = opts[:analysis_time_interval] if opts[:analysis_time_interval]
  query_params[:timeIntervalStart] = opts[:time_interval_start] if opts[:time_interval_start]
  query_params[:timeIntervalEnd] = opts[:time_interval_end] if opts[:time_interval_end]
  query_params[:platformType] = OCI::ApiClient.build_collection_params(opts[:platform_type], :multi) if opts[:platform_type] && !opts[:platform_type].empty?
  query_params[:id] = OCI::ApiClient.build_collection_params(opts[:id], :multi) if opts[:id] && !opts[:id].empty?
  query_params[:exadataInsightId] = OCI::ApiClient.build_collection_params(opts[:exadata_insight_id], :multi) if opts[:exadata_insight_id] && !opts[:exadata_insight_id].empty?
  query_params[:percentile] = opts[:percentile] if opts[:percentile]
  query_params[:insightBy] = opts[:insight_by] if opts[:insight_by]
  query_params[:forecastDays] = opts[:forecast_days] if opts[:forecast_days]
  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[:definedTagEquals] = OCI::ApiClient.build_collection_params(opts[:defined_tag_equals], :multi) if opts[:defined_tag_equals] && !opts[:defined_tag_equals].empty?
  query_params[:freeformTagEquals] = OCI::ApiClient.build_collection_params(opts[:freeform_tag_equals], :multi) if opts[:freeform_tag_equals] && !opts[:freeform_tag_equals].empty?
  query_params[:definedTagExists] = OCI::ApiClient.build_collection_params(opts[:defined_tag_exists], :multi) if opts[:defined_tag_exists] && !opts[:defined_tag_exists].empty?
  query_params[:freeformTagExists] = OCI::ApiClient.build_collection_params(opts[:freeform_tag_exists], :multi) if opts[:freeform_tag_exists] && !opts[:freeform_tag_exists].empty?
  query_params[:compartmentIdInSubtree] = opts[:compartment_id_in_subtree] if !opts[:compartment_id_in_subtree].nil?
  query_params[:hostType] = OCI::ApiClient.build_collection_params(opts[:host_type], :multi) if opts[:host_type] && !opts[:host_type].empty?
  query_params[:hostId] = opts[:host_id] if opts[:host_id]
  query_params[:vmclusterName] = OCI::ApiClient.build_collection_params(opts[:vmcluster_name], :multi) if opts[:vmcluster_name] && !opts[:vmcluster_name].empty?
  query_params[:highUtilizationThreshold] = opts[:high_utilization_threshold] if opts[:high_utilization_threshold]
  query_params[:lowUtilizationThreshold] = opts[:low_utilization_threshold] if opts[:low_utilization_threshold]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'OperationsInsightsClient#summarize_host_insight_resource_statistics') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Opsi::Models::SummarizeHostInsightResourceStatisticsAggregationCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#summarize_host_insight_resource_usage(compartment_id, resource_metric, opts = {}) ⇒ `Response`

Note:

Click here to see an example of how to use summarize_host_insight_resource_usage API.

A cumulative distribution function is used to rank the usage data points per host within the specified time period. For each host, the minimum data point with a ranking > the percentile value is included in the summation. Linear regression functions are used to calculate the usage change percentage. If compartmentIdInSubtree is specified, aggregates resources in a compartment and in all sub-compartments.

Parameters:

compartment_id (String) —

The OCID of the compartment.
resource_metric (String) —

Filter by host resource metric. Supported values are CPU, MEMORY, LOGICAL_MEMORY, STORAGE and NETWORK.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:retry_config (OCI::Retry::RetryConfig) —

The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry
:analysis_time_interval (String) —

Specify time period in ISO 8601 format with respect to current time. Default is last 30 days represented by P30D. If timeInterval is specified, then timeIntervalStart and timeIntervalEnd will be ignored. Examples P90D (last 90 days), P4W (last 4 weeks), P2M (last 2 months), P1Y (last 12 months), . Maximum value allowed is 25 months prior to current time (P25M). (default to P30D)
:time_interval_start (DateTime) —

Analysis start time in UTC in ISO 8601 format(inclusive). Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). The minimum allowed value is 2 years prior to the current day. timeIntervalStart and timeIntervalEnd parameters are used together. If analysisTimeInterval is specified, this parameter is ignored.
:time_interval_end (DateTime) —

Analysis end time in UTC in ISO 8601 format(exclusive). Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). timeIntervalStart and timeIntervalEnd are used together. If timeIntervalEnd is not specified, current time is used as timeIntervalEnd.
:platform_type (Array<String>) —

Filter by one or more platform types. Supported platformType(s) for MACS-managed external host insight: [LINUX, SOLARIS, WINDOWS]. Supported platformType(s) for MACS-managed cloud host insight: [LINUX]. Supported platformType(s) for EM-managed external host insight: [LINUX, SOLARIS, SUNOS, ZLINUX, WINDOWS, AIX, HP-UX]. (default to []) Allowed values are: LINUX, SOLARIS, SUNOS, ZLINUX, WINDOWS, AIX, HP_UX
:id (Array<String>) —

Optional list of host insight resource OCIDs. (default to [])
:exadata_insight_id (Array<String>) —

Optional list of exadata insight resource OCIDs. (default to [])
:page (String) —

For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination.
:percentile (Integer) —

Percentile values of daily usage to be used for computing the aggregate resource usage. (default to 90)
:opc_request_id (String) —

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
:defined_tag_equals (Array<String>) —

A list of tag filters to apply. Only resources with a defined tag matching the value will be returned. Each item in the list has the format "namespace.tagName.value". All inputs are case-insensitive. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as "OR". Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as "AND".
:freeform_tag_equals (Array<String>) —

A list of tag filters to apply. Only resources with a freeform tag matching the value will be returned. The key for each tag is "tagName.value". All inputs are case-insensitive. Multiple values for the same tag name are interpreted as "OR". Values for different tag names are interpreted as "AND".
:defined_tag_exists (Array<String>) —

A list of tag existence filters to apply. Only resources for which the specified defined tags exist will be returned. Each item in the list has the format "namespace.tagName.true" (for checking existence of a defined tag) or "namespace.true". All inputs are case-insensitive. Currently, only existence ("true" at the end) is supported. Absence ("false" at the end) is not supported. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as "OR". Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as "AND".
:freeform_tag_exists (Array<String>) —

A list of tag existence filters to apply. Only resources for which the specified freeform tags exist the value will be returned. The key for each tag is "tagName.true". All inputs are case-insensitive. Currently, only existence ("true" at the end) is supported. Absence ("false" at the end) is not supported. Multiple values for different tag names are interpreted as "AND".
:compartment_id_in_subtree (BOOLEAN) —

A flag to search all resources within a given compartment and all sub-compartments. (default to false)
:host_type (Array<String>) —

Filter by one or more host types. Possible values are CLOUD-HOST, EXTERNAL-HOST, COMANAGED-VM-HOST, COMANAGED-BM-HOST, COMANAGED-EXACS-HOST (default to [])
:host_id (String) —

Optional OCID of the host (Compute Id)
:vmcluster_name (Array<String>) —

Optional list of Exadata Insight VM cluster name. (default to [])

Returns:

(Response) —

A Response object with data of type SummarizeHostInsightResourceUsageAggregation

# File 'lib/oci/opsi/operations_insights_client.rb', line 14764

def summarize_host_insight_resource_usage(compartment_id, resource_metric, opts = {})
  logger.debug 'Calling operation OperationsInsightsClient#summarize_host_insight_resource_usage.' if logger

  raise "Missing the required parameter 'compartment_id' when calling summarize_host_insight_resource_usage." if compartment_id.nil?
  raise "Missing the required parameter 'resource_metric' when calling summarize_host_insight_resource_usage." if resource_metric.nil?


  platform_type_allowable_values = %w[LINUX SOLARIS SUNOS ZLINUX WINDOWS AIX HP_UX]
  if opts[:platform_type] && !opts[:platform_type].empty?
    opts[:platform_type].each do |val_to_check|
      unless platform_type_allowable_values.include?(val_to_check)
        raise 'Invalid value for "platform_type", must be one of LINUX, SOLARIS, SUNOS, ZLINUX, WINDOWS, AIX, HP_UX.'
      end
    end
  end

  path = '/hostInsights/resourceUsageSummary'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:resourceMetric] = resource_metric
  query_params[:analysisTimeInterval] = opts[:analysis_time_interval] if opts[:analysis_time_interval]
  query_params[:timeIntervalStart] = opts[:time_interval_start] if opts[:time_interval_start]
  query_params[:timeIntervalEnd] = opts[:time_interval_end] if opts[:time_interval_end]
  query_params[:platformType] = OCI::ApiClient.build_collection_params(opts[:platform_type], :multi) if opts[:platform_type] && !opts[:platform_type].empty?
  query_params[:id] = OCI::ApiClient.build_collection_params(opts[:id], :multi) if opts[:id] && !opts[:id].empty?
  query_params[:exadataInsightId] = OCI::ApiClient.build_collection_params(opts[:exadata_insight_id], :multi) if opts[:exadata_insight_id] && !opts[:exadata_insight_id].empty?
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:percentile] = opts[:percentile] if opts[:percentile]
  query_params[:definedTagEquals] = OCI::ApiClient.build_collection_params(opts[:defined_tag_equals], :multi) if opts[:defined_tag_equals] && !opts[:defined_tag_equals].empty?
  query_params[:freeformTagEquals] = OCI::ApiClient.build_collection_params(opts[:freeform_tag_equals], :multi) if opts[:freeform_tag_equals] && !opts[:freeform_tag_equals].empty?
  query_params[:definedTagExists] = OCI::ApiClient.build_collection_params(opts[:defined_tag_exists], :multi) if opts[:defined_tag_exists] && !opts[:defined_tag_exists].empty?
  query_params[:freeformTagExists] = OCI::ApiClient.build_collection_params(opts[:freeform_tag_exists], :multi) if opts[:freeform_tag_exists] && !opts[:freeform_tag_exists].empty?
  query_params[:compartmentIdInSubtree] = opts[:compartment_id_in_subtree] if !opts[:compartment_id_in_subtree].nil?
  query_params[:hostType] = OCI::ApiClient.build_collection_params(opts[:host_type], :multi) if opts[:host_type] && !opts[:host_type].empty?
  query_params[:hostId] = opts[:host_id] if opts[:host_id]
  query_params[:vmclusterName] = OCI::ApiClient.build_collection_params(opts[:vmcluster_name], :multi) if opts[:vmcluster_name] && !opts[:vmcluster_name].empty?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'OperationsInsightsClient#summarize_host_insight_resource_usage') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Opsi::Models::SummarizeHostInsightResourceUsageAggregation'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#summarize_host_insight_resource_usage_trend(compartment_id, resource_metric, opts = {}) ⇒ `Response`

Note:

Click here to see an example of how to use summarize_host_insight_resource_usage_trend API.

Returns response with time series data (endTimestamp, usage, capacity) for the time period specified. The maximum time range for analysis is 2 years, hence this is intentionally not paginated. If compartmentIdInSubtree is specified, aggregates resources in a compartment and in all sub-compartments.

Allowed values are: endTimestamp, usage, capacity

Parameters:

compartment_id (String) —

The OCID of the compartment.
resource_metric (String) —

Filter by host resource metric. Supported values are CPU, MEMORY, LOGICAL_MEMORY, STORAGE and NETWORK.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:retry_config (OCI::Retry::RetryConfig) —

The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry
:analysis_time_interval (String) —

Specify time period in ISO 8601 format with respect to current time. Default is last 30 days represented by P30D. If timeInterval is specified, then timeIntervalStart and timeIntervalEnd will be ignored. Examples P90D (last 90 days), P4W (last 4 weeks), P2M (last 2 months), P1Y (last 12 months), . Maximum value allowed is 25 months prior to current time (P25M). (default to P30D)
:time_interval_start (DateTime) —

Analysis start time in UTC in ISO 8601 format(inclusive). Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). The minimum allowed value is 2 years prior to the current day. timeIntervalStart and timeIntervalEnd parameters are used together. If analysisTimeInterval is specified, this parameter is ignored.
:time_interval_end (DateTime) —

Analysis end time in UTC in ISO 8601 format(exclusive). Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). timeIntervalStart and timeIntervalEnd are used together. If timeIntervalEnd is not specified, current time is used as timeIntervalEnd.
:platform_type (Array<String>) —

Filter by one or more platform types. Supported platformType(s) for MACS-managed external host insight: [LINUX, SOLARIS, WINDOWS]. Supported platformType(s) for MACS-managed cloud host insight: [LINUX]. Supported platformType(s) for EM-managed external host insight: [LINUX, SOLARIS, SUNOS, ZLINUX, WINDOWS, AIX, HP-UX]. (default to []) Allowed values are: LINUX, SOLARIS, SUNOS, ZLINUX, WINDOWS, AIX, HP_UX
:id (Array<String>) —

Optional list of host insight resource OCIDs. (default to [])
:exadata_insight_id (Array<String>) —

Optional list of exadata insight resource OCIDs. (default to [])
:page (String) —

For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination.
:sort_order (String) —

The sort order to use, either ascending (ASC) or descending (DESC).
:sort_by (String) —

Sorts using end timestamp, usage or capacity (default to endTimestamp)
:opc_request_id (String) —

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
:defined_tag_equals (Array<String>) —

A list of tag filters to apply. Only resources with a defined tag matching the value will be returned. Each item in the list has the format "namespace.tagName.value". All inputs are case-insensitive. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as "OR". Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as "AND".
:freeform_tag_equals (Array<String>) —

A list of tag filters to apply. Only resources with a freeform tag matching the value will be returned. The key for each tag is "tagName.value". All inputs are case-insensitive. Multiple values for the same tag name are interpreted as "OR". Values for different tag names are interpreted as "AND".
:defined_tag_exists (Array<String>) —

A list of tag existence filters to apply. Only resources for which the specified defined tags exist will be returned. Each item in the list has the format "namespace.tagName.true" (for checking existence of a defined tag) or "namespace.true". All inputs are case-insensitive. Currently, only existence ("true" at the end) is supported. Absence ("false" at the end) is not supported. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as "OR". Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as "AND".
:freeform_tag_exists (Array<String>) —

A list of tag existence filters to apply. Only resources for which the specified freeform tags exist the value will be returned. The key for each tag is "tagName.true". All inputs are case-insensitive. Currently, only existence ("true" at the end) is supported. Absence ("false" at the end) is not supported. Multiple values for different tag names are interpreted as "AND".
:compartment_id_in_subtree (BOOLEAN) —

A flag to search all resources within a given compartment and all sub-compartments. (default to false)
:host_type (Array<String>) —

Filter by one or more host types. Possible values are CLOUD-HOST, EXTERNAL-HOST, COMANAGED-VM-HOST, COMANAGED-BM-HOST, COMANAGED-EXACS-HOST (default to [])
:host_id (String) —

Optional OCID of the host (Compute Id)
:vmcluster_name (Array<String>) —

Optional list of Exadata Insight VM cluster name. (default to [])

Returns:

(Response) —

A Response object with data of type SummarizeHostInsightResourceUsageTrendAggregationCollection

# File 'lib/oci/opsi/operations_insights_client.rb', line 14919

def summarize_host_insight_resource_usage_trend(compartment_id, resource_metric, opts = {})
  logger.debug 'Calling operation OperationsInsightsClient#summarize_host_insight_resource_usage_trend.' if logger

  raise "Missing the required parameter 'compartment_id' when calling summarize_host_insight_resource_usage_trend." if compartment_id.nil?
  raise "Missing the required parameter 'resource_metric' when calling summarize_host_insight_resource_usage_trend." if resource_metric.nil?


  platform_type_allowable_values = %w[LINUX SOLARIS SUNOS ZLINUX WINDOWS AIX HP_UX]
  if opts[:platform_type] && !opts[:platform_type].empty?
    opts[:platform_type].each do |val_to_check|
      unless platform_type_allowable_values.include?(val_to_check)
        raise 'Invalid value for "platform_type", must be one of LINUX, SOLARIS, SUNOS, ZLINUX, WINDOWS, AIX, HP_UX.'
      end
    end
  end

  if opts[:sort_order] && !OCI::Opsi::Models::SORT_ORDER_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::Opsi::Models::SORT_ORDER_ENUM.'
  end

  if opts[:sort_by] && !%w[endTimestamp usage capacity].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of endTimestamp, usage, capacity.'
  end

  path = '/hostInsights/resourceUsageTrend'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:resourceMetric] = resource_metric
  query_params[:analysisTimeInterval] = opts[:analysis_time_interval] if opts[:analysis_time_interval]
  query_params[:timeIntervalStart] = opts[:time_interval_start] if opts[:time_interval_start]
  query_params[:timeIntervalEnd] = opts[:time_interval_end] if opts[:time_interval_end]
  query_params[:platformType] = OCI::ApiClient.build_collection_params(opts[:platform_type], :multi) if opts[:platform_type] && !opts[:platform_type].empty?
  query_params[:id] = OCI::ApiClient.build_collection_params(opts[:id], :multi) if opts[:id] && !opts[:id].empty?
  query_params[:exadataInsightId] = OCI::ApiClient.build_collection_params(opts[:exadata_insight_id], :multi) if opts[:exadata_insight_id] && !opts[:exadata_insight_id].empty?
  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[:definedTagEquals] = OCI::ApiClient.build_collection_params(opts[:defined_tag_equals], :multi) if opts[:defined_tag_equals] && !opts[:defined_tag_equals].empty?
  query_params[:freeformTagEquals] = OCI::ApiClient.build_collection_params(opts[:freeform_tag_equals], :multi) if opts[:freeform_tag_equals] && !opts[:freeform_tag_equals].empty?
  query_params[:definedTagExists] = OCI::ApiClient.build_collection_params(opts[:defined_tag_exists], :multi) if opts[:defined_tag_exists] && !opts[:defined_tag_exists].empty?
  query_params[:freeformTagExists] = OCI::ApiClient.build_collection_params(opts[:freeform_tag_exists], :multi) if opts[:freeform_tag_exists] && !opts[:freeform_tag_exists].empty?
  query_params[:compartmentIdInSubtree] = opts[:compartment_id_in_subtree] if !opts[:compartment_id_in_subtree].nil?
  query_params[:hostType] = OCI::ApiClient.build_collection_params(opts[:host_type], :multi) if opts[:host_type] && !opts[:host_type].empty?
  query_params[:hostId] = opts[:host_id] if opts[:host_id]
  query_params[:vmclusterName] = OCI::ApiClient.build_collection_params(opts[:vmcluster_name], :multi) if opts[:vmcluster_name] && !opts[:vmcluster_name].empty?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'OperationsInsightsClient#summarize_host_insight_resource_usage_trend') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Opsi::Models::SummarizeHostInsightResourceUsageTrendAggregationCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#summarize_host_insight_resource_utilization_insight(compartment_id, resource_metric, opts = {}) ⇒ `Response`

Note:

Click here to see an example of how to use summarize_host_insight_resource_utilization_insight API.

Gets resources with current utilization (high and low) and projected utilization (high and low) for a resource type over specified time period. If compartmentIdInSubtree is specified, aggregates resources in a compartment and in all sub-compartments.

Parameters:

compartment_id (String) —

The OCID of the compartment.
resource_metric (String) —

Filter by host resource metric. Supported values are CPU, MEMORY, LOGICAL_MEMORY, STORAGE and NETWORK.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:retry_config (OCI::Retry::RetryConfig) —

The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry
:analysis_time_interval (String) —

Specify time period in ISO 8601 format with respect to current time. Default is last 30 days represented by P30D. If timeInterval is specified, then timeIntervalStart and timeIntervalEnd will be ignored. Examples P90D (last 90 days), P4W (last 4 weeks), P2M (last 2 months), P1Y (last 12 months), . Maximum value allowed is 25 months prior to current time (P25M). (default to P30D)
:time_interval_start (DateTime) —

Analysis start time in UTC in ISO 8601 format(inclusive). Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). The minimum allowed value is 2 years prior to the current day. timeIntervalStart and timeIntervalEnd parameters are used together. If analysisTimeInterval is specified, this parameter is ignored.
:time_interval_end (DateTime) —

Analysis end time in UTC in ISO 8601 format(exclusive). Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). timeIntervalStart and timeIntervalEnd are used together. If timeIntervalEnd is not specified, current time is used as timeIntervalEnd.
:platform_type (Array<String>) —

Filter by one or more platform types. Supported platformType(s) for MACS-managed external host insight: [LINUX, SOLARIS, WINDOWS]. Supported platformType(s) for MACS-managed cloud host insight: [LINUX]. Supported platformType(s) for EM-managed external host insight: [LINUX, SOLARIS, SUNOS, ZLINUX, WINDOWS, AIX, HP-UX]. (default to []) Allowed values are: LINUX, SOLARIS, SUNOS, ZLINUX, WINDOWS, AIX, HP_UX
:id (Array<String>) —

Optional list of host insight resource OCIDs. (default to [])
:exadata_insight_id (Array<String>) —

Optional list of exadata insight resource OCIDs. (default to [])
:forecast_days (Integer) —

Number of days used for utilization forecast analysis. (default to 30)
:page (String) —

For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination.
:opc_request_id (String) —

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
:defined_tag_equals (Array<String>) —

A list of tag filters to apply. Only resources with a defined tag matching the value will be returned. Each item in the list has the format "namespace.tagName.value". All inputs are case-insensitive. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as "OR". Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as "AND".
:freeform_tag_equals (Array<String>) —

A list of tag filters to apply. Only resources with a freeform tag matching the value will be returned. The key for each tag is "tagName.value". All inputs are case-insensitive. Multiple values for the same tag name are interpreted as "OR". Values for different tag names are interpreted as "AND".
:defined_tag_exists (Array<String>) —

A list of tag existence filters to apply. Only resources for which the specified defined tags exist will be returned. Each item in the list has the format "namespace.tagName.true" (for checking existence of a defined tag) or "namespace.true". All inputs are case-insensitive. Currently, only existence ("true" at the end) is supported. Absence ("false" at the end) is not supported. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as "OR". Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as "AND".
:freeform_tag_exists (Array<String>) —

A list of tag existence filters to apply. Only resources for which the specified freeform tags exist the value will be returned. The key for each tag is "tagName.true". All inputs are case-insensitive. Currently, only existence ("true" at the end) is supported. Absence ("false" at the end) is not supported. Multiple values for different tag names are interpreted as "AND".
:compartment_id_in_subtree (BOOLEAN) —

A flag to search all resources within a given compartment and all sub-compartments. (default to false)
:host_type (Array<String>) —

Filter by one or more host types. Possible values are CLOUD-HOST, EXTERNAL-HOST, COMANAGED-VM-HOST, COMANAGED-BM-HOST, COMANAGED-EXACS-HOST (default to [])
:host_id (String) —

Optional OCID of the host (Compute Id)
:vmcluster_name (Array<String>) —

Optional list of Exadata Insight VM cluster name. (default to [])
:high_utilization_threshold (Integer) —

Percent value in which a resource metric is considered highly utilized. (default to 75)
:low_utilization_threshold (Integer) —

Percent value in which a resource metric is considered low utilized. (default to 25)

Returns:

(Response) —

A Response object with data of type SummarizeHostInsightResourceUtilizationInsightAggregation

# File 'lib/oci/opsi/operations_insights_client.rb', line 15081

def summarize_host_insight_resource_utilization_insight(compartment_id, resource_metric, opts = {})
  logger.debug 'Calling operation OperationsInsightsClient#summarize_host_insight_resource_utilization_insight.' if logger

  raise "Missing the required parameter 'compartment_id' when calling summarize_host_insight_resource_utilization_insight." if compartment_id.nil?
  raise "Missing the required parameter 'resource_metric' when calling summarize_host_insight_resource_utilization_insight." if resource_metric.nil?


  platform_type_allowable_values = %w[LINUX SOLARIS SUNOS ZLINUX WINDOWS AIX HP_UX]
  if opts[:platform_type] && !opts[:platform_type].empty?
    opts[:platform_type].each do |val_to_check|
      unless platform_type_allowable_values.include?(val_to_check)
        raise 'Invalid value for "platform_type", must be one of LINUX, SOLARIS, SUNOS, ZLINUX, WINDOWS, AIX, HP_UX.'
      end
    end
  end

  path = '/hostInsights/resourceUtilizationInsight'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:resourceMetric] = resource_metric
  query_params[:analysisTimeInterval] = opts[:analysis_time_interval] if opts[:analysis_time_interval]
  query_params[:timeIntervalStart] = opts[:time_interval_start] if opts[:time_interval_start]
  query_params[:timeIntervalEnd] = opts[:time_interval_end] if opts[:time_interval_end]
  query_params[:platformType] = OCI::ApiClient.build_collection_params(opts[:platform_type], :multi) if opts[:platform_type] && !opts[:platform_type].empty?
  query_params[:id] = OCI::ApiClient.build_collection_params(opts[:id], :multi) if opts[:id] && !opts[:id].empty?
  query_params[:exadataInsightId] = OCI::ApiClient.build_collection_params(opts[:exadata_insight_id], :multi) if opts[:exadata_insight_id] && !opts[:exadata_insight_id].empty?
  query_params[:forecastDays] = opts[:forecast_days] if opts[:forecast_days]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:definedTagEquals] = OCI::ApiClient.build_collection_params(opts[:defined_tag_equals], :multi) if opts[:defined_tag_equals] && !opts[:defined_tag_equals].empty?
  query_params[:freeformTagEquals] = OCI::ApiClient.build_collection_params(opts[:freeform_tag_equals], :multi) if opts[:freeform_tag_equals] && !opts[:freeform_tag_equals].empty?
  query_params[:definedTagExists] = OCI::ApiClient.build_collection_params(opts[:defined_tag_exists], :multi) if opts[:defined_tag_exists] && !opts[:defined_tag_exists].empty?
  query_params[:freeformTagExists] = OCI::ApiClient.build_collection_params(opts[:freeform_tag_exists], :multi) if opts[:freeform_tag_exists] && !opts[:freeform_tag_exists].empty?
  query_params[:compartmentIdInSubtree] = opts[:compartment_id_in_subtree] if !opts[:compartment_id_in_subtree].nil?
  query_params[:hostType] = OCI::ApiClient.build_collection_params(opts[:host_type], :multi) if opts[:host_type] && !opts[:host_type].empty?
  query_params[:hostId] = opts[:host_id] if opts[:host_id]
  query_params[:vmclusterName] = OCI::ApiClient.build_collection_params(opts[:vmcluster_name], :multi) if opts[:vmcluster_name] && !opts[:vmcluster_name].empty?
  query_params[:highUtilizationThreshold] = opts[:high_utilization_threshold] if opts[:high_utilization_threshold]
  query_params[:lowUtilizationThreshold] = opts[:low_utilization_threshold] if opts[:low_utilization_threshold]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'OperationsInsightsClient#summarize_host_insight_resource_utilization_insight') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Opsi::Models::SummarizeHostInsightResourceUtilizationInsightAggregation'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#summarize_host_insight_storage_usage_trend(compartment_id, id, opts = {}) ⇒ `Response`

Note:

Click here to see an example of how to use summarize_host_insight_storage_usage_trend API.

Returns response with usage time series data with breakdown by filesystem for the time period specified.

Parameters:

compartment_id (String) —

The OCID of the compartment.
id (String) —

Required OCID of the host insight 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
:analysis_time_interval (String) —

Specify time period in ISO 8601 format with respect to current time. Default is last 30 days represented by P30D. If timeInterval is specified, then timeIntervalStart and timeIntervalEnd will be ignored. Examples P90D (last 90 days), P4W (last 4 weeks), P2M (last 2 months), P1Y (last 12 months), . Maximum value allowed is 25 months prior to current time (P25M). (default to P30D)
:time_interval_start (DateTime) —

Analysis start time in UTC in ISO 8601 format(inclusive). Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). The minimum allowed value is 2 years prior to the current day. timeIntervalStart and timeIntervalEnd parameters are used together. If analysisTimeInterval is specified, this parameter is ignored.
:time_interval_end (DateTime) —

Analysis end time in UTC in ISO 8601 format(exclusive). Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). timeIntervalStart and timeIntervalEnd are used together. If timeIntervalEnd is not specified, current time is used as timeIntervalEnd.
:host_id (String) —

Optional OCID of the host (Compute Id)
:page (String) —

For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination.
:limit (Integer) —

For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see List Pagination. Example: 50 (default to 50)
:statistic (String) —

Choose the type of statistic metric data to be used for forecasting. (default to AVG) Allowed values are: AVG, MAX
:opc_request_id (String) —

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:

(Response) —

A Response object with data of type SummarizeHostInsightStorageUsageTrendAggregationCollection

# File 'lib/oci/opsi/operations_insights_client.rb', line 15200

def summarize_host_insight_storage_usage_trend(compartment_id, id, opts = {})
  logger.debug 'Calling operation OperationsInsightsClient#summarize_host_insight_storage_usage_trend.' if logger

  raise "Missing the required parameter 'compartment_id' when calling summarize_host_insight_storage_usage_trend." if compartment_id.nil?
  raise "Missing the required parameter 'id' when calling summarize_host_insight_storage_usage_trend." if id.nil?

  if opts[:statistic] && !%w[AVG MAX].include?(opts[:statistic])
    raise 'Invalid value for "statistic", must be one of AVG, MAX.'
  end

  path = '/hostInsights/storageUsageTrend'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:id] = id
  query_params[:analysisTimeInterval] = opts[:analysis_time_interval] if opts[:analysis_time_interval]
  query_params[:timeIntervalStart] = opts[:time_interval_start] if opts[:time_interval_start]
  query_params[:timeIntervalEnd] = opts[:time_interval_end] if opts[:time_interval_end]
  query_params[:hostId] = opts[:host_id] if opts[:host_id]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:statistic] = opts[:statistic] if opts[:statistic]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'OperationsInsightsClient#summarize_host_insight_storage_usage_trend') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Opsi::Models::SummarizeHostInsightStorageUsageTrendAggregationCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#summarize_host_insight_top_processes_usage(compartment_id, id, resource_metric, timestamp, opts = {}) ⇒ `Response`

Note:

Click here to see an example of how to use summarize_host_insight_top_processes_usage API.

Returns response with aggregated data (timestamp, usageData) for top processes on a specific date. Data is aggregated for the time specified and processes are sorted descendent by the process metric specified (CPU, MEMORY, VIRTUAL_MEMORY). hostInsightId, processMetric must be specified.

Parameters:

compartment_id (String) —

The OCID of the compartment.
id (String) —

Required OCID of the host insight resource.
resource_metric (String) —

Host top processes resource metric sort options. Supported values are CPU, MEMORY, VIIRTUAL_MEMORY.
timestamp (DateTime) —

Timestamp at which to gather the top processes. This will be top processes over the hour or over the day pending the time range passed into the query.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:retry_config (OCI::Retry::RetryConfig) —

The retry configuration to apply to this operation. If no key is provided then the 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_interval_start (DateTime) —

Analysis start time in UTC in ISO 8601 format(inclusive). Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). The minimum allowed value is 2 years prior to the current day. timeIntervalStart and timeIntervalEnd parameters are used together. If analysisTimeInterval is specified, this parameter is ignored.
:time_interval_end (DateTime) —

Analysis end time in UTC in ISO 8601 format(exclusive). Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). timeIntervalStart and timeIntervalEnd are used together. If timeIntervalEnd is not specified, current time is used as timeIntervalEnd.
:page (String) —

For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination.
:limit (Integer) —

For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see List Pagination. Example: 50 (default to 50)
:opc_request_id (String) —

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
:analysis_time_interval (String) —

Specify time period in ISO 8601 format with respect to current time. Default is last 30 days represented by P30D. If timeInterval is specified, then timeIntervalStart and timeIntervalEnd will be ignored. Examples P90D (last 90 days), P4W (last 4 weeks), P2M (last 2 months), P1Y (last 12 months), . Maximum value allowed is 25 months prior to current time (P25M). (default to P30D)
:host_type (Array<String>) —

Filter by one or more host types. Possible values are CLOUD-HOST, EXTERNAL-HOST, COMANAGED-VM-HOST, COMANAGED-BM-HOST, COMANAGED-EXACS-HOST (default to [])
:host_id (String) —

Optional OCID of the host (Compute Id)
:statistic (String) —

Choose the type of statistic metric data to be used for forecasting. (default to AVG) Allowed values are: AVG, MAX

Returns:

(Response) —

A Response object with data of type SummarizeHostInsightsTopProcessesUsageCollection

# File 'lib/oci/opsi/operations_insights_client.rb', line 15313

def summarize_host_insight_top_processes_usage(compartment_id, id, resource_metric, timestamp, opts = {})
  logger.debug 'Calling operation OperationsInsightsClient#summarize_host_insight_top_processes_usage.' if logger

  raise "Missing the required parameter 'compartment_id' when calling summarize_host_insight_top_processes_usage." if compartment_id.nil?
  raise "Missing the required parameter 'id' when calling summarize_host_insight_top_processes_usage." if id.nil?
  raise "Missing the required parameter 'resource_metric' when calling summarize_host_insight_top_processes_usage." if resource_metric.nil?
  raise "Missing the required parameter 'timestamp' when calling summarize_host_insight_top_processes_usage." if timestamp.nil?

  if opts[:statistic] && !%w[AVG MAX].include?(opts[:statistic])
    raise 'Invalid value for "statistic", must be one of AVG, MAX.'
  end

  path = '/hostInsights/topProcessesUsage'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:id] = id
  query_params[:resourceMetric] = resource_metric
  query_params[:timestamp] = timestamp
  query_params[:timeIntervalStart] = opts[:time_interval_start] if opts[:time_interval_start]
  query_params[:timeIntervalEnd] = opts[:time_interval_end] if opts[:time_interval_end]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:analysisTimeInterval] = opts[:analysis_time_interval] if opts[:analysis_time_interval]
  query_params[:hostType] = OCI::ApiClient.build_collection_params(opts[:host_type], :multi) if opts[:host_type] && !opts[:host_type].empty?
  query_params[:hostId] = opts[:host_id] if opts[:host_id]
  query_params[:statistic] = opts[:statistic] if opts[:statistic]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'OperationsInsightsClient#summarize_host_insight_top_processes_usage') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Opsi::Models::SummarizeHostInsightsTopProcessesUsageCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#summarize_host_insight_top_processes_usage_trend(compartment_id, id, resource_metric, opts = {}) ⇒ `Response`

Note:

Click here to see an example of how to use summarize_host_insight_top_processes_usage_trend API.

Returns response with aggregated time series data (timeIntervalstart, timeIntervalEnd, commandArgs, usageData) for top processes. Data is aggregated for the time period specified and proceses are sorted descendent by the proces metric specified (CPU, MEMORY, VIRTUAL_MEMORY). HostInsight Id and Process metric must be specified

Parameters:

compartment_id (String) —

The OCID of the compartment.
id (String) —

Required OCID of the host insight resource.
resource_metric (String) —

Host top processes resource metric sort options. Supported values are CPU, MEMORY, VIIRTUAL_MEMORY.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:retry_config (OCI::Retry::RetryConfig) —

The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry
:analysis_time_interval (String) —

Specify time period in ISO 8601 format with respect to current time. Default is last 30 days represented by P30D. If timeInterval is specified, then timeIntervalStart and timeIntervalEnd will be ignored. Examples P90D (last 90 days), P4W (last 4 weeks), P2M (last 2 months), P1Y (last 12 months), . Maximum value allowed is 25 months prior to current time (P25M). (default to P30D)
:time_interval_start (DateTime) —

Analysis start time in UTC in ISO 8601 format(inclusive). Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). The minimum allowed value is 2 years prior to the current day. timeIntervalStart and timeIntervalEnd parameters are used together. If analysisTimeInterval is specified, this parameter is ignored.
:time_interval_end (DateTime) —

Analysis end time in UTC in ISO 8601 format(exclusive). Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). timeIntervalStart and timeIntervalEnd are used together. If timeIntervalEnd is not specified, current time is used as timeIntervalEnd.
:page (String) —

For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination.
:limit (Integer) —

For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see List Pagination. Example: 50 (default to 50)
:opc_request_id (String) —

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
:host_type (Array<String>) —

Filter by one or more host types. Possible values are CLOUD-HOST, EXTERNAL-HOST, COMANAGED-VM-HOST, COMANAGED-BM-HOST, COMANAGED-EXACS-HOST (default to [])
:host_id (String) —

Optional OCID of the host (Compute Id)
:process_hash (String) —

Unique identifier for a process.
:statistic (String) —

Choose the type of statistic metric data to be used for forecasting. (default to AVG) Allowed values are: AVG, MAX

Returns:

(Response) —

A Response object with data of type SummarizeHostInsightsTopProcessesUsageTrendCollection

# File 'lib/oci/opsi/operations_insights_client.rb', line 15430

def summarize_host_insight_top_processes_usage_trend(compartment_id, id, resource_metric, opts = {})
  logger.debug 'Calling operation OperationsInsightsClient#summarize_host_insight_top_processes_usage_trend.' if logger

  raise "Missing the required parameter 'compartment_id' when calling summarize_host_insight_top_processes_usage_trend." if compartment_id.nil?
  raise "Missing the required parameter 'id' when calling summarize_host_insight_top_processes_usage_trend." if id.nil?
  raise "Missing the required parameter 'resource_metric' when calling summarize_host_insight_top_processes_usage_trend." if resource_metric.nil?

  if opts[:statistic] && !%w[AVG MAX].include?(opts[:statistic])
    raise 'Invalid value for "statistic", must be one of AVG, MAX.'
  end

  path = '/hostInsights/topProcessesUsageTrend'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:id] = id
  query_params[:resourceMetric] = resource_metric
  query_params[:analysisTimeInterval] = opts[:analysis_time_interval] if opts[:analysis_time_interval]
  query_params[:timeIntervalStart] = opts[:time_interval_start] if opts[:time_interval_start]
  query_params[:timeIntervalEnd] = opts[:time_interval_end] if opts[:time_interval_end]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:hostType] = OCI::ApiClient.build_collection_params(opts[:host_type], :multi) if opts[:host_type] && !opts[:host_type].empty?
  query_params[:hostId] = opts[:host_id] if opts[:host_id]
  query_params[:processHash] = opts[:process_hash] if opts[:process_hash]
  query_params[:statistic] = opts[:statistic] if opts[:statistic]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'OperationsInsightsClient#summarize_host_insight_top_processes_usage_trend') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Opsi::Models::SummarizeHostInsightsTopProcessesUsageTrendCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#summarize_operations_insights_warehouse_resource_usage(operations_insights_warehouse_id, opts = {}) ⇒ `Response`

Note:

Click here to see an example of how to use summarize_operations_insights_warehouse_resource_usage API.

Gets the details of resources used by an Operations Insights Warehouse. There is only expected to be 1 warehouse per tenant. The warehouse is expected to be in the root compartment.

Parameters:

operations_insights_warehouse_id (String) —

Unique Operations Insights Warehouse identifier
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:retry_config (OCI::Retry::RetryConfig) —

The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry
:opc_request_id (String) —

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:

(Response) —

A Response object with data of type SummarizeOperationsInsightsWarehouseResourceUsageAggregation

# File 'lib/oci/opsi/operations_insights_client.rb', line 15505

def summarize_operations_insights_warehouse_resource_usage(operations_insights_warehouse_id, opts = {})
  logger.debug 'Calling operation OperationsInsightsClient#summarize_operations_insights_warehouse_resource_usage.' if logger

  raise "Missing the required parameter 'operations_insights_warehouse_id' when calling summarize_operations_insights_warehouse_resource_usage." if operations_insights_warehouse_id.nil?
  raise "Parameter value for 'operations_insights_warehouse_id' must not be blank" if OCI::Internal::Util.blank_string?(operations_insights_warehouse_id)

  path = '/operationsInsightsWarehouses/{operationsInsightsWarehouseId}/resourceUsageSummary'.sub('{operationsInsightsWarehouseId}', operations_insights_warehouse_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable 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: 'OperationsInsightsClient#summarize_operations_insights_warehouse_resource_usage') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Opsi::Models::SummarizeOperationsInsightsWarehouseResourceUsageAggregation'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#summarize_sql_insights(compartment_id, opts = {}) ⇒ `Response`

Note:

Click here to see an example of how to use summarize_sql_insights API.

Query SQL Warehouse to get the performance insights for SQLs taking greater than X% database time for a given time period across the given databases or database types in a compartment and in all sub-compartments if specified.

Parameters:

compartment_id (String) —

The OCID of the compartment.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:retry_config (OCI::Retry::RetryConfig) —

The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry
:database_type (Array<String>) —

Filter by one or more database type. Possible values are ADW-S, ATP-S, ADW-D, ATP-D, EXTERNAL-PDB, EXTERNAL-NONCDB. (default to []) Allowed values are: ADW-S, ATP-S, ADW-D, ATP-D, EXTERNAL-PDB, EXTERNAL-NONCDB, COMANAGED-VM-CDB, COMANAGED-VM-PDB, COMANAGED-VM-NONCDB, COMANAGED-BM-CDB, COMANAGED-BM-PDB, COMANAGED-BM-NONCDB, COMANAGED-EXACS-CDB, COMANAGED-EXACS-PDB, COMANAGED-EXACS-NONCDB
:database_id (Array<String>) —

Optional list of database OCIDs of the associated DBaaS entity. (default to [])
:id (Array<String>) —

Optional list of database insight resource OCIDs. (default to [])
:exadata_insight_id (Array<String>) —

Optional list of exadata insight resource OCIDs. (default to [])
:cdb_name (Array<String>) —

Filter by one or more cdb name. (default to [])
:host_name (Array<String>) —

Filter by one or more hostname. (default to [])
:database_time_pct_greater_than (Float) —

Filter sqls by percentage of db time. (default to 1)
:analysis_time_interval (String) —

Specify time period in ISO 8601 format with respect to current time. Default is last 30 days represented by P30D. If timeInterval is specified, then timeIntervalStart and timeIntervalEnd will be ignored. Examples P90D (last 90 days), P4W (last 4 weeks), P2M (last 2 months), P1Y (last 12 months), . Maximum value allowed is 25 months prior to current time (P25M). (default to P30D)
:time_interval_start (DateTime) —

Analysis start time in UTC in ISO 8601 format(inclusive). Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). The minimum allowed value is 2 years prior to the current day. timeIntervalStart and timeIntervalEnd parameters are used together. If analysisTimeInterval is specified, this parameter is ignored.
:time_interval_end (DateTime) —

Analysis end time in UTC in ISO 8601 format(exclusive). Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). timeIntervalStart and timeIntervalEnd are used together. If timeIntervalEnd is not specified, current time is used as timeIntervalEnd.
:page (String) —

For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination.
:opc_request_id (String) —

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
:defined_tag_equals (Array<String>) —

A list of tag filters to apply. Only resources with a defined tag matching the value will be returned. Each item in the list has the format "namespace.tagName.value". All inputs are case-insensitive. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as "OR". Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as "AND".
:freeform_tag_equals (Array<String>) —

A list of tag filters to apply. Only resources with a freeform tag matching the value will be returned. The key for each tag is "tagName.value". All inputs are case-insensitive. Multiple values for the same tag name are interpreted as "OR". Values for different tag names are interpreted as "AND".
:defined_tag_exists (Array<String>) —

A list of tag existence filters to apply. Only resources for which the specified defined tags exist will be returned. Each item in the list has the format "namespace.tagName.true" (for checking existence of a defined tag) or "namespace.true". All inputs are case-insensitive. Currently, only existence ("true" at the end) is supported. Absence ("false" at the end) is not supported. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as "OR". Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as "AND".
:freeform_tag_exists (Array<String>) —

A list of tag existence filters to apply. Only resources for which the specified freeform tags exist the value will be returned. The key for each tag is "tagName.true". All inputs are case-insensitive. Currently, only existence ("true" at the end) is supported. Absence ("false" at the end) is not supported. Multiple values for different tag names are interpreted as "AND".
:compartment_id_in_subtree (BOOLEAN) —

A flag to search all resources within a given compartment and all sub-compartments. (default to false)
:vmcluster_name (Array<String>) —

Optional list of Exadata Insight VM cluster name. (default to [])

Returns:

(Response) —

A Response object with data of type SqlInsightAggregationCollection

# File 'lib/oci/opsi/operations_insights_client.rb', line 15624

def summarize_sql_insights(compartment_id, opts = {})
  logger.debug 'Calling operation OperationsInsightsClient#summarize_sql_insights.' if logger

  raise "Missing the required parameter 'compartment_id' when calling summarize_sql_insights." if compartment_id.nil?


  database_type_allowable_values = %w[ADW-S ATP-S ADW-D ATP-D EXTERNAL-PDB EXTERNAL-NONCDB COMANAGED-VM-CDB COMANAGED-VM-PDB COMANAGED-VM-NONCDB COMANAGED-BM-CDB COMANAGED-BM-PDB COMANAGED-BM-NONCDB COMANAGED-EXACS-CDB COMANAGED-EXACS-PDB COMANAGED-EXACS-NONCDB]
  if opts[:database_type] && !opts[:database_type].empty?
    opts[:database_type].each do |val_to_check|
      unless database_type_allowable_values.include?(val_to_check)
        raise 'Invalid value for "database_type", must be one of ADW-S, ATP-S, ADW-D, ATP-D, EXTERNAL-PDB, EXTERNAL-NONCDB, COMANAGED-VM-CDB, COMANAGED-VM-PDB, COMANAGED-VM-NONCDB, COMANAGED-BM-CDB, COMANAGED-BM-PDB, COMANAGED-BM-NONCDB, COMANAGED-EXACS-CDB, COMANAGED-EXACS-PDB, COMANAGED-EXACS-NONCDB.'
      end
    end
  end

  path = '/databaseInsights/sqlInsights'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:databaseType] = OCI::ApiClient.build_collection_params(opts[:database_type], :multi) if opts[:database_type] && !opts[:database_type].empty?
  query_params[:databaseId] = OCI::ApiClient.build_collection_params(opts[:database_id], :multi) if opts[:database_id] && !opts[:database_id].empty?
  query_params[:id] = OCI::ApiClient.build_collection_params(opts[:id], :multi) if opts[:id] && !opts[:id].empty?
  query_params[:exadataInsightId] = OCI::ApiClient.build_collection_params(opts[:exadata_insight_id], :multi) if opts[:exadata_insight_id] && !opts[:exadata_insight_id].empty?
  query_params[:cdbName] = OCI::ApiClient.build_collection_params(opts[:cdb_name], :multi) if opts[:cdb_name] && !opts[:cdb_name].empty?
  query_params[:hostName] = OCI::ApiClient.build_collection_params(opts[:host_name], :multi) if opts[:host_name] && !opts[:host_name].empty?
  query_params[:databaseTimePctGreaterThan] = opts[:database_time_pct_greater_than] if opts[:database_time_pct_greater_than]
  query_params[:analysisTimeInterval] = opts[:analysis_time_interval] if opts[:analysis_time_interval]
  query_params[:timeIntervalStart] = opts[:time_interval_start] if opts[:time_interval_start]
  query_params[:timeIntervalEnd] = opts[:time_interval_end] if opts[:time_interval_end]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:definedTagEquals] = OCI::ApiClient.build_collection_params(opts[:defined_tag_equals], :multi) if opts[:defined_tag_equals] && !opts[:defined_tag_equals].empty?
  query_params[:freeformTagEquals] = OCI::ApiClient.build_collection_params(opts[:freeform_tag_equals], :multi) if opts[:freeform_tag_equals] && !opts[:freeform_tag_equals].empty?
  query_params[:definedTagExists] = OCI::ApiClient.build_collection_params(opts[:defined_tag_exists], :multi) if opts[:defined_tag_exists] && !opts[:defined_tag_exists].empty?
  query_params[:freeformTagExists] = OCI::ApiClient.build_collection_params(opts[:freeform_tag_exists], :multi) if opts[:freeform_tag_exists] && !opts[:freeform_tag_exists].empty?
  query_params[:compartmentIdInSubtree] = opts[:compartment_id_in_subtree] if !opts[:compartment_id_in_subtree].nil?
  query_params[:vmclusterName] = OCI::ApiClient.build_collection_params(opts[:vmcluster_name], :multi) if opts[:vmcluster_name] && !opts[:vmcluster_name].empty?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'OperationsInsightsClient#summarize_sql_insights') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Opsi::Models::SqlInsightAggregationCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#summarize_sql_plan_insights(compartment_id, sql_identifier, opts = {}) ⇒ `Response`

Note:

Click here to see an example of how to use summarize_sql_plan_insights API.

Query SQL Warehouse to get the performance insights on the execution plans for a given SQL for a given time period. Either databaseId or id must be specified.

Parameters:

compartment_id (String) —

The OCID of the compartment.
sql_identifier (String) —

Unique SQL_ID for a SQL Statement. Example: 6rgjh9bjmy2s7
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:retry_config (OCI::Retry::RetryConfig) —

The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry
:database_id (String) —

Optional OCID of the associated DBaaS entity.
:id (String) —

OCID of the database insight resource.
:analysis_time_interval (String) —

Specify time period in ISO 8601 format with respect to current time. Default is last 30 days represented by P30D. If timeInterval is specified, then timeIntervalStart and timeIntervalEnd will be ignored. Examples P90D (last 90 days), P4W (last 4 weeks), P2M (last 2 months), P1Y (last 12 months), . Maximum value allowed is 25 months prior to current time (P25M). (default to P30D)
:time_interval_start (DateTime) —

Analysis start time in UTC in ISO 8601 format(inclusive). Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). The minimum allowed value is 2 years prior to the current day. timeIntervalStart and timeIntervalEnd parameters are used together. If analysisTimeInterval is specified, this parameter is ignored.
:time_interval_end (DateTime) —

Analysis end time in UTC in ISO 8601 format(exclusive). Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). timeIntervalStart and timeIntervalEnd are used together. If timeIntervalEnd is not specified, current time is used as timeIntervalEnd.
:page (String) —

For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination.
:opc_request_id (String) —

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:

(Response) —

A Response object with data of type SqlPlanInsightAggregationCollection

# File 'lib/oci/opsi/operations_insights_client.rb', line 15736

def summarize_sql_plan_insights(compartment_id, sql_identifier, opts = {})
  logger.debug 'Calling operation OperationsInsightsClient#summarize_sql_plan_insights.' if logger

  raise "Missing the required parameter 'compartment_id' when calling summarize_sql_plan_insights." if compartment_id.nil?
  raise "Missing the required parameter 'sql_identifier' when calling summarize_sql_plan_insights." if sql_identifier.nil?

  path = '/databaseInsights/sqlPlanInsights'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:sqlIdentifier] = sql_identifier
  query_params[:databaseId] = opts[:database_id] if opts[:database_id]
  query_params[:id] = opts[:id] if opts[:id]
  query_params[:analysisTimeInterval] = opts[:analysis_time_interval] if opts[:analysis_time_interval]
  query_params[:timeIntervalStart] = opts[:time_interval_start] if opts[:time_interval_start]
  query_params[:timeIntervalEnd] = opts[:time_interval_end] if opts[:time_interval_end]
  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: 'OperationsInsightsClient#summarize_sql_plan_insights') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Opsi::Models::SqlPlanInsightAggregationCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#summarize_sql_response_time_distributions(compartment_id, sql_identifier, opts = {}) ⇒ `Response`

Note:

Click here to see an example of how to use summarize_sql_response_time_distributions API.

Query SQL Warehouse to summarize the response time distribution of query executions for a given SQL for a given time period. Either databaseId or id must be specified.

Parameters:

compartment_id (String) —

The OCID of the compartment.
sql_identifier (String) —

Unique SQL_ID for a SQL Statement. Example: 6rgjh9bjmy2s7
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:retry_config (OCI::Retry::RetryConfig) —

The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry
:database_id (String) —

Optional OCID of the associated DBaaS entity.
:id (String) —

OCID of the database insight resource.
:analysis_time_interval (String) —

Specify time period in ISO 8601 format with respect to current time. Default is last 30 days represented by P30D. If timeInterval is specified, then timeIntervalStart and timeIntervalEnd will be ignored. Examples P90D (last 90 days), P4W (last 4 weeks), P2M (last 2 months), P1Y (last 12 months), . Maximum value allowed is 25 months prior to current time (P25M). (default to P30D)
:time_interval_start (DateTime) —

Analysis start time in UTC in ISO 8601 format(inclusive). Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). The minimum allowed value is 2 years prior to the current day. timeIntervalStart and timeIntervalEnd parameters are used together. If analysisTimeInterval is specified, this parameter is ignored.
:time_interval_end (DateTime) —

Analysis end time in UTC in ISO 8601 format(exclusive). Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). timeIntervalStart and timeIntervalEnd are used together. If timeIntervalEnd is not specified, current time is used as timeIntervalEnd.
:page (String) —

For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination.
:opc_request_id (String) —

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:

(Response) —

A Response object with data of type SqlResponseTimeDistributionAggregationCollection

# File 'lib/oci/opsi/operations_insights_client.rb', line 15829

def summarize_sql_response_time_distributions(compartment_id, sql_identifier, opts = {})
  logger.debug 'Calling operation OperationsInsightsClient#summarize_sql_response_time_distributions.' if logger

  raise "Missing the required parameter 'compartment_id' when calling summarize_sql_response_time_distributions." if compartment_id.nil?
  raise "Missing the required parameter 'sql_identifier' when calling summarize_sql_response_time_distributions." if sql_identifier.nil?

  path = '/databaseInsights/sqlResponseTimeDistributions'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:sqlIdentifier] = sql_identifier
  query_params[:databaseId] = opts[:database_id] if opts[:database_id]
  query_params[:id] = opts[:id] if opts[:id]
  query_params[:analysisTimeInterval] = opts[:analysis_time_interval] if opts[:analysis_time_interval]
  query_params[:timeIntervalStart] = opts[:time_interval_start] if opts[:time_interval_start]
  query_params[:timeIntervalEnd] = opts[:time_interval_end] if opts[:time_interval_end]
  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: 'OperationsInsightsClient#summarize_sql_response_time_distributions') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Opsi::Models::SqlResponseTimeDistributionAggregationCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#summarize_sql_statistics(compartment_id, opts = {}) ⇒ `Response`

Note:

Click here to see an example of how to use summarize_sql_statistics API.

Query SQL Warehouse to get the performance statistics for SQLs taking greater than X% database time for a given time period across the given databases or database types in a compartment and in all sub-compartments if specified.

Allowed values are: DEGRADING, VARIANT, INEFFICIENT, CHANGING_PLANS, IMPROVING, DEGRADING_VARIANT, DEGRADING_INEFFICIENT, DEGRADING_CHANGING_PLANS, DEGRADING_INCREASING_IO, DEGRADING_INCREASING_CPU, DEGRADING_INCREASING_INEFFICIENT_WAIT, DEGRADING_CHANGING_PLANS_AND_INCREASING_IO, DEGRADING_CHANGING_PLANS_AND_INCREASING_CPU, DEGRADING_CHANGING_PLANS_AND_INCREASING_INEFFICIENT_WAIT, VARIANT_INEFFICIENT, VARIANT_CHANGING_PLANS, VARIANT_INCREASING_IO, VARIANT_INCREASING_CPU, VARIANT_INCREASING_INEFFICIENT_WAIT, VARIANT_CHANGING_PLANS_AND_INCREASING_IO, VARIANT_CHANGING_PLANS_AND_INCREASING_CPU, VARIANT_CHANGING_PLANS_AND_INCREASING_INEFFICIENT_WAIT, INEFFICIENT_CHANGING_PLANS, INEFFICIENT_INCREASING_INEFFICIENT_WAIT, INEFFICIENT_CHANGING_PLANS_AND_INCREASING_INEFFICIENT_WAIT

Parameters:

compartment_id (String) —

The OCID of the compartment.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:retry_config (OCI::Retry::RetryConfig) —

The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry
:database_type (Array<String>) —

Filter by one or more database type. Possible values are ADW-S, ATP-S, ADW-D, ATP-D, EXTERNAL-PDB, EXTERNAL-NONCDB. (default to []) Allowed values are: ADW-S, ATP-S, ADW-D, ATP-D, EXTERNAL-PDB, EXTERNAL-NONCDB, COMANAGED-VM-CDB, COMANAGED-VM-PDB, COMANAGED-VM-NONCDB, COMANAGED-BM-CDB, COMANAGED-BM-PDB, COMANAGED-BM-NONCDB, COMANAGED-EXACS-CDB, COMANAGED-EXACS-PDB, COMANAGED-EXACS-NONCDB
:database_id (Array<String>) —

Optional list of database OCIDs of the associated DBaaS entity. (default to [])
:id (Array<String>) —

Optional list of database insight resource OCIDs. (default to [])
:exadata_insight_id (Array<String>) —

Optional list of exadata insight resource OCIDs. (default to [])
:cdb_name (Array<String>) —

Filter by one or more cdb name. (default to [])
:host_name (Array<String>) —

Filter by one or more hostname. (default to [])
:database_time_pct_greater_than (Float) —

Filter sqls by percentage of db time. (default to 1)
:sql_identifier (Array<String>) —

One or more unique SQL_IDs for a SQL Statement. Example: 6rgjh9bjmy2s7 (default to [])
:analysis_time_interval (String) —

Specify time period in ISO 8601 format with respect to current time. Default is last 30 days represented by P30D. If timeInterval is specified, then timeIntervalStart and timeIntervalEnd will be ignored. Examples P90D (last 90 days), P4W (last 4 weeks), P2M (last 2 months), P1Y (last 12 months), . Maximum value allowed is 25 months prior to current time (P25M). (default to P30D)
:time_interval_start (DateTime) —

Analysis start time in UTC in ISO 8601 format(inclusive). Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). The minimum allowed value is 2 years prior to the current day. timeIntervalStart and timeIntervalEnd parameters are used together. If analysisTimeInterval is specified, this parameter is ignored.
:time_interval_end (DateTime) —

Analysis end time in UTC in ISO 8601 format(exclusive). Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). timeIntervalStart and timeIntervalEnd are used together. If timeIntervalEnd is not specified, current time is used as timeIntervalEnd.
:limit (Integer) —

For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see List Pagination. Example: 50 (default to 50)
:page (String) —

For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination.
:opc_request_id (String) —

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
:sort_order (String) —

The sort order to use, either ascending (ASC) or descending (DESC).
:sort_by (String) —

The field to use when sorting SQL statistics. Example: databaseTimeInSec (default to databaseTimeInSec) Allowed values are: databaseTimeInSec, executionsPerHour, executionsCount, cpuTimeInSec, ioTimeInSec, inefficientWaitTimeInSec, responseTimeInSec, planCount, variability, averageActiveSessions, databaseTimePct, inefficiencyInPct, changeInCpuTimeInPct, changeInIoTimeInPct, changeInInefficientWaitTimeInPct, changeInResponseTimeInPct, changeInAverageActiveSessionsInPct, changeInExecutionsPerHourInPct, changeInInefficiencyInPct
:category (Array<String>) —

Filter sqls by one or more performance categories. (default to [])
:defined_tag_equals (Array<String>) —

A list of tag filters to apply. Only resources with a defined tag matching the value will be returned. Each item in the list has the format "namespace.tagName.value". All inputs are case-insensitive. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as "OR". Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as "AND".
:freeform_tag_equals (Array<String>) —

A list of tag filters to apply. Only resources with a freeform tag matching the value will be returned. The key for each tag is "tagName.value". All inputs are case-insensitive. Multiple values for the same tag name are interpreted as "OR". Values for different tag names are interpreted as "AND".
:defined_tag_exists (Array<String>) —

A list of tag existence filters to apply. Only resources for which the specified defined tags exist will be returned. Each item in the list has the format "namespace.tagName.true" (for checking existence of a defined tag) or "namespace.true". All inputs are case-insensitive. Currently, only existence ("true" at the end) is supported. Absence ("false" at the end) is not supported. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as "OR". Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as "AND".
:freeform_tag_exists (Array<String>) —

A list of tag existence filters to apply. Only resources for which the specified freeform tags exist the value will be returned. The key for each tag is "tagName.true". All inputs are case-insensitive. Currently, only existence ("true" at the end) is supported. Absence ("false" at the end) is not supported. Multiple values for different tag names are interpreted as "AND".
:compartment_id_in_subtree (BOOLEAN) —

A flag to search all resources within a given compartment and all sub-compartments. (default to false)
:vmcluster_name (Array<String>) —

Optional list of Exadata Insight VM cluster name. (default to [])

Returns:

(Response) —

A Response object with data of type SqlStatisticAggregationCollection

# File 'lib/oci/opsi/operations_insights_client.rb', line 15974

def summarize_sql_statistics(compartment_id, opts = {})
  logger.debug 'Calling operation OperationsInsightsClient#summarize_sql_statistics.' if logger

  raise "Missing the required parameter 'compartment_id' when calling summarize_sql_statistics." if compartment_id.nil?


  database_type_allowable_values = %w[ADW-S ATP-S ADW-D ATP-D EXTERNAL-PDB EXTERNAL-NONCDB COMANAGED-VM-CDB COMANAGED-VM-PDB COMANAGED-VM-NONCDB COMANAGED-BM-CDB COMANAGED-BM-PDB COMANAGED-BM-NONCDB COMANAGED-EXACS-CDB COMANAGED-EXACS-PDB COMANAGED-EXACS-NONCDB]
  if opts[:database_type] && !opts[:database_type].empty?
    opts[:database_type].each do |val_to_check|
      unless database_type_allowable_values.include?(val_to_check)
        raise 'Invalid value for "database_type", must be one of ADW-S, ATP-S, ADW-D, ATP-D, EXTERNAL-PDB, EXTERNAL-NONCDB, COMANAGED-VM-CDB, COMANAGED-VM-PDB, COMANAGED-VM-NONCDB, COMANAGED-BM-CDB, COMANAGED-BM-PDB, COMANAGED-BM-NONCDB, COMANAGED-EXACS-CDB, COMANAGED-EXACS-PDB, COMANAGED-EXACS-NONCDB.'
      end
    end
  end

  if opts[:sort_order] && !OCI::Opsi::Models::SORT_ORDER_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::Opsi::Models::SORT_ORDER_ENUM.'
  end

  if opts[:sort_by] && !%w[databaseTimeInSec executionsPerHour executionsCount cpuTimeInSec ioTimeInSec inefficientWaitTimeInSec responseTimeInSec planCount variability averageActiveSessions databaseTimePct inefficiencyInPct changeInCpuTimeInPct changeInIoTimeInPct changeInInefficientWaitTimeInPct changeInResponseTimeInPct changeInAverageActiveSessionsInPct changeInExecutionsPerHourInPct changeInInefficiencyInPct].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of databaseTimeInSec, executionsPerHour, executionsCount, cpuTimeInSec, ioTimeInSec, inefficientWaitTimeInSec, responseTimeInSec, planCount, variability, averageActiveSessions, databaseTimePct, inefficiencyInPct, changeInCpuTimeInPct, changeInIoTimeInPct, changeInInefficientWaitTimeInPct, changeInResponseTimeInPct, changeInAverageActiveSessionsInPct, changeInExecutionsPerHourInPct, changeInInefficiencyInPct.'
  end


  category_allowable_values = %w[DEGRADING VARIANT INEFFICIENT CHANGING_PLANS IMPROVING DEGRADING_VARIANT DEGRADING_INEFFICIENT DEGRADING_CHANGING_PLANS DEGRADING_INCREASING_IO DEGRADING_INCREASING_CPU DEGRADING_INCREASING_INEFFICIENT_WAIT DEGRADING_CHANGING_PLANS_AND_INCREASING_IO DEGRADING_CHANGING_PLANS_AND_INCREASING_CPU DEGRADING_CHANGING_PLANS_AND_INCREASING_INEFFICIENT_WAIT VARIANT_INEFFICIENT VARIANT_CHANGING_PLANS VARIANT_INCREASING_IO VARIANT_INCREASING_CPU VARIANT_INCREASING_INEFFICIENT_WAIT VARIANT_CHANGING_PLANS_AND_INCREASING_IO VARIANT_CHANGING_PLANS_AND_INCREASING_CPU VARIANT_CHANGING_PLANS_AND_INCREASING_INEFFICIENT_WAIT INEFFICIENT_CHANGING_PLANS INEFFICIENT_INCREASING_INEFFICIENT_WAIT INEFFICIENT_CHANGING_PLANS_AND_INCREASING_INEFFICIENT_WAIT]
  if opts[:category] && !opts[:category].empty?
    opts[:category].each do |val_to_check|
      unless category_allowable_values.include?(val_to_check)
        raise 'Invalid value for "category", must be one of DEGRADING, VARIANT, INEFFICIENT, CHANGING_PLANS, IMPROVING, DEGRADING_VARIANT, DEGRADING_INEFFICIENT, DEGRADING_CHANGING_PLANS, DEGRADING_INCREASING_IO, DEGRADING_INCREASING_CPU, DEGRADING_INCREASING_INEFFICIENT_WAIT, DEGRADING_CHANGING_PLANS_AND_INCREASING_IO, DEGRADING_CHANGING_PLANS_AND_INCREASING_CPU, DEGRADING_CHANGING_PLANS_AND_INCREASING_INEFFICIENT_WAIT, VARIANT_INEFFICIENT, VARIANT_CHANGING_PLANS, VARIANT_INCREASING_IO, VARIANT_INCREASING_CPU, VARIANT_INCREASING_INEFFICIENT_WAIT, VARIANT_CHANGING_PLANS_AND_INCREASING_IO, VARIANT_CHANGING_PLANS_AND_INCREASING_CPU, VARIANT_CHANGING_PLANS_AND_INCREASING_INEFFICIENT_WAIT, INEFFICIENT_CHANGING_PLANS, INEFFICIENT_INCREASING_INEFFICIENT_WAIT, INEFFICIENT_CHANGING_PLANS_AND_INCREASING_INEFFICIENT_WAIT.'
      end
    end
  end

  path = '/databaseInsights/sqlStatistics'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:databaseType] = OCI::ApiClient.build_collection_params(opts[:database_type], :multi) if opts[:database_type] && !opts[:database_type].empty?
  query_params[:databaseId] = OCI::ApiClient.build_collection_params(opts[:database_id], :multi) if opts[:database_id] && !opts[:database_id].empty?
  query_params[:id] = OCI::ApiClient.build_collection_params(opts[:id], :multi) if opts[:id] && !opts[:id].empty?
  query_params[:exadataInsightId] = OCI::ApiClient.build_collection_params(opts[:exadata_insight_id], :multi) if opts[:exadata_insight_id] && !opts[:exadata_insight_id].empty?
  query_params[:cdbName] = OCI::ApiClient.build_collection_params(opts[:cdb_name], :multi) if opts[:cdb_name] && !opts[:cdb_name].empty?
  query_params[:hostName] = OCI::ApiClient.build_collection_params(opts[:host_name], :multi) if opts[:host_name] && !opts[:host_name].empty?
  query_params[:databaseTimePctGreaterThan] = opts[:database_time_pct_greater_than] if opts[:database_time_pct_greater_than]
  query_params[:sqlIdentifier] = OCI::ApiClient.build_collection_params(opts[:sql_identifier], :multi) if opts[:sql_identifier] && !opts[:sql_identifier].empty?
  query_params[:analysisTimeInterval] = opts[:analysis_time_interval] if opts[:analysis_time_interval]
  query_params[:timeIntervalStart] = opts[:time_interval_start] if opts[:time_interval_start]
  query_params[:timeIntervalEnd] = opts[:time_interval_end] if opts[:time_interval_end]
  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[:category] = OCI::ApiClient.build_collection_params(opts[:category], :multi) if opts[:category] && !opts[:category].empty?
  query_params[:definedTagEquals] = OCI::ApiClient.build_collection_params(opts[:defined_tag_equals], :multi) if opts[:defined_tag_equals] && !opts[:defined_tag_equals].empty?
  query_params[:freeformTagEquals] = OCI::ApiClient.build_collection_params(opts[:freeform_tag_equals], :multi) if opts[:freeform_tag_equals] && !opts[:freeform_tag_equals].empty?
  query_params[:definedTagExists] = OCI::ApiClient.build_collection_params(opts[:defined_tag_exists], :multi) if opts[:defined_tag_exists] && !opts[:defined_tag_exists].empty?
  query_params[:freeformTagExists] = OCI::ApiClient.build_collection_params(opts[:freeform_tag_exists], :multi) if opts[:freeform_tag_exists] && !opts[:freeform_tag_exists].empty?
  query_params[:compartmentIdInSubtree] = opts[:compartment_id_in_subtree] if !opts[:compartment_id_in_subtree].nil?
  query_params[:vmclusterName] = OCI::ApiClient.build_collection_params(opts[:vmcluster_name], :multi) if opts[:vmcluster_name] && !opts[:vmcluster_name].empty?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'OperationsInsightsClient#summarize_sql_statistics') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Opsi::Models::SqlStatisticAggregationCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#summarize_sql_statistics_time_series(compartment_id, sql_identifier, opts = {}) ⇒ `Response`

Note:

Click here to see an example of how to use summarize_sql_statistics_time_series API.

Query SQL Warehouse to get the performance statistics time series for a given SQL across given databases for a given time period in a compartment and in all sub-compartments if specified.

Parameters:

compartment_id (String) —

The OCID of the compartment.
sql_identifier (String) —

Unique SQL_ID for a SQL Statement. Example: 6rgjh9bjmy2s7
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:retry_config (OCI::Retry::RetryConfig) —

The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry
:database_id (Array<String>) —

Optional list of database OCIDs of the associated DBaaS entity. (default to [])
:id (Array<String>) —

Optional list of database OCIDs of the database insight resource. (default to [])
:exadata_insight_id (Array<String>) —

Optional list of exadata insight resource OCIDs. (default to [])
:cdb_name (Array<String>) —

Filter by one or more cdb name. (default to [])
:host_name (Array<String>) —

Filter by one or more hostname. (default to [])
:analysis_time_interval (String) —

Specify time period in ISO 8601 format with respect to current time. Default is last 30 days represented by P30D. If timeInterval is specified, then timeIntervalStart and timeIntervalEnd will be ignored. Examples P90D (last 90 days), P4W (last 4 weeks), P2M (last 2 months), P1Y (last 12 months), . Maximum value allowed is 25 months prior to current time (P25M). (default to P30D)
:time_interval_start (DateTime) —

Analysis start time in UTC in ISO 8601 format(inclusive). Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). The minimum allowed value is 2 years prior to the current day. timeIntervalStart and timeIntervalEnd parameters are used together. If analysisTimeInterval is specified, this parameter is ignored.
:time_interval_end (DateTime) —

Analysis end time in UTC in ISO 8601 format(exclusive). Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). timeIntervalStart and timeIntervalEnd are used together. If timeIntervalEnd is not specified, current time is used as timeIntervalEnd.
:page (String) —

For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination.
:opc_request_id (String) —

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
:defined_tag_equals (Array<String>) —

A list of tag filters to apply. Only resources with a defined tag matching the value will be returned. Each item in the list has the format "namespace.tagName.value". All inputs are case-insensitive. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as "OR". Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as "AND".
:freeform_tag_equals (Array<String>) —

A list of tag filters to apply. Only resources with a freeform tag matching the value will be returned. The key for each tag is "tagName.value". All inputs are case-insensitive. Multiple values for the same tag name are interpreted as "OR". Values for different tag names are interpreted as "AND".
:defined_tag_exists (Array<String>) —

A list of tag existence filters to apply. Only resources for which the specified defined tags exist will be returned. Each item in the list has the format "namespace.tagName.true" (for checking existence of a defined tag) or "namespace.true". All inputs are case-insensitive. Currently, only existence ("true" at the end) is supported. Absence ("false" at the end) is not supported. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as "OR". Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as "AND".
:freeform_tag_exists (Array<String>) —

A list of tag existence filters to apply. Only resources for which the specified freeform tags exist the value will be returned. The key for each tag is "tagName.true". All inputs are case-insensitive. Currently, only existence ("true" at the end) is supported. Absence ("false" at the end) is not supported. Multiple values for different tag names are interpreted as "AND".
:compartment_id_in_subtree (BOOLEAN) —

A flag to search all resources within a given compartment and all sub-compartments. (default to false)
:vmcluster_name (Array<String>) —

Optional list of Exadata Insight VM cluster name. (default to [])

Returns:

(Response) —

A Response object with data of type SqlStatisticsTimeSeriesAggregationCollection

# File 'lib/oci/opsi/operations_insights_client.rb', line 16140

def summarize_sql_statistics_time_series(compartment_id, sql_identifier, opts = {})
  logger.debug 'Calling operation OperationsInsightsClient#summarize_sql_statistics_time_series.' if logger

  raise "Missing the required parameter 'compartment_id' when calling summarize_sql_statistics_time_series." if compartment_id.nil?
  raise "Missing the required parameter 'sql_identifier' when calling summarize_sql_statistics_time_series." if sql_identifier.nil?

  path = '/databaseInsights/sqlStatisticsTimeSeries'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:sqlIdentifier] = sql_identifier
  query_params[:databaseId] = OCI::ApiClient.build_collection_params(opts[:database_id], :multi) if opts[:database_id] && !opts[:database_id].empty?
  query_params[:id] = OCI::ApiClient.build_collection_params(opts[:id], :multi) if opts[:id] && !opts[:id].empty?
  query_params[:exadataInsightId] = OCI::ApiClient.build_collection_params(opts[:exadata_insight_id], :multi) if opts[:exadata_insight_id] && !opts[:exadata_insight_id].empty?
  query_params[:cdbName] = OCI::ApiClient.build_collection_params(opts[:cdb_name], :multi) if opts[:cdb_name] && !opts[:cdb_name].empty?
  query_params[:hostName] = OCI::ApiClient.build_collection_params(opts[:host_name], :multi) if opts[:host_name] && !opts[:host_name].empty?
  query_params[:analysisTimeInterval] = opts[:analysis_time_interval] if opts[:analysis_time_interval]
  query_params[:timeIntervalStart] = opts[:time_interval_start] if opts[:time_interval_start]
  query_params[:timeIntervalEnd] = opts[:time_interval_end] if opts[:time_interval_end]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:definedTagEquals] = OCI::ApiClient.build_collection_params(opts[:defined_tag_equals], :multi) if opts[:defined_tag_equals] && !opts[:defined_tag_equals].empty?
  query_params[:freeformTagEquals] = OCI::ApiClient.build_collection_params(opts[:freeform_tag_equals], :multi) if opts[:freeform_tag_equals] && !opts[:freeform_tag_equals].empty?
  query_params[:definedTagExists] = OCI::ApiClient.build_collection_params(opts[:defined_tag_exists], :multi) if opts[:defined_tag_exists] && !opts[:defined_tag_exists].empty?
  query_params[:freeformTagExists] = OCI::ApiClient.build_collection_params(opts[:freeform_tag_exists], :multi) if opts[:freeform_tag_exists] && !opts[:freeform_tag_exists].empty?
  query_params[:compartmentIdInSubtree] = opts[:compartment_id_in_subtree] if !opts[:compartment_id_in_subtree].nil?
  query_params[:vmclusterName] = OCI::ApiClient.build_collection_params(opts[:vmcluster_name], :multi) if opts[:vmcluster_name] && !opts[:vmcluster_name].empty?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'OperationsInsightsClient#summarize_sql_statistics_time_series') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Opsi::Models::SqlStatisticsTimeSeriesAggregationCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#summarize_sql_statistics_time_series_by_plan(compartment_id, sql_identifier, opts = {}) ⇒ `Response`

Note:

Click here to see an example of how to use summarize_sql_statistics_time_series_by_plan API.

Query SQL Warehouse to get the performance statistics time series for a given SQL by execution plans for a given time period. Either databaseId or id must be specified.

Parameters:

compartment_id (String) —

The OCID of the compartment.
sql_identifier (String) —

Unique SQL_ID for a SQL Statement. Example: 6rgjh9bjmy2s7
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:retry_config (OCI::Retry::RetryConfig) —

The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry
:database_id (String) —

Optional OCID of the associated DBaaS entity.
:id (String) —

OCID of the database insight resource.
:analysis_time_interval (String) —

Specify time period in ISO 8601 format with respect to current time. Default is last 30 days represented by P30D. If timeInterval is specified, then timeIntervalStart and timeIntervalEnd will be ignored. Examples P90D (last 90 days), P4W (last 4 weeks), P2M (last 2 months), P1Y (last 12 months), . Maximum value allowed is 25 months prior to current time (P25M). (default to P30D)
:time_interval_start (DateTime) —

Analysis start time in UTC in ISO 8601 format(inclusive). Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). The minimum allowed value is 2 years prior to the current day. timeIntervalStart and timeIntervalEnd parameters are used together. If analysisTimeInterval is specified, this parameter is ignored.
:time_interval_end (DateTime) —

Analysis end time in UTC in ISO 8601 format(exclusive). Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). timeIntervalStart and timeIntervalEnd are used together. If timeIntervalEnd is not specified, current time is used as timeIntervalEnd.
:page (String) —

For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination.
:opc_request_id (String) —

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:

(Response) —

A Response object with data of type SqlStatisticsTimeSeriesByPlanAggregationCollection

# File 'lib/oci/opsi/operations_insights_client.rb', line 16242

def summarize_sql_statistics_time_series_by_plan(compartment_id, sql_identifier, opts = {})
  logger.debug 'Calling operation OperationsInsightsClient#summarize_sql_statistics_time_series_by_plan.' if logger

  raise "Missing the required parameter 'compartment_id' when calling summarize_sql_statistics_time_series_by_plan." if compartment_id.nil?
  raise "Missing the required parameter 'sql_identifier' when calling summarize_sql_statistics_time_series_by_plan." if sql_identifier.nil?

  path = '/databaseInsights/sqlStatisticsTimeSeriesByPlan'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:sqlIdentifier] = sql_identifier
  query_params[:databaseId] = opts[:database_id] if opts[:database_id]
  query_params[:id] = opts[:id] if opts[:id]
  query_params[:analysisTimeInterval] = opts[:analysis_time_interval] if opts[:analysis_time_interval]
  query_params[:timeIntervalStart] = opts[:time_interval_start] if opts[:time_interval_start]
  query_params[:timeIntervalEnd] = opts[:time_interval_end] if opts[:time_interval_end]
  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: 'OperationsInsightsClient#summarize_sql_statistics_time_series_by_plan') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Opsi::Models::SqlStatisticsTimeSeriesByPlanAggregationCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_awr_hub(awr_hub_id, update_awr_hub_details, opts = {}) ⇒ `Response`

Note:

Click here to see an example of how to use update_awr_hub API.

Updates the configuration of a hub .

Parameters:

awr_hub_id (String) —

Unique Awr Hub identifier
update_awr_hub_details (OCI::Opsi::Models::UpdateAwrHubDetails) —

The configuration 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) —

Used for optimistic concurrency control. In the update or delete call for a resource, set the if-match parameter to the value of the etag from a previous get, create, or update response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
:opc_request_id (String) —

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:

(Response) —

A Response object with data of type nil

# File 'lib/oci/opsi/operations_insights_client.rb', line 16311

def update_awr_hub(awr_hub_id, update_awr_hub_details, opts = {})
  logger.debug 'Calling operation OperationsInsightsClient#update_awr_hub.' if logger

  raise "Missing the required parameter 'awr_hub_id' when calling update_awr_hub." if awr_hub_id.nil?
  raise "Missing the required parameter 'update_awr_hub_details' when calling update_awr_hub." if update_awr_hub_details.nil?
  raise "Parameter value for 'awr_hub_id' must not be blank" if OCI::Internal::Util.blank_string?(awr_hub_id)

  path = '/awrHubs/{awrHubId}'.sub('{awrHubId}', awr_hub_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_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_awr_hub_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'OperationsInsightsClient#update_awr_hub') 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_awr_hub_source(update_awr_hub_source_details, awr_hub_source_id, opts = {}) ⇒ `Response`

Note:

Click here to see an example of how to use update_awr_hub_source API.

Update Awr Hub Source object.

Parameters:

update_awr_hub_source_details (OCI::Opsi::Models::UpdateAwrHubSourceDetails) —

The configuration to be updated.
awr_hub_source_id (String) —

Unique Awr Hub Source identifier
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:retry_config (OCI::Retry::RetryConfig) —

The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry
:if_match (String) —

Used for optimistic concurrency control. In the update or delete call for a resource, set the if-match parameter to the value of the etag from a previous get, create, or update response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
:opc_request_id (String) —

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:

(Response) —

A Response object with data of type nil

# File 'lib/oci/opsi/operations_insights_client.rb', line 16373

def update_awr_hub_source(update_awr_hub_source_details, awr_hub_source_id, opts = {})
  logger.debug 'Calling operation OperationsInsightsClient#update_awr_hub_source.' if logger

  raise "Missing the required parameter 'update_awr_hub_source_details' when calling update_awr_hub_source." if update_awr_hub_source_details.nil?
  raise "Missing the required parameter 'awr_hub_source_id' when calling update_awr_hub_source." if awr_hub_source_id.nil?
  raise "Parameter value for 'awr_hub_source_id' must not be blank" if OCI::Internal::Util.blank_string?(awr_hub_source_id)

  path = '/awrHubSources/{awrHubSourceId}'.sub('{awrHubSourceId}', awr_hub_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 = @api_client.object_to_http_body(update_awr_hub_source_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'OperationsInsightsClient#update_awr_hub_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_database_insight(database_insight_id, update_database_insight_details, opts = {}) ⇒ `Response`

Note:

Click here to see an example of how to use update_database_insight API.

Updates configuration of a database insight.

Parameters:

database_insight_id (String) —

Unique database insight identifier
update_database_insight_details (OCI::Opsi::Models::UpdateDatabaseInsightDetails) —

The configuration 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) —

Used for optimistic concurrency control. In the update or delete call for a resource, set the if-match parameter to the value of the etag from a previous get, create, or update response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
:opc_request_id (String) —

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:

(Response) —

A Response object with data of type nil

# File 'lib/oci/opsi/operations_insights_client.rb', line 16435

def update_database_insight(database_insight_id, update_database_insight_details, opts = {})
  logger.debug 'Calling operation OperationsInsightsClient#update_database_insight.' if logger

  raise "Missing the required parameter 'database_insight_id' when calling update_database_insight." if database_insight_id.nil?
  raise "Missing the required parameter 'update_database_insight_details' when calling update_database_insight." if update_database_insight_details.nil?
  raise "Parameter value for 'database_insight_id' must not be blank" if OCI::Internal::Util.blank_string?(database_insight_id)

  path = '/databaseInsights/{databaseInsightId}'.sub('{databaseInsightId}', database_insight_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(update_database_insight_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'OperationsInsightsClient#update_database_insight') 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_enterprise_manager_bridge(enterprise_manager_bridge_id, update_enterprise_manager_bridge_details, opts = {}) ⇒ `Response`

Note:

Click here to see an example of how to use update_enterprise_manager_bridge API.

Updates configuration of an Operations Insights Enterprise Manager bridge.

Parameters:

enterprise_manager_bridge_id (String) —

Unique Enterprise Manager bridge identifier
update_enterprise_manager_bridge_details (OCI::Opsi::Models::UpdateEnterpriseManagerBridgeDetails) —

The configuration 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) —

Used for optimistic concurrency control. In the update or delete call for a resource, set the if-match parameter to the value of the etag from a previous get, create, or update response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
:opc_request_id (String) —

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:

(Response) —

A Response object with data of type nil

# File 'lib/oci/opsi/operations_insights_client.rb', line 16497

def update_enterprise_manager_bridge(enterprise_manager_bridge_id, update_enterprise_manager_bridge_details, opts = {})
  logger.debug 'Calling operation OperationsInsightsClient#update_enterprise_manager_bridge.' if logger

  raise "Missing the required parameter 'enterprise_manager_bridge_id' when calling update_enterprise_manager_bridge." if enterprise_manager_bridge_id.nil?
  raise "Missing the required parameter 'update_enterprise_manager_bridge_details' when calling update_enterprise_manager_bridge." if update_enterprise_manager_bridge_details.nil?
  raise "Parameter value for 'enterprise_manager_bridge_id' must not be blank" if OCI::Internal::Util.blank_string?(enterprise_manager_bridge_id)

  path = '/enterpriseManagerBridges/{enterpriseManagerBridgeId}'.sub('{enterpriseManagerBridgeId}', enterprise_manager_bridge_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_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_enterprise_manager_bridge_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'OperationsInsightsClient#update_enterprise_manager_bridge') 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_exadata_insight(exadata_insight_id, update_exadata_insight_details, opts = {}) ⇒ `Response`

Note:

Click here to see an example of how to use update_exadata_insight API.

Updates configuration of an Exadata insight.

Parameters:

exadata_insight_id (String) —

Unique Exadata insight identifier
update_exadata_insight_details (OCI::Opsi::Models::UpdateExadataInsightDetails) —

The configuration 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) —

Used for optimistic concurrency control. In the update or delete call for a resource, set the if-match parameter to the value of the etag from a previous get, create, or update response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
:opc_request_id (String) —

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:

(Response) —

A Response object with data of type nil

# File 'lib/oci/opsi/operations_insights_client.rb', line 16559

def update_exadata_insight(exadata_insight_id, update_exadata_insight_details, opts = {})
  logger.debug 'Calling operation OperationsInsightsClient#update_exadata_insight.' if logger

  raise "Missing the required parameter 'exadata_insight_id' when calling update_exadata_insight." if exadata_insight_id.nil?
  raise "Missing the required parameter 'update_exadata_insight_details' when calling update_exadata_insight." if update_exadata_insight_details.nil?
  raise "Parameter value for 'exadata_insight_id' must not be blank" if OCI::Internal::Util.blank_string?(exadata_insight_id)

  path = '/exadataInsights/{exadataInsightId}'.sub('{exadataInsightId}', exadata_insight_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_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_exadata_insight_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'OperationsInsightsClient#update_exadata_insight') 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_host_insight(host_insight_id, update_host_insight_details, opts = {}) ⇒ `Response`

Note:

Click here to see an example of how to use update_host_insight API.

Updates configuration of a host insight.

Parameters:

host_insight_id (String) —

Unique host insight identifier
update_host_insight_details (OCI::Opsi::Models::UpdateHostInsightDetails) —

The configuration 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) —

Used for optimistic concurrency control. In the update or delete call for a resource, set the if-match parameter to the value of the etag from a previous get, create, or update response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
:opc_request_id (String) —

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:

(Response) —

A Response object with data of type nil

# File 'lib/oci/opsi/operations_insights_client.rb', line 16621

def update_host_insight(host_insight_id, update_host_insight_details, opts = {})
  logger.debug 'Calling operation OperationsInsightsClient#update_host_insight.' if logger

  raise "Missing the required parameter 'host_insight_id' when calling update_host_insight." if host_insight_id.nil?
  raise "Missing the required parameter 'update_host_insight_details' when calling update_host_insight." if update_host_insight_details.nil?
  raise "Parameter value for 'host_insight_id' must not be blank" if OCI::Internal::Util.blank_string?(host_insight_id)

  path = '/hostInsights/{hostInsightId}'.sub('{hostInsightId}', host_insight_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_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_host_insight_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'OperationsInsightsClient#update_host_insight') 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_news_report(news_report_id, update_news_report_details, opts = {}) ⇒ `Response`

Note:

Click here to see an example of how to use update_news_report API.

Updates the configuration of a news report.

Parameters:

news_report_id (String) —

Unique news report identifier.
update_news_report_details (OCI::Opsi::Models::UpdateNewsReportDetails) —

The configuration 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) —

Used for optimistic concurrency control. In the update or delete call for a resource, set the if-match parameter to the value of the etag from a previous get, create, or update response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
:opc_request_id (String) —

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:

(Response) —

A Response object with data of type nil

# File 'lib/oci/opsi/operations_insights_client.rb', line 16683

def update_news_report(news_report_id, update_news_report_details, opts = {})
  logger.debug 'Calling operation OperationsInsightsClient#update_news_report.' if logger

  raise "Missing the required parameter 'news_report_id' when calling update_news_report." if news_report_id.nil?
  raise "Missing the required parameter 'update_news_report_details' when calling update_news_report." if update_news_report_details.nil?
  raise "Parameter value for 'news_report_id' must not be blank" if OCI::Internal::Util.blank_string?(news_report_id)

  path = '/newsReports/{newsReportId}'.sub('{newsReportId}', news_report_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(update_news_report_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'OperationsInsightsClient#update_news_report') do
    @api_client.call_api(
      :PUT,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_operations_insights_private_endpoint(operations_insights_private_endpoint_id, update_operations_insights_private_endpoint_details, opts = {}) ⇒ `Response`

Note:

Click here to see an example of how to use update_operations_insights_private_endpoint API.

Updates one or more attributes of the specified private endpoint.

Parameters:

operations_insights_private_endpoint_id (String) —

The OCID of the Operation Insights private endpoint.
update_operations_insights_private_endpoint_details (OCI::Opsi::Models::UpdateOperationsInsightsPrivateEndpointDetails) —

The details used to update a private endpoint.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:retry_config (OCI::Retry::RetryConfig) —

The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry
:if_match (String) —

Used for optimistic concurrency control. In the update or delete call for a resource, set the if-match parameter to the value of the etag from a previous get, create, or update response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
:opc_request_id (String) —

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:

(Response) —

A Response object with data of type nil

# File 'lib/oci/opsi/operations_insights_client.rb', line 16745

def update_operations_insights_private_endpoint(operations_insights_private_endpoint_id, update_operations_insights_private_endpoint_details, opts = {})
  logger.debug 'Calling operation OperationsInsightsClient#update_operations_insights_private_endpoint.' if logger

  raise "Missing the required parameter 'operations_insights_private_endpoint_id' when calling update_operations_insights_private_endpoint." if operations_insights_private_endpoint_id.nil?
  raise "Missing the required parameter 'update_operations_insights_private_endpoint_details' when calling update_operations_insights_private_endpoint." if update_operations_insights_private_endpoint_details.nil?
  raise "Parameter value for 'operations_insights_private_endpoint_id' must not be blank" if OCI::Internal::Util.blank_string?(operations_insights_private_endpoint_id)

  path = '/operationsInsightsPrivateEndpoints/{operationsInsightsPrivateEndpointId}'.sub('{operationsInsightsPrivateEndpointId}', operations_insights_private_endpoint_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(update_operations_insights_private_endpoint_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'OperationsInsightsClient#update_operations_insights_private_endpoint') do
    @api_client.call_api(
      :PUT,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_operations_insights_warehouse(operations_insights_warehouse_id, update_operations_insights_warehouse_details, opts = {}) ⇒ `Response`

Note:

Click here to see an example of how to use update_operations_insights_warehouse API.

Updates the configuration of an Operations Insights Warehouse. There is only expected to be 1 warehouse per tenant. The warehouse is expected to be in the root compartment.

Parameters:

operations_insights_warehouse_id (String) —

Unique Operations Insights Warehouse identifier
update_operations_insights_warehouse_details (OCI::Opsi::Models::UpdateOperationsInsightsWarehouseDetails) —

The configuration 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) —

Used for optimistic concurrency control. In the update or delete call for a resource, set the if-match parameter to the value of the etag from a previous get, create, or update response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
:opc_request_id (String) —

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:

(Response) —

A Response object with data of type nil

# File 'lib/oci/opsi/operations_insights_client.rb', line 16809

def update_operations_insights_warehouse(operations_insights_warehouse_id, update_operations_insights_warehouse_details, opts = {})
  logger.debug 'Calling operation OperationsInsightsClient#update_operations_insights_warehouse.' if logger

  raise "Missing the required parameter 'operations_insights_warehouse_id' when calling update_operations_insights_warehouse." if operations_insights_warehouse_id.nil?
  raise "Missing the required parameter 'update_operations_insights_warehouse_details' when calling update_operations_insights_warehouse." if update_operations_insights_warehouse_details.nil?
  raise "Parameter value for 'operations_insights_warehouse_id' must not be blank" if OCI::Internal::Util.blank_string?(operations_insights_warehouse_id)

  path = '/operationsInsightsWarehouses/{operationsInsightsWarehouseId}'.sub('{operationsInsightsWarehouseId}', operations_insights_warehouse_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_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_operations_insights_warehouse_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'OperationsInsightsClient#update_operations_insights_warehouse') 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_operations_insights_warehouse_user(operations_insights_warehouse_user_id, update_operations_insights_warehouse_user_details, opts = {}) ⇒ `Response`

Note:

Click here to see an example of how to use update_operations_insights_warehouse_user API.

Updates the configuration of an Operations Insights Warehouse User.

Parameters:

operations_insights_warehouse_user_id (String) —

Unique Operations Insights Warehouse User identifier
update_operations_insights_warehouse_user_details (OCI::Opsi::Models::UpdateOperationsInsightsWarehouseUserDetails) —

The configuration 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) —

Used for optimistic concurrency control. In the update or delete call for a resource, set the if-match parameter to the value of the etag from a previous get, create, or update response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
:opc_request_id (String) —

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:

(Response) —

A Response object with data of type nil

# File 'lib/oci/opsi/operations_insights_client.rb', line 16871

def update_operations_insights_warehouse_user(operations_insights_warehouse_user_id, update_operations_insights_warehouse_user_details, opts = {})
  logger.debug 'Calling operation OperationsInsightsClient#update_operations_insights_warehouse_user.' if logger

  raise "Missing the required parameter 'operations_insights_warehouse_user_id' when calling update_operations_insights_warehouse_user." if operations_insights_warehouse_user_id.nil?
  raise "Missing the required parameter 'update_operations_insights_warehouse_user_details' when calling update_operations_insights_warehouse_user." if update_operations_insights_warehouse_user_details.nil?
  raise "Parameter value for 'operations_insights_warehouse_user_id' must not be blank" if OCI::Internal::Util.blank_string?(operations_insights_warehouse_user_id)

  path = '/operationsInsightsWarehouseUsers/{operationsInsightsWarehouseUserId}'.sub('{operationsInsightsWarehouseUserId}', operations_insights_warehouse_user_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_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_operations_insights_warehouse_user_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'OperationsInsightsClient#update_operations_insights_warehouse_user') 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_opsi_configuration(opsi_configuration_id, update_opsi_configuration_details, opts = {}) ⇒ `Response`

Note:

Click here to see an example of how to use update_opsi_configuration API.

Updates an OPSI configuration resource with the given ID.

Parameters:

opsi_configuration_id (String) —

OCID of OPSI configuration resource.
update_opsi_configuration_details (OCI::Opsi::Models::UpdateOpsiConfigurationDetails) —

The OPSI configuration resource 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) —

Used for optimistic concurrency control. In the update or delete call for a resource, set the if-match parameter to the value of the etag from a previous get, create, or update response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
:opc_request_id (String) —

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:

(Response) —

A Response object with data of type nil

# File 'lib/oci/opsi/operations_insights_client.rb', line 16934

def update_opsi_configuration(opsi_configuration_id, update_opsi_configuration_details, opts = {})
  logger.debug 'Calling operation OperationsInsightsClient#update_opsi_configuration.' if logger

  raise "Missing the required parameter 'opsi_configuration_id' when calling update_opsi_configuration." if opsi_configuration_id.nil?
  raise "Missing the required parameter 'update_opsi_configuration_details' when calling update_opsi_configuration." if update_opsi_configuration_details.nil?
  raise "Parameter value for 'opsi_configuration_id' must not be blank" if OCI::Internal::Util.blank_string?(opsi_configuration_id)

  path = '/opsiConfigurations/{opsiConfigurationId}'.sub('{opsiConfigurationId}', opsi_configuration_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_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_opsi_configuration_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'OperationsInsightsClient#update_opsi_configuration') do
    @api_client.call_api(
      :PUT,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

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) ⇒ OperationsInsightsClient

Instance Attribute Details

#api_client ⇒ OCI::ApiClient (readonly)

#endpoint ⇒ String (readonly)

#region ⇒ String

#retry_config ⇒ OCI::Retry::RetryConfig (readonly)

Instance Method Details

#add_exadata_insight_members(add_exadata_insight_members_details, exadata_insight_id, opts = {}) ⇒ Response

#change_autonomous_database_insight_advanced_features(change_autonomous_database_insight_advanced_features_details, database_insight_id, opts = {}) ⇒ Response

#change_awr_hub_source_compartment(awr_hub_source_id, change_awr_hub_source_compartment_details, opts = {}) ⇒ Response

#change_database_insight_compartment(database_insight_id, change_database_insight_compartment_details, opts = {}) ⇒ Response

#change_enterprise_manager_bridge_compartment(enterprise_manager_bridge_id, change_enterprise_manager_bridge_compartment_details, opts = {}) ⇒ Response

#change_exadata_insight_compartment(exadata_insight_id, change_exadata_insight_compartment_details, opts = {}) ⇒ Response

#change_host_insight_compartment(host_insight_id, change_host_insight_compartment_details, opts = {}) ⇒ Response

#change_news_report_compartment(news_report_id, change_news_report_compartment_details, opts = {}) ⇒ Response

#change_operations_insights_private_endpoint_compartment(operations_insights_private_endpoint_id, change_operations_insights_private_endpoint_compartment_details, opts = {}) ⇒ Response

#change_operations_insights_warehouse_compartment(operations_insights_warehouse_id, change_operations_insights_warehouse_compartment_details, opts = {}) ⇒ Response

#change_opsi_configuration_compartment(opsi_configuration_id, change_opsi_configuration_compartment_details, opts = {}) ⇒ Response

#change_pe_comanaged_database_insight(database_insight_id, change_pe_comanaged_database_insight_details, opts = {}) ⇒ Response

#create_awr_hub(create_awr_hub_details, opts = {}) ⇒ Response

#create_awr_hub_source(create_awr_hub_source_details, opts = {}) ⇒ Response

#create_database_insight(create_database_insight_details, opts = {}) ⇒ Response

#create_enterprise_manager_bridge(create_enterprise_manager_bridge_details, opts = {}) ⇒ Response

#create_exadata_insight(create_exadata_insight_details, opts = {}) ⇒ Response

#create_host_insight(create_host_insight_details, opts = {}) ⇒ Response

#create_news_report(create_news_report_details, opts = {}) ⇒ Response

#create_operations_insights_private_endpoint(create_operations_insights_private_endpoint_details, opts = {}) ⇒ Response

#create_operations_insights_warehouse(create_operations_insights_warehouse_details, opts = {}) ⇒ Response

#create_operations_insights_warehouse_user(create_operations_insights_warehouse_user_details, opts = {}) ⇒ Response

#create_opsi_configuration(create_opsi_configuration_details, opts = {}) ⇒ Response

#delete_awr_hub(awr_hub_id, opts = {}) ⇒ Response

#delete_awr_hub_object(awr_hub_source_id, object_name, opts = {}) ⇒ Response

#delete_awr_hub_source(awr_hub_source_id, opts = {}) ⇒ Response

#delete_database_insight(database_insight_id, opts = {}) ⇒ Response

#delete_enterprise_manager_bridge(enterprise_manager_bridge_id, opts = {}) ⇒ Response

#delete_exadata_insight(exadata_insight_id, opts = {}) ⇒ Response

#delete_host_insight(host_insight_id, opts = {}) ⇒ Response

#delete_news_report(news_report_id, opts = {}) ⇒ Response

#delete_operations_insights_private_endpoint(operations_insights_private_endpoint_id, opts = {}) ⇒ Response

#delete_operations_insights_warehouse(operations_insights_warehouse_id, opts = {}) ⇒ Response

#delete_operations_insights_warehouse_user(operations_insights_warehouse_user_id, opts = {}) ⇒ Response

#delete_opsi_configuration(opsi_configuration_id, opts = {}) ⇒ Response

#disable_autonomous_database_insight_advanced_features(database_insight_id, opts = {}) ⇒ Response

#disable_awr_hub_source(awr_hub_source_id, opts = {}) ⇒ Response

#disable_database_insight(database_insight_id, opts = {}) ⇒ Response

#disable_exadata_insight(exadata_insight_id, opts = {}) ⇒ Response

#disable_host_insight(host_insight_id, opts = {}) ⇒ Response

#download_operations_insights_warehouse_wallet(operations_insights_warehouse_id, download_operations_insights_warehouse_wallet_details, opts = {}, &block) ⇒ Response

#enable_autonomous_database_insight_advanced_features(enable_autonomous_database_insight_advanced_features_details, database_insight_id, opts = {}) ⇒ Response

#enable_awr_hub_source(awr_hub_source_id, opts = {}) ⇒ Response

#enable_database_insight(enable_database_insight_details, database_insight_id, opts = {}) ⇒ Response

#enable_exadata_insight(enable_exadata_insight_details, exadata_insight_id, opts = {}) ⇒ Response

#enable_host_insight(enable_host_insight_details, host_insight_id, opts = {}) ⇒ Response

#get_awr_database_report(awr_hub_id, awr_source_database_identifier, opts = {}) ⇒ Response

#get_awr_database_sql_report(awr_hub_id, awr_source_database_identifier, sql_id, opts = {}) ⇒ Response

#get_awr_hub(awr_hub_id, opts = {}) ⇒ Response

#get_awr_hub_object(awr_hub_source_id, object_name, opts = {}, &block) ⇒ Response

#get_awr_hub_source(awr_hub_source_id, opts = {}) ⇒ Response

#get_awr_report(awr_hub_id, awr_source_database_identifier, opts = {}) ⇒ Response

#get_database_insight(database_insight_id, opts = {}) ⇒ Response

#get_enterprise_manager_bridge(enterprise_manager_bridge_id, opts = {}) ⇒ Response

#get_exadata_insight(exadata_insight_id, opts = {}) ⇒ Response

#get_host_insight(host_insight_id, opts = {}) ⇒ Response

#get_news_report(news_report_id, opts = {}) ⇒ Response

#get_operations_insights_private_endpoint(operations_insights_private_endpoint_id, opts = {}) ⇒ Response

#get_operations_insights_warehouse(operations_insights_warehouse_id, opts = {}) ⇒ Response

#get_operations_insights_warehouse_user(operations_insights_warehouse_user_id, opts = {}) ⇒ Response

#get_opsi_configuration(opsi_configuration_id, opts = {}) ⇒ Response

#get_opsi_data_object(compartment_id, opsi_data_object_identifier, opts = {}) ⇒ Response

#get_work_request(work_request_id, opts = {}) ⇒ Response

#head_awr_hub_object(awr_hub_source_id, object_name, opts = {}) ⇒ Response

#ingest_addm_reports(ingest_addm_reports_details, opts = {}) ⇒ Response

#ingest_database_configuration(ingest_database_configuration_details, opts = {}) ⇒ Response

#ingest_host_configuration(id, ingest_host_configuration_details, opts = {}) ⇒ Response

#ingest_host_metrics(id, ingest_host_metrics_details, opts = {}) ⇒ Response

#initialize(config: nil, region: nil, endpoint: nil, signer: nil, proxy_settings: nil, retry_config: nil) ⇒ `OperationsInsightsClient`

#api_client ⇒ `OCI::ApiClient` (readonly)

#endpoint ⇒ `String` (readonly)

#region ⇒ `String`

#retry_config ⇒ `OCI::Retry::RetryConfig` (readonly)

#add_exadata_insight_members(add_exadata_insight_members_details, exadata_insight_id, opts = {}) ⇒ `Response`

#change_autonomous_database_insight_advanced_features(change_autonomous_database_insight_advanced_features_details, database_insight_id, opts = {}) ⇒ `Response`

#change_awr_hub_source_compartment(awr_hub_source_id, change_awr_hub_source_compartment_details, opts = {}) ⇒ `Response`

#change_database_insight_compartment(database_insight_id, change_database_insight_compartment_details, opts = {}) ⇒ `Response`

#change_enterprise_manager_bridge_compartment(enterprise_manager_bridge_id, change_enterprise_manager_bridge_compartment_details, opts = {}) ⇒ `Response`

#change_exadata_insight_compartment(exadata_insight_id, change_exadata_insight_compartment_details, opts = {}) ⇒ `Response`

#change_host_insight_compartment(host_insight_id, change_host_insight_compartment_details, opts = {}) ⇒ `Response`

#change_news_report_compartment(news_report_id, change_news_report_compartment_details, opts = {}) ⇒ `Response`

#change_operations_insights_private_endpoint_compartment(operations_insights_private_endpoint_id, change_operations_insights_private_endpoint_compartment_details, opts = {}) ⇒ `Response`

#change_operations_insights_warehouse_compartment(operations_insights_warehouse_id, change_operations_insights_warehouse_compartment_details, opts = {}) ⇒ `Response`

#change_opsi_configuration_compartment(opsi_configuration_id, change_opsi_configuration_compartment_details, opts = {}) ⇒ `Response`

#change_pe_comanaged_database_insight(database_insight_id, change_pe_comanaged_database_insight_details, opts = {}) ⇒ `Response`

#create_awr_hub(create_awr_hub_details, opts = {}) ⇒ `Response`

#create_awr_hub_source(create_awr_hub_source_details, opts = {}) ⇒ `Response`

#create_database_insight(create_database_insight_details, opts = {}) ⇒ `Response`

#create_enterprise_manager_bridge(create_enterprise_manager_bridge_details, opts = {}) ⇒ `Response`

#create_exadata_insight(create_exadata_insight_details, opts = {}) ⇒ `Response`

#create_host_insight(create_host_insight_details, opts = {}) ⇒ `Response`

#create_news_report(create_news_report_details, opts = {}) ⇒ `Response`

#create_operations_insights_private_endpoint(create_operations_insights_private_endpoint_details, opts = {}) ⇒ `Response`

#create_operations_insights_warehouse(create_operations_insights_warehouse_details, opts = {}) ⇒ `Response`

#create_operations_insights_warehouse_user(create_operations_insights_warehouse_user_details, opts = {}) ⇒ `Response`

#create_opsi_configuration(create_opsi_configuration_details, opts = {}) ⇒ `Response`

#delete_awr_hub(awr_hub_id, opts = {}) ⇒ `Response`

#delete_awr_hub_object(awr_hub_source_id, object_name, opts = {}) ⇒ `Response`

#delete_awr_hub_source(awr_hub_source_id, opts = {}) ⇒ `Response`

#delete_database_insight(database_insight_id, opts = {}) ⇒ `Response`

#delete_enterprise_manager_bridge(enterprise_manager_bridge_id, opts = {}) ⇒ `Response`

#delete_exadata_insight(exadata_insight_id, opts = {}) ⇒ `Response`

#delete_host_insight(host_insight_id, opts = {}) ⇒ `Response`

#delete_news_report(news_report_id, opts = {}) ⇒ `Response`

#delete_operations_insights_private_endpoint(operations_insights_private_endpoint_id, opts = {}) ⇒ `Response`

#delete_operations_insights_warehouse(operations_insights_warehouse_id, opts = {}) ⇒ `Response`

#delete_operations_insights_warehouse_user(operations_insights_warehouse_user_id, opts = {}) ⇒ `Response`

#delete_opsi_configuration(opsi_configuration_id, opts = {}) ⇒ `Response`

#disable_autonomous_database_insight_advanced_features(database_insight_id, opts = {}) ⇒ `Response`

#disable_awr_hub_source(awr_hub_source_id, opts = {}) ⇒ `Response`

#disable_database_insight(database_insight_id, opts = {}) ⇒ `Response`

#disable_exadata_insight(exadata_insight_id, opts = {}) ⇒ `Response`

#disable_host_insight(host_insight_id, opts = {}) ⇒ `Response`

#download_operations_insights_warehouse_wallet(operations_insights_warehouse_id, download_operations_insights_warehouse_wallet_details, opts = {}, &block) ⇒ `Response`

#enable_autonomous_database_insight_advanced_features(enable_autonomous_database_insight_advanced_features_details, database_insight_id, opts = {}) ⇒ `Response`

#enable_awr_hub_source(awr_hub_source_id, opts = {}) ⇒ `Response`

#enable_database_insight(enable_database_insight_details, database_insight_id, opts = {}) ⇒ `Response`

#enable_exadata_insight(enable_exadata_insight_details, exadata_insight_id, opts = {}) ⇒ `Response`

#enable_host_insight(enable_host_insight_details, host_insight_id, opts = {}) ⇒ `Response`

#get_awr_database_report(awr_hub_id, awr_source_database_identifier, opts = {}) ⇒ `Response`

#get_awr_database_sql_report(awr_hub_id, awr_source_database_identifier, sql_id, opts = {}) ⇒ `Response`

#get_awr_hub(awr_hub_id, opts = {}) ⇒ `Response`

#get_awr_hub_object(awr_hub_source_id, object_name, opts = {}, &block) ⇒ `Response`

#get_awr_hub_source(awr_hub_source_id, opts = {}) ⇒ `Response`

#get_awr_report(awr_hub_id, awr_source_database_identifier, opts = {}) ⇒ `Response`

#get_database_insight(database_insight_id, opts = {}) ⇒ `Response`

#get_enterprise_manager_bridge(enterprise_manager_bridge_id, opts = {}) ⇒ `Response`

#get_exadata_insight(exadata_insight_id, opts = {}) ⇒ `Response`

#get_host_insight(host_insight_id, opts = {}) ⇒ `Response`

#get_news_report(news_report_id, opts = {}) ⇒ `Response`

#get_operations_insights_private_endpoint(operations_insights_private_endpoint_id, opts = {}) ⇒ `Response`

#get_operations_insights_warehouse(operations_insights_warehouse_id, opts = {}) ⇒ `Response`

#get_operations_insights_warehouse_user(operations_insights_warehouse_user_id, opts = {}) ⇒ `Response`

#get_opsi_configuration(opsi_configuration_id, opts = {}) ⇒ `Response`

#get_opsi_data_object(compartment_id, opsi_data_object_identifier, opts = {}) ⇒ `Response`

#get_work_request(work_request_id, opts = {}) ⇒ `Response`

#head_awr_hub_object(awr_hub_source_id, object_name, opts = {}) ⇒ `Response`

#ingest_addm_reports(ingest_addm_reports_details, opts = {}) ⇒ `Response`

#ingest_database_configuration(ingest_database_configuration_details, opts = {}) ⇒ `Response`

#ingest_host_configuration(id, ingest_host_configuration_details, opts = {}) ⇒ `Response`

#ingest_host_metrics(id, ingest_host_metrics_details, opts = {}) ⇒ `Response`

#ingest_sql_bucket(ingest_sql_bucket_details, opts = {}) ⇒ `Response`

#ingest_sql_plan_lines(ingest_sql_plan_lines_details, opts = {}) ⇒ `Response`

#ingest_sql_stats(ingest_sql_stats_details, opts = {}) ⇒ `Response`

#ingest_sql_text(ingest_sql_text_details, opts = {}) ⇒ `Response`

#list_addm_db_finding_categories(compartment_id, opts = {}) ⇒ `Response`

#list_addm_db_findings_time_series(compartment_id, opts = {}) ⇒ `Response`

#list_addm_db_parameter_categories(compartment_id, opts = {}) ⇒ `Response`