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

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

Instance Attribute Summary collapse

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) 


85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/aws-sdk-kinesis/waiters.rb', line 85

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 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. 



109
110
111
 
# File 'lib/aws-sdk-kinesis/waiters.rb', line 109

def waiter
  @waiter
end

Instance Method Details

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

Returns a response object which responds to the following methods:

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.

Returns:



104
105
106
 
# File 'lib/aws-sdk-kinesis/waiters.rb', line 104

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