Method: OCI::ObjectStorage::ObjectStorageClient#get_object

Defined in:

lib/oci/object_storage/object_storage_client.rb

#get_object(namespace_name, bucket_name, object_name, opts = {}, &block) ⇒ Response

Gets the metadata and body of an object.

Parameters:

• namespace_name (String) —

  The top-level namespace used for the request.

• bucket_name (String) —

  The name of the bucket. Avoid entering confidential information. Example: ‘my-new-bucket1`

• object_name (String) —

  The name of the object. Avoid entering confidential information. Example: ‘test/object1.log`

• opts (Hash) (defaults to: {}) —

  the optional parameters

• [Block] (Hash) —

  a customizable set of options

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  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

• :if_match (String) —

  The entity tag to match. For creating and committing a multipart upload to an object, this is the entity tag of the target object. For uploading a part, this is the entity tag of the target part.

• :if_none_match (String) —

  The entity tag to avoid matching. The only valid value is u2018*u2019, which indicates that the request should fail if the object already exists. For creating and committing a multipart upload, this is the entity tag of the target object. For uploading a part, this is the entity tag of the target part.

• :opc_client_request_id (String) —

  The client request ID for tracing.

• :range (String) —

  Optional byte range to fetch, as described in [RFC 7233](tools.ietf.org/rfc/rfc7233), section 2.1. Note that only a single range of bytes is supported.

• :response_target (String, IO) —

  Streaming http body into a file (specified by file name or File object) or IO object if the block is not given

Returns:

• (Response) —

  A Response object with data of type String if response_target and block are not given, otherwise with nil data

# File 'lib/oci/object_storage/object_storage_client.rb', line 822

def get_object(namespace_name, bucket_name, object_name, opts = {}, &block)
  logger.debug 'Calling operation ObjectStorageClient#get_object.' if logger

  raise "Missing the required parameter 'namespace_name' when calling get_object." if namespace_name.nil?
  raise "Missing the required parameter 'bucket_name' when calling get_object." if bucket_name.nil?
  raise "Missing the required parameter 'object_name' when calling get_object." if object_name.nil?
  raise "Parameter value for 'namespace_name' must not be blank" if OCI::Internal::Util.blank_string?(namespace_name)
  raise "Parameter value for 'bucket_name' must not be blank" if OCI::Internal::Util.blank_string?(bucket_name)
  raise "Parameter value for 'object_name' must not be blank" if OCI::Internal::Util.blank_string?(object_name)

  path = '/n/{namespaceName}/b/{bucketName}/o/{objectName}'.sub('{namespaceName}', namespace_name.to_s).sub('{bucketName}', bucket_name.to_s).sub('{objectName}', object_name.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[:'if-none-match'] = opts[:if_none_match] if opts[:if_none_match]
  header_params[:'opc-client-request-id'] = opts[:opc_client_request_id] if opts[:opc_client_request_id]
  header_params[:range] = opts[:range] if opts[:range]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ObjectStorageClient#get_object') do
    if !block.nil?
      @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: 'Stream',
        &block
      )
    elsif opts[:response_target]
      if opts[:response_target].respond_to? :write
        @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: '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(
            :GET,
            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(
        :GET,
        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