ListShardsRequest (aws-android-sdk-kinesis 2.62.1 API)

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.kinesis.model.ListShardsRequest

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable
```
public class ListShardsRequest
extends com.amazonaws.AmazonWebServiceRequest
implements java.io.Serializable
```
Lists the shards in a stream and provides information about each shard.

This API is a new operation that is used by the Amazon Kinesis Client Library (KCL). If you have a fine-grained IAM policy that only allows specific operations, you must update your policy to allow calls to this API. For more information, see Controlling Access to Amazon Kinesis Data Streams Resources Using IAM.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

ListShardsRequest()

Constructors
Constructor and Description
`ListShardsRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(java.lang.Object obj)`
`java.lang.String`	`getExclusiveStartShardId()` The ID of the shard to start the list with.
`java.lang.Integer`	`getMaxResults()` The maximum number of shards to return in a single call to `ListShards`.
`java.lang.String`	`getNextToken()` When the number of shards in the data stream is greater than the default value for the `MaxResults` parameter, or if you explicitly specify a value for `MaxResults` that is less than the number of shards in the data stream, the response includes a pagination token named `NextToken`.
`java.util.Date`	`getStreamCreationTimestamp()` Specify this input parameter to distinguish data streams that have the same name.
`java.lang.String`	`getStreamName()` The name of the data stream whose shards you want to list.
`int`	`hashCode()`
`void`	`setExclusiveStartShardId(java.lang.String exclusiveStartShardId)` The ID of the shard to start the list with.
`void`	`setMaxResults(java.lang.Integer maxResults)` The maximum number of shards to return in a single call to `ListShards`.
`void`	`setNextToken(java.lang.String nextToken)` When the number of shards in the data stream is greater than the default value for the `MaxResults` parameter, or if you explicitly specify a value for `MaxResults` that is less than the number of shards in the data stream, the response includes a pagination token named `NextToken`.
`void`	`setStreamCreationTimestamp(java.util.Date streamCreationTimestamp)` Specify this input parameter to distinguish data streams that have the same name.
`void`	`setStreamName(java.lang.String streamName)` The name of the data stream whose shards you want to list.
`java.lang.String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`ListShardsRequest`	`withExclusiveStartShardId(java.lang.String exclusiveStartShardId)` The ID of the shard to start the list with.
`ListShardsRequest`	`withMaxResults(java.lang.Integer maxResults)` The maximum number of shards to return in a single call to `ListShards`.
`ListShardsRequest`	`withNextToken(java.lang.String nextToken)` When the number of shards in the data stream is greater than the default value for the `MaxResults` parameter, or if you explicitly specify a value for `MaxResults` that is less than the number of shards in the data stream, the response includes a pagination token named `NextToken`.
`ListShardsRequest`	`withStreamCreationTimestamp(java.util.Date streamCreationTimestamp)` Specify this input parameter to distinguish data streams that have the same name.
`ListShardsRequest`	`withStreamName(java.lang.String streamName)` The name of the data stream whose shards you want to list.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest
clone, copyBaseTo, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - ListShardsRequest
```
public ListShardsRequest()
```
- Method Detail
  - getStreamName
```
public java.lang.String getStreamName()
```
    The name of the data stream whose shards you want to list.
    
    You cannot specify this parameter if you specify the NextToken parameter.
    
    Constraints:
    Length: 1 - 128
    Pattern: [a-zA-Z0-9_.-]+
    
    Returns:
    
    The name of the data stream whose shards you want to list.
    
    You cannot specify this parameter if you specify the NextToken parameter.
  - setStreamName
```
public void setStreamName(java.lang.String streamName)
```
    The name of the data stream whose shards you want to list.
    
    You cannot specify this parameter if you specify the NextToken parameter.
    
    Constraints:
    Length: 1 - 128
    Pattern: [a-zA-Z0-9_.-]+
    
    Parameters:
    
    streamName -
    The name of the data stream whose shards you want to list.
    
    You cannot specify this parameter if you specify the NextToken parameter.
  - withStreamName
```
public ListShardsRequest withStreamName(java.lang.String streamName)
```
    The name of the data stream whose shards you want to list.
    
    You cannot specify this parameter if you specify the NextToken parameter.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 - 128
    Pattern: [a-zA-Z0-9_.-]+
    
    Parameters:
    
    streamName -
    The name of the data stream whose shards you want to list.
    
    You cannot specify this parameter if you specify the NextToken parameter.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getNextToken
```
public java.lang.String getNextToken()
```
    When the number of shards in the data stream is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of shards in the data stream, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListShards to list the next set of shards.
    
    Don't specify StreamName or StreamCreationTimestamp if you specify NextToken because the latter unambiguously identifies the stream.
    
    You can optionally specify a value for the MaxResults parameter when you specify NextToken. If you specify a MaxResults value that is less than the number of shards that the operation returns if you don't specify MaxResults, the response will contain a new NextToken value. You can use the new NextToken value in a subsequent call to the ListShards operation.
    
    Tokens expire after 300 seconds. When you obtain a value for NextToken in the response to a call to ListShards, you have 300 seconds to use that value. If you specify an expired token in a call to ListShards, you get ExpiredNextTokenException.
    
    Constraints:
    Length: 1 - 1048576
    
    Returns:
    
    When the number of shards in the data stream is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of shards in the data stream, the response includes a pagination token named NextToken . You can specify this NextToken value in a subsequent call to ListShards to list the next set of shards.
    
    Don't specify StreamName or StreamCreationTimestamp if you specify NextToken because the latter unambiguously identifies the stream.
    
    You can optionally specify a value for the MaxResults parameter when you specify NextToken. If you specify a MaxResults value that is less than the number of shards that the operation returns if you don't specify MaxResults, the response will contain a new NextToken value. You can use the new NextToken value in a subsequent call to the ListShards operation.
    
    Tokens expire after 300 seconds. When you obtain a value for NextToken in the response to a call to ListShards, you have 300 seconds to use that value. If you specify an expired token in a call to ListShards, you get ExpiredNextTokenException.
  - setNextToken
```
public void setNextToken(java.lang.String nextToken)
```
    When the number of shards in the data stream is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of shards in the data stream, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListShards to list the next set of shards.
    
    Don't specify StreamName or StreamCreationTimestamp if you specify NextToken because the latter unambiguously identifies the stream.
    
    You can optionally specify a value for the MaxResults parameter when you specify NextToken. If you specify a MaxResults value that is less than the number of shards that the operation returns if you don't specify MaxResults, the response will contain a new NextToken value. You can use the new NextToken value in a subsequent call to the ListShards operation.
    
    Tokens expire after 300 seconds. When you obtain a value for NextToken in the response to a call to ListShards, you have 300 seconds to use that value. If you specify an expired token in a call to ListShards, you get ExpiredNextTokenException.
    
    Constraints:
    Length: 1 - 1048576
    
    Parameters:
    
    nextToken -
    When the number of shards in the data stream is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of shards in the data stream, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListShards to list the next set of shards.
    
    Don't specify StreamName or StreamCreationTimestamp if you specify NextToken because the latter unambiguously identifies the stream.
    
    You can optionally specify a value for the MaxResults parameter when you specify NextToken. If you specify a MaxResults value that is less than the number of shards that the operation returns if you don't specify MaxResults, the response will contain a new NextToken value. You can use the new NextToken value in a subsequent call to the ListShards operation.
    
    Tokens expire after 300 seconds. When you obtain a value for NextToken in the response to a call to ListShards, you have 300 seconds to use that value. If you specify an expired token in a call to ListShards, you get ExpiredNextTokenException.
  - withNextToken
```
public ListShardsRequest withNextToken(java.lang.String nextToken)
```
    When the number of shards in the data stream is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of shards in the data stream, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListShards to list the next set of shards.
    
    Don't specify StreamName or StreamCreationTimestamp if you specify NextToken because the latter unambiguously identifies the stream.
    
    You can optionally specify a value for the MaxResults parameter when you specify NextToken. If you specify a MaxResults value that is less than the number of shards that the operation returns if you don't specify MaxResults, the response will contain a new NextToken value. You can use the new NextToken value in a subsequent call to the ListShards operation.
    
    Tokens expire after 300 seconds. When you obtain a value for NextToken in the response to a call to ListShards, you have 300 seconds to use that value. If you specify an expired token in a call to ListShards, you get ExpiredNextTokenException.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 - 1048576
    
    Parameters:
    
    nextToken -
    When the number of shards in the data stream is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of shards in the data stream, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListShards to list the next set of shards.
    
    Don't specify StreamName or StreamCreationTimestamp if you specify NextToken because the latter unambiguously identifies the stream.
    
    You can optionally specify a value for the MaxResults parameter when you specify NextToken. If you specify a MaxResults value that is less than the number of shards that the operation returns if you don't specify MaxResults, the response will contain a new NextToken value. You can use the new NextToken value in a subsequent call to the ListShards operation.
    
    Tokens expire after 300 seconds. When you obtain a value for NextToken in the response to a call to ListShards, you have 300 seconds to use that value. If you specify an expired token in a call to ListShards, you get ExpiredNextTokenException.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getExclusiveStartShardId
```
public java.lang.String getExclusiveStartShardId()
```
    The ID of the shard to start the list with.
    
    If you don't specify this parameter, the default behavior is for ListShards to list the shards starting with the first one in the stream.
    
    You cannot specify this parameter if you specify NextToken.
    
    Constraints:
    Length: 1 - 128
    Pattern: [a-zA-Z0-9_.-]+
    
    Returns:
    
    The ID of the shard to start the list with.
    
    If you don't specify this parameter, the default behavior is for ListShards to list the shards starting with the first one in the stream.
    
    You cannot specify this parameter if you specify NextToken.
  - setExclusiveStartShardId
```
public void setExclusiveStartShardId(java.lang.String exclusiveStartShardId)
```
    The ID of the shard to start the list with.
    
    If you don't specify this parameter, the default behavior is for ListShards to list the shards starting with the first one in the stream.
    
    You cannot specify this parameter if you specify NextToken.
    
    Constraints:
    Length: 1 - 128
    Pattern: [a-zA-Z0-9_.-]+
    
    Parameters:
    
    exclusiveStartShardId -
    The ID of the shard to start the list with.
    
    If you don't specify this parameter, the default behavior is for ListShards to list the shards starting with the first one in the stream.
    
    You cannot specify this parameter if you specify NextToken.
  - withExclusiveStartShardId
```
public ListShardsRequest withExclusiveStartShardId(java.lang.String exclusiveStartShardId)
```
    The ID of the shard to start the list with.
    
    If you don't specify this parameter, the default behavior is for ListShards to list the shards starting with the first one in the stream.
    
    You cannot specify this parameter if you specify NextToken.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 - 128
    Pattern: [a-zA-Z0-9_.-]+
    
    Parameters:
    
    exclusiveStartShardId -
    The ID of the shard to start the list with.
    
    If you don't specify this parameter, the default behavior is for ListShards to list the shards starting with the first one in the stream.
    
    You cannot specify this parameter if you specify NextToken.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getMaxResults
```
public java.lang.Integer getMaxResults()
```
    The maximum number of shards to return in a single call to ListShards. The minimum value you can specify for this parameter is 1, and the maximum is 1,000, which is also the default.
    
    When the number of shards to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to ListShards to list the next set of shards.
    
    Constraints:
    Range: 1 - 10000
    
    Returns:
    
    The maximum number of shards to return in a single call to ListShards. The minimum value you can specify for this parameter is 1, and the maximum is 1,000, which is also the default.
    
    When the number of shards to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to ListShards to list the next set of shards.
  - setMaxResults
```
public void setMaxResults(java.lang.Integer maxResults)
```
    The maximum number of shards to return in a single call to ListShards. The minimum value you can specify for this parameter is 1, and the maximum is 1,000, which is also the default.
    
    When the number of shards to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to ListShards to list the next set of shards.
    
    Constraints:
    Range: 1 - 10000
    
    Parameters:
    
    maxResults -
    The maximum number of shards to return in a single call to ListShards. The minimum value you can specify for this parameter is 1, and the maximum is 1,000, which is also the default.
    
    When the number of shards to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to ListShards to list the next set of shards.
  - withMaxResults
```
public ListShardsRequest withMaxResults(java.lang.Integer maxResults)
```
    The maximum number of shards to return in a single call to ListShards. The minimum value you can specify for this parameter is 1, and the maximum is 1,000, which is also the default.
    
    When the number of shards to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to ListShards to list the next set of shards.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Range: 1 - 10000
    
    Parameters:
    
    maxResults -
    The maximum number of shards to return in a single call to ListShards. The minimum value you can specify for this parameter is 1, and the maximum is 1,000, which is also the default.
    
    When the number of shards to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to ListShards to list the next set of shards.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getStreamCreationTimestamp
```
public java.util.Date getStreamCreationTimestamp()
```
    Specify this input parameter to distinguish data streams that have the same name. For example, if you create a data stream and then delete it, and you later create another data stream with the same name, you can use this input parameter to specify which of the two streams you want to list the shards for.
    
    You cannot specify this parameter if you specify the NextToken parameter.
    
    Returns:
    
    Specify this input parameter to distinguish data streams that have the same name. For example, if you create a data stream and then delete it, and you later create another data stream with the same name, you can use this input parameter to specify which of the two streams you want to list the shards for.
    
    You cannot specify this parameter if you specify the NextToken parameter.
  - setStreamCreationTimestamp
```
public void setStreamCreationTimestamp(java.util.Date streamCreationTimestamp)
```
    Specify this input parameter to distinguish data streams that have the same name. For example, if you create a data stream and then delete it, and you later create another data stream with the same name, you can use this input parameter to specify which of the two streams you want to list the shards for.
    
    You cannot specify this parameter if you specify the NextToken parameter.
    
    Parameters:
    
    streamCreationTimestamp -
    Specify this input parameter to distinguish data streams that have the same name. For example, if you create a data stream and then delete it, and you later create another data stream with the same name, you can use this input parameter to specify which of the two streams you want to list the shards for.
    
    You cannot specify this parameter if you specify the NextToken parameter.
  - withStreamCreationTimestamp
```
public ListShardsRequest withStreamCreationTimestamp(java.util.Date streamCreationTimestamp)
```
    Specify this input parameter to distinguish data streams that have the same name. For example, if you create a data stream and then delete it, and you later create another data stream with the same name, you can use this input parameter to specify which of the two streams you want to list the shards for.
    
    You cannot specify this parameter if you specify the NextToken parameter.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    streamCreationTimestamp -
    Specify this input parameter to distinguish data streams that have the same name. For example, if you create a data stream and then delete it, and you later create another data stream with the same name, you can use this input parameter to specify which of the two streams you want to list the shards for.
    
    You cannot specify this parameter if you specify the NextToken parameter.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - toString
```
public java.lang.String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object

Class ListShardsRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

ListShardsRequest

Method Detail

getStreamName

setStreamName

withStreamName

getNextToken

setNextToken

withNextToken

getExclusiveStartShardId

setExclusiveStartShardId

withExclusiveStartShardId

getMaxResults

setMaxResults

withMaxResults

getStreamCreationTimestamp

setStreamCreationTimestamp

withStreamCreationTimestamp

toString

hashCode

equals