Class: Aws::CodeGuruReviewer::Waiters::CodeReviewCompleted

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

Overview

Wait until a code review is complete.

Instance Method Summary collapse

Constructor Details

#initialize(options) ⇒ CodeReviewCompleted

Returns a new instance of CodeReviewCompleted.

Parameters:

  • options (Hash)

Options Hash (options):

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


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

def initialize(options)
  @client = options.fetch(:client)
  @waiter = Aws::Waiters::Waiter.new({
    max_attempts: 180,
    delay: 10,
    poller: Aws::Waiters::Poller.new(
      operation_name: :describe_code_review,
      acceptors: [
        {
          "state" => "success",
          "matcher" => "path",
          "argument" => "code_review.state",
          "expected" => "Completed"
        },
        {
          "state" => "failure",
          "matcher" => "path",
          "argument" => "code_review.state",
          "expected" => "Failed"
        },
        {
          "state" => "retry",
          "matcher" => "path",
          "argument" => "code_review.state",
          "expected" => "Pending"
        }
      ]
    )
  }.merge(options))
end

Instance Method Details

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

Returns a response object which responds to the following methods:

Parameters:

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

    a customizable set of options

Options Hash (params):

  • :code_review_arn (required, String)

    The Amazon Resource Name (ARN) of the CodeReview object.

Returns:



119
120
121
# File 'gems/aws-sdk-codegurureviewer/lib/aws-sdk-codegurureviewer/waiters.rb', line 119

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