Class: Aws::S3::MultipartUpload

Inherits:
Object
  • Object
show all
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

Actions collapse

Associations 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 '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
  expected_bucket_owner: "AccountId",
})

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 Requester Pays Buckets] in the *Amazon S3 User Guide*.

    [1]: docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html

  • :expected_bucket_owner (String)

    The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code `403 Forbidden` (access denied).

Returns:


247
248
249
250
251
252
253
254
255
# File 'lib/aws-sdk-s3/multipart_upload.rb', line 247

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",
        checksum_crc32: "ChecksumCRC32",
        checksum_crc32c: "ChecksumCRC32C",
        checksum_sha1: "ChecksumSHA1",
        checksum_sha256: "ChecksumSHA256",
        part_number: 1,
      },
    ],
  },
  checksum_crc32: "ChecksumCRC32",
  checksum_crc32c: "ChecksumCRC32C",
  checksum_sha1: "ChecksumSHA1",
  checksum_sha256: "ChecksumSHA256",
  request_payer: "requester", # accepts requester
  expected_bucket_owner: "AccountId",
  sse_customer_algorithm: "SSECustomerAlgorithm",
  sse_customer_key: "SSECustomerKey",
  sse_customer_key_md5: "SSECustomerKeyMD5",
})

Parameters:

  • options (Hash)

    ({})

Returns:


7
8
9
10
11
12
13
14
15
16
17
18
19
# File '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 'lib/aws-sdk-s3/multipart_upload.rb', line 39

def bucket_name
  @bucket_name
end

#checksum_algorithmString

The algorithm that was used to create a checksum of the object.

Returns:

  • (String)

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

def checksum_algorithm
  data[:checksum_algorithm]
end

#clientClient

Returns:


99
100
101
# File 'lib/aws-sdk-s3/multipart_upload.rb', line 99

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.


367
368
369
370
371
372
373
374
375
376
377
378
379
# File 'lib/aws-sdk-s3/multipart_upload.rb', line 367

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:

  • (NotImplementedError)

    Raises when #data_loaded? is `false`.


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

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.


122
123
124
# File 'lib/aws-sdk-s3/multipart_upload.rb', line 122

def data_loaded?
  !!@data
end

#idString

Returns:

  • (String)

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

def id
  @id
end

#identifiersObject

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.

Deprecated.

484
485
486
487
488
489
490
# File 'lib/aws-sdk-s3/multipart_upload.rb', line 484

def identifiers
  {
    bucket_name: @bucket_name,
    object_key: @object_key,
    id: @id
  }
end

#initiatedTime

Date and time at which the multipart upload was initiated.

Returns:

  • (Time)

67
68
69
# File '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 '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 'lib/aws-sdk-s3/multipart_upload.rb', line 61

def key
  data[:key]
end

#loadObject 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.

Raises:

  • (NotImplementedError)

105
106
107
108
# File 'lib/aws-sdk-s3/multipart_upload.rb', line 105

def load
  msg = "#load is not implemented, data only available via enumeration"
  raise NotImplementedError, msg
end

#objectObject

Returns:


384
385
386
387
388
389
390
# File 'lib/aws-sdk-s3/multipart_upload.rb', line 384

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

#object_keyString

Returns:

  • (String)

44
45
46
# File '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 'lib/aws-sdk-s3/multipart_upload.rb', line 80

def owner
  data[:owner]
end

#part(part_number) ⇒ MultipartUploadPart

Parameters:

  • part_number (String)

Returns:


394
395
396
397
398
399
400
401
402
# File 'lib/aws-sdk-s3/multipart_upload.rb', line 394

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
  expected_bucket_owner: "AccountId",
  sse_customer_algorithm: "SSECustomerAlgorithm",
  sse_customer_key: "SSECustomerKey",
  sse_customer_key_md5: "SSECustomerKeyMD5",
})

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 Requester Pays Buckets] in the *Amazon S3 User Guide*.

    [1]: docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html

  • :expected_bucket_owner (String)

    The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code `403 Forbidden` (access denied).

  • :sse_customer_algorithm (String)

    The server-side encryption (SSE) algorithm used to encrypt the object. This parameter is needed only when the object was created using a checksum algorithm. For more information, see [Protecting data using SSE-C keys] in the *Amazon S3 User Guide*.

    [1]: docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html

  • :sse_customer_key (String)

    The server-side encryption (SSE) customer managed key. This parameter is needed only when the object was created using a checksum algorithm. For more information, see [Protecting data using SSE-C keys] in the *Amazon S3 User Guide*.

    [1]: docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html

  • :sse_customer_key_md5 (String)

    The MD5 server-side encryption (SSE) customer managed key. This parameter is needed only when the object was created using a checksum algorithm. For more information, see [Protecting data using SSE-C keys] in the *Amazon S3 User Guide*.

    [1]: docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html

Returns:


456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
# File 'lib/aws-sdk-s3/multipart_upload.rb', line 456

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 '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 '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


206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
# File 'lib/aws-sdk-s3/multipart_upload.rb', line 206

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