class Aws::RDS::Event

Public Class Methods

new(*args) click to toggle source

@overload def initialize(source_id, date, options = {})

@param [String] source_id
@param [String] date
@option options [Client] :client

@overload def initialize(options = {})

@option options [required, String] :source_id
@option options [required, String] :date
@option options [Client] :client
# File lib/aws-sdk-rds/event.rb, line 24
def initialize(*args)
  options = Hash === args.last ? args.pop.dup : {}
  @source_id = extract_source_id(args, options)
  @date = extract_date(args, options)
  @data = options.delete(:data)
  @client = options.delete(:client) || Client.new(options)
  @waiter_block_warned = false
end

Public Instance Methods

client() click to toggle source

@return [Client]

# File lib/aws-sdk-rds/event.rb, line 73
def client
  @client
end
data() click to toggle source

@raise [NotImplementedError] Raises when {#data_loaded?} is `false`. @return [Types::Event]

Returns the data for this {Event}.
# File lib/aws-sdk-rds/event.rb, line 88
def data
  load unless @data
  @data
end
data_loaded?() click to toggle source

@return [Boolean]

Returns `true` if this resource is loaded.  Accessing attributes or
{#data} on an unloaded resource will trigger a call to {#load}.
# File lib/aws-sdk-rds/event.rb, line 96
def data_loaded?
  !!@data
end
date() click to toggle source

@return [String]

# File lib/aws-sdk-rds/event.rb, line 42
def date
  @date
end
event_categories() click to toggle source

Specifies the category for the event. @return [Array<String>]

# File lib/aws-sdk-rds/event.rb, line 60
def event_categories
  data[:event_categories]
end
identifiers() click to toggle source

@deprecated @api private

# File lib/aws-sdk-rds/event.rb, line 199
def identifiers
  {
    source_id: @source_id,
    date: @date
  }
end
load() click to toggle source

@raise [NotImplementedError] @api private

# File lib/aws-sdk-rds/event.rb, line 79
def load
  msg = "#load is not implemented, data only available via enumeration"
  raise NotImplementedError, msg
end
Also aliased as: reload
message() click to toggle source

Provides the text of this event. @return [String]

# File lib/aws-sdk-rds/event.rb, line 54
def message
  data[:message]
end
reload()
Alias for: load
source_arn() click to toggle source

The Amazon Resource Name (ARN) for the event. @return [String]

# File lib/aws-sdk-rds/event.rb, line 66
def source_arn
  data[:source_arn]
end
source_id() click to toggle source

@return [String]

# File lib/aws-sdk-rds/event.rb, line 36
def source_id
  @source_id
end
Also aliased as: source_identifier
source_identifier()
Alias for: source_id
source_type() click to toggle source

Specifies the source type for this event. @return [String]

# File lib/aws-sdk-rds/event.rb, line 48
def source_type
  data[:source_type]
end
wait_until(options = {}, &block) click to toggle source

@deprecated Use [Aws::RDS::Client] wait_until instead

Waiter polls an API operation until a resource enters a desired state.

@note The waiting operation is performed on a copy. The original resource

remains unchanged.

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

@yieldparam [Resource] resource to be used in the waiting condition.

@raise [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.

@raise [Aws::Waiters::Errors::UnexpectedError] Raised when an error is

encountered while polling for a resource that is not expected.

@raise [NotImplementedError] Raised when the resource does not

@option options [Integer] :max_attempts (10) Maximum number of attempts @option options [Integer] :delay (10) Delay between each attempt in seconds @option options [Proc] :before_attempt (nil) Callback invoked before each attempt @option options [Proc] :before_wait (nil) Callback invoked before each wait @return [Resource] if the waiter was successful

# File lib/aws-sdk-rds/event.rb, line 180
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

Private Instance Methods

extract_date(args, options) click to toggle source
# File lib/aws-sdk-rds/event.rb, line 220
def extract_date(args, options)
  value = args[1] || options.delete(:date)
  case value
  when String then value
  when nil then raise ArgumentError, "missing required option :date"
  else
    msg = "expected :date to be a String, got #{value.class}"
    raise ArgumentError, msg
  end
end
extract_source_id(args, options) click to toggle source
# File lib/aws-sdk-rds/event.rb, line 209
def extract_source_id(args, options)
  value = args[0] || options.delete(:source_id)
  case value
  when String then value
  when nil then raise ArgumentError, "missing required option :source_id"
  else
    msg = "expected :source_id to be a String, got #{value.class}"
    raise ArgumentError, msg
  end
end