mirror of
https://github.com/fog/fog.git
synced 2022-11-09 13:51:43 -05:00
change docs on initiate_multipart_upload.rb
This commit is contained in:
parent
d15a610a65
commit
cab272834f
2 changed files with 20 additions and 21 deletions
|
@ -19,8 +19,8 @@ module Fog
|
|||
# @return [Excon::Response] response:
|
||||
# * body [String] Contents of object
|
||||
# * headers [Hash]:
|
||||
# * Content-Length - [String] Size of object contents
|
||||
# * Content-Type - [String] MIME type of object
|
||||
# * Content-Length [String] - Size of object contents
|
||||
# * Content-Type [String] - MIME type of object
|
||||
# * ETag [String] - Etag of object
|
||||
# * Last-Modified - [String] Last modified timestamp for object
|
||||
#
|
||||
|
|
|
@ -5,30 +5,29 @@ module Fog
|
|||
|
||||
require 'fog/aws/parsers/storage/initiate_multipart_upload'
|
||||
|
||||
#
|
||||
# Initiate a multipart upload to an S3 bucket
|
||||
#
|
||||
# ==== Parameters
|
||||
# * bucket_name<~String> - Name of bucket to create object in
|
||||
# * object_name<~String> - Name of object to create
|
||||
# * options<~Hash>:
|
||||
# * 'Cache-Control'<~String> - Caching behaviour
|
||||
# * 'Content-Disposition'<~String> - Presentational information for the object
|
||||
# * 'Content-Encoding'<~String> - Encoding of object data
|
||||
# * 'Content-MD5'<~String> - Base64 encoded 128-bit MD5 digest of message (defaults to Base64 encoded MD5 of object.read)
|
||||
# * 'Content-Type'<~String> - Standard MIME type describing contents (defaults to MIME::Types.of.first)
|
||||
# * 'x-amz-acl'<~String> - Permissions, must be in ['private', 'public-read', 'public-read-write', 'authenticated-read']
|
||||
# * "x-amz-meta-#{name}" - Headers to be returned with object, note total size of request without body must be less than 8 KB.
|
||||
# @param bucket_name [String] Name of bucket to create object in
|
||||
# @param object_name [String] Name of object to create
|
||||
# @param options [Hash]:
|
||||
# @option options [String] Cache-Control Caching behaviour
|
||||
# @option options [String] Content-Disposition Presentational information for the object
|
||||
# @option options [String] Content-Encoding Encoding of object data
|
||||
# @option options [String] Content-MD5 Base64 encoded 128-bit MD5 digest of message (defaults to Base64 encoded MD5 of object.read)
|
||||
# @option options [String] Content-Type Standard MIME type describing contents (defaults to MIME::Types.of.first)
|
||||
# @option options [String] x-amz-acl Permissions, must be in ['private', 'public-read', 'public-read-write', 'authenticated-read']
|
||||
# @option options [String] x-amz-meta-#{name} Headers to be returned with object, note total size of request without body must be less than 8 KB.
|
||||
#
|
||||
# ==== Returns
|
||||
# * response<~Excon::Response>:
|
||||
# * body<~Hash>:
|
||||
# * 'Bucket'<~String> - Bucket where upload was initiated
|
||||
# * 'Key'<~String> - Object key where the upload was initiated
|
||||
# * 'UploadId'<~String> - Id for initiated multipart upload
|
||||
# @return [Excon::Response] response:
|
||||
# * body [Hash]:
|
||||
# * Bucket [String] - Bucket where upload was initiated
|
||||
# * Key [String] - Object key where the upload was initiated
|
||||
# * UploadId [String] - Id for initiated multipart upload
|
||||
#
|
||||
# ==== See Also
|
||||
# http://docs.amazonwebservices.com/AmazonS3/latest/API/mpUploadInitiate.html
|
||||
# @see http://docs.amazonwebservices.com/AmazonS3/latest/API/mpUploadInitiate.html
|
||||
#
|
||||
|
||||
def initiate_multipart_upload(bucket_name, object_name, options = {})
|
||||
request({
|
||||
:expects => 200,
|
||||
|
|
Loading…
Add table
Reference in a new issue