Class: OCI::OsManagementHub::ScheduledJobClient
- Inherits:
-
Object
- Object
- OCI::OsManagementHub::ScheduledJobClient
- Defined in:
- lib/oci/os_management_hub/scheduled_job_client.rb
Overview
Use the OS Management Hub API to manage and monitor updates and patches for the operating system environments in your private data centers through a single management console. 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
-
#create_scheduled_job(create_scheduled_job_details, opts = {}) ⇒ Response
Creates a new scheduled job.
-
#delete_scheduled_job(scheduled_job_id, opts = {}) ⇒ Response
Deletes the specified scheduled job.
-
#get_scheduled_job(scheduled_job_id, opts = {}) ⇒ Response
Gets information about the specified scheduled job.
-
#initialize(config: nil, region: nil, endpoint: nil, signer: nil, proxy_settings: nil, retry_config: nil) ⇒ ScheduledJobClient
constructor
Creates a new ScheduledJobClient.
-
#list_scheduled_jobs(opts = {}) ⇒ Response
Lists scheduled jobs that match the specified compartment or scheduled job OCID.
-
#logger ⇒ Logger
The logger for this client.
-
#run_scheduled_job_now(scheduled_job_id, opts = {}) ⇒ Response
Triggers an already created RECURRING scheduled job to run immediately instead of waiting for its next regularly scheduled time.
-
#update_scheduled_job(scheduled_job_id, update_scheduled_job_details, opts = {}) ⇒ Response
Updates the specified scheduled job's name, description, and other details, such as next execution and recurrence.
Constructor Details
#initialize(config: nil, region: nil, endpoint: nil, signer: nil, proxy_settings: nil, retry_config: nil) ⇒ ScheduledJobClient
Creates a new ScheduledJobClient. 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.
55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 |
# File 'lib/oci/os_management_hub/scheduled_job_client.rb', line 55 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 "ScheduledJobClient endpoint set to '#{@endpoint}'." if logger end |
Instance Attribute Details
#api_client ⇒ OCI::ApiClient (readonly)
Client used to make HTTP requests.
15 16 17 |
# File 'lib/oci/os_management_hub/scheduled_job_client.rb', line 15 def api_client @api_client end |
#endpoint ⇒ String (readonly)
Fully qualified endpoint URL
19 20 21 |
# File 'lib/oci/os_management_hub/scheduled_job_client.rb', line 19 def endpoint @endpoint end |
#region ⇒ String
The region, which will usually correspond to a value in Regions::REGION_ENUM.
29 30 31 |
# File 'lib/oci/os_management_hub/scheduled_job_client.rb', line 29 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
25 26 27 |
# File 'lib/oci/os_management_hub/scheduled_job_client.rb', line 25 def retry_config @retry_config end |
Instance Method Details
#create_scheduled_job(create_scheduled_job_details, opts = {}) ⇒ Response
Click here to see an example of how to use create_scheduled_job API.
Creates a new scheduled job.
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 149 150 151 152 153 154 155 |
# File 'lib/oci/os_management_hub/scheduled_job_client.rb', line 118 def create_scheduled_job(create_scheduled_job_details, opts = {}) logger.debug 'Calling operation ScheduledJobClient#create_scheduled_job.' if logger raise "Missing the required parameter 'create_scheduled_job_details' when calling create_scheduled_job." if create_scheduled_job_details.nil? path = '/scheduledJobs' 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_scheduled_job_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'ScheduledJobClient#create_scheduled_job') 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::OsManagementHub::Models::ScheduledJob' ) end # rubocop:enable Metrics/BlockLength end |
#delete_scheduled_job(scheduled_job_id, opts = {}) ⇒ Response
Click here to see an example of how to use delete_scheduled_job API.
Deletes the specified scheduled job.
180 181 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 |
# File 'lib/oci/os_management_hub/scheduled_job_client.rb', line 180 def delete_scheduled_job(scheduled_job_id, opts = {}) logger.debug 'Calling operation ScheduledJobClient#delete_scheduled_job.' if logger raise "Missing the required parameter 'scheduled_job_id' when calling delete_scheduled_job." if scheduled_job_id.nil? raise "Parameter value for 'scheduled_job_id' must not be blank" if OCI::Internal::Util.blank_string?(scheduled_job_id) path = '/scheduledJobs/{scheduledJobId}'.sub('{scheduledJobId}', scheduled_job_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: 'ScheduledJobClient#delete_scheduled_job') 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_scheduled_job(scheduled_job_id, opts = {}) ⇒ Response
Click here to see an example of how to use get_scheduled_job API.
Gets information about the specified scheduled job.
235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 |
# File 'lib/oci/os_management_hub/scheduled_job_client.rb', line 235 def get_scheduled_job(scheduled_job_id, opts = {}) logger.debug 'Calling operation ScheduledJobClient#get_scheduled_job.' if logger raise "Missing the required parameter 'scheduled_job_id' when calling get_scheduled_job." if scheduled_job_id.nil? raise "Parameter value for 'scheduled_job_id' must not be blank" if OCI::Internal::Util.blank_string?(scheduled_job_id) path = '/scheduledJobs/{scheduledJobId}'.sub('{scheduledJobId}', scheduled_job_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: 'ScheduledJobClient#get_scheduled_job') 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::ScheduledJob' ) end # rubocop:enable Metrics/BlockLength end |
#list_scheduled_jobs(opts = {}) ⇒ Response
Click here to see an example of how to use list_scheduled_jobs API.
Lists scheduled jobs that match the specified compartment or scheduled job OCID. Filter the list against a variety of criteria including but not limited to its display name, lifecycle state, operation type, and schedule type.
Allowed values are: timeCreated, displayName
329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 |
# File 'lib/oci/os_management_hub/scheduled_job_client.rb', line 329 def list_scheduled_jobs(opts = {}) logger.debug 'Calling operation ScheduledJobClient#list_scheduled_jobs.' if logger if opts[:lifecycle_state] && !OCI::OsManagementHub::Models::ScheduledJob::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state]) raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::OsManagementHub::Models::ScheduledJob::LIFECYCLE_STATE_ENUM.' end if opts[:operation_type] && !OCI::OsManagementHub::Models::OPERATION_TYPES_ENUM.include?(opts[:operation_type]) raise 'Invalid value for "operation_type", must be one of the values in OCI::OsManagementHub::Models::OPERATION_TYPES_ENUM.' end if opts[:schedule_type] && !OCI::OsManagementHub::Models::SCHEDULE_TYPES_ENUM.include?(opts[:schedule_type]) raise 'Invalid value for "schedule_type", must be one of the values in OCI::OsManagementHub::Models::SCHEDULE_TYPES_ENUM.' 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 path = '/scheduledJobs' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:compartmentId] = opts[:compartment_id] if opts[:compartment_id] query_params[:displayName] = opts[:display_name] if opts[:display_name] query_params[:displayNameContains] = opts[:display_name_contains] if opts[:display_name_contains] query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state] query_params[:managedInstanceId] = opts[:managed_instance_id] if opts[:managed_instance_id] query_params[:managedInstanceGroupId] = opts[:managed_instance_group_id] if opts[:managed_instance_group_id] query_params[:managedCompartmentId] = opts[:managed_compartment_id] if opts[:managed_compartment_id] query_params[:lifecycleStageId] = opts[:lifecycle_stage_id] if opts[:lifecycle_stage_id] query_params[:operationType] = opts[:operation_type] if opts[:operation_type] query_params[:scheduleType] = opts[:schedule_type] if opts[:schedule_type] query_params[:timeStart] = opts[:time_start] if opts[:time_start] query_params[:timeEnd] = opts[:time_end] if opts[:time_end] 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[:isRestricted] = opts[:is_restricted] if !opts[:is_restricted].nil? query_params[:id] = opts[:id] if opts[:id] query_params[:compartmentIdInSubtree] = opts[:compartment_id_in_subtree] if !opts[:compartment_id_in_subtree].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: 'ScheduledJobClient#list_scheduled_jobs') 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::ScheduledJobCollection' ) end # rubocop:enable Metrics/BlockLength end |
#logger ⇒ Logger
Returns The logger for this client. May be nil.
94 95 96 |
# File 'lib/oci/os_management_hub/scheduled_job_client.rb', line 94 def logger @api_client.config.logger end |
#run_scheduled_job_now(scheduled_job_id, opts = {}) ⇒ Response
Click here to see an example of how to use run_scheduled_job_now API.
Triggers an already created RECURRING scheduled job to run immediately instead of waiting for its next regularly scheduled time. This operation does not support ONETIME scheduled job.
434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 |
# File 'lib/oci/os_management_hub/scheduled_job_client.rb', line 434 def run_scheduled_job_now(scheduled_job_id, opts = {}) logger.debug 'Calling operation ScheduledJobClient#run_scheduled_job_now.' if logger raise "Missing the required parameter 'scheduled_job_id' when calling run_scheduled_job_now." if scheduled_job_id.nil? raise "Parameter value for 'scheduled_job_id' must not be blank" if OCI::Internal::Util.blank_string?(scheduled_job_id) path = '/scheduledJobs/{scheduledJobId}/actions/runNow'.sub('{scheduledJobId}', scheduled_job_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: 'ScheduledJobClient#run_scheduled_job_now') 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 |
#update_scheduled_job(scheduled_job_id, update_scheduled_job_details, opts = {}) ⇒ Response
Click here to see an example of how to use update_scheduled_job API.
Updates the specified scheduled job's name, description, and other details, such as next execution and recurrence.
498 499 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 |
# File 'lib/oci/os_management_hub/scheduled_job_client.rb', line 498 def update_scheduled_job(scheduled_job_id, update_scheduled_job_details, opts = {}) logger.debug 'Calling operation ScheduledJobClient#update_scheduled_job.' if logger raise "Missing the required parameter 'scheduled_job_id' when calling update_scheduled_job." if scheduled_job_id.nil? raise "Missing the required parameter 'update_scheduled_job_details' when calling update_scheduled_job." if update_scheduled_job_details.nil? raise "Parameter value for 'scheduled_job_id' must not be blank" if OCI::Internal::Util.blank_string?(scheduled_job_id) path = '/scheduledJobs/{scheduledJobId}'.sub('{scheduledJobId}', scheduled_job_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_scheduled_job_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'ScheduledJobClient#update_scheduled_job') 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::ScheduledJob' ) end # rubocop:enable Metrics/BlockLength end |