You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::Glacier::Account

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

Defined Under Namespace

Classes: Collection

Actions collapse

Associations collapse

Read-Only Attributes collapse

Instance Method Summary collapse

Constructor Details

#initialize(id, options = {}) ⇒ Account #initialize(options = {}) ⇒ Account

Returns a new instance of Account

Overloads:

  • #initialize(id, options = {}) ⇒ Account

    Parameters:

    • id (String)

    Options Hash (options):

  • #initialize(options = {}) ⇒ Account

    Options Hash (options):

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


19
20
21
22
23
24
# File 'gems/aws-sdk-glacier/lib/aws-sdk-glacier/account.rb', line 19

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

Instance Method Details

#clientClient

Returns:



36
37
38
# File 'gems/aws-sdk-glacier/lib/aws-sdk-glacier/account.rb', line 36

def client
  @client
end

#create_vault(options = {}) ⇒ Vault

Examples:

Request syntax with placeholder values


vault = .create_vault({
  vault_name: "string", # required
})

Parameters:

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

    ({})

Options Hash (options):

  • :vault_name (required, String)

    The name of the vault.

Returns:



167
168
169
170
171
172
173
174
175
# File 'gems/aws-sdk-glacier/lib/aws-sdk-glacier/account.rb', line 167

def create_vault(options = {})
  options = options.merge(account_id: @id)
  resp = @client.create_vault(options)
  Vault.new(
    account_id: @id,
    name: options[:vault_name],
    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.



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

def data_loaded?
  !!@data
end

#idString

Returns:

  • (String)


29
30
31
# File 'gems/aws-sdk-glacier/lib/aws-sdk-glacier/account.rb', line 29

def id
  @id
end

#vault(name) ⇒ Vault

Parameters:

  • name (String)

Returns:



181
182
183
184
185
186
187
# File 'gems/aws-sdk-glacier/lib/aws-sdk-glacier/account.rb', line 181

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

#vaults(options = {}) ⇒ Vault::Collection

Examples:

Request syntax with placeholder values


.vaults()

Parameters:

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

    ({})

Returns:



194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
# File 'gems/aws-sdk-glacier/lib/aws-sdk-glacier/account.rb', line 194

def vaults(options = {})
  batches = Enumerator.new do |y|
    options = options.merge(account_id: @id)
    resp = @client.list_vaults(options)
    resp.each_page do |page|
      batch = []
      page.data.vault_list.each do |v|
        batch << Vault.new(
          account_id: @id,
          name: v.vault_name,
          data: v,
          client: @client
        )
      end
      y.yield(batch)
    end
  end
  Vault::Collection.new(batches)
end

#wait_until(options = {}, &block) ⇒ 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) {|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

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

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



139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
# File 'gems/aws-sdk-glacier/lib/aws-sdk-glacier/account.rb', line 139

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