Class: Aws::RDS::Event
- Inherits:
-
Object
- Object
- Aws::RDS::Event
- Defined in:
- gems/aws-sdk-rds/lib/aws-sdk-rds/event.rb
Defined Under Namespace
Classes: Collection
Read-Only Attributes collapse
-
#date ⇒ String
-
#event_categories ⇒ Array<String>
Specifies the category for the event.
-
#message ⇒ String
Provides the text of this event.
-
#source_arn ⇒ String
The Amazon Resource Name (ARN) for the event.
-
#source_id ⇒ String
(also: #source_identifier)
-
#source_type ⇒ String
Specifies the source type for this event.
Instance Method Summary collapse
-
#client ⇒ Client
-
#data ⇒ Types::Event
Returns the data for this Event.
-
#data_loaded? ⇒ Boolean
Returns
true
if this resource is loaded. -
#initialize(*args) ⇒ Event
constructor
A new instance of Event.
-
#wait_until(options = {}) {|resource| ... } ⇒ Resource
deprecated
Deprecated.
Use [Aws::RDS::Client] #wait_until instead
Constructor Details
#initialize(source_id, date, options = {}) ⇒ Event #initialize(options = {}) ⇒ Event
Returns a new instance of Event.
24 25 26 27 28 29 30 31 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/event.rb', line 24 def initialize(*args) = Hash === args.last ? args.pop.dup : {} @source_id = extract_source_id(args, ) @date = extract_date(args, ) @data = .delete(:data) @client = .delete(:client) || Client.new() @waiter_block_warned = false end |
Instance Method Details
#client ⇒ Client
73 74 75 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/event.rb', line 73 def client @client end |
#data ⇒ Types::Event
Returns the data for this Aws::RDS::Event.
88 89 90 91 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/event.rb', line 88 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.
96 97 98 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/event.rb', line 96 def data_loaded? !!@data end |
#date ⇒ String
42 43 44 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/event.rb', line 42 def date @date end |
#event_categories ⇒ Array<String>
Specifies the category for the event.
60 61 62 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/event.rb', line 60 def event_categories data[:event_categories] end |
#message ⇒ String
Provides the text of this event.
54 55 56 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/event.rb', line 54 def data[:message] end |
#source_arn ⇒ String
The Amazon Resource Name (ARN) for the event.
66 67 68 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/event.rb', line 66 def source_arn data[:source_arn] end |
#source_id ⇒ String Also known as: source_identifier
36 37 38 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/event.rb', line 36 def source_id @source_id end |
#source_type ⇒ String
Specifies the source type for this event.
48 49 50 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/event.rb', line 48 def source_type data[:source_type] end |
#wait_until(options = {}) {|resource| ... } ⇒ Resource
Use [Aws::RDS::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) 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
180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/event.rb', line 180 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::Plugins::UserAgent.metric('RESOURCE_MODEL') do Aws::Waiters::Waiter.new().wait({}) end end |