Class: Aws::S3::ObjectVersion
- Inherits:
-
Object
- Object
- Aws::S3::ObjectVersion
- Extended by:
- Deprecations
- Defined in:
- lib/aws-sdk-s3/object_version.rb
Defined Under Namespace
Classes: Collection
Read-Only Attributes collapse
- #bucket_name ⇒ String
-
#etag ⇒ String
The entity tag is an MD5 hash of that version of the object.
- #id ⇒ String
-
#is_latest ⇒ Boolean
Specifies whether the object is (true) or is not (false) the latest version of an object.
-
#key ⇒ String
The object key.
-
#last_modified ⇒ Time
Date and time the object was last modified.
- #object_key ⇒ String
-
#owner ⇒ Types::Owner
Specifies the owner of the object.
-
#size ⇒ Integer
Size in bytes of the object.
-
#storage_class ⇒ String
The class of storage used to store the object.
-
#version_id ⇒ String
Version ID of an object.
Actions collapse
- #delete(options = {}) ⇒ Types::DeleteObjectOutput
- #get(options = {}, &block) ⇒ Types::GetObjectOutput
- #head(options = {}) ⇒ Types::HeadObjectOutput
Associations collapse
- #identifiers ⇒ Object deprecated private Deprecated.
- #object ⇒ Object
Instance Method Summary collapse
- #client ⇒ Client
-
#data ⇒ Types::ObjectVersion
Returns the data for this ObjectVersion.
-
#data_loaded? ⇒ Boolean
Returns ‘true` if this resource is loaded.
-
#initialize(*args) ⇒ ObjectVersion
constructor
A new instance of ObjectVersion.
- #load ⇒ Object (also: #reload) private
-
#wait_until(options = {}) {|resource| ... } ⇒ Resource
deprecated
Deprecated.
Use [Aws::S3::Client] #wait_until instead
Constructor Details
#initialize(bucket_name, object_key, id, options = {}) ⇒ ObjectVersion #initialize(options = {}) ⇒ ObjectVersion
Returns a new instance of ObjectVersion.
24 25 26 27 28 29 30 31 32 |
# File 'lib/aws-sdk-s3/object_version.rb', line 24 def initialize(*args) = Hash === args.last ? args.pop.dup : {} @bucket_name = extract_bucket_name(args, ) @object_key = extract_object_key(args, ) @id = extract_id(args, ) @data = .delete(:data) @client = .delete(:client) || Client.new() @waiter_block_warned = false end |
Instance Method Details
#bucket_name ⇒ String
37 38 39 |
# File 'lib/aws-sdk-s3/object_version.rb', line 37 def bucket_name @bucket_name end |
#client ⇒ Client
103 104 105 |
# File 'lib/aws-sdk-s3/object_version.rb', line 103 def client @client end |
#data ⇒ Types::ObjectVersion
Returns the data for this Aws::S3::ObjectVersion.
118 119 120 121 |
# File 'lib/aws-sdk-s3/object_version.rb', line 118 def data load unless @data @data end |
#data_loaded? ⇒ Boolean
126 127 128 |
# File 'lib/aws-sdk-s3/object_version.rb', line 126 def data_loaded? !!@data end |
#delete(options = {}) ⇒ Types::DeleteObjectOutput
256 257 258 259 260 261 262 263 264 |
# File 'lib/aws-sdk-s3/object_version.rb', line 256 def delete( = {}) = .merge( bucket: @bucket_name, key: @object_key, version_id: @id ) resp = @client.delete_object() resp.data end |
#etag ⇒ String
The entity tag is an MD5 hash of that version of the object.
53 54 55 |
# File 'lib/aws-sdk-s3/object_version.rb', line 53 def etag data[:etag] end |
#get(options = {}, &block) ⇒ Types::GetObjectOutput
344 345 346 347 348 349 350 351 352 |
# File 'lib/aws-sdk-s3/object_version.rb', line 344 def get( = {}, &block) = .merge( bucket: @bucket_name, key: @object_key, version_id: @id ) resp = @client.get_object(, &block) resp.data end |
#head(options = {}) ⇒ Types::HeadObjectOutput
414 415 416 417 418 419 420 421 422 |
# File 'lib/aws-sdk-s3/object_version.rb', line 414 def head( = {}) = .merge( bucket: @bucket_name, key: @object_key, version_id: @id ) resp = @client.head_object() resp.data end |
#id ⇒ String
47 48 49 |
# File 'lib/aws-sdk-s3/object_version.rb', line 47 def id @id end |
#identifiers ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
437 438 439 440 441 442 443 |
# File 'lib/aws-sdk-s3/object_version.rb', line 437 def identifiers { bucket_name: @bucket_name, object_key: @object_key, id: @id } end |
#is_latest ⇒ Boolean
Specifies whether the object is (true) or is not (false) the latest version of an object.
84 85 86 |
# File 'lib/aws-sdk-s3/object_version.rb', line 84 def is_latest data[:is_latest] end |
#key ⇒ String
The object key.
71 72 73 |
# File 'lib/aws-sdk-s3/object_version.rb', line 71 def key data[:key] end |
#last_modified ⇒ Time
Date and time the object was last modified.
90 91 92 |
# File 'lib/aws-sdk-s3/object_version.rb', line 90 def last_modified data[:last_modified] end |
#load ⇒ Object Also known as: reload
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
109 110 111 112 |
# File 'lib/aws-sdk-s3/object_version.rb', line 109 def load msg = "#load is not implemented, data only available via enumeration" raise NotImplementedError, msg end |
#object ⇒ Object
427 428 429 430 431 432 433 |
# File 'lib/aws-sdk-s3/object_version.rb', line 427 def object Object.new( bucket_name: @bucket_name, key: @object_key, client: @client ) end |
#object_key ⇒ String
42 43 44 |
# File 'lib/aws-sdk-s3/object_version.rb', line 42 def object_key @object_key end |
#owner ⇒ Types::Owner
Specifies the owner of the object.
96 97 98 |
# File 'lib/aws-sdk-s3/object_version.rb', line 96 def owner data[:owner] end |
#size ⇒ Integer
Size in bytes of the object.
59 60 61 |
# File 'lib/aws-sdk-s3/object_version.rb', line 59 def size data[:size] end |
#storage_class ⇒ String
The class of storage used to store the object.
65 66 67 |
# File 'lib/aws-sdk-s3/object_version.rb', line 65 def storage_class data[:storage_class] end |
#version_id ⇒ String
Version ID of an object.
77 78 79 |
# File 'lib/aws-sdk-s3/object_version.rb', line 77 def version_id data[:version_id] end |
#wait_until(options = {}) {|resource| ... } ⇒ Resource
Use [Aws::S3::Client] #wait_until instead
The waiting operation is performed on a copy. The original resource remains unchanged.
Waiter polls an API operation until a resource enters a desired state.
## Basic Usage
Waiter will polls until it is successful, it fails by entering a terminal state, or until a maximum number of attempts are made.
# polls in a loop until condition is true
resource.wait_until() {|resource| condition}
## Example
instance.wait_until(max_attempts:10, delay:5) do |instance|
instance.state.name == 'running'
end
## Configuration
You can configure the maximum number of polling attempts, and the delay (in seconds) between each polling attempt. The waiting condition is set by passing a block to #wait_until:
# poll for ~25 seconds
resource.wait_until(max_attempts:5,delay:5) {|resource|...}
## Callbacks
You can be notified before each polling attempt and before each delay. If you throw ‘:success` or `:failure` from these callbacks, it will terminate the waiter.
started_at = Time.now
# poll for 1 hour, instead of a number of attempts
proc = Proc.new do |attempts, response|
throw :failure if Time.now - started_at > 3600
end
# disable max attempts
instance.wait_until(before_wait:proc, max_attempts:nil) {...}
## Handling Errors
When a waiter is successful, it returns the Resource. When a waiter fails, it raises an error.
begin
resource.wait_until(...)
rescue Aws::Waiters::Errors::WaiterFailed
# resource did not enter the desired state in time
end
attempts attempt in seconds invoked before each attempt invoked before each wait
210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 |
# File 'lib/aws-sdk-s3/object_version.rb', line 210 def wait_until( = {}, &block) self_copy = self.dup attempts = 0 [:max_attempts] = 10 unless .key?(:max_attempts) [:delay] ||= 10 [:poller] = Proc.new do attempts += 1 if block.call(self_copy) [:success, self_copy] else self_copy.reload unless attempts == [:max_attempts] :retry end end Aws::Waiters::Waiter.new().wait({}) end |