Class: Aws::RDS::Event
- Inherits:
-
Object
- Object
- Aws::RDS::Event
- Extended by:
- Deprecations
- Defined in:
- 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.
- #identifiers ⇒ Object deprecated private Deprecated.
-
#initialize(*args) ⇒ Event
constructor
A new instance of Event.
- #load ⇒ Object (also: #reload) private
-
#wait_until(options = {}, &block) ⇒ 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.
21 22 23 24 25 26 27 |
# File 'lib/aws-sdk-rds/event.rb', line 21 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() end |
Instance Method Details
#data ⇒ Types::Event
Returns the data for this Aws::RDS::Event.
84 85 86 87 |
# File 'lib/aws-sdk-rds/event.rb', line 84 def data load unless @data @data end |
#data_loaded? ⇒ Boolean
92 93 94 |
# File 'lib/aws-sdk-rds/event.rb', line 92 def data_loaded? !!@data end |
#date ⇒ String
38 39 40 |
# File 'lib/aws-sdk-rds/event.rb', line 38 def date @date end |
#event_categories ⇒ Array<String>
Specifies the category for the event.
56 57 58 |
# File 'lib/aws-sdk-rds/event.rb', line 56 def event_categories data[:event_categories] end |
#identifiers ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
193 194 195 196 197 198 |
# File 'lib/aws-sdk-rds/event.rb', line 193 def identifiers { source_id: @source_id, date: @date } end |
#load ⇒ Object Also known as: reload
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
75 76 77 78 |
# File 'lib/aws-sdk-rds/event.rb', line 75 def load msg = "#load is not implemented, data only available via enumeration" raise NotImplementedError, msg end |
#message ⇒ String
Provides the text of this event.
50 51 52 |
# File 'lib/aws-sdk-rds/event.rb', line 50 def data[:message] end |
#source_arn ⇒ String
The Amazon Resource Name (ARN) for the event.
62 63 64 |
# File 'lib/aws-sdk-rds/event.rb', line 62 def source_arn data[:source_arn] end |
#source_id ⇒ String Also known as: source_identifier
32 33 34 |
# File 'lib/aws-sdk-rds/event.rb', line 32 def source_id @source_id end |
#source_type ⇒ String
Specifies the source type for this event.
44 45 46 |
# File 'lib/aws-sdk-rds/event.rb', line 44 def source_type data[:source_type] end |
#wait_until(options = {}, &block) ⇒ 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) {|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
174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 |
# File 'lib/aws-sdk-rds/event.rb', line 174 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 |