Class: Aws::MediaPackageV2::Waiters::HarvestJobFinished

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options) ⇒ HarvestJobFinished

Returns a new instance of HarvestJobFinished.

Parameters:

  • options (Hash)

Options Hash (options):

  • :client (required, Client)
  • :max_attempts (Integer) — default: 60
  • :delay (Integer) — default: 2
  • :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
114
115
116
117
118
119
120
121
122
123
124
125
 
# File 'lib/aws-sdk-mediapackagev2/waiters.rb', line 84

def initialize(options)
  @client = options.fetch(:client)
  @waiter = Aws::Waiters::Waiter.new({
    max_attempts: 60,
    delay: 2,
    poller: Aws::Waiters::Poller.new(
      operation_name: :get_harvest_job,
      acceptors: [
        {
          "matcher" => "path",
          "argument" => "status",
          "state" => "success",
          "expected" => "COMPLETED"
        },
        {
          "matcher" => "path",
          "argument" => "status",
          "state" => "success",
          "expected" => "CANCELLED"
        },
        {
          "matcher" => "path",
          "argument" => "status",
          "state" => "failure",
          "expected" => "FAILED"
        },
        {
          "matcher" => "path",
          "argument" => "status",
          "state" => "retry",
          "expected" => "QUEUED"
        },
        {
          "matcher" => "path",
          "argument" => "status",
          "state" => "retry",
          "expected" => "IN_PROGRESS"
        }
      ]
    )
  }.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. 



134
135
136
 
# File 'lib/aws-sdk-mediapackagev2/waiters.rb', line 134

def waiter
  @waiter
end

Instance Method Details

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

Returns a response object which responds to the following methods:

Options Hash (params):

  • :channel_group_name (required, String) —

    The name of the channel group containing the channel associated with the harvest job.

  • :channel_name (required, String) —

    The name of the channel associated with the harvest job.

  • :origin_endpoint_name (required, String) —

    The name of the origin endpoint associated with the harvest job.

  • :harvest_job_name (required, String) —

    The name of the harvest job to retrieve.

Returns:



129
130
131
 
# File 'lib/aws-sdk-mediapackagev2/waiters.rb', line 129

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