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(value="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 and Description
static interface	DescribeStreamRequest.Builder

Method Summary

Modifier and Type	Method and Description
static DescribeStreamRequest.Builder	builder()
boolean	equals(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) Used to retrieve the value of a field from any class that extends SdkRequest.
int	hashCode()
Integer	limit() The maximum number of shard objects to return.
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeStreamRequest.Builder>	serializableBuilderClass()
String	streamArn() The Amazon Resource Name (ARN) for the stream.
DescribeStreamRequest.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

streamArn

public String streamArn()

The Amazon Resource Name (ARN) for the stream.

Returns:

The Amazon Resource Name (ARN) for the stream.

limit

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

toBuilder

public DescribeStreamRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeStreamRequest.Builder,DescribeStreamRequest>

Specified by:

toBuilder in class DynamoDbStreamsRequest

Returns:

a builder for type T

builder

public static DescribeStreamRequest.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

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

Description copied from class: SdkRequest

Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkRequest

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.