Method: OCI::ObjectStorage::ObjectStorageClient#put_object

Defined in:

lib/oci/object_storage/object_storage_client.rb

#put_object(namespace_name, bucket_name, object_name, put_object_body, opts = {}) ⇒ Response

Creates a new object or overwrites an existing one.

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`

• put_object_body (String, IO) —

  The object to upload to the object store.

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

  the optional parameters

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

• :content_length (Integer) —

  The content length of the body.

• :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.

• :expect (String) —

  100-continue (default to 100-continue)

• :content_md5 (String) —

  The base-64 encoded MD5 hash of the body.

• :content_type (String) —

  The content type of the object. Defaults to ‘application/octet-stream’ if not overridden during the PutObject call.

• :content_language (String) —

  The content language of the object.

• :content_encoding (String) —

  The content encoding of the object.

• :opc_meta (Hash<String, String>) —

  Optional user-defined metadata key and value. “opc-meta-” will be appended to each Hash key before it is sent to the server.

Returns:

• (Response) —

  A Response object with data of type nil

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

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

  raise "Missing the required parameter 'namespace_name' when calling put_object." if namespace_name.nil?
  raise "Missing the required parameter 'bucket_name' when calling put_object." if bucket_name.nil?
  raise "Missing the required parameter 'object_name' when calling put_object." if object_name.nil?
  raise "Missing the required parameter 'put_object_body' when calling put_object." if put_object_body.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 = :exclude_body

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

  # Header Params
  header_params = {}
  header_params['accept'] = '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[:expect] = opts[:expect] if opts[:expect]
  header_params[:'content-length'] = opts[:content_length] if opts[:content_length]
  header_params[:'content-md5'] = opts[:content_md5] if opts[:content_md5]
  header_params[:'content-type'] = opts[:content_type] if opts[:content_type]
  header_params[:'content-language'] = opts[:content_language] if opts[:content_language]
  header_params[:'content-encoding'] = opts[:content_encoding] if opts[:content_encoding]
  # rubocop:enable Style/NegatedIf

  if opts[:opc_meta]
    opts[:opc_meta].each do |key, value|
      header_params["opc-meta-#{key}".to_sym] = value
    end
  end
  header_params['content-type'] ||= 'application/octet-stream'

  post_body = @api_client.object_to_http_body(put_object_body)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ObjectStorageClient#put_object') 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