Class: OCI::Oda::OdaClient
- Inherits:
-
Object
- Object
- OCI::Oda::OdaClient
- Defined in:
- lib/oci/oda/oda_client.rb
Overview
API to create and maintain Oracle Digital Assistant service instances.
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_oda_instance_compartment(oda_instance_id, change_oda_instance_compartment_details, opts = {}) ⇒ Response
Moves an Digital Assistant instance into a different compartment.
-
#create_oda_instance(create_oda_instance_details, opts = {}) ⇒ Response
Starts an asynchronous job to create a Digital Assistant instance.
-
#create_oda_instance_attachment(oda_instance_id, create_oda_instance_attachment_details, opts = {}) ⇒ Response
Starts an asynchronous job to create a Digital Assistant instance attachment.
-
#delete_oda_instance(oda_instance_id, opts = {}) ⇒ Response
Starts an asynchronous job to delete the specified Digital Assistant instance.
-
#delete_oda_instance_attachment(oda_instance_id, attachment_id, opts = {}) ⇒ Response
Starts an asynchronous job to delete the specified Digital Assistant instance attachment.
-
#get_oda_instance(oda_instance_id, opts = {}) ⇒ Response
Gets the specified Digital Assistant instance.
-
#get_oda_instance_attachment(oda_instance_id, attachment_id, opts = {}) ⇒ Response
Gets an ODA instance attachment by identifier.
-
#get_work_request(work_request_id, opts = {}) ⇒ Response
Gets information about the work request with the specified ID, including its status.
-
#initialize(config: nil, region: nil, endpoint: nil, signer: nil, proxy_settings: nil, retry_config: nil) ⇒ OdaClient
constructor
Creates a new OdaClient.
-
#list_oda_instance_attachments(oda_instance_id, opts = {}) ⇒ Response
Returns a list of ODA instance attachments.
-
#list_oda_instances(compartment_id, opts = {}) ⇒ Response
Returns a page of Digital Assistant instances that belong to the specified compartment.
-
#list_work_request_errors(work_request_id, opts = {}) ⇒ Response
Returns a page of errors for the specified work request.
-
#list_work_request_logs(work_request_id, opts = {}) ⇒ Response
Returns a page of of log messages for a given work request.
-
#list_work_requests(compartment_id, opts = {}) ⇒ Response
Returns a page of work requests for the specified compartment.
-
#logger ⇒ Logger
The logger for this client.
-
#start_oda_instance(oda_instance_id, opts = {}) ⇒ Response
Starts an inactive Digital Assistant instance.
-
#stop_oda_instance(oda_instance_id, opts = {}) ⇒ Response
Stops an active Digital Assistant instance.
-
#update_oda_instance(oda_instance_id, update_oda_instance_details, opts = {}) ⇒ Response
Updates the specified Digital Assistant instance with the information in the request body.
-
#update_oda_instance_attachment(oda_instance_id, attachment_id, update_oda_instance_attachment_details, opts = {}) ⇒ Response
Updates the ODA instance attachment.
Constructor Details
#initialize(config: nil, region: nil, endpoint: nil, signer: nil, proxy_settings: nil, retry_config: nil) ⇒ OdaClient
Creates a new OdaClient. 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/oda/oda_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 + '/20190506' else region ||= config.region region ||= signer.region if signer.respond_to?(:region) self.region = region end logger.info "OdaClient 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/oda/oda_client.rb', line 15 def api_client @api_client end |
#endpoint ⇒ String (readonly)
Fully qualified endpoint URL
19 20 21 |
# File 'lib/oci/oda/oda_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/oda/oda_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/oda/oda_client.rb', line 25 def retry_config @retry_config end |
Instance Method Details
#change_oda_instance_compartment(oda_instance_id, change_oda_instance_compartment_details, opts = {}) ⇒ Response
Click here to see an example of how to use change_oda_instance_compartment API.
Moves an Digital Assistant instance into a different compartment. When provided, If-Match is checked against ETag values of the resource.
128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 |
# File 'lib/oci/oda/oda_client.rb', line 128 def change_oda_instance_compartment(oda_instance_id, change_oda_instance_compartment_details, opts = {}) logger.debug 'Calling operation OdaClient#change_oda_instance_compartment.' if logger raise "Missing the required parameter 'oda_instance_id' when calling change_oda_instance_compartment." if oda_instance_id.nil? raise "Missing the required parameter 'change_oda_instance_compartment_details' when calling change_oda_instance_compartment." if change_oda_instance_compartment_details.nil? raise "Parameter value for 'oda_instance_id' must not be blank" if OCI::Internal::Util.blank_string?(oda_instance_id) path = '/odaInstances/{odaInstanceId}/actions/changeCompartment'.sub('{odaInstanceId}', oda_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_oda_instance_compartment_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'OdaClient#change_oda_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_oda_instance(create_oda_instance_details, opts = {}) ⇒ Response
Click here to see an example of how to use create_oda_instance API.
Starts an asynchronous job to create a Digital Assistant instance.
To monitor the status of the job, take the opc-work-request-id
response header value and use it to call GET /workRequests/{workRequestId}
.
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 231 232 233 |
# File 'lib/oci/oda/oda_client.rb', line 196 def create_oda_instance(create_oda_instance_details, opts = {}) logger.debug 'Calling operation OdaClient#create_oda_instance.' if logger raise "Missing the required parameter 'create_oda_instance_details' when calling create_oda_instance." if create_oda_instance_details.nil? path = '/odaInstances' 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_oda_instance_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'OdaClient#create_oda_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::Oda::Models::OdaInstance' ) end # rubocop:enable Metrics/BlockLength end |
#create_oda_instance_attachment(oda_instance_id, create_oda_instance_attachment_details, opts = {}) ⇒ Response
Click here to see an example of how to use create_oda_instance_attachment API.
Starts an asynchronous job to create a Digital Assistant instance attachment.
To monitor the status of the job, take the opc-work-request-id
response header value and use it to call GET /workRequests/{workRequestId}
.
263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 |
# File 'lib/oci/oda/oda_client.rb', line 263 def (oda_instance_id, , opts = {}) logger.debug 'Calling operation OdaClient#create_oda_instance_attachment.' if logger raise "Missing the required parameter 'oda_instance_id' when calling create_oda_instance_attachment." if oda_instance_id.nil? raise "Missing the required parameter 'create_oda_instance_attachment_details' when calling create_oda_instance_attachment." if .nil? raise "Parameter value for 'oda_instance_id' must not be blank" if OCI::Internal::Util.blank_string?(oda_instance_id) path = '/odaInstances/{odaInstanceId}/attachments'.sub('{odaInstanceId}', oda_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] 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() # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'OdaClient#create_oda_instance_attachment') 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_oda_instance(oda_instance_id, opts = {}) ⇒ Response
Click here to see an example of how to use delete_oda_instance API.
Starts an asynchronous job to delete the specified Digital Assistant instance. To monitor the status of the job, take the opc-work-request-id
response header value and use it to call GET /workRequests/{workRequestId}
.
328 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 |
# File 'lib/oci/oda/oda_client.rb', line 328 def delete_oda_instance(oda_instance_id, opts = {}) logger.debug 'Calling operation OdaClient#delete_oda_instance.' if logger raise "Missing the required parameter 'oda_instance_id' when calling delete_oda_instance." if oda_instance_id.nil? raise "Parameter value for 'oda_instance_id' must not be blank" if OCI::Internal::Util.blank_string?(oda_instance_id) path = '/odaInstances/{odaInstanceId}'.sub('{odaInstanceId}', oda_instance_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:retentionTime] = opts[:retention_time] if opts[:retention_time] # 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: 'OdaClient#delete_oda_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_oda_instance_attachment(oda_instance_id, attachment_id, opts = {}) ⇒ Response
Click here to see an example of how to use delete_oda_instance_attachment API.
Starts an asynchronous job to delete the specified Digital Assistant instance attachment.
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 |
# File 'lib/oci/oda/oda_client.rb', line 391 def (oda_instance_id, , opts = {}) logger.debug 'Calling operation OdaClient#delete_oda_instance_attachment.' if logger raise "Missing the required parameter 'oda_instance_id' when calling delete_oda_instance_attachment." if oda_instance_id.nil? raise "Missing the required parameter 'attachment_id' when calling delete_oda_instance_attachment." if .nil? raise "Parameter value for 'oda_instance_id' must not be blank" if OCI::Internal::Util.blank_string?(oda_instance_id) raise "Parameter value for 'attachment_id' must not be blank" if OCI::Internal::Util.blank_string?() path = '/odaInstances/{odaInstanceId}/attachments/{attachmentId}'.sub('{odaInstanceId}', oda_instance_id.to_s).sub('{attachmentId}', .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: 'OdaClient#delete_oda_instance_attachment') 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_oda_instance(oda_instance_id, opts = {}) ⇒ Response
Click here to see an example of how to use get_oda_instance API.
Gets the specified Digital Assistant instance.
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/oda/oda_client.rb', line 447 def get_oda_instance(oda_instance_id, opts = {}) logger.debug 'Calling operation OdaClient#get_oda_instance.' if logger raise "Missing the required parameter 'oda_instance_id' when calling get_oda_instance." if oda_instance_id.nil? raise "Parameter value for 'oda_instance_id' must not be blank" if OCI::Internal::Util.blank_string?(oda_instance_id) path = '/odaInstances/{odaInstanceId}'.sub('{odaInstanceId}', oda_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: 'OdaClient#get_oda_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::Oda::Models::OdaInstance' ) end # rubocop:enable Metrics/BlockLength end |
#get_oda_instance_attachment(oda_instance_id, attachment_id, opts = {}) ⇒ Response
Click here to see an example of how to use get_oda_instance_attachment API.
Gets an ODA instance attachment by identifier
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 537 538 539 540 541 542 |
# File 'lib/oci/oda/oda_client.rb', line 503 def (oda_instance_id, , opts = {}) logger.debug 'Calling operation OdaClient#get_oda_instance_attachment.' if logger raise "Missing the required parameter 'oda_instance_id' when calling get_oda_instance_attachment." if oda_instance_id.nil? raise "Missing the required parameter 'attachment_id' when calling get_oda_instance_attachment." if .nil? raise "Parameter value for 'oda_instance_id' must not be blank" if OCI::Internal::Util.blank_string?(oda_instance_id) raise "Parameter value for 'attachment_id' must not be blank" if OCI::Internal::Util.blank_string?() path = '/odaInstances/{odaInstanceId}/attachments/{attachmentId}'.sub('{odaInstanceId}', oda_instance_id.to_s).sub('{attachmentId}', .to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:includeOwnerMetadata] = opts[:include_owner_metadata] if !opts[:include_owner_metadata].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: 'OdaClient#get_oda_instance_attachment') 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::Oda::Models::OdaInstanceAttachment' ) 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 information about the work request with the specified ID, including its status.
You can use this operation to monitor the status of jobs that you requested to create, delete, and update instances.
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 595 596 597 598 599 600 |
# File 'lib/oci/oda/oda_client.rb', line 564 def get_work_request(work_request_id, opts = {}) logger.debug 'Calling operation OdaClient#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: 'OdaClient#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::Oda::Models::WorkRequest' ) end # rubocop:enable Metrics/BlockLength end |
#list_oda_instance_attachments(oda_instance_id, opts = {}) ⇒ Response
Click here to see an example of how to use list_oda_instance_attachments API.
Returns a list of ODA instance attachments
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 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 |
# File 'lib/oci/oda/oda_client.rb', line 636 def (oda_instance_id, opts = {}) logger.debug 'Calling operation OdaClient#list_oda_instance_attachments.' if logger raise "Missing the required parameter 'oda_instance_id' when calling list_oda_instance_attachments." if oda_instance_id.nil? if opts[:lifecycle_state] && !%w[ATTACHING ACTIVE DETACHING INACTIVE FAILED].include?(opts[:lifecycle_state]) raise 'Invalid value for "lifecycle_state", must be one of ATTACHING, ACTIVE, DETACHING, INACTIVE, FAILED.' end if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order]) raise 'Invalid value for "sort_order", must be one of ASC, DESC.' end if opts[:sort_by] && !%w[TIMECREATED].include?(opts[:sort_by]) raise 'Invalid value for "sort_by", must be one of TIMECREATED.' end raise "Parameter value for 'oda_instance_id' must not be blank" if OCI::Internal::Util.blank_string?(oda_instance_id) path = '/odaInstances/{odaInstanceId}/attachments'.sub('{odaInstanceId}', oda_instance_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:includeOwnerMetadata] = opts[:include_owner_metadata] if !opts[:include_owner_metadata].nil? query_params[:limit] = opts[:limit] if opts[:limit] query_params[:page] = opts[:page] if opts[:page] query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state] 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: 'OdaClient#list_oda_instance_attachments') 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::Oda::Models::OdaInstanceAttachmentCollection' ) end # rubocop:enable Metrics/BlockLength end |
#list_oda_instances(compartment_id, opts = {}) ⇒ Response
Click here to see an example of how to use list_oda_instances API.
Returns a page of Digital Assistant instances that belong to the specified compartment.
If the opc-next-page
header appears in the response, then there are more items to retrieve. To get the next page in the subsequent GET request, include the header's value as the page
query parameter.
735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 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 |
# File 'lib/oci/oda/oda_client.rb', line 735 def list_oda_instances(compartment_id, opts = {}) logger.debug 'Calling operation OdaClient#list_oda_instances.' if logger raise "Missing the required parameter 'compartment_id' when calling list_oda_instances." if compartment_id.nil? if opts[:lifecycle_state] && !%w[CREATING UPDATING ACTIVE INACTIVE DELETING DELETED FAILED].include?(opts[:lifecycle_state]) raise 'Invalid value for "lifecycle_state", must be one of CREATING, UPDATING, ACTIVE, INACTIVE, DELETING, DELETED, FAILED.' end if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order]) raise 'Invalid value for "sort_order", must be one of ASC, DESC.' 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 = '/odaInstances' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:compartmentId] = compartment_id query_params[:displayName] = opts[:display_name] if opts[:display_name] 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[: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: 'OdaClient#list_oda_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::Oda::Models::OdaInstanceSummary>' ) 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 page of errors for the specified work request.
If the opc-next-page
header appears in the response, then there are more items to retrieve. To get the next page in the subsequent GET request, include the header's value as the page
query parameter.
827 828 829 830 831 832 833 834 835 836 837 838 839 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 |
# File 'lib/oci/oda/oda_client.rb', line 827 def list_work_request_errors(work_request_id, opts = {}) logger.debug 'Calling operation OdaClient#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[CODE TIMESTAMP].include?(opts[:sort_by]) raise 'Invalid value for "sort_by", must be one of CODE, TIMESTAMP.' end if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order]) raise 'Invalid value for "sort_order", must be one of ASC, DESC.' 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: 'OdaClient#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::Oda::Models::WorkRequestError>' ) 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 page of of log messages for a given work request.
If the opc-next-page
header appears in the response, then there are more items to retrieve. To get the next page in the subsequent GET request, include the header's value as the page
query parameter.
913 914 915 916 917 918 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 957 958 959 960 961 |
# File 'lib/oci/oda/oda_client.rb', line 913 def list_work_request_logs(work_request_id, opts = {}) logger.debug 'Calling operation OdaClient#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[MESSAGE TIMESTAMP].include?(opts[:sort_by]) raise 'Invalid value for "sort_by", must be one of MESSAGE, TIMESTAMP.' end if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order]) raise 'Invalid value for "sort_order", must be one of ASC, DESC.' 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: 'OdaClient#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::Oda::Models::WorkRequestLogEntry>' ) end # rubocop:enable Metrics/BlockLength end |
#list_work_requests(compartment_id, opts = {}) ⇒ Response
Click here to see an example of how to use list_work_requests API.
Returns a page of work requests for the specified compartment.
If the opc-next-page
header appears in the response, then there are more items to retrieve. To get the next page in the subsequent GET request, include the header's value as the page
query parameter.
1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 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 |
# File 'lib/oci/oda/oda_client.rb', line 1001 def list_work_requests(compartment_id, opts = {}) logger.debug 'Calling operation OdaClient#list_work_requests.' if logger raise "Missing the required parameter 'compartment_id' when calling list_work_requests." if compartment_id.nil? if opts[:sort_by] && !%w[OPERATION_TYPE STATUS TIME_ACCEPTED TIME_STARTED TIME_FINISHED].include?(opts[:sort_by]) raise 'Invalid value for "sort_by", must be one of OPERATION_TYPE, STATUS, TIME_ACCEPTED, TIME_STARTED, TIME_FINISHED.' end if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order]) raise 'Invalid value for "sort_order", must be one of ASC, DESC.' end path = '/workRequests' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:compartmentId] = compartment_id query_params[:odaInstanceId] = opts[:oda_instance_id] if opts[:oda_instance_id] 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[: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: 'OdaClient#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::Oda::Models::WorkRequestSummary>' ) end # rubocop:enable Metrics/BlockLength end |
#logger ⇒ Logger
Returns The logger for this client. May be nil.
94 95 96 |
# File 'lib/oci/oda/oda_client.rb', line 94 def logger @api_client.config.logger end |
#start_oda_instance(oda_instance_id, opts = {}) ⇒ Response
Click here to see an example of how to use start_oda_instance API.
Starts an inactive Digital Assistant instance. Once active, the instance will be accessible and metering of requests will be started again.
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 1120 1121 1122 1123 |
# File 'lib/oci/oda/oda_client.rb', line 1085 def start_oda_instance(oda_instance_id, opts = {}) logger.debug 'Calling operation OdaClient#start_oda_instance.' if logger raise "Missing the required parameter 'oda_instance_id' when calling start_oda_instance." if oda_instance_id.nil? raise "Parameter value for 'oda_instance_id' must not be blank" if OCI::Internal::Util.blank_string?(oda_instance_id) path = '/odaInstances/{odaInstanceId}/actions/start'.sub('{odaInstanceId}', oda_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] 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: 'OdaClient#start_oda_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_oda_instance(oda_instance_id, opts = {}) ⇒ Response
Click here to see an example of how to use stop_oda_instance API.
Stops an active Digital Assistant instance. Once inactive, the instance will not be accessible and metering of requests will be stopped until the instance is started again. Data associated with the instance is not affected.
1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 |
# File 'lib/oci/oda/oda_client.rb', line 1158 def stop_oda_instance(oda_instance_id, opts = {}) logger.debug 'Calling operation OdaClient#stop_oda_instance.' if logger raise "Missing the required parameter 'oda_instance_id' when calling stop_oda_instance." if oda_instance_id.nil? raise "Parameter value for 'oda_instance_id' must not be blank" if OCI::Internal::Util.blank_string?(oda_instance_id) path = '/odaInstances/{odaInstanceId}/actions/stop'.sub('{odaInstanceId}', oda_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] 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: 'OdaClient#stop_oda_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_oda_instance(oda_instance_id, update_oda_instance_details, opts = {}) ⇒ Response
Click here to see an example of how to use update_oda_instance API.
Updates the specified Digital Assistant instance with the information in the request body.
1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 |
# File 'lib/oci/oda/oda_client.rb', line 1222 def update_oda_instance(oda_instance_id, update_oda_instance_details, opts = {}) logger.debug 'Calling operation OdaClient#update_oda_instance.' if logger raise "Missing the required parameter 'oda_instance_id' when calling update_oda_instance." if oda_instance_id.nil? raise "Missing the required parameter 'update_oda_instance_details' when calling update_oda_instance." if update_oda_instance_details.nil? raise "Parameter value for 'oda_instance_id' must not be blank" if OCI::Internal::Util.blank_string?(oda_instance_id) path = '/odaInstances/{odaInstanceId}'.sub('{odaInstanceId}', oda_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_oda_instance_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'OdaClient#update_oda_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::Oda::Models::OdaInstance' ) end # rubocop:enable Metrics/BlockLength end |
#update_oda_instance_attachment(oda_instance_id, attachment_id, update_oda_instance_attachment_details, opts = {}) ⇒ Response
Click here to see an example of how to use update_oda_instance_attachment API.
Updates the ODA instance attachment
1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 |
# File 'lib/oci/oda/oda_client.rb', line 1287 def (oda_instance_id, , , opts = {}) logger.debug 'Calling operation OdaClient#update_oda_instance_attachment.' if logger raise "Missing the required parameter 'oda_instance_id' when calling update_oda_instance_attachment." if oda_instance_id.nil? raise "Missing the required parameter 'attachment_id' when calling update_oda_instance_attachment." if .nil? raise "Missing the required parameter 'update_oda_instance_attachment_details' when calling update_oda_instance_attachment." if .nil? raise "Parameter value for 'oda_instance_id' must not be blank" if OCI::Internal::Util.blank_string?(oda_instance_id) raise "Parameter value for 'attachment_id' must not be blank" if OCI::Internal::Util.blank_string?() path = '/odaInstances/{odaInstanceId}/attachments/{attachmentId}'.sub('{odaInstanceId}', oda_instance_id.to_s).sub('{attachmentId}', .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() # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'OdaClient#update_oda_instance_attachment') 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 |