software.amazon.kinesis.lifecycle

Class ShardConsumer

java.lang.Object

software.amazon.kinesis.lifecycle.ShardConsumer

public class ShardConsumer
extends Object

Responsible for consuming data records of a (specified) shard. The instance should be shutdown when we lose the primary responsibility for a shard. A new instance should be created if the primary responsibility is reassigned back to this process.

Field Summary

Fields

Modifier and Type	Field and Description
static int	MAX_TIME_BETWEEN_REQUEST_RESPONSE

Constructor Summary

Constructors

Constructor and Description
ShardConsumer(RecordsPublisher recordsPublisher, ExecutorService executorService, ShardInfo shardInfo, Optional<Long> logWarningForTaskAfterMillis, ShardConsumerArgument shardConsumerArgument, software.amazon.kinesis.lifecycle.ConsumerState initialState, Function<ConsumerTask,ConsumerTask> taskMetricsDecorator, int bufferSize, TaskExecutionListener taskExecutionListener) Deprecated.
ShardConsumer(RecordsPublisher recordsPublisher, ExecutorService executorService, ShardInfo shardInfo, Optional<Long> logWarningForTaskAfterMillis, ShardConsumerArgument shardConsumerArgument, software.amazon.kinesis.lifecycle.ConsumerState initialState, Function<ConsumerTask,ConsumerTask> taskMetricsDecorator, int bufferSize, TaskExecutionListener taskExecutionListener, int readTimeoutsToIgnoreBeforeWarning)
ShardConsumer(RecordsPublisher recordsPublisher, ExecutorService executorService, ShardInfo shardInfo, Optional<Long> logWarningForTaskAfterMillis, ShardConsumerArgument shardConsumerArgument, TaskExecutionListener taskExecutionListener) Deprecated.
ShardConsumer(RecordsPublisher recordsPublisher, ExecutorService executorService, ShardInfo shardInfo, Optional<Long> logWarningForTaskAfterMillis, ShardConsumerArgument shardConsumerArgument, TaskExecutionListener taskExecutionListener, int readTimeoutsToIgnoreBeforeWarning)

Method Summary

Modifier and Type	Method and Description
void	executeLifecycle()
void	gracefulShutdown(ShutdownNotification shutdownNotification) Requests the shutdown of the this ShardConsumer.
boolean	isShutdown() Used (by Worker) to check if this ShardConsumer instance has been shutdown ShardRecordProcessor shutdown() has been invoked, as appropriate.
boolean	isShutdownRequested()
boolean	leaseLost() Shutdown this ShardConsumer (including invoking the ShardRecordProcessor shutdown API).

Methods inherited from class java.lang.Object

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

Field Detail

MAX_TIME_BETWEEN_REQUEST_RESPONSE

public static final int MAX_TIME_BETWEEN_REQUEST_RESPONSE

See Also:

Constant Field Values

Constructor Detail

ShardConsumer

@Deprecated
public ShardConsumer(RecordsPublisher recordsPublisher,
                                 ExecutorService executorService,
                                 ShardInfo shardInfo,
                                 Optional<Long> logWarningForTaskAfterMillis,
                                 ShardConsumerArgument shardConsumerArgument,
                                 TaskExecutionListener taskExecutionListener)

Deprecated.

ShardConsumer

public ShardConsumer(RecordsPublisher recordsPublisher,
                     ExecutorService executorService,
                     ShardInfo shardInfo,
                     Optional<Long> logWarningForTaskAfterMillis,
                     ShardConsumerArgument shardConsumerArgument,
                     TaskExecutionListener taskExecutionListener,
                     int readTimeoutsToIgnoreBeforeWarning)

ShardConsumer

@Deprecated
public ShardConsumer(RecordsPublisher recordsPublisher,
                                 ExecutorService executorService,
                                 ShardInfo shardInfo,
                                 Optional<Long> logWarningForTaskAfterMillis,
                                 ShardConsumerArgument shardConsumerArgument,
                                 software.amazon.kinesis.lifecycle.ConsumerState initialState,
                                 Function<ConsumerTask,ConsumerTask> taskMetricsDecorator,
                                 int bufferSize,
                                 TaskExecutionListener taskExecutionListener)

Deprecated.

ShardConsumer

public ShardConsumer(RecordsPublisher recordsPublisher,
                     ExecutorService executorService,
                     ShardInfo shardInfo,
                     Optional<Long> logWarningForTaskAfterMillis,
                     ShardConsumerArgument shardConsumerArgument,
                     software.amazon.kinesis.lifecycle.ConsumerState initialState,
                     Function<ConsumerTask,ConsumerTask> taskMetricsDecorator,
                     int bufferSize,
                     TaskExecutionListener taskExecutionListener,
                     int readTimeoutsToIgnoreBeforeWarning)

Method Detail

executeLifecycle

public void executeLifecycle()

gracefulShutdown

public void gracefulShutdown(ShutdownNotification shutdownNotification)

Requests the shutdown of the this ShardConsumer. This should give the record processor a chance to checkpoint before being shutdown.

Parameters:

shutdownNotification - used to signal that the record processor has been given the chance to shutdown.

leaseLost

public boolean leaseLost()

Shutdown this ShardConsumer (including invoking the ShardRecordProcessor shutdown API). This is called by Worker when it loses responsibility for a shard.

Returns:

true if shutdown is complete (false if shutdown is still in progress)

isShutdown

public boolean isShutdown()

Used (by Worker) to check if this ShardConsumer instance has been shutdown ShardRecordProcessor shutdown() has been invoked, as appropriate.

Returns:

true if shutdown is complete

isShutdownRequested

public boolean isShutdownRequested()