software.amazon.awssdk.services.kinesis.model

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(value="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 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 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.

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 String streamName()

The name of the stream to describe.

Returns:

The name of the stream to describe.

limit

public 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 shards 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 shards are returned.

exclusiveStartShardId

public String exclusiveStartShardId()

The shard ID of the shard to start with.

Returns:

The shard ID of the shard to start with.

toBuilder

public DescribeStreamRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeStreamRequest.Builder,DescribeStreamRequest>

Specified by:

toBuilder in class KinesisRequest

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()

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 <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo