lib/oci/key_management/kms_management_client.rb
def restore_key_from_file(restore_key_from_file_details, opts = {})
      logger.debug 'Calling operation KmsManagementClient#restore_key_from_file.' if logger

      raise "Missing the required parameter 'restore_key_from_file_details' when calling restore_key_from_file." if restore_key_from_file_details.nil?

      path = '/20180608/keys/actions/restoreFromFile'
      operation_signing_strategy = :standard

      # rubocop:disable Style/NegatedIf
      # Query Params
      query_params = {}

      # Header Params
      header_params = {}
      header_params[:accept] = 'application/json'
      header_params[:'content-length'] = opts[:content_length] if opts[:content_length]
      header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
      header_params[:'content-md5'] = opts[:content_md5] if opts[:content_md5]
      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[:'content-type'] ||= 'application/octet-stream'
      header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

      post_body = @api_client.object_to_http_body(restore_key_from_file_details)

      # rubocop:disable Metrics/BlockLength
      OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'KmsManagementClient#restore_key_from_file') 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::KeyManagement::Models::Key'
        )
      end
      # rubocop:enable Metrics/BlockLength
    end
# Restores the specified key to the specified vault, based on information in the backup file provided.
# If the vault doesn't exist, the operation returns a response with a 404 HTTP status error code. You
# need to first restore the vault associated with the key.
#
# @param [String, IO] restore_key_from_file_details The encrypted backup file to upload to restore the key.
# @param [Hash] opts the optional parameters
# @option opts [OCI::Retry::RetryConfig] :retry_config The retry configuration to apply to this operation. If no key is provided then the service-level
#   retry configuration defined by {#retry_config} will be used. If an explicit `nil` value is provided then the operation will not retry
# @option opts [Integer] :content_length The content length of the body.
# @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.
#
# @option opts [String] :content_md5 The base64-encoded MD5 hash value of the body, as described in [RFC 2616](https://tools.ietf.org/rfc/rfc2616), section 14.15.
#   If the Content-MD5 header is present, Key Management performs an integrity check on the body of the HTTP request by computing the MD5
#   hash for the body and comparing it to the MD5 hash supplied in the header. If the two hashes don't match, the object is rejected and
#   a response with 400 Unmatched Content MD5 error is returned, along with the message: \"The computed MD5 of the request body (ACTUAL_MD5)
#   does not match the Content-MD5 header (HEADER_MD5).\"
#
# @option opts [String] :opc_request_id Unique identifier for the request. If provided, the returned request ID
#   will include this value. Otherwise, a random request ID will be
#   generated by the service.
#
# @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 {OCI::KeyManagement::Models::Key Key}
# @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/keymanagement/restore_key_from_file.rb.html) to see an example of how to use restore_key_from_file API.
Restores the specified key to the specified vault, based on information in the backup file provided.
If the vault doesn't exist, the operation returns a response with a 404 HTTP status error code. You
need to first restore the vault associated with the key.
Restores the specified key to the specified vault based on information in the backup file provided . If the vault doesn ' t exist the operation returns a response with a 404 HTTP status error code . You need to first restore the vault associated with the key .
def restore_key_from_file(restore_key_from_file_details, opts = {})
      logger.debug 'Calling operation KmsManagementClient#restore_key_from_file.' if logger
      raise "Missing the required parameter 'restore_key_from_file_details' when calling restore_key_from_file." if restore_key_from_file_details.nil?
      path = '/20180608/keys/actions/restoreFromFile'
      operation_signing_strategy = :standard
      query_params = {}
      header_params = {}
      header_params[:accept] = 'application/json'
      header_params[:'content-length'] = opts[:content_length] if opts[:content_length]
      header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
      header_params[:'content-md5'] = opts[:content_md5] if opts[:content_md5]
      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]
      header_params[:'content-type'] ||= 'application/octet-stream'
      header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token
      post_body = @api_client.object_to_http_body(restore_key_from_file_details)
      OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'KmsManagementClient#restore_key_from_file') 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::KeyManagement::Models::Key'
        )
      end
    end
def restore_key_from_file ( restore_key_from_file_details , opts = { } ) logger . debug 'Calling operation KmsManagementClient#restore_key_from_file.' if logger raise "Missing the required parameter 'restore_key_from_file_details' when calling restore_key_from_file." if restore_key_from_file_details . nil? path = '/20180608/keys/actions/restoreFromFile' operation_signing_strategy = :standard query_params = { } header_params = { } header_params [ :accept ] = 'application/json' header_params [ :' content-length ' ] = opts [ :content_length ] if opts [ :content_length ] header_params [ :' if-match ' ] = opts [ :if_match ] if opts [ :if_match ] header_params [ :' content-md5 ' ] = opts [ :content_md5 ] if opts [ :content_md5 ] 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 ] header_params [ :' content-type ' ] ||= 'application/octet-stream' header_params [ :' opc-retry-token ' ] ||= OCI :: Retry . generate_opc_retry_token post_body = @api_client . object_to_http_body ( restore_key_from_file_details ) OCI :: Retry . make_retrying_call ( applicable_retry_config ( opts ) , call_name : 'KmsManagementClient#restore_key_from_file' ) 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::KeyManagement::Models::Key' ) end end
Restores the specified key to the specified vault, based on information in the backup file provided.
Restores the specified key to the specified vault based on information in the backup file provided .
# rubocop:disable Style/NegatedIf # Query Params # Header Params # rubocop:enable Style/NegatedIf # rubocop:disable Metrics/BlockLength # rubocop:enable Metrics/BlockLength
A Response object with data of type {OCI::KeyManagement::Models::Key Key}
A Response object with data of type { OCI :: KeyManagement :: Models :: Key Key }
Response
restore_key_from_file_details
opts
: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 .
: 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 .
opts the optional parameters
opts the optional parameters
note
Click [here] to see an example of how to use restore_key_from_file API.
Click [ here ] to see an example of how to use restore_key_from_file API .