Class: OCI::VnMonitoring::VnMonitoringClient
- Inherits:
-
Object
- Object
- OCI::VnMonitoring::VnMonitoringClient
- Defined in:
- lib/oci/vn_monitoring/vn_monitoring_client.rb
Overview
Use the Network Monitoring API to troubleshoot routing and security issues for resources such as virtual cloud networks (VCNs) and compute instances. For more information, see the console documentation for the Network Path Analyzer tool.
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
-
#change_path_analyzer_test_compartment(path_analyzer_test_id, change_path_analyzer_test_compartment_details, opts = {}) ⇒ Response
Moves a
PathAnalyzerTest
resource from one compartment to another based on the identifier. -
#create_path_analyzer_test(create_path_analyzer_test_details, opts = {}) ⇒ Response
Creates a new
PathAnalyzerTest
resource. -
#delete_path_analyzer_test(path_analyzer_test_id, opts = {}) ⇒ Response
Deletes a
PathAnalyzerTest
resource using its identifier. -
#get_path_analysis(get_path_analysis_details, opts = {}) ⇒ Response
Use this method to initiate a Network Path Analyzer analysis.
-
#get_path_analyzer_test(path_analyzer_test_id, opts = {}) ⇒ Response
Gets a
PathAnalyzerTest
using its identifier. -
#get_work_request(work_request_id, opts = {}) ⇒ Response
Gets the details of a work request.
-
#initialize(config: nil, region: nil, endpoint: nil, signer: nil, proxy_settings: nil, retry_config: nil) ⇒ VnMonitoringClient
constructor
Creates a new VnMonitoringClient.
-
#list_path_analyzer_tests(compartment_id, opts = {}) ⇒ Response
Returns a list of all
PathAnalyzerTests
in a compartment. -
#list_work_request_errors(work_request_id, opts = {}) ⇒ Response
Returns a (paginated) list of errors for the work request with the given ID.
-
#list_work_request_logs(work_request_id, opts = {}) ⇒ Response
Returns a (paginated) list of logs for the work request with the given ID.
-
#list_work_request_results(work_request_id, opts = {}) ⇒ Response
Returns a (paginated) list of results for a successful work request.
-
#list_work_requests(compartment_id, opts = {}) ⇒ Response
Lists the work requests in a compartment.
-
#logger ⇒ Logger
The logger for this client.
-
#update_path_analyzer_test(path_analyzer_test_id, update_path_analyzer_test_details, opts = {}) ⇒ Response
Updates a
PathAnalyzerTest
using its identifier.
Constructor Details
#initialize(config: nil, region: nil, endpoint: nil, signer: nil, proxy_settings: nil, retry_config: nil) ⇒ VnMonitoringClient
Creates a new VnMonitoringClient. 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.
56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 |
# File 'lib/oci/vn_monitoring/vn_monitoring_client.rb', line 56 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 + '/20160918' else region ||= config.region region ||= signer.region if signer.respond_to?(:region) self.region = region end logger.info "VnMonitoringClient endpoint set to '#{@endpoint}'." if logger end |
Instance Attribute Details
#api_client ⇒ OCI::ApiClient (readonly)
Client used to make HTTP requests.
16 17 18 |
# File 'lib/oci/vn_monitoring/vn_monitoring_client.rb', line 16 def api_client @api_client end |
#endpoint ⇒ String (readonly)
Fully qualified endpoint URL
20 21 22 |
# File 'lib/oci/vn_monitoring/vn_monitoring_client.rb', line 20 def endpoint @endpoint end |
#region ⇒ String
The region, which will usually correspond to a value in Regions::REGION_ENUM.
30 31 32 |
# File 'lib/oci/vn_monitoring/vn_monitoring_client.rb', line 30 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
26 27 28 |
# File 'lib/oci/vn_monitoring/vn_monitoring_client.rb', line 26 def retry_config @retry_config end |
Instance Method Details
#change_path_analyzer_test_compartment(path_analyzer_test_id, change_path_analyzer_test_compartment_details, opts = {}) ⇒ Response
Click here to see an example of how to use change_path_analyzer_test_compartment API.
Moves a PathAnalyzerTest
resource from one compartment to another based on the identifier.
120 121 122 123 124 125 126 127 128 129 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 |
# File 'lib/oci/vn_monitoring/vn_monitoring_client.rb', line 120 def change_path_analyzer_test_compartment(path_analyzer_test_id, change_path_analyzer_test_compartment_details, opts = {}) logger.debug 'Calling operation VnMonitoringClient#change_path_analyzer_test_compartment.' if logger raise "Missing the required parameter 'path_analyzer_test_id' when calling change_path_analyzer_test_compartment." if path_analyzer_test_id.nil? raise "Missing the required parameter 'change_path_analyzer_test_compartment_details' when calling change_path_analyzer_test_compartment." if change_path_analyzer_test_compartment_details.nil? raise "Parameter value for 'path_analyzer_test_id' must not be blank" if OCI::Internal::Util.blank_string?(path_analyzer_test_id) path = '/pathAnalyzerTests/{pathAnalyzerTestId}/actions/changeCompartment'.sub('{pathAnalyzerTestId}', path_analyzer_test_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_path_analyzer_test_compartment_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VnMonitoringClient#change_path_analyzer_test_compartment') do @api_client.call_api( :POST, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body ) end # rubocop:enable Metrics/BlockLength end |
#create_path_analyzer_test(create_path_analyzer_test_details, opts = {}) ⇒ Response
Click here to see an example of how to use create_path_analyzer_test API.
Creates a new PathAnalyzerTest
resource.
183 184 185 186 187 188 189 190 191 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 |
# File 'lib/oci/vn_monitoring/vn_monitoring_client.rb', line 183 def create_path_analyzer_test(create_path_analyzer_test_details, opts = {}) logger.debug 'Calling operation VnMonitoringClient#create_path_analyzer_test.' if logger raise "Missing the required parameter 'create_path_analyzer_test_details' when calling create_path_analyzer_test." if create_path_analyzer_test_details.nil? path = '/pathAnalyzerTests' 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_path_analyzer_test_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VnMonitoringClient#create_path_analyzer_test') 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::VnMonitoring::Models::PathAnalyzerTest' ) end # rubocop:enable Metrics/BlockLength end |
#delete_path_analyzer_test(path_analyzer_test_id, opts = {}) ⇒ Response
Click here to see an example of how to use delete_path_analyzer_test API.
Deletes a PathAnalyzerTest
resource using its identifier.
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 |
# File 'lib/oci/vn_monitoring/vn_monitoring_client.rb', line 244 def delete_path_analyzer_test(path_analyzer_test_id, opts = {}) logger.debug 'Calling operation VnMonitoringClient#delete_path_analyzer_test.' if logger raise "Missing the required parameter 'path_analyzer_test_id' when calling delete_path_analyzer_test." if path_analyzer_test_id.nil? raise "Parameter value for 'path_analyzer_test_id' must not be blank" if OCI::Internal::Util.blank_string?(path_analyzer_test_id) path = '/pathAnalyzerTests/{pathAnalyzerTestId}'.sub('{pathAnalyzerTestId}', path_analyzer_test_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.(applicable_retry_config(opts), call_name: 'VnMonitoringClient#delete_path_analyzer_test') 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_path_analysis(get_path_analysis_details, opts = {}) ⇒ Response
Click here to see an example of how to use get_path_analysis API.
Use this method to initiate a Network Path Analyzer analysis. This method returns an opc-work-request-id, and you can poll the status of the work request until it either fails or succeeds.
If the work request status is successful, use list_work_request_results with the work request ID to ask for the successful analysis results. If the work request status is failed, use list_work_request_errors with the work request ID to ask for the analysis failure information. The information returned from either of these methods can be used to build a final report.
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 352 353 354 |
# File 'lib/oci/vn_monitoring/vn_monitoring_client.rb', line 317 def get_path_analysis(get_path_analysis_details, opts = {}) logger.debug 'Calling operation VnMonitoringClient#get_path_analysis.' if logger raise "Missing the required parameter 'get_path_analysis_details' when calling get_path_analysis." if get_path_analysis_details.nil? path = '/pathAnalysis' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] header_params[:'cache-control'] = opts[:cache_control] if opts[:cache_control] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = @api_client.object_to_http_body(get_path_analysis_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VnMonitoringClient#get_path_analysis') 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_path_analyzer_test(path_analyzer_test_id, opts = {}) ⇒ Response
Click here to see an example of how to use get_path_analyzer_test API.
Gets a PathAnalyzerTest
using its identifier.
374 375 376 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 |
# File 'lib/oci/vn_monitoring/vn_monitoring_client.rb', line 374 def get_path_analyzer_test(path_analyzer_test_id, opts = {}) logger.debug 'Calling operation VnMonitoringClient#get_path_analyzer_test.' if logger raise "Missing the required parameter 'path_analyzer_test_id' when calling get_path_analyzer_test." if path_analyzer_test_id.nil? raise "Parameter value for 'path_analyzer_test_id' must not be blank" if OCI::Internal::Util.blank_string?(path_analyzer_test_id) path = '/pathAnalyzerTests/{pathAnalyzerTestId}'.sub('{pathAnalyzerTestId}', path_analyzer_test_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.(applicable_retry_config(opts), call_name: 'VnMonitoringClient#get_path_analyzer_test') 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::VnMonitoring::Models::PathAnalyzerTest' ) end # rubocop:enable Metrics/BlockLength end |
#get_work_request(work_request_id, opts = {}) ⇒ Response
Click here to see an example of how to use get_work_request API.
Gets the details of a work request.
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 |
# File 'lib/oci/vn_monitoring/vn_monitoring_client.rb', line 430 def get_work_request(work_request_id, opts = {}) logger.debug 'Calling operation VnMonitoringClient#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.(applicable_retry_config(opts), call_name: 'VnMonitoringClient#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::VnMonitoring::Models::WorkRequest' ) end # rubocop:enable Metrics/BlockLength end |
#list_path_analyzer_tests(compartment_id, opts = {}) ⇒ Response
Click here to see an example of how to use list_path_analyzer_tests API.
Returns a list of all PathAnalyzerTests
in a compartment.
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 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 |
# File 'lib/oci/vn_monitoring/vn_monitoring_client.rb', line 513 def list_path_analyzer_tests(compartment_id, opts = {}) logger.debug 'Calling operation VnMonitoringClient#list_path_analyzer_tests.' if logger raise "Missing the required parameter 'compartment_id' when calling list_path_analyzer_tests." if compartment_id.nil? if opts[:lifecycle_state] && !OCI::VnMonitoring::Models::PathAnalyzerTest::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state]) raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::VnMonitoring::Models::PathAnalyzerTest::LIFECYCLE_STATE_ENUM.' 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 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 = '/pathAnalyzerTests' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:compartmentId] = compartment_id query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state] query_params[:displayName] = opts[:display_name] if opts[:display_name] query_params[: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.(applicable_retry_config(opts), call_name: 'VnMonitoringClient#list_path_analyzer_tests') 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::VnMonitoring::Models::PathAnalyzerTestCollection' ) end # rubocop:enable Metrics/BlockLength end |
#list_work_request_errors(work_request_id, opts = {}) ⇒ Response
Click here to see an example of how to use list_work_request_errors API.
Returns a (paginated) list of errors for the work request with the given ID. This information is used to build the final report output.
Allowed values are: timeCreated
605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 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 |
# File 'lib/oci/vn_monitoring/vn_monitoring_client.rb', line 605 def list_work_request_errors(work_request_id, opts = {}) logger.debug 'Calling operation VnMonitoringClient#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_order] && !%w[ASC DESC].include?(opts[:sort_order]) raise 'Invalid value for "sort_order", must be one of ASC, DESC.' end if opts[:sort_by] && !%w[timeCreated].include?(opts[:sort_by]) raise 'Invalid value for "sort_by", must be one of timeCreated.' end raise "Parameter value for '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[: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.(applicable_retry_config(opts), call_name: 'VnMonitoringClient#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::VnMonitoring::Models::WorkRequestErrorCollection' ) end # rubocop:enable Metrics/BlockLength end |
#list_work_request_logs(work_request_id, opts = {}) ⇒ Response
Click here to see an example of how to use list_work_request_logs API.
Returns a (paginated) list of logs for the work request with the given ID.
Allowed values are: timeCreated
691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 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 |
# File 'lib/oci/vn_monitoring/vn_monitoring_client.rb', line 691 def list_work_request_logs(work_request_id, opts = {}) logger.debug 'Calling operation VnMonitoringClient#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_order] && !%w[ASC DESC].include?(opts[:sort_order]) raise 'Invalid value for "sort_order", must be one of ASC, DESC.' end if opts[:sort_by] && !%w[timeCreated].include?(opts[:sort_by]) raise 'Invalid value for "sort_by", must be one of timeCreated.' end raise "Parameter value for '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[: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.(applicable_retry_config(opts), call_name: 'VnMonitoringClient#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::VnMonitoring::Models::WorkRequestLogEntryCollection' ) end # rubocop:enable Metrics/BlockLength end |
#list_work_request_results(work_request_id, opts = {}) ⇒ Response
Click here to see an example of how to use list_work_request_results API.
Returns a (paginated) list of results for a successful work request. This information is used to build the final report output.
772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 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 |
# File 'lib/oci/vn_monitoring/vn_monitoring_client.rb', line 772 def list_work_request_results(work_request_id, opts = {}) logger.debug 'Calling operation VnMonitoringClient#list_work_request_results.' if logger raise "Missing the required parameter 'work_request_id' when calling list_work_request_results." if work_request_id.nil? if opts[:result_type] && !OCI::VnMonitoring::Models::WorkRequestResult::RESULT_TYPE_ENUM.include?(opts[:result_type]) raise 'Invalid value for "result_type", must be one of the values in OCI::VnMonitoring::Models::WorkRequestResult::RESULT_TYPE_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}/results'.sub('{workRequestId}', work_request_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[:resultType] = opts[:result_type] if opts[:result_type] # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VnMonitoringClient#list_work_request_results') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::VnMonitoring::Models::WorkRequestResultCollection' ) end # rubocop:enable Metrics/BlockLength end |
#list_work_requests(compartment_id, opts = {}) ⇒ Response
Click here to see an example of how to use list_work_requests API.
Lists the work requests in a compartment. Allowed values are: timeAccepted
855 856 857 858 859 860 861 862 863 864 865 866 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 |
# File 'lib/oci/vn_monitoring/vn_monitoring_client.rb', line 855 def list_work_requests(compartment_id, opts = {}) logger.debug 'Calling operation VnMonitoringClient#list_work_requests.' if logger raise "Missing the required parameter 'compartment_id' when calling list_work_requests." if compartment_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 if opts[:sort_by] && !%w[timeAccepted].include?(opts[:sort_by]) raise 'Invalid value for "sort_by", must be one of timeAccepted.' end if opts[:status] && !OCI::VnMonitoring::Models::OPERATION_STATUS_ENUM.include?(opts[:status]) raise 'Invalid value for "status", must be one of the values in OCI::VnMonitoring::Models::OPERATION_STATUS_ENUM.' end path = '/workRequests' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:compartmentId] = compartment_id query_params[:workRequestId] = opts[:work_request_id] if opts[:work_request_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[:status] = opts[:status] if opts[:status] query_params[:resourceId] = opts[:resource_id] if opts[:resource_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.(applicable_retry_config(opts), call_name: 'VnMonitoringClient#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::VnMonitoring::Models::WorkRequestSummaryCollection' ) end # rubocop:enable Metrics/BlockLength end |
#logger ⇒ Logger
Returns The logger for this client. May be nil.
95 96 97 |
# File 'lib/oci/vn_monitoring/vn_monitoring_client.rb', line 95 def logger @api_client.config.logger end |
#update_path_analyzer_test(path_analyzer_test_id, update_path_analyzer_test_details, opts = {}) ⇒ Response
Click here to see an example of how to use update_path_analyzer_test API.
Updates a PathAnalyzerTest
using its identifier.
941 942 943 944 945 946 947 948 949 950 951 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 |
# File 'lib/oci/vn_monitoring/vn_monitoring_client.rb', line 941 def update_path_analyzer_test(path_analyzer_test_id, update_path_analyzer_test_details, opts = {}) logger.debug 'Calling operation VnMonitoringClient#update_path_analyzer_test.' if logger raise "Missing the required parameter 'path_analyzer_test_id' when calling update_path_analyzer_test." if path_analyzer_test_id.nil? raise "Missing the required parameter 'update_path_analyzer_test_details' when calling update_path_analyzer_test." if update_path_analyzer_test_details.nil? raise "Parameter value for 'path_analyzer_test_id' must not be blank" if OCI::Internal::Util.blank_string?(path_analyzer_test_id) path = '/pathAnalyzerTests/{pathAnalyzerTestId}'.sub('{pathAnalyzerTestId}', path_analyzer_test_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'if-match'] = opts[:if_match] if opts[:if_match] header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = @api_client.object_to_http_body(update_path_analyzer_test_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VnMonitoringClient#update_path_analyzer_test') 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::VnMonitoring::Models::PathAnalyzerTest' ) end # rubocop:enable Metrics/BlockLength end |