Class: Aws::S3::MultipartUploadPart
- Inherits:
-
Object
- Object
- Aws::S3::MultipartUploadPart
- Defined in:
- gems/aws-sdk-s3/lib/aws-sdk-s3/multipart_upload_part.rb
Defined Under Namespace
Classes: Collection
Read-Only Attributes collapse
-
#bucket_name ⇒ String
-
#checksum_crc32 ⇒ String
This header can be used as a data integrity check to verify that the data received is the same data that was originally sent.
-
#checksum_crc32c ⇒ String
The base64-encoded, 32-bit CRC-32C checksum of the object.
-
#checksum_sha1 ⇒ String
The base64-encoded, 160-bit SHA-1 digest of the object.
-
#checksum_sha256 ⇒ String
This header can be used as a data integrity check to verify that the data received is the same data that was originally sent.
-
#etag ⇒ String
Entity tag returned when the part was uploaded.
-
#last_modified ⇒ Time
Date and time at which the part was uploaded.
-
#multipart_upload_id ⇒ String
-
#object_key ⇒ String
-
#part_number ⇒ Integer
-
#size ⇒ Integer
Size in bytes of the uploaded part data.
Actions collapse
-
#copy_from(options = {}) ⇒ Types::UploadPartCopyOutput
-
#upload(options = {}) ⇒ Types::UploadPartOutput
Associations collapse
Instance Method Summary collapse
-
#client ⇒ Client
-
#data ⇒ Types::Part
Returns the data for this MultipartUploadPart.
-
#data_loaded? ⇒ Boolean
Returns
true
if this resource is loaded. -
#initialize(*args) ⇒ MultipartUploadPart
constructor
A new instance of MultipartUploadPart.
-
#wait_until(options = {}) {|resource| ... } ⇒ Resource
deprecated
Deprecated.
Use [Aws::S3::Client] #wait_until instead
Constructor Details
#initialize(bucket_name, object_key, multipart_upload_id, part_number, options = {}) ⇒ MultipartUploadPart #initialize(options = {}) ⇒ MultipartUploadPart
Returns a new instance of MultipartUploadPart.
28 29 30 31 32 33 34 35 36 37 |
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/multipart_upload_part.rb', line 28 def initialize(*args) = Hash === args.last ? args.pop.dup : {} @bucket_name = extract_bucket_name(args, ) @object_key = extract_object_key(args, ) @multipart_upload_id = extract_multipart_upload_id(args, ) @part_number = extract_part_number(args, ) @data = .delete(:data) @client = .delete(:client) || Client.new() @waiter_block_warned = false end |
Instance Method Details
#bucket_name ⇒ String
42 43 44 |
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/multipart_upload_part.rb', line 42 def bucket_name @bucket_name end |
#checksum_crc32 ⇒ String
This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the base64-encoded, 32-bit CRC-32 checksum of the object. For more information, see Checking object integrity in the Amazon S3 User Guide.
89 90 91 |
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/multipart_upload_part.rb', line 89 def checksum_crc32 data[:checksum_crc32] end |
#checksum_crc32c ⇒ String
The base64-encoded, 32-bit CRC-32C checksum of the object. This will only be present if it was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.
106 107 108 |
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/multipart_upload_part.rb', line 106 def checksum_crc32c data[:checksum_crc32c] end |
#checksum_sha1 ⇒ String
The base64-encoded, 160-bit SHA-1 digest of the object. This will only be present if it was uploaded with the object. When you use the API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.
123 124 125 |
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/multipart_upload_part.rb', line 123 def checksum_sha1 data[:checksum_sha1] end |
#checksum_sha256 ⇒ String
This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the base64-encoded, 256-bit SHA-256 digest of the object. For more information, see Checking object integrity in the Amazon S3 User Guide.
137 138 139 |
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/multipart_upload_part.rb', line 137 def checksum_sha256 data[:checksum_sha256] end |
#client ⇒ Client
144 145 146 |
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/multipart_upload_part.rb', line 144 def client @client end |
#copy_from(options = {}) ⇒ Types::UploadPartCopyOutput
496 497 498 499 500 501 502 503 504 505 506 507 |
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/multipart_upload_part.rb', line 496 def copy_from( = {}) = .merge( bucket: @bucket_name, key: @object_key, upload_id: @multipart_upload_id, part_number: @part_number ) resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do @client.upload_part_copy() end resp.data end |
#data ⇒ Types::Part
Returns the data for this Aws::S3::MultipartUploadPart.
159 160 161 162 |
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/multipart_upload_part.rb', line 159 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.
167 168 169 |
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/multipart_upload_part.rb', line 167 def data_loaded? !!@data end |
#etag ⇒ String
Entity tag returned when the part was uploaded.
69 70 71 |
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/multipart_upload_part.rb', line 69 def etag data[:etag] end |
#last_modified ⇒ Time
Date and time at which the part was uploaded.
63 64 65 |
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/multipart_upload_part.rb', line 63 def last_modified data[:last_modified] end |
#multipart_upload ⇒ MultipartUpload
662 663 664 665 666 667 668 669 |
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/multipart_upload_part.rb', line 662 def multipart_upload MultipartUpload.new( bucket_name: @bucket_name, object_key: @object_key, id: @multipart_upload_id, client: @client ) end |
#multipart_upload_id ⇒ String
52 53 54 |
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/multipart_upload_part.rb', line 52 def multipart_upload_id @multipart_upload_id end |
#object_key ⇒ String
47 48 49 |
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/multipart_upload_part.rb', line 47 def object_key @object_key end |
#part_number ⇒ Integer
57 58 59 |
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/multipart_upload_part.rb', line 57 def part_number @part_number end |
#size ⇒ Integer
Size in bytes of the uploaded part data.
75 76 77 |
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/multipart_upload_part.rb', line 75 def size data[:size] end |
#upload(options = {}) ⇒ Types::UploadPartOutput
646 647 648 649 650 651 652 653 654 655 656 657 |
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/multipart_upload_part.rb', line 646 def upload( = {}) = .merge( bucket: @bucket_name, key: @object_key, upload_id: @multipart_upload_id, part_number: @part_number ) resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do @client.upload_part() end resp.data 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
251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 |
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/multipart_upload_part.rb', line 251 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 |