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

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

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)


84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
# File 'gems/aws-sdk-elastictranscoder/lib/aws-sdk-elastictranscoder/waiters.rb', line 84

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 Method Details

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

Returns a response object which responds to the following methods:

  • #job => Types::Job

Parameters:

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

    a customizable set of options

Options Hash (params):

  • :id (required, String)

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

Returns:



117
118
119
# File 'gems/aws-sdk-elastictranscoder/lib/aws-sdk-elastictranscoder/waiters.rb', line 117

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