Trait

com.twitter.finatra.kafka.consumers

FinagleKafkaConsumerBuilderMethods

Related Doc: package consumers

Permalink

trait FinagleKafkaConsumerBuilderMethods[K, V, Self] extends KafkaConsumerConfigMethods[Self]

Trait defining methods for configuring a FinagleKafkaConsumer. It extends KafkaConsumerConfig, to get all the Kafka-specific methods that set elements of the java.util.Properties object. It also adds methods for configuring new parameters that are specific to FinagleKafkaConsumer (pollTimeout and seekStrategy).

K

The key type of the consumer this will build.

V

The value type of the consumer this will build.

Self

The type of the concrete builder that includes these methods.

Linear Supertypes
Known Subclasses
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. FinagleKafkaConsumerBuilderMethods
  2. KafkaConsumerConfigMethods
  3. Logging
  4. Logging
  5. KafkaConfigMethods
  6. KafkaConfig
  7. AnyRef
  8. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. type This = Self

    Permalink
    Definition Classes
    KafkaConfigMethods

Abstract Value Members

  1. abstract def config: FinagleKafkaConsumerConfig[K, V]

    Permalink

    The KafkaConsumerConfig config, which can be used to build KafkaConsumer

  2. abstract def fromFinagleConsumerConfig(config: FinagleKafkaConsumerConfig[K, V]): This

    Permalink
    Attributes
    protected

