@Generated(value="software.amazon.awssdk:codegen") public final class DescribeStreamRequest extends KinesisRequest implements ToCopyableBuilder<DescribeStreamRequest.Builder,DescribeStreamRequest>
Represents the input for DescribeStream.
| Modifier and Type | Class and Description |
|---|---|
static interface |
DescribeStreamRequest.Builder |
| Modifier and Type | Method and Description |
|---|---|
static DescribeStreamRequest.Builder |
builder() |
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj) |
String |
exclusiveStartShardId()
The shard ID of the shard to start with.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
Integer |
limit()
The maximum number of shards to return in a single call.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends DescribeStreamRequest.Builder> |
serializableBuilderClass() |
String |
streamName()
The name of the stream to describe.
|
DescribeStreamRequest.Builder |
toBuilder() |
String |
toString()
Returns a string representation of this object.
|
overrideConfigurationclone, finalize, getClass, notify, notifyAll, wait, wait, waitcopypublic final String streamName()
The name of the stream to describe.
public final Integer limit()
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.
public final String exclusiveStartShardId()
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.
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.
public DescribeStreamRequest.Builder toBuilder()
toBuilder in interface ToCopyableBuilder<DescribeStreamRequest.Builder,DescribeStreamRequest>toBuilder in class KinesisRequestpublic static DescribeStreamRequest.Builder builder()
public static Class<? extends DescribeStreamRequest.Builder> serializableBuilderClass()
public final int hashCode()
hashCode in class AwsRequestpublic final boolean equals(Object obj)
equals in class AwsRequestpublic final boolean equalsBySdkFields(Object obj)
equalsBySdkFields in interface SdkPojopublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
getValueForField in class SdkRequestCopyright © 2022. All rights reserved.