Class: Aws::TranscribeService::Waiters::TranscriptionJobCompleted

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options) ⇒ TranscriptionJobCompleted

Returns a new instance of TranscriptionJobCompleted.

Parameters:

  • options (Hash)

Options Hash (options):

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


310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
 
# File 'lib/aws-sdk-transcribeservice/waiters.rb', line 310

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_transcription_job,
      acceptors: [
        {
          "state" => "success",
          "matcher" => "path",
          "argument" => "transcription_job.transcription_job_status",
          "expected" => "COMPLETED"
        },
        {
          "state" => "failure",
          "matcher" => "path",
          "argument" => "transcription_job.transcription_job_status",
          "expected" => "FAILED"
        }
      ]
    )
  }.merge(options))
end

Instance Attribute Details

#waiter ⇒ Object (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. 



342
343
344
 
# File 'lib/aws-sdk-transcribeservice/waiters.rb', line 342

def waiter
  @waiter
end

Instance Method Details

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

Returns a response object which responds to the following methods:

Options Hash (params):

  • :transcription_job_name (required, String) —

    The name of the transcription job you want information about. Job names are case sensitive.

Returns:



337
338
339
 
# File 'lib/aws-sdk-transcribeservice/waiters.rb', line 337

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