Package software.amazon.awssdk.services.kinesis.model

Class Shard

java.lang.Object

software.amazon.awssdk.services.kinesis.model.Shard

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<Shard.Builder,Shard>

@Generated("software.amazon.awssdk:codegen")
public final class Shard
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<Shard.Builder,Shard>

A uniquely identified group of data records in a Kinesis data stream.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	Shard.Builder

Method Summary

Modifier and Type	Method	Description
String	adjacentParentShardId()	The shard ID of the shard adjacent to the shard's parent.
static Shard.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
HashKeyRange	hashKeyRange()	The range of possible hash key values for the shard, which is a set of ordered contiguous positive integers.
String	parentShardId()	The shard ID of the shard's parent.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
SequenceNumberRange	sequenceNumberRange()	The range of possible sequence numbers for the shard.
static Class<? extends Shard.Builder>	serializableBuilderClass()
String	shardId()	The unique identifier of the shard within the stream.
Shard.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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

shardId

public final String shardId()

The unique identifier of the shard within the stream.

Returns:

The unique identifier of the shard within the stream.

parentShardId

public final String parentShardId()

The shard ID of the shard's parent.

Returns:

The shard ID of the shard's parent.

adjacentParentShardId

public final String adjacentParentShardId()

The shard ID of the shard adjacent to the shard's parent.

Returns:

The shard ID of the shard adjacent to the shard's parent.

hashKeyRange

public final HashKeyRange hashKeyRange()

The range of possible hash key values for the shard, which is a set of ordered contiguous positive integers.

Returns:

The range of possible hash key values for the shard, which is a set of ordered contiguous positive integers.

sequenceNumberRange

public final SequenceNumberRange sequenceNumberRange()

The range of possible sequence numbers for the shard.

Returns:

The range of possible sequence numbers for the shard.

toBuilder

public Shard.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<Shard.Builder,Shard>

builder

public static Shard.Builder builder()

serializableBuilderClass

public static Class<? extends Shard.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

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.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo