ListShardsRequest (AWS SDK for Java

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.ListShardsRequest

All Implemented Interfaces:: ToCopyableBuilder<ListShardsRequest.Builder,ListShardsRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class ListShardsRequest
extends KinesisRequest
implements ToCopyableBuilder<ListShardsRequest.Builder,ListShardsRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface ListShardsRequest.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`ListShardsRequest.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static ListShardsRequest.Builder`	`builder()`
`boolean`	`equals(Object obj)`
`String`	`exclusiveStartShardId()` Specify this parameter to indicate that you want to list the shards starting with the shard whose ID immediately follows `ExclusiveStartShardId`.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)` Used to retrieve the value of a field from any class that extends `SdkRequest`.
`int`	`hashCode()`
`Integer`	`maxResults()` The maximum number of shards to return in a single call to `ListShards`.
`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`.
`static Class<? extends ListShardsRequest.Builder>`	`serializableBuilderClass()`
`Instant`	`streamCreationTimestamp()` Specify this input parameter to distinguish data streams that have the same name.
`String`	`streamName()` The name of the data stream whose shards you want to list.
`ListShardsRequest.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.awscore.AwsRequest
overrideConfiguration

Methods inherited from class java.lang.Object
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 data stream whose shards you want to list.
    
    You cannot specify this parameter if you specify the NextToken parameter.
    
    Returns:
    
    The name of the data stream whose shards you want to list.
    
    You cannot specify this parameter if you specify the NextToken parameter.
  - nextToken
```
public 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:
    
    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.
  - exclusiveStartShardId
```
public String exclusiveStartShardId()
```
    Specify this parameter to indicate that you want to list the shards starting with the shard whose ID immediately follows ExclusiveStartShardId.
    
    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:
    
    Specify this parameter to indicate that you want to list the shards starting with the shard whose ID immediately follows ExclusiveStartShardId.
    
    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.
  - maxResults
```
public 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:
    
    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.
  - streamCreationTimestamp
```
public Instant 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:
    
    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.
  - toBuilder
```
public ListShardsRequest.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<ListShardsRequest.Builder,ListShardsRequest>
    
    Specified by:
    
    toBuilder in class KinesisRequest
    
    Returns:
    
    a builder for type T
  - builder
```
public static ListShardsRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends ListShardsRequest.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
  - getValueForField
```
public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
    Description copied from class: SdkRequest
    
    Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
    
    Overrides:
    
    getValueForField in class SdkRequest
    
    Parameters:
    
    fieldName - The name of the member to be retrieved.
    
    clazz - The class to cast the returned object to.
    
    Returns:
    
    Optional containing the casted return value

Class ListShardsRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

streamName

nextToken

exclusiveStartShardId

maxResults

streamCreationTimestamp

toBuilder

builder

serializableBuilderClass

hashCode

equals

toString

getValueForField