Class: OCI::Analytics::AnalyticsClient
- Inherits:
-
Object
- Object
- OCI::Analytics::AnalyticsClient
- Defined in:
- lib/oci/analytics/analytics_client.rb
Overview
Analytics API.
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_analytics_instance_compartment(analytics_instance_id, change_compartment_details, opts = {}) ⇒ Response
Change the compartment of an Analytics instance.
-
#create_analytics_instance(create_analytics_instance_details, opts = {}) ⇒ Response
Create a new AnalyticsInstance in the specified compartment.
-
#delete_analytics_instance(analytics_instance_id, opts = {}) ⇒ Response
Terminates the specified Analytics instance.
-
#delete_work_request(work_request_id, opts = {}) ⇒ Response
Cancel a work request that has not started yet.
-
#get_analytics_instance(analytics_instance_id, opts = {}) ⇒ Response
Info for a specific Analytics instance.
-
#get_work_request(work_request_id, opts = {}) ⇒ Response
Get the details of a work request.
-
#initialize(config: nil, region: nil, endpoint: nil, signer: nil, proxy_settings: nil, retry_config: nil) ⇒ AnalyticsClient
constructor
Creates a new AnalyticsClient.
-
#list_analytics_instances(compartment_id, opts = {}) ⇒ Response
List Analytics instances.
-
#list_work_request_errors(work_request_id, opts = {}) ⇒ Response
Get the errors of a work request.
-
#list_work_request_logs(work_request_id, opts = {}) ⇒ Response
Get the logs of a work request.
-
#list_work_requests(compartment_id, opts = {}) ⇒ Response
List all work requests in a compartment.
-
#logger ⇒ Logger
The logger for this client.
-
#scale_analytics_instance(analytics_instance_id, scale_analytics_instance_details, opts = {}) ⇒ Response
Scale an Analytics instance up or down.
-
#start_analytics_instance(analytics_instance_id, opts = {}) ⇒ Response
Starts the specified Analytics instance.
-
#stop_analytics_instance(analytics_instance_id, opts = {}) ⇒ Response
Stop the specified Analytics instance.
-
#update_analytics_instance(analytics_instance_id, update_analytics_instance_details, opts = {}) ⇒ Response
Updates certain fields of an Analytics instance.
Constructor Details
#initialize(config: nil, region: nil, endpoint: nil, signer: nil, proxy_settings: nil, retry_config: nil) ⇒ AnalyticsClient
Creates a new AnalyticsClient. 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.
53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 |
# File 'lib/oci/analytics/analytics_client.rb', line 53 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) if signer.nil? signer = OCI::Signer.new( config.user, config.fingerprint, config.tenancy, config.key_file, pass_phrase: config.pass_phrase, private_key_content: config.key_content ) end @api_client = OCI::ApiClient.new(config, signer, proxy_settings: proxy_settings) @retry_config = retry_config if endpoint @endpoint = endpoint + '/20190331' else region ||= config.region region ||= signer.region if signer.respond_to?(:region) self.region = region end logger.info "AnalyticsClient endpoint set to '#{@endpoint}'." if logger end |
Instance Attribute Details
#api_client ⇒ OCI::ApiClient (readonly)
Client used to make HTTP requests.
13 14 15 |
# File 'lib/oci/analytics/analytics_client.rb', line 13 def api_client @api_client end |
#endpoint ⇒ String (readonly)
Fully qualified endpoint URL
17 18 19 |
# File 'lib/oci/analytics/analytics_client.rb', line 17 def endpoint @endpoint end |
#region ⇒ String
The region, which will usually correspond to a value in Regions::REGION_ENUM.
27 28 29 |
# File 'lib/oci/analytics/analytics_client.rb', line 27 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
23 24 25 |
# File 'lib/oci/analytics/analytics_client.rb', line 23 def retry_config @retry_config end |
Instance Method Details
#change_analytics_instance_compartment(analytics_instance_id, change_compartment_details, opts = {}) ⇒ Response
Change the compartment of an Analytics instance. The operation is long-running and creates a new WorkRequest.
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 167 168 169 170 171 172 173 |
# File 'lib/oci/analytics/analytics_client.rb', line 134 def change_analytics_instance_compartment(analytics_instance_id, change_compartment_details, opts = {}) logger.debug 'Calling operation AnalyticsClient#change_analytics_instance_compartment.' if logger raise "Missing the required parameter 'analytics_instance_id' when calling change_analytics_instance_compartment." if analytics_instance_id.nil? raise "Missing the required parameter 'change_compartment_details' when calling change_analytics_instance_compartment." if change_compartment_details.nil? raise "Parameter value for 'analytics_instance_id' must not be blank" if OCI::Internal::Util.blank_string?(analytics_instance_id) path = '/analyticsInstances/{analyticsInstanceId}/actions/changeCompartment'.sub('{analyticsInstanceId}', analytics_instance_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_compartment_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'AnalyticsClient#change_analytics_instance_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_analytics_instance(create_analytics_instance_details, opts = {}) ⇒ Response
Create a new AnalyticsInstance in the specified compartment. The operation is long-running and creates a new WorkRequest.
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 231 232 233 234 235 236 237 238 |
# File 'lib/oci/analytics/analytics_client.rb', line 201 def create_analytics_instance(create_analytics_instance_details, opts = {}) logger.debug 'Calling operation AnalyticsClient#create_analytics_instance.' if logger raise "Missing the required parameter 'create_analytics_instance_details' when calling create_analytics_instance." if create_analytics_instance_details.nil? path = '/analyticsInstances' 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[:'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(create_analytics_instance_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'AnalyticsClient#create_analytics_instance') 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::Analytics::Models::AnalyticsInstance' ) end # rubocop:enable Metrics/BlockLength end |
#delete_analytics_instance(analytics_instance_id, opts = {}) ⇒ Response
Terminates the specified Analytics instance. The operation is long-running and creates a new WorkRequest.
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 |
# File 'lib/oci/analytics/analytics_client.rb', line 270 def delete_analytics_instance(analytics_instance_id, opts = {}) logger.debug 'Calling operation AnalyticsClient#delete_analytics_instance.' if logger raise "Missing the required parameter 'analytics_instance_id' when calling delete_analytics_instance." if analytics_instance_id.nil? raise "Parameter value for 'analytics_instance_id' must not be blank" if OCI::Internal::Util.blank_string?(analytics_instance_id) path = '/analyticsInstances/{analyticsInstanceId}'.sub('{analyticsInstanceId}', analytics_instance_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 = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'AnalyticsClient#delete_analytics_instance') 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_work_request(work_request_id, opts = {}) ⇒ Response
Cancel a work request that has not started yet.
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 |
# File 'lib/oci/analytics/analytics_client.rb', line 333 def delete_work_request(work_request_id, opts = {}) logger.debug 'Calling operation AnalyticsClient#delete_work_request.' if logger raise "Missing the required parameter 'work_request_id' when calling delete_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: 'AnalyticsClient#delete_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 |
#get_analytics_instance(analytics_instance_id, opts = {}) ⇒ Response
Info for a specific Analytics instance.
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 |
# File 'lib/oci/analytics/analytics_client.rb', line 390 def get_analytics_instance(analytics_instance_id, opts = {}) logger.debug 'Calling operation AnalyticsClient#get_analytics_instance.' if logger raise "Missing the required parameter 'analytics_instance_id' when calling get_analytics_instance." if analytics_instance_id.nil? raise "Parameter value for 'analytics_instance_id' must not be blank" if OCI::Internal::Util.blank_string?(analytics_instance_id) path = '/analyticsInstances/{analyticsInstanceId}'.sub('{analyticsInstanceId}', analytics_instance_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: 'AnalyticsClient#get_analytics_instance') 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::Analytics::Models::AnalyticsInstance' ) end # rubocop:enable Metrics/BlockLength end |
#get_work_request(work_request_id, opts = {}) ⇒ Response
Get the details of a work request.
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 473 474 475 476 477 478 479 480 481 482 483 |
# File 'lib/oci/analytics/analytics_client.rb', line 447 def get_work_request(work_request_id, opts = {}) logger.debug 'Calling operation AnalyticsClient#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: 'AnalyticsClient#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::Analytics::Models::WorkRequest' ) end # rubocop:enable Metrics/BlockLength end |
#list_analytics_instances(compartment_id, opts = {}) ⇒ Response
List Analytics instances.
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 568 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 |
# File 'lib/oci/analytics/analytics_client.rb', line 530 def list_analytics_instances(compartment_id, opts = {}) logger.debug 'Calling operation AnalyticsClient#list_analytics_instances.' if logger raise "Missing the required parameter 'compartment_id' when calling list_analytics_instances." if compartment_id.nil? if opts[:capacity_type] && !OCI::Analytics::Models::CAPACITY_TYPE_ENUM.include?(opts[:capacity_type]) raise 'Invalid value for "capacity_type", must be one of the values in OCI::Analytics::Models::CAPACITY_TYPE_ENUM.' end if opts[:feature_set] && !OCI::Analytics::Models::FEATURE_SET_ENUM.include?(opts[:feature_set]) raise 'Invalid value for "feature_set", must be one of the values in OCI::Analytics::Models::FEATURE_SET_ENUM.' end if opts[:lifecycle_state] && !OCI::Analytics::Models::ANALYTICS_INSTANCE_LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state]) raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::Analytics::Models::ANALYTICS_INSTANCE_LIFECYCLE_STATE_ENUM.' end if opts[:sort_by] && !OCI::Analytics::Models::SORT_BY_ENUM.include?(opts[:sort_by]) raise 'Invalid value for "sort_by", must be one of the values in OCI::Analytics::Models::SORT_BY_ENUM.' end if opts[:sort_order] && !OCI::Analytics::Models::SORT_ORDER_ENUM.include?(opts[:sort_order]) raise 'Invalid value for "sort_order", must be one of the values in OCI::Analytics::Models::SORT_ORDER_ENUM.' end path = '/analyticsInstances' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:compartmentId] = compartment_id query_params[:name] = opts[:name] if opts[:name] query_params[:capacityType] = opts[:capacity_type] if opts[:capacity_type] query_params[:featureSet] = opts[:feature_set] if opts[:feature_set] query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state] query_params[:limit] = opts[:limit] if opts[:limit] query_params[:page] = opts[:page] if opts[:page] 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: 'AnalyticsClient#list_analytics_instances') 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: 'Array<OCI::Analytics::Models::AnalyticsInstanceSummary>' ) end # rubocop:enable Metrics/BlockLength end |
#list_work_request_errors(work_request_id, opts = {}) ⇒ Response
Get the errors of a work request.
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 |
# File 'lib/oci/analytics/analytics_client.rb', line 625 def list_work_request_errors(work_request_id, opts = {}) logger.debug 'Calling operation AnalyticsClient#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? 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] # 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: 'AnalyticsClient#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: 'Array<OCI::Analytics::Models::WorkRequestError>' ) end # rubocop:enable Metrics/BlockLength end |
#list_work_request_logs(work_request_id, opts = {}) ⇒ Response
Get the logs of a work request.
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 |
# File 'lib/oci/analytics/analytics_client.rb', line 694 def list_work_request_logs(work_request_id, opts = {}) logger.debug 'Calling operation AnalyticsClient#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? 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] # 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: 'AnalyticsClient#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: 'Array<OCI::Analytics::Models::WorkRequestLog>' ) end # rubocop:enable Metrics/BlockLength end |
#list_work_requests(compartment_id, opts = {}) ⇒ Response
List all work requests in a compartment.
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 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 |
# File 'lib/oci/analytics/analytics_client.rb', line 774 def list_work_requests(compartment_id, opts = {}) logger.debug 'Calling operation AnalyticsClient#list_work_requests.' if logger raise "Missing the required parameter 'compartment_id' when calling list_work_requests." if compartment_id.nil? if opts[:resource_type] && !OCI::Analytics::Models::WORK_REQUEST_RESOURCE_TYPE_ENUM.include?(opts[:resource_type]) raise 'Invalid value for "resource_type", must be one of the values in OCI::Analytics::Models::WORK_REQUEST_RESOURCE_TYPE_ENUM.' end 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_by] && !OCI::Analytics::Models::WORK_REQUEST_SORT_BY_ENUM.include?(opts[:sort_by]) raise 'Invalid value for "sort_by", must be one of the values in OCI::Analytics::Models::WORK_REQUEST_SORT_BY_ENUM.' end if opts[:sort_order] && !OCI::Analytics::Models::SORT_ORDER_ENUM.include?(opts[:sort_order]) raise 'Invalid value for "sort_order", must be one of the values in OCI::Analytics::Models::SORT_ORDER_ENUM.' end path = '/workRequests' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:compartmentId] = compartment_id query_params[:resourceId] = opts[:resource_id] if opts[:resource_id] query_params[:resourceType] = opts[:resource_type] if opts[:resource_type] query_params[:status] = OCI::ApiClient.build_collection_params(opts[:status], :multi) if opts[:status] && !opts[:status].empty? query_params[:limit] = opts[:limit] if opts[:limit] query_params[:page] = opts[:page] if opts[:page] 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: 'AnalyticsClient#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: 'Array<OCI::Analytics::Models::WorkRequestSummary>' ) end # rubocop:enable Metrics/BlockLength end |
#logger ⇒ Logger
Returns The logger for this client. May be nil.
101 102 103 |
# File 'lib/oci/analytics/analytics_client.rb', line 101 def logger @api_client.config.logger end |
#scale_analytics_instance(analytics_instance_id, scale_analytics_instance_details, opts = {}) ⇒ Response
Scale an Analytics instance up or down. The operation is long-running and creates a new WorkRequest.
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 911 912 |
# File 'lib/oci/analytics/analytics_client.rb', line 873 def scale_analytics_instance(analytics_instance_id, scale_analytics_instance_details, opts = {}) logger.debug 'Calling operation AnalyticsClient#scale_analytics_instance.' if logger raise "Missing the required parameter 'analytics_instance_id' when calling scale_analytics_instance." if analytics_instance_id.nil? raise "Missing the required parameter 'scale_analytics_instance_details' when calling scale_analytics_instance." if scale_analytics_instance_details.nil? raise "Parameter value for 'analytics_instance_id' must not be blank" if OCI::Internal::Util.blank_string?(analytics_instance_id) path = '/analyticsInstances/{analyticsInstanceId}/actions/scale'.sub('{analyticsInstanceId}', analytics_instance_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(scale_analytics_instance_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'AnalyticsClient#scale_analytics_instance') 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 |
#start_analytics_instance(analytics_instance_id, opts = {}) ⇒ Response
Starts the specified Analytics instance. The operation is long-running and creates a new WorkRequest.
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 982 |
# File 'lib/oci/analytics/analytics_client.rb', line 944 def start_analytics_instance(analytics_instance_id, opts = {}) logger.debug 'Calling operation AnalyticsClient#start_analytics_instance.' if logger raise "Missing the required parameter 'analytics_instance_id' when calling start_analytics_instance." if analytics_instance_id.nil? raise "Parameter value for 'analytics_instance_id' must not be blank" if OCI::Internal::Util.blank_string?(analytics_instance_id) path = '/analyticsInstances/{analyticsInstanceId}/actions/start'.sub('{analyticsInstanceId}', analytics_instance_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 = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'AnalyticsClient#start_analytics_instance') 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 |
#stop_analytics_instance(analytics_instance_id, opts = {}) ⇒ Response
Stop the specified Analytics instance. The operation is long-running and creates a new WorkRequest.
1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 |
# File 'lib/oci/analytics/analytics_client.rb', line 1014 def stop_analytics_instance(analytics_instance_id, opts = {}) logger.debug 'Calling operation AnalyticsClient#stop_analytics_instance.' if logger raise "Missing the required parameter 'analytics_instance_id' when calling stop_analytics_instance." if analytics_instance_id.nil? raise "Parameter value for 'analytics_instance_id' must not be blank" if OCI::Internal::Util.blank_string?(analytics_instance_id) path = '/analyticsInstances/{analyticsInstanceId}/actions/stop'.sub('{analyticsInstanceId}', analytics_instance_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 = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'AnalyticsClient#stop_analytics_instance') 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_analytics_instance(analytics_instance_id, update_analytics_instance_details, opts = {}) ⇒ Response
Updates certain fields of an Analytics instance. Fields that are not provided in the request will not be updated.
1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 |
# File 'lib/oci/analytics/analytics_client.rb', line 1081 def update_analytics_instance(analytics_instance_id, update_analytics_instance_details, opts = {}) logger.debug 'Calling operation AnalyticsClient#update_analytics_instance.' if logger raise "Missing the required parameter 'analytics_instance_id' when calling update_analytics_instance." if analytics_instance_id.nil? raise "Missing the required parameter 'update_analytics_instance_details' when calling update_analytics_instance." if update_analytics_instance_details.nil? raise "Parameter value for 'analytics_instance_id' must not be blank" if OCI::Internal::Util.blank_string?(analytics_instance_id) path = '/analyticsInstances/{analyticsInstanceId}'.sub('{analyticsInstanceId}', analytics_instance_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_analytics_instance_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'AnalyticsClient#update_analytics_instance') 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::Analytics::Models::AnalyticsInstance' ) end # rubocop:enable Metrics/BlockLength end |