Package software.amazon.awssdk.services.dynamodb.model

Class DescribeStreamRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.dynamodb.model.DynamoDbStreamsRequest

software.amazon.awssdk.services.dynamodb.model.DescribeStreamRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeStreamRequest.Builder,DescribeStreamRequest>

@Generated("software.amazon.awssdk:codegen")
public final class DescribeStreamRequest
extends DynamoDbStreamsRequest
implements ToCopyableBuilder<DescribeStreamRequest.Builder,DescribeStreamRequest>

Represents the input of a DescribeStream operation.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DescribeStreamRequest.Builder

Method Summary

Modifier and Type	Method	Description
static DescribeStreamRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	exclusiveStartShardId()	The shard ID of the first item that this operation will evaluate.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Integer	limit()	The maximum number of shard objects to return.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeStreamRequest.Builder>	serializableBuilderClass()
ShardFilter	shardFilter()	This optional field contains the filter definition for the DescribeStream API.
String	streamArn()	The Amazon Resource Name (ARN) for the stream.
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

streamArn

public final String streamArn()

The Amazon Resource Name (ARN) for the stream.

Returns:

The Amazon Resource Name (ARN) for the stream.

limit

public final Integer limit()

The maximum number of shard objects to return. The upper limit is 100.

Returns:

The maximum number of shard objects to return. The upper limit is 100.

exclusiveStartShardId

public final String exclusiveStartShardId()

The shard ID of the first item that this operation will evaluate. Use the value that was returned for LastEvaluatedShardId in the previous operation.

Returns:

The shard ID of the first item that this operation will evaluate. Use the value that was returned for LastEvaluatedShardId in the previous operation.

shardFilter

public final ShardFilter shardFilter()

This optional field contains the filter definition for the DescribeStream API.

Returns:

This optional field contains the filter definition for the DescribeStream API.

toBuilder

public DescribeStreamRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeStreamRequest.Builder,DescribeStreamRequest>

Specified by:

toBuilder in class DynamoDbStreamsRequest

builder

public static DescribeStreamRequest.Builder builder()

serializableBuilderClass

public static Class<? extends DescribeStreamRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

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.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo