class Aws::S3::MultipartUpload
Public Class Methods
@overload def initialize(bucket_name
, object_key
, id, options = {})
@param [String] bucket_name @param [String] object_key @param [String] id @option options [Client] :client
@overload def initialize(options = {})
@option options [required, String] :bucket_name @option options [required, String] :object_key @option options [required, String] :id @option options [Client] :client
# File lib/aws-sdk-s3/multipart_upload.rb, line 26 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) @waiter_block_warned = false end
Public Instance Methods
@example Request syntax with placeholder values
multipart_upload.abort({ request_payer: "requester", # accepts requester expected_bucket_owner: "AccountId", })
@param [Hash] options ({}) @option options [String] :request_payer
Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests. For information about downloading objects from requester pays buckets, see [Downloading Objects in Requestor Pays Buckets][1] in the *Amazon S3 User Guide*. [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html
@option options [String] :expected_bucket_owner
The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP `403 (Access Denied)` error.
@return [Types::AbortMultipartUploadOutput]
# File lib/aws-sdk-s3/multipart_upload.rb, line 241 def abort(options = {}) options = options.merge( bucket: @bucket_name, key: @object_key, upload_id: @id ) resp = @client.abort_multipart_upload(options) resp.data end
@return [String]
# File lib/aws-sdk-s3/multipart_upload.rb, line 39 def bucket_name @bucket_name end
@return [Client]
# File lib/aws-sdk-s3/multipart_upload.rb, line 93 def client @client end
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)
@option options [Boolean] :compute_parts (false) When `true`,
the {Client#list_parts} method will be called to determine the list of required part numbers and their ETags.
# File lib/aws-sdk-s3/customizations/multipart_upload.rb, line 27 def complete(options = {}) if options.delete(:compute_parts) options[:multipart_upload] = { parts: compute_parts } end basic_complete(options) end
@raise [NotImplementedError] Raises when {#data_loaded?} is `false`. @return [Types::MultipartUpload]
Returns the data for this {MultipartUpload}.
# File lib/aws-sdk-s3/multipart_upload.rb, line 108 def data load unless @data @data end
@return [Boolean]
Returns `true` if this resource is loaded. Accessing attributes or {#data} on an unloaded resource will trigger a call to {#load}.
# File lib/aws-sdk-s3/multipart_upload.rb, line 116 def data_loaded? !!@data end
@return [String]
# File lib/aws-sdk-s3/multipart_upload.rb, line 49 def id @id end
@deprecated @api private
# File lib/aws-sdk-s3/multipart_upload.rb, line 370 def identifiers { bucket_name: @bucket_name, object_key: @object_key, id: @id } end
Date and time at which the multipart upload was initiated. @return [Time]
# File lib/aws-sdk-s3/multipart_upload.rb, line 67 def initiated data[:initiated] end
Identifies who initiated the multipart upload. @return [Types::Initiator]
# File lib/aws-sdk-s3/multipart_upload.rb, line 86 def initiator data[:initiator] end
Key of the object for which the multipart upload was initiated. @return [String]
# File lib/aws-sdk-s3/multipart_upload.rb, line 61 def key data[:key] end
@raise [NotImplementedError] @api private
# File lib/aws-sdk-s3/multipart_upload.rb, line 99 def load msg = "#load is not implemented, data only available via enumeration" raise NotImplementedError, msg end
@return [Object]
# File lib/aws-sdk-s3/multipart_upload.rb, line 300 def object Object.new( bucket_name: @bucket_name, key: @object_key, client: @client ) end
@return [String]
# File lib/aws-sdk-s3/multipart_upload.rb, line 44 def object_key @object_key end
Specifies the owner of the object that is part of the multipart upload. @return [Types::Owner]
# File lib/aws-sdk-s3/multipart_upload.rb, line 80 def owner data[:owner] end
@param [String] part_number @return [MultipartUploadPart]
# File lib/aws-sdk-s3/multipart_upload.rb, line 310 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
@example Request syntax with placeholder values
parts = multipart_upload.parts({ request_payer: "requester", # accepts requester expected_bucket_owner: "AccountId", })
@param [Hash] options ({}) @option options [String] :request_payer
Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests. For information about downloading objects from requester pays buckets, see [Downloading Objects in Requestor Pays Buckets][1] in the *Amazon S3 User Guide*. [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html
@option options [String] :expected_bucket_owner
The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP `403 (Access Denied)` error.
@return [MultipartUploadPart::Collection]
# File lib/aws-sdk-s3/multipart_upload.rb, line 342 def parts(options = {}) batches = Enumerator.new do |y| options = options.merge( bucket: @bucket_name, key: @object_key, upload_id: @id ) resp = @client.list_parts(options) resp.each_page do |page| batch = [] page.data.parts.each do |p| batch << MultipartUploadPart.new( bucket_name: options[:bucket], object_key: options[:key], multipart_upload_id: options[:upload_id], part_number: p.part_number, data: p, client: @client ) end y.yield(batch) end end MultipartUploadPart::Collection.new(batches) end
The class of storage used to store the object. @return [String]
# File lib/aws-sdk-s3/multipart_upload.rb, line 73 def storage_class data[:storage_class] end
Upload ID that identifies the multipart upload. @return [String]
# File lib/aws-sdk-s3/multipart_upload.rb, line 55 def upload_id data[:upload_id] end
@deprecated Use [Aws::S3::Client] wait_until
instead
Waiter polls an API operation until a resource enters a desired state.
@note The waiting operation is performed on a copy. The original resource
remains unchanged.
## 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(options) {|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
@yieldparam [Resource] resource to be used in the waiting condition.
@raise [Aws::Waiters::Errors::FailureStateError] Raised when the waiter
terminates because the waiter has entered a state that it will not transition out of, preventing success. yet successful.
@raise [Aws::Waiters::Errors::UnexpectedError] Raised when an error is
encountered while polling for a resource that is not expected.
@raise [NotImplementedError] Raised when the resource does not
@option options [Integer] :max_attempts (10) Maximum number of attempts @option options [Integer] :delay (10) Delay between each attempt in seconds @option options [Proc] :before_attempt (nil) Callback invoked before each attempt @option options [Proc] :before_wait (nil) Callback invoked before each wait @return [Resource] if the waiter was successful
# File lib/aws-sdk-s3/multipart_upload.rb, line 200 def wait_until(options = {}, &block) self_copy = self.dup attempts = 0 options[:max_attempts] = 10 unless options.key?(:max_attempts) options[:delay] ||= 10 options[:poller] = Proc.new do attempts += 1 if block.call(self_copy) [:success, self_copy] else self_copy.reload unless attempts == options[:max_attempts] :retry end end Aws::Waiters::Waiter.new(options).wait({}) end
Private Instance Methods
# File lib/aws-sdk-s3/customizations/multipart_upload.rb, line 36 def compute_parts parts.sort_by(&:part_number).each.with_object([]) do |part, part_list| part_list << { part_number: part.part_number, etag: part.etag } end end
# File lib/aws-sdk-s3/multipart_upload.rb, line 381 def extract_bucket_name(args, options) value = args[0] || options.delete(:bucket_name) case value when String then value when nil then raise ArgumentError, "missing required option :bucket_name" else msg = "expected :bucket_name to be a String, got #{value.class}" raise ArgumentError, msg end end
# File lib/aws-sdk-s3/multipart_upload.rb, line 403 def extract_id(args, options) value = args[2] || options.delete(:id) case value when String then value when nil then raise ArgumentError, "missing required option :id" else msg = "expected :id to be a String, got #{value.class}" raise ArgumentError, msg end end
# File lib/aws-sdk-s3/multipart_upload.rb, line 392 def extract_object_key(args, options) value = args[1] || options.delete(:object_key) case value when String then value when nil then raise ArgumentError, "missing required option :object_key" else msg = "expected :object_key to be a String, got #{value.class}" raise ArgumentError, msg end end