Class: OCI::OsManagementHub::WorkRequestClient
- Inherits:
-
Object
- Object
- OCI::OsManagementHub::WorkRequestClient
- Defined in:
- lib/oci/os_management_hub/work_request_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
-
#get_work_request(work_request_id, opts = {}) ⇒ Response
Gets information about the specified work request.
-
#initialize(config: nil, region: nil, endpoint: nil, signer: nil, proxy_settings: nil, retry_config: nil) ⇒ WorkRequestClient
constructor
Creates a new WorkRequestClient.
-
#list_work_request_errors(work_request_id, opts = {}) ⇒ Response
Gets the errors for the specified work request.
-
#list_work_request_logs(work_request_id, opts = {}) ⇒ Response
Gets the logs for the specified work request.
-
#list_work_requests(opts = {}) ⇒ Response
Lists work requests that match the specified compartment or work request OCID.
-
#logger ⇒ Logger
The logger for this client.
Constructor Details
#initialize(config: nil, region: nil, endpoint: nil, signer: nil, proxy_settings: nil, retry_config: nil) ⇒ WorkRequestClient
Creates a new WorkRequestClient. 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/work_request_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 "WorkRequestClient 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/work_request_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/work_request_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/work_request_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/work_request_client.rb', line 26 def retry_config @retry_config end |
Instance Method Details
#get_work_request(work_request_id, opts = {}) ⇒ Response
Click here to see an example of how to use get_work_request API.
Gets information about the specified work request.
112 113 114 115 116 117 118 119 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 |
# File 'lib/oci/os_management_hub/work_request_client.rb', line 112 def get_work_request(work_request_id, opts = {}) logger.debug 'Calling operation WorkRequestClient#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: 'WorkRequestClient#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::OsManagementHub::Models::WorkRequest' ) 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.
Gets the errors for the specified work request.
182 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 221 222 223 224 225 226 227 228 229 230 |
# File 'lib/oci/os_management_hub/work_request_client.rb', line 182 def list_work_request_errors(work_request_id, opts = {}) logger.debug 'Calling operation WorkRequestClient#list_work_request_errors.' if logger raise "Missing the required parameter 'work_request_id' when calling list_work_request_errors." if work_request_id.nil? if opts[:sort_by] && !%w[timeCreated displayName].include?(opts[:sort_by]) raise 'Invalid value for "sort_by", must be one of timeCreated, displayName.' 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 raise "Parameter value for 'work_request_id' must not be blank" if OCI::Internal::Util.blank_string?(work_request_id) path = '/workRequests/{workRequestId}/errors'.sub('{workRequestId}', work_request_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:page] = opts[:page] if opts[:page] query_params[:limit] = opts[:limit] if opts[:limit] query_params[:sortBy] = opts[:sort_by] if opts[:sort_by] query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order] # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'WorkRequestClient#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::OsManagementHub::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.
Gets the logs for the specified work request.
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 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 |
# File 'lib/oci/os_management_hub/work_request_client.rb', line 264 def list_work_request_logs(work_request_id, opts = {}) logger.debug 'Calling operation WorkRequestClient#list_work_request_logs.' if logger raise "Missing the required parameter 'work_request_id' when calling list_work_request_logs." if work_request_id.nil? if opts[:sort_by] && !%w[timeCreated displayName].include?(opts[:sort_by]) raise 'Invalid value for "sort_by", must be one of timeCreated, displayName.' 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 raise "Parameter value for 'work_request_id' must not be blank" if OCI::Internal::Util.blank_string?(work_request_id) path = '/workRequests/{workRequestId}/logs'.sub('{workRequestId}', work_request_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:page] = opts[:page] if opts[:page] query_params[:limit] = opts[:limit] if opts[:limit] query_params[:sortBy] = opts[:sort_by] if opts[:sort_by] query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order] # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'WorkRequestClient#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::OsManagementHub::Models::WorkRequestLogEntryCollection' ) end # rubocop:enable Metrics/BlockLength end |
#list_work_requests(opts = {}) ⇒ Response
Click here to see an example of how to use list_work_requests API.
Lists work requests that match the specified compartment or work request OCID. Filter the list against a variety of criteria including but not limited to its name, status, and operation type.
366 367 368 369 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 |
# File 'lib/oci/os_management_hub/work_request_client.rb', line 366 def list_work_requests(opts = {}) logger.debug 'Calling operation WorkRequestClient#list_work_requests.' if logger status_allowable_values = %w[ACCEPTED IN_PROGRESS FAILED SUCCEEDED CANCELING CANCELED] if opts[:status] && !opts[:status].empty? opts[:status].each do |val_to_check| unless status_allowable_values.include?(val_to_check) raise 'Invalid value for "status", must be one of ACCEPTED, IN_PROGRESS, FAILED, SUCCEEDED, CANCELING, CANCELED.' 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 displayName].include?(opts[:sort_by]) raise 'Invalid value for "sort_by", must be one of timeCreated, displayName.' end operation_type_allowable_values = %w[INSTALL_PACKAGES REMOVE_PACKAGES UPDATE_PACKAGES UPDATE_ALL_PACKAGES UPDATE_SECURITY UPDATE_BUGFIX UPDATE_ENHANCEMENT UPDATE_OTHER UPDATE_KSPLICE_KERNEL UPDATE_KSPLICE_USERSPACE ENABLE_MODULE_STREAMS DISABLE_MODULE_STREAMS SWITCH_MODULE_STREAM INSTALL_MODULE_PROFILES REMOVE_MODULE_PROFILES SET_SOFTWARE_SOURCES LIST_PACKAGES SET_MANAGEMENT_STATION_CONFIG SYNC_MANAGEMENT_STATION_MIRROR UPDATE_MANAGEMENT_STATION_SOFTWARE UPDATE MODULE_ACTIONS LIFECYCLE_PROMOTION CREATE_SOFTWARE_SOURCE UPDATE_SOFTWARE_SOURCE IMPORT_CONTENT SYNC_AGENT_CONFIG INSTALL_WINDOWS_UPDATES LIST_WINDOWS_UPDATE GET_WINDOWS_UPDATE_DETAILS INSTALL_ALL_WINDOWS_UPDATES INSTALL_SECURITY_WINDOWS_UPDATES INSTALL_BUGFIX_WINDOWS_UPDATES INSTALL_ENHANCEMENT_WINDOWS_UPDATES INSTALL_OTHER_WINDOWS_UPDATES REMOVE_CONTENT UNREGISTER_MANAGED_INSTANCE] if opts[:operation_type] && !opts[:operation_type].empty? opts[:operation_type].each do |val_to_check| unless operation_type_allowable_values.include?(val_to_check) raise 'Invalid value for "operation_type", must be one of INSTALL_PACKAGES, REMOVE_PACKAGES, UPDATE_PACKAGES, UPDATE_ALL_PACKAGES, UPDATE_SECURITY, UPDATE_BUGFIX, UPDATE_ENHANCEMENT, UPDATE_OTHER, UPDATE_KSPLICE_KERNEL, UPDATE_KSPLICE_USERSPACE, ENABLE_MODULE_STREAMS, DISABLE_MODULE_STREAMS, SWITCH_MODULE_STREAM, INSTALL_MODULE_PROFILES, REMOVE_MODULE_PROFILES, SET_SOFTWARE_SOURCES, LIST_PACKAGES, SET_MANAGEMENT_STATION_CONFIG, SYNC_MANAGEMENT_STATION_MIRROR, UPDATE_MANAGEMENT_STATION_SOFTWARE, UPDATE, MODULE_ACTIONS, LIFECYCLE_PROMOTION, CREATE_SOFTWARE_SOURCE, UPDATE_SOFTWARE_SOURCE, IMPORT_CONTENT, SYNC_AGENT_CONFIG, INSTALL_WINDOWS_UPDATES, LIST_WINDOWS_UPDATE, GET_WINDOWS_UPDATE_DETAILS, INSTALL_ALL_WINDOWS_UPDATES, INSTALL_SECURITY_WINDOWS_UPDATES, INSTALL_BUGFIX_WINDOWS_UPDATES, INSTALL_ENHANCEMENT_WINDOWS_UPDATES, INSTALL_OTHER_WINDOWS_UPDATES, REMOVE_CONTENT, UNREGISTER_MANAGED_INSTANCE.' end end end path = '/workRequests' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:compartmentId] = opts[:compartment_id] if opts[:compartment_id] query_params[:workRequestId] = opts[:work_request_id] if opts[:work_request_id] query_params[:status] = OCI::ApiClient.build_collection_params(opts[:status], :multi) if opts[:status] && !opts[:status].empty? query_params[:resourceId] = opts[:resource_id] if opts[:resource_id] query_params[:page] = opts[:page] if opts[:page] query_params[:limit] = opts[:limit] if opts[:limit] query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order] query_params[:sortBy] = opts[:sort_by] if opts[:sort_by] query_params[:initiatorId] = opts[:initiator_id] if opts[:initiator_id] query_params[:parentId] = opts[:parent_id] if opts[:parent_id] query_params[:parentResourcesNotEqualTo] = OCI::ApiClient.build_collection_params(opts[:parent_resources_not_equal_to], :multi) if opts[:parent_resources_not_equal_to] && !opts[:parent_resources_not_equal_to].empty? query_params[:operationType] = OCI::ApiClient.build_collection_params(opts[:operation_type], :multi) if opts[:operation_type] && !opts[:operation_type].empty? query_params[:displayNameContains] = opts[:display_name_contains] if opts[:display_name_contains] query_params[:retryOfId] = opts[:retry_of_id] if opts[:retry_of_id] 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[: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: 'WorkRequestClient#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::OsManagementHub::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/os_management_hub/work_request_client.rb', line 95 def logger @api_client.config.logger end |