Class: OCI::OsManagementHub::EventClient
- Inherits:
-
Object
- Object
- OCI::OsManagementHub::EventClient
- Defined in:
- lib/oci/os_management_hub/event_client.rb
Overview
Use the OS Management Hub API to manage and monitor updates and patches for instances in OCI, your private data center, or 3rd-party clouds. For more information, see Overview of OS Management Hub.
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_event_compartment(change_event_compartment_details, event_id, opts = {}) ⇒ Response
Moves an event into a different compartment within the same tenancy.
-
#delete_event(event_id, opts = {}) ⇒ Response
Deletes the specified event.
-
#delete_event_content(event_id, opts = {}) ⇒ Response
Deletes an event content ZIP archive from the service.
-
#get_event(event_id, opts = {}) ⇒ Response
Returns information about the specified event.
-
#get_event_content(event_id, opts = {}, &block) ⇒ Response
Returns a ZIP archive with additional information about an event.
-
#import_event_content(event_id, opts = {}) ⇒ Response
Uploads an event content ZIP archive from an instance to the service.
-
#initialize(config: nil, region: nil, endpoint: nil, signer: nil, proxy_settings: nil, retry_config: nil) ⇒ EventClient
constructor
Creates a new EventClient.
-
#list_events(opts = {}) ⇒ Response
Lists events that match the specified criteria, such as compartment, state, and event type.
-
#logger ⇒ Logger
The logger for this client.
-
#update_event(event_id, update_event_details, opts = {}) ⇒ Response
Updates the tags for an event.
Constructor Details
#initialize(config: nil, region: nil, endpoint: nil, signer: nil, proxy_settings: nil, retry_config: nil) ⇒ EventClient
Creates a new EventClient. 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/os_management_hub/event_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 + '/20220901' else region ||= config.region region ||= signer.region if signer.respond_to?(:region) self.region = region end logger.info "EventClient 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/os_management_hub/event_client.rb', line 16 def api_client @api_client end |
#endpoint ⇒ String (readonly)
Fully qualified endpoint URL
20 21 22 |
# File 'lib/oci/os_management_hub/event_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/os_management_hub/event_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/os_management_hub/event_client.rb', line 26 def retry_config @retry_config end |
Instance Method Details
#change_event_compartment(change_event_compartment_details, event_id, opts = {}) ⇒ Response
Click here to see an example of how to use change_event_compartment API.
Moves an event into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.
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 158 159 160 161 162 163 164 165 166 |
# File 'lib/oci/os_management_hub/event_client.rb', line 127 def change_event_compartment(change_event_compartment_details, event_id, opts = {}) logger.debug 'Calling operation EventClient#change_event_compartment.' if logger raise "Missing the required parameter 'change_event_compartment_details' when calling change_event_compartment." if change_event_compartment_details.nil? raise "Missing the required parameter 'event_id' when calling change_event_compartment." if event_id.nil? raise "Parameter value for 'event_id' must not be blank" if OCI::Internal::Util.blank_string?(event_id) path = '/events/{eventId}/actions/changeCompartment'.sub('{eventId}', event_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_event_compartment_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'EventClient#change_event_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 |
#delete_event(event_id, opts = {}) ⇒ Response
Click here to see an example of how to use delete_event API.
Deletes the specified event.
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 221 222 223 224 225 226 |
# File 'lib/oci/os_management_hub/event_client.rb', line 190 def delete_event(event_id, opts = {}) logger.debug 'Calling operation EventClient#delete_event.' if logger raise "Missing the required parameter 'event_id' when calling delete_event." if event_id.nil? raise "Parameter value for 'event_id' must not be blank" if OCI::Internal::Util.blank_string?(event_id) path = '/events/{eventId}'.sub('{eventId}', event_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: 'EventClient#delete_event') 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_event_content(event_id, opts = {}) ⇒ Response
Click here to see an example of how to use delete_event_content API.
Deletes an event content ZIP archive from the service.
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 292 293 294 295 |
# File 'lib/oci/os_management_hub/event_client.rb', line 257 def delete_event_content(event_id, opts = {}) logger.debug 'Calling operation EventClient#delete_event_content.' if logger raise "Missing the required parameter 'event_id' when calling delete_event_content." if event_id.nil? raise "Parameter value for 'event_id' must not be blank" if OCI::Internal::Util.blank_string?(event_id) path = '/events/{eventId}/content'.sub('{eventId}', event_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] 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.(applicable_retry_config(opts), call_name: 'EventClient#delete_event_content') 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_event(event_id, opts = {}) ⇒ Response
Click here to see an example of how to use get_event API.
Returns information about the specified event.
313 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 |
# File 'lib/oci/os_management_hub/event_client.rb', line 313 def get_event(event_id, opts = {}) logger.debug 'Calling operation EventClient#get_event.' if logger raise "Missing the required parameter 'event_id' when calling get_event." if event_id.nil? raise "Parameter value for 'event_id' must not be blank" if OCI::Internal::Util.blank_string?(event_id) path = '/events/{eventId}'.sub('{eventId}', event_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: 'EventClient#get_event') 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::OsManagementHub::Models::Event' ) end # rubocop:enable Metrics/BlockLength end |
#get_event_content(event_id, opts = {}, &block) ⇒ Response
Click here to see an example of how to use get_event_content API.
Returns a ZIP archive with additional information about an event. The archive content depends on the event type.
370 371 372 373 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 411 412 413 414 415 416 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 |
# File 'lib/oci/os_management_hub/event_client.rb', line 370 def get_event_content(event_id, opts = {}, &block) logger.debug 'Calling operation EventClient#get_event_content.' if logger raise "Missing the required parameter 'event_id' when calling get_event_content." if event_id.nil? raise "Parameter value for 'event_id' must not be blank" if OCI::Internal::Util.blank_string?(event_id) path = '/events/{eventId}/content'.sub('{eventId}', event_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = opts[:accept] if opts[:accept] header_params[:accept] ||= 'application/octet-stream' header_params[:'accept-encoding'] = opts[:accept_encoding] if opts[:accept_encoding] header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'EventClient#get_event_content') do if !block.nil? @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'Stream', &block ) elsif opts[:response_target] if opts[:response_target].respond_to? :write @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'Stream', &proc { |chunk, _response| opts[:response_target].write(chunk) } ) elsif opts[:response_target].is_a?(String) File.open(opts[:response_target], 'wb') do |output| return @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'Stream', &proc { |chunk, _response| output.write(chunk) } ) end end else @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'String' ) end end # rubocop:enable Metrics/BlockLength end |
#import_event_content(event_id, opts = {}) ⇒ Response
Click here to see an example of how to use import_event_content API.
Uploads an event content ZIP archive from an instance to the service.
481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 |
# File 'lib/oci/os_management_hub/event_client.rb', line 481 def import_event_content(event_id, opts = {}) logger.debug 'Calling operation EventClient#import_event_content.' if logger raise "Missing the required parameter 'event_id' when calling import_event_content." if event_id.nil? raise "Parameter value for 'event_id' must not be blank" if OCI::Internal::Util.blank_string?(event_id) path = '/events/{eventId}/actions/importContent'.sub('{eventId}', event_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] 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.(applicable_retry_config(opts), call_name: 'EventClient#import_event_content') 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 |
#list_events(opts = {}) ⇒ Response
Click here to see an example of how to use list_events API.
Lists events that match the specified criteria, such as compartment, state, and event type.
Allowed values are: timeCreated, timeOccurredAt, timeUpdated, eventSummary
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 600 601 602 603 604 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 |
# File 'lib/oci/os_management_hub/event_client.rb', line 569 def list_events(opts = {}) logger.debug 'Calling operation EventClient#list_events.' if logger if opts[:lifecycle_state] && !OCI::OsManagementHub::Models::Event::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state]) raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::OsManagementHub::Models::Event::LIFECYCLE_STATE_ENUM.' end type_allowable_values = %w[KERNEL_OOPS KERNEL_CRASH EXPLOIT_ATTEMPT SOFTWARE_UPDATE KSPLICE_UPDATE SOFTWARE_SOURCE AGENT MANAGEMENT_STATION] if opts[:type] && !opts[:type].empty? opts[:type].each do |val_to_check| unless type_allowable_values.include?(val_to_check) raise 'Invalid value for "type", must be one of KERNEL_OOPS, KERNEL_CRASH, EXPLOIT_ATTEMPT, SOFTWARE_UPDATE, KSPLICE_UPDATE, SOFTWARE_SOURCE, AGENT, MANAGEMENT_STATION.' end end end if opts[:sort_order] && !OCI::OsManagementHub::Models::SORT_ORDER_ENUM.include?(opts[:sort_order]) raise 'Invalid value for "sort_order", must be one of the values in OCI::OsManagementHub::Models::SORT_ORDER_ENUM.' end if opts[:sort_by] && !%w[timeCreated timeOccurredAt timeUpdated eventSummary].include?(opts[:sort_by]) raise 'Invalid value for "sort_by", must be one of timeCreated, timeOccurredAt, timeUpdated, eventSummary.' end path = '/events' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:eventSummary] = opts[:event_summary] if opts[:event_summary] query_params[:eventSummaryContains] = opts[:event_summary_contains] if opts[:event_summary_contains] query_params[:id] = opts[:id] if opts[:id] query_params[:eventFingerprint] = opts[:event_fingerprint] if opts[:event_fingerprint] query_params[:compartmentId] = opts[:compartment_id] if opts[:compartment_id] query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state] query_params[:resourceId] = opts[:resource_id] if opts[:resource_id] query_params[:type] = OCI::ApiClient.build_collection_params(opts[:type], :multi) if opts[:type] && !opts[:type].empty? query_params[:limit] = opts[:limit] if opts[:limit] query_params[:page] = opts[:page] if opts[:page] query_params[:timeCreatedLessThan] = opts[:time_created_less_than] if opts[:time_created_less_than] query_params[:timeCreatedGreaterThanOrEqualTo] = opts[:time_created_greater_than_or_equal_to] if opts[:time_created_greater_than_or_equal_to] query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order] query_params[:sortBy] = opts[:sort_by] if opts[:sort_by] query_params[:isManagedByAutonomousLinux] = opts[:is_managed_by_autonomous_linux] if !opts[:is_managed_by_autonomous_linux].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.(applicable_retry_config(opts), call_name: 'EventClient#list_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::OsManagementHub::Models::EventCollection' ) end # rubocop:enable Metrics/BlockLength end |
#logger ⇒ Logger
Returns The logger for this client. May be nil.
95 96 97 |
# File 'lib/oci/os_management_hub/event_client.rb', line 95 def logger @api_client.config.logger end |
#update_event(event_id, update_event_details, opts = {}) ⇒ Response
Click here to see an example of how to use update_event API.
Updates the tags for an event.
665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 |
# File 'lib/oci/os_management_hub/event_client.rb', line 665 def update_event(event_id, update_event_details, opts = {}) logger.debug 'Calling operation EventClient#update_event.' if logger raise "Missing the required parameter 'event_id' when calling update_event." if event_id.nil? raise "Missing the required parameter 'update_event_details' when calling update_event." if update_event_details.nil? raise "Parameter value for 'event_id' must not be blank" if OCI::Internal::Util.blank_string?(event_id) path = '/events/{eventId}'.sub('{eventId}', event_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_event_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'EventClient#update_event') 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::OsManagementHub::Models::Event' ) end # rubocop:enable Metrics/BlockLength end |