kotovalexarian-likes-github/fog--fog
1
0
Fork 0
mirror of https://github.com/fog/fog.git synced 2022-11-09 13:51:43 -05:00
Code Releases Activity

YARD docs for head_object.rb

Browse source
This commit is contained in:
Danny Garcia 2013-01-06 21:28:40 -05:00
parent 0485245d19
commit bad71d1805
1 changed files with 21 additions and 21 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

42
lib/fog/aws/requests/storage/head_object.rb
View file

@ -3,30 +3,30 @@ module Fog
class AWS
class Real
#
# Get headers for an object from S3
#
# ==== Parameters
# * bucket_name<~String> - Name of bucket to read from
# * object_name<~String> - Name of object to read
# * options<~Hash>:
# * 'If-Match'<~String> - Returns object only if its etag matches this value, otherwise returns 412 (Precondition Failed).
# * 'If-Modified-Since'<~Time> - Returns object only if it has been modified since this time, otherwise returns 304 (Not Modified).
# * 'If-None-Match'<~String> - Returns object only if its etag differs from this value, otherwise returns 304 (Not Modified)
# * 'If-Unmodified-Since'<~Time> - Returns object only if it has not been modified since this time, otherwise returns 412 (Precodition Failed).
# * 'Range'<~String> - Range of object to download
# * 'versionId'<~String> - specify a particular version to retrieve
# @param bucket_name [String] Name of bucket to read from
# @param object_name [String] Name of object to read
# @param options [Hash]:
# @option options [String] If-Match Returns object only if its etag matches this value, otherwise returns 412 (Precondition Failed).
# @option options [Time] If-Modified-Since Returns object only if it has been modified since this time, otherwise returns 304 (Not Modified).
# @option options [String] If-None-Match Returns object only if its etag differs from this value, otherwise returns 304 (Not Modified)
# @option options [Time] If-Unmodified-Since Returns object only if it has not been modified since this time, otherwise returns 412 (Precodition Failed).
# @option options [String] Range Range of object to download
# @option options [String] versionId specify a particular version to retrieve
#
# @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
# * ETag [String] - Etag of object
# * Last-Modified - [String] Last modified timestamp for object
#
# @see http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTObjectHEAD.html
#
# ==== Returns
# * response<~Excon::Response>:
# * body<~String> - Contents of object
# * headers<~Hash>:
# * '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
#
# ==== See Also
# http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTObjectHEAD.html
def head_object(bucket_name, object_name, options={})
unless bucket_name