software.amazon.kinesis.leases

Class KinesisShardDetector

java.lang.Object

software.amazon.kinesis.leases.KinesisShardDetector

All Implemented Interfaces:

ShardDetector

public class KinesisShardDetector
extends Object
implements ShardDetector

Constructor Summary

Constructors

Constructor and Description
KinesisShardDetector(software.amazon.awssdk.services.kinesis.KinesisAsyncClient kinesisClient, StreamIdentifier streamIdentifier, long listShardsBackoffTimeInMillis, int maxListShardsRetryAttempts, long listShardsCacheAllowedAgeInSeconds, int maxCacheMissesBeforeReload, int cacheMissWarningModulus, Duration kinesisRequestTimeout)
KinesisShardDetector(software.amazon.awssdk.services.kinesis.KinesisAsyncClient kinesisClient, String streamName, long listShardsBackoffTimeInMillis, int maxListShardsRetryAttempts, long listShardsCacheAllowedAgeInSeconds, int maxCacheMissesBeforeReload, int cacheMissWarningModulus) Deprecated.

Method Summary

Modifier and Type	Method and Description
List<software.amazon.awssdk.services.kinesis.model.ChildShard>	getChildShards(String shardId) Gets the children shards of a shard.
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.
List<software.amazon.awssdk.services.kinesis.model.Shard>	listShardsWithFilter(software.amazon.awssdk.services.kinesis.model.ShardFilter shardFilter) List shards with shard filter.
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.
software.amazon.awssdk.services.kinesis.model.Shard	shard(@NonNull String shardId) Gets shard based on shardId.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.kinesis.leases.ShardDetector

streamIdentifier

Constructor Detail

KinesisShardDetector

@Deprecated
public KinesisShardDetector(software.amazon.awssdk.services.kinesis.KinesisAsyncClient kinesisClient,
                                        String streamName,
                                        long listShardsBackoffTimeInMillis,
                                        int maxListShardsRetryAttempts,
                                        long listShardsCacheAllowedAgeInSeconds,
                                        int maxCacheMissesBeforeReload,
                                        int cacheMissWarningModulus)

Deprecated.

KinesisShardDetector

public KinesisShardDetector(software.amazon.awssdk.services.kinesis.KinesisAsyncClient kinesisClient,
                            StreamIdentifier streamIdentifier,
                            long listShardsBackoffTimeInMillis,
                            int maxListShardsRetryAttempts,
                            long listShardsCacheAllowedAgeInSeconds,
                            int maxCacheMissesBeforeReload,
                            int cacheMissWarningModulus,
                            Duration kinesisRequestTimeout)

Method Detail

shard

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

Description copied from interface: ShardDetector

Gets shard based on shardId.

Specified by:

shard in interface ShardDetector

Returns:

Shard

listShards

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

Description copied from interface: ShardDetector

List shards.

Specified by:

listShards in interface ShardDetector

Returns:

Shards

listShardsWithoutConsumingResourceNotFoundException

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

Description copied from interface: ShardDetector

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

Specified by:

listShardsWithoutConsumingResourceNotFoundException in interface ShardDetector

Returns:

Shards

listShardsWithFilter

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

Description copied from interface: ShardDetector

List shards with shard filter.

Specified by:

listShardsWithFilter in interface ShardDetector

Returns:

Shards

getListShardsResponse

public software.amazon.awssdk.services.kinesis.model.ListShardsResponse getListShardsResponse(software.amazon.awssdk.services.kinesis.model.ListShardsRequest request)
                                                                                       throws ExecutionException,
                                                                                              TimeoutException,
                                                                                              InterruptedException

Description copied from interface: ShardDetector

Gets a list shards response based on the request.

Specified by:

getListShardsResponse in interface ShardDetector

Parameters:

request - list shards request

Returns:

ListShardsResponse which contains list shards response

Throws:

ExecutionException

TimeoutException

InterruptedException

getChildShards

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

Description copied from interface: ShardDetector

Gets the children shards of a shard.

Specified by:

getChildShards in interface ShardDetector

Returns:

Throws:

InterruptedException

ExecutionException

TimeoutException