class
Amazonite::Kinesis::DescribeStreamInput
- Amazonite::Kinesis::DescribeStreamInput
- Reference
- Object
Overview
Represents the input for DescribeStream.
Included Modules
- JSON::Serializable
Defined in:
kinesis/describe_stream_input.crConstructors
- .new(pull : JSON::PullParser)
- .new(stream_name : String | Nil = nil, limit : Int32 | Nil = nil, exclusive_start_shard_id : String | Nil = nil, stream_arn : String | Nil = nil, stream_id : String | Nil = nil)
Instance Method Summary
-
#==(other : self)
Returns
trueif this reference is the same as other. -
#exclusive_start_shard_id : String | Nil
The shard ID of the shard to start with.
-
#exclusive_start_shard_id=(exclusive_start_shard_id : String | Nil)
The shard ID of the shard to start with.
-
#hash(hasher)
See
Object#hash(hasher) -
#limit : Int32 | Nil
The maximum number of shards to return in a single call.
-
#limit=(limit : Int32 | Nil)
The maximum number of shards to return in a single call.
-
#stream_arn : String | Nil
The ARN of the stream.
-
#stream_arn=(stream_arn : String | Nil)
The ARN of the stream.
-
#stream_id : String | Nil
Not Implemented.
-
#stream_id=(stream_id : String | Nil)
Not Implemented.
-
#stream_name : String | Nil
The name of the stream to describe.
-
#stream_name=(stream_name : String | Nil)
The name of the stream to describe.
- #validate! : Nil
Constructor Detail
Instance Method Detail
Returns true if this reference is the same as other. Invokes same?.
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.
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.
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.
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.