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
-
#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 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 = {}, &block) ⇒ 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.
25 26 27 28 29 30 31 32 33 |
# File 'lib/aws-sdk-s3/multipart_upload_part.rb', line 25 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() end |
Instance Method Details
#bucket_name ⇒ String
38 39 40 |
# File 'lib/aws-sdk-s3/multipart_upload_part.rb', line 38 def bucket_name @bucket_name end |
#client ⇒ Client
78 79 80 |
# File 'lib/aws-sdk-s3/multipart_upload_part.rb', line 78 def client @client end |
#copy_from(options = {}) ⇒ Types::UploadPartCopyOutput
272 273 274 275 276 277 278 279 280 281 |
# File 'lib/aws-sdk-s3/multipart_upload_part.rb', line 272 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.
93 94 95 96 |
# File 'lib/aws-sdk-s3/multipart_upload_part.rb', line 93 def data load unless @data @data end |
#data_loaded? ⇒ Boolean
101 102 103 |
# File 'lib/aws-sdk-s3/multipart_upload_part.rb', line 101 def data_loaded? !!@data end |
#etag ⇒ String
Entity tag returned when the part was uploaded.
65 66 67 |
# File 'lib/aws-sdk-s3/multipart_upload_part.rb', line 65 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.
349 350 351 352 353 354 355 356 |
# File 'lib/aws-sdk-s3/multipart_upload_part.rb', line 349 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.
59 60 61 |
# File 'lib/aws-sdk-s3/multipart_upload_part.rb', line 59 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.
84 85 86 87 |
# File 'lib/aws-sdk-s3/multipart_upload_part.rb', line 84 def load msg = "#load is not implemented, data only available via enumeration" raise NotImplementedError, msg end |
#multipart_upload ⇒ MultipartUpload
338 339 340 341 342 343 344 345 |
# File 'lib/aws-sdk-s3/multipart_upload_part.rb', line 338 def multipart_upload MultipartUpload.new( bucket_name: @bucket_name, object_key: @object_key, id: @multipart_upload_id, client: @client ) end |
#multipart_upload_id ⇒ String
48 49 50 |
# File 'lib/aws-sdk-s3/multipart_upload_part.rb', line 48 def multipart_upload_id @multipart_upload_id end |
#object_key ⇒ String
43 44 45 |
# File 'lib/aws-sdk-s3/multipart_upload_part.rb', line 43 def object_key @object_key end |
#part_number ⇒ Integer
53 54 55 |
# File 'lib/aws-sdk-s3/multipart_upload_part.rb', line 53 def part_number @part_number end |
#size ⇒ Integer
Size of the uploaded part data.
71 72 73 |
# File 'lib/aws-sdk-s3/multipart_upload_part.rb', line 71 def size data[:size] end |
#upload(options = {}) ⇒ Types::UploadPartOutput
324 325 326 327 328 329 330 331 332 333 |
# File 'lib/aws-sdk-s3/multipart_upload_part.rb', line 324 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 = {}, &block) ⇒ 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) {|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
183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 |
# File 'lib/aws-sdk-s3/multipart_upload_part.rb', line 183 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 |