Class: OCI::EmWarehouse::EmWarehouseClient
- Inherits:
-
Object
- Object
- OCI::EmWarehouse::EmWarehouseClient
- Defined in:
- lib/oci/em_warehouse/em_warehouse_client.rb
Overview
Use the EM Warehouse API to manage EM Warehouse data collection.
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
-
#cancel_work_request(work_request_id, opts = {}) ⇒ Response
Cancels the work request with the given ID.
-
#change_em_warehouse_compartment(em_warehouse_id, change_em_warehouse_compartment_details, opts = {}) ⇒ Response
Moves a EmWarehouse resource from one compartment identifier to another.
-
#create_em_warehouse(create_em_warehouse_details, opts = {}) ⇒ Response
Creates a new EmWarehouse.
-
#delete_em_warehouse(em_warehouse_id, opts = {}) ⇒ Response
Deletes a EmWarehouse resource by identifier.
-
#get_em_warehouse(em_warehouse_id, opts = {}) ⇒ Response
Gets a EmWarehouse by identifier.
-
#get_em_warehouse_resource_usage(em_warehouse_id, opts = {}) ⇒ Response
Gets a EmWarehouseResourceUsage by identifier.
-
#get_work_request(work_request_id, opts = {}) ⇒ Response
Gets details of the work request with the given ID.
-
#initialize(config: nil, region: nil, endpoint: nil, signer: nil, proxy_settings: nil, retry_config: nil) ⇒ EmWarehouseClient
constructor
Creates a new EmWarehouseClient.
-
#list_em_warehouses(opts = {}) ⇒ Response
Returns a list of EmWarehouses.
-
#list_etl_runs(em_warehouse_id, opts = {}) ⇒ Response
Gets a list of runs of an EmWarehouseResource by identifier Allowed values are: timeCreated, displayName.
-
#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_requests(opts = {}) ⇒ Response
Lists the work requests in a compartment.
-
#logger ⇒ Logger
The logger for this client.
-
#update_em_warehouse(em_warehouse_id, update_em_warehouse_details, opts = {}) ⇒ Response
Updates the EmWarehouse.
Constructor Details
#initialize(config: nil, region: nil, endpoint: nil, signer: nil, proxy_settings: nil, retry_config: nil) ⇒ EmWarehouseClient
Creates a new EmWarehouseClient. 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/em_warehouse/em_warehouse_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 + '/20180828' else region ||= config.region region ||= signer.region if signer.respond_to?(:region) self.region = region end logger.info "EmWarehouseClient 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/em_warehouse/em_warehouse_client.rb', line 15 def api_client @api_client end |
#endpoint ⇒ String (readonly)
Fully qualified endpoint URL
19 20 21 |
# File 'lib/oci/em_warehouse/em_warehouse_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/em_warehouse/em_warehouse_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/em_warehouse/em_warehouse_client.rb', line 25 def retry_config @retry_config end |
Instance Method Details
#cancel_work_request(work_request_id, opts = {}) ⇒ Response
Click here to see an example of how to use cancel_work_request API.
Cancels the work request with the given ID.
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 149 150 151 152 153 |
# File 'lib/oci/em_warehouse/em_warehouse_client.rb', line 117 def cancel_work_request(work_request_id, opts = {}) logger.debug 'Calling operation EmWarehouseClient#cancel_work_request.' if logger raise "Missing the required parameter 'work_request_id' when calling cancel_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[:'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: 'EmWarehouseClient#cancel_work_request') 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 |
#change_em_warehouse_compartment(em_warehouse_id, change_em_warehouse_compartment_details, opts = {}) ⇒ Response
Click here to see an example of how to use change_em_warehouse_compartment API.
Moves a EmWarehouse resource from one compartment identifier to another. When provided, If-Match is checked against ETag values of the resource.
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 |
# File 'lib/oci/em_warehouse/em_warehouse_client.rb', line 184 def change_em_warehouse_compartment(em_warehouse_id, change_em_warehouse_compartment_details, opts = {}) logger.debug 'Calling operation EmWarehouseClient#change_em_warehouse_compartment.' if logger raise "Missing the required parameter 'em_warehouse_id' when calling change_em_warehouse_compartment." if em_warehouse_id.nil? raise "Missing the required parameter 'change_em_warehouse_compartment_details' when calling change_em_warehouse_compartment." if change_em_warehouse_compartment_details.nil? raise "Parameter value for 'em_warehouse_id' must not be blank" if OCI::Internal::Util.blank_string?(em_warehouse_id) path = '/emWarehouses/{emWarehouseId}/actions/changeCompartment'.sub('{emWarehouseId}', em_warehouse_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_em_warehouse_compartment_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'EmWarehouseClient#change_em_warehouse_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_em_warehouse(create_em_warehouse_details, opts = {}) ⇒ Response
Click here to see an example of how to use create_em_warehouse API.
Creates a new EmWarehouse.
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 281 282 283 284 |
# File 'lib/oci/em_warehouse/em_warehouse_client.rb', line 248 def create_em_warehouse(create_em_warehouse_details, opts = {}) logger.debug 'Calling operation EmWarehouseClient#create_em_warehouse.' if logger raise "Missing the required parameter 'create_em_warehouse_details' when calling create_em_warehouse." if create_em_warehouse_details.nil? path = '/emWarehouses' 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_em_warehouse_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'EmWarehouseClient#create_em_warehouse') 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_em_warehouse(em_warehouse_id, opts = {}) ⇒ Response
Click here to see an example of how to use delete_em_warehouse API.
Deletes a EmWarehouse resource by identifier
308 309 310 311 312 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 |
# File 'lib/oci/em_warehouse/em_warehouse_client.rb', line 308 def delete_em_warehouse(em_warehouse_id, opts = {}) logger.debug 'Calling operation EmWarehouseClient#delete_em_warehouse.' if logger raise "Missing the required parameter 'em_warehouse_id' when calling delete_em_warehouse." if em_warehouse_id.nil? raise "Parameter value for 'em_warehouse_id' must not be blank" if OCI::Internal::Util.blank_string?(em_warehouse_id) path = '/emWarehouses/{emWarehouseId}'.sub('{emWarehouseId}', em_warehouse_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: 'EmWarehouseClient#delete_em_warehouse') 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_em_warehouse(em_warehouse_id, opts = {}) ⇒ Response
Click here to see an example of how to use get_em_warehouse API.
Gets a EmWarehouse by identifier
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 |
# File 'lib/oci/em_warehouse/em_warehouse_client.rb', line 362 def get_em_warehouse(em_warehouse_id, opts = {}) logger.debug 'Calling operation EmWarehouseClient#get_em_warehouse.' if logger raise "Missing the required parameter 'em_warehouse_id' when calling get_em_warehouse." if em_warehouse_id.nil? raise "Parameter value for 'em_warehouse_id' must not be blank" if OCI::Internal::Util.blank_string?(em_warehouse_id) path = '/emWarehouses/{emWarehouseId}'.sub('{emWarehouseId}', em_warehouse_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: 'EmWarehouseClient#get_em_warehouse') 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::EmWarehouse::Models::EmWarehouse' ) end # rubocop:enable Metrics/BlockLength end |
#get_em_warehouse_resource_usage(em_warehouse_id, opts = {}) ⇒ Response
Click here to see an example of how to use get_em_warehouse_resource_usage API.
Gets a EmWarehouseResourceUsage by identifier
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 451 452 |
# File 'lib/oci/em_warehouse/em_warehouse_client.rb', line 416 def get_em_warehouse_resource_usage(em_warehouse_id, opts = {}) logger.debug 'Calling operation EmWarehouseClient#get_em_warehouse_resource_usage.' if logger raise "Missing the required parameter 'em_warehouse_id' when calling get_em_warehouse_resource_usage." if em_warehouse_id.nil? raise "Parameter value for 'em_warehouse_id' must not be blank" if OCI::Internal::Util.blank_string?(em_warehouse_id) path = '/emWarehouses/{emWarehouseId}/resourceUsage'.sub('{emWarehouseId}', em_warehouse_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: 'EmWarehouseClient#get_em_warehouse_resource_usage') 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::EmWarehouse::Models::ResourceUsage' ) 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 details of the work request with the given ID.
470 471 472 473 474 475 476 477 478 479 480 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 |
# File 'lib/oci/em_warehouse/em_warehouse_client.rb', line 470 def get_work_request(work_request_id, opts = {}) logger.debug 'Calling operation EmWarehouseClient#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: 'EmWarehouseClient#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::EmWarehouse::Models::WorkRequest' ) end # rubocop:enable Metrics/BlockLength end |
#list_em_warehouses(opts = {}) ⇒ Response
Click here to see an example of how to use list_em_warehouses API.
Returns a list of EmWarehouses.
Allowed values are: timeCreated, displayName
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 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 |
# File 'lib/oci/em_warehouse/em_warehouse_client.rb', line 535 def list_em_warehouses(opts = {}) logger.debug 'Calling operation EmWarehouseClient#list_em_warehouses.' if logger if opts[:lifecycle_state] && !OCI::EmWarehouse::Models::EmWarehouse::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state]) raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::EmWarehouse::Models::EmWarehouse::LIFECYCLE_STATE_ENUM.' end if opts[:sort_order] && !OCI::EmWarehouse::Models::SORT_ORDER_ENUM.include?(opts[:sort_order]) raise 'Invalid value for "sort_order", must be one of the values in OCI::EmWarehouse::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 = '/emWarehouses' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:compartmentId] = opts[:compartment_id] if opts[:compartment_id] query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state] query_params[:displayName] = opts[:display_name] if opts[:display_name] query_params[:operationsInsightsWarehouseId] = opts[:operations_insights_warehouse_id] if opts[:operations_insights_warehouse_id] query_params[:id] = opts[:id] if opts[: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] # 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: 'EmWarehouseClient#list_em_warehouses') 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::EmWarehouse::Models::EmWarehouseCollection' ) end # rubocop:enable Metrics/BlockLength end |
#list_etl_runs(em_warehouse_id, opts = {}) ⇒ Response
Click here to see an example of how to use list_etl_runs API.
Gets a list of runs of an EmWarehouseResource by identifier Allowed values are: timeCreated, displayName
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 654 655 656 657 658 659 660 661 662 663 664 665 666 |
# File 'lib/oci/em_warehouse/em_warehouse_client.rb', line 616 def list_etl_runs(em_warehouse_id, opts = {}) logger.debug 'Calling operation EmWarehouseClient#list_etl_runs.' if logger raise "Missing the required parameter 'em_warehouse_id' when calling list_etl_runs." if em_warehouse_id.nil? if opts[:sort_order] && !OCI::EmWarehouse::Models::SORT_ORDER_ENUM.include?(opts[:sort_order]) raise 'Invalid value for "sort_order", must be one of the values in OCI::EmWarehouse::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 raise "Parameter value for 'em_warehouse_id' must not be blank" if OCI::Internal::Util.blank_string?(em_warehouse_id) path = '/emWarehouses/{emWarehouseId}/etlRuns'.sub('{emWarehouseId}', em_warehouse_id.to_s) 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[: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: 'EmWarehouseClient#list_etl_runs') 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::EmWarehouse::Models::EtlRunCollection' ) 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.
Allowed values are: timeAccepted
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/em_warehouse/em_warehouse_client.rb', line 691 def list_work_request_errors(work_request_id, opts = {}) logger.debug 'Calling operation EmWarehouseClient#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[timeAccepted].include?(opts[:sort_by]) raise 'Invalid value for "sort_by", must be one of timeAccepted.' end if opts[:sort_order] && !OCI::EmWarehouse::Models::SORT_ORDER_ENUM.include?(opts[:sort_order]) raise 'Invalid value for "sort_order", must be one of the values in OCI::EmWarehouse::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: 'EmWarehouseClient#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::EmWarehouse::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: timeAccepted
764 765 766 767 768 769 770 771 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 |
# File 'lib/oci/em_warehouse/em_warehouse_client.rb', line 764 def list_work_request_logs(work_request_id, opts = {}) logger.debug 'Calling operation EmWarehouseClient#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[timeAccepted].include?(opts[:sort_by]) raise 'Invalid value for "sort_by", must be one of timeAccepted.' end if opts[:sort_order] && !OCI::EmWarehouse::Models::SORT_ORDER_ENUM.include?(opts[:sort_order]) raise 'Invalid value for "sort_order", must be one of the values in OCI::EmWarehouse::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: 'EmWarehouseClient#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::EmWarehouse::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 the work requests in a compartment.
Allowed values are: timeAccepted
840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 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 |
# File 'lib/oci/em_warehouse/em_warehouse_client.rb', line 840 def list_work_requests(opts = {}) logger.debug 'Calling operation EmWarehouseClient#list_work_requests.' if logger if opts[:status] && !OCI::EmWarehouse::Models::OPERATION_STATUS_ENUM.include?(opts[:status]) raise 'Invalid value for "status", must be one of the values in OCI::EmWarehouse::Models::OPERATION_STATUS_ENUM.' end if opts[:sort_order] && !OCI::EmWarehouse::Models::SORT_ORDER_ENUM.include?(opts[:sort_order]) raise 'Invalid value for "sort_order", must be one of the values in OCI::EmWarehouse::Models::SORT_ORDER_ENUM.' end if opts[:sort_by] && !%w[timeAccepted].include?(opts[:sort_by]) raise 'Invalid value for "sort_by", must be one of timeAccepted.' 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] = opts[:status] if opts[:status] 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] # 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: 'EmWarehouseClient#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::EmWarehouse::Models::WorkRequestSummaryCollection' ) end # rubocop:enable Metrics/BlockLength end |
#logger ⇒ Logger
Returns The logger for this client. May be nil.
94 95 96 |
# File 'lib/oci/em_warehouse/em_warehouse_client.rb', line 94 def logger @api_client.config.logger end |
#update_em_warehouse(em_warehouse_id, update_em_warehouse_details, opts = {}) ⇒ Response
Click here to see an example of how to use update_em_warehouse API.
Updates the EmWarehouse
919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 |
# File 'lib/oci/em_warehouse/em_warehouse_client.rb', line 919 def update_em_warehouse(em_warehouse_id, update_em_warehouse_details, opts = {}) logger.debug 'Calling operation EmWarehouseClient#update_em_warehouse.' if logger raise "Missing the required parameter 'em_warehouse_id' when calling update_em_warehouse." if em_warehouse_id.nil? raise "Missing the required parameter 'update_em_warehouse_details' when calling update_em_warehouse." if update_em_warehouse_details.nil? raise "Parameter value for 'em_warehouse_id' must not be blank" if OCI::Internal::Util.blank_string?(em_warehouse_id) path = '/emWarehouses/{emWarehouseId}'.sub('{emWarehouseId}', em_warehouse_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_em_warehouse_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'EmWarehouseClient#update_em_warehouse') 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 ) end # rubocop:enable Metrics/BlockLength end |