Class: Aws::Kinesis::Waiters::StreamExists

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

Instance Method Summary collapse

Constructor Details

#initialize(options) ⇒ StreamExists

Returns a new instance of StreamExists.

Parameters:

  • options (Hash)

Options Hash (options):

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


148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
 
# File 'gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/waiters.rb', line 148

def initialize(options)
  @client = options.fetch(:client)
  @waiter = Aws::Waiters::Waiter.new({
    max_attempts: 18,
    delay: 10,
    poller: Aws::Waiters::Poller.new(
      operation_name: :describe_stream,
      acceptors: [{
        "expected" => "ACTIVE",
        "matcher" => "path",
        "state" => "success",
        "argument" => "stream_description.stream_status"
      }]
    )
  }.merge(options))
end

Instance Method Details

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

Returns a response object which responds to the following methods:

Parameters:

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

    a customizable set of options

Options Hash (params):

  • :stream_name (String) —

    The name of the stream to describe.

  • :limit (Integer) —

    The maximum number of shards to return in a single call. The default value is 100. If you specify a value greater than 100, at most 100 results are returned.

  • :exclusive_start_shard_id (String) —

    The shard ID of the shard to start with.

    Specify this parameter to indicate that you want to describe the stream starting with the shard whose ID immediately follows ExclusiveStartShardId.

    If you don't specify this parameter, the default behavior for DescribeStream is to describe the stream starting with the first shard in the stream.

  • :stream_arn (String) —

    The ARN of the stream.

  • :stream_id (String) —

    Not Implemented. Reserved for future use.

Returns:



167
168
169
 
# File 'gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/waiters.rb', line 167

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