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

Interface Shard.Builder

All Superinterfaces:

Buildable, CopyableBuilder<Shard.Builder,Shard>, SdkBuilder<Shard.Builder,Shard>, SdkPojo

Enclosing class:

Shard

@Mutable
@NotThreadSafe
public static interface Shard.Builder
extends SdkPojo, CopyableBuilder<Shard.Builder,Shard>

Method Summary

Modifier and Type	Method	Description
Shard.Builder	adjacentParentShardId(String adjacentParentShardId)	The shard ID of the shard adjacent to the shard's parent.
default Shard.Builder	hashKeyRange(Consumer<HashKeyRange.Builder> hashKeyRange)	The range of possible hash key values for the shard, which is a set of ordered contiguous positive integers.
Shard.Builder	hashKeyRange(HashKeyRange hashKeyRange)	The range of possible hash key values for the shard, which is a set of ordered contiguous positive integers.
Shard.Builder	parentShardId(String parentShardId)	The shard ID of the shard's parent.
default Shard.Builder	sequenceNumberRange(Consumer<SequenceNumberRange.Builder> sequenceNumberRange)	The range of possible sequence numbers for the shard.
Shard.Builder	sequenceNumberRange(SequenceNumberRange sequenceNumberRange)	The range of possible sequence numbers for the shard.
Shard.Builder	shardId(String shardId)	The unique identifier of the shard within the stream.

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

copy

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

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Detail

shardId

Shard.Builder shardId(String shardId)

The unique identifier of the shard within the stream.

Parameters:

shardId - The unique identifier of the shard within the stream.

Returns:

Returns a reference to this object so that method calls can be chained together.

parentShardId

Shard.Builder parentShardId(String parentShardId)

The shard ID of the shard's parent.

Parameters:

parentShardId - The shard ID of the shard's parent.

Returns:

Returns a reference to this object so that method calls can be chained together.

adjacentParentShardId

Shard.Builder adjacentParentShardId(String adjacentParentShardId)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

hashKeyRange

Shard.Builder hashKeyRange(HashKeyRange hashKeyRange)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

hashKeyRange

default Shard.Builder hashKeyRange(Consumer<HashKeyRange.Builder> hashKeyRange)

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

This is a convenience method that creates an instance of the HashKeyRange.Builder avoiding the need to create one manually via HashKeyRange.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to hashKeyRange(HashKeyRange).

Parameters:

hashKeyRange - a consumer that will call methods on HashKeyRange.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

hashKeyRange(HashKeyRange)

sequenceNumberRange

Shard.Builder sequenceNumberRange(SequenceNumberRange sequenceNumberRange)

The range of possible sequence numbers for the shard.

Parameters:

sequenceNumberRange - The range of possible sequence numbers for the shard.

Returns:

Returns a reference to this object so that method calls can be chained together.

sequenceNumberRange

default Shard.Builder sequenceNumberRange(Consumer<SequenceNumberRange.Builder> sequenceNumberRange)

The range of possible sequence numbers for the shard.

This is a convenience method that creates an instance of the SequenceNumberRange.Builder avoiding the need to create one manually via SequenceNumberRange.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to sequenceNumberRange(SequenceNumberRange).

Parameters:

sequenceNumberRange - a consumer that will call methods on SequenceNumberRange.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

sequenceNumberRange(SequenceNumberRange)