Class DescribeStreamRequest
- java.lang.Object
-
- software.amazon.awssdk.core.SdkRequest
-
- software.amazon.awssdk.awscore.AwsRequest
-
- software.amazon.awssdk.services.kinesis.model.KinesisRequest
-
- software.amazon.awssdk.services.kinesis.model.DescribeStreamRequest
-
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<DescribeStreamRequest.Builder,DescribeStreamRequest>
@Generated("software.amazon.awssdk:codegen") public final class DescribeStreamRequest extends KinesisRequest implements ToCopyableBuilder<DescribeStreamRequest.Builder,DescribeStreamRequest>
Represents the input for
DescribeStream
.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
DescribeStreamRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method 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
streamARN()
The ARN of the stream.String
streamName()
The name of the stream to describe.DescribeStreamRequest.Builder
toBuilder()
String
toString()
Returns a string representation of this object.-
Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
streamName
public final String streamName()
The name of the stream to describe.
- Returns:
- The name of the stream to describe.
-
limit
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.
- Returns:
- 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.
-
exclusiveStartShardId
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.- Returns:
- 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.
-
streamARN
public final String streamARN()
The ARN of the stream.
- Returns:
- The ARN of the stream.
-
toBuilder
public DescribeStreamRequest.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<DescribeStreamRequest.Builder,DescribeStreamRequest>
- Specified by:
toBuilder
in classKinesisRequest
-
builder
public static DescribeStreamRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends DescribeStreamRequest.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCode
in classAwsRequest
-
equals
public final boolean equals(Object obj)
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in interfaceSdkPojo
-
toString
public final String toString()
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForField
in classSdkRequest
-
-