com.amazonaws.services.kinesis.model

Class DescribeStreamRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.kinesis.model.DescribeStreamRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class DescribeStreamRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Represents the input for DescribeStream.

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
DescribeStreamRequest()

Method Summary

Modifier and Type	Method and Description
DescribeStreamRequest	clone()
boolean	equals(Object obj)
String	getExclusiveStartShardId() The shard ID of the shard to start with.
Integer	getLimit() The maximum number of shards to return in a single call.
String	getStreamARN() The ARN of the stream.
String	getStreamName() The name of the stream to describe.
int	hashCode()
void	setExclusiveStartShardId(String exclusiveStartShardId) The shard ID of the shard to start with.
void	setLimit(Integer limit) The maximum number of shards to return in a single call.
void	setStreamARN(String streamARN) The ARN of the stream.
void	setStreamName(String streamName) The name of the stream to describe.
String	toString() Returns a string representation of this object.
DescribeStreamRequest	withExclusiveStartShardId(String exclusiveStartShardId) The shard ID of the shard to start with.
DescribeStreamRequest	withLimit(Integer limit) The maximum number of shards to return in a single call.
DescribeStreamRequest	withStreamARN(String streamARN) The ARN of the stream.
DescribeStreamRequest	withStreamName(String streamName) The name of the stream to describe.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DescribeStreamRequest

public DescribeStreamRequest()

Method Detail

setStreamName

public void setStreamName(String streamName)

The name of the stream to describe.

Parameters:

streamName - The name of the stream to describe.

getStreamName

public String getStreamName()

The name of the stream to describe.

Returns:

The name of the stream to describe.

withStreamName

public DescribeStreamRequest withStreamName(String streamName)

The name of the stream to describe.

Parameters:

streamName - The name of the stream to describe.

Returns:

Returns a reference to this object so that method calls can be chained together.

setLimit

public void setLimit(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.

Parameters:

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.

getLimit

public Integer getLimit()

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.

withLimit

public DescribeStreamRequest withLimit(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

setExclusiveStartShardId

public void setExclusiveStartShardId(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.

Parameters:

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.

getExclusiveStartShardId

public String getExclusiveStartShardId()

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.

withExclusiveStartShardId

public DescribeStreamRequest withExclusiveStartShardId(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

setStreamARN

public void setStreamARN(String streamARN)

The ARN of the stream.

Parameters:

streamARN - The ARN of the stream.

getStreamARN

public String getStreamARN()

The ARN of the stream.

Returns:

The ARN of the stream.

withStreamARN

public DescribeStreamRequest withStreamARN(String streamARN)

The ARN of the stream.

Parameters:

streamARN - The ARN of the stream.

Returns:

Returns a reference to this object so that method calls can be chained together.

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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public DescribeStreamRequest clone()

Overrides:

clone in class AmazonWebServiceRequest