Class: Aws::Glacier::Archive

Inherits:
Object
  • Object
show all
Defined in:
gems/aws-sdk-glacier/lib/aws-sdk-glacier/archive.rb

Defined Under Namespace

Classes: Collection

Read-Only Attributes collapse

Actions collapse

Associations collapse

Instance Method Summary collapse

Constructor Details

#initialize(account_id, vault_name, id, options = {}) ⇒ Archive #initialize(options = {}) ⇒ Archive

Returns a new instance of Archive.

Overloads:

  • #initialize(account_id, vault_name, id, options = {}) ⇒ Archive

    Parameters:

    • account_id (String)
    • vault_name (String)
    • id (String)

    Options Hash (options):

  • #initialize(options = {}) ⇒ Archive

    Options Hash (options):

    • :account_id (required, String)
    • :vault_name (required, String)
    • :id (required, String)
    • :client (Client) 


26
27
28
29
30
31
32
33
34
 
# File 'gems/aws-sdk-glacier/lib/aws-sdk-glacier/archive.rb', line 26

def initialize(*args)
  options = Hash === args.last ? args.pop.dup : {}
  @account_id = (args, options)
  @vault_name = extract_vault_name(args, options)
  @id = extract_id(args, options)
  @data = Aws::EmptyStructure.new
  @client = options.delete(:client) || Client.new(options)
  @waiter_block_warned = false
end

Instance Method Details

#account_id ⇒ String

Returns:

  • (String) 


39
40
41
 
# File 'gems/aws-sdk-glacier/lib/aws-sdk-glacier/archive.rb', line 39

def 
  @account_id
end

#client ⇒ Client

Returns:



56
57
58
 
# File 'gems/aws-sdk-glacier/lib/aws-sdk-glacier/archive.rb', line 56

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.

Returns:

  • (Boolean) —

    Returns true if this resource is loaded. Accessing attributes or #data on an unloaded resource will trigger a call to #load.



77
78
79
 
# File 'gems/aws-sdk-glacier/lib/aws-sdk-glacier/archive.rb', line 77

def data_loaded?
  !!@data
end

#delete(options = {}) ⇒ EmptyStructure

Examples:

Request syntax with placeholder values


archive.delete()

Parameters:

  • options (Hash) (defaults to: {}) —

    ({})

Returns:

  • (EmptyStructure) 


187
188
189
190
191
192
193
194
195
196
197
 
# File 'gems/aws-sdk-glacier/lib/aws-sdk-glacier/archive.rb', line 187

def delete(options = {})
  options = options.merge(
    account_id: @account_id,
    vault_name: @vault_name,
    archive_id: @id
  )
  resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
    @client.delete_archive(options)
  end
  resp.data
end

#id ⇒ String

Returns:

  • (String) 


49
50
51
 
# File 'gems/aws-sdk-glacier/lib/aws-sdk-glacier/archive.rb', line 49

def id
  @id
end

#initiate_archive_retrieval(options = {}) ⇒ Job

Examples:

Request syntax with placeholder values


archive.initiate_archive_retrieval()

Parameters:

  • options (Hash) (defaults to: {}) —

    ({})

Returns:



204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
 
# File 'gems/aws-sdk-glacier/lib/aws-sdk-glacier/archive.rb', line 204

def initiate_archive_retrieval(options = {})
  options = Aws::Util.deep_merge(options,
    vault_name: @vault_name,
    account_id: @account_id,
    job_parameters: {
      type: "archive-retrieval",
      archive_id: @id
    }
  )
  resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
    @client.initiate_job(options)
  end
  Job.new(
    id: resp.data.job_id,
    account_id: @account_id,
    vault_name: @vault_name,
    client: @client
  )
end

#vault ⇒ Vault

Returns:



227
228
229
230
231
232
233
 
# File 'gems/aws-sdk-glacier/lib/aws-sdk-glacier/archive.rb', line 227

def vault
  Vault.new(
    account_id: @account_id,
    name: @vault_name,
    client: @client
  )
end

#vault_name ⇒ String

Returns:

  • (String) 


44
45
46
 
# File 'gems/aws-sdk-glacier/lib/aws-sdk-glacier/archive.rb', line 44

def vault_name
  @vault_name
end

#wait_until(options = {}) {|resource| ... } ⇒ Resource

Deprecated.

Use [Aws::Glacier::Client] #wait_until instead

Note:

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(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

attempts attempt in seconds invoked before each attempt invoked before each wait

Parameters:

  • options (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (options):

  • :max_attempts (Integer) — default: 10 —

    Maximum number of

  • :delay (Integer) — default: 10 —

    Delay between each

  • :before_attempt (Proc) — default: nil —

    Callback

  • :before_wait (Proc) — default: nil —

    Callback

Yield Parameters:

  • resource (Resource) —

    to be used in the waiting condition.

Returns:

  • (Resource) —

    if the waiter was successful

Raises:

  • (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.

  • (Aws::Waiters::Errors::UnexpectedError) —

    Raised when an error is encountered while polling for a resource that is not expected.

  • (NotImplementedError) —

    Raised when the resource does not



161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
 
# File 'gems/aws-sdk-glacier/lib/aws-sdk-glacier/archive.rb', line 161

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::Plugins::UserAgent.metric('RESOURCE_MODEL') do
    Aws::Waiters::Waiter.new(options).wait({})
  end
end