software.amazon.kinesis.leases

Interface ShardDetector

All Known Implementing Classes:

KinesisShardDetector

public interface ShardDetector

Method Summary

Modifier and Type	Method and Description
default List<software.amazon.awssdk.services.kinesis.model.ChildShard>	getChildShards(String shardId) Gets the children shards of a shard.
default software.amazon.awssdk.services.kinesis.model.ListShardsResponse	getListShardsResponse(software.amazon.awssdk.services.kinesis.model.ListShardsRequest request) Gets a list shards response based on the request.
List<software.amazon.awssdk.services.kinesis.model.Shard>	listShards() List shards.
default List<software.amazon.awssdk.services.kinesis.model.Shard>	listShards(String consumerId) List shards.
default List<software.amazon.awssdk.services.kinesis.model.Shard>	listShardsWithFilter(software.amazon.awssdk.services.kinesis.model.ShardFilter shardFilter) List shards with shard filter.
default List<software.amazon.awssdk.services.kinesis.model.Shard>	listShardsWithFilter(software.amazon.awssdk.services.kinesis.model.ShardFilter shardFilter, String consumerId) List shards with shard filter.
default List<software.amazon.awssdk.services.kinesis.model.Shard>	listShardsWithoutConsumingResourceNotFoundException() This method behaves exactly similar to listShards except the fact that this does not consume and throw ResourceNotFoundException instead of returning empty list.
default List<software.amazon.awssdk.services.kinesis.model.Shard>	listShardsWithoutConsumingResourceNotFoundException(String consumerId) This method behaves exactly similar to listShards except the fact that this does not consume and throw ResourceNotFoundException instead of returning empty list.
software.amazon.awssdk.services.kinesis.model.Shard	shard(String shardId) Gets shard based on shardId.
default StreamIdentifier	streamIdentifier() Gets stream identifier.

Method Detail

shard

software.amazon.awssdk.services.kinesis.model.Shard shard(String shardId)

Gets shard based on shardId.

Parameters:

shardId -

Returns:

Shard

listShards

List<software.amazon.awssdk.services.kinesis.model.Shard> listShards()

List shards.

Returns:

Shards

listShards

default List<software.amazon.awssdk.services.kinesis.model.Shard> listShards(String consumerId)

List shards.

Returns:

Shards

listShardsWithoutConsumingResourceNotFoundException

default List<software.amazon.awssdk.services.kinesis.model.Shard> listShardsWithoutConsumingResourceNotFoundException()

This method behaves exactly similar to listShards except the fact that this does not consume and throw ResourceNotFoundException instead of returning empty list.

Returns:

Shards

listShardsWithoutConsumingResourceNotFoundException

default List<software.amazon.awssdk.services.kinesis.model.Shard> listShardsWithoutConsumingResourceNotFoundException(String consumerId)

This method behaves exactly similar to listShards except the fact that this does not consume and throw ResourceNotFoundException instead of returning empty list.

Returns:

Shards

listShardsWithFilter

default List<software.amazon.awssdk.services.kinesis.model.Shard> listShardsWithFilter(software.amazon.awssdk.services.kinesis.model.ShardFilter shardFilter)

List shards with shard filter.

Parameters:

shardFilter -

Returns:

Shards

listShardsWithFilter

default List<software.amazon.awssdk.services.kinesis.model.Shard> listShardsWithFilter(software.amazon.awssdk.services.kinesis.model.ShardFilter shardFilter,
                                                                                       String consumerId)

List shards with shard filter.

Parameters:

shardFilter -

Returns:

Shards

streamIdentifier

default StreamIdentifier streamIdentifier()

Gets stream identifier.

Returns:

StreamIdentifier

getListShardsResponse

default software.amazon.awssdk.services.kinesis.model.ListShardsResponse getListShardsResponse(software.amazon.awssdk.services.kinesis.model.ListShardsRequest request)
                                                                                        throws Exception

Gets a list shards response based on the request.

Parameters:

request - list shards request

Returns:

ListShardsResponse which contains list shards response

Throws:

Exception

getChildShards

default List<software.amazon.awssdk.services.kinesis.model.ChildShard> getChildShards(String shardId)
                                                                               throws InterruptedException,
                                                                                      ExecutionException,
                                                                                      TimeoutException

Gets the children shards of a shard.

Parameters:

shardId -

Returns:

Throws:

InterruptedException

ExecutionException

TimeoutException