class Aws::Glacier::MultipartUpload
Public Class Methods
@overload def initialize(account_id
, vault_name
, id, options = {})
@param [String] account_id @param [String] vault_name @param [String] id @option options [Client] :client
@overload def initialize(options = {})
@option options [required, String] :account_id @option options [required, String] :vault_name @option options [required, String] :id @option options [Client] :client
# File lib/aws-sdk-glacier/multipart_upload.rb, line 26 def initialize(*args) options = Hash === args.last ? args.pop.dup : {} @account_id = extract_account_id(args, options) @vault_name = extract_vault_name(args, options) @id = extract_id(args, options) @data = options.delete(:data) @client = options.delete(:client) || Client.new(options) @waiter_block_warned = false end
Public Instance Methods
@example Request syntax with placeholder values
multipart_upload.abort()
@param [Hash] options ({}) @return [EmptyStructure]
# File lib/aws-sdk-glacier/multipart_upload.rb, line 215 def abort(options = {}) options = options.merge( account_id: @account_id, vault_name: @vault_name, upload_id: @id ) resp = @client.abort_multipart_upload(options) resp.data end
@return [String]
# File lib/aws-sdk-glacier/multipart_upload.rb, line 39 def account_id @account_id end
The description of the archive that was specified in the Initiate Multipart Upload request. @return [String]
# File lib/aws-sdk-glacier/multipart_upload.rb, line 63 def archive_description data[:archive_description] end
@return [Client]
# File lib/aws-sdk-glacier/multipart_upload.rb, line 84 def client @client end
@example Request syntax with placeholder values
multipart_upload.complete({ archive_size: 1, checksum: "string", })
@param [Hash] options ({}) @option options [Integer] :archive_size
The total size, in bytes, of the entire archive. This value should be the sum of all the sizes of the individual parts that you uploaded.
@option options [String] :checksum
The SHA256 tree hash of the entire archive. It is the tree hash of SHA256 tree hash of the individual parts. If the value you specify in the request does not match the SHA256 tree hash of the final assembled archive as computed by Amazon S3 Glacier (Glacier), Glacier returns an error and the request fails.
@return [Types::ArchiveCreationOutput]
# File lib/aws-sdk-glacier/multipart_upload.rb, line 242 def complete(options = {}) options = options.merge( account_id: @account_id, vault_name: @vault_name, upload_id: @id ) resp = @client.complete_multipart_upload(options) resp.data end
The UTC time at which the multipart upload was initiated. @return [Time]
# File lib/aws-sdk-glacier/multipart_upload.rb, line 77 def creation_date data[:creation_date] end
@raise [NotImplementedError] Raises when {#data_loaded?} is `false`. @return [Types::UploadListElement]
Returns the data for this {MultipartUpload}.
# File lib/aws-sdk-glacier/multipart_upload.rb, line 99 def data load unless @data @data end
@return [Boolean]
Returns `true` if this resource is loaded. Accessing attributes or {#data} on an unloaded resource will trigger a call to {#load}.
# File lib/aws-sdk-glacier/multipart_upload.rb, line 107 def data_loaded? !!@data end
@return [String]
# File lib/aws-sdk-glacier/multipart_upload.rb, line 49 def id @id end
@deprecated @api private
# File lib/aws-sdk-glacier/multipart_upload.rb, line 322 def identifiers { account_id: @account_id, vault_name: @vault_name, id: @id } end
@raise [NotImplementedError] @api private
# File lib/aws-sdk-glacier/multipart_upload.rb, line 90 def load msg = "#load is not implemented, data only available via enumeration" raise NotImplementedError, msg end
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. @return [Integer]
# File lib/aws-sdk-glacier/multipart_upload.rb, line 71 def part_size_in_bytes data[:part_size_in_bytes] end
@example Request syntax with placeholder values
multipart_upload.parts({ marker: "string", limit: 1, })
@param [Hash] options ({}) @option options [String] :marker
An opaque string used for pagination. This value specifies the part at which the listing of parts should begin. Get the marker value from the response of a previous List Parts response. You need only include the marker if you are continuing the pagination of results started in a previous List Parts request.
@option options [Integer] :limit
The maximum number of parts to be returned. The default limit is 50. The number of parts returned might be fewer than the specified limit, but the number of returned parts never exceeds the limit.
@return [Types::ListPartsOutput]
# File lib/aws-sdk-glacier/multipart_upload.rb, line 270 def parts(options = {}) options = options.merge( account_id: @account_id, vault_name: @vault_name, upload_id: @id ) resp = @client.list_parts(options) resp.data end
@example Request syntax with placeholder values
multipart_upload.upload_part({ checksum: "string", range: "string", body: "data", })
@param [Hash] options ({}) @option options [String] :checksum
The SHA256 tree hash of the data being uploaded.
@option options [String] :range
Identifies the range of bytes in the assembled archive that will be uploaded in this part. Amazon S3 Glacier uses this information to assemble the archive in the proper sequence. The format of this header follows RFC 2616. An example header is Content-Range:bytes 0-4194303/*.
@option options [String, StringIO, File] :body
The data to upload.
@return [Types::UploadMultipartPartOutput]
# File lib/aws-sdk-glacier/multipart_upload.rb, line 299 def upload_part(options = {}) options = options.merge( account_id: @account_id, vault_name: @vault_name, upload_id: @id ) resp = @client.upload_multipart_part(options) resp.data end
@return [Vault]
# File lib/aws-sdk-glacier/multipart_upload.rb, line 312 def vault Vault.new( account_id: @account_id, name: @vault_name, client: @client ) end
The Amazon Resource
Name (ARN) of the vault that contains the archive. @return [String]
# File lib/aws-sdk-glacier/multipart_upload.rb, line 56 def vault_arn data[:vault_arn] end
@return [String]
# File lib/aws-sdk-glacier/multipart_upload.rb, line 44 def vault_name @vault_name end
@deprecated Use [Aws::Glacier::Client] wait_until
instead
Waiter polls an API operation until a resource enters a desired state.
@note The waiting operation is performed on a copy. The original resource
remains unchanged.
## 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
@yieldparam [Resource] resource to be used in the waiting condition.
@raise [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.
@raise [Aws::Waiters::Errors::UnexpectedError] Raised when an error is
encountered while polling for a resource that is not expected.
@raise [NotImplementedError] Raised when the resource does not
@option options [Integer] :max_attempts (10) Maximum number of attempts @option options [Integer] :delay (10) Delay between each attempt in seconds @option options [Proc] :before_attempt (nil) Callback invoked before each attempt @option options [Proc] :before_wait (nil) Callback invoked before each wait @return [Resource] if the waiter was successful
# File lib/aws-sdk-glacier/multipart_upload.rb, line 191 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
Private Instance Methods
# File lib/aws-sdk-glacier/multipart_upload.rb, line 333 def extract_account_id(args, options) value = args[0] || options.delete(:account_id) case value when String then value when nil then raise ArgumentError, "missing required option :account_id" else msg = "expected :account_id to be a String, got #{value.class}" raise ArgumentError, msg end end
# File lib/aws-sdk-glacier/multipart_upload.rb, line 355 def extract_id(args, options) value = args[2] || options.delete(:id) case value when String then value when nil then raise ArgumentError, "missing required option :id" else msg = "expected :id to be a String, got #{value.class}" raise ArgumentError, msg end end
# File lib/aws-sdk-glacier/multipart_upload.rb, line 344 def extract_vault_name(args, options) value = args[1] || options.delete(:vault_name) case value when String then value when nil then raise ArgumentError, "missing required option :vault_name" else msg = "expected :vault_name to be a String, got #{value.class}" raise ArgumentError, msg end end