Class: Aws::S3::Waiters::BucketExists

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options) ⇒ BucketExists

Returns a new instance of BucketExists.

Parameters:

  • options (Hash)

Options Hash (options):

  • :client (required, Client)
  • :max_attempts (Integer) — default: 20
  • :delay (Integer) — default: 5
  • :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
51
52
 
# File 'lib/aws-sdk-s3/waiters.rb', line 21

def initialize(options)
  @client = options.fetch(:client)
  @waiter = Aws::Waiters::Waiter.new({
    max_attempts: 20,
    delay: 5,
    poller: Aws::Waiters::Poller.new(
      operation_name: :head_bucket,
      acceptors: [
        {
          "expected" => 200,
          "matcher" => "status",
          "state" => "success"
        },
        {
          "expected" => 301,
          "matcher" => "status",
          "state" => "success"
        },
        {
          "expected" => 403,
          "matcher" => "status",
          "state" => "success"
        },
        {
          "expected" => 404,
          "matcher" => "status",
          "state" => "retry"
        }
      ]
    )
  }.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. 



61
62
63
 
# File 'lib/aws-sdk-s3/waiters.rb', line 61

def waiter
  @waiter
end

Instance Method Details

#wait(params = {}) ⇒ Struct

Returns an empty response.

Options Hash (params):

  • :bucket (required, String)

Returns:

  • (Struct) —

    Returns an empty response.



56
57
58
 
# File 'lib/aws-sdk-s3/waiters.rb', line 56

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