Class: Aws::TranscribeService::Waiters::VocabularyReady

Inherits:

Object

• Object
• Aws::TranscribeService::Waiters::VocabularyReady

Defined in:

gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/waiters.rb

Instance Method Summary

• #initialize(options) ⇒ VocabularyReady constructor

  A new instance of VocabularyReady.

• #wait(params = {}) ⇒ Types::GetVocabularyResponse

  Returns a response object which responds to the following methods:.

Constructor Details

#initialize(options) ⇒ VocabularyReady

Returns a new instance of VocabularyReady.

Parameters:

• options (Hash)

Options Hash (options):

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

# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/waiters.rb', line 354

def initialize(options)
  @client = options.fetch(:client)
  @waiter = Aws::Waiters::Waiter.new({
    max_attempts: 180,
    delay: 10,
    poller: Aws::Waiters::Poller.new(
      operation_name: :get_vocabulary,
      acceptors: [
        {
          "state" => "success",
          "matcher" => "path",
          "argument" => "vocabulary_state",
          "expected" => "READY"
        },
        {
          "state" => "failure",
          "matcher" => "path",
          "argument" => "vocabulary_state",
          "expected" => "FAILED"
        }
      ]
    )
  }.merge(options))
end

Instance Method Details

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

Returns a response object which responds to the following methods:

• #vocabulary_name => String
• #language_code => String
• #vocabulary_state => String
• #last_modified_time => Time
• #failure_reason => String
• #download_uri => String

Parameters:

• params (Hash) (defaults to: {}) —

  a customizable set of options

Options Hash (params):

• :vocabulary_name (required, String) —

  The name of the custom vocabulary you want information about. Custom vocabulary names are case sensitive.

Returns:

• (Types::GetVocabularyResponse) —

  Returns a response object which responds to the following methods:

  • #vocabulary_name => String
  • #language_code => String
  • #vocabulary_state => String
  • #last_modified_time => Time
  • #failure_reason => String
  • #download_uri => String

# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/waiters.rb', line 381

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