Concrete Value Members

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

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

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

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

    Permalink
    Definition Classes
    Any
  5. def autoCommitInterval(duration: Duration): This

    Permalink
    Definition Classes
    KafkaConsumerConfigMethods
  6. def autoOffsetReset(offsetResetStrategy: OffsetResetStrategy): This

    Permalink
    Definition Classes
    KafkaConsumerConfigMethods
  7. def bootstrapServers(servers: String): This

    Permalink
    Definition Classes
    KafkaConsumerConfigMethods
  8. def buildClient(): KafkaConsumer[K, V]

    Permalink

    Create the native KafkaConsumer client, it blocks on metadata update.

  9. def checkCrcs(boolean: Boolean): This

    Permalink
    Definition Classes
    KafkaConsumerConfigMethods
  10. def clientId(clientId: String): This

    Permalink
    Definition Classes
    KafkaConsumerConfigMethods
  11. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  12. def configMap: Map[String, String]

    Permalink
    Attributes
    protected
    Definition Classes
    FinagleKafkaConsumerBuilderMethodsKafkaConfig
  13. def connectionsMaxIdle(duration: Duration): This

    Permalink
    Definition Classes
    KafkaConsumerConfigMethods
  14. def debug(marker: Marker, message: ⇒ Any, cause: Throwable): Unit

    Permalink
    Attributes
    protected[this]
    Definition Classes
    Logging
  15. def debug(message: ⇒ Any, cause: Throwable): Unit

    Permalink
    Attributes
    protected[this]
    Definition Classes
    Logging
  16. def debug(marker: Marker, message: ⇒ Any): Unit

    Permalink
    Attributes
    protected[this]
    Definition Classes
    Logging
  17. def debug(message: ⇒ Any): Unit

    Permalink
    Attributes
    protected[this]
    Definition Classes
    Logging
  18. def debugFutureResult[T](msg: String)(func: ⇒ Future[T]): Future[T]

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  19. def debugResult[T](message: ⇒ String)(fn: ⇒ T): T

    Permalink
    Attributes
    protected[this]
    Definition Classes
    Logging
  20. def dest(dest: String, timeout: Duration): This

    Permalink

    Configure the Kafka server the consumer will connect to.

    Configure the Kafka server the consumer will connect to.

    dest

    the Kafka server address

    timeout

    the timeout duration when trying to resolve the dest server.

    returns

    the KafkaConsumerConfigMethods instance.

    Definition Classes
    KafkaConsumerConfigMethods
  21. def dest(dest: String): This

    Permalink

    Configure the Kafka server the consumer will connect to.

    Configure the Kafka server the consumer will connect to.

    dest

    the Kafka server address

    returns

    the KafkaConsumerConfigMethods instance.

    Definition Classes
    KafkaConsumerConfigMethods
  22. def enableAutoCommit(boolean: Boolean): This

    Permalink
    Definition Classes
    KafkaConsumerConfigMethods
  23. final def eq(arg0: AnyRef): Boolean

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

    Permalink
    Definition Classes
    AnyRef → Any
  25. def error(marker: Marker, message: ⇒ Any, cause: Throwable): Unit

    Permalink
    Attributes
    protected[this]
    Definition Classes
    Logging
  26. def error(message: ⇒ Any, cause: Throwable): Unit

    Permalink
    Attributes
    protected[this]
    Definition Classes
    Logging
  27. def error(marker: Marker, message: ⇒ Any): Unit

    Permalink
    Attributes
    protected[this]
    Definition Classes
    Logging
  28. def error(message: ⇒ Any): Unit

    Permalink
    Attributes
    protected[this]
    Definition Classes
    Logging
  29. def errorResult[T](message: ⇒ String)(fn: ⇒ T): T

    Permalink
    Attributes
    protected[this]
    Definition Classes
    Logging
  30. def excludeInternalTopics(boolean: Boolean): This

    Permalink
    Definition Classes
    KafkaConsumerConfigMethods
  31. def fetchMax(storageUnit: StorageUnit): This

    Permalink
    Definition Classes
    KafkaConsumerConfigMethods
  32. def fetchMaxWait(duration: Duration): This

    Permalink
    Definition Classes
    KafkaConsumerConfigMethods
  33. def fetchMin(storageUnit: StorageUnit): This

    Permalink
    Definition Classes
    KafkaConsumerConfigMethods
  34. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  35. def fromConfigMap(configMap: Map[String, String]): This

    Permalink

    Override this in your concrete builder with a copy constructor for that builder that replaces the old configMap with a modified one.

    Override this in your concrete builder with a copy constructor for that builder that replaces the old configMap with a modified one.

    Attributes
    protected
    Definition Classes
    FinagleKafkaConsumerBuilderMethodsKafkaConfigMethods
  36. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  37. def groupId(groupId: KafkaGroupId): This

    Permalink
    Definition Classes
    KafkaConsumerConfigMethods
  38. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  39. def heartbeatInterval(duration: Duration): This

    Permalink
    Definition Classes
    KafkaConsumerConfigMethods
  40. def includeNodeMetrics(include: Boolean): This

    Permalink

    For KafkaFinagleMetricsReporter: whether to include node-level metrics.

  41. def info(marker: Marker, message: ⇒ Any, cause: Throwable): Unit

    Permalink
    Attributes
    protected[this]
    Definition Classes
    Logging
  42. def info(message: ⇒ Any, cause: Throwable): Unit

    Permalink
    Attributes
    protected[this]
    Definition Classes
    Logging
  43. def info(marker: Marker, message: ⇒ Any): Unit

    Permalink
    Attributes
    protected[this]
    Definition Classes
    Logging
  44. def info(message: ⇒ Any): Unit

    Permalink
    Attributes
    protected[this]
    Definition Classes
    Logging
  45. def infoResult[T](message: ⇒ String)(fn: ⇒ T): T

    Permalink
    Attributes
    protected[this]
    Definition Classes
    Logging
  46. def interceptor[T](implicit arg0: Manifest[T]): This

    Permalink
    Definition Classes
    KafkaConsumerConfigMethods
  47. def isDebugEnabled(marker: Marker): Boolean

    Permalink
    Attributes
    protected[this]
    Definition Classes
    Logging
  48. def isDebugEnabled: Boolean

    Permalink
    Attributes
    protected[this]
    Definition Classes
    Logging
  49. def isErrorEnabled(marker: Marker): Boolean

    Permalink
    Attributes
    protected[this]
    Definition Classes
    Logging
  50. def isErrorEnabled: Boolean

    Permalink
    Attributes
    protected[this]
    Definition Classes
    Logging
  51. def isInfoEnabled(marker: Marker): Boolean

    Permalink
    Attributes
    protected[this]
    Definition Classes
    Logging
  52. def isInfoEnabled: Boolean

    Permalink
    Attributes
    protected[this]
    Definition Classes
    Logging
  53. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  54. def isTraceEnabled(marker: Marker): Boolean

    Permalink
    Attributes
    protected[this]
    Definition Classes
    Logging
  55. def isTraceEnabled: Boolean

    Permalink
    Attributes
    protected[this]
    Definition Classes
    Logging
  56. def isWarnEnabled(marker: Marker): Boolean

    Permalink
    Attributes
    protected[this]
    Definition Classes
    Logging
  57. def isWarnEnabled: Boolean

    Permalink
    Attributes
    protected[this]
    Definition Classes
    Logging
  58. def isolationLevel(isolationLevel: IsolationLevel): This

    Permalink
    Definition Classes
    KafkaConsumerConfigMethods
  59. def keyDeserializer(keyDeserializer: Deserializer[K]): This

    Permalink

    Deserializer class for key

  60. final def logger: Logger

    Permalink
    Attributes
    protected[this]
    Definition Classes
    Logging
  61. final def loggerName: String

    Permalink
    Attributes
    protected[this]
    Definition Classes
    Logging
  62. def maxPartitionFetch(storageUnit: StorageUnit): This

    Permalink
    Definition Classes
    KafkaConsumerConfigMethods
  63. def maxPollInterval(duration: Duration): This

    Permalink
    Definition Classes
    KafkaConsumerConfigMethods
  64. def maxPollRecords(int: Int): This

    Permalink
    Definition Classes
    KafkaConsumerConfigMethods
  65. def metadataMaxAge(duration: Duration): This

    Permalink
    Definition Classes
    KafkaConsumerConfigMethods
  66. def metricReporter[T](implicit arg0: Manifest[T]): This

    Permalink
    Definition Classes
    KafkaConsumerConfigMethods
  67. def metricsNumSamples(int: Int): This

    Permalink
    Definition Classes
    KafkaConsumerConfigMethods
  68. def metricsRecordingLevel(recordingLevel: RecordingLevel): This

    Permalink
    Definition Classes
    KafkaConsumerConfigMethods
  69. def metricsSampleWindow(duration: Duration): This

    Permalink
    Definition Classes
    KafkaConsumerConfigMethods
  70. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  71. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  72. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  73. def partitionAssignmentStrategy[T](implicit arg0: Manifest[T]): This

    Permalink
    Definition Classes
    KafkaConsumerConfigMethods
  74. def pollTimeout(pollTimeout: Duration): This

    Permalink

    Default poll timeout in milliseconds

  75. def receiveBuffer(storageUnit: StorageUnit): This

    Permalink
    Definition Classes
    KafkaConsumerConfigMethods
  76. def reconnectBackoff(duration: Duration): This

    Permalink
    Definition Classes
    KafkaConsumerConfigMethods
  77. def reconnectBackoffMax(duration: Duration): This

    Permalink
    Definition Classes
    KafkaConsumerConfigMethods
  78. def requestTimeout(duration: Duration): This

    Permalink
    Definition Classes
    KafkaConsumerConfigMethods
  79. def retryBackoff(duration: Duration): This

    Permalink
    Definition Classes
    KafkaConsumerConfigMethods
  80. def rewindDuration(rewindDuration: Duration): This

    Permalink

    If using SeekStrategy.REWIND, specify the duration back in time to rewind and start consuming from

  81. def seekStrategy(seekStrategy: SeekStrategy): This

    Permalink

    Whether the consumer should start from end, beginning or from the offset

  82. def sendBufferConfig(storageUnit: StorageUnit): This

    Permalink
    Definition Classes
    KafkaConsumerConfigMethods
  83. def sessionTimeout(duration: Duration): This

    Permalink
    Definition Classes
    KafkaConsumerConfigMethods
  84. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  85. def time[T](formatStr: String)(func: ⇒ T): T

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  86. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  87. def trace(marker: Marker, message: ⇒ Any, cause: Throwable): Unit

    Permalink
    Attributes
    protected[this]
    Definition Classes
    Logging
  88. def trace(message: ⇒ Any, cause: Throwable): Unit

    Permalink
    Attributes
    protected[this]
    Definition Classes
    Logging
  89. def trace(marker: Marker, message: ⇒ Any): Unit

    Permalink
    Attributes
    protected[this]
    Definition Classes
    Logging
  90. def trace(message: ⇒ Any): Unit

    Permalink
    Attributes
    protected[this]
    Definition Classes
    Logging
  91. def traceResult[T](message: ⇒ String)(fn: ⇒ T): T

    Permalink
    Attributes
    protected[this]
    Definition Classes
    Logging
  92. def validateConfigs(config: FinagleKafkaConsumerConfig[K, V]): Unit

    Permalink
    Attributes
    protected
  93. def valueDeserializer(valueDeserializer: Deserializer[V]): This

    Permalink

    Deserializer class for value

  94. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  97. def warn(marker: Marker, message: ⇒ Any, cause: Throwable): Unit

    Permalink
    Attributes
    protected[this]
    Definition Classes
    Logging
  98. def warn(message: ⇒ Any, cause: Throwable): Unit

    Permalink
    Attributes
    protected[this]
    Definition Classes
    Logging
  99. def warn(marker: Marker, message: ⇒ Any): Unit

    Permalink
    Attributes
    protected[this]
    Definition Classes
    Logging
  100. def warn(message: ⇒ Any): Unit

    Permalink
    Attributes
    protected[this]
    Definition Classes
    Logging
  101. def warnResult[T](message: ⇒ String)(fn: ⇒ T): T

    Permalink
    Attributes
    protected[this]
    Definition Classes
    Logging
  102. def withClassName[T](key: String)(implicit arg0: Manifest[T]): This

    Permalink
    Attributes
    protected
    Definition Classes
    KafkaConfigMethods
  103. def withClassNameBuilder[T](key: String)(implicit arg0: Manifest[T]): This

    Permalink
    Attributes
    protected
    Definition Classes
    KafkaConfigMethods
  104. def withConfig(keyValuesMap: Map[String, String]): This

    Permalink
    Definition Classes
    KafkaConfigMethods
  105. def withConfig(key: String, value: StorageUnit): This

    Permalink
    Definition Classes
    KafkaConfigMethods
  106. def withConfig(key: String, value: Duration): This

    Permalink
    Definition Classes
    KafkaConfigMethods
  107. def withConfig(key: String, value: Boolean): This

    Permalink
    Definition Classes
    KafkaConfigMethods
  108. def withConfig(key: String, value: Int): This

    Permalink
    Definition Classes
    KafkaConfigMethods
  109. def withConfig(key: String, value: String): This

    Permalink
    Definition Classes
    KafkaConfigMethods

Deprecated Value Members

  1. def build(): FinagleKafkaConsumer[K, V]

    Permalink
    Annotations
    @deprecated
    Deprecated

    (Since version 2018-05-30) Use buildClient instead

Inherited from KafkaConsumerConfigMethods[Self]

Inherited from Logging

Inherited from Logging

Inherited from KafkaConfigMethods[Self]

Inherited from KafkaConfig

Inherited from AnyRef

Inherited from Any

Ungrouped