Class: OCI::Healthchecks::HealthChecksClient
- Inherits:
-
Object
- Object
- OCI::Healthchecks::HealthChecksClient
- Defined in:
- lib/oci/healthchecks/health_checks_client.rb
Overview
API for the Health Checks service. Use this API to manage endpoint probes and monitors. For more information, see [Overview of the Health Checks Service](/iaas/Content/HealthChecks/Concepts/healthchecks.htm).
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
-
#create_http_monitor(create_http_monitor_details, opts = {}) ⇒ Response
Creates an HTTP monitor.
-
#create_on_demand_http_probe(create_on_demand_http_probe_details, opts = {}) ⇒ Response
Creates an on-demand HTTP probe.
-
#create_on_demand_ping_probe(create_on_demand_ping_probe_details, opts = {}) ⇒ Response
Creates an on-demand ping probe.
-
#create_ping_monitor(create_ping_monitor_details, opts = {}) ⇒ Response
Creates a ping monitor.
-
#delete_http_monitor(monitor_id, opts = {}) ⇒ Response
Deletes the HTTP monitor and its configuration.
-
#delete_ping_monitor(monitor_id, opts = {}) ⇒ Response
Deletes the ping monitor and its configuration.
-
#get_http_monitor(monitor_id, opts = {}) ⇒ Response
Gets the configuration for the specified monitor.
-
#get_ping_monitor(monitor_id, opts = {}) ⇒ Response
Gets the configuration for the specified ping monitor.
-
#initialize(config: nil, region: nil, endpoint: nil, signer: nil, proxy_settings: nil, retry_config: nil) ⇒ HealthChecksClient
constructor
Creates a new HealthChecksClient.
-
#list_health_checks_vantage_points(opts = {}) ⇒ Response
Gets information about all vantage points available to the user.
-
#list_http_monitors(compartment_id, opts = {}) ⇒ Response
Gets a list of HTTP monitors.
-
#list_http_probe_results(probe_configuration_id, opts = {}) ⇒ Response
Gets the HTTP probe results for the specified probe or monitor, where the ‘probeConfigurationId` is the OCID of either a monitor or an on-demand probe.
-
#list_ping_monitors(compartment_id, opts = {}) ⇒ Response
Gets a list of configured ping monitors.
-
#list_ping_probe_results(probe_configuration_id, opts = {}) ⇒ Response
Returns the results for the specified probe, where the ‘probeConfigurationId` is the OCID of either a monitor or an on-demand probe.
-
#logger ⇒ Logger
The logger for this client.
-
#update_http_monitor(monitor_id, update_http_monitor_details, opts = {}) ⇒ Response
Updates the configuration of the specified HTTP monitor.
-
#update_ping_monitor(monitor_id, update_ping_monitor_details, opts = {}) ⇒ Response
Updates the configuration of the specified ping monitor.
Constructor Details
#initialize(config: nil, region: nil, endpoint: nil, signer: nil, proxy_settings: nil, retry_config: nil) ⇒ HealthChecksClient
Creates a new HealthChecksClient. 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.
54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 |
# File 'lib/oci/healthchecks/health_checks_client.rb', line 54 def initialize(config: nil, region: nil, endpoint: nil, signer: nil, proxy_settings: nil, retry_config: nil) # If the signer is an InstancePrincipalsSecurityTokenSigner and no config was supplied (which is valid for instance principals) # 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 unless signer.is_a?(OCI::Auth::Signers::InstancePrincipalsSecurityTokenSigner) config ||= OCI::Config.new if signer.is_a?(OCI::Auth::Signers::InstancePrincipalsSecurityTokenSigner) config.validate unless signer.is_a?(OCI::Auth::Signers::InstancePrincipalsSecurityTokenSigner) if signer.nil? signer = OCI::Signer.new( config.user, config.fingerprint, config.tenancy, config.key_file, pass_phrase: config.pass_phrase, private_key_content: config.key_content ) end @api_client = OCI::ApiClient.new(config, signer, proxy_settings: proxy_settings) @retry_config = retry_config if endpoint @endpoint = endpoint + '/20180501' else region ||= config.region region ||= signer.region if signer.respond_to?(:region) self.region = region end logger.info "HealthChecksClient endpoint set to '#{@endpoint}'." if logger end |
Instance Attribute Details
#api_client ⇒ OCI::ApiClient (readonly)
Client used to make HTTP requests.
14 15 16 |
# File 'lib/oci/healthchecks/health_checks_client.rb', line 14 def api_client @api_client end |
#endpoint ⇒ String (readonly)
Fully qualified endpoint URL
18 19 20 |
# File 'lib/oci/healthchecks/health_checks_client.rb', line 18 def endpoint @endpoint end |
#region ⇒ String
The region, which will usually correspond to a value in Regions::REGION_ENUM.
28 29 30 |
# File 'lib/oci/healthchecks/health_checks_client.rb', line 28 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
24 25 26 |
# File 'lib/oci/healthchecks/health_checks_client.rb', line 24 def retry_config @retry_config end |
Instance Method Details
#create_http_monitor(create_http_monitor_details, opts = {}) ⇒ Response
Creates an HTTP monitor. Vantage points will be automatically selected if not specified, and probes will be initiated from each vantage point to each of the targets at the frequency specified by ‘intervalInSeconds`.
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 |
# File 'lib/oci/healthchecks/health_checks_client.rb', line 132 def create_http_monitor(create_http_monitor_details, opts = {}) logger.debug 'Calling operation HealthChecksClient#create_http_monitor.' if logger raise "Missing the required parameter 'create_http_monitor_details' when calling create_http_monitor." if create_http_monitor_details.nil? path = '/httpMonitors' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = @api_client.object_to_http_body(create_http_monitor_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'HealthChecksClient#create_http_monitor') 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::Healthchecks::Models::HttpMonitor' ) end # rubocop:enable Metrics/BlockLength end |
#create_on_demand_http_probe(create_on_demand_http_probe_details, opts = {}) ⇒ Response
Creates an on-demand HTTP probe. The location response header contains the URL for fetching the probe results.
Note: On-demand probe configurations are not saved.
192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 |
# File 'lib/oci/healthchecks/health_checks_client.rb', line 192 def create_on_demand_http_probe(create_on_demand_http_probe_details, opts = {}) logger.debug 'Calling operation HealthChecksClient#create_on_demand_http_probe.' if logger raise "Missing the required parameter 'create_on_demand_http_probe_details' when calling create_on_demand_http_probe." if create_on_demand_http_probe_details.nil? path = '/httpProbeResults' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = @api_client.object_to_http_body(create_on_demand_http_probe_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'HealthChecksClient#create_on_demand_http_probe') 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::Healthchecks::Models::HttpProbe' ) end # rubocop:enable Metrics/BlockLength end |
#create_on_demand_ping_probe(create_on_demand_ping_probe_details, opts = {}) ⇒ Response
Creates an on-demand ping probe. The location response header contains the URL for fetching probe results.
Note: The on-demand probe configuration is not saved.
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 |
# File 'lib/oci/healthchecks/health_checks_client.rb', line 250 def create_on_demand_ping_probe(create_on_demand_ping_probe_details, opts = {}) logger.debug 'Calling operation HealthChecksClient#create_on_demand_ping_probe.' if logger raise "Missing the required parameter 'create_on_demand_ping_probe_details' when calling create_on_demand_ping_probe." if create_on_demand_ping_probe_details.nil? path = '/pingProbeResults' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = @api_client.object_to_http_body(create_on_demand_ping_probe_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'HealthChecksClient#create_on_demand_ping_probe') 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::Healthchecks::Models::PingProbe' ) end # rubocop:enable Metrics/BlockLength end |
#create_ping_monitor(create_ping_monitor_details, opts = {}) ⇒ Response
Creates a ping monitor. Vantage points will be automatically selected if not specified, and probes will be initiated from each vantage point to each of the targets at the frequency specified by ‘intervalInSeconds`.
314 315 316 317 318 319 320 321 322 323 324 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 |
# File 'lib/oci/healthchecks/health_checks_client.rb', line 314 def create_ping_monitor(create_ping_monitor_details, opts = {}) logger.debug 'Calling operation HealthChecksClient#create_ping_monitor.' if logger raise "Missing the required parameter 'create_ping_monitor_details' when calling create_ping_monitor." if create_ping_monitor_details.nil? path = '/pingMonitors' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = @api_client.object_to_http_body(create_ping_monitor_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'HealthChecksClient#create_ping_monitor') 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::Healthchecks::Models::PingMonitor' ) end # rubocop:enable Metrics/BlockLength end |
#delete_http_monitor(monitor_id, opts = {}) ⇒ Response
Deletes the HTTP monitor and its configuration. All future probes of this monitor are stopped. Results associated with the monitor are not deleted.
377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 |
# File 'lib/oci/healthchecks/health_checks_client.rb', line 377 def delete_http_monitor(monitor_id, opts = {}) logger.debug 'Calling operation HealthChecksClient#delete_http_monitor.' if logger raise "Missing the required parameter 'monitor_id' when calling delete_http_monitor." if monitor_id.nil? raise "Parameter value for 'monitor_id' must not be blank" if OCI::Internal::Util.blank_string?(monitor_id) path = '/httpMonitors/{monitorId}'.sub('{monitorId}', monitor_id.to_s) operation_signing_strategy = :standard # rubocop: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.(applicable_retry_config(opts), call_name: 'HealthChecksClient#delete_http_monitor') 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_ping_monitor(monitor_id, opts = {}) ⇒ Response
Deletes the ping monitor and its configuration. All future probes of this monitor are stopped. Results associated with the monitor are not deleted.
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/healthchecks/health_checks_client.rb', line 439 def delete_ping_monitor(monitor_id, opts = {}) logger.debug 'Calling operation HealthChecksClient#delete_ping_monitor.' if logger raise "Missing the required parameter 'monitor_id' when calling delete_ping_monitor." if monitor_id.nil? raise "Parameter value for 'monitor_id' must not be blank" if OCI::Internal::Util.blank_string?(monitor_id) path = '/pingMonitors/{monitorId}'.sub('{monitorId}', monitor_id.to_s) operation_signing_strategy = :standard # rubocop: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.(applicable_retry_config(opts), call_name: 'HealthChecksClient#delete_ping_monitor') 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 |
#get_http_monitor(monitor_id, opts = {}) ⇒ Response
Gets the configuration for the specified monitor.
500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 |
# File 'lib/oci/healthchecks/health_checks_client.rb', line 500 def get_http_monitor(monitor_id, opts = {}) logger.debug 'Calling operation HealthChecksClient#get_http_monitor.' if logger raise "Missing the required parameter 'monitor_id' when calling get_http_monitor." if monitor_id.nil? raise "Parameter value for 'monitor_id' must not be blank" if OCI::Internal::Util.blank_string?(monitor_id) path = '/httpMonitors/{monitorId}'.sub('{monitorId}', monitor_id.to_s) operation_signing_strategy = :standard # rubocop: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-none-match'] = opts[:if_none_match] if opts[:if_none_match] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'HealthChecksClient#get_http_monitor') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Healthchecks::Models::HttpMonitor' ) end # rubocop:enable Metrics/BlockLength end |
#get_ping_monitor(monitor_id, opts = {}) ⇒ Response
Gets the configuration for the specified ping monitor.
562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 |
# File 'lib/oci/healthchecks/health_checks_client.rb', line 562 def get_ping_monitor(monitor_id, opts = {}) logger.debug 'Calling operation HealthChecksClient#get_ping_monitor.' if logger raise "Missing the required parameter 'monitor_id' when calling get_ping_monitor." if monitor_id.nil? raise "Parameter value for 'monitor_id' must not be blank" if OCI::Internal::Util.blank_string?(monitor_id) path = '/pingMonitors/{monitorId}'.sub('{monitorId}', monitor_id.to_s) operation_signing_strategy = :standard # rubocop: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-none-match'] = opts[:if_none_match] if opts[:if_none_match] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'HealthChecksClient#get_ping_monitor') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Healthchecks::Models::PingMonitor' ) end # rubocop:enable Metrics/BlockLength end |
#list_health_checks_vantage_points(opts = {}) ⇒ Response
Gets information about all vantage points available to the user.
629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 |
# File 'lib/oci/healthchecks/health_checks_client.rb', line 629 def list_health_checks_vantage_points(opts = {}) logger.debug 'Calling operation HealthChecksClient#list_health_checks_vantage_points.' if logger if opts[:sort_by] && !%w[name displayName].include?(opts[:sort_by]) raise 'Invalid value for "sort_by", must be one of name, displayName.' end if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order]) raise 'Invalid value for "sort_order", must be one of ASC, DESC.' end path = '/vantagePoints' 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[:sortBy] = opts[:sort_by] if opts[:sort_by] query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order] query_params[:name] = opts[:name] if opts[:name] query_params[:displayName] = opts[:display_name] if opts[:display_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.(applicable_retry_config(opts), call_name: 'HealthChecksClient#list_health_checks_vantage_points') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'Array<OCI::Healthchecks::Models::HealthChecksVantagePointSummary>' ) end # rubocop:enable Metrics/BlockLength end |
#list_http_monitors(compartment_id, opts = {}) ⇒ Response
Gets a list of HTTP monitors.
707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 |
# File 'lib/oci/healthchecks/health_checks_client.rb', line 707 def list_http_monitors(compartment_id, opts = {}) logger.debug 'Calling operation HealthChecksClient#list_http_monitors.' if logger raise "Missing the required parameter 'compartment_id' when calling list_http_monitors." if compartment_id.nil? if opts[:sort_by] && !%w[id displayName].include?(opts[:sort_by]) raise 'Invalid value for "sort_by", must be one of id, displayName.' end if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order]) raise 'Invalid value for "sort_order", must be one of ASC, DESC.' end path = '/httpMonitors' 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[:sortBy] = opts[:sort_by] if opts[:sort_by] query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order] query_params[:displayName] = opts[:display_name] if opts[:display_name] # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'HealthChecksClient#list_http_monitors') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'Array<OCI::Healthchecks::Models::HttpMonitorSummary>' ) end # rubocop:enable Metrics/BlockLength end |
#list_http_probe_results(probe_configuration_id, opts = {}) ⇒ Response
Gets the HTTP probe results for the specified probe or monitor, where the ‘probeConfigurationId` is the OCID of either a monitor or an on-demand probe.
788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 |
# File 'lib/oci/healthchecks/health_checks_client.rb', line 788 def list_http_probe_results(probe_configuration_id, opts = {}) logger.debug 'Calling operation HealthChecksClient#list_http_probe_results.' if logger raise "Missing the required parameter 'probe_configuration_id' when calling list_http_probe_results." if probe_configuration_id.nil? if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order]) raise 'Invalid value for "sort_order", must be one of ASC, DESC.' end raise "Parameter value for 'probe_configuration_id' must not be blank" if OCI::Internal::Util.blank_string?(probe_configuration_id) path = '/httpProbeResults/{probeConfigurationId}'.sub('{probeConfigurationId}', probe_configuration_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[:startTimeGreaterThanOrEqualTo] = opts[:start_time_greater_than_or_equal_to] if opts[:start_time_greater_than_or_equal_to] query_params[:startTimeLessThanOrEqualTo] = opts[:start_time_less_than_or_equal_to] if opts[:start_time_less_than_or_equal_to] query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order] query_params[:target] = opts[:target] if opts[:target] # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'HealthChecksClient#list_http_probe_results') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'Array<OCI::Healthchecks::Models::HttpProbeResultSummary>' ) end # rubocop:enable Metrics/BlockLength end |
#list_ping_monitors(compartment_id, opts = {}) ⇒ Response
Gets a list of configured ping monitors.
Results are paginated based on ‘page` and `limit`. The `opc-next-page` header provides a URL for fetching the next page.
867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 |
# File 'lib/oci/healthchecks/health_checks_client.rb', line 867 def list_ping_monitors(compartment_id, opts = {}) logger.debug 'Calling operation HealthChecksClient#list_ping_monitors.' if logger raise "Missing the required parameter 'compartment_id' when calling list_ping_monitors." if compartment_id.nil? if opts[:sort_by] && !%w[id displayName].include?(opts[:sort_by]) raise 'Invalid value for "sort_by", must be one of id, displayName.' end if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order]) raise 'Invalid value for "sort_order", must be one of ASC, DESC.' end path = '/pingMonitors' 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[:sortBy] = opts[:sort_by] if opts[:sort_by] query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order] query_params[:displayName] = opts[:display_name] if opts[:display_name] # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'HealthChecksClient#list_ping_monitors') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'Array<OCI::Healthchecks::Models::PingMonitorSummary>' ) end # rubocop:enable Metrics/BlockLength end |
#list_ping_probe_results(probe_configuration_id, opts = {}) ⇒ Response
Returns the results for the specified probe, where the ‘probeConfigurationId` is the OCID of either a monitor or an on-demand probe.
Results are paginated based on ‘page` and `limit`. The `opc-next-page` header provides a URL for fetching the next page. Use `sortOrder` to set the order of the results. If `sortOrder` is unspecified, results are sorted in ascending order by `startTime`.
952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 |
# File 'lib/oci/healthchecks/health_checks_client.rb', line 952 def list_ping_probe_results(probe_configuration_id, opts = {}) logger.debug 'Calling operation HealthChecksClient#list_ping_probe_results.' if logger raise "Missing the required parameter 'probe_configuration_id' when calling list_ping_probe_results." if probe_configuration_id.nil? if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order]) raise 'Invalid value for "sort_order", must be one of ASC, DESC.' end raise "Parameter value for 'probe_configuration_id' must not be blank" if OCI::Internal::Util.blank_string?(probe_configuration_id) path = '/pingProbeResults/{probeConfigurationId}'.sub('{probeConfigurationId}', probe_configuration_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[:startTimeGreaterThanOrEqualTo] = opts[:start_time_greater_than_or_equal_to] if opts[:start_time_greater_than_or_equal_to] query_params[:startTimeLessThanOrEqualTo] = opts[:start_time_less_than_or_equal_to] if opts[:start_time_less_than_or_equal_to] query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order] query_params[:target] = opts[:target] if opts[:target] # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'HealthChecksClient#list_ping_probe_results') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'Array<OCI::Healthchecks::Models::PingProbeResultSummary>' ) end # rubocop:enable Metrics/BlockLength end |
#logger ⇒ Logger
Returns The logger for this client. May be nil.
104 105 106 |
# File 'lib/oci/healthchecks/health_checks_client.rb', line 104 def logger @api_client.config.logger end |
#update_http_monitor(monitor_id, update_http_monitor_details, opts = {}) ⇒ Response
Updates the configuration of the specified HTTP monitor. Only the fields specified in the request body will be updated; all other configuration properties will remain unchanged.
1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 |
# File 'lib/oci/healthchecks/health_checks_client.rb', line 1026 def update_http_monitor(monitor_id, update_http_monitor_details, opts = {}) logger.debug 'Calling operation HealthChecksClient#update_http_monitor.' if logger raise "Missing the required parameter 'monitor_id' when calling update_http_monitor." if monitor_id.nil? raise "Missing the required parameter 'update_http_monitor_details' when calling update_http_monitor." if update_http_monitor_details.nil? raise "Parameter value for 'monitor_id' must not be blank" if OCI::Internal::Util.blank_string?(monitor_id) path = '/httpMonitors/{monitorId}'.sub('{monitorId}', monitor_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] header_params[:'if-match'] = opts[:if_match] if opts[:if_match] # rubocop:enable Style/NegatedIf post_body = @api_client.object_to_http_body(update_http_monitor_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'HealthChecksClient#update_http_monitor') do @api_client.call_api( :PUT, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Healthchecks::Models::HttpMonitor' ) end # rubocop:enable Metrics/BlockLength end |
#update_ping_monitor(monitor_id, update_ping_monitor_details, opts = {}) ⇒ Response
Updates the configuration of the specified ping monitor. Only the fields specified in the request body will be updated; all other configuration properties will remain unchanged.
1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 |
# File 'lib/oci/healthchecks/health_checks_client.rb', line 1092 def update_ping_monitor(monitor_id, update_ping_monitor_details, opts = {}) logger.debug 'Calling operation HealthChecksClient#update_ping_monitor.' if logger raise "Missing the required parameter 'monitor_id' when calling update_ping_monitor." if monitor_id.nil? raise "Missing the required parameter 'update_ping_monitor_details' when calling update_ping_monitor." if update_ping_monitor_details.nil? raise "Parameter value for 'monitor_id' must not be blank" if OCI::Internal::Util.blank_string?(monitor_id) path = '/pingMonitors/{monitorId}'.sub('{monitorId}', monitor_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] header_params[:'if-match'] = opts[:if_match] if opts[:if_match] # rubocop:enable Style/NegatedIf post_body = @api_client.object_to_http_body(update_ping_monitor_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'HealthChecksClient#update_ping_monitor') do @api_client.call_api( :PUT, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Healthchecks::Models::PingMonitor' ) end # rubocop:enable Metrics/BlockLength end |