You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::S3::ObjectVersion

Inherits:
Object
  • Object
show all
Defined in:
gems/aws-sdk-s3/lib/aws-sdk-s3/object_version.rb

Defined Under Namespace

Classes: Collection

Actions collapse

Associations collapse

Read-Only Attributes collapse

Instance Method Summary collapse

Constructor Details

#initialize(bucket_name, object_key, id, options = {}) ⇒ ObjectVersion #initialize(options = {}) ⇒ ObjectVersion

Returns a new instance of ObjectVersion

Overloads:

  • #initialize(bucket_name, object_key, id, options = {}) ⇒ ObjectVersion

    Parameters:

    • bucket_name (String)
    • object_key (String)
    • id (String)

    Options Hash (options):

  • #initialize(options = {}) ⇒ ObjectVersion

    Options Hash (options):

    • :bucket_name (required, String)
    • :object_key (required, String)
    • :id (required, String)
    • :client (Client)


23
24
25
26
27
28
29
30
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/object_version.rb', line 23

def initialize(*args)
  options = Hash === args.last ? args.pop.dup : {}
  @bucket_name = extract_bucket_name(args, options)
  @object_key = extract_object_key(args, options)
  @id = extract_id(args, options)
  @data = options.delete(:data)
  @client = options.delete(:client) || Client.new(options)
end

Instance Method Details

#bucket_nameString

Returns:

  • (String)


35
36
37
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/object_version.rb', line 35

def bucket_name
  @bucket_name
end

#clientClient

Returns:



99
100
101
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/object_version.rb', line 99

def client
  @client
end

#dataTypes::ObjectVersion

Returns the data for this Aws::S3::ObjectVersion.

Returns:

Raises:



114
115
116
117
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/object_version.rb', line 114

def data
  load unless @data
  @data
end

#data_loaded?Boolean

Returns true if this resource is loaded. Accessing attributes or #data on an unloaded resource will trigger a call to #load.

Returns:

  • (Boolean)

    Returns true if this resource is loaded. Accessing attributes or #data on an unloaded resource will trigger a call to #load.



122
123
124
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/object_version.rb', line 122

def data_loaded?
  !!@data
end

#delete(options = {}) ⇒ Types::DeleteObjectOutput

Examples:

Request syntax with placeholder values


object_version.delete({
  mfa: "MFA",
  request_payer: "requester", # accepts requester
})

Parameters:

  • options (Hash) (defaults to: {})

    ({})

Options Hash (options):

  • :mfa (String)

    The concatenation of the authentication device's serial number, a space, and the value that is displayed on your authentication device.

  • :request_payer (String)

    Confirms that the requester knows that she or he will be charged for the request. Bucket owners need not specify this parameter in their requests. Documentation on downloading objects from requester pays buckets can be found at http://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html

Returns:



145
146
147
148
149
150
151
152
153
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/object_version.rb', line 145

def delete(options = {})
  options = options.merge(
    bucket: @bucket_name,
    key: @object_key,
    version_id: @id
  )
  resp = @client.delete_object(options)
  resp.data
end

#etagString

Returns:

  • (String)


50
51
52
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/object_version.rb', line 50

def etag
  data.etag
end

#get(options = {}) ⇒ Types::GetObjectOutput

Examples:

Request syntax with placeholder values


object_version.get({
  if_match: "IfMatch",
  if_modified_since: Time.now,
  if_none_match: "IfNoneMatch",
  if_unmodified_since: Time.now,
  range: "Range",
  response_cache_control: "ResponseCacheControl",
  response_content_disposition: "ResponseContentDisposition",
  response_content_encoding: "ResponseContentEncoding",
  response_content_language: "ResponseContentLanguage",
  response_content_type: "ResponseContentType",
  response_expires: Time.now,
  sse_customer_algorithm: "SSECustomerAlgorithm",
  sse_customer_key: "SSECustomerKey",
  sse_customer_key_md5: "SSECustomerKeyMD5",
  request_payer: "requester", # accepts requester
  part_number: 1,
})

Parameters:

  • options (Hash) (defaults to: {})

    ({})

Options Hash (options):

  • :if_match (String)

    Return the object only if its entity tag (ETag) is the same as the one specified, otherwise return a 412 (precondition failed).

  • :if_modified_since (Time, DateTime, Date, Integer, String)

    Return the object only if it has been modified since the specified time, otherwise return a 304 (not modified).

  • :if_none_match (String)

    Return the object only if its entity tag (ETag) is different from the one specified, otherwise return a 304 (not modified).

  • :if_unmodified_since (Time, DateTime, Date, Integer, String)

    Return the object only if it has not been modified since the specified time, otherwise return a 412 (precondition failed).

  • :range (String)

    Downloads the specified range bytes of an object. For more information about the HTTP Range header, go to http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35.

  • :response_cache_control (String)

    Sets the Cache-Control header of the response.

  • :response_content_disposition (String)

    Sets the Content-Disposition header of the response

  • :response_content_encoding (String)

    Sets the Content-Encoding header of the response.

  • :response_content_language (String)

    Sets the Content-Language header of the response.

  • :response_content_type (String)

    Sets the Content-Type header of the response.

  • :response_expires (Time, DateTime, Date, Integer, String)

    Sets the Expires header of the response.

  • :sse_customer_algorithm (String)

    Specifies the algorithm to use to when encrypting the object (e.g., AES256).

  • :sse_customer_key (String)

    Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon does not store the encryption key. The key must be appropriate for use with the algorithm specified in the x-amz-server-side​-encryption​-customer-algorithm header.

  • :sse_customer_key_md5 (String)

    Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure the encryption key was transmitted without error.

  • :request_payer (String)

    Confirms that the requester knows that she or he will be charged for the request. Bucket owners need not specify this parameter in their requests. Documentation on downloading objects from requester pays buckets can be found at http://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html

  • :part_number (Integer)

    Part number of the object being read. This is a positive integer between 1 and 10,000. Effectively performs a 'ranged' GET request for the part specified. Useful for downloading just a part of an object.

Returns:



229
230
231
232
233
234
235
236
237
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/object_version.rb', line 229

def get(options = {})
  options = options.merge(
    bucket: @bucket_name,
    key: @object_key,
    version_id: @id
  )
  resp = @client.get_object(options)
  resp.data
end

#head(options = {}) ⇒ Types::HeadObjectOutput

Examples:

Request syntax with placeholder values


object_version.head({
  if_match: "IfMatch",
  if_modified_since: Time.now,
  if_none_match: "IfNoneMatch",
  if_unmodified_since: Time.now,
  range: "Range",
  sse_customer_algorithm: "SSECustomerAlgorithm",
  sse_customer_key: "SSECustomerKey",
  sse_customer_key_md5: "SSECustomerKeyMD5",
  request_payer: "requester", # accepts requester
  part_number: 1,
})

Parameters:

  • options (Hash) (defaults to: {})

    ({})

Options Hash (options):

  • :if_match (String)

    Return the object only if its entity tag (ETag) is the same as the one specified, otherwise return a 412 (precondition failed).

  • :if_modified_since (Time, DateTime, Date, Integer, String)

    Return the object only if it has been modified since the specified time, otherwise return a 304 (not modified).

  • :if_none_match (String)

    Return the object only if its entity tag (ETag) is different from the one specified, otherwise return a 304 (not modified).

  • :if_unmodified_since (Time, DateTime, Date, Integer, String)

    Return the object only if it has not been modified since the specified time, otherwise return a 412 (precondition failed).

  • :range (String)

    Downloads the specified range bytes of an object. For more information about the HTTP Range header, go to http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35.

  • :sse_customer_algorithm (String)

    Specifies the algorithm to use to when encrypting the object (e.g., AES256).

  • :sse_customer_key (String)

    Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon does not store the encryption key. The key must be appropriate for use with the algorithm specified in the x-amz-server-side​-encryption​-customer-algorithm header.

  • :sse_customer_key_md5 (String)

    Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure the encryption key was transmitted without error.

  • :request_payer (String)

    Confirms that the requester knows that she or he will be charged for the request. Bucket owners need not specify this parameter in their requests. Documentation on downloading objects from requester pays buckets can be found at http://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html

  • :part_number (Integer)

    Part number of the object being read. This is a positive integer between 1 and 10,000. Effectively performs a 'ranged' HEAD request for the part specified. Useful querying about the size of the part and the number of parts in this object.

Returns:



295
296
297
298
299
300
301
302
303
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/object_version.rb', line 295

def head(options = {})
  options = options.merge(
    bucket: @bucket_name,
    key: @object_key,
    version_id: @id
  )
  resp = @client.head_object(options)
  resp.data
end

#idString

Returns:

  • (String)


45
46
47
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/object_version.rb', line 45

def id
  @id
end

#is_latestBoolean

Specifies whether the object is (true) or is not (false) the latest version of an object.

Returns:

  • (Boolean)


81
82
83
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/object_version.rb', line 81

def is_latest
  data.is_latest
end

#keyString

The object key.

Returns:

  • (String)


68
69
70
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/object_version.rb', line 68

def key
  data.key
end

#last_modifiedTime

Date and time the object was last modified.

Returns:

  • (Time)


87
88
89
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/object_version.rb', line 87

def last_modified
  data.last_modified
end

#objectObject

Returns:



308
309
310
311
312
313
314
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/object_version.rb', line 308

def object
  Object.new(
    bucket_name: @bucket_name,
    key: @object_key,
    client: @client
  )
end

#object_keyString

Returns:

  • (String)


40
41
42
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/object_version.rb', line 40

def object_key
  @object_key
end

#ownerTypes::Owner

Returns:



92
93
94
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/object_version.rb', line 92

def owner
  data.owner
end

#sizeInteger

Size in bytes of the object.

Returns:

  • (Integer)


56
57
58
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/object_version.rb', line 56

def size
  data.size
end

#storage_classString

The class of storage used to store the object.

Returns:

  • (String)


62
63
64
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/object_version.rb', line 62

def storage_class
  data.storage_class
end

#version_idString

Version ID of an object.

Returns:

  • (String)


74
75
76
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/object_version.rb', line 74

def version_id
  data.version_id
end