Class: OCI::DatabaseManagement::DiagnosabilityClient
- Inherits:
-
Object
- Object
- OCI::DatabaseManagement::DiagnosabilityClient
- Defined in:
- lib/oci/database_management/diagnosability_client.rb
Overview
Use the Database Management API to monitor and manage resources such as Oracle Databases, MySQL Databases, and External Database Systems. For more information, see Database Management.
Instance Attribute Summary collapse
-
#api_client ⇒ OCI::ApiClient
readonly
Client used to make HTTP requests.
-
#endpoint ⇒ String
readonly
Fully qualified endpoint URL.
-
#region ⇒ String
The region, which will usually correspond to a value in Regions::REGION_ENUM.
-
#retry_config ⇒ OCI::Retry::RetryConfig
readonly
The default retry configuration to apply to all operations in this service client.
Instance Method Summary collapse
-
#initialize(config: nil, region: nil, endpoint: nil, signer: nil, proxy_settings: nil, retry_config: nil) ⇒ DiagnosabilityClient
constructor
Creates a new DiagnosabilityClient.
-
#list_alert_logs(managed_database_id, opts = {}) ⇒ Response
Lists the alert logs for the specified Managed Database.
-
#list_attention_logs(managed_database_id, opts = {}) ⇒ Response
Lists the attention logs for the specified Managed Database.
-
#logger ⇒ Logger
The logger for this client.
-
#summarize_alert_log_counts(managed_database_id, opts = {}) ⇒ Response
Get the counts of alert logs for the specified Managed Database.
-
#summarize_attention_log_counts(managed_database_id, opts = {}) ⇒ Response
Get the counts of attention logs for the specified Managed Database.
Constructor Details
#initialize(config: nil, region: nil, endpoint: nil, signer: nil, proxy_settings: nil, retry_config: nil) ⇒ DiagnosabilityClient
Creates a new DiagnosabilityClient. Notes: If a config is not specified, then the global OCI.config will be used.
This client is not thread-safe
Either a region or an endpoint must be specified. If an endpoint is specified, it will be used instead of the region. A region may be specified in the config or via or the region parameter. If specified in both, then the region parameter will be used.
57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 |
# File 'lib/oci/database_management/diagnosability_client.rb', line 57 def initialize(config: nil, region: nil, endpoint: nil, signer: nil, proxy_settings: nil, retry_config: nil) # If the signer is an InstancePrincipalsSecurityTokenSigner or SecurityTokenSigner and no config was supplied (they are self-sufficient signers) # then create a dummy config to pass to the ApiClient constructor. If customers wish to create a client which uses instance principals # and has config (either populated programmatically or loaded from a file), they must construct that config themselves and then # pass it to this constructor. # # If there is no signer (or the signer is not an instance principals signer) and no config was supplied, this is not valid # so try and load the config from the default file. config = OCI::Config.validate_and_build_config_with_signer(config, signer) signer = OCI::Signer.config_file_auth_builder(config) if signer.nil? @api_client = OCI::ApiClient.new(config, signer, proxy_settings: proxy_settings) @retry_config = retry_config if endpoint @endpoint = endpoint + '/20201101' else region ||= config.region region ||= signer.region if signer.respond_to?(:region) self.region = region end logger.info "DiagnosabilityClient endpoint set to '#{@endpoint}'." if logger end |
Instance Attribute Details
#api_client ⇒ OCI::ApiClient (readonly)
Client used to make HTTP requests.
17 18 19 |
# File 'lib/oci/database_management/diagnosability_client.rb', line 17 def api_client @api_client end |
#endpoint ⇒ String (readonly)
Fully qualified endpoint URL
21 22 23 |
# File 'lib/oci/database_management/diagnosability_client.rb', line 21 def endpoint @endpoint end |
#region ⇒ String
The region, which will usually correspond to a value in Regions::REGION_ENUM.
31 32 33 |
# File 'lib/oci/database_management/diagnosability_client.rb', line 31 def region @region end |
#retry_config ⇒ OCI::Retry::RetryConfig (readonly)
The default retry configuration to apply to all operations in this service client. This can be overridden on a per-operation basis. The default retry configuration value is nil
, which means that an operation will not perform any retries
27 28 29 |
# File 'lib/oci/database_management/diagnosability_client.rb', line 27 def retry_config @retry_config end |
Instance Method Details
#list_alert_logs(managed_database_id, opts = {}) ⇒ Response
Click here to see an example of how to use list_alert_logs API.
Lists the alert logs for the specified Managed Database.
130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 |
# File 'lib/oci/database_management/diagnosability_client.rb', line 130 def list_alert_logs(managed_database_id, opts = {}) logger.debug 'Calling operation DiagnosabilityClient#list_alert_logs.' if logger raise "Missing the required parameter 'managed_database_id' when calling list_alert_logs." if managed_database_id.nil? if opts[:level_filter] && !%w[CRITICAL SEVERE IMPORTANT NORMAL ALL].include?(opts[:level_filter]) raise 'Invalid value for "level_filter", must be one of CRITICAL, SEVERE, IMPORTANT, NORMAL, ALL.' end if opts[:type_filter] && !%w[UNKNOWN INCIDENT_ERROR ERROR WARNING NOTIFICATION TRACE ALL].include?(opts[:type_filter]) raise 'Invalid value for "type_filter", must be one of UNKNOWN, INCIDENT_ERROR, ERROR, WARNING, NOTIFICATION, TRACE, ALL.' end if opts[:sort_by] && !%w[LEVEL TYPE MESSAGE TIMESTAMP].include?(opts[:sort_by]) raise 'Invalid value for "sort_by", must be one of LEVEL, TYPE, MESSAGE, TIMESTAMP.' end if opts[:sort_order] && !OCI::DatabaseManagement::Models::SORT_ORDERS_ENUM.include?(opts[:sort_order]) raise 'Invalid value for "sort_order", must be one of the values in OCI::DatabaseManagement::Models::SORT_ORDERS_ENUM.' end raise "Parameter value for 'managed_database_id' must not be blank" if OCI::Internal::Util.blank_string?(managed_database_id) path = '/managedDatabases/{managedDatabaseId}/alertLogs'.sub('{managedDatabaseId}', managed_database_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} 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[:levelFilter] = opts[:level_filter] if opts[:level_filter] query_params[:typeFilter] = opts[:type_filter] if opts[:type_filter] query_params[:logSearchText] = opts[:log_search_text] if opts[:log_search_text] query_params[:isRegularExpression] = opts[:is_regular_expression] if !opts[:is_regular_expression].nil? query_params[:sortBy] = opts[:sort_by] if opts[:sort_by] query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order] 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] header_params[:'opc-named-credential-id'] = opts[:opc_named_credential_id] if opts[:opc_named_credential_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'DiagnosabilityClient#list_alert_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::DatabaseManagement::Models::AlertLogCollection' ) end # rubocop:enable Metrics/BlockLength end |
#list_attention_logs(managed_database_id, opts = {}) ⇒ Response
Click here to see an example of how to use list_attention_logs API.
Lists the attention logs for the specified Managed Database.
228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 |
# File 'lib/oci/database_management/diagnosability_client.rb', line 228 def list_attention_logs(managed_database_id, opts = {}) logger.debug 'Calling operation DiagnosabilityClient#list_attention_logs.' if logger raise "Missing the required parameter 'managed_database_id' when calling list_attention_logs." if managed_database_id.nil? if opts[:urgency_filter] && !%w[IMMEDIATE SOON DEFERRABLE INFO ALL].include?(opts[:urgency_filter]) raise 'Invalid value for "urgency_filter", must be one of IMMEDIATE, SOON, DEFERRABLE, INFO, ALL.' end if opts[:type_filter] && !%w[UNKNOWN INCIDENT_ERROR ERROR WARNING NOTIFICATION TRACE ALL].include?(opts[:type_filter]) raise 'Invalid value for "type_filter", must be one of UNKNOWN, INCIDENT_ERROR, ERROR, WARNING, NOTIFICATION, TRACE, ALL.' end if opts[:sort_by] && !%w[URGENCY TYPE MESSAGE TIMESTAMP SCOPE TARGET_USER].include?(opts[:sort_by]) raise 'Invalid value for "sort_by", must be one of URGENCY, TYPE, MESSAGE, TIMESTAMP, SCOPE, TARGET_USER.' end if opts[:sort_order] && !OCI::DatabaseManagement::Models::SORT_ORDERS_ENUM.include?(opts[:sort_order]) raise 'Invalid value for "sort_order", must be one of the values in OCI::DatabaseManagement::Models::SORT_ORDERS_ENUM.' end raise "Parameter value for 'managed_database_id' must not be blank" if OCI::Internal::Util.blank_string?(managed_database_id) path = '/managedDatabases/{managedDatabaseId}/attentionLogs'.sub('{managedDatabaseId}', managed_database_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} 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[:urgencyFilter] = opts[:urgency_filter] if opts[:urgency_filter] query_params[:typeFilter] = opts[:type_filter] if opts[:type_filter] query_params[:logSearchText] = opts[:log_search_text] if opts[:log_search_text] query_params[:isRegularExpression] = opts[:is_regular_expression] if !opts[:is_regular_expression].nil? query_params[:sortBy] = opts[:sort_by] if opts[:sort_by] query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order] 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] header_params[:'opc-named-credential-id'] = opts[:opc_named_credential_id] if opts[:opc_named_credential_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'DiagnosabilityClient#list_attention_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::DatabaseManagement::Models::AttentionLogCollection' ) end # rubocop:enable Metrics/BlockLength end |
#logger ⇒ Logger
Returns The logger for this client. May be nil.
96 97 98 |
# File 'lib/oci/database_management/diagnosability_client.rb', line 96 def logger @api_client.config.logger end |
#summarize_alert_log_counts(managed_database_id, opts = {}) ⇒ Response
Click here to see an example of how to use summarize_alert_log_counts API.
Get the counts of alert logs for the specified Managed Database.
325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 |
# File 'lib/oci/database_management/diagnosability_client.rb', line 325 def summarize_alert_log_counts(managed_database_id, opts = {}) logger.debug 'Calling operation DiagnosabilityClient#summarize_alert_log_counts.' if logger raise "Missing the required parameter 'managed_database_id' when calling summarize_alert_log_counts." if managed_database_id.nil? if opts[:level_filter] && !%w[CRITICAL SEVERE IMPORTANT NORMAL ALL].include?(opts[:level_filter]) raise 'Invalid value for "level_filter", must be one of CRITICAL, SEVERE, IMPORTANT, NORMAL, ALL.' end if opts[:group_by] && !%w[LEVEL TYPE].include?(opts[:group_by]) raise 'Invalid value for "group_by", must be one of LEVEL, TYPE.' end if opts[:type_filter] && !%w[UNKNOWN INCIDENT_ERROR ERROR WARNING NOTIFICATION TRACE ALL].include?(opts[:type_filter]) raise 'Invalid value for "type_filter", must be one of UNKNOWN, INCIDENT_ERROR, ERROR, WARNING, NOTIFICATION, TRACE, ALL.' end raise "Parameter value for 'managed_database_id' must not be blank" if OCI::Internal::Util.blank_string?(managed_database_id) path = '/managedDatabases/{managedDatabaseId}/alertLogCounts'.sub('{managedDatabaseId}', managed_database_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} 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[:levelFilter] = opts[:level_filter] if opts[:level_filter] query_params[:groupBy] = opts[:group_by] if opts[:group_by] query_params[:typeFilter] = opts[:type_filter] if opts[:type_filter] query_params[:logSearchText] = opts[:log_search_text] if opts[:log_search_text] query_params[:isRegularExpression] = opts[:is_regular_expression] if !opts[:is_regular_expression].nil? 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] header_params[:'opc-named-credential-id'] = opts[:opc_named_credential_id] if opts[:opc_named_credential_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'DiagnosabilityClient#summarize_alert_log_counts') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::DatabaseManagement::Models::AlertLogCountsCollection' ) end # rubocop:enable Metrics/BlockLength end |
#summarize_attention_log_counts(managed_database_id, opts = {}) ⇒ Response
Click here to see an example of how to use summarize_attention_log_counts API.
Get the counts of attention logs for the specified Managed Database.
417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 |
# File 'lib/oci/database_management/diagnosability_client.rb', line 417 def summarize_attention_log_counts(managed_database_id, opts = {}) logger.debug 'Calling operation DiagnosabilityClient#summarize_attention_log_counts.' if logger raise "Missing the required parameter 'managed_database_id' when calling summarize_attention_log_counts." if managed_database_id.nil? if opts[:urgency_filter] && !%w[IMMEDIATE SOON DEFERRABLE INFO ALL].include?(opts[:urgency_filter]) raise 'Invalid value for "urgency_filter", must be one of IMMEDIATE, SOON, DEFERRABLE, INFO, ALL.' end if opts[:group_by] && !%w[URGENCY TYPE].include?(opts[:group_by]) raise 'Invalid value for "group_by", must be one of URGENCY, TYPE.' end if opts[:type_filter] && !%w[UNKNOWN INCIDENT_ERROR ERROR WARNING NOTIFICATION TRACE ALL].include?(opts[:type_filter]) raise 'Invalid value for "type_filter", must be one of UNKNOWN, INCIDENT_ERROR, ERROR, WARNING, NOTIFICATION, TRACE, ALL.' end raise "Parameter value for 'managed_database_id' must not be blank" if OCI::Internal::Util.blank_string?(managed_database_id) path = '/managedDatabases/{managedDatabaseId}/attentionLogCounts'.sub('{managedDatabaseId}', managed_database_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} 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[:urgencyFilter] = opts[:urgency_filter] if opts[:urgency_filter] query_params[:groupBy] = opts[:group_by] if opts[:group_by] query_params[:typeFilter] = opts[:type_filter] if opts[:type_filter] query_params[:logSearchText] = opts[:log_search_text] if opts[:log_search_text] query_params[:isRegularExpression] = opts[:is_regular_expression] if !opts[:is_regular_expression].nil? 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] header_params[:'opc-named-credential-id'] = opts[:opc_named_credential_id] if opts[:opc_named_credential_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'DiagnosabilityClient#summarize_attention_log_counts') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::DatabaseManagement::Models::AttentionLogCountsCollection' ) end # rubocop:enable Metrics/BlockLength end |