Class: OCI::ContainerInstances::ContainerInstanceClient
- Inherits:
-
Object
- Object
- OCI::ContainerInstances::ContainerInstanceClient
- Defined in:
- lib/oci/container_instances/container_instance_client.rb
Overview
A description of the Container Instance 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_container_instance_compartment(container_instance_id, change_container_instance_compartment_details, opts = {}) ⇒ Response
Moves a container instance resource from one compartment identifier to another.
-
#create_container_instance(create_container_instance_details, opts = {}) ⇒ Response
Creates a container instance and deploys the containers on it.
-
#delete_container_instance(container_instance_id, opts = {}) ⇒ Response
Deletes a container instance and its containers.
-
#get_container(container_id, opts = {}) ⇒ Response
Get details about a single container by the container ID.
-
#get_container_instance(container_instance_id, opts = {}) ⇒ Response
Gets information about the specified container instance.
-
#get_work_request(work_request_id, opts = {}) ⇒ Response
Gets the status of the work request with the given ID.
-
#initialize(config: nil, region: nil, endpoint: nil, signer: nil, proxy_settings: nil, retry_config: nil) ⇒ ContainerInstanceClient
constructor
Creates a new ContainerInstanceClient.
-
#list_container_instance_shapes(compartment_id, opts = {}) ⇒ Response
Lists the shapes that can be used to create container instances.
-
#list_container_instances(compartment_id, opts = {}) ⇒ Response
Returns a list of container instances.
-
#list_containers(compartment_id, opts = {}) ⇒ Response
Returns a list of containers in a compartment.
-
#list_work_request_errors(work_request_id, opts = {}) ⇒ Response
Returns a paginated list of errors for a work request.
-
#list_work_request_logs(work_request_id, opts = {}) ⇒ Response
Returns a paginated list of logs for a work request.
-
#list_work_requests(compartment_id, opts = {}) ⇒ Response
Lists the work requests in a compartment.
-
#logger ⇒ Logger
The logger for this client.
-
#restart_container_instance(container_instance_id, opts = {}) ⇒ Response
Restarts a container instance.
-
#retrieve_logs(container_id, opts = {}, &block) ⇒ Response
Returns the most recent 256 KB of logs from the specified container.
-
#start_container_instance(container_instance_id, opts = {}) ⇒ Response
Starts a container instance if it is "inactive".
-
#stop_container_instance(container_instance_id, opts = {}) ⇒ Response
Stops a container instance if it is "active".
-
#update_container(container_id, update_container_details, opts = {}) ⇒ Response
Updates a container.
-
#update_container_instance(container_instance_id, update_container_instance_details, opts = {}) ⇒ Response
Updates a container instance.
Constructor Details
#initialize(config: nil, region: nil, endpoint: nil, signer: nil, proxy_settings: nil, retry_config: nil) ⇒ ContainerInstanceClient
Creates a new ContainerInstanceClient. 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/container_instances/container_instance_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 + '/20210415' else region ||= config.region region ||= signer.region if signer.respond_to?(:region) self.region = region end logger.info "ContainerInstanceClient 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/container_instances/container_instance_client.rb', line 15 def api_client @api_client end |
#endpoint ⇒ String (readonly)
Fully qualified endpoint URL
19 20 21 |
# File 'lib/oci/container_instances/container_instance_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/container_instances/container_instance_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/container_instances/container_instance_client.rb', line 25 def retry_config @retry_config end |
Instance Method Details
#change_container_instance_compartment(container_instance_id, change_container_instance_compartment_details, opts = {}) ⇒ Response
Click here to see an example of how to use change_container_instance_compartment API.
Moves a container instance resource from one compartment identifier to another. When provided, If-Match is checked against ETag values of the resource.
118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 |
# File 'lib/oci/container_instances/container_instance_client.rb', line 118 def change_container_instance_compartment(container_instance_id, change_container_instance_compartment_details, opts = {}) logger.debug 'Calling operation ContainerInstanceClient#change_container_instance_compartment.' if logger raise "Missing the required parameter 'container_instance_id' when calling change_container_instance_compartment." if container_instance_id.nil? raise "Missing the required parameter 'change_container_instance_compartment_details' when calling change_container_instance_compartment." if change_container_instance_compartment_details.nil? raise "Parameter value for 'container_instance_id' must not be blank" if OCI::Internal::Util.blank_string?(container_instance_id) path = '/containerInstances/{containerInstanceId}/actions/changeCompartment'.sub('{containerInstanceId}', container_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(change_container_instance_compartment_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'ContainerInstanceClient#change_container_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_container_instance(create_container_instance_details, opts = {}) ⇒ Response
Click here to see an example of how to use create_container_instance API.
Creates a container instance and deploys the containers on it.
180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 |
# File 'lib/oci/container_instances/container_instance_client.rb', line 180 def create_container_instance(create_container_instance_details, opts = {}) logger.debug 'Calling operation ContainerInstanceClient#create_container_instance.' if logger raise "Missing the required parameter 'create_container_instance_details' when calling create_container_instance." if create_container_instance_details.nil? path = '/containerInstances' 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_container_instance_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'ContainerInstanceClient#create_container_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::ContainerInstances::Models::ContainerInstance' ) end # rubocop:enable Metrics/BlockLength end |
#delete_container_instance(container_instance_id, opts = {}) ⇒ Response
Click here to see an example of how to use delete_container_instance API.
Deletes a container instance and its containers.
241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 |
# File 'lib/oci/container_instances/container_instance_client.rb', line 241 def delete_container_instance(container_instance_id, opts = {}) logger.debug 'Calling operation ContainerInstanceClient#delete_container_instance.' if logger raise "Missing the required parameter 'container_instance_id' when calling delete_container_instance." if container_instance_id.nil? raise "Parameter value for 'container_instance_id' must not be blank" if OCI::Internal::Util.blank_string?(container_instance_id) path = '/containerInstances/{containerInstanceId}'.sub('{containerInstanceId}', container_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 = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'ContainerInstanceClient#delete_container_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 |
#get_container(container_id, opts = {}) ⇒ Response
Click here to see an example of how to use get_container API.
Get details about a single container by the container ID.
295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 |
# File 'lib/oci/container_instances/container_instance_client.rb', line 295 def get_container(container_id, opts = {}) logger.debug 'Calling operation ContainerInstanceClient#get_container.' if logger raise "Missing the required parameter 'container_id' when calling get_container." if container_id.nil? raise "Parameter value for 'container_id' must not be blank" if OCI::Internal::Util.blank_string?(container_id) path = '/containers/{containerId}'.sub('{containerId}', container_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: 'ContainerInstanceClient#get_container') 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::ContainerInstances::Models::Container' ) end # rubocop:enable Metrics/BlockLength end |
#get_container_instance(container_instance_id, opts = {}) ⇒ Response
Click here to see an example of how to use get_container_instance API.
Gets information about the specified container instance.
349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 |
# File 'lib/oci/container_instances/container_instance_client.rb', line 349 def get_container_instance(container_instance_id, opts = {}) logger.debug 'Calling operation ContainerInstanceClient#get_container_instance.' if logger raise "Missing the required parameter 'container_instance_id' when calling get_container_instance." if container_instance_id.nil? raise "Parameter value for 'container_instance_id' must not be blank" if OCI::Internal::Util.blank_string?(container_instance_id) path = '/containerInstances/{containerInstanceId}'.sub('{containerInstanceId}', container_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: 'ContainerInstanceClient#get_container_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::ContainerInstances::Models::ContainerInstance' ) 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 the status of the work request with the given ID.
403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 |
# File 'lib/oci/container_instances/container_instance_client.rb', line 403 def get_work_request(work_request_id, opts = {}) logger.debug 'Calling operation ContainerInstanceClient#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: 'ContainerInstanceClient#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::ContainerInstances::Models::WorkRequest' ) end # rubocop:enable Metrics/BlockLength end |
#list_container_instance_shapes(compartment_id, opts = {}) ⇒ Response
Click here to see an example of how to use list_container_instance_shapes API.
Lists the shapes that can be used to create container instances.
463 464 465 466 467 468 469 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 |
# File 'lib/oci/container_instances/container_instance_client.rb', line 463 def list_container_instance_shapes(compartment_id, opts = {}) logger.debug 'Calling operation ContainerInstanceClient#list_container_instance_shapes.' if logger raise "Missing the required parameter 'compartment_id' when calling list_container_instance_shapes." if compartment_id.nil? path = '/containerInstanceShapes' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:compartmentId] = compartment_id query_params[:availabilityDomain] = opts[:availability_domain] if opts[:availability_domain] 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: 'ContainerInstanceClient#list_container_instance_shapes') 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::ContainerInstances::Models::ContainerInstanceShapeCollection' ) end # rubocop:enable Metrics/BlockLength end |
#list_container_instances(compartment_id, opts = {}) ⇒ Response
Click here to see an example of how to use list_container_instances API.
Returns a list of container instances.
Allowed values are: timeCreated, displayName
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 |
# File 'lib/oci/container_instances/container_instance_client.rb', line 533 def list_container_instances(compartment_id, opts = {}) logger.debug 'Calling operation ContainerInstanceClient#list_container_instances.' if logger raise "Missing the required parameter 'compartment_id' when calling list_container_instances." if compartment_id.nil? if opts[:lifecycle_state] && !OCI::ContainerInstances::Models::ContainerInstance::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state]) raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::ContainerInstances::Models::ContainerInstance::LIFECYCLE_STATE_ENUM.' end if opts[:sort_order] && !OCI::ContainerInstances::Models::SORT_ORDER_ENUM.include?(opts[:sort_order]) raise 'Invalid value for "sort_order", must be one of the values in OCI::ContainerInstances::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 = '/containerInstances' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:compartmentId] = compartment_id query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state] query_params[:displayName] = opts[:display_name] if opts[:display_name] query_params[:availabilityDomain] = opts[:availability_domain] if opts[:availability_domain] 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: 'ContainerInstanceClient#list_container_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: 'OCI::ContainerInstances::Models::ContainerInstanceCollection' ) end # rubocop:enable Metrics/BlockLength end |
#list_containers(compartment_id, opts = {}) ⇒ Response
Click here to see an example of how to use list_containers API.
Returns a list of containers in a compartment.
Allowed values are: timeCreated, displayName
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 667 668 669 670 671 672 673 674 675 676 |
# File 'lib/oci/container_instances/container_instance_client.rb', line 620 def list_containers(compartment_id, opts = {}) logger.debug 'Calling operation ContainerInstanceClient#list_containers.' if logger raise "Missing the required parameter 'compartment_id' when calling list_containers." if compartment_id.nil? if opts[:lifecycle_state] && !OCI::ContainerInstances::Models::Container::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state]) raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::ContainerInstances::Models::Container::LIFECYCLE_STATE_ENUM.' end if opts[:sort_order] && !OCI::ContainerInstances::Models::SORT_ORDER_ENUM.include?(opts[:sort_order]) raise 'Invalid value for "sort_order", must be one of the values in OCI::ContainerInstances::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 = '/containers' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:compartmentId] = compartment_id query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state] query_params[:displayName] = opts[:display_name] if opts[:display_name] query_params[:containerInstanceId] = opts[:container_instance_id] if opts[:container_instance_id] query_params[:availabilityDomain] = opts[:availability_domain] if opts[:availability_domain] 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: 'ContainerInstanceClient#list_containers') 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::ContainerInstances::Models::ContainerCollection' ) 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 a work request.
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 740 741 742 743 744 745 746 747 748 |
# File 'lib/oci/container_instances/container_instance_client.rb', line 700 def list_work_request_errors(work_request_id, opts = {}) logger.debug 'Calling operation ContainerInstanceClient#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[timestamp].include?(opts[:sort_by]) raise 'Invalid value for "sort_by", must be one of timestamp.' end if opts[:sort_order] && !OCI::ContainerInstances::Models::SORT_ORDER_ENUM.include?(opts[:sort_order]) raise 'Invalid value for "sort_order", must be one of the values in OCI::ContainerInstances::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: 'ContainerInstanceClient#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::ContainerInstances::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 a work request.
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 813 814 815 816 817 818 819 820 |
# File 'lib/oci/container_instances/container_instance_client.rb', line 772 def list_work_request_logs(work_request_id, opts = {}) logger.debug 'Calling operation ContainerInstanceClient#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[timestamp].include?(opts[:sort_by]) raise 'Invalid value for "sort_by", must be one of timestamp.' end if opts[:sort_order] && !OCI::ContainerInstances::Models::SORT_ORDER_ENUM.include?(opts[:sort_order]) raise 'Invalid value for "sort_order", must be one of the values in OCI::ContainerInstances::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: 'ContainerInstanceClient#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::ContainerInstances::Models::WorkRequestLogEntryCollection' ) 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.
Lists the work requests in a compartment.
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 895 896 897 898 899 900 901 902 903 904 905 906 907 |
# File 'lib/oci/container_instances/container_instance_client.rb', line 851 def list_work_requests(compartment_id, opts = {}) logger.debug 'Calling operation ContainerInstanceClient#list_work_requests.' if logger raise "Missing the required parameter 'compartment_id' when calling list_work_requests." if compartment_id.nil? if opts[:status] && !OCI::ContainerInstances::Models::OPERATION_STATUS_ENUM.include?(opts[:status]) raise 'Invalid value for "status", must be one of the values in OCI::ContainerInstances::Models::OPERATION_STATUS_ENUM.' end 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::ContainerInstances::Models::SORT_ORDER_ENUM.include?(opts[:sort_order]) raise 'Invalid value for "sort_order", must be one of the values in OCI::ContainerInstances::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[:workRequestId] = opts[:work_request_id] if opts[:work_request_id] query_params[:page] = opts[:page] if opts[:page] query_params[:limit] = opts[:limit] if opts[:limit] query_params[:availabilityDomain] = opts[:availability_domain] if opts[:availability_domain] query_params[:status] = opts[:status] if opts[:status] query_params[:sortBy] = opts[:sort_by] if opts[:sort_by] query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order] query_params[:resourceId] = opts[:resource_id] if opts[:resource_id] # 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: 'ContainerInstanceClient#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::ContainerInstances::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/container_instances/container_instance_client.rb', line 94 def logger @api_client.config.logger end |
#restart_container_instance(container_instance_id, opts = {}) ⇒ Response
Click here to see an example of how to use restart_container_instance API.
Restarts a container instance. When provided, If-Match is checked against ETag values of the container instance.
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 962 963 964 965 966 967 |
# File 'lib/oci/container_instances/container_instance_client.rb', line 931 def restart_container_instance(container_instance_id, opts = {}) logger.debug 'Calling operation ContainerInstanceClient#restart_container_instance.' if logger raise "Missing the required parameter 'container_instance_id' when calling restart_container_instance." if container_instance_id.nil? raise "Parameter value for 'container_instance_id' must not be blank" if OCI::Internal::Util.blank_string?(container_instance_id) path = '/containerInstances/{containerInstanceId}/actions/restart'.sub('{containerInstanceId}', container_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 = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'ContainerInstanceClient#restart_container_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 |
#retrieve_logs(container_id, opts = {}, &block) ⇒ Response
Click here to see an example of how to use retrieve_logs API.
Returns the most recent 256 KB of logs from the specified container.
991 992 993 994 995 996 997 998 999 1000 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 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 |
# File 'lib/oci/container_instances/container_instance_client.rb', line 991 def retrieve_logs(container_id, opts = {}, &block) logger.debug 'Calling operation ContainerInstanceClient#retrieve_logs.' if logger raise "Missing the required parameter 'container_id' when calling retrieve_logs." if container_id.nil? raise "Parameter value for 'container_id' must not be blank" if OCI::Internal::Util.blank_string?(container_id) path = '/containers/{containerId}/actions/retrieveLogs'.sub('{containerId}', container_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:isPrevious] = opts[:is_previous] if !opts[:is_previous].nil? # Header Params header_params = {} header_params[:accept] = opts[:accept] if opts[:accept] header_params[:accept] ||= 'application/json, text/plain' header_params[:'accept-encoding'] = opts[:accept_encoding] if opts[:accept_encoding] 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: 'ContainerInstanceClient#retrieve_logs') do if !block.nil? @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: 'Stream', &block ) elsif opts[:response_target] if opts[:response_target].respond_to? :write @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: 'Stream', &proc { |chunk, _response| opts[:response_target].write(chunk) } ) elsif opts[:response_target].is_a?(String) File.open(opts[:response_target], 'wb') do |output| return @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: 'Stream', &proc { |chunk, _response| output.write(chunk) } ) end end else @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: 'String' ) end end # rubocop:enable Metrics/BlockLength end |
#start_container_instance(container_instance_id, opts = {}) ⇒ Response
Click here to see an example of how to use start_container_instance API.
Starts a container instance if it is "inactive". No effect otherwise. When provided, If-Match is checked against ETag values of the container instance.
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 1124 1125 1126 1127 1128 1129 1130 1131 1132 |
# File 'lib/oci/container_instances/container_instance_client.rb', line 1096 def start_container_instance(container_instance_id, opts = {}) logger.debug 'Calling operation ContainerInstanceClient#start_container_instance.' if logger raise "Missing the required parameter 'container_instance_id' when calling start_container_instance." if container_instance_id.nil? raise "Parameter value for 'container_instance_id' must not be blank" if OCI::Internal::Util.blank_string?(container_instance_id) path = '/containerInstances/{containerInstanceId}/actions/start'.sub('{containerInstanceId}', container_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 = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'ContainerInstanceClient#start_container_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_container_instance(container_instance_id, opts = {}) ⇒ Response
Click here to see an example of how to use stop_container_instance API.
Stops a container instance if it is "active". No effect otherwise. When provided, If-Match is checked against ETag values of the container instance.
1156 1157 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 |
# File 'lib/oci/container_instances/container_instance_client.rb', line 1156 def stop_container_instance(container_instance_id, opts = {}) logger.debug 'Calling operation ContainerInstanceClient#stop_container_instance.' if logger raise "Missing the required parameter 'container_instance_id' when calling stop_container_instance." if container_instance_id.nil? raise "Parameter value for 'container_instance_id' must not be blank" if OCI::Internal::Util.blank_string?(container_instance_id) path = '/containerInstances/{containerInstanceId}/actions/stop'.sub('{containerInstanceId}', container_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 = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'ContainerInstanceClient#stop_container_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_container(container_id, update_container_details, opts = {}) ⇒ Response
Click here to see an example of how to use update_container API.
Updates a container.
1217 1218 1219 1220 1221 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 |
# File 'lib/oci/container_instances/container_instance_client.rb', line 1217 def update_container(container_id, update_container_details, opts = {}) logger.debug 'Calling operation ContainerInstanceClient#update_container.' if logger raise "Missing the required parameter 'container_id' when calling update_container." if container_id.nil? raise "Missing the required parameter 'update_container_details' when calling update_container." if update_container_details.nil? raise "Parameter value for 'container_id' must not be blank" if OCI::Internal::Util.blank_string?(container_id) path = '/containers/{containerId}'.sub('{containerId}', container_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_container_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'ContainerInstanceClient#update_container') 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 |
#update_container_instance(container_instance_id, update_container_instance_details, opts = {}) ⇒ Response
Click here to see an example of how to use update_container_instance API.
Updates a container instance.
1279 1280 1281 1282 1283 1284 1285 1286 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 |
# File 'lib/oci/container_instances/container_instance_client.rb', line 1279 def update_container_instance(container_instance_id, update_container_instance_details, opts = {}) logger.debug 'Calling operation ContainerInstanceClient#update_container_instance.' if logger raise "Missing the required parameter 'container_instance_id' when calling update_container_instance." if container_instance_id.nil? raise "Missing the required parameter 'update_container_instance_details' when calling update_container_instance." if update_container_instance_details.nil? raise "Parameter value for 'container_instance_id' must not be blank" if OCI::Internal::Util.blank_string?(container_instance_id) path = '/containerInstances/{containerInstanceId}'.sub('{containerInstanceId}', container_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_container_instance_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'ContainerInstanceClient#update_container_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 ) end # rubocop:enable Metrics/BlockLength end |