Class: Aws::S3::MultipartUpload
- Inherits:
-
Object
- Object
- Aws::S3::MultipartUpload
- Extended by:
- Deprecations
- Defined in:
- lib/aws-sdk-s3/multipart_upload.rb,
lib/aws-sdk-s3/customizations/multipart_upload.rb
Defined Under Namespace
Classes: Collection
Read-Only Attributes collapse
- #bucket_name ⇒ String
-
#checksum_algorithm ⇒ String
The algorithm that was used to create a checksum of the object.
- #id ⇒ String
-
#initiated ⇒ Time
Date and time at which the multipart upload was initiated.
-
#initiator ⇒ Types::Initiator
Identifies who initiated the multipart upload.
-
#key ⇒ String
Key of the object for which the multipart upload was initiated.
- #object_key ⇒ String
-
#owner ⇒ Types::Owner
Specifies the owner of the object that is part of the multipart upload.
-
#storage_class ⇒ String
The class of storage used to store the object.
-
#upload_id ⇒ String
Upload ID that identifies the multipart upload.
Actions collapse
- #abort(options = {}) ⇒ Types::AbortMultipartUploadOutput
-
#complete(options = {}) ⇒ Object
Completes the upload, requires a list of completed parts.
Associations collapse
- #identifiers ⇒ Object deprecated private Deprecated.
- #object ⇒ Object
- #part(part_number) ⇒ MultipartUploadPart
- #parts(options = {}) ⇒ MultipartUploadPart::Collection
Instance Method Summary collapse
- #basic_complete ⇒ Object
- #client ⇒ Client
-
#data ⇒ Types::MultipartUpload
Returns the data for this MultipartUpload.
-
#data_loaded? ⇒ Boolean
Returns ‘true` if this resource is loaded.
-
#initialize(*args) ⇒ MultipartUpload
constructor
A new instance of MultipartUpload.
- #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 = {}) ⇒ MultipartUpload #initialize(options = {}) ⇒ MultipartUpload
Returns a new instance of MultipartUpload.
26 27 28 29 30 31 32 33 34 |
# File 'lib/aws-sdk-s3/multipart_upload.rb', line 26 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
#abort(options = {}) ⇒ Types::AbortMultipartUploadOutput
277 278 279 280 281 282 283 284 285 286 287 |
# File 'lib/aws-sdk-s3/multipart_upload.rb', line 277 def abort( = {}) = .merge( bucket: @bucket_name, key: @object_key, upload_id: @id ) resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do @client.abort_multipart_upload() end resp.data end |
#basic_complete ⇒ Object
7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 |
# File 'lib/aws-sdk-s3/customizations/multipart_upload.rb', line 7 def complete( = {}) = .merge( bucket: @bucket_name, key: @object_key, upload_id: @id ) Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do @client.complete_multipart_upload() end Object.new( bucket_name: @bucket_name, key: @object_key, client: @client ) end |
#bucket_name ⇒ String
39 40 41 |
# File 'lib/aws-sdk-s3/multipart_upload.rb', line 39 def bucket_name @bucket_name end |
#checksum_algorithm ⇒ String
The algorithm that was used to create a checksum of the object.
102 103 104 |
# File 'lib/aws-sdk-s3/multipart_upload.rb', line 102 def checksum_algorithm data[:checksum_algorithm] end |
#client ⇒ Client
109 110 111 |
# File 'lib/aws-sdk-s3/multipart_upload.rb', line 109 def client @client end |
#complete(options = {}) ⇒ Object
Completes the upload, requires a list of completed parts. You can provide the list of parts with ‘:part_number` and `:etag` values.
upload.complete(multipart_upload: { parts: [
{ part_number: 1, etag:'etag1' },
{ part_number: 2, etag:'etag2' },
...
]})
Alternatively, you can pass **‘compute_parts: true`** and the part list will be computed by calling Client#list_parts.
upload.complete(compute_parts: true)
459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 |
# File 'lib/aws-sdk-s3/multipart_upload.rb', line 459 def complete( = {}) = .merge( bucket: @bucket_name, key: @object_key, upload_id: @id ) Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do @client.complete_multipart_upload() end Object.new( bucket_name: @bucket_name, key: @object_key, client: @client ) end |
#data ⇒ Types::MultipartUpload
Returns the data for this Aws::S3::MultipartUpload.
124 125 126 127 |
# File 'lib/aws-sdk-s3/multipart_upload.rb', line 124 def data load unless @data @data end |
#data_loaded? ⇒ Boolean
132 133 134 |
# File 'lib/aws-sdk-s3/multipart_upload.rb', line 132 def data_loaded? !!@data end |
#id ⇒ String
49 50 51 |
# File 'lib/aws-sdk-s3/multipart_upload.rb', line 49 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.
598 599 600 601 602 603 604 |
# File 'lib/aws-sdk-s3/multipart_upload.rb', line 598 def identifiers { bucket_name: @bucket_name, object_key: @object_key, id: @id } end |
#initiated ⇒ Time
Date and time at which the multipart upload was initiated.
67 68 69 |
# File 'lib/aws-sdk-s3/multipart_upload.rb', line 67 def initiated data[:initiated] end |
#initiator ⇒ Types::Initiator
Identifies who initiated the multipart upload.
96 97 98 |
# File 'lib/aws-sdk-s3/multipart_upload.rb', line 96 def initiator data[:initiator] end |
#key ⇒ String
Key of the object for which the multipart upload was initiated.
61 62 63 |
# File 'lib/aws-sdk-s3/multipart_upload.rb', line 61 def key data[:key] 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.
115 116 117 118 |
# File 'lib/aws-sdk-s3/multipart_upload.rb', line 115 def load msg = "#load is not implemented, data only available via enumeration" raise NotImplementedError, msg end |
#object ⇒ Object
478 479 480 481 482 483 484 |
# File 'lib/aws-sdk-s3/multipart_upload.rb', line 478 def object Object.new( bucket_name: @bucket_name, key: @object_key, client: @client ) end |
#object_key ⇒ String
44 45 46 |
# File 'lib/aws-sdk-s3/multipart_upload.rb', line 44 def object_key @object_key end |
#owner ⇒ Types::Owner
Specifies the owner of the object that is part of the multipart upload.
<note markdown=“1”> **Directory buckets** - The bucket owner is returned as the object owner for all the objects.
</note>
90 91 92 |
# File 'lib/aws-sdk-s3/multipart_upload.rb', line 90 def owner data[:owner] end |
#part(part_number) ⇒ MultipartUploadPart
488 489 490 491 492 493 494 495 496 |
# File 'lib/aws-sdk-s3/multipart_upload.rb', line 488 def part(part_number) MultipartUploadPart.new( bucket_name: @bucket_name, object_key: @object_key, multipart_upload_id: @id, part_number: part_number, client: @client ) end |
#parts(options = {}) ⇒ MultipartUploadPart::Collection
568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 |
# File 'lib/aws-sdk-s3/multipart_upload.rb', line 568 def parts( = {}) batches = Enumerator.new do |y| = .merge( bucket: @bucket_name, key: @object_key, upload_id: @id ) resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do @client.list_parts() end resp.each_page do |page| batch = [] page.data.parts.each do |p| batch << MultipartUploadPart.new( bucket_name: [:bucket], object_key: [:key], multipart_upload_id: [:upload_id], part_number: p.part_number, data: p, client: @client ) end y.yield(batch) end end MultipartUploadPart::Collection.new(batches) end |
#storage_class ⇒ String
The class of storage used to store the object.
<note markdown=“1”> **Directory buckets** - Only the S3 Express One Zone storage class is supported by directory buckets to store objects.
</note>
78 79 80 |
# File 'lib/aws-sdk-s3/multipart_upload.rb', line 78 def storage_class data[:storage_class] end |
#upload_id ⇒ String
Upload ID that identifies the multipart upload.
55 56 57 |
# File 'lib/aws-sdk-s3/multipart_upload.rb', line 55 def upload_id data[:upload_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
216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 |
# File 'lib/aws-sdk-s3/multipart_upload.rb', line 216 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 |