Class: Aws::DynamoDB::Waiters::TableExists

Inherits:
Object
  • Object
show all
Defined in:
lib/aws-sdk-dynamodb/waiters.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options) ⇒ TableExists

Returns a new instance of TableExists.

Parameters:

  • options (Hash)

Options Hash (options):

  • :client (required, Client)
  • :max_attempts (Integer) — default: 25
  • :delay (Integer) — default: 20
  • :before_attempt (Proc)
  • :before_wait (Proc)

85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
# File 'lib/aws-sdk-dynamodb/waiters.rb', line 85

def initialize(options)
  @client = options.fetch(:client)
  @waiter = Aws::Waiters::Waiter.new({
    max_attempts: 25,
    delay: 20,
    poller: Aws::Waiters::Poller.new(
      operation_name: :describe_table,
      acceptors: [
        {
          "expected" => "ACTIVE",
          "matcher" => "path",
          "state" => "success",
          "argument" => "table.table_status"
        },
        {
          "expected" => "ResourceNotFoundException",
          "matcher" => "error",
          "state" => "retry"
        }
      ]
    )
  }.merge(options))
end

Instance Attribute Details

#waiterObject (readonly)

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.


116
117
118
# File 'lib/aws-sdk-dynamodb/waiters.rb', line 116

def waiter
  @waiter
end

Instance Method Details

#wait(params = {}) ⇒ Types::DescribeTableOutput

Returns a response object which responds to the following methods:

  • #table => Types::TableDescription

Options Hash (params):

  • :table_name (required, String)

    The name of the table to describe.

Returns:


111
112
113
# File 'lib/aws-sdk-dynamodb/waiters.rb', line 111

def wait(params = {})
  @waiter.wait(client: @client, params: params)
end