Class ListShardsResponse
- java.lang.Object
-
- software.amazon.awssdk.core.SdkResponse
-
- software.amazon.awssdk.awscore.AwsResponse
-
- software.amazon.awssdk.services.kinesis.model.KinesisResponse
-
- software.amazon.awssdk.services.kinesis.model.ListShardsResponse
-
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<ListShardsResponse.Builder,ListShardsResponse>
@Generated("software.amazon.awssdk:codegen") public final class ListShardsResponse extends KinesisResponse implements ToCopyableBuilder<ListShardsResponse.Builder,ListShardsResponse>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
ListShardsResponse.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static ListShardsResponse.Builder
builder()
boolean
equals(Object obj)
boolean
equalsBySdkFields(Object obj)
<T> Optional<T>
getValueForField(String fieldName, Class<T> clazz)
int
hashCode()
boolean
hasShards()
For responses, this returns true if the service returned a value for the Shards property.String
nextToken()
When the number of shards in the data stream is greater than the default value for theMaxResults
parameter, or if you explicitly specify a value forMaxResults
that is less than the number of shards in the data stream, the response includes a pagination token namedNextToken
.List<SdkField<?>>
sdkFields()
static Class<? extends ListShardsResponse.Builder>
serializableBuilderClass()
List<Shard>
shards()
An array of JSON objects.ListShardsResponse.Builder
toBuilder()
String
toString()
Returns a string representation of this object.-
Methods inherited from class software.amazon.awssdk.services.kinesis.model.KinesisResponse
responseMetadata
-
Methods inherited from class software.amazon.awssdk.core.SdkResponse
sdkHttpResponse
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
hasShards
public final boolean hasShards()
For responses, this returns true if the service returned a value for the Shards property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
-
shards
public final List<Shard> shards()
An array of JSON objects. Each object represents one shard and specifies the IDs of the shard, the shard's parent, and the shard that's adjacent to the shard's parent. Each object also contains the starting and ending hash keys and the starting and ending sequence numbers for the shard.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasShards()
method.- Returns:
- An array of JSON objects. Each object represents one shard and specifies the IDs of the shard, the shard's parent, and the shard that's adjacent to the shard's parent. Each object also contains the starting and ending hash keys and the starting and ending sequence numbers for the shard.
-
nextToken
public final 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 forMaxResults
that is less than the number of shards in the data stream, the response includes a pagination token namedNextToken
. You can specify thisNextToken
value in a subsequent call toListShards
to list the next set of shards. For more information about the use of this pagination token when calling theListShards
operation, see ListShardsInput$NextToken.Tokens expire after 300 seconds. When you obtain a value for
NextToken
in the response to a call toListShards
, you have 300 seconds to use that value. If you specify an expired token in a call toListShards
, you getExpiredNextTokenException
.- 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 forMaxResults
that is less than the number of shards in the data stream, the response includes a pagination token namedNextToken
. You can specify thisNextToken
value in a subsequent call toListShards
to list the next set of shards. For more information about the use of this pagination token when calling theListShards
operation, see ListShardsInput$NextToken.Tokens expire after 300 seconds. When you obtain a value for
NextToken
in the response to a call toListShards
, you have 300 seconds to use that value. If you specify an expired token in a call toListShards
, you getExpiredNextTokenException
.
-
toBuilder
public ListShardsResponse.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<ListShardsResponse.Builder,ListShardsResponse>
- Specified by:
toBuilder
in classAwsResponse
-
builder
public static ListShardsResponse.Builder builder()
-
serializableBuilderClass
public static Class<? extends ListShardsResponse.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCode
in classAwsResponse
-
equals
public final boolean equals(Object obj)
- Overrides:
equals
in classAwsResponse
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in interfaceSdkPojo
-
toString
public final 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.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForField
in classSdkResponse
-
-