You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.
Class: Aws::Glacier::Archive
- Inherits:
-
Object
- Object
- Aws::Glacier::Archive
- Defined in:
- gems/aws-sdk-glacier/lib/aws-sdk-glacier/archive.rb
Defined Under Namespace
Classes: Collection
Actions collapse
Associations collapse
Read-Only Attributes collapse
Instance Method Summary collapse
-
#client ⇒ Client
-
#data_loaded? ⇒ Boolean
Returns
true
if this resource is loaded. -
#initialize(*args) ⇒ Archive
constructor
A new instance of Archive.
-
#wait_until(options = {}, &block) ⇒ Resource
deprecated
Deprecated.
Use [Aws::Glacier::Client] #wait_until instead
Constructor Details
#initialize(account_id, vault_name, id, options = {}) ⇒ Archive #initialize(options = {}) ⇒ Archive
Returns a new instance of Archive
23 24 25 26 27 28 29 30 31 |
# File 'gems/aws-sdk-glacier/lib/aws-sdk-glacier/archive.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 = Aws::EmptyStructure.new @client = .delete(:client) || Client.new() @waiter_block_warned = false end |
Instance Method Details
#account_id ⇒ String
36 37 38 |
# File 'gems/aws-sdk-glacier/lib/aws-sdk-glacier/archive.rb', line 36 def account_id @account_id end |
#client ⇒ Client
53 54 55 |
# File 'gems/aws-sdk-glacier/lib/aws-sdk-glacier/archive.rb', line 53 def client @client 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.
74 75 76 |
# File 'gems/aws-sdk-glacier/lib/aws-sdk-glacier/archive.rb', line 74 def data_loaded? !!@data end |
#delete(options = {}) ⇒ EmptyStructure
180 181 182 183 184 185 186 187 188 |
# File 'gems/aws-sdk-glacier/lib/aws-sdk-glacier/archive.rb', line 180 def delete( = {}) = .merge( account_id: @account_id, vault_name: @vault_name, archive_id: @id ) resp = @client.delete_archive() resp.data end |
#id ⇒ String
46 47 48 |
# File 'gems/aws-sdk-glacier/lib/aws-sdk-glacier/archive.rb', line 46 def id @id end |
#initiate_archive_retrieval(options = {}) ⇒ Job
195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 |
# File 'gems/aws-sdk-glacier/lib/aws-sdk-glacier/archive.rb', line 195 def initiate_archive_retrieval( = {}) = Aws::Util.deep_merge(, vault_name: @vault_name, account_id: @account_id, job_parameters: { type: "archive-retrieval", archive_id: @id } ) resp = @client.initiate_job() Job.new( id: resp.data.job_id, account_id: @account_id, vault_name: @vault_name, client: @client ) end |
#vault ⇒ Vault
216 217 218 219 220 221 222 |
# File 'gems/aws-sdk-glacier/lib/aws-sdk-glacier/archive.rb', line 216 def vault Vault.new( account_id: @account_id, name: @vault_name, client: @client ) end |
#vault_name ⇒ String
41 42 43 |
# File 'gems/aws-sdk-glacier/lib/aws-sdk-glacier/archive.rb', line 41 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
156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 |
# File 'gems/aws-sdk-glacier/lib/aws-sdk-glacier/archive.rb', line 156 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 |