Class: Aws::S3::MultipartUpload

Inherits:
Object
  • Object
show all
Defined in:
gems/aws-sdk-s3/lib/aws-sdk-s3/multipart_upload.rb,
gems/aws-sdk-s3/lib/aws-sdk-s3/customizations/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)


26
27
28
29
30
31
32
33
34
# File 'gems/aws-sdk-s3/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

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

  • :request_payer (String)

    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 in the Amazon S3 Developer Guide.

Returns:



236
237
238
239
240
241
242
243
244
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/multipart_upload.rb', line 236

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

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)

    ({})

Returns:



7
8
9
10
11
12
13
14
15
16
17
18
19
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/customizations/multipart_upload.rb', line 7

def complete(options = {})
  options = options.merge(
    bucket: @bucket_name,
    key: @object_key,
    upload_id: @id
  )
  @client.complete_multipart_upload(options)
  Object.new(
    bucket_name: @bucket_name,
    key: @object_key,
    client: @client
  )
end

#bucket_nameString

Returns:

  • (String)


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

def bucket_name
  @bucket_name
end

#clientClient

Returns:



93
94
95
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/multipart_upload.rb', line 93

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)

Parameters:

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

    a customizable set of options

Options Hash (options):

  • :compute_parts (Boolean) — default: false

    When true, the Client#list_parts method will be called to determine the list of required part numbers and their ETags.



273
274
275
276
277
278
279
280
281
282
283
284
285
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/multipart_upload.rb', line 273

def complete(options = {})
  options = options.merge(
    bucket: @bucket_name,
    key: @object_key,
    upload_id: @id
  )
  @client.complete_multipart_upload(options)
  Object.new(
    bucket_name: @bucket_name,
    key: @object_key,
    client: @client
  )
end

#dataTypes::MultipartUpload

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

Returns:

Raises:



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

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.



116
117
118
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/multipart_upload.rb', line 116

def data_loaded?
  !!@data
end

#idString

Returns:

  • (String)


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

def id
  @id
end

#initiatedTime

Date and time at which the multipart upload was initiated.

Returns:

  • (Time)


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

def initiated
  data[:initiated]
end

#initiatorTypes::Initiator

Identifies who initiated the multipart upload.

Returns:



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

def initiator
  data[:initiator]
end

#keyString

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

Returns:

  • (String)


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

def key
  data[:key]
end

#objectObject

Returns:



290
291
292
293
294
295
296
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/multipart_upload.rb', line 290

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

#object_keyString

Returns:

  • (String)


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

def object_key
  @object_key
end

#ownerTypes::Owner

Specifies the owner of the object that is part of the multipart upload.

Returns:



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

def owner
  data[:owner]
end

#part(part_number) ⇒ MultipartUploadPart

Parameters:

  • part_number (String)

Returns:



300
301
302
303
304
305
306
307
308
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/multipart_upload.rb', line 300

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

  • :request_payer (String)

    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 in the Amazon S3 Developer Guide.

Returns:



327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/multipart_upload.rb', line 327

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)


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

def storage_class
  data[:storage_class]
end

#upload_idString

Upload ID that identifies the multipart upload.

Returns:

  • (String)


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

def upload_id
  data[:upload_id]
end

#wait_until(options = {}) {|resource| ... } ⇒ 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) 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

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

Yield Parameters:

  • resource (Resource)

    to be used in the waiting condition.

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



200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
# File 'gems/aws-sdk-s3/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