Package software.amazon.awssdk.services.kinesis.model

Class DescribeStreamRequest

java.lang.Object

software.amazon.awssdk.AmazonWebServiceRequest

software.amazon.awssdk.services.kinesis.model.DescribeStreamRequest

All Implemented Interfaces:

Cloneable, ReadLimitInfo, ToCopyableBuilder<DescribeStreamRequest.Builder,DescribeStreamRequest>

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

Represents the input for DescribeStream.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DescribeStreamRequest.Builder

Field Summary

Fields inherited from class software.amazon.awssdk.AmazonWebServiceRequest

NOOP

Method Summary

Modifier and Type	Method	Description
static DescribeStreamRequest.Builder	builder()
boolean	equals(Object obj)
String	exclusiveStartShardId()	The shard ID of the shard to start with.
int	hashCode()
Integer	limit()	The maximum number of shards to return in a single call.
static Class<? extends DescribeStreamRequest.Builder>	serializableBuilderClass()
String	streamName()	The name of the stream to describe.
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.AmazonWebServiceRequest

clone, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

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>

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