Class: Aws::S3::MultipartUploadPart
- Inherits:
-
Object
- Object
- Aws::S3::MultipartUploadPart
- Extended by:
- Deprecations
- Defined in:
- lib/aws-sdk-s3/multipart_upload_part.rb
Defined Under Namespace
Classes: Collection
Read-Only Attributes collapse
- #bucket_name ⇒ String
-
#checksum_crc32 ⇒ String
This header can be used as a data integrity check to verify that the data received is the same data that was originally sent.
-
#checksum_crc32c ⇒ String
The base64-encoded, 32-bit CRC32C checksum of the object.
-
#checksum_sha1 ⇒ String
The base64-encoded, 160-bit SHA-1 digest of the object.
-
#checksum_sha256 ⇒ String
This header can be used as a data integrity check to verify that the data received is the same data that was originally sent.
-
#etag ⇒ String
Entity tag returned when the part was uploaded.
-
#last_modified ⇒ Time
Date and time at which the part was uploaded.
- #multipart_upload_id ⇒ String
- #object_key ⇒ String
- #part_number ⇒ Integer
-
#size ⇒ Integer
Size in bytes of the uploaded part data.
Actions collapse
- #copy_from(options = {}) ⇒ Types::UploadPartCopyOutput
- #upload(options = {}) ⇒ Types::UploadPartOutput
Associations collapse
- #identifiers ⇒ Object deprecated private Deprecated.
- #multipart_upload ⇒ MultipartUpload
Instance Method Summary collapse
- #client ⇒ Client
-
#data ⇒ Types::Part
Returns the data for this MultipartUploadPart.
-
#data_loaded? ⇒ Boolean
Returns ‘true` if this resource is loaded.
-
#initialize(*args) ⇒ MultipartUploadPart
constructor
A new instance of MultipartUploadPart.
- #load ⇒ Object (also: #reload) private
-
#wait_until(options = {}) {|resource| ... } ⇒ Resource
deprecated
Deprecated.
Use [Aws::S3::Client] #wait_until instead
Constructor Details
#initialize(bucket_name, object_key, multipart_upload_id, part_number, options = {}) ⇒ MultipartUploadPart #initialize(options = {}) ⇒ MultipartUploadPart
Returns a new instance of MultipartUploadPart.
28 29 30 31 32 33 34 35 36 37 |
# File 'lib/aws-sdk-s3/multipart_upload_part.rb', line 28 def initialize(*args) = Hash === args.last ? args.pop.dup : {} @bucket_name = extract_bucket_name(args, ) @object_key = extract_object_key(args, ) @multipart_upload_id = extract_multipart_upload_id(args, ) @part_number = extract_part_number(args, ) @data = .delete(:data) @client = .delete(:client) || Client.new() @waiter_block_warned = false end |
Instance Method Details
#bucket_name ⇒ String
42 43 44 |
# File 'lib/aws-sdk-s3/multipart_upload_part.rb', line 42 def bucket_name @bucket_name end |
#checksum_crc32 ⇒ String
This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the base64-encoded, 32-bit CRC32 checksum of the object. For more information, see [Checking object integrity] in the *Amazon S3 User Guide*.
[1]: docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html
89 90 91 |
# File 'lib/aws-sdk-s3/multipart_upload_part.rb', line 89 def checksum_crc32 data[:checksum_crc32] end |
#checksum_crc32c ⇒ String
The base64-encoded, 32-bit CRC32C checksum of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see [ Checking object integrity] in the *Amazon S3 User Guide*.
[1]: docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums
103 104 105 |
# File 'lib/aws-sdk-s3/multipart_upload_part.rb', line 103 def checksum_crc32c data[:checksum_crc32c] end |
#checksum_sha1 ⇒ String
The base64-encoded, 160-bit SHA-1 digest of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see [ Checking object integrity] in the *Amazon S3 User Guide*.
[1]: docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums
117 118 119 |
# File 'lib/aws-sdk-s3/multipart_upload_part.rb', line 117 def checksum_sha1 data[:checksum_sha1] end |
#checksum_sha256 ⇒ String
This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the base64-encoded, 256-bit SHA-256 digest of the object. For more information, see [Checking object integrity] in the *Amazon S3 User Guide*.
[1]: docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html
131 132 133 |
# File 'lib/aws-sdk-s3/multipart_upload_part.rb', line 131 def checksum_sha256 data[:checksum_sha256] end |
#client ⇒ Client
138 139 140 |
# File 'lib/aws-sdk-s3/multipart_upload_part.rb', line 138 def client @client end |
#copy_from(options = {}) ⇒ Types::UploadPartCopyOutput
391 392 393 394 395 396 397 398 399 400 |
# File 'lib/aws-sdk-s3/multipart_upload_part.rb', line 391 def copy_from( = {}) = .merge( bucket: @bucket_name, key: @object_key, upload_id: @multipart_upload_id, part_number: @part_number ) resp = @client.upload_part_copy() resp.data end |
#data ⇒ Types::Part
Returns the data for this Aws::S3::MultipartUploadPart.
153 154 155 156 |
# File 'lib/aws-sdk-s3/multipart_upload_part.rb', line 153 def data load unless @data @data end |
#data_loaded? ⇒ Boolean
161 162 163 |
# File 'lib/aws-sdk-s3/multipart_upload_part.rb', line 161 def data_loaded? !!@data end |
#etag ⇒ String
Entity tag returned when the part was uploaded.
69 70 71 |
# File 'lib/aws-sdk-s3/multipart_upload_part.rb', line 69 def etag data[:etag] end |
#identifiers ⇒ Object
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.
542 543 544 545 546 547 548 549 |
# File 'lib/aws-sdk-s3/multipart_upload_part.rb', line 542 def identifiers { bucket_name: @bucket_name, object_key: @object_key, multipart_upload_id: @multipart_upload_id, part_number: @part_number } end |
#last_modified ⇒ Time
Date and time at which the part was uploaded.
63 64 65 |
# File 'lib/aws-sdk-s3/multipart_upload_part.rb', line 63 def last_modified data[:last_modified] end |
#load ⇒ Object 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.
144 145 146 147 |
# File 'lib/aws-sdk-s3/multipart_upload_part.rb', line 144 def load msg = "#load is not implemented, data only available via enumeration" raise NotImplementedError, msg end |
#multipart_upload ⇒ MultipartUpload
531 532 533 534 535 536 537 538 |
# File 'lib/aws-sdk-s3/multipart_upload_part.rb', line 531 def multipart_upload MultipartUpload.new( bucket_name: @bucket_name, object_key: @object_key, id: @multipart_upload_id, client: @client ) end |
#multipart_upload_id ⇒ String
52 53 54 |
# File 'lib/aws-sdk-s3/multipart_upload_part.rb', line 52 def multipart_upload_id @multipart_upload_id end |
#object_key ⇒ String
47 48 49 |
# File 'lib/aws-sdk-s3/multipart_upload_part.rb', line 47 def object_key @object_key end |
#part_number ⇒ Integer
57 58 59 |
# File 'lib/aws-sdk-s3/multipart_upload_part.rb', line 57 def part_number @part_number end |
#size ⇒ Integer
Size in bytes of the uploaded part data.
75 76 77 |
# File 'lib/aws-sdk-s3/multipart_upload_part.rb', line 75 def size data[:size] end |
#upload(options = {}) ⇒ Types::UploadPartOutput
517 518 519 520 521 522 523 524 525 526 |
# File 'lib/aws-sdk-s3/multipart_upload_part.rb', line 517 def upload( = {}) = .merge( bucket: @bucket_name, key: @object_key, upload_id: @multipart_upload_id, part_number: @part_number ) resp = @client.upload_part() resp.data end |
#wait_until(options = {}) {|resource| ... } ⇒ Resource
Use [Aws::S3::Client] #wait_until instead
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() {|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
245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 |
# File 'lib/aws-sdk-s3/multipart_upload_part.rb', line 245 def wait_until( = {}, &block) self_copy = self.dup attempts = 0 [:max_attempts] = 10 unless .key?(:max_attempts) [:delay] ||= 10 [:poller] = Proc.new do attempts += 1 if block.call(self_copy) [:success, self_copy] else self_copy.reload unless attempts == [:max_attempts] :retry end end Aws::Waiters::Waiter.new().wait({}) end |