Class DescribeStreamRequest
- All Implemented Interfaces:
ReadLimitInfo
,Serializable
,Cloneable
Represents the input of a DescribeStream operation.
- See Also:
-
Field Summary
Fields inherited from class com.amazonaws.AmazonWebServiceRequest
NOOP
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionclone()
Creates a shallow clone of this request.boolean
The shard ID of the first item that this operation will evaluate.getLimit()
The maximum number of shard objects to return.The Amazon Resource Name (ARN) for the stream.int
hashCode()
void
setExclusiveStartShardId
(String exclusiveStartShardId) The shard ID of the first item that this operation will evaluate.void
The maximum number of shard objects to return.void
setStreamArn
(String streamArn) The Amazon Resource Name (ARN) for the stream.toString()
Returns a string representation of this object; useful for testing and debugging.withExclusiveStartShardId
(String exclusiveStartShardId) The shard ID of the first item that this operation will evaluate.The maximum number of shard objects to return.withStreamArn
(String streamArn) The Amazon Resource Name (ARN) for the stream.Methods inherited from class com.amazonaws.AmazonWebServiceRequest
copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
-
Constructor Details
-
DescribeStreamRequest
public DescribeStreamRequest()
-
-
Method Details
-
setStreamArn
The Amazon Resource Name (ARN) for the stream.
- Parameters:
streamArn
- The Amazon Resource Name (ARN) for the stream.
-
getStreamArn
The Amazon Resource Name (ARN) for the stream.
- Returns:
- The Amazon Resource Name (ARN) for the stream.
-
withStreamArn
The Amazon Resource Name (ARN) for the stream.
- Parameters:
streamArn
- The Amazon Resource Name (ARN) for the stream.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setLimit
The maximum number of shard objects to return. The upper limit is 100.
- Parameters:
limit
- The maximum number of shard objects to return. The upper limit is 100.
-
getLimit
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.
-
withLimit
The maximum number of shard objects to return. The upper limit is 100.
- Parameters:
limit
- The maximum number of shard objects to return. The upper limit is 100.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setExclusiveStartShardId
The shard ID of the first item that this operation will evaluate. Use the value that was returned for
LastEvaluatedShardId
in the previous operation.- Parameters:
exclusiveStartShardId
- The shard ID of the first item that this operation will evaluate. Use the value that was returned forLastEvaluatedShardId
in the previous operation.
-
getExclusiveStartShardId
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.
-
withExclusiveStartShardId
The shard ID of the first item that this operation will evaluate. Use the value that was returned for
LastEvaluatedShardId
in the previous operation.- Parameters:
exclusiveStartShardId
- The shard ID of the first item that this operation will evaluate. Use the value that was returned forLastEvaluatedShardId
in the previous operation.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
toString
Returns a string representation of this object; useful for testing and debugging. -
equals
-
hashCode
public int hashCode() -
clone
Description copied from class:AmazonWebServiceRequest
Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.- Overrides:
clone
in classAmazonWebServiceRequest
- See Also:
-