Class: Aws::AbuseSignal::Waiters::ReportProcessing

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

Overview

Wait until an abuse report has at least reached PROCESSING.

A report advances QUEUED -> PROCESSING -> COMPLETED. A report can go from QUEUED all the way to COMPLETED in well under a second, so a poller that only accepts PROCESSING can miss the transient PROCESSING window entirely and then poll forever. COMPLETED therefore also satisfies this waiter: it implies the report already passed through PROCESSING.

Instance Method Summary collapse

Constructor Details

#initialize(options) ⇒ ReportProcessing

Returns a new instance of ReportProcessing.

Parameters:

  • options (Hash)

Options Hash (options):

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


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
# File 'gems/aws-sdk-abusesignal/lib/aws-sdk-abusesignal/waiters.rb', line 92

def initialize(options)
  @client = options.fetch(:client)
  @waiter = Aws::Waiters::Waiter.new({
    max_attempts: 5,
    delay: 1,
    poller: Aws::Waiters::Poller.new(
      operation_name: :get_abuse_report_status,
      acceptors: [
        {
          "matcher" => "path",
          "argument" => "status",
          "state" => "success",
          "expected" => "PROCESSING"
        },
        {
          "matcher" => "path",
          "argument" => "status",
          "state" => "success",
          "expected" => "COMPLETED"
        },
        {
          "matcher" => "error",
          "state" => "retry",
          "expected" => "ResourceNotFoundException"
        }
      ]
    )
  }.merge(options))
end

Instance Method Details

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

Returns a response object which responds to the following methods:

Parameters:

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

    a customizable set of options

Options Hash (params):

  • :report_id (required, String) —

    The unique identifier of the abuse report to retrieve status for. This is the reportId that is returned by CreateAbuseReport.

Returns:



124
125
126
# File 'gems/aws-sdk-abusesignal/lib/aws-sdk-abusesignal/waiters.rb', line 124

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