Class: Aws::Glacier::MultipartUpload
- Inherits:
-
Object
- Object
- Aws::Glacier::MultipartUpload
- Extended by:
- Deprecations
- Defined in:
- lib/aws-sdk-glacier/multipart_upload.rb
Defined Under Namespace
Classes: Collection
Read-Only Attributes collapse
- #account_id ⇒ String
-
#archive_description ⇒ String
The description of the archive that was specified in the Initiate Multipart Upload request.
-
#creation_date ⇒ Time
The UTC time at which the multipart upload was initiated.
- #id ⇒ String (also: #multipart_upload_id)
-
#part_size_in_bytes ⇒ Integer
The part size, in bytes, specified in the Initiate Multipart Upload request.
-
#vault_arn ⇒ String
The Amazon Resource Name (ARN) of the vault that contains the archive.
- #vault_name ⇒ String
Actions collapse
- #abort(options = {}) ⇒ EmptyStructure
- #complete(options = {}) ⇒ Types::ArchiveCreationOutput
- #parts(options = {}) ⇒ Types::ListPartsOutput
- #upload_part(options = {}) ⇒ Types::UploadMultipartPartOutput
Associations collapse
- #identifiers ⇒ Object deprecated private Deprecated.
- #vault ⇒ Vault
Instance Method Summary collapse
- #client ⇒ Client
-
#data ⇒ Types::UploadListElement
Returns the data for this MultipartUpload.
-
#data_loaded? ⇒ Boolean
Returns ‘true` if this resource is loaded.
-
#initialize(*args) ⇒ MultipartUpload
constructor
A new instance of MultipartUpload.
- #load ⇒ Object (also: #reload) private
-
#wait_until(options = {}, &block) ⇒ Resource
deprecated
Deprecated.
Use [Aws::Glacier::Client] #wait_until instead
Constructor Details
#initialize(account_id, vault_name, id, options = {}) ⇒ MultipartUpload #initialize(options = {}) ⇒ MultipartUpload
Returns a new instance of MultipartUpload.
23 24 25 26 27 28 29 30 |
# File 'lib/aws-sdk-glacier/multipart_upload.rb', line 23 def initialize(*args) = Hash === args.last ? args.pop.dup : {} @account_id = extract_account_id(args, ) @vault_name = extract_vault_name(args, ) @id = extract_id(args, ) @data = .delete(:data) @client = .delete(:client) || Client.new() end |
Instance Method Details
#abort(options = {}) ⇒ EmptyStructure
209 210 211 212 213 214 215 216 217 |
# File 'lib/aws-sdk-glacier/multipart_upload.rb', line 209 def abort( = {}) = .merge( account_id: @account_id, vault_name: @vault_name, upload_id: @id ) resp = @client.abort_multipart_upload() resp.data end |
#account_id ⇒ String
35 36 37 |
# File 'lib/aws-sdk-glacier/multipart_upload.rb', line 35 def account_id @account_id end |
#archive_description ⇒ String
The description of the archive that was specified in the Initiate Multipart Upload request.
59 60 61 |
# File 'lib/aws-sdk-glacier/multipart_upload.rb', line 59 def archive_description data[:archive_description] end |
#client ⇒ Client
80 81 82 |
# File 'lib/aws-sdk-glacier/multipart_upload.rb', line 80 def client @client end |
#complete(options = {}) ⇒ Types::ArchiveCreationOutput
236 237 238 239 240 241 242 243 244 |
# File 'lib/aws-sdk-glacier/multipart_upload.rb', line 236 def complete( = {}) = .merge( account_id: @account_id, vault_name: @vault_name, upload_id: @id ) resp = @client.complete_multipart_upload() resp.data end |
#creation_date ⇒ Time
The UTC time at which the multipart upload was initiated.
73 74 75 |
# File 'lib/aws-sdk-glacier/multipart_upload.rb', line 73 def creation_date data[:creation_date] end |
#data ⇒ Types::UploadListElement
Returns the data for this Aws::Glacier::MultipartUpload.
95 96 97 98 |
# File 'lib/aws-sdk-glacier/multipart_upload.rb', line 95 def data load unless @data @data end |
#data_loaded? ⇒ Boolean
103 104 105 |
# File 'lib/aws-sdk-glacier/multipart_upload.rb', line 103 def data_loaded? !!@data end |
#id ⇒ String Also known as: multipart_upload_id
45 46 47 |
# File 'lib/aws-sdk-glacier/multipart_upload.rb', line 45 def id @id 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.
316 317 318 319 320 321 322 |
# File 'lib/aws-sdk-glacier/multipart_upload.rb', line 316 def identifiers { account_id: @account_id, vault_name: @vault_name, id: @id } 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.
86 87 88 89 |
# File 'lib/aws-sdk-glacier/multipart_upload.rb', line 86 def load msg = "#load is not implemented, data only available via enumeration" raise NotImplementedError, msg end |
#part_size_in_bytes ⇒ Integer
The part size, in bytes, specified in the Initiate Multipart Upload request. This is the size of all the parts in the upload except the last part, which may be smaller than this size.
67 68 69 |
# File 'lib/aws-sdk-glacier/multipart_upload.rb', line 67 def part_size_in_bytes data[:part_size_in_bytes] end |
#parts(options = {}) ⇒ Types::ListPartsOutput
264 265 266 267 268 269 270 271 272 |
# File 'lib/aws-sdk-glacier/multipart_upload.rb', line 264 def parts( = {}) = .merge( account_id: @account_id, vault_name: @vault_name, upload_id: @id ) resp = @client.list_parts() resp.data end |
#upload_part(options = {}) ⇒ Types::UploadMultipartPartOutput
293 294 295 296 297 298 299 300 301 |
# File 'lib/aws-sdk-glacier/multipart_upload.rb', line 293 def upload_part( = {}) = .merge( account_id: @account_id, vault_name: @vault_name, upload_id: @id ) resp = @client.upload_multipart_part() resp.data end |
#vault ⇒ Vault
306 307 308 309 310 311 312 |
# File 'lib/aws-sdk-glacier/multipart_upload.rb', line 306 def vault Vault.new( account_id: @account_id, name: @vault_name, client: @client ) end |
#vault_arn ⇒ String
The Amazon Resource Name (ARN) of the vault that contains the archive.
52 53 54 |
# File 'lib/aws-sdk-glacier/multipart_upload.rb', line 52 def vault_arn data[:vault_arn] end |
#vault_name ⇒ String
40 41 42 |
# File 'lib/aws-sdk-glacier/multipart_upload.rb', line 40 def vault_name @vault_name end |
#wait_until(options = {}, &block) ⇒ Resource
Use [Aws::Glacier::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
185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 |
# File 'lib/aws-sdk-glacier/multipart_upload.rb', line 185 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 |