class AWS::S3::MultipartUpload

@return [String] Returns the upload id.

@return [S3Object] Returns the object this upload is intended for.

@return [String] Returns the upload id.

@private

# File lib/aws/s3/multipart_upload.rb, line 27
def initialize(object, id, options = {})
  @id = id
  @object = object

  super

  @completed_parts = {}
  @increment_mutex = Mutex.new
  @completed_mutex = Mutex.new
  @last_part = 0
end

@return [Boolean] Returns true if both multipart uploads

represent the same object and upload.

# File lib/aws/s3/multipart_upload.rb, line 56
def ==(other)
  other.kind_of?(MultipartUpload) and
    other.object == object and
    other.id == id
end

Aborts the upload. After a multipart upload is aborted, no additional parts can be uploaded using that upload ID. The storage consumed by any previously uploaded parts will be freed. However, if any part uploads are currently in progress, those part uploads might or might not succeed. As a result, it might be necessary to abort a given multipart upload multiple times in order to completely free all storage consumed by all parts. @return [nil]

# File lib/aws/s3/multipart_upload.rb, line 112
def abort
  client.abort_multipart_upload(base_opts)
  @aborted = true
  nil
end

@return [Boolean] True if the upload has been aborted. @see abort

# File lib/aws/s3/multipart_upload.rb, line 122
def aborted?
  @aborted
end

Uploads a part.

@overload #add_part(data, options = {})

@param data The data to upload.  Valid values include:

  * A string

  * A Pathname object

  * Any object responding to +read+ and +eof?+; the object
    must support the following access methods:

     read                     # all at once
     read(length) until eof?  # in chunks

    If you specify data this way, you must also include
    the +:content_length+ option.

@param [Hash] options Additional options for the upload.

@option options [Integer] :content_length If provided,
  this option must match the total number of bytes written
  to S3 during the operation.  This option is required if
  +:data+ is an IO-like object without a +size+ method.

@overload #add_part(options)

@param [Hash] options Options for the upload.  Either
  +:data+ or +:file+ is required.

@option options :data The data to upload.  Valid values
  include:

  * A string

  * A Pathname object

  * Any object responding to +read+ and +eof?+; the object
    must support the following access methods:

     read                     # all at once
     read(length) until eof?  # in chunks

    If you specify data this way, you must also include
    the +:content_length+ option.

@option options [String] :file Can be specified instead of
  +:data+; its value specifies the path of a file to
  upload.

@option options [Integer] :content_length If provided,
  this option must match the total number of bytes written
  to S3 during the operation.  This option is required if
  +:data+ is an IO-like object without a +size+ method.

@option options [Integer] :part_number The part number.

# File lib/aws/s3/multipart_upload.rb, line 183
def add_part(data_or_options, options = {})
  if data_or_options.kind_of?(Hash)
    part_options = base_opts.merge(data_or_options)
  else
    part_options = base_opts.merge(:data => data_or_options)
  end
  part_options.merge!(options)

  unless part_options[:part_number]
    @increment_mutex.synchronize do
      part_options[:part_number] = (@last_part += 1)
    end
  end
  part_number = part_options[:part_number]

  resp = client.upload_part(part_options)
  @completed_mutex.synchronize do
    @completed_parts[part_number] = {
      :part_number => part_number,
      :etag => resp.etag
    }
  end
  UploadedPart.new(self, part_number)
end

Completes the upload or aborts it if no parts have been uploaded yet. Does nothing if the upload has already been aborted.

@return [S3Object, ObjectVersion] If the bucket has versioning

enabled, returns the {ObjectVersion} representing the
version that was uploaded.  If versioning is disabled,
returns the object.  If no upload was attempted (e.g. if it
was aborted or if no parts were uploaded), returns +nil+.

# File lib/aws/s3/multipart_upload.rb, line 259
def close
  return if aborted?
  if completed_parts.empty?
    abort
  else
    complete
  end
end

Completes the upload by assembling previously uploaded parts.

@return [S3Object, ObjectVersion] If the bucket has versioning

enabled, returns the {ObjectVersion} representing the
version that was uploaded.  If versioning is disabled,
returns the object.

# File lib/aws/s3/multipart_upload.rb, line 215
def complete(*parts)
  parts = parts.flatten
  case parts.first
  when :remote_parts
    complete_opts = get_complete_opts
  when :local_parts, nil
    complete_opts = base_opts.merge(:parts => completed_parts)
  else
    part_numbers = parts.map do |part|
      case part
      when Integer
        part
      when UploadedPart
        raise ArgumentError.new("cannot complete an upload with parts "+
                                "from a different upload") unless
          part.upload == self

        part.part_number
      else
        raise ArgumentError.new("expected number or UploadedPart")
      end
    end
    complete_opts = get_complete_opts(part_numbers)
  end

  raise "no parts uploaded" if complete_opts[:parts].empty?

  resp = client.complete_multipart_upload(complete_opts)
  if resp.version_id
    ObjectVersion.new(object, resp.version_id)
  else
    object
  end
end

@private

# File lib/aws/s3/multipart_upload.rb, line 275
def completed_parts
  @completed_parts.values.
    sort { |a, b| a[:part_number] <=> b[:part_number] }
end

@return [Boolean] True if the upload exists.

# File lib/aws/s3/multipart_upload.rb, line 65
def exists?
  client.list_parts(base_opts)
rescue Errors::NoSuchUpload => e
  false
else
  true
end

@return The upload initiator. This object will have :id

and +:display_name+ methods; if the initiator is an IAM
user, the +:id+ method will return the ARN of the user, and
if the initiator is an AWS account, this method will return
the same data as {#owner}.

# File lib/aws/s3/multipart_upload.rb, line 78
def initiator
  client.list_parts(base_opts).initiator
end

@return The upload owner. This object will have :id

and +:display_name+ methods.

# File lib/aws/s3/multipart_upload.rb, line 84
def owner
  client.list_parts(base_opts).owner
end

@return [UploadedPartCollection] A collection representing

the parts that have been uploaded to S3 for this upload.

# File lib/aws/s3/multipart_upload.rb, line 270
def parts
  UploadedPartCollection.new(self)
end

@return [Boolean] True if the uploaded object will be stored

with reduced redundancy.

# File lib/aws/s3/multipart_upload.rb, line 99
def reduced_redundancy?
  storage_class == :reduced_redundancy
end

@return [Symbol] The class of storage used to store the

uploaded object.  Possible values:

* +:standard+
* +:reduced_redundancy?+

# File lib/aws/s3/multipart_upload.rb, line 93
def storage_class
  client.list_parts(base_opts).storage_class.downcase.to_sym
end