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

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

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)


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

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

#wait(params = {}) ⇒ Struct

Returns an empty response.

Parameters:

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

    a customizable set of options

Options Hash (params):

  • :bucket (required, String)

    The bucket name.

Returns:

  • (Struct)

    Returns an empty response.



122
123
124
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/waiters.rb', line 122

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