Class: Aws::S3::ObjectSummary
- Inherits:
-
Object
- Object
- Aws::S3::ObjectSummary
- Defined in:
- gems/aws-sdk-s3/lib/aws-sdk-s3/object_summary.rb,
gems/aws-sdk-s3/lib/aws-sdk-s3/customizations/object_summary.rb
Defined Under Namespace
Classes: Collection
Read-Only Attributes collapse
-
#bucket_name ⇒ String
-
#checksum_algorithm ⇒ Array<String>
The algorithm that was used to create a checksum of the object.
-
#etag ⇒ String
The entity tag is a hash of the object.
-
#key ⇒ String
-
#last_modified ⇒ Time
Creation date of the object.
-
#owner ⇒ Types::Owner
The owner of the object.
-
#restore_status ⇒ Types::RestoreStatus
Specifies the restoration status of an object.
-
#size ⇒ Integer
(also: #content_length)
Size in bytes of the object.
-
#storage_class ⇒ String
The class of storage used to store the object.
Actions collapse
-
#copy_from(source, options = {}) ⇒ Object
-
#delete(options = {}) ⇒ Types::DeleteObjectOutput
-
#get(options = {}, &block) ⇒ Types::GetObjectOutput
-
#initiate_multipart_upload(options = {}) ⇒ MultipartUpload
-
#put(options = {}) ⇒ Types::PutObjectOutput
-
#restore_object(options = {}) ⇒ Types::RestoreObjectOutput
Associations collapse
-
#acl ⇒ ObjectAcl
-
#bucket ⇒ Bucket
-
#multipart_upload(id) ⇒ MultipartUpload
-
#object ⇒ Object
-
#version(id) ⇒ ObjectVersion
Instance Method Summary collapse
-
#client ⇒ Client
-
#copy_to(target, options = {}) ⇒ Object
-
#data ⇒ Types::Object
Returns the data for this ObjectSummary.
-
#data_loaded? ⇒ Boolean
Returns
true
if this resource is loaded. -
#download_file(destination, options = {}) ⇒ Boolean
Returns
true
when the file is downloaded without any errors. -
#exists?(options = {}) ⇒ Boolean
Returns
true
if the ObjectSummary exists. -
#initialize(*args) ⇒ ObjectSummary
constructor
A new instance of ObjectSummary.
-
#move_to(target, options = {}) ⇒ void
-
#presigned_post(options = {}) ⇒ PresignedPost
-
#presigned_url(http_method, params = {}) ⇒ String
-
#public_url(options = {}) ⇒ String
-
#upload_file(source, options = {}) ⇒ Boolean
Returns
true
when the object is uploaded without any errors. -
#upload_stream(options = {}, &block) ⇒ Boolean
Returns
true
when the object is uploaded without any errors. -
#wait_until(options = {}) {|resource| ... } ⇒ Resource
deprecated
Deprecated.
Use [Aws::S3::Client] #wait_until instead
-
#wait_until_exists(options = {}, &block) ⇒ ObjectSummary
-
#wait_until_not_exists(options = {}, &block) ⇒ ObjectSummary
Constructor Details
#initialize(bucket_name, key, options = {}) ⇒ ObjectSummary #initialize(options = {}) ⇒ ObjectSummary
Returns a new instance of ObjectSummary.
24 25 26 27 28 29 30 31 |
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/object_summary.rb', line 24 def initialize(*args) = Hash === args.last ? args.pop.dup : {} @bucket_name = extract_bucket_name(args, ) @key = extract_key(args, ) @data = .delete(:data) @client = .delete(:client) || Client.new() @waiter_block_warned = false end |
Instance Method Details
#acl ⇒ ObjectAcl
2656 2657 2658 2659 2660 2661 2662 |
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/object_summary.rb', line 2656 def acl ObjectAcl.new( bucket_name: @bucket_name, object_key: @key, client: @client ) end |
#bucket ⇒ Bucket
2665 2666 2667 2668 2669 2670 |
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/object_summary.rb', line 2665 def bucket Bucket.new( name: @bucket_name, client: @client ) end |
#bucket_name ⇒ String
36 37 38 |
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/object_summary.rb', line 36 def bucket_name @bucket_name end |
#checksum_algorithm ⇒ Array<String>
The algorithm that was used to create a checksum of the object.
83 84 85 |
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/object_summary.rb', line 83 def checksum_algorithm data[:checksum_algorithm] end |
#client ⇒ Client
138 139 140 |
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/object_summary.rb', line 138 def client @client end |
#copy_from(source, options = {}) ⇒ Object
1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 |
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/object_summary.rb', line 1039 def copy_from( = {}) = .merge( bucket: @bucket_name, key: @key ) resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do @client.copy_object() end resp.data end |
#copy_to(target, options = {}) ⇒ Object
24 25 26 |
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/customizations/object_summary.rb', line 24 def copy_to(target, = {}) object.copy_to(target, ) end |
#data ⇒ Types::Object
Returns the data for this Aws::S3::ObjectSummary.
153 154 155 156 |
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/object_summary.rb', line 153 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.
161 162 163 |
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/object_summary.rb', line 161 def data_loaded? !!@data end |
#delete(options = {}) ⇒ Types::DeleteObjectOutput
1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 |
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/object_summary.rb', line 1105 def delete( = {}) = .merge( bucket: @bucket_name, key: @key ) resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do @client.delete_object() end resp.data end |
#download_file(destination, options = {}) ⇒ Boolean
Returns true
when the file is downloaded without
any errors.
79 80 81 |
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/customizations/object_summary.rb', line 79 def download_file(destination, = {}) object.download_file(destination, ) end |
#etag ⇒ String
The entity tag is a hash of the object. The ETag reflects changes only to the contents of an object, not its metadata. The ETag may or may not be an MD5 digest of the object data. Whether or not it is depends on how the object was created and how it is encrypted as described below:
Objects created by the PUT Object, POST Object, or Copy operation, or through the Amazon Web Services Management Console, and are encrypted by SSE-S3 or plaintext, have ETags that are an MD5 digest of their object data.
Objects created by the PUT Object, POST Object, or Copy operation, or through the Amazon Web Services Management Console, and are encrypted by SSE-C or SSE-KMS, have ETags that are not an MD5 digest of their object data.
If an object is created by either the Multipart Upload or Part Copy operation, the ETag is not an MD5 digest, regardless of the method of encryption. If an object is larger than 16 MB, the Amazon Web Services Management Console will upload or copy that object as a Multipart Upload, and therefore the ETag will not be an MD5 digest.
77 78 79 |
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/object_summary.rb', line 77 def etag data[:etag] end |
#exists?(options = {}) ⇒ Boolean
Returns true
if the ObjectSummary exists.
168 169 170 171 172 173 174 175 176 177 |
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/object_summary.rb', line 168 def exists?( = {}) begin wait_until_exists(.merge(max_attempts: 1)) true rescue Aws::Waiters::Errors::UnexpectedError => e raise e.error rescue Aws::Waiters::Errors::WaiterFailed false end end |
#get(options = {}, &block) ⇒ Types::GetObjectOutput
1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 |
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/object_summary.rb', line 1370 def get( = {}, &block) = .merge( bucket: @bucket_name, key: @key ) resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do @client.get_object(, &block) end resp.data end |
#initiate_multipart_upload(options = {}) ⇒ MultipartUpload
1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 |
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/object_summary.rb', line 1934 def initiate_multipart_upload( = {}) = .merge( bucket: @bucket_name, key: @key ) resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do @client.create_multipart_upload() end MultipartUpload.new( bucket_name: @bucket_name, object_key: @key, id: resp.data.upload_id, client: @client ) end |
#key ⇒ String
41 42 43 |
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/object_summary.rb', line 41 def key @key end |
#last_modified ⇒ Time
Creation date of the object.
47 48 49 |
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/object_summary.rb', line 47 def last_modified data[:last_modified] end |
#move_to(target, options = {}) ⇒ void
This method returns an undefined value.
32 33 34 |
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/customizations/object_summary.rb', line 32 def move_to(target, = {}) object.move_to(target, ) end |
#multipart_upload(id) ⇒ MultipartUpload
2674 2675 2676 2677 2678 2679 2680 2681 |
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/object_summary.rb', line 2674 def multipart_upload(id) MultipartUpload.new( bucket_name: @bucket_name, object_key: @key, id: id, client: @client ) end |
#object ⇒ Object
2684 2685 2686 2687 2688 2689 2690 |
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/object_summary.rb', line 2684 def object Object.new( bucket_name: @bucket_name, key: @key, client: @client ) end |
#owner ⇒ Types::Owner
The owner of the object
111 112 113 |
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/object_summary.rb', line 111 def owner data[:owner] end |
#presigned_post(options = {}) ⇒ PresignedPost
40 41 42 |
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/customizations/object_summary.rb', line 40 def presigned_post( = {}) object.presigned_post() end |
#presigned_url(http_method, params = {}) ⇒ String
48 49 50 |
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/customizations/object_summary.rb', line 48 def presigned_url(http_method, params = {}) object.presigned_url(http_method, params) end |
#public_url(options = {}) ⇒ String
56 57 58 |
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/customizations/object_summary.rb', line 56 def public_url( = {}) object.public_url() end |
#put(options = {}) ⇒ Types::PutObjectOutput
2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 |
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/object_summary.rb', line 2501 def put( = {}) = .merge( bucket: @bucket_name, key: @key ) resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do @client.put_object() end resp.data end |
#restore_object(options = {}) ⇒ Types::RestoreObjectOutput
2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 |
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/object_summary.rb', line 2642 def restore_object( = {}) = .merge( bucket: @bucket_name, key: @key ) resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do @client.restore_object() end resp.data end |
#restore_status ⇒ Types::RestoreStatus
Specifies the restoration status of an object. Objects in certain storage classes must be restored before they can be retrieved. For more information about these storage classes and how to work with archived objects, see Working with archived objects in the Amazon S3 User Guide.
131 132 133 |
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/object_summary.rb', line 131 def restore_status data[:restore_status] end |
#size ⇒ Integer Also known as: content_length
Size in bytes of the object
89 90 91 |
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/object_summary.rb', line 89 def size data[:size] end |
#storage_class ⇒ String
The class of storage used to store the object.
100 101 102 |
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/object_summary.rb', line 100 def storage_class data[:storage_class] end |
#upload_file(source, options = {}) ⇒ Boolean
Returns true
when the object is uploaded
without any errors.
64 65 66 |
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/customizations/object_summary.rb', line 64 def upload_file(source, = {}) object.upload_file(source, ) end |
#upload_stream(options = {}, &block) ⇒ Boolean
Returns true
when the object is uploaded
without any errors.
71 72 73 |
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/customizations/object_summary.rb', line 71 def upload_stream( = {}, &block) object.upload_stream(, &block) end |
#version(id) ⇒ ObjectVersion
2694 2695 2696 2697 2698 2699 2700 2701 |
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/object_summary.rb', line 2694 def version(id) ObjectVersion.new( bucket_name: @bucket_name, object_key: @key, id: id, client: @client ) 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
301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 |
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/object_summary.rb', line 301 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::Plugins::UserAgent.metric('RESOURCE_MODEL') do Aws::Waiters::Waiter.new().wait({}) end end |
#wait_until_exists(options = {}, &block) ⇒ ObjectSummary
185 186 187 188 189 190 191 192 193 194 195 196 197 198 |
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/object_summary.rb', line 185 def wait_until_exists( = {}, &block) , params = () waiter = Waiters::ObjectExists.new() yield_waiter_and_warn(waiter, &block) if block_given? Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do waiter.wait(params.merge(bucket: @bucket_name, key: @key)) end ObjectSummary.new({ bucket_name: @bucket_name, key: @key, client: @client }) end |
#wait_until_not_exists(options = {}, &block) ⇒ ObjectSummary
206 207 208 209 210 211 212 213 214 215 216 217 218 219 |
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/object_summary.rb', line 206 def wait_until_not_exists( = {}, &block) , params = () waiter = Waiters::ObjectNotExists.new() yield_waiter_and_warn(waiter, &block) if block_given? Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do waiter.wait(params.merge(bucket: @bucket_name, key: @key)) end ObjectSummary.new({ bucket_name: @bucket_name, key: @key, client: @client }) end |