You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::S3::MultipartUpload

Inherits:
Object
  • Object
show all
Defined in:
gems/aws-sdk-s3/lib/aws-sdk-s3/customizations/multipart_upload.rb,
gems/aws-sdk-s3/lib/aws-sdk-s3/multipart_upload.rb

Defined Under Namespace

Classes: Collection

Actions collapse

Associations collapse

Read-Only Attributes collapse

Instance Method Summary collapse

Constructor Details

#initialize(bucket_name, object_key, id, options = {}) ⇒ MultipartUpload #initialize(options = {}) ⇒ MultipartUpload

Returns a new instance of MultipartUpload

Overloads:

  • #initialize(bucket_name, object_key, id, options = {}) ⇒ MultipartUpload

    Parameters:

    • bucket_name (String)
    • object_key (String)
    • id (String)

    Options Hash (options):

  • #initialize(options = {}) ⇒ MultipartUpload

    Options Hash (options):

    • :bucket_name (required, String)
    • :object_key (required, String)
    • :id (required, String)
    • :client (Client)


23
24
25
26
27
28
29
30
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/multipart_upload.rb', line 23

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)
end

Instance Method Details

#abort(options = {}) ⇒ Types::AbortMultipartUploadOutput

Examples:

Request syntax with placeholder values


multipart_upload.abort({
  request_payer: "requester", # accepts requester
})

Parameters:

  • options (Hash) (defaults to: {})

    ({})

Options Hash (options):

Returns:



224
225
226
227
228
229
230
231
232
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/multipart_upload.rb', line 224

def abort(options = {})
  options = options.merge(
    bucket: @bucket_name,
    key: @object_key,
    upload_id: @id
  )
  resp = @client.abort_multipart_upload(options)
  resp.data
end

#basic_completeObject



5
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/customizations/multipart_upload.rb', line 5

alias_method :basic_complete, :complete

#bucket_nameString

Returns:

  • (String)


35
36
37
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/multipart_upload.rb', line 35

def bucket_name
  @bucket_name
end

#clientClient

Returns:



87
88
89
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/multipart_upload.rb', line 87

def client
  @client
end

#complete(options = {}) ⇒ Object

Examples:

Request syntax with placeholder values


object = multipart_upload.complete({
  multipart_upload: {
    parts: [
      {
        etag: "ETag",
        part_number: 1,
      },
    ],
  },
  request_payer: "requester", # accepts requester
})

Parameters:

  • options (Hash) (defaults to: {})

    ({})

Options Hash (options):

Returns:



25
26
27
28
29
30
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/customizations/multipart_upload.rb', line 25

def complete(options = {})
  if options.delete(:compute_parts)
    options[:multipart_upload] = { parts: compute_parts }
  end
  basic_complete(options)
end

#dataTypes::MultipartUpload

Returns the data for this Aws::S3::MultipartUpload.

Returns:

Raises:



102
103
104
105
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/multipart_upload.rb', line 102

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.

Returns:

  • (Boolean)

    Returns true if this resource is loaded. Accessing attributes or #data on an unloaded resource will trigger a call to #load.



110
111
112
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/multipart_upload.rb', line 110

def data_loaded?
  !!@data
end

#idString

Returns:

  • (String)


45
46
47
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/multipart_upload.rb', line 45

def id
  @id
end

#initiatedTime

Date and time at which the multipart upload was initiated.

Returns:

  • (Time)


63
64
65
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/multipart_upload.rb', line 63

def initiated
  data[:initiated]
end

#initiatorTypes::Initiator

Identifies who initiated the multipart upload.

Returns:



80
81
82
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/multipart_upload.rb', line 80

def initiator
  data[:initiator]
end

#keyString

Key of the object for which the multipart upload was initiated.

Returns:

  • (String)


57
58
59
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/multipart_upload.rb', line 57

def key
  data[:key]
end

#objectObject

Returns:



273
274
275
276
277
278
279
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/multipart_upload.rb', line 273

def object
  Object.new(
    bucket_name: @bucket_name,
    key: @object_key,
    client: @client
  )
end

#object_keyString

Returns:

  • (String)


40
41
42
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/multipart_upload.rb', line 40

def object_key
  @object_key
end

#ownerTypes::Owner

Returns:



74
75
76
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/multipart_upload.rb', line 74

def owner
  data[:owner]
end

#part(part_number) ⇒ MultipartUploadPart

Parameters:

  • part_number (String)

Returns:



283
284
285
286
287
288
289
290
291
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/multipart_upload.rb', line 283

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

Examples:

Request syntax with placeholder values


parts = multipart_upload.parts({
  request_payer: "requester", # accepts requester
})

Parameters:

  • options (Hash) (defaults to: {})

    ({})

Options Hash (options):

Returns:



306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/multipart_upload.rb', line 306

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

#storage_classString

The class of storage used to store the object.

Returns:

  • (String)


69
70
71
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/multipart_upload.rb', line 69

def storage_class
  data[:storage_class]
end

#upload_idString

Upload ID that identifies the multipart upload.

Returns:

  • (String)


51
52
53
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/multipart_upload.rb', line 51

def upload_id
  data[:upload_id]
end

#wait_until(options = {}, &block) ⇒ Resource

Deprecated.

Use [Aws::S3::Client] #wait_until instead

Note:

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(options) {|resource| condition}

Example

instance.wait_until(max_attempts:10, delay:5) {|instance| instance.state.name == 'running' }

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

Parameters:

  • options (Hash) (defaults to: {})

    a customizable set of options

Options Hash (options):

  • :max_attempts (Integer) — default: 10

    Maximum number of

  • :delay (Integer) — default: 10

    Delay between each

  • :before_attempt (Proc) — default: nil

    Callback

  • :before_wait (Proc) — default: nil

    Callback

Returns:

  • (Resource)

    if the waiter was successful

Raises:

  • (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.

  • (Aws::Waiters::Errors::UnexpectedError)

    Raised when an error is encountered while polling for a resource that is not expected.

  • (NotImplementedError)

    Raised when the resource does not



192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/multipart_upload.rb', line 192

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