Packages

o

kinesis4cats.client.localstack

LocalstackKinesisClient

object LocalstackKinesisClient

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. LocalstackKinesisClient
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

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 client[F[_]](prefix: Option[String] = None)(implicit F: Async[F], LE: LogEncoders): F[KinesisClient[F]]

    Builds a KinesisClient that is compliant for Localstack usage.

    Builds a KinesisClient that is compliant for Localstack usage.

    prefix

    Optional prefix for parsing configuration. Default to None

    F

    F with an Async instance

    LE

    LogEncoders

    returns

    F of KinesisClient

  6. def client[F[_]](config: LocalstackConfig)(implicit F: Async[F], LE: LogEncoders): F[KinesisClient[F]]

    Builds a KinesisClient that is compliant for Localstack usage.

    Builds a KinesisClient that is compliant for Localstack usage.

    config

    LocalstackConfig

    F

    F with an Async instance

    LE

    LogEncoders

    returns

    F of KinesisClient

  7. def clientResource[F[_]](prefix: Option[String] = None)(implicit F: Async[F], LE: LogEncoders): Resource[F, KinesisClient[F]]

    Builds a KinesisClient that is compliant for Localstack usage.

    Builds a KinesisClient that is compliant for Localstack usage. Lifecycle is managed as a Resource.

    prefix

    Optional prefix for parsing configuration. Default to None

    F

    F with an Async instance

    returns

    Resource of KinesisClient

  8. def clientResource[F[_]](config: LocalstackConfig)(implicit F: Async[F], LE: LogEncoders): Resource[F, KinesisClient[F]]

    Builds a KinesisClient that is compliant for Localstack usage.

    Builds a KinesisClient that is compliant for Localstack usage. Lifecycle is managed as a Resource.

    config

    LocalstackConfig

    F

    F with an Async instance

    LE

    LogEncoders

    returns

    Resource of KinesisClient

  9. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
  10. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  11. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  12. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  13. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  14. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  15. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  16. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  17. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  18. def streamResource[F[_]](streamName: String, shardCount: Int, prefix: Option[String] = None, describeRetries: Int = 5, describeRetryDuration: FiniteDuration = 500.millis)(implicit F: Async[F], LE: LogEncoders): Resource[F, KinesisClient[F]]

    A resources that does the following:

    A resources that does the following:

    • Builds a KinesisClient that is compliant for Localstack usage.
    • Creates a stream with the desired name and shard count, and waits until the stream is active.
    • Destroys the stream when the Resource is closed
    streamName

    Stream name

    shardCount

    Shard count for stream

    prefix

    Optional prefix for parsing configuration. Default to None

    describeRetries

    How many times to retry DescribeStreamSummary when checking the stream status. Default to 5

    describeRetryDuration

    How long to delay between retries of the DescribeStreamSummary call. Default to 500 ms

    F

    F with an Async instance

    LE

    LogEncoders

    returns

    Resource of KinesisClient

  19. def streamResource[F[_]](config: LocalstackConfig, streamName: String, shardCount: Int, describeRetries: Int, describeRetryDuration: FiniteDuration)(implicit F: Async[F], LE: LogEncoders): Resource[F, KinesisClient[F]]

    A resources that does the following:

    A resources that does the following:

    • Builds a KinesisClient that is compliant for Localstack usage.
    • Creates a stream with the desired name and shard count, and waits until the stream is active.
    • Destroys the stream when the Resource is closed
    config

    LocalstackConfig

    streamName

    Stream name

    shardCount

    Shard count for stream

    describeRetries

    How many times to retry DescribeStreamSummary when checking the stream status

    describeRetryDuration

    How long to delay between retries of the DescribeStreamSummary call

    F

    F with an Async instance

    LE

    LogEncoders

    returns

    Resource of KinesisClient

  20. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  21. def toString(): String
    Definition Classes
    AnyRef → Any
  22. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  23. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  24. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

Inherited from AnyRef

Inherited from Any

Ungrouped