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

Class: Aws::Glacier::Notification

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

Defined Under Namespace

Classes: Collection

Actions collapse

Associations collapse

Read-Only Attributes collapse

Instance Method Summary collapse

Constructor Details

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

Returns a new instance of Notification

Overloads:

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

    Parameters:

    • account_id (String)
    • vault_name (String)

    Options Hash (options):

  • #initialize(options = {}) ⇒ Notification

    Options Hash (options):

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


21
22
23
24
25
26
27
# File 'gems/aws-sdk-glacier/lib/aws-sdk-glacier/notification.rb', line 21

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

Instance Method Details

#account_idString

Returns:

  • (String)


32
33
34
# File 'gems/aws-sdk-glacier/lib/aws-sdk-glacier/notification.rb', line 32

def 
  @account_id
end

#clientClient

Returns:



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

def client
  @client
end

#dataTypes::VaultNotificationConfig

Returns the data for this Aws::Glacier::Notification. Calls Client#get_vault_notifications if #data_loaded? is false.

Returns:



81
82
83
84
# File 'gems/aws-sdk-glacier/lib/aws-sdk-glacier/notification.rb', line 81

def data
  load unless @data
  @data
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.



89
90
91
# File 'gems/aws-sdk-glacier/lib/aws-sdk-glacier/notification.rb', line 89

def data_loaded?
  !!@data
end

#delete(options = {}) ⇒ EmptyStructure

Examples:

Request syntax with placeholder values


notification.delete()

Parameters:

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

    ({})

Returns:

  • (EmptyStructure)


195
196
197
198
199
200
201
202
# File 'gems/aws-sdk-glacier/lib/aws-sdk-glacier/notification.rb', line 195

def delete(options = {})
  options = options.merge(
    account_id: @account_id,
    vault_name: @vault_name
  )
  resp = @client.delete_vault_notifications(options)
  resp.data
end

#eventsArray<String>

A list of one or more events for which Amazon Glacier will send a notification to the specified Amazon SNS topic.

Returns:

  • (Array<String>)


51
52
53
# File 'gems/aws-sdk-glacier/lib/aws-sdk-glacier/notification.rb', line 51

def events
  data[:events]
end

#loadself Also known as: reload

Loads, or reloads #data for the current Aws::Glacier::Notification. Returns self making it possible to chain methods.

notification.reload.data

Returns:

  • (self)


68
69
70
71
72
73
74
75
# File 'gems/aws-sdk-glacier/lib/aws-sdk-glacier/notification.rb', line 68

def load
  resp = @client.get_vault_notifications(
    account_id: @account_id,
    vault_name: @vault_name
  )
  @data = resp.vault_notification_config
  self
end

#set(options = {}) ⇒ EmptyStructure

Examples:

Request syntax with placeholder values


notification.set({
  vault_notification_config: {
    sns_topic: "string",
    events: ["string"],
  },
})

Parameters:

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

    ({})

Options Hash (options):

Returns:

  • (EmptyStructure)


216
217
218
219
220
221
222
223
# File 'gems/aws-sdk-glacier/lib/aws-sdk-glacier/notification.rb', line 216

def set(options = {})
  options = options.merge(
    account_id: @account_id,
    vault_name: @vault_name
  )
  resp = @client.set_vault_notifications(options)
  resp.data
end

#sns_topicString

The Amazon Simple Notification Service (Amazon SNS) topic Amazon Resource Name (ARN).

Returns:

  • (String)


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

def sns_topic
  data[:sns_topic]
end

#vaultVault

Returns:



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

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

#vault_nameString

Returns:

  • (String)


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

def vault_name
  @vault_name
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



171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
# File 'gems/aws-sdk-glacier/lib/aws-sdk-glacier/notification.rb', line 171

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