oraclebmc 1.1.1

data/lib/oraclebmc/core/compute_client.rb

@@ -0,0 +1,1053 @@
+# Copyright (c) 2016 Oracle and/or its affiliates. All rights reserved.
+
+require "uri"
+require "logger"
+
+module OracleBMC
+
+  class Core::ComputeClient
+
+    # Client used to make HTTP requests.
+    # @return [OracleBMC::ApiClient]
+    attr_reader :api_client
+
+    # Fully qualified endpoint URL
+    # @return [String]
+    attr_reader :endpoint
+
+    # The region, which will usually correspond to a value in {OracleBMC::Regions::REGION_ENUM}.
+    # @return [String]
+    attr_accessor :region
+
+    # Creates a new ComputeClient.
+    # If a config is not specified, then the global OracleBMC.config will be used.
+    #
+    # A region must be specified in either the config or the region parameter. If specified
+    # in both, then the region parameter will be used.
+    #
+    # @param [Config] config A Config object.
+    # @param [String] region A region used to determine the service endpoint. This will usually
+    #   correspond to a value in {OracleBMC::Regions::REGION_ENUM}, but may be an arbitrary string.
+    #
+    def initialize(config:nil, region:nil)
+      config ||= OracleBMC.config
+      signer = Signer.new(config.user, config.fingerprint, config.tenancy, config.key_file, pass_phrase: config.pass_phrase)
+      @api_client = ApiClient.new(config, signer)
+
+      region ||= config.region
+      self.region = region
+    end
+
+    # Set the region that will be used to determine the service endpoint.
+    # This will usually correspond to a value in {OracleBMC::Regions::REGION_ENUM},
+    # but may be an arbitrary string.
+    def region=(r)
+      @region = r
+
+      fail 'A region must be specified.' unless @region
+
+      if not OracleBMC::Regions.valid_region? region
+        logger.info "Unknown region '#{@region}', falling back to default endpoint format." if logger
+      end
+
+      @endpoint = OracleBMC::Regions.get_service_endpoint(@region, :ComputeClient) + '/20160918'
+      logger.info "ComputeClient endpoint set to '#{endpoint}'." if logger
+    end
+
+    # @return [Logger] The logger for this client. May be nil.
+    def logger
+      @api_client.config.logger
+    end
+
+
+    # Attaches the specified storage volume to the specified instance.
+    # 
+    # @param [AttachVolumeDetails] attach_volume_details Attach volume request
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :opc_retry_token A token that uniquely identifies a request so it can be retried in case of a timeout or
+    #   server error without risk of executing that same action again. Retry tokens expire after 24
+    #   hours, but can be invalidated before then due to conflicting operations (e.g., if a resource
+    #   has been deleted and purged from the system, then a retry of the original creation request
+    #   may be rejected).
+    #   
+    # @return [Response] A Response object with data of type OracleBMC::Core::Models::VolumeAttachment
+    def attach_volume(attach_volume_details, opts = {})
+      logger.debug "Calling operation ComputeClient#attach_volume." if logger
+
+      fail "Missing the required parameter 'attach_volume_details' when calling attach_volume." if attach_volume_details.nil?
+
+      path = "/volumeAttachments/"
+
+      # 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']
+
+      post_body = @api_client.object_to_http_body(attach_volume_details)
+
+      return @api_client.call_api(
+        :POST,
+        path,
+        endpoint,
+        :header_params => header_params,
+        :query_params => query_params,
+        :body => post_body,
+        :return_type => 'OracleBMC::Core::Models::VolumeAttachment')
+    end
+
+    # Captures the most recent serial console data (up to a megabyte) for the
+    # specified instance. 
+    # 
+    # The `CaptureConsoleHistory` operation works with the other console history operations
+    # as described below.
+    # 
+    # 1. Use `CaptureConsoleHistory` to request the capture of up to a megabyte of the
+    # most recent console history. This call returns a `ConsoleHistory`
+    # object. The object will have a state of REQUESTED.
+    # 2. Wait for the capture operation to succeed by polling `GetConsoleHistory` with
+    # the identifier of the console history metadata. The state of the
+    # `ConsoleHistory` object will go from REQUESTED to GETTING-HISTORY and
+    # then SUCCEEDED (or FAILED).
+    # 3. Use `GetConsoleHistoryContent` to get the actual console history data (not the
+    # metadata).
+    # 4. Optionally, use `DeleteConsoleHistory` to delete the console history metadata
+    # and the console history data.
+    # 
+    # @param [CaptureConsoleHistoryDetails] capture_console_history_details Console history details
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :opc_retry_token A token that uniquely identifies a request so it can be retried in case of a timeout or
+    #   server error without risk of executing that same action again. Retry tokens expire after 24
+    #   hours, but can be invalidated before then due to conflicting operations (e.g., if a resource
+    #   has been deleted and purged from the system, then a retry of the original creation request
+    #   may be rejected).
+    #   
+    # @return [Response] A Response object with data of type OracleBMC::Core::Models::ConsoleHistory
+    def capture_console_history(capture_console_history_details, opts = {})
+      logger.debug "Calling operation ComputeClient#capture_console_history." if logger
+
+      fail "Missing the required parameter 'capture_console_history_details' when calling capture_console_history." if capture_console_history_details.nil?
+
+      path = "/instanceConsoleHistories/"
+
+      # 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']
+
+      post_body = @api_client.object_to_http_body(capture_console_history_details)
+
+      return @api_client.call_api(
+        :POST,
+        path,
+        endpoint,
+        :header_params => header_params,
+        :query_params => query_params,
+        :body => post_body,
+        :return_type => 'OracleBMC::Core::Models::ConsoleHistory')
+    end
+
+    # Creates a boot disk image for the specified instance. For more information about images, see
+    # [Managing Custom Images](https://docs.us-phoenix-1.oraclecloud.com/Content/Compute/Tasks/managingcustomimages.htm).
+    # 
+    # You must provide the OCID of the instance you want to use as the basis for the image, and
+    # the OCID of the compartment containing that instance.
+    # 
+    # You may optionally specify a *display name* for the image, which is simply a friendly name or description.
+    # It does not have to be unique, and you can change it. See {#update_image update_image}.
+    # 
+    # @param [CreateImageDetails] create_image_details Image creation details
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :opc_retry_token A token that uniquely identifies a request so it can be retried in case of a timeout or
+    #   server error without risk of executing that same action again. Retry tokens expire after 24
+    #   hours, but can be invalidated before then due to conflicting operations (e.g., if a resource
+    #   has been deleted and purged from the system, then a retry of the original creation request
+    #   may be rejected).
+    #   
+    # @return [Response] A Response object with data of type OracleBMC::Core::Models::Image
+    def create_image(create_image_details, opts = {})
+      logger.debug "Calling operation ComputeClient#create_image." if logger
+
+      fail "Missing the required parameter 'create_image_details' when calling create_image." if create_image_details.nil?
+
+      path = "/images/"
+
+      # 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']
+
+      post_body = @api_client.object_to_http_body(create_image_details)
+
+      return @api_client.call_api(
+        :POST,
+        path,
+        endpoint,
+        :header_params => header_params,
+        :query_params => query_params,
+        :body => post_body,
+        :return_type => 'OracleBMC::Core::Models::Image')
+    end
+
+    # Deletes the specified console history metadata and the console history data.
+    # @param [String] instance_console_history_id The OCID of the console history.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :if_match For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`
+    #   parameter to the value of the etag from a previous GET or POST response for that resource.  The resource
+    #   will be updated or deleted only if the etag you provide matches the resource's current etag value.
+    #   
+    # @return [Response] A Response object with data of type nil
+    def delete_console_history(instance_console_history_id, opts = {})
+      logger.debug "Calling operation ComputeClient#delete_console_history." if logger
+
+      fail "Missing the required parameter 'instance_console_history_id' when calling delete_console_history." if instance_console_history_id.nil?
+
+      path = "/instanceConsoleHistories/{instanceConsoleHistoryId}".sub('{instanceConsoleHistoryId}', instance_console_history_id.to_s)
+
+      # 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']
+
+      post_body = nil
+
+      return @api_client.call_api(
+        :DELETE,
+        path,
+        endpoint,
+        :header_params => header_params,
+        :query_params => query_params,
+        :body => post_body)
+    end
+
+    # Deletes an image.
+    # @param [String] image_id The OCID of the image.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :if_match For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`
+    #   parameter to the value of the etag from a previous GET or POST response for that resource.  The resource
+    #   will be updated or deleted only if the etag you provide matches the resource's current etag value.
+    #   
+    # @return [Response] A Response object with data of type nil
+    def delete_image(image_id, opts = {})
+      logger.debug "Calling operation ComputeClient#delete_image." if logger
+
+      fail "Missing the required parameter 'image_id' when calling delete_image." if image_id.nil?
+
+      path = "/images/{imageId}".sub('{imageId}', image_id.to_s)
+
+      # 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']
+
+      post_body = nil
+
+      return @api_client.call_api(
+        :DELETE,
+        path,
+        endpoint,
+        :header_params => header_params,
+        :query_params => query_params,
+        :body => post_body)
+    end
+
+    # Detaches a storage volume from an instance. You must specify the OCID of the volume attachment.
+    # 
+    # This is an asynchronous operation; the attachment's `lifecycleState` will change to DETACHING temporarily
+    # until the attachment is completely removed.
+    # 
+    # @param [String] volume_attachment_id The OCID of the volume attachment.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :if_match For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`
+    #   parameter to the value of the etag from a previous GET or POST response for that resource.  The resource
+    #   will be updated or deleted only if the etag you provide matches the resource's current etag value.
+    #   
+    # @return [Response] A Response object with data of type nil
+    def detach_volume(volume_attachment_id, opts = {})
+      logger.debug "Calling operation ComputeClient#detach_volume." if logger
+
+      fail "Missing the required parameter 'volume_attachment_id' when calling detach_volume." if volume_attachment_id.nil?
+
+      path = "/volumeAttachments/{volumeAttachmentId}".sub('{volumeAttachmentId}', volume_attachment_id.to_s)
+
+      # 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']
+
+      post_body = nil
+
+      return @api_client.call_api(
+        :DELETE,
+        path,
+        endpoint,
+        :header_params => header_params,
+        :query_params => query_params,
+        :body => post_body)
+    end
+
+    # Shows the metadata for the specified console history.
+    # See {#capture_console_history capture_console_history}
+    # for details about using the console history operations.
+    # 
+    # @param [String] instance_console_history_id The OCID of the console history.
+    # @param [Hash] opts the optional parameters
+    # @return [Response] A Response object with data of type OracleBMC::Core::Models::ConsoleHistory
+    def get_console_history(instance_console_history_id, opts = {})
+      logger.debug "Calling operation ComputeClient#get_console_history." if logger
+
+      fail "Missing the required parameter 'instance_console_history_id' when calling get_console_history." if instance_console_history_id.nil?
+
+      path = "/instanceConsoleHistories/{instanceConsoleHistoryId}".sub('{instanceConsoleHistoryId}', instance_console_history_id.to_s)
+
+      # Query Params
+      query_params = {}
+
+      # Header Params
+      header_params = {}
+      header_params['accept'] = 'application/json'
+      header_params['content-type'] = 'application/json'
+
+      post_body = nil
+
+      return @api_client.call_api(
+        :GET,
+        path,
+        endpoint,
+        :header_params => header_params,
+        :query_params => query_params,
+        :body => post_body,
+        :return_type => 'OracleBMC::Core::Models::ConsoleHistory')
+    end
+
+    # Gets the actual console history data (not the metadata).
+    # See {#capture_console_history capture_console_history}
+    # for details about using the console history operations.
+    # 
+    # @param [String] instance_console_history_id The OCID of the console history.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :offset Offset of the snapshot data to retrieve.
+    # @option opts [Integer] :length Length of the snapshot data to retrieve.
+    # @return [Response] A Response object with data of type String
+    def get_console_history_content(instance_console_history_id, opts = {})
+      logger.debug "Calling operation ComputeClient#get_console_history_content." if logger
+
+      fail "Missing the required parameter 'instance_console_history_id' when calling get_console_history_content." if instance_console_history_id.nil?
+
+      path = "/instanceConsoleHistories/{instanceConsoleHistoryId}/data".sub('{instanceConsoleHistoryId}', instance_console_history_id.to_s)
+
+      # Query Params
+      query_params = {}
+      query_params[:'offset'] = opts[:'offset'] if opts[:'offset']
+      query_params[:'length'] = opts[:'length'] if opts[:'length']
+
+      # Header Params
+      header_params = {}
+      header_params['accept'] = 'application/json'
+      header_params['content-type'] = 'application/json'
+
+      post_body = nil
+
+      return @api_client.call_api(
+        :GET,
+        path,
+        endpoint,
+        :header_params => header_params,
+        :query_params => query_params,
+        :body => post_body,
+        :return_type => 'String')
+    end
+
+    # Gets the specified image.
+    # @param [String] image_id The OCID of the image.
+    # @param [Hash] opts the optional parameters
+    # @return [Response] A Response object with data of type OracleBMC::Core::Models::Image
+    def get_image(image_id, opts = {})
+      logger.debug "Calling operation ComputeClient#get_image." if logger
+
+      fail "Missing the required parameter 'image_id' when calling get_image." if image_id.nil?
+
+      path = "/images/{imageId}".sub('{imageId}', image_id.to_s)
+
+      # Query Params
+      query_params = {}
+
+      # Header Params
+      header_params = {}
+      header_params['accept'] = 'application/json'
+      header_params['content-type'] = 'application/json'
+
+      post_body = nil
+
+      return @api_client.call_api(
+        :GET,
+        path,
+        endpoint,
+        :header_params => header_params,
+        :query_params => query_params,
+        :body => post_body,
+        :return_type => 'OracleBMC::Core::Models::Image')
+    end
+
+    # Gets information about the specified instance.
+    # @param [String] instance_id The OCID of the instance.
+    # @param [Hash] opts the optional parameters
+    # @return [Response] A Response object with data of type OracleBMC::Core::Models::Instance
+    def get_instance(instance_id, opts = {})
+      logger.debug "Calling operation ComputeClient#get_instance." if logger
+
+      fail "Missing the required parameter 'instance_id' when calling get_instance." if instance_id.nil?
+
+      path = "/instances/{instanceId}".sub('{instanceId}', instance_id.to_s)
+
+      # Query Params
+      query_params = {}
+
+      # Header Params
+      header_params = {}
+      header_params['accept'] = 'application/json'
+      header_params['content-type'] = 'application/json'
+
+      post_body = nil
+
+      return @api_client.call_api(
+        :GET,
+        path,
+        endpoint,
+        :header_params => header_params,
+        :query_params => query_params,
+        :body => post_body,
+        :return_type => 'OracleBMC::Core::Models::Instance')
+    end
+
+    # Gets information about the specified volume attachment.
+    # @param [String] volume_attachment_id The OCID of the volume attachment.
+    # @param [Hash] opts the optional parameters
+    # @return [Response] A Response object with data of type OracleBMC::Core::Models::VolumeAttachment
+    def get_volume_attachment(volume_attachment_id, opts = {})
+      logger.debug "Calling operation ComputeClient#get_volume_attachment." if logger
+
+      fail "Missing the required parameter 'volume_attachment_id' when calling get_volume_attachment." if volume_attachment_id.nil?
+
+      path = "/volumeAttachments/{volumeAttachmentId}".sub('{volumeAttachmentId}', volume_attachment_id.to_s)
+
+      # Query Params
+      query_params = {}
+
+      # Header Params
+      header_params = {}
+      header_params['accept'] = 'application/json'
+      header_params['content-type'] = 'application/json'
+
+      post_body = nil
+
+      return @api_client.call_api(
+        :GET,
+        path,
+        endpoint,
+        :header_params => header_params,
+        :query_params => query_params,
+        :body => post_body,
+        :return_type => 'OracleBMC::Core::Models::VolumeAttachment')
+    end
+
+    # Performs one of the power actions (start, stop, softreset, or reset)
+    # on the specified instance.
+    # 
+    # **start** - power on
+    # 
+    # **stop** - power off
+    # 
+    # **softreset** - ACPI shutdown and power on
+    # 
+    # **reset** - power off and power on
+    # 
+    # Note that the **stop** state has no effect on the resources you consume.
+    # Billing continues for instances that you stop, and related resources continue
+    # to apply against any relevant quotas. You must terminate an instance 
+    # ({#terminate_instance terminate_instance})
+    # to remove its resources from billing and quotas.
+    # 
+    # @param [String] instance_id The OCID of the instance.
+    # @param [String] action The action to perform on the instance.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :opc_retry_token A token that uniquely identifies a request so it can be retried in case of a timeout or
+    #   server error without risk of executing that same action again. Retry tokens expire after 24
+    #   hours, but can be invalidated before then due to conflicting operations (e.g., if a resource
+    #   has been deleted and purged from the system, then a retry of the original creation request
+    #   may be rejected).
+    #   
+    # @option opts [String] :if_match For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`
+    #   parameter to the value of the etag from a previous GET or POST response for that resource.  The resource
+    #   will be updated or deleted only if the etag you provide matches the resource's current etag value.
+    #   
+    # @return [Response] A Response object with data of type OracleBMC::Core::Models::Instance
+    def instance_action(instance_id, action, opts = {})
+      logger.debug "Calling operation ComputeClient#instance_action." if logger
+
+      fail "Missing the required parameter 'instance_id' when calling instance_action." if instance_id.nil?
+      fail "Missing the required parameter 'action' when calling instance_action." if action.nil?
+      unless ['STOP', 'START', 'SOFTRESET', 'RESET'].include?(action)
+        fail "Invalid value for 'action', must be one of STOP, START, SOFTRESET, RESET."
+      end
+
+      path = "/instances/{instanceId}".sub('{instanceId}', instance_id.to_s)
+
+      # Query Params
+      query_params = {}
+      query_params[:'action'] = action
+
+      # 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[:'if-match'] = opts[:'if_match'] if opts[:'if_match']
+
+      post_body = nil
+
+      return @api_client.call_api(
+        :POST,
+        path,
+        endpoint,
+        :header_params => header_params,
+        :query_params => query_params,
+        :body => post_body,
+        :return_type => 'OracleBMC::Core::Models::Instance')
+    end
+
+    # Creates a new instance in the specified compartment and the specified Availability Domain.
+    # For general information about instances, see 
+    # [Overview of the Compute Service](https://docs.us-phoenix-1.oraclecloud.com/Content/Compute/Concepts/computeoverview.htm).
+    # 
+    # For information about access control and compartments, see
+    # [Overview of the IAM Service](https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/overview.htm).
+    # 
+    # For information about Availability Domains, see
+    # [Regions and Availability Domains](https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/regions.htm).
+    # To get a list of Availability Domains, use the `ListAvailabilityDomains` operation
+    # in the Identity and Access Management Service API.
+    # 
+    # All Oracle Bare Metal Cloud Services resources, including instances, get an Oracle-assigned,
+    # unique ID called an Oracle Cloud Identifier (OCID).
+    # When you create a resource, you can find its OCID in the response. You can
+    # also retrieve a resource's OCID by using a List API operation
+    # on that resource type, or by viewing the resource in the Console.
+    # 
+    # When you launch an instance, it is automatically attached to a Virtual
+    # Network Interface Card (VNIC) and given both a public and private IP address.
+    # To get both addresses, use the {#list_vnic_attachments list_vnic_attachments}
+    # operation to get the VNIC ID for the instance, and then call
+    # {#get_vnic get_vnic} with the VNIC ID.
+    # 
+    # @param [LaunchInstanceDetails] launch_instance_details Instance details
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :opc_retry_token A token that uniquely identifies a request so it can be retried in case of a timeout or
+    #   server error without risk of executing that same action again. Retry tokens expire after 24
+    #   hours, but can be invalidated before then due to conflicting operations (e.g., if a resource
+    #   has been deleted and purged from the system, then a retry of the original creation request
+    #   may be rejected).
+    #   
+    # @option opts [String] :opc_host_serial For Oracle internal use only.
+    # @option opts [String] :opc_pool_name For Oracle internal use only.
+    # @option opts [String] :opc_vnic_id For Oracle internal use only.
+    # @return [Response] A Response object with data of type OracleBMC::Core::Models::Instance
+    def launch_instance(launch_instance_details, opts = {})
+      logger.debug "Calling operation ComputeClient#launch_instance." if logger
+
+      fail "Missing the required parameter 'launch_instance_details' when calling launch_instance." if launch_instance_details.nil?
+
+      path = "/instances/"
+
+      # Query Params
+      query_params = {}
+      query_params[:'opc-host-serial'] = opts[:'opc_host_serial'] if opts[:'opc_host_serial']
+      query_params[:'opc-pool-name'] = opts[:'opc_pool_name'] if opts[:'opc_pool_name']
+      query_params[:'opc-vnic-id'] = opts[:'opc_vnic_id'] if opts[:'opc_vnic_id']
+
+      # 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']
+
+      post_body = @api_client.object_to_http_body(launch_instance_details)
+
+      return @api_client.call_api(
+        :POST,
+        path,
+        endpoint,
+        :header_params => header_params,
+        :query_params => query_params,
+        :body => post_body,
+        :return_type => 'OracleBMC::Core::Models::Instance')
+    end
+
+    # Lists the console history metadata for the specified compartment or instance.
+    # 
+    # @param [String] compartment_id The OCID of the compartment.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :availability_domain The name of the Availability Domain.
+    #   
+    #   Example: `Uocm:PHX-AD-1`
+    #   
+    # @option opts [Integer] :limit The maximum number of items to return in a paginated \"List\" call.
+    #   
+    #   Example: `500`
+    #   
+    # @option opts [String] :page The value of the `opc-next-page` response header from the previous \"List\" call.
+    #   
+    # @option opts [String] :instance_id The OCID of the instance.
+    # @return [Response] A Response object with data of type Array<OracleBMC::Core::Models::ConsoleHistory>
+    def list_console_histories(compartment_id, opts = {})
+      logger.debug "Calling operation ComputeClient#list_console_histories." if logger
+
+      fail "Missing the required parameter 'compartment_id' when calling list_console_histories." if compartment_id.nil?
+
+      path = "/instanceConsoleHistories/"
+
+      # 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']
+      query_params[:'instanceId'] = opts[:'instance_id'] if opts[:'instance_id']
+
+      # Header Params
+      header_params = {}
+      header_params['accept'] = 'application/json'
+      header_params['content-type'] = 'application/json'
+
+      post_body = nil
+
+      return @api_client.call_api(
+        :GET,
+        path,
+        endpoint,
+        :header_params => header_params,
+        :query_params => query_params,
+        :body => post_body,
+        :return_type => 'Array<OracleBMC::Core::Models::ConsoleHistory>')
+    end
+
+    # Lists the available images in the specified compartment. For more 
+    # information about images, see
+    # [Managing Custom Images](https://docs.us-phoenix-1.oraclecloud.com/Content/Compute/Tasks/managingcustomimages.htm).
+    # 
+    # @param [String] compartment_id The OCID of the compartment.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :display_name A user-friendly name. Does not have to be unique, and it&#39;s changeable.
+    #   
+    #   Example: `My new resource`
+    #   
+    # @option opts [String] :operating_system The image&#39;s operating system.
+    #   
+    #   Example: `Oracle Linux`
+    #   
+    # @option opts [String] :operating_system_version The image&#39;s operating system version.
+    #   
+    #   Example: `7.2`
+    #   
+    # @option opts [Integer] :limit The maximum number of items to return in a paginated \&quot;List\&quot; call.
+    #   
+    #   Example: `500`
+    #   
+    # @option opts [String] :page The value of the `opc-next-page` response header from the previous \&quot;List\&quot; call.
+    #   
+    # @return [Response] A Response object with data of type Array<OracleBMC::Core::Models::Image>
+    def list_images(compartment_id, opts = {})
+      logger.debug "Calling operation ComputeClient#list_images." if logger
+
+      fail "Missing the required parameter 'compartment_id' when calling list_images." if compartment_id.nil?
+
+      path = "/images/"
+
+      # Query Params
+      query_params = {}
+      query_params[:'compartmentId'] = compartment_id
+      query_params[:'displayName'] = opts[:'display_name'] if opts[:'display_name']
+      query_params[:'operatingSystem'] = opts[:'operating_system'] if opts[:'operating_system']
+      query_params[:'operatingSystemVersion'] = opts[:'operating_system_version'] if opts[:'operating_system_version']
+      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'
+
+      post_body = nil
+
+      return @api_client.call_api(
+        :GET,
+        path,
+        endpoint,
+        :header_params => header_params,
+        :query_params => query_params,
+        :body => post_body,
+        :return_type => 'Array<OracleBMC::Core::Models::Image>')
+    end
+
+    # Lists the instances in the specified compartment and the specified Availability Domain.
+    # You can filter the results by specifying an instance name (the list will include all the identically-named
+    # instances in the compartment).
+    # 
+    # @param [String] compartment_id The OCID of the compartment.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :availability_domain The name of the Availability Domain.
+    #   
+    #   Example: `Uocm:PHX-AD-1`
+    #   
+    # @option opts [String] :display_name A user-friendly name. Does not have to be unique, and it&#39;s changeable.
+    #   
+    #   Example: `My new resource`
+    #   
+    # @option opts [Integer] :limit The maximum number of items to return in a paginated \&quot;List\&quot; call.
+    #   
+    #   Example: `500`
+    #   
+    # @option opts [String] :page The value of the `opc-next-page` response header from the previous \&quot;List\&quot; call.
+    #   
+    # @return [Response] A Response object with data of type Array<OracleBMC::Core::Models::Instance>
+    def list_instances(compartment_id, opts = {})
+      logger.debug "Calling operation ComputeClient#list_instances." if logger
+
+      fail "Missing the required parameter 'compartment_id' when calling list_instances." if compartment_id.nil?
+
+      path = "/instances/"
+
+      # Query Params
+      query_params = {}
+      query_params[:'compartmentId'] = compartment_id
+      query_params[:'availabilityDomain'] = opts[:'availability_domain'] if opts[:'availability_domain']
+      query_params[:'displayName'] = opts[:'display_name'] if opts[:'display_name']
+      query_params[:'limit'] = opts[:'limit'] if opts[:'limit']
+      query_params[:'page'] = opts[:'page'] if opts[:'page']
+
+      # Header Params
+      header_params = {}
+      header_params['accept'] = 'application/json'
+      header_params['content-type'] = 'application/json'
+
+      post_body = nil
+
+      return @api_client.call_api(
+        :GET,
+        path,
+        endpoint,
+        :header_params => header_params,
+        :query_params => query_params,
+        :body => post_body,
+        :return_type => 'Array<OracleBMC::Core::Models::Instance>')
+    end
+
+    # Lists the shapes that can be used to launch an instance within the specified compartment. You can 
+    # filter the list by compatibility with a specific image.
+    # 
+    # @param [String] compartment_id The OCID of the compartment.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :availability_domain The name of the Availability Domain.
+    #   
+    #   Example: `Uocm:PHX-AD-1`
+    #   
+    # @option opts [Integer] :limit The maximum number of items to return in a paginated \&quot;List\&quot; call.
+    #   
+    #   Example: `500`
+    #   
+    # @option opts [String] :page The value of the `opc-next-page` response header from the previous \&quot;List\&quot; call.
+    #   
+    # @option opts [String] :image_id The OCID of an image.
+    # @return [Response] A Response object with data of type Array<OracleBMC::Core::Models::Shape>
+    def list_shapes(compartment_id, opts = {})
+      logger.debug "Calling operation ComputeClient#list_shapes." if logger
+
+      fail "Missing the required parameter 'compartment_id' when calling list_shapes." if compartment_id.nil?
+
+      path = "/shapes"
+
+      # 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']
+      query_params[:'imageId'] = opts[:'image_id'] if opts[:'image_id']
+
+      # Header Params
+      header_params = {}
+      header_params['accept'] = 'application/json'
+      header_params['content-type'] = 'application/json'
+
+      post_body = nil
+
+      return @api_client.call_api(
+        :GET,
+        path,
+        endpoint,
+        :header_params => header_params,
+        :query_params => query_params,
+        :body => post_body,
+        :return_type => 'Array<OracleBMC::Core::Models::Shape>')
+    end
+
+    # Lists the VNIC attachments for the specified compartment. The list can be filtered by
+    # instance and by VNIC.
+    # 
+    # @param [String] compartment_id The OCID of the compartment.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :availability_domain The name of the Availability Domain.
+    #   
+    #   Example: `Uocm:PHX-AD-1`
+    #   
+    # @option opts [String] :instance_id The OCID of the instance.
+    # @option opts [Integer] :limit The maximum number of items to return in a paginated \&quot;List\&quot; call.
+    #   
+    #   Example: `500`
+    #   
+    # @option opts [String] :page The value of the `opc-next-page` response header from the previous \&quot;List\&quot; call.
+    #   
+    # @option opts [String] :vnic_id The OCID of the VNIC.
+    # @return [Response] A Response object with data of type Array<OracleBMC::Core::Models::VnicAttachment>
+    def list_vnic_attachments(compartment_id, opts = {})
+      logger.debug "Calling operation ComputeClient#list_vnic_attachments." if logger
+
+      fail "Missing the required parameter 'compartment_id' when calling list_vnic_attachments." if compartment_id.nil?
+
+      path = "/vnicAttachments/"
+
+      # Query Params
+      query_params = {}
+      query_params[:'compartmentId'] = compartment_id
+      query_params[:'availabilityDomain'] = opts[:'availability_domain'] if opts[:'availability_domain']
+      query_params[:'instanceId'] = opts[:'instance_id'] if opts[:'instance_id']
+      query_params[:'limit'] = opts[:'limit'] if opts[:'limit']
+      query_params[:'page'] = opts[:'page'] if opts[:'page']
+      query_params[:'vnicId'] = opts[:'vnic_id'] if opts[:'vnic_id']
+
+      # Header Params
+      header_params = {}
+      header_params['accept'] = 'application/json'
+      header_params['content-type'] = 'application/json'
+
+      post_body = nil
+
+      return @api_client.call_api(
+        :GET,
+        path,
+        endpoint,
+        :header_params => header_params,
+        :query_params => query_params,
+        :body => post_body,
+        :return_type => 'Array<OracleBMC::Core::Models::VnicAttachment>')
+    end
+
+    # Lists the volume attachments in the specified compartment. You can filter the
+    # list by specifying an instance OCID, volume OCID, or both.
+    # 
+    # Currently, the only supported volume attachment type is {IScsiVolumeAttachment}.
+    # 
+    # @param [String] compartment_id The OCID of the compartment.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :availability_domain The name of the Availability Domain.
+    #   
+    #   Example: `Uocm:PHX-AD-1`
+    #   
+    # @option opts [Integer] :limit The maximum number of items to return in a paginated \&quot;List\&quot; call.
+    #   
+    #   Example: `500`
+    #   
+    # @option opts [String] :page The value of the `opc-next-page` response header from the previous \&quot;List\&quot; call.
+    #   
+    # @option opts [String] :instance_id The OCID of the instance.
+    # @option opts [String] :volume_id The OCID of the volume.
+    # @return [Response] A Response object with data of type Array<OracleBMC::Core::Models::VolumeAttachment>
+    def list_volume_attachments(compartment_id, opts = {})
+      logger.debug "Calling operation ComputeClient#list_volume_attachments." if logger
+
+      fail "Missing the required parameter 'compartment_id' when calling list_volume_attachments." if compartment_id.nil?
+
+      path = "/volumeAttachments/"
+
+      # 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']
+      query_params[:'instanceId'] = opts[:'instance_id'] if opts[:'instance_id']
+      query_params[:'volumeId'] = opts[:'volume_id'] if opts[:'volume_id']
+
+      # Header Params
+      header_params = {}
+      header_params['accept'] = 'application/json'
+      header_params['content-type'] = 'application/json'
+
+      post_body = nil
+
+      return @api_client.call_api(
+        :GET,
+        path,
+        endpoint,
+        :header_params => header_params,
+        :query_params => query_params,
+        :body => post_body,
+        :return_type => 'Array<OracleBMC::Core::Models::VolumeAttachment>')
+    end
+
+    # Terminates the specified instance. Any attached VNICs and volumes are automatically detached
+    # when the instance terminates.
+    # 
+    # This is an asynchronous operation; the instance's `lifecycleState` will change to TERMINATING temporarily
+    # until the instance is completely removed.
+    # 
+    # @param [String] instance_id The OCID of the instance.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :if_match For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`
+    #   parameter to the value of the etag from a previous GET or POST response for that resource.  The resource
+    #   will be updated or deleted only if the etag you provide matches the resource&#39;s current etag value.
+    #   
+    # @return [Response] A Response object with data of type nil
+    def terminate_instance(instance_id, opts = {})
+      logger.debug "Calling operation ComputeClient#terminate_instance." if logger
+
+      fail "Missing the required parameter 'instance_id' when calling terminate_instance." if instance_id.nil?
+
+      path = "/instances/{instanceId}".sub('{instanceId}', instance_id.to_s)
+
+      # 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']
+
+      post_body = nil
+
+      return @api_client.call_api(
+        :DELETE,
+        path,
+        endpoint,
+        :header_params => header_params,
+        :query_params => query_params,
+        :body => post_body)
+    end
+
+    # Updates the display name of the image.
+    # @param [String] image_id The OCID of the image.
+    # @param [UpdateImageDetails] update_image_details Updates the image display name field.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :opc_retry_token A token that uniquely identifies a request so it can be retried in case of a timeout or
+    #   server error without risk of executing that same action again. Retry tokens expire after 24
+    #   hours, but can be invalidated before then due to conflicting operations (e.g., if a resource
+    #   has been deleted and purged from the system, then a retry of the original creation request
+    #   may be rejected).
+    #   
+    # @option opts [String] :if_match For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`
+    #   parameter to the value of the etag from a previous GET or POST response for that resource.  The resource
+    #   will be updated or deleted only if the etag you provide matches the resource&#39;s current etag value.
+    #   
+    # @return [Response] A Response object with data of type OracleBMC::Core::Models::Image
+    def update_image(image_id, update_image_details, opts = {})
+      logger.debug "Calling operation ComputeClient#update_image." if logger
+
+      fail "Missing the required parameter 'image_id' when calling update_image." if image_id.nil?
+      fail "Missing the required parameter 'update_image_details' when calling update_image." if update_image_details.nil?
+
+      path = "/images/{imageId}".sub('{imageId}', image_id.to_s)
+
+      # 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[:'if-match'] = opts[:'if_match'] if opts[:'if_match']
+
+      post_body = @api_client.object_to_http_body(update_image_details)
+
+      return @api_client.call_api(
+        :PUT,
+        path,
+        endpoint,
+        :header_params => header_params,
+        :query_params => query_params,
+        :body => post_body,
+        :return_type => 'OracleBMC::Core::Models::Image')
+    end
+
+    # Updates the display name of the specified instance. The OCID of the instance
+    # remains the same.
+    # 
+    # @param [String] instance_id The OCID of the instance.
+    # @param [UpdateInstanceDetails] update_instance_details Update instance fields
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :opc_retry_token A token that uniquely identifies a request so it can be retried in case of a timeout or
+    #   server error without risk of executing that same action again. Retry tokens expire after 24
+    #   hours, but can be invalidated before then due to conflicting operations (e.g., if a resource
+    #   has been deleted and purged from the system, then a retry of the original creation request
+    #   may be rejected).
+    #   
+    # @option opts [String] :if_match For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`
+    #   parameter to the value of the etag from a previous GET or POST response for that resource.  The resource
+    #   will be updated or deleted only if the etag you provide matches the resource&#39;s current etag value.
+    #   
+    # @return [Response] A Response object with data of type OracleBMC::Core::Models::Instance
+    def update_instance(instance_id, update_instance_details, opts = {})
+      logger.debug "Calling operation ComputeClient#update_instance." if logger
+
+      fail "Missing the required parameter 'instance_id' when calling update_instance." if instance_id.nil?
+      fail "Missing the required parameter 'update_instance_details' when calling update_instance." if update_instance_details.nil?
+
+      path = "/instances/{instanceId}".sub('{instanceId}', instance_id.to_s)
+
+      # 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[:'if-match'] = opts[:'if_match'] if opts[:'if_match']
+
+      post_body = @api_client.object_to_http_body(update_instance_details)
+
+      return @api_client.call_api(
+        :PUT,
+        path,
+        endpoint,
+        :header_params => header_params,
+        :query_params => query_params,
+        :body => post_body,
+        :return_type => 'OracleBMC::Core::Models::Instance')
+    end
+  end
+end