Class: Aws::ElasticTranscoder::Waiters::JobComplete

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options) ⇒ JobComplete

Returns a new instance of JobComplete.

Parameters:

  • options (Hash)

Options Hash (options):

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


21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
 
# File 'lib/aws-sdk-elastictranscoder/waiters.rb', line 21

def initialize(options)
  @client = options.fetch(:client)
  @waiter = Aws::Waiters::Waiter.new({
    max_attempts: 120,
    delay: 30,
    poller: Aws::Waiters::Poller.new(
      operation_name: :read_job,
      acceptors: [
        {
          "expected" => "Complete",
          "matcher" => "path",
          "state" => "success",
          "argument" => "job.status"
        },
        {
          "expected" => "Canceled",
          "matcher" => "path",
          "state" => "failure",
          "argument" => "job.status"
        },
        {
          "expected" => "Error",
          "matcher" => "path",
          "state" => "failure",
          "argument" => "job.status"
        }
      ]
    )
  }.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. 



59
60
61
 
# File 'lib/aws-sdk-elastictranscoder/waiters.rb', line 59

def waiter
  @waiter
end

Instance Method Details

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

Returns a response object which responds to the following methods:

  • #job => Types::Job

Options Hash (params):

  • :id (required, String) —

    The identifier of the job for which you want to get detailed information.

Returns:



54
55
56
 
# File 'lib/aws-sdk-elastictranscoder/waiters.rb', line 54

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