com.gilt.gfc.kinesis.consumer

Checkpoint

trait Checkpoint extends AnyRef

Allows consumer to checkpoint a stream's shard at latest read point, or at a specific sequence number.

Also provided is tracking information on the last checkpoint (its age, and also the number of records passed to application since last checkpoint) of the associated shard.

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Checkpoint
  2. AnyRef
  3. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def age(): FiniteDuration

    The duration since the last checkpoint.

    The duration since the last checkpoint. This can be used by the application to implement less frequent periodic checkpointing.

    returns

  2. abstract def apply(sequenceNumber: SequenceNumber): Unit

    This method will checkpoint the progress at the provided sequenceNumber.

    This method will checkpoint the progress at the provided sequenceNumber. This method is analogous to #apply() but provides the ability to specify the sequence number at which to checkpoint.

    sequenceNumber

  3. abstract def apply(): Unit

    This method will checkpoint the progress at the last data record that was delivered to the consumer for this shard.

    This method will checkpoint the progress at the last data record that was delivered to the consumer for this shard. In steady state, applications should checkpoint periodically (e.g. once every 5 minutes). Calling this API too frequently can slow down the application (because it puts pressure on the underlying checkpoint storage layer).

  4. abstract def shardId(): ShardId

    The ShardId that this checkpoint is associated with.

    The ShardId that this checkpoint is associated with.

    returns

  5. abstract def size(): Long

    The number of records that have been passed to the application (for the shard in question) since the last checkpoint

    The number of records that have been passed to the application (for the shard in question) since the last checkpoint

    returns

Concrete Value Members

  1. final def !=(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  5. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  6. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  7. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  8. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  9. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  10. def hashCode(): Int

    Definition Classes
    AnyRef → Any
  11. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  12. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  13. final def notify(): Unit

    Definition Classes
    AnyRef
  14. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  15. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  16. def toString(): String

    Definition Classes
    AnyRef → Any
  17. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  18. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  19. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